# AWS CLI コマンドの例 このトピックのコードサンプルは、AWS Command Line Interface を AWS と共に使用する方法を示しています。 *基本* は、重要なオペレーションをサービス内で実行する方法を示すコード例です。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 *シナリオ*は、1 つのサービス内から、または他の AWS のサービスと組み合わせて複数の関数を呼び出し、特定のタスクを実行する方法を示すコード例です。 一部のサービスには、サービス固有のライブラリや関数の活用方法を示す追加のカテゴリ例が含まれています。 **Topics** + [ACM](cli_acm_code_examples.md) + [API ゲートウェイ](cli_api-gateway_code_examples.md) + [API Gateway HTTP と WebSocket API](cli_apigatewayv2_code_examples.md) + [API Gateway Management API](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) + [Auto Scaling](cli_auto-scaling_code_examples.md) + [自動スケーリングプラン](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) + [Cloud Control API](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) + [CloudWatch Network Monitoring](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 CodeStar 通知](cli_codestar-notifications_code_examples.md) + [CodeConnections](cli_codestar-connections_code_examples.md) + [Amazon Cognito ID](cli_cognito-identity_code_examples.md) + [Amazon Cognito ID プロバイダー](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 サービス](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) + [検出](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) + [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 - バージョン 1](cli_elastic-load-balancing_code_examples.md) + [Elastic Load Balancing - バージョン 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 on EKS](cli_emr-containers_code_examples.md) + [EventBridge](cli_eventbridge_code_examples.md) + [EventBridge Pipes](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) + [AWS IoT ジョブ 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) + [Amazon IVS Real-Time Streaming](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) + [MediaStore Data Plane](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) + [組織](cli_organizations_code_examples.md) + [AWS Outposts](cli_outposts_code_examples.md) + [AWS Payment Cryptography](cli_payment-cryptography_code_examples.md) + [AWS Payment Cryptography Data Plane](cli_payment-cryptography-data_code_examples.md) + [Amazon Pinpoint](cli_pinpoint_code_examples.md) + [Amazon Polly](cli_polly_code_examples.md) + [AWS の料金表](cli_pricing_code_examples.md) + [AWS Private CA](cli_acm-pca_code_examples.md) + [AWS Proton](cli_proton_code_examples.md) + [Amazon RDS](cli_rds_code_examples.md) + [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) + [Resource Explorer](cli_resource-explorer-2_code_examples.md) + [Resource Groups](cli_resource-groups_code_examples.md) + [リソースグループタグ付け API](cli_resource-groups-tagging-api_code_examples.md) + [Route 53](cli_route-53_code_examples.md) + [Route 53 ドメイン登録](cli_route-53-domains_code_examples.md) + [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) + [Security Hub CSPM](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) + [サービスクォータ](cli_service-quotas_code_examples.md) + [Amazon SES](cli_ses_code_examples.md) + [Shield](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) + [サポート](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) + [Verified Permissions](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 メッセージフロー](cli_workmailmessageflow_code_examples.md) + [WorkSpaces](cli_workspaces_code_examples.md) + [X-Ray](cli_xray_code_examples.md) # AWS CLI を使用した ACM の例 次のコード例は、ACM で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `add-tags-to-certificate` 次の例では、`add-tags-to-certificate` を使用する方法を説明しています。 **AWS CLI** **既存の ACM 証明書にタグを追加する方法** 次の `add-tags-to-certificate` コマンドは、指定された証明書に 2 つのタグを追加します。複数のタグは空白で区切ります。 ``` 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 ``` + API の詳細については、*AWS CLI コマンドリファレンス*の「[AddTagsToCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/add-tags-to-certificate.html)」を参照してください。 ### `delete-certificate` 次の例では、`delete-certificate` を使用する方法を説明しています。 **AWS CLI** **アカウントから ACM 証明書を削除する方法** 次の `delete-certificate` コマンドは、指定した ARN の証明書を削除します。 ``` aws acm delete-certificate --certificate-arn arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/delete-certificate.html)」を参照してください。 ### `describe-certificate` 次の例では、`describe-certificate` を使用する方法を説明しています。 **AWS CLI** **ACM 証明書に含まれるフィールドを取得する方法** 次の `describe-certificate` コマンドは、指定した ARN の証明書のすべてのフィールドを取得します。 ``` aws acm describe-certificate --certificate-arn arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 ``` 以下のような出力が表示されます。 ``` { "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" ] } } ``` + API の詳細については、**AWS CLI コマンドリファレンスの「[DescribeCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/describe-certificate.html)」を参照してください。 ### `export-certificate` 次の例では、`export-certificate` を使用する方法を説明しています。 **AWS CLI** **プライベート CA によって発行されたプライベート証明書をエクスポートする方法** 次の `export-certificate` のコマンドは、プライベート証明書、証明書チェーン、プライベートキーをディスプレイにエクスポートします。 ``` aws acm export-certificate --certificate-arn arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 --passphrase file://path-to-passphrase-file ``` 証明書、チェーン、プライベートキーをローカルファイルにエクスポートするには、次のコマンドを使用します。 ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ExportCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/export-certificate.html)」を参照してください。 ### `get-certificate` 次の例では、`get-certificate` を使用する方法を説明しています。 **AWS CLI** **ACM 証明書を取得する方法** 次の `get-certificate` のコマンドは、指定された ARN およびチェーンの証明書を取得します。 ``` aws acm get-certificate --certificate-arn arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 ``` 以下のような出力が表示されます。 ``` { "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-----" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/get-certificate.html)」を参照してください。 ### `import-certificate` 次の例では、`import-certificate` を使用する方法を説明しています。 **AWS CLI** **ACM に証明書をインポートする方法** 以下の `import-certificate` コマンドは、ACM に証明書をインポートします。ファイル名を使用するファイル名で置き換えます。 ``` aws acm import-certificate --certificate file://Certificate.pem --certificate-chain file://CertificateChain.pem --private-key file://PrivateKey.pem ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ImportCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/import-certificate.html)」を参照してください。 ### `list-certificates` 次の例では、`list-certificates` を使用する方法を説明しています。 **AWS CLI** **AWS アカウントの ACM 証明書を一覧表示する方法** 次の `list-certificates` コマンドは、アカウント内の証明書の ARN を一覧表示します。 ``` aws acm list-certificates ``` このコマンドを処理すると、次のような出力が生成されます。 ``` { "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" } ] } ``` `list-certificates` を呼び出すたびに表示される証明書の数を指定できます。例えば、証明書が 4 つあって一度に 2 つまでを表示する場合は、次の例のように `max-items` 引数を 2 に設定します。 ``` aws acm list-certificates --max-items 2 ``` 2 つの証明書 ARN と `NextToken` 値が表示されます。 ``` "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" ``` アカウント内の次の 2 つの証明書を表示するには、次の呼び出しで `NextToken` 値を設定します。 ``` aws acm list-certificates --max-items 2 --next-token 9f4d9f69-275a-41fe-b58e-2b837bd9ba48 ``` `certificate-statuses` 引数を使用して出力をフィルタリングできます。以下のコマンドは、PENDING\$1VALIDATION ステータスの証明書を表示します。 ``` aws acm list-certificates --certificate-statuses PENDING_VALIDATION ``` また、`includes` 引数を使用して出力をフィルタリングすることもできます。次のコマンドは、以下のプロパティでフィルタリングされた証明書を表示します。表示される証明書: ``` - 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/list-certificates.html)」を参照してください。 ### `list-tags-for-certificate` 次の例では、`list-tags-for-certificate` を使用する方法を説明しています。 **AWS CLI** **ACM 証明書に適用されたタグを一覧表示する方法** 次の `list-tags-for-certificate` コマンドは、アカウント内の証明書に適用されたタグを一覧表示します。 ``` aws acm list-tags-for-certificate --certificate-arn arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 ``` このコマンドを処理すると、次のような出力が生成されます。 ``` { "Tags": [ { "Value": "Website", "Key": "Purpose" }, { "Value": "Alice", "Key": "Admin" } ] } ``` + API の詳細については、**AWS CLI コマンドリファレンスの「[ListTagsForCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/list-tags-for-certificate.html)」を参照してください。 ### `remove-tags-from-certificate` 次の例では、`remove-tags-from-certificate` を使用する方法を説明しています。 **AWS CLI** **ACM 証明書からタグを削除する方法** 次の `remove-tags-from-certificate` のコマンドは、指定された証明書から 2 つのタグを削除します。複数のタグは空白で区切ります。 ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveTagsFromCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/remove-tags-from-certificate.html)」を参照してください。 ### `request-certificate` 次の例では、`request-certificate` を使用する方法を説明しています。 **AWS CLI** **新しい ACM 証明書をリクエストする方法** 次の `request-certificate` コマンドは、DNS 検証を使用して www.example.com ドメインの新しい証明書をリクエストします。 ``` aws acm request-certificate --domain-name www.example.com --validation-method DNS ``` べき等性トークンを入力して、`request-certificate` への呼び出しを区別できます。 ``` aws acm request-certificate --domain-name www.example.com --validation-method DNS --idempotency-token 91adc45q ``` サブジェクトの代替名を 1 つ以上入力して、複数の Apex ドメインを保護する証明書をリクエストできます。 ``` aws acm request-certificate --domain-name example.com --validation-method DNS --idempotency-token 91adc45q --subject-alternative-names www.example.net ``` ウェブサイトへのアクセスに使用できる代替名を入力することもできます。 ``` aws acm request-certificate --domain-name example.com --validation-method DNS --idempotency-token 91adc45q --subject-alternative-names www.example.com ``` アスタリスク (\$1) をワイルドカードとして使用して、同じドメイン内の複数のサブドメインの証明書を作成できます。 ``` aws acm request-certificate --domain-name example.com --validation-method DNS --idempotency-token 91adc45q --subject-alternative-names *.example.com ``` 複数の代替名を入力することもできます。 ``` aws acm request-certificate --domain-name example.com --validation-method DNS --subject-alternative-names b.example.com c.example.com d.example.com ``` 検証に E メールを使用している場合は、ドメイン検証オプションを入力して、検証 E メールの送信先ドメインを指定できます。 ``` 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 ``` 次のコマンドは、新しい証明書をリクエストしたときに、証明書の透明性ロギングをオプトアウトします。 ``` aws acm request-certificate --domain-name www.example.com --validation-method DNS --options CertificateTransparencyLoggingPreference=DISABLED --idempotency-token 184627 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RequestCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/request-certificate.html)」を参照してください。 ### `resend-validation-email` 次の例では、`resend-validation-email` を使用する方法を説明しています。 **AWS CLI** **ACM 証明書リクエストの検証 E メールを再送信する方法** 次の `resend-validation-email` コマンドは、Amazon 認証機関に検証 E メールを適切なアドレスに送信するように指示します。 ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ResendValidationEmail](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/resend-validation-email.html)」を参照してください。 ### `update-certificate-options` 次の例では、`update-certificate-options` を使用する方法を説明しています。 **AWS CLI** **証明書オプションを更新する方法** 次の `update-certificate-options` のコマンドは、証明書の透明性ロギングからオプトアウトします。 ``` aws acm update-certificate-options --certificate-arn arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 --options CertificateTransparencyLoggingPreference=DISABLED ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateCertificateOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm/update-certificate-options.html)」を参照してください。 # AWS CLI を使用した API Gateway の例 次のコードサンプルは、API Gateway で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-api-key` 次のコード例では、`create-api-key` を使用する方法を示しています。 **AWS CLI** **既存の API とステージで有効になっている API キーを作成する方法** コマンド: ``` aws apigateway create-api-key --name 'Dev API Key' --description 'Used for development' --enabled --stage-keys restApiId='a1b2c3d4e5',stageName='dev' ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateApiKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-api-key.html)」を参照してください。 ### `create-authorizer` 次のコード例では、`create-authorizer` を使用する方法を示しています。 **AWS CLI** **例 1: API のトークンベースの API Gateway Custom Authorizer を作成する方法** 次の `create-authorizer` の例では、トークンベースのオーソライザーを作成します。 ``` 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 ``` 出力: ``` { "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" } ``` **例 2: API の Cognito ユーザープールベースの API Gateway Custom Authorizer を作成する方法** 次の `create-authorizer` の例では、Cognito ユーザープールベースの API Gateway Custom Authorizer を作成します。 ``` 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' ``` 出力: ``` { "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" } ``` **例 3: API のリクエストベースの API Gateway Custom Authorizer を作成する方法** 次の `create-authorizer` の例では、リクエストベースのオーソライザーを作成します。 ``` 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 ``` 出力: ``` { "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 } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-authorizer.html)」を参照してください。 ### `create-base-path-mapping` 次のコード例では、`create-base-path-mapping` を使用する方法を示しています。 **AWS CLI** **カスタムドメイン名のベースパスマッピングを取得する方法** コマンド: ``` aws apigateway create-base-path-mapping --domain-name subdomain.domain.tld --rest-api-id 1234123412 --stage prod --base-path v1 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateBasePathMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-base-path-mapping.html)」を参照してください。 ### `create-deployment` 次のコード例では、`create-deployment` を使用する方法を示しています。 **AWS CLI** **API に設定したリソースを新しいステージにデプロイする方法** コマンド: ``` aws apigateway create-deployment --rest-api-id 1234123412 --stage-name dev --stage-description 'Development Stage' --description 'First deployment to the dev stage' ``` **API に設定したリソースを既存のステージにデプロイする方法** コマンド: ``` aws apigateway create-deployment --rest-api-id 1234123412 --stage-name dev --description 'Second deployment to the dev stage' ``` **ステージ変数を使用して、API に設定したリソースを既存のステージにデプロイする方法** aws apigateway create-deployment --rest-api-id 1234123412 --stage-name dev --description 'Third deployment to the dev stage' --variables key='value',otherKey='otherValue' + API の詳細については、AWS CLI コマンドリファレンスの「[CreateDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-deployment.html)」を参照してください。** ### `create-domain-name-access-association` 次のコード例は、`create-domain-name-access-association` を使用する方法を示しています。 **AWS CLI** **ドメイン名アクセスの関連付けを作成するには** 次の `create-domain-name-access-association` の例では、プライベートカスタムドメイン名と 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 ``` 出力: ``` { "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" } ``` 詳細については、*Amazon API Gateway デベロッパーガイド*の「[API Gateway でのプライベート API 用のカスタムドメイン名](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[CreateDomainNameAccessAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-domain-name-access-association.html)」を参照してください。 ### `create-domain-name` 次のコード例は、`create-domain-name` を使用する方法を示しています。 **AWS CLI** **例 1: パブリックカスタムドメイン名を作成するには** 次の `create-domain-name` の例では、パブリックカスタムドメイン名を作成します。 ``` 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' ``` 出力: ``` { "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" } ``` 詳細については、*Amazon API Gateway デベロッパーガイド*の「[API Gateway でのパブリック REST API 用のカスタムドメイン名](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)」を参照してください。 **例 2: プライベートカスタムドメイン名を作成するには** 次の `create-domain-name` の例では、プライベートカスタムドメイン名を作成します。 ``` 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 ``` `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" } } } ] } ``` 出力: ``` { "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\"}}}]}" } ``` 詳細については、*Amazon API Gateway デベロッパーガイド*の「[API Gateway でのパブリック REST API 用のカスタムドメイン名](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDomainName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-domain-name.html)」を参照してください。 ### `create-model` 次のコード例では、`create-model` を使用する方法を示しています。 **AWS CLI** **API 用のモデルを作成する方法** コマンド: ``` 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" } } } } }' ``` 出力: ``` { "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\" } } } } }" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-model.html)」を参照してください。 ### `create-resource` 次のコード例では、`create-resource` を使用する方法を示しています。 **AWS CLI** **API でリソースを作成する方法** コマンド: ``` aws apigateway create-resource --rest-api-id 1234123412 --parent-id a1b2c3 --path-part 'new-resource' ``` + API の詳細については、AWS CLI コマンドリファレンスの「[CreateResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-resource.html)」を参照してください。** ### `create-rest-api` 次のコード例では、`create-rest-api` を使用する方法を示しています。 **AWS CLI** **API を作成する方法** コマンド: ``` aws apigateway create-rest-api --name 'My First API' --description 'This is my first API' ``` **既存の API から複製 API を作成する方法** コマンド: ``` aws apigateway create-rest-api --name 'Copy of My First API' --description 'This is a copy of my first API' --clone-from 1234123412 ``` + API の詳細については、AWS CLI コマンドリファレンスの「[CreateRestApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-rest-api.html)」を参照してください。** ### `create-stage` 次のコード例では、`create-stage` を使用する方法を示しています。 **AWS CLI** **既存のデプロイを含む API にステージを作成する方法** コマンド: ``` aws apigateway create-stage --rest-api-id 1234123412 --stage-name 'dev' --description 'Development stage' --deployment-id a1b2c3 ``` **既存のデプロイとカスタムステージ変数を含む API でステージを作成する方法** コマンド: ``` aws apigateway create-stage --rest-api-id 1234123412 --stage-name 'dev' --description 'Development stage' --deployment-id a1b2c3 --variables key='value',otherKey='otherValue' ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-stage.html)」を参照してください。 ### `create-usage-plan-key` 次のコード例では、`create-usage-plan-key` を使用する方法を示しています。 **AWS CLI** **既存の API キーを使用量プランに関連付ける** コマンド: ``` aws apigateway create-usage-plan-key --usage-plan-id a1b2c3 --key-type "API_KEY" --key-id 4vq3yryqm5 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateUsagePlanKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-usage-plan-key.html)」を参照してください。 ### `create-usage-plan` 次のコード例では、`create-usage-plan` を使用する方法を示しています。 **AWS CLI** **月の初めにリセットされるスロットルとクォータの制限を使用して使用量プランを作成する方法** コマンド: ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateUsagePlan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/create-usage-plan.html)」を参照してください。 ### `delete-api-key` 次のコード例では、`delete-api-key` を使用する方法を示しています。 **AWS CLI** **API キーを削除する方法** コマンド: ``` aws apigateway delete-api-key --api-key 8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteApiKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-api-key.html)」を参照してください。 ### `delete-authorizer` 次のコード例では、`delete-authorizer` を使用する方法を示しています。 **AWS CLI** **API でカスタムオーソライザーを削除する方法** コマンド: ``` aws apigateway delete-authorizer --rest-api-id 1234123412 --authorizer-id 7gkfbo ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-authorizer.html)」を参照してください。 ### `delete-base-path-mapping` 次のコード例では、`delete-base-path-mapping` を使用する方法を示しています。 **AWS CLI** **カスタムドメイン名のベースパスマッピングを削除する方法** コマンド: ``` aws apigateway delete-base-path-mapping --domain-name 'api.domain.tld' --base-path 'dev' ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteBasePathMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-base-path-mapping.html)」を参照してください。 ### `delete-client-certificate` 次のコード例では、`delete-client-certificate` を使用する方法を示しています。 **AWS CLI** **クライアント証明書を削除する方法** コマンド: ``` aws apigateway delete-client-certificate --client-certificate-id a1b2c3 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteClientCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-client-certificate.html)」を参照してください。 ### `delete-deployment` 次のコード例では、`delete-deployment` を使用する方法を示しています。 **AWS CLI** **API のデプロイを削除する方法** コマンド: ``` aws apigateway delete-deployment --rest-api-id 1234123412 --deployment-id a1b2c3 ``` + API の詳細については、 コマンドリファレンスAWS CLIの「[DeleteDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-deployment.html)」を参照してください。** ### `delete-domain-name-access-association` 次のコード例は、`delete-domain-name-access-association` を使用する方法を示しています。 **AWS CLI** **ドメイン名アクセスの関連付けを削除するには** 次の `delete-domain-name-access-association` の例では、プライベートカスタムドメイン名と 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 ``` このコマンドでは何も出力されません。 詳細については、*Amazon API Gateway デベロッパーガイド*の「[API Gateway でのプライベート API 用のカスタムドメイン名](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DeleteDomainNameAccessAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-domain-name-access-association.html)」を参照してください。 ### `delete-domain-name` 次のコード例は、`delete-domain-name` を使用する方法を示しています。 **AWS CLI** **カスタムドメイン名を削除する方法** コマンド: ``` aws apigateway delete-domain-name --domain-name 'api.domain.tld' ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDomainName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-domain-name.html)」を参照してください。 ### `delete-integration-response` 次のコード例では、`delete-integration-response` を使用する方法を示しています。 **AWS CLI** **API で特定のリソース、メソッド、ステータスコードの統合レスポンスを削除する方法** コマンド: ``` aws apigateway delete-integration-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteIntegrationResponse](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-integration-response.html)」を参照してください。 ### `delete-integration` 次のコード例では、`delete-integration` を使用する方法を示しています。 **AWS CLI** **API で特定のリソースとメソッドの統合を削除する方法** コマンド: ``` aws apigateway delete-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteIntegration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-integration.html)」を参照してください。 ### `delete-method-response` 次のコード例では、`delete-method-response` を使用する方法を示しています。 **AWS CLI** **API で特定のリソース、メソッド、ステータスコードのメソッドレスポンスを削除する方法** コマンド: ``` aws apigateway delete-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteMethodResponse](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-method-response.html)」を参照してください。 ### `delete-method` 次のコード例では、`delete-method` を使用する方法を示しています。 **AWS CLI** **API で特定のリソースのメソッドを削除する方法** コマンド: ``` aws apigateway delete-method --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteMethod](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-method.html)」を参照してください。 ### `delete-model` 次のコード例では、`delete-model` を使用する方法を示しています。 **AWS CLI** **特定の API でモデルを削除する方法** コマンド: ``` aws apigateway delete-model --rest-api-id 1234123412 --model-name 'customModel' ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-model.html)」を参照してください。 ### `delete-resource` 次のコード例では、`delete-resource` を使用する方法を示しています。 **AWS CLI** **API でリソースを削除する方法** コマンド: ``` aws apigateway delete-resource --rest-api-id 1234123412 --resource-id a1b2c3 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-resource.html)」を参照してください。 ### `delete-rest-api` 次のコード例では、`delete-rest-api` を使用する方法を示しています。 **AWS CLI** **API を削除する方法** コマンド: ``` aws apigateway delete-rest-api --rest-api-id 1234123412 ``` + API の詳細については、AWS CLI コマンドリファレンスの「[DeleteRestApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-rest-api.html)」を参照してください。** ### `delete-stage` 次のコード例では、`delete-stage` を使用する方法を示しています。 **AWS CLI** **API でインスタンスを削除する方法** コマンド: ``` aws apigateway delete-stage --rest-api-id 1234123412 --stage-name 'dev' ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-stage.html)」を参照してください。 ### `delete-usage-plan-key` 次のコード例では、`delete-usage-plan-key` を使用する方法を示しています。 **AWS CLI** **使用量プランから API キーを削除する方法** コマンド: ``` aws apigateway delete-usage-plan-key --usage-plan-id a1b2c3 --key-id 1NbjQzMReAkeEQPNAW8r3dXsU2rDD7fc7f2Sipnu ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteUsagePlanKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-usage-plan-key.html)」を参照してください。 ### `delete-usage-plan` 次のコード例では、`delete-usage-plan` を使用する方法を示しています。 **AWS CLI** **使用量プランを削除する方法** コマンド: ``` aws apigateway delete-usage-plan --usage-plan-id a1b2c3 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteUsagePlan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/delete-usage-plan.html)」を参照してください。 ### `flush-stage-authorizers-cache` 次のコード例では、`flush-stage-authorizers-cache` を使用する方法を示しています。 **AWS CLI** **ステージのすべてのオーソライザーキャッシュエントリをすべて消去する方法** コマンド: ``` aws apigateway flush-stage-authorizers-cache --rest-api-id 1234123412 --stage-name dev ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[FlushStageAuthorizersCache](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/flush-stage-authorizers-cache.html)」を参照してください。 ### `flush-stage-cache` 次のコード例では、`flush-stage-cache` を使用する方法を示しています。 **AWS CLI** **API のステージのキャッシュをすべて消去する方法** 次の `flush-stage-cache` の例では、ステージのキャッシュをフラッシュします。 ``` aws apigateway flush-stage-cache \ --rest-api-id 1234123412 \ --stage-name dev ``` このコマンドでは何も出力されません。 詳細については、*Amazon API Gateway デベロッパーガイド*の「[API Gateway での API ステージキャッシュをフラッシュする](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html#flush-api-caching)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[FlushStageCache](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/flush-stage-cache.html)」を参照してください。 ### `generate-client-certificate` 次のコード例では、`generate-client-certificate` を使用する方法を示しています。 **AWS CLI** **クライアント側 SSL 証明書を作成する方法** コマンド: ``` aws apigateway generate-client-certificate --description 'My First Client Certificate' ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GenerateClientCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/generate-client-certificate.html)」を参照してください。 ### `get-account` 次のコード例では、`get-account` を使用する方法を示しています。 **AWS CLI** **API Gateway アカウント設定を取得する方法** コマンド: ``` aws apigateway get-account ``` 出力: ``` { "cloudwatchRoleArn": "arn:aws:iam::123412341234:role/APIGatewayToCloudWatchLogsRole", "throttleSettings": { "rateLimit": 500.0, "burstLimit": 1000 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-account.html)」を参照してください。 ### `get-api-key` 次のコード例では、`get-api-key` を使用する方法を示しています。 **AWS CLI** **特定の API に関する情報を取得する方法** コマンド: ``` aws apigateway get-api-key --api-key 8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk ``` 出力: ``` { "description": "My first key", "enabled": true, "stageKeys": [ "a1b2c3d4e5/dev", "e5d4c3b2a1/dev" ], "lastUpdatedDate": 1456184515, "createdDate": 1456184452, "id": "8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk", "name": "My key" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetApiKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-api-key.html)」を参照してください。 ### `get-api-keys` 次のコード例では、`get-api-keys` を使用する方法を示しています。 **AWS CLI** **API キーの一覧を取得する方法** コマンド: ``` aws apigateway get-api-keys ``` 出力: ``` { "items": [ { "description": "My first key", "enabled": true, "stageKeys": [ "a1b2c3d4e5/dev", "e5d4c3b2a1/dev" ], "lastUpdatedDate": 1456184515, "createdDate": 1456184452, "id": "8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk", "name": "My key" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetApiKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-api-keys.html)」を参照してください。 ### `get-authorizer` 次のコード例では、`get-authorizer` を使用する方法を示しています。 **AWS CLI** **API Gateway per-API Authorizer 設定を取得する方法** コマンド: ``` aws apigateway get-authorizer --rest-api-id 1234123412 --authorizer-id gfi4n3 ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-authorizer.html)」を参照してください。 ### `get-authorizers` 次のコード例では、`get-authorizers` を使用する方法を示しています。 **AWS CLI** **REST API のオーソライザーの一覧を取得する方法** コマンド: ``` aws apigateway get-authorizers --rest-api-id 1234123412 ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAuthorizers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-authorizers.html)」を参照してください。 ### `get-base-path-mapping` 次のコード例では、`get-base-path-mapping` を使用する方法を示しています。 **AWS CLI** **カスタムドメイン名のベースパスマッピングを取得する方法** コマンド: ``` aws apigateway get-base-path-mapping --domain-name subdomain.domain.tld --base-path v1 ``` 出力: ``` { "basePath": "v1", "restApiId": "1234w4321e", "stage": "api" } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[GetBasePathMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-base-path-mapping.html)」を参照してください。** ### `get-base-path-mappings` 次のコード例では、`get-base-path-mappings` を使用する方法を示しています。 **AWS CLI** **カスタムドメイン名のベースパスマッピングを取得する方法** コマンド: ``` aws apigateway get-base-path-mappings --domain-name subdomain.domain.tld ``` 出力: ``` { "items": [ { "basePath": "(none)", "restApiId": "1234w4321e", "stage": "dev" }, { "basePath": "v1", "restApiId": "1234w4321e", "stage": "api" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetBasePathMappings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-base-path-mappings.html)」を参照してください。 ### `get-client-certificate` 次のコード例では、`get-client-certificate` を使用する方法を示しています。 **AWS CLI** **クライアント証明書を取得する方法** コマンド: ``` aws apigateway get-client-certificate --client-certificate-id a1b2c3 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetClientCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-client-certificate.html)」を参照してください。 ### `get-client-certificates` 次のコード例では、`get-client-certificates` を使用する方法を示しています。 **AWS CLI** **クライアント証明書の一覧を取得する方法** コマンド: ``` aws apigateway get-client-certificates ``` 出力: ``` { "items": [ { "pemEncodedCertificate": "-----BEGIN CERTIFICATE----- -----END CERTIFICATE-----", "clientCertificateId": "a1b2c3", "expirationDate": 1483556561, "description": "My Client Certificate", "createdDate": 1452020561 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetClientCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-client-certificates.html)」を参照してください。 ### `get-deployment` 次のコード例では、`get-deployment` を使用する方法を示しています。 **AWS CLI** **デプロイの情報を取得する方法** コマンド: ``` aws apigateway get-deployment --rest-api-id 1234123412 --deployment-id ztt4m2 ``` 出力: ``` { "description": "myDeployment", "id": "ztt4m2", "createdDate": 1455218022 } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-deployment.html)」を参照してください。 ### `get-deployments` 次のコード例では、`get-deployments` を使用する方法を示しています。 **AWS CLI** **REST API のデプロイの一覧を取得する方法** コマンド: ``` aws apigateway get-deployments --rest-api-id 1234123412 ``` 出力: ``` { "items": [ { "createdDate": 1453797217, "id": "0a2b4c", "description": "Deployed my API for the first time" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-deployments.html)」を参照してください。 ### `get-domain-name-access-associations` 次のコード例は、`get-domain-name-access-associations` を使用する方法を示しています。 **AWS CLI** **例 1: すべてのドメイン名アクセスの関連付けを一覧表示するには** 次の `get-domain-name-access-associations` の例では、すべてのドメイン名アクセスの関連付けを一覧表示します。 ``` aws apigateway get-domain-name-access-associations ``` 出力: ``` { "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" } ] } ``` 詳細については、*Amazon API Gateway デベロッパーガイド*の「[API Gateway でのプライベート API 用のカスタムドメイン名](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains.html)」を参照してください。 **例 2: この AWS アカウントが所有するすべてのドメイン名アクセスの関連付けを一覧表示するには** 次の `get-domain-name-access-associations` の例では、現在の AWS アカウントが所有するすべてのドメイン名アクセスの関連付けを一覧表示します。 ``` aws apigateway get-domain-name-access-associations \ --resource-owner SELF ``` 出力: ``` { "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" } ] } ``` 詳細については、*Amazon API Gateway デベロッパーガイド*の「[API Gateway でのプライベート API 用のカスタムドメイン名](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[GetDomainNameAccessAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-domain-name-access-associations.html)」を参照してください。 ### `get-domain-name` 次のコード例は、`get-domain-name` を使用する方法を示しています。 **AWS CLI** **例 1: パブリックカスタムドメイン名に関する情報を取得するには** 次の `get-domain-name` の例では、パブリックカスタムドメイン名に関する情報を取得します。 ``` aws apigateway get-domain-name \ --domain-name api.domain.tld ``` 出力: ``` { "domainName": "api.domain.tld", "distributionDomainName": "d1a2f3a4c5o6d.cloudfront.net", "certificateName": "uploadedCertificate", "certificateUploadDate": 1462565487 } ``` 詳細については、*Amazon API Gateway デベロッパーガイド*の「[API Gateway でのパブリック REST API 用のカスタムドメイン名](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)」を参照してください。 **例 2: プライベートカスタムドメイン名に関する情報を取得するには** 次の `get-domain-name` の例では、プライベートカスタムドメイン名に関する情報を取得します。 ``` aws apigateway get-domain-name \ --domain-name api.private.domain.tld \ --domain-name-id abcd1234 ``` 出力: ``` { "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\"}}}]}" } ``` 詳細については、*Amazon API Gateway デベロッパーガイド*の「[API Gateway でのパブリック REST API 用のカスタムドメイン名](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDomainName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-domain-name.html)」を参照してください。 ### `get-domain-names` 次のコード例は、`get-domain-names` を使用する方法を示しています。 **AWS CLI** **例 1: カスタムドメイン名のリストを取得するには** 次の `get-domain-names` コマンドは、ドメイン名のリストを取得します。 ``` aws apigateway get-domain-names ``` 出力: ``` { "items": [ { "distributionDomainName": "d9511k3l09bkd.cloudfront.net", "certificateUploadDate": 1452812505, "certificateName": "my_custom_domain-certificate", "domainName": "subdomain.domain.tld" } ] } ``` 詳細については、*Amazon API Gateway デベロッパーガイド*の「[API Gateway でのプライベート API 用のカスタムドメイン名](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains.html)」を参照してください。 **例 2: この AWS アカウントが所有するカスタムドメイン名のリストを取得するには** 次の `get-domain-names` コマンドは、この AWS アカウントが所有するドメイン名のリストを取得します。 ``` aws apigateway get-domain-names \ --resource-owner SELF ``` 出力: ``` { "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" } ] } ``` 詳細については、*Amazon API Gateway デベロッパーガイド*の「[API Gateway でのプライベート API 用のカスタムドメイン名](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains.html)」を参照してください。 **例 3: 他の AWS アカウントが所有し、お客様がドメイン名アクセスの関連付けを作成できるカスタムドメイン名のリストを取得します。** 次の `get-domain-names` コマンドは、他の AWS アカウントが所有し、アクセス関連付けを作成できるカスタムドメイン名のリストを取得します。 ``` aws apigateway get-domain-names \ --resource-owner OTHER_ACCOUNTS ``` 出力: ``` { "items": [ { "domainName": "my.private.domain.tld", "domainNameId": "abcd1234", "domainNameArn": "arn:aws:apigateway:us-east-1:012345678910:/domainnames/my.private.domain.tld+abcd1234" } ] } ``` 詳細については、*Amazon API Gateway デベロッパーガイド*の「[API Gateway でのプライベート API 用のカスタムドメイン名](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDomainNames](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-domain-names.html)」を参照してください。 ### `get-export` 次のコード例では、`get-export` を使用する方法を示しています。 **AWS CLI** **ステージの JSON Swagger テンプレートを取得するには** コマンド: ``` aws apigateway get-export --rest-api-id a1b2c3d4e5 --stage-name dev --export-type swagger /path/to/filename.json ``` **ステージの JSON Swagger テンプレート \$1 API Gateway Extentions を取得する方法** コマンド: ``` aws apigateway get-export --parameters extensions='integrations' --rest-api-id a1b2c3d4e5 --stage-name dev --export-type swagger /path/to/filename.json ``` **ステージの JSON Swagger テンプレート \$1 Postman Extensions を取得する方法** コマンド: ``` aws apigateway get-export --parameters extensions='postman' --rest-api-id a1b2c3d4e5 --stage-name dev --export-type swagger /path/to/filename.json ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetExport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-export.html)」を参照してください。 ### `get-integration-response` 次のコード例では、`get-integration-response` を使用する方法を示しています。 **AWS CLI** **REST API のリソースで定義された HTTP メソッドの統合レスポンス構成を取得する方法** コマンド: ``` aws apigateway get-integration-response --rest-api-id 1234123412 --resource-id y9h6rt --http-method GET --status-code 200 ``` 出力: ``` { "statusCode": "200", "responseTemplates": { "application/json": null } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetIntegrationResponse](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-integration-response.html)」を参照してください。 ### `get-integration` 次のコード例では、`get-integration` を使用する方法を示しています。 **AWS CLI** **REST API のリソースで定義された HTTP メソッドの統合構成を取得する方法** コマンド: ``` aws apigateway get-integration --rest-api-id 1234123412 --resource-id y9h6rt --http-method GET ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetIntegration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-integration.html)」を参照してください。 ### `get-method-response` 次のコード例では、`get-method-response` を使用する方法を示しています。 **AWS CLI** **REST API のリソースで定義された HTTP メソッドのメソッドレスポンスリソース構成を取得する方法** コマンド: ``` aws apigateway get-method-response --rest-api-id 1234123412 --resource-id y9h6rt --http-method GET --status-code 200 ``` 出力: ``` { "responseModels": { "application/json": "Empty" }, "statusCode": "200" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetMethodResponse](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-method-response.html)」を参照してください。 ### `get-method` 次のコード例では、`get-method` を使用する方法を示しています。 **AWS CLI** **REST API のリソースで定義された HTTP メソッドのメソッドリソース構成を取得する方法** コマンド: ``` aws apigateway get-method --rest-api-id 1234123412 --resource-id y9h6rt --http-method GET ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetMethod](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-method.html)」を参照してください。 ### `get-model-template` 次のコード例では、`get-model-template` を使用する方法を示しています。 **AWS CLI** **REST API で定義されたモデルのマッピングテンプレートを取得する方法** コマンド: ``` aws apigateway get-model-template --rest-api-id 1234123412 --model-name Empty ``` 出力: ``` { "value": "#set($inputRoot = $input.path('$'))\n{ }" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetModelTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-model-template.html)」を参照してください。 ### `get-model` 次のコード例では、`get-model` を使用する方法を示しています。 **AWS CLI** **REST API で定義されたモデルの構成を取得する方法** コマンド: ``` aws apigateway get-model --rest-api-id 1234123412 --model-name Empty ``` 出力: ``` { "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}" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-model.html)」を参照してください。 ### `get-models` 次のコード例では、`get-models` を使用する方法を示しています。 **AWS CLI** **REST API のリソースの一覧を取得する方法** コマンド: ``` aws apigateway get-models --rest-api-id 1234123412 ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetModels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-models.html)」を参照してください。 ### `get-resource` 次のコード例では、`get-resource` を使用する方法を示しています。 **AWS CLI** **リソースに関する情報を取得する方法** コマンド: ``` aws apigateway get-resource --rest-api-id 1234123412 --resource-id zwo0y3 ``` 出力: ``` { "path": "/path", "pathPart": "path", "id": "zwo0y3", "parentId": "uyokt6ij2g" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-resource.html)」を参照してください。 ### `get-resources` 次のコード例では、`get-resources` を使用する方法を示しています。 **AWS CLI** **REST API のリソースの一覧を取得する方法** コマンド: ``` aws apigateway get-resources --rest-api-id 1234123412 ``` 出力: ``` { "items": [ { "path": "/resource/subresource", "resourceMethods": { "POST": {} }, "id": "024ace", "pathPart": "subresource", "parentId": "ai5b02" } ] } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[GetResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-resources.html)」を参照してください。** ### `get-rest-api` 次のコード例では、`get-rest-api` を使用する方法を示しています。 **AWS CLI** **API に関する情報を取得する方法** コマンド: ``` aws apigateway get-rest-api --rest-api-id 1234123412 ``` 出力: ``` { "name": "myAPI", "id": "o1y243m4f5", "createdDate": 1453416433 } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRestApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-rest-api.html)」を参照してください。 ### `get-rest-apis` 次のコード例では、`get-rest-apis` を使用する方法を示しています。 **AWS CLI** **REST API の一覧を取得する方法** コマンド: ``` aws apigateway get-rest-apis ``` 出力: ``` { "items": [ { "createdDate": 1438884790, "id": "12s44z21rb", "name": "My First API" } ] } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[GetRestApis](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-rest-apis.html)」を参照してください。** ### `get-sdk` 次のコード例では、`get-sdk` を使用する方法を示しています。 **AWS CLI** **REST API ステージの Android SDK を取得する方法** コマンド: ``` 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 ``` 出力: ``` { "contentType": "application/octet-stream", "contentDisposition": "attachment; filename=\"android_2016-02-22_23-52Z.zip\"" } ``` **REST API ステージの IOS SDK を取得する方法** コマンド: ``` aws apigateway get-sdk --rest-api-id 1234123412 --stage-name dev --sdk-type objectivec --parameters classPrefix='myprefix' /path/to/iOS_sdk.zip ``` 出力: ``` { "contentType": "application/octet-stream", "contentDisposition": "attachment; filename=\"objectivec_2016-02-22_23-52Z.zip\"" } ``` **REST API ステージの Javascript SDK を取得する方法** コマンド: ``` aws apigateway get-sdk --rest-api-id 1234123412 --stage-name dev --sdk-type javascript /path/to/javascript_sdk.zip ``` 出力: ``` { "contentType": "application/octet-stream", "contentDisposition": "attachment; filename=\"javascript_2016-02-22_23-52Z.zip\"" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetSdk](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-sdk.html)」を参照してください。 ### `get-stage` 次のコード例では、`get-stage` を使用する方法を示しています。 **AWS CLI** **API のステージに関する情報を取得する方法** コマンド: ``` aws apigateway get-stage --rest-api-id 1234123412 --stage-name dev ``` 出力: ``` { "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 } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-stage.html)」を参照してください。 ### `get-stages` 次のコード例では、`get-stages` を使用する方法を示しています。 **AWS CLI** **REST API のリソースの一覧を取得する方法** コマンド: ``` aws apigateway get-stages --rest-api-id 1234123412 ``` 出力: ``` { "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 } } } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetStages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-stages.html)」を参照してください。 ### `get-usage-plan-key` 次のコード例では、`get-usage-plan-key` を使用する方法を示しています。 **AWS CLI** **Usage Plan に関連付けられた API キーの詳細を取得する方法** コマンド: ``` aws apigateway get-usage-plan-key --usage-plan-id a1b2c3 --key-id 1NbjQzMReAkeEQPNAW8r3dXsU2rDD7fc7f2Sipnu ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetUsagePlanKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-usage-plan-key.html)」を参照してください。 ### `get-usage-plan-keys` 次のコード例では、`get-usage-plan-keys` を使用する方法を示しています。 **AWS CLI** **使用量プランに関連付けられた API キーの一覧を取得する方法** コマンド: ``` aws apigateway get-usage-plan-keys --usage-plan-id a1b2c3 ``` + API の詳細については、「**AWS CLI コマンドリファレンス」の「[GetUsagePlanKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-usage-plan-keys.html)」を参照してください。 ### `get-usage-plan` 次のコード例では、`get-usage-plan` を使用する方法を示しています。 **AWS CLI** **使用量プランの詳細を取得する方法** コマンド: ``` aws apigateway get-usage-plan --usage-plan-id a1b2c3 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetUsagePlan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-usage-plan.html)」を参照してください。 ### `get-usage-plans` 次のコード例では、`get-usage-plans` を使用する方法を示しています。 **AWS CLI** **すべての使用量プランの詳細を取得する方法** コマンド: ``` aws apigateway get-usage-plans ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetUsagePlans](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-usage-plans.html)」を参照してください。 ### `get-usage` 次のコード例では、`get-usage` を使用する方法を示しています。 **AWS CLI** **使用量プランの使用の詳細を取得する方法** コマンド: ``` aws apigateway get-usage --usage-plan-id a1b2c3 --start-date "2016-08-16" --end-date "2016-08-17" ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetUsage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/get-usage.html)」を参照してください。 ### `import-rest-api` 次のコード例では、`import-rest-api` を使用する方法を示しています。 **AWS CLI** **Swagger テンプレートをインポートして API を作成する方法** コマンド: ``` aws apigateway import-rest-api --body 'file:///path/to/API_Swagger_template.json' ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ImportRestApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/import-rest-api.html)」を参照してください。 ### `put-integration-response` 次のコード例では、`put-integration-response` を使用する方法を示しています。 **AWS CLI** **マッピングテンプレートを定義して、統合レスポンスをデフォルトレスポンスとして作成する方法** コマンド: ``` 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\"}"}' ``` **regex が 400 でヘッダー値が静的に定義された統合レスポンスを作成する方法** コマンド: ``` 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'"'"'"}' ``` + API の詳細については、**AWS CLI コマンドリファレンスの「[PutIntegrationResponse](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/put-integration-response.html)」を参照してください。 ### `put-integration` 次のコード例では、`put-integration` を使用する方法を示しています。 **AWS CLI** **MOCK 統合リクエストを作成する方法** コマンド: ``` aws apigateway put-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --type MOCK --request-templates '{ "application/json": "{\"statusCode\": 200}" }' ``` **HTTP 統合リクエストを作成する方法** コマンド: ``` 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' ``` **Lambda 関数エンドポイントを使用して AWS 統合リクエストを作成する方法** コマンド: ``` 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' ``` + API の詳細については、AWS CLI コマンドリファレンスの「[PutIntegration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/put-integration.html)」を参照してください。** ### `put-method-response` 次のコード例では、`put-method-response` を使用する方法を示しています。 **AWS CLI** **カスタムメソッドレスポンスヘッダーを使用して、指定したステータスコードでメソッドレスポンスを作成する方法** コマンド: ``` 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" ``` + API の詳細については、AWS CLI コマンドリファレンスの「[PutMethodResponse](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/put-method-response.html)」を参照してください。** ### `put-method` 次のコード例では、`put-method` を使用する方法を示しています。 **AWS CLI** **権限なし、API キーなし、カスタムメソッドリクエストヘッダーありで API 内のリソース用のメソッドを作成する方法** コマンド: ``` 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" ``` + API の詳細については、AWS CLI コマンドリファレンスの「[PutMethod](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/put-method.html)」を参照してください。** ### `put-rest-api` 次のコード例では、`put-rest-api` を使用する方法を示しています。 **AWS CLI** **Swagger テンプレートを使用して既存の API を上書きする方法** コマンド: ``` aws apigateway put-rest-api --rest-api-id 1234123412 --mode overwrite --body 'fileb:///path/to/API_Swagger_template.json' ``` **Swagger テンプレートを既存の API にマージする方法** コマンド: ``` aws apigateway put-rest-api --rest-api-id 1234123412 --mode merge --body 'fileb:///path/to/API_Swagger_template.json' ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutRestApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/put-rest-api.html)」を参照してください。 ### `reject-domain-name-access-association` 次のコード例は、`reject-domain-name-access-association` を使用する方法を示しています。 **AWS CLI** **ドメイン名アクセスの関連付けを拒否するには** 次の `reject-domain-name-access-association` の例では、プライベートカスタムドメイン名と 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 ``` このコマンドでは何も出力されません。 詳細については、*Amazon API Gateway デベロッパーガイド*の「[API Gateway でのプライベート API 用のカスタムドメイン名](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-private-custom-domains.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[RejectDomainNameAccessAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/reject-domain-name-access-association.html)」を参照してください。 ### `test-invoke-authorizer` 次のコード例は、`test-invoke-authorizer` を使用する方法を示しています。 **AWS CLI** **必要なヘッダーと値を含むカスタムオーソライザーへのリクエストをテストする方法** コマンド: ``` aws apigateway test-invoke-authorizer --rest-api-id 1234123412 --authorizer-id 5yid1t --headers Authorization='Value' ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TestInvokeAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/test-invoke-authorizer.html)」を参照してください。 ### `test-invoke-method` 次のコード例では、`test-invoke-method` を使用する方法を示しています。 **AWS CLI** **GET リクエストを実行して API のルートリソースをテストする方法** コマンド: ``` aws apigateway test-invoke-method --rest-api-id 1234123412 --resource-id avl5sg8fw8 --http-method GET --path-with-query-string '/' ``` **パスパラメータ値を指定して GET リクエストを実行し、API でサブリソースを呼び出すテストをする方法** コマンド: ``` aws apigateway test-invoke-method --rest-api-id 1234123412 --resource-id 3gapai --http-method GET --path-with-query-string '/pets/1' ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TestInvokeMethod](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/test-invoke-method.html)」を参照してください。 ### `update-account` 次のコード例では、`update-account` を使用する方法を示しています。 **AWS CLI** **CloudWatch Logs へのログ記録用の IAM ロール ARN を変更する方法** コマンド: ``` aws apigateway update-account --patch-operations op='replace',path='/cloudwatchRoleArn',value='arn:aws:iam::123412341234:role/APIGatewayToCloudWatchLogs' ``` 出力: ``` { "cloudwatchRoleArn": "arn:aws:iam::123412341234:role/APIGatewayToCloudWatchLogs", "throttleSettings": { "rateLimit": 1000.0, "burstLimit": 2000 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-account.html)」を参照してください。 ### `update-api-key` 次のコード例では、`update-api-key` を使用する方法を示しています。 **AWS CLI** **API キーの名前を変更する方法** コマンド: ``` aws apigateway update-api-key --api-key sNvjQDMReA1eEQPNAW8r37XsU2rDD7fc7m2SiMnu --patch-operations op='replace',path='/name',value='newName' ``` 出力: ``` { "description": "currentDescription", "enabled": true, "stageKeys": [ "41t2j324r5/dev" ], "lastUpdatedDate": 1470086052, "createdDate": 1445460347, "id": "sNvjQDMReA1vEQPNzW8r3dXsU2rrD7fcjm2SiMnu", "name": "newName" } ``` **API キーを無効にする方法** コマンド: ``` aws apigateway update-api-key --api-key sNvjQDMReA1eEQPNAW8r37XsU2rDD7fc7m2SiMnu --patch-operations op='replace',path='/enabled',value='false' ``` 出力: ``` { "description": "currentDescription", "enabled": false, "stageKeys": [ "41t2j324r5/dev" ], "lastUpdatedDate": 1470086052, "createdDate": 1445460347, "id": "sNvjQDMReA1vEQPNzW8r3dXsU2rrD7fcjm2SiMnu", "name": "newName" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateApiKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-api-key.html)」を参照してください。 ### `update-authorizer` 次のコード例では、`update-authorizer` を使用する方法を示しています。 **AWS CLI** **Custom Authorizer の名前を変更する方法** コマンド: ``` aws apigateway update-authorizer --rest-api-id 1234123412 --authorizer-id gfi4n3 --patch-operations op='replace',path='/name',value='testAuthorizer' ``` 出力: ``` { "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" } ``` **カスタムオーソライザーによって呼び出される Lambda 関数を変更する方法** コマンド: ``` 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' ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-authorizer.html)」を参照してください。 ### `update-base-path-mapping` 次のコード例では、`update-base-path-mapping` を使用する方法を示しています。 **AWS CLI** **カスタムドメイン名のベースパスマッピングを変更する方法** コマンド: ``` aws apigateway update-base-path-mapping --domain-name api.domain.tld --base-path prod --patch-operations op='replace',path='/basePath',value='v1' ``` 出力: ``` { "basePath": "v1", "restApiId": "1234123412", "stage": "api" } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[UpdateBasePathMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-base-path-mapping.html)」を参照してください。** ### `update-client-certificate` 次のコード例では、`update-client-certificate` を使用する方法を示しています。 **AWS CLI** **クライアント証明書の説明を更新する方法** コマンド: ``` aws apigateway update-client-certificate --client-certificate-id a1b2c3 --patch-operations op='replace',path='/description',value='My new description' ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateClientCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-client-certificate.html)」を参照してください。 ### `update-deployment` 次のコード例では、`update-deployment` を使用する方法を示しています。 **AWS CLI** **デプロイの説明を変更する方法** コマンド: ``` aws apigateway update-deployment --rest-api-id 1234123412 --deployment-id ztt4m2 --patch-operations op='replace',path='/description',value='newDescription' ``` 出力: ``` { "description": "newDescription", "id": "ztt4m2", "createdDate": 1455218022 } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-deployment.html)」を参照してください。 ### `update-domain-name` 次のコード例では、`update-domain-name` を使用する方法を示しています。 **AWS CLI** **カスタムドメイン名の証明書を変更する方法** 次の `update-domain-name` の例では、カスタムドメインの証明書名を変更します。 ``` 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' ``` 出力: ``` { "domainName": "api.domain.tld", "distributionDomainName": "d123456789012.cloudfront.net", "certificateArn": "arn:aws:acm:us-west-2:111122223333:certificate/CERTEXAMPLE123EXAMPLE", "certificateUploadDate": 1462565487 } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[Set up Custom Domain Name for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateDomainName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-domain-name.html)」を参照してください。 ### `update-integration-response` 次のコード例では、`update-integration-response` を使用する方法を示しています。 **AWS CLI** **統合レスポンスヘッダーを「\$1」の静的マッピングに変更する方法** コマンド: ``` 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='"'"'*'"'"' ``` 出力: ``` { "statusCode": "200", "responseParameters": { "method.response.header.Access-Control-Allow-Origin": "'*'" } } ``` **統合レスポンスヘッダーを削除する方法** コマンド: ``` 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' ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateIntegrationResponse](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-integration-response.html)」を参照してください。 ### `update-integration` 次のコード例では、`update-integration` を使用する方法を示しています。 **AWS CLI** **Input Passthrough で設定された「コンテンツタイプ: application/json」マッピングテンプレートを追加する方法** コマンド: ``` aws apigateway update-integration \ --rest-api-id a1b2c3d4e5 \ --resource-id a1b2c3 \ --http-method POST \ --patch-operations "op='add',path='/requestTemplates/application~1json'" ``` **カスタムテンプレートで設定された「コンテンツタイプ: application/json」マッピングテンプレートを更新 (置き換え) する方法** コマンド: ``` 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"}'" ``` **コンテンツタイプ: application/json」に関連付けられたカスタムテンプレートを Input Passthrough で更新 (置き換え) する方法** コマンド: ``` aws apigateway update-integration \ --rest-api-id a1b2c3d4e5 \ --resource-id a1b2c3 \ --http-method POST \ --patch-operations "op='replace',path='requestTemplates/application~1json'" ``` **コンテンツタイプ: application/json」マッピングテンプレートを削除する方法** コマンド: ``` aws apigateway update-integration \ --rest-api-id a1b2c3d4e5 \ --resource-id a1b2c3 \ --http-method POST \ --patch-operations "op='remove',path='/requestTemplates/application~1json'" ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateIntegration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-integration.html)」を参照してください。 ### `update-method-response` 次のコード例では、`update-method-response` を使用する方法を示しています。 **AWS CLI** **メソッドで 200 レスポンスの新しいメソッドレスポンスヘッダーを作成し、不要として定義する方法 (デフォルト）** コマンド: ``` 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" ``` **メソッドで 200 レスポンスのレスポンスモデルを削除する方法** コマンド: ``` 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" ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateMethodResponse](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-method-response.html)」を参照してください。 ### `update-method` 次のコード例では、`update-method` を使用する方法を示しています。 **AWS CLI** **例 1: API キーを要求するようにメソッドを変更する方法** 次の `update-method` の例では、API キーを要求するようにメソッドを変更します。 ``` aws apigateway update-method \ --rest-api-id 1234123412 \ --resource-id a1b2c3 \ --http-method GET \ --patch-operations op="replace",path="/apiKeyRequired",value="true" ``` 出力: ``` { "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": {} } } } } ``` **例 2: メソッドを変更して IAM 認証を要求する方法** 次の `update-method` の例では、IAM 認証を必要とするようにメソッドを変更します。 ``` aws apigateway update-method \ --rest-api-id 1234123412 \ --resource-id a1b2c3 \ --http-method GET \ --patch-operations op="replace",path="/authorizationType",value="AWS_IAM" ``` 出力: ``` { "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": {} } } } } ``` **例 3: Lambda 認証を要求するようにメソッドを変更する方法** 次の `update-method` の例では、メソッドを必要な Lambda 認証に変更します。 ``` 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" ``` 出力: ``` { "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": {} } } } } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway CLI と REST API を使用した使用量プランの作成、設定、テスト](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-create-usage-plans-with-rest-api.html)」と「[API Gateway の REST API へのアクセスの制御と管理](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-control-access-to-api.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateMethod](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-method.html)」を参照してください。 ### `update-model` 次のコード例では、`update-model` を使用する方法を示しています。 **AWS CLI** **API でモデルの説明を変更する方法** コマンド: ``` aws apigateway update-model --rest-api-id 1234123412 --model-name 'Empty' --patch-operations op=replace,path=/description,value='New Description' ``` **API でモデルのスキーマを変更する方法** コマンド: ``` 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\" }"' ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-model.html)」を参照してください。 ### `update-resource` 次のコード例では、`update-resource` を使用する方法を示しています。 **AWS CLI** **リソースを移動して API 内の別の親リソースに配置する方法** コマンド: ``` aws apigateway update-resource --rest-api-id 1234123412 --resource-id 1a2b3c --patch-operations op=replace,path=/parentId,value='3c2b1a' ``` 出力: ``` { "path": "/resource", "pathPart": "resource", "id": "1a2b3c", "parentId": "3c2b1a" } ``` **API でリソース (pathPart) の名前を変更する方法** コマンド: ``` aws apigateway update-resource --rest-api-id 1234123412 --resource-id 1a2b3c --patch-operations op=replace,path=/pathPart,value=newresourcename ``` 出力: ``` { "path": "/newresourcename", "pathPart": "newresourcename", "id": "1a2b3c", "parentId": "3c2b1a" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-resource.html)」を参照してください。 ### `update-rest-api` 次のコード例では、`update-rest-api` を使用する方法を示しています。 **AWS CLI** **API の名前を変更する方法** コマンド: ``` aws apigateway update-rest-api --rest-api-id 1234123412 --patch-operations op=replace,path=/name,value='New Name' ``` **API の説明を変更する方法** コマンド: ``` aws apigateway update-rest-api --rest-api-id 1234123412 --patch-operations op=replace,path=/description,value='New Description' ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateRestApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-rest-api.html)」を参照してください。 ### `update-stage` 次のコード例では、`update-stage` を使用する方法を示しています。 **AWS CLI** **例 1: リソースとメソッドのステージ設定を上書きする方法** 次の `update-stage` の例では、ステージ設定を上書きし、特定のリソースとメソッドの完全なリクエスト/レスポンスログ記録をオフにします。 ``` aws apigateway update-stage \ --rest-api-id 1234123412 \ --stage-name 'dev' \ --patch-operations op=replace,path=/~1resourceName/GET/logging/dataTrace,value=false ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[REST API にステージを設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-stages.html)」を参照してください。 **例 2: API ステージのすべてのリソースとメソッドのステージ設定を更新する方法** 次の `update-stage` の例では、API ステージのすべてのリソースとメソッドの完全なリクエスト/レスポンスログ記録をオンにします。 ``` aws apigateway update-stage \ --rest-api-id 1234123412 \ --stage-name 'dev' \ --patch-operations 'op=replace,path=/*/*/logging/dataTrace,value=true' ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[REST API にステージを設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-stages.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-stage.html)」を参照してください。 ### `update-usage-plan` 次のコード例では、`update-usage-plan` を使用する方法を示しています。 **AWS CLI** **使用量プランで定義された期間を変更する方法** コマンド: ``` aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/quota/period",value="MONTH" ``` **使用量プランで定義されているクォータ制限を変更する方法** コマンド: ``` aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/quota/limit",value="500" ``` **使用量プランで定義されているスロットルレート制限を変更する方法** コマンド: ``` aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/throttle/rateLimit",value="10" ``` **使用量プランで定義されているスロットルバースト制限を変更する方法** コマンド: ``` aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/throttle/burstLimit",value="20" ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateUsagePlan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-usage-plan.html)」を参照してください。 ### `update-usage` 次のコード例では、`update-usage` を使用する方法を示しています。 **AWS CLI** **使用量プランで定義されている現在の期間の API キーのクォータを一時的に変更する方法** コマンド: ``` aws apigateway update-usage --usage-plan-id a1b2c3 --key-id 1NbjQzMReAkeEQPNAW8r3dXsU2rDD7fc7f2Sipnu --patch-operations op="replace",path="/remaining",value="50" ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateUsage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-usage.html)」を参照してください。 ### `update-vpc-link` 次の例は、`update-vpc-link` を使用する方法を説明しています。 **AWS CLI** **例 1: 既存の VPC リンク名を更新するには** 次の `update-vpc-link` の例では、指定された VPC リンクの名前を更新します。 ``` aws apigateway update-vpc-link \ --vpc-link-id ab3de6 \ --patch-operations op=replace,path=/name,value=my-vpc-link ``` 出力: ``` { "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": {} } ``` 詳細については、「*AWS CLI コマンドリファレンス*」の「[既存の VPC リンクの更新](https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-vpc-link.html)」を参照してください。 **例 2: 既存の VPC リンク名と説明を更新するには** 次の `update-vpc-link` の例では、指定された 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" ``` 出力: ``` { "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": {} } ``` 詳細については、「*AWS CLI コマンドリファレンス*」の「[既存の VPC リンクの更新](https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-vpc-link.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateVpcLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigateway/update-vpc-link.html)」を参照してください。 # AWS CLI を使用した API Gateway HTTP と WebSocket API の例 次のコード例は、API Gateway と WebSocket API で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-api-mapping` 次のコード例は、`create-api-mapping` を使用する方法を示しています。 **AWS CLI** **API 用に API マッピングを作成するには** 次の `create-api-mapping` の例では、API の `test` のステージをカスタムドメイン名「`regional.example.com`」のパス「`/myApi`」にマッピングします。 ``` aws apigatewayv2 create-api-mapping \ --domain-name regional.example.com \ --api-mapping-key myApi \ --api-id a1b2c3d4 \ --stage test ``` 出力: ``` { "ApiId": "a1b2c3d4", "ApiMappingId": "0qzs2sy7bh", "ApiMappingKey": "myApi" "Stage": "test" } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway でリージョナルカスタムドメイン名を設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドレットリファレンス*」の「[CreateApiMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-api-mapping.html)」を参照してください。 ### `create-api` 次のコード例は、`create-api` を使用する方法を示しています。 **AWS CLI** **HTTP API を作成する方法** 次の `create-api` の例では、クイック作成を使用して HTTP API を作成します。クイック作成を使用して、AWS Lambda または HTTP 統合、デフォルトのキャッチオールルート、変更を自動的にデプロイするように設定されたデフォルトステージを持つ API を作成できます。次のコマンドは、クイック作成を使用して、Lambda 関数と統合する HTTP API を作成します。 ``` aws apigatewayv2 create-api \ --name my-http-api \ --protocol-type HTTP \ --target arn:aws:lambda:us-west-2:123456789012:function:my-lambda-function ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway での HTTP API の開発](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop.html)」を参照してください。 **WebSocket API を作成する方法** 次の `create-api` の例では、指定された名前の WebSocket API を作成します。 ``` aws apigatewayv2 create-api \ --name "myWebSocketApi" \ --protocol-type WEBSOCKET \ --route-selection-expression '$request.body.action' ``` 出力: ``` { "ApiKeySelectionExpression": "$request.header.x-api-key", "Name": "myWebSocketApi", "CreatedDate": "2018-11-15T06:23:51Z", "ProtocolType": "WEBSOCKET", "RouteSelectionExpression": "'$request.body.action'", "ApiId": "aabbccddee" } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway での WebSocket API の作成](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-create-empty-api.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-api.html)」を参照してください。 ### `create-authorizer` 次のコード例は、`create-authorizer` を使用する方法を示しています。 **AWS CLI** **HTTP API の JWT オーソライザーを作成する方法** 次の `create-authorizer` の例では、Amazon Cognito を ID プロバイダーとして使用する JWT オーソライザーを作成します。 ``` 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 ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[JWT オーソライザーを使用した HTTP API へのアクセスの制御](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-authorizer.html)」を参照してください。 ### `create-deployment` 次のコード例は、`create-deployment` を使用する方法を示しています。 **AWS CLI** **API のデプロイを作成する方法** 次の `create-deployment` の例では、API にデプロイを作成し、API の `dev` ステージにデプロイを関連付けます。 ``` aws apigatewayv2 create-deployment \ --api-id a1b2c3d4 \ --stage-name dev ``` 出力: ``` { "AutoDeployed": false, "CreatedDate": "2020-04-06T23:38:08Z", "DeploymentId": "53lz9l", "DeploymentStatus": "DEPLOYED" } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API デプロイ](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-basic-concept.html#apigateway-definition-api-deployment)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[CreateDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-deployment.html)」を参照してください。** ### `create-domain-name` 次のコード例は、`create-domain-name` を使用する方法を示しています。 **AWS CLI** **カスタムドメイン名を作成する方法** 次の `create-domain-name` の例では、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 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway でリージョナルカスタムドメイン名を設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDomainName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-domain-name.html)」を参照してください。 ### `create-integration` 次のコード例は、`create-integration` を使用する方法を示しています。 **AWS CLI** **WebSocket API 統合を作成する方法** 次の `create-integration` の例では、WebSocket API 用のモック統合を作成します。 ``` aws apigatewayv2 create-integration \ --api-id aabbccddee \ --passthrough-behavior WHEN_NO_MATCH \ --timeout-in-millis 29000 \ --connection-type INTERNET \ --integration-type MOCK ``` 出力: ``` { "ConnectionType": "INTERNET", "IntegrationId": "0abcdef", "IntegrationResponseSelectionExpression": "${integration.response.statuscode}", "IntegrationType": "MOCK", "PassthroughBehavior": "WHEN_NO_MATCH", "PayloadFormatVersion": "1.0", "TimeoutInMillis": 29000 } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway での WebSocket API 統合リクエストのセットアップ](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-requests.html)」を参照してください。 **HTTP API カスタム統合を作成する方法** 次の `create-integration` の例では、HTTP API の AWS Lambda 統合を作成します。 ``` 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 ``` 出力: ``` { "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 } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API 統合の設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateIntegration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-integration.html)」を参照してください。 ### `create-route` 次のコード例は、`create-route` を使用する方法を示しています。 **AWS CLI** **WebSocket または HTTP API の \$1default ルートを作成する方法** 次の `create-route` の例では、WebSocket または HTTP API の `$default` ルートを作成します。 ``` aws apigatewayv2 create-route \ --api-id aabbccddee \ --route-key '$default' ``` 出力: ``` { "ApiKeyRequired": false, "AuthorizationType": "NONE", "RouteKey": "$default", "RouteId": "1122334" } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[WebSocket API のルートの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-add-route.html)」を参照してください。 **HTTP API のルートを作成する方法** 次の `create-route` の例では、POST リクエストを受け入れる「`signup`」という名前のルートを作成します。 ``` aws apigatewayv2 create-route \ --api-id aabbccddee \ --route-key 'POST /signup' ``` 出力: ``` { "ApiKeyRequired": false, "AuthorizationType": "NONE", "RouteKey": "POST /signup", "RouteId": "1122334" } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API のルートの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-route.html)」を参照してください。 ### `create-routing-rule` 次のコード例は、`create-routing-rule` を使用する方法を示しています。 **AWS CLI** **ルーティングルールを作成するには** 次の `create-routing-rule` の例では、優先度が `50` のルーティングルールを作成します。 ``` aws apigatewayv2 create-routing-rule \ --domain-name 'regional.example.com' \ --priority 50 \ --conditions '[ \ { \ "MatchBasePaths": { \ "AnyOf": [ \ "PetStoreShopper" \ ] \ } \ } \ ]' \ --actions '[ \ { \ "InvokeApi": { \ "ApiId": "abcd1234", \ "Stage": "prod" \ } \ } \ ]' ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API ステージを REST API のカスタムドメイン名に接続するためのルーティングルール](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateRoutingRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-routing-rule.html)」を参照してください。 ### `create-stage` 次のコード例は、`create-stage` を使用する方法を示しています。 **AWS CLI** **ステージを作成する方法** 次の `create-stage` の例では、 API に「dev」という名前のステージを作成します。 ``` aws apigatewayv2 create-stage \ --api-id a1b2c3d4 \ --stage-name dev ``` 出力: ``` { "CreatedDate": "2020-04-06T23:23:46Z", "DefaultRouteSettings": { "DetailedMetricsEnabled": false }, "LastUpdatedDate": "2020-04-06T23:23:46Z", "RouteSettings": {}, "StageName": "dev", "StageVariables": {}, "Tags": {} } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API のルートの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-stages.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-stage.html)」を参照してください。 ### `create-vpc-link` 次のコード例は、`create-vpc-link` を使用する方法を示しています。 **AWS CLI** **HTTP API の VPC リンクを作成する方法** 次の `create-vpc-link` の例では、HTTP API の VPC リンクを作成します。 ``` aws apigatewayv2 create-vpc-link \ --name MyVpcLink \ --subnet-ids subnet-aaaa subnet-bbbb \ --security-group-ids sg1234 sg5678 ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API の VPC リンクの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateVpcLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/create-vpc-link.html)」を参照してください。 ### `delete-access-log-settings` 次のコード例は、`delete-access-log-settings` を使用する方法を示しています。 **AWS CLI** **API のアクセスログ記録を無効にする方法** 次の `delete-access-log-settings` の例では、API の `$default` ステージのアクセスログ設定を削除します。ステージのアクセスログ記録を無効にするには、そのアクセスログ設定を削除します。 ``` aws apigatewayv2 delete-access-log-settings \ --api-id a1b2c3d4 \ --stage-name '$default' ``` このコマンドでは何も出力されません。 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API 記録の設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-logging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAccessLogSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-access-log-settings.html)」を参照してください。 ### `delete-api-mapping` 次のコード例は、`delete-api-mapping` を使用する方法を示しています。 **AWS CLI** **API マッピングを削除する方法** 次の `delete-api-mapping` の例は、カスタムドメイン名「`api.example.com`」の API マッピングを削除します。 ``` aws apigatewayv2 delete-api-mapping \ --api-mapping-id a1b2c3 \ --domain-name api.example.com ``` このコマンドでは何も出力されません。 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway でリージョナルカスタムドメイン名を設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteApiMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-api-mapping.html)」を参照してください。 ### `delete-api` 次のコード例は、`delete-api` を使用する方法を示しています。 **AWS CLI** **API を削除する方法** 次の `delete-api` の例は、API を削除します。 ``` aws apigatewayv2 delete-api \ --api-id a1b2c3d4 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API の使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html)」と「[WebSocket API の使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-api.html)」を参照してください。 ### `delete-authorizer` 次のコード例は、`delete-authorizer` を使用する方法を示しています。 **AWS CLI** **オーソライザーを削除する方法** 次の `delete-authorizer` の例では、オーソライザーを削除します。 ``` aws apigatewayv2 delete-authorizer \ --api-id a1b2c3d4 \ --authorizer-id a1b2c3 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[JWT オーソライザーを使用した HTTP API へのアクセスの制御](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-authorizer.html)」を参照してください。 ### `delete-cors-configuration` 次のコード例は、`delete-cors-configuration` を使用する方法を示しています。 **AWS CLI** **HTTP API の CORS 構成を削除する方法** 次の `delete-cors-configuration` の例では、CORS 構成を削除することで HTTP API の CORS を無効にします。 ``` aws apigatewayv2 delete-cors-configuration \ --api-id a1b2c3d4 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API CORS の設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCorsConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-cors-configuration.html)」を参照してください。 ### `delete-deployment` 次のコード例は、`delete-deployment` を使用する方法を示しています。 **AWS CLI** **デプロイを削除する方法** 次の `delete-deployment` の例では、API のデプロイを削除します。 ``` aws apigatewayv2 delete-deployment \ --api-id a1b2c3d4 \ --deployment-id a1b2c3 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API デプロイ](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-basic-concept.html#apigateway-definition-api-deployment)」を参照してください。 + API の詳細については、 コマンドリファレンスAWS CLIの「[DeleteDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-deployment.html)」を参照してください。** ### `delete-domain-name` 次のコード例では、`delete-domain-name` を使用する方法を示しています。 **AWS CLI** **カスタムドメイン名を削除する方法** 次の `delete-domain-name` の例では、カスタムドメイン名を削除します。 ``` aws apigatewayv2 delete-domain-name \ --domain-name api.example.com ``` このコマンドでは何も出力されません。 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway でリージョナルカスタムドメイン名を設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDomainName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-domain-name.html)」を参照してください。 ### `delete-integration` 次のコード例は、`delete-integration` を使用する方法を示しています。 **AWS CLI** **統合を削除する方法** 次の `delete-integration` の例では、API 統合を削除します。 ``` aws apigatewayv2 delete-integration \ --api-id a1b2c3d4 \ --integration-id a1b2c3 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API 統合の設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations.html)」と「[WebSocket API 統合の設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integrations.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteIntegration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-integration.html)」を参照してください。 ### `delete-route-settings` 次のコード例は、`delete-route-settings` を使用する方法を示しています。 **AWS CLI** **ルート設定を削除する方法** 次の `delete-route-settings` の例では、指定されたルートのルート設定を削除します。 ``` aws apigatewayv2 delete-route-settings \ --api-id a1b2c3d4 \ --stage-name dev \ --route-key 'GET /pets' ``` このコマンドでは何も出力されません。 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API のルートの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRouteSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-route-settings.html)」を参照してください。 ### `delete-route` 次のコード例は、`delete-route` を使用する方法を示しています。 **AWS CLI** **ルートを削除する方法** 次の `delete-route` の例では、API ルートを削除します。 ``` aws apigatewayv2 delete-route \ --api-id a1b2c3d4 \ --route-id a1b2c3 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API のルートの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-route.html)」を参照してください。 ### `delete-routing-rule` 次のコード例は、`delete-routing-rule` を使用する方法を示しています。 **AWS CLI** **ルーティングルールを削除するには** 次の `delete-routing-rule` の例では、カスタムドメイン名のルーティングルールを削除します。 ``` aws apigatewayv2 delete-routing-rule \ --domain-name 'regional.example.com' \ --routing-rule-id aaa111 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API ステージを REST API のカスタムドメイン名に接続するためのルーティングルール](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRoutingRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-routing-rule.html)」を参照してください。 ### `delete-stage` 次のコード例は、`delete-stage` を使用する方法を示しています。 **AWS CLI** **ステージを削除する方法** 次の `delete-stage` の例では、API の `test` ステージを削除します。 ``` aws apigatewayv2 delete-stage \ --api-id a1b2c3d4 \ --stage-name test ``` このコマンドでは何も出力されません。 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API のルートの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-stages.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-stage.html)」を参照してください。 ### `delete-vpc-link` 次のコード例は、`delete-vpc-link` を使用する方法を示しています。 **AWS CLI** **HTTP API の VPC リンクを削除する方法** 次の `delete-vpc-link` の例は、VPC リンクを削除します。 ``` aws apigatewayv2 delete-vpc-link \ --vpc-link-id abcd123 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API の VPC リンクの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteVpcLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/delete-vpc-link.html)」を参照してください。 ### `export-api` 次のコード例は、`export-api` を使用する方法を示しています。 **AWS CLI** **HTTP API の OpenAPI 定義をエクスポートする方法** 次の `export-api` の例は、「`prod`」という名前の API ステージの OpenAPI 3.0 定義を、 「`stage-definition.yaml`」という名前の YAML ファイルにエクスポートします。エクスポートされた定義ファイルには、デフォルトで API Gateway 拡張が含まれます。 ``` aws apigatewayv2 export-api \ --api-id a1b2c3d4 \ --output-type YAML \ --specification OAS30 \ --stage-name prod \ stage-definition.yaml ``` このコマンドでは何も出力されません。 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway から HTTP API のエクスポート](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-export.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ExportApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/export-api.html)」を参照してください。 ### `get-api-mapping` 次のコード例は、`get-api-mapping` を使用する方法を示しています。 **AWS CLI** **カスタムドメイン名の API マッピングに関する情報を取得するには** 次の `get-api-mapping` の例では、カスタムドメイン名「`api.example.com`」の API マッピングに関する情報を表示します。 ``` aws apigatewayv2 get-api-mapping \ --api-mapping-id a1b2c3 \ --domain-name api.example.com ``` 出力: ``` { "ApiId": "a1b2c3d4", "ApiMappingId": "a1b2c3d5", "ApiMappingKey": "myTestApi" "Stage": "test" } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway でリージョナルカスタムドメイン名を設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetApiMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-api-mapping.html)」を参照してください。 ### `get-api-mappings` 次のコード例は、`get-api-mappings` を使用する方法を示しています。 **AWS CLI** **カスタムドメイン名の API マッピングを取得する方法** 次の `get-api-mappings` の例では、カスタムドメイン名「`api.example.com`」の API マッピングのすべてを一覧表示します。 ``` aws apigatewayv2 get-api-mappings \ --domain-name api.example.com ``` 出力: ``` { "Items": [ { "ApiId": "a1b2c3d4", "ApiMappingId": "a1b2c3d5", "ApiMappingKey": "myTestApi" "Stage": "test" }, { "ApiId": "a5b6c7d8", "ApiMappingId": "a1b2c3d6", "ApiMappingKey": "myDevApi" "Stage": "dev" }, ] } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway でリージョナルカスタムドメイン名を設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetApiMappings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-api-mappings.html)」を参照してください。 ### `get-api` 次のコード例は、`get-api` を使用する方法を示しています。 **AWS CLI** **API に関する情報を取得する方法** 以下の `get-api` の例では、API に関する情報を表示します。 ``` aws apigatewayv2 get-api \ --api-id a1b2c3d4 ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-api.html)」を参照してください。 ### `get-apis` 次のコード例は、`get-apis` を使用する方法を示しています。 **AWS CLI** **API の一覧を取得する方法** 次の `get-apis` の例では、現在のユーザーのすべての API を一覧表示します。 ``` aws apigatewayv2 get-apis ``` 出力: ``` { "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": {} } ] } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API の使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html)」と「[WebSocket API の使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetApis](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-apis.html)」を参照してください。 ### `get-authorizer` 次のコード例は、`get-authorizer` を使用する方法を示しています。 **AWS CLI** **オーソライザーに関する情報を取得する方法** 以下の `get-authorizer` の例では、オーソライザーに関する情報を表示します。 ``` aws apigatewayv2 get-authorizer \ --api-id a1b2c3d4 \ --authorizer-id a1b2c3 ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[JWT オーソライザーを使用した HTTP API へのアクセスの制御](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-authorizer.html)」を参照してください。 ### `get-authorizers` 次のコード例は、`get-authorizers` を使用する方法を示しています。 **AWS CLI** **API のオーソライザーの一覧を取得する方法** 次の `get-authorizers` の例では、API のすべてのオーソライザーを一覧表示します。 ``` aws apigatewayv2 get-authorizers \ --api-id a1b2c3d4 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[JWT オーソライザーを使用した HTTP API へのアクセスの制御](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAuthorizers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-authorizers.html)」を参照してください。 ### `get-deployment` 次のコード例は、`get-deployment` を使用する方法を示しています。 **AWS CLI** **デプロイの情報を取得する方法** 以下の `get-deployment` の例では、デプロイに関する情報を表示します。 ``` aws apigatewayv2 get-deployment \ --api-id a1b2c3d4 \ --deployment-id abcdef ``` 出力: ``` { "AutoDeployed": true, "CreatedDate": "2020-04-07T23:58:40Z", "DeploymentId": "abcdef", "DeploymentStatus": "DEPLOYED", "Description": "Automatic deployment triggered by changes to the Api configuration" } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API デプロイ](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-basic-concept.html#apigateway-definition-api-deployment)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-deployment.html)」を参照してください。 ### `get-deployments` 次のコード例は、`get-deployments` を使用する方法を示しています。 **AWS CLI** **デプロイの一覧を取得する方法** 次の `get-deployments` の例では、すべての API のデプロイの一覧を表示します。 ``` aws apigatewayv2 get-deployments \ --api-id a1b2c3d4 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API デプロイ](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-basic-concept.html#apigateway-definition-api-deployment)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-deployments.html)」を参照してください。 ### `get-domain-name` 次のコード例は、`get-domain-name` を使用する方法を示しています。 **AWS CLI** **カスタムドメイン名に関する情報を取得する方法** 次の `get-domain-name` の例では、カスタムドメイン名に関する情報を表示します。 ``` aws apigatewayv2 get-domain-name \ --domain-name api.example.com ``` 出力: ``` { "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": {} } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway でリージョナルカスタムドメイン名を設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDomainName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-domain-name.html)」を参照してください。 ### `get-domain-names` 次のコード例は、`get-domain-names` を使用する方法を示しています。 **AWS CLI** **カスタムドメイン名の一覧を取得する方法** 次の `get-domain-names` の例では、現在のユーザーのすべてのカスタムドメイン名を一覧表示します。 ``` aws apigatewayv2 get-domain-names ``` 出力: ``` { "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" } ] } ] } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway でリージョナルカスタムドメイン名を設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDomainNames](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-domain-names.html)」を参照してください。 ### `get-integration` 次のコード例は、`get-integration` を使用する方法を示しています。 **AWS CLI** **統合に関する情報を取得する方法** 以下の `get-integration` の例では、統合に関する情報を表示します。 ``` aws apigatewayv2 get-integration \ --api-id a1b2c3d4 \ --integration-id a1b2c3 ``` 出力: ``` { "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 } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API 統合の設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations.html)」と「[WebSocket API 統合の設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integrations.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetIntegration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-integration.html)」を参照してください。 ### `get-integrations` 次のコード例は、`get-integrations` を使用する方法を示しています。 **AWS CLI** **統合の一覧を取得する方法** 次の `get-integrations` の例では、すべての API の統合の一覧を表示します。 ``` aws apigatewayv2 get-integrations \ --api-id a1b2c3d4 ``` 出力: ``` { "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 } ] } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API 統合の設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations.html)」と「[WebSocket API 統合の設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integrations.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetIntegrations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-integrations.html)」を参照してください。 ### `get-route` 次のコード例は、`get-route` を使用する方法を示しています。 **AWS CLI** **ルートに関する情報を取得するには** 以下の `get-route` の例では、ルートに関する情報を表示します。 ``` aws apigatewayv2 get-route \ --api-id a1b2c3d4 \ --route-id 72jz1wk ``` 出力: ``` { "ApiKeyRequired": false, "AuthorizationType": "NONE", "RouteId": "72jz1wk", "RouteKey": "ANY /pets", "Target": "integrations/a1b2c3" } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API のルートの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-route.html)」を参照してください。 ### `get-routes` 次のコード例は、`get-routes` を使用する方法を示しています。 **AWS CLI** **ルートの一覧を取得する方法** 次の `get-routes` の例では、API のすべてのルートの一覧を表示します。 ``` aws apigatewayv2 get-routes \ --api-id a1b2c3d4 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API のルートの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRoutes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-routes.html)」を参照してください。 ### `get-routing-rule` 次のコード例は、`get-routing-rule` を使用する方法を示しています。 **AWS CLI** **ルーティングルールを取得するには** 次の `get-routing-rule` の例では、ドメイン名のルーティングルールを取得します。 ``` aws apigatewayv2 get-routing-rule \ --domain-name 'regional.example.com' \ --routing-rule-id aaa111 ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API ステージを REST API のカスタムドメイン名に接続するためのルーティングルール](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRoutingRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-routing-rule.html)」を参照してください。 ### `get-stage` 次のコード例は、`get-stage` を使用する方法を示しています。 **AWS CLI** **ステージに関する情報を取得するには** 以下の `get-stage` の例では、API の `prod` ステージに関する情報を表示します。 ``` aws apigatewayv2 get-stage \ --api-id a1b2c3d4 \ --stage-name prod ``` 出力: ``` { "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": {} } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API のルートの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-stages.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-stage.html)」を参照してください。 ### `get-stages` 次のコード例は、`get-stages` を使用する方法を示しています。 **AWS CLI** **ステージの一覧を取得する方法** 次の `get-stages` の例では、API のすべてのステージを一覧表示します。 ``` aws apigatewayv2 get-stages \ --api-id a1b2c3d4 ``` 出力: ``` { "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": {} } ] } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API のルートの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-stages.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetStages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-stages.html)」を参照してください。 ### `get-tags` 次のコード例は、`get-tags` を使用する方法を示しています。 **AWS CLI** **リソースのタグの一覧を取得する方法** 次の `get-tags` の例では、API のすべてのタグを一覧表示します。 ``` aws apigatewayv2 get-tags \ --resource-arn arn:aws:apigateway:us-west-2::/apis/a1b2c3d4 ``` 出力: ``` { "Tags": { "owner": "dev-team", "environment": "prod" } } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway リソースのタグ付け](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-tags.html)」を参照してください。 ### `get-vpc-link` 次のコード例は、`get-vpc-link` を使用する方法を示しています。 **AWS CLI** **VPC リンクに関する情報を取得する方法** 以下の `get-vpc-link` の例では、VPC リンクに関する情報を表示します。 ``` aws apigatewayv2 get-vpc-link \ --vpc-link-id abcd123 ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API の VPC リンクの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetVpcLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-vpc-link.html)」を参照してください。 ### `get-vpc-links` 次のコード例は、`get-vpc-links` を使用する方法を示しています。 **AWS CLI** **VPC リンクの一覧を取得する方法** 次の例 `get-vpc-links` では、現在のユーザーのすべての VPC リンクを一覧表示します。 ``` aws apigatewayv2 get-vpc-links ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API の VPC リンクの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetVpcLinks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/get-vpc-links.html)」を参照してください。 ### `import-api` 次のコード例は、`import-api` を使用する方法を示しています。 **AWS CLI** **HTTP API をインポートする方法** 次の `import-api` の例では、「`api-definition.yaml`」という名前の OpenAPI 3.0 定義ファイルから HTTP API を作成します。 ``` aws apigatewayv2 import-api \ --body file://api-definition.yaml ``` `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 ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API の OpenAPI 定義の使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-open-api.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ImportApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/import-api.html)」を参照してください。 ### `list-routing-rules` 次のコード例は、`list-routing-rules` を使用する方法を示しています。 **AWS CLI** **ルーティングルールを一覧表示するには** 次の `list-routing-rules` の例では、ドメイン名のルーティングルールを一覧表示します。 ``` aws apigatewayv2 list-routing-rules \ --domain-name 'regional.example.com' ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API ステージを REST API のカスタムドメイン名に接続するためのルーティングルール](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRoutingRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/list-routing-rules.html)」を参照してください。 ### `put-routing-rule` 次のコード例は、`put-routing-rule` を使用する方法を示しています。 **AWS CLI** **ルーティングルールを更新するには** 次の `put-routing-rule` の例では、ルーティングルールの優先度を更新します。 ``` aws apigatewayv2 put-routing-rule \ --domain-name 'regional.example.com' \ --priority 150 \ --conditions '[ \ { \ "MatchBasePaths": { \ "AnyOf": [ \ "PetStoreShopper" \ ] \ } \ } \ ]' \ --actions '[ \ { \ "InvokeApi": { \ "ApiId": "abcd1234", \ "Stage": "prod" \ } \ } \ ]' ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API ステージを REST API のカスタムドメイン名に接続するためのルーティングルール](https://docs.aws.amazon.com/apigateway/latest/developerguide/rest-api-routing-rules.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutRoutingRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/put-routing-rule.html)」を参照してください。 ### `reimport-api` 次のコード例は、`reimport-api` を使用する方法を示しています。 **AWS CLI** **HTTP API を再インポートする方法** 次の `reimport-api` の例では、`api-definition.yaml` で指定された OpenAPI 3.0 定義を使用するように既存の HTTP API を更新します。 ``` aws apigatewayv2 reimport-api \ --body file://api-definition.yaml \ --api-id a1b2c3d4 ``` `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 ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API の OpenAPI 定義の使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-open-api.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ReimportApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/reimport-api.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **リソースにタグ付けする方法** 次の `tag-resource` の例では、指定された API に「`Department`」のキー名と「`Accounting`」の値を持つタグを追加します。 ``` aws apigatewayv2 tag-resource \ --resource-arn arn:aws:apigateway:us-west-2::/apis/a1b2c3d4 \ --tags Department=Accounting ``` このコマンドでは何も出力されません。 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway リソースのタグ付け](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **リソースからタグを削除する** 次の `untag-resource` の例では、キー名「`Project`」と「`Owner`」の含まれるタグを指定された API から削除します。 ``` aws apigatewayv2 untag-resource \ --resource-arn arn:aws:apigateway:us-west-2::/apis/a1b2c3d4 \ --tag-keys Project Owner ``` このコマンドでは何も出力されません。 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway リソースのタグ付け](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/untag-resource.html)」を参照してください。 ### `update-api-mapping` 次のコード例は、`update-api-mapping` を使用する方法を示しています。 **AWS CLI** **API マッピングを作成する方法** 次の `update-api-mapping` の例では、カスタムドメイン名の API マッピングを変更します。その結果、指定された API とステージにカスタムドメイン名を使用するベース URL は `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 ``` 出力: ``` { "ApiId": "a1b2c3d4", "ApiMappingId": "0qzs2sy7bh", "ApiMappingKey": "dev" "Stage": "dev" } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway でリージョナルカスタムドメイン名を設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateApiMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-api-mapping.html)」を参照してください。 ### `update-api` 次のコード例は、`update-api` を使用する方法を示しています。 **AWS CLI** **HTTP API の CORS を有効にする方法** 次の `update-api` の例では、指定された API の CORS 構成を更新して、`https://www.example.com` からのリクエストを許可します。 ``` aws apigatewayv2 update-api \ --api-id a1b2c3d4 \ --cors-configuration AllowOrigins=https://www.example.com ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API CORS の設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateApi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-api.html)」を参照してください。 ### `update-authorizer` 次のコード例は、`update-authorizer` を使用する方法を示しています。 **AWS CLI** **オーソライザーを更新する方法** 次の `update-authorizer` の例では、JWT オーソライザーの ID ソースを「`Authorization`」という名前のヘッダーに変更します。 ``` aws apigatewayv2 update-authorizer \ --api-id a1b2c3d4 \ --authorizer-id a1b2c3 \ --identity-source '$request.header.Authorization' ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[JWT オーソライザーを使用した HTTP API へのアクセスの制御](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-authorizer.html)」を参照してください。 ### `update-deployment` 次のコード例は、`update-deployment` を使用する方法を示しています。 **AWS CLI** **デプロイの説明を変更する方法** 次の `update-deployment` の例では、デプロイの説明を更新します。 ``` aws apigatewayv2 update-deployment \ --api-id a1b2c3d4 \ --deployment-id abcdef \ --description 'Manual deployment to fix integration test failures.' ``` 出力: ``` { "AutoDeployed": false, "CreatedDate": "2020-02-05T16:21:48+00:00", "DeploymentId": "abcdef", "DeploymentStatus": "DEPLOYED", "Description": "Manual deployment to fix integration test failures." } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway での HTTP API の開発](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-deployment.html)」を参照してください。 ### `update-domain-name` 次のコード例は、`update-domain-name` を使用する方法を示しています。 **AWS CLI** **カスタムドメイン名を更新する方法** 次の `update-domain-name` の例では、`api.example.com` カスタムドメイン名の新しい ACM 証明書を指定します。 ``` 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 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[API Gateway でリージョナルカスタムドメイン名を設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateDomainName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-domain-name.html)」を参照してください。 ### `update-integration` 次のコード例は、`update-integration` を使用する方法を示しています。 **AWS CLI** **Lambda 統合を更新する方法** 次の `update-integration` の例では、既存の AWS Lambda 統合を更新して、指定された Lambda 関数を使用します。 ``` 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 ``` 出力: ``` { "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 } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API 統合の設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations.html)」と「[WebSocket API 統合の設定](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integrations.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateIntegration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-integration.html)」を参照してください。 ### `update-route` 次のコード例は、`update-route` を使用する方法を示しています。 **AWS CLI** **例 1: ルートの統合を更新する方法** 次の `update-route` の例では、指定されたルートの統合を更新します。 ``` aws apigatewayv2 update-route \ --api-id a1b2c3d4 \ --route-id a1b2c3 \ --target integrations/a1b2c6 ``` 出力: ``` { "ApiKeyRequired": false, "AuthorizationType": "NONE", "RouteId": "a1b2c3", "RouteKey": "ANY /pets", "Target": "integrations/a1b2c6" } ``` **例 2: ルートにオーソライザーを追加する方法** 次の `update-route` の例では、指定されたルートを更新して、JWT オーソライザーを使用します。 ``` aws apigatewayv2 update-route \ --api-id a1b2c3d4 \ --route-id a1b2c3 \ --authorization-type JWT \ --authorizer-id a1b2c5 \ --authorization-scopes user.id user.email ``` 出力: ``` { "ApiKeyRequired": false, "AuthorizationScopes": [ "user.id", "user.email" ], "AuthorizationType": "JWT", "AuthorizerId": "a1b2c5", "OperationName": "GET HTTP", "RequestParameters": {}, "RouteId": "a1b2c3", "RouteKey": "GET /pets", "Target": "integrations/a1b2c6" } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[JWT オーソライザーを使用した HTTP API へのアクセスの制御](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-jwt-authorizer.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-route.html)」を参照してください。 ### `update-stage` 次のコード例は、`update-stage` を使用する方法を示しています。 **AWS CLI** **カスタムスロットリングを設定する方法** 次の `update-stage` の例は、API の指定されたステージとルートのカスタムスロットリングを設定します。 ``` aws apigatewayv2 update-stage \ --api-id a1b2c3d4 \ --stage-name dev \ --route-settings '{"GET /pets":{"ThrottlingBurstLimit":100,"ThrottlingRateLimit":2000}}' ``` 出力: ``` { "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": {} } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API の保護](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-protect.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-stage.html)」を参照してください。 ### `update-vpc-link` 次のコード例は、`update-vpc-link` を使用する方法を示しています。 **AWS CLI** **VPC リンクを更新する方法** 次の `update-vpc-link` 例では、VPC リンクの名前を更新します。VPC リンクを作成した後は、そのセキュリティグループまたはサブネットを変更することはできません。 ``` aws apigatewayv2 update-vpc-link \ --vpc-link-id abcd123 \ --name MyUpdatedVpcLink ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon API Gateway デベロッパーガイド*」の「[HTTP API の VPC リンクの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-vpc-links.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateVpcLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewayv2/update-vpc-link.html)」を参照してください。 # AWS CLI を使用した API Gateway Management API の例 次のコードサンプルは、API Gateway Management API で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `delete-connection` 次の例では、`delete-connection` を使用する方法を説明しています。 **AWS CLI** **WebSocket 接続を削除する方法** 次の `delete-connection` の例では、指定された WebSocket API からクライアントを切断します。 ``` aws apigatewaymanagementapi delete-connection \ --connection-id L0SM9cOFvHcCIhw= \ --endpoint-url https://aabbccddee.execute-api.us-west-2.amazonaws.com/prod ``` このコマンドでは何も出力されません。 詳細については、「**Amazon API Gateway ディベロッパーガイド」の「[バックエンドサービスでの @connections コマンドの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewaymanagementapi/delete-connection.html)」を参照してください。 ### `get-connection` 次の例では、`get-connection` を使用する方法を説明しています。 **AWS CLI** **WebSocket 接続に関する情報を取得する方法** 次の `get-connection` 例では、指定された WebSocket API への接続について説明しています。 ``` aws apigatewaymanagementapi get-connection \ --connection-id L0SM9cOFvHcCIhw= \ --endpoint-url https://aabbccddee.execute-api.us-west-2.amazonaws.com/prod ``` 出力: ``` { "ConnectedAt": "2020-04-30T20:10:33.236Z", "Identity": { "SourceIp": "192.0.2.1" }, "LastActiveAt": "2020-04-30T20:10:42.997Z" } ``` 詳細については、「**Amazon API Gateway ディベロッパーガイド」の「[バックエンドサービスでの @connections コマンドの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewaymanagementapi/get-connection.html)」を参照してください。 ### `post-to-connection` 次の例では、`post-to-connection` を使用する方法を説明しています。 **AWS CLI** **データを WebSocket 接続に送信する方法** 次の `post-to-connection` の例では、指定した WebSocket API に接続しているクライアントにメッセージを送信します。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「**Amazon API Gateway ディベロッパーガイド」の「[バックエンドサービスでの @connections コマンドの使用](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[PostToConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apigatewaymanagementapi/post-to-connection.html)」を参照してください。** # AWS CLI を使用した App Mesh の例 次のコードサンプルは、App Mesh で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-mesh` 次のコード例は、`create-mesh` を使用する方法を示しています。 **AWS CLI** **例 1: 新しいサービスメッシュを作成する方法** 次の `create-mesh` の例では、サービスメッシュを作成します。 ``` aws appmesh create-mesh \ --mesh-name app1 ``` 出力: ``` { "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" } } } ``` **例 2: 複数のタグを含む新しいサービスメッシュを作成する方法** 次の `create-mesh` の例は、複数のタグを含むサービスメッシュを作成します。 ``` aws appmesh create-mesh \ --mesh-name app2 \ --tags key=key1,value=value1 key=key2,value=value2 key=key3,value=value3 ``` 出力: ``` { "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" } } } ``` 詳細については、「*AWS App Mesh ユーザーガイド*」の「[サービスメッシュ](https://docs.aws.amazon.com/app-mesh/latest/userguide/meshes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateMesh](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/create-mesh.html)」を参照してください。 ### `create-route` 次のコード例は、`create-route` を使用する方法を示しています。 **AWS CLI** **新しい gRPC ルートを作成する方法** 次の `create-route` の例では、JSON 入力ファイルを使用して gRPC ルートを作成します。123 で始まるメタデータを持つ GRPC トラフィックは、serviceBgrpc という名前の仮想ノードにルーティングされます。ルートのターゲットと通信しようとしたときに特定の gRPC、HTTP、または TCP の障害が発生した場合、ルートは 3 回再試行されます。再試行するたびに 15 秒の遅延が発生します。 ``` aws appmesh create-route \ --cli-input-json file://create-route-grpc.json ``` `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" } ``` 出力: ``` { "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" } } ``` **新しい HTTP または HTTP/2 ルートを作成する方法** 次の `create-route` の例では、JSON 入力ファイルを使用して HTTP/2 ルートを作成します。HTTP ルートを作成するには、http2Route を仕様の httpRoute に置き換えます。123 で始まるヘッダー値を持つ URL プレフィックス宛てのすべての HTTP/2 トラフィックは、serviceBhttp2 という名前の仮想ノードにルーティングされます。ルートのターゲットと通信しようとしたときに特定の HTTP または TCP の障害が発生した場合、ルートは 3 回再試行されます。再試行するたびに 15 秒の遅延が発生します。 ``` aws appmesh create-route \ --cli-input-json file://create-route-http2.json ``` `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" } ``` 出力: ``` { "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" } } ``` **新しい TCP ルートを作成する方法** 次の `create-route` の例では、JSON 入力ファイルを使用して TCP ルートを作成します。トラフィックの 75% は serviceBtcp という名前の仮想ノードにルーティングされ、トラフィックの 25% は serviceBv2tcp という名前の仮想ノードにルーティングされます。ターゲットごとに異なる重みを指定することは、アプリケーションの新しいバージョンのデプロイを実行する効果的な方法です。重みを調整して、最終的にすべてのトラフィックの 100% がアプリケーションの新しいバージョンを持つターゲットにルーティングされるようにできます。 ``` aws appmesh create-route \ --cli-input-json file://create-route-tcp.json ``` create-route-tcp.json の内容: ``` { "meshName": "apps", "routeName": "tcpRoute", "spec": { "priority": 300, "tcpRoute": { "action": { "weightedTargets": [ { "virtualNode": "serviceBtcp", "weight": 75 }, { "virtualNode": "serviceBv2tcp", "weight": 25 } ] } } }, "virtualRouterName": "serviceBtcp" } ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS App Mesh ユーザーガイド*」の「[ルート](https://docs.aws.amazon.com/app-mesh/latest/userguide/routes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/create-route.html)」を参照してください。 ### `create-virtual-gateway` 次のコード例は、`create-virtual-gateway` を使用する方法を示しています。 **AWS CLI** **仮想ゲートウェイを作成する方法** 次の `create-virtual-gateway` の例では、JSON 入力ファイルを使用して、ポート 9080 を使用して HTTP のリスナーを持つ仮想ゲートウェイを作成します。 ``` aws appmesh create-virtual-gateway \ --mesh-name meshName \ --virtual-gateway-name virtualGatewayName \ --cli-input-json file://create-virtual-gateway.json ``` `create-virtual-gateway.json` の内容: ``` { "spec": { "listeners": [ { "portMapping": { "port": 9080, "protocol": "http" } } ] } } ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS App Mesh ユーザーガイド*」の「[仮想ゲートウェイ](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_gateways.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateVirtualGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/create-virtual-gateway.html)」を参照してください。 ### `create-virtual-node` 次のコード例は、`create-virtual-node` を使用する方法を示しています。 **AWS CLI** **例 1: 検出に DNS を使用する新しい仮想ノードを作成する方法** 次の `create-virtual-node` の例では、JSON 入力ファイルを使用して、サービス検出に DNS を使用する仮想ノードを作成します。 ``` aws appmesh create-virtual-node \ --cli-input-json file://create-virtual-node-dns.json ``` `create-virtual-node-dns.json` の内容: ``` { "meshName": "app1", "spec": { "listeners": [ { "portMapping": { "port": 80, "protocol": "http" } } ], "serviceDiscovery": { "dns": { "hostname": "serviceBv1.svc.cluster.local" } } }, "virtualNodeName": "vnServiceBv1" } ``` 出力: ``` { "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" } } ``` **例 2: 検出に AWS Cloud Map を使用する新しい仮想ノードを作成する方法** 次の `create-virtual-node` の例では、JSON 入力ファイルを使用して、サービス検出に AWS Cloud Map を使用する仮想ノードを作成します。 ``` aws appmesh create-virtual-node \ --cli-input-json file://create-virtual-node-cloud-map.json ``` `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" } ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS App Mesh ユーザーガイド*」の「[仮想ノード](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_nodes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateVirtualNode](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/create-virtual-node.html)」を参照してください。 ### `create-virtual-router` 次のコード例は、`create-virtual-router` を使用する方法を示しています。 **AWS CLI** **仮想ルーターを作成する方法** 次の `create-virtual-router` の例では、JSON 入力ファイルを使用して、ポート 80 を使用して HTTP のリスナーを持つ仮想ルーターを作成します。 ``` aws appmesh create-virtual-router \ --cli-input-json file://create-virtual-router.json ``` `create-virtual-router.json` の内容: ``` { "meshName": "app1", "spec": { "listeners": [ { "portMapping": { "port": 80, "protocol": "http" } } ] }, "virtualRouterName": "vrServiceB" } ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS App Mesh ユーザーガイド*」の「[仮想ルーター](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_routers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateVirtualRouter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/create-virtual-router.html)」を参照してください。 ### `create-virtual-service` 次のコード例は、`create-virtual-service` を使用する方法を示しています。 **AWS CLI** **例 1: 仮想ノードプロバイダーを使用して新しい仮想サービスを作成する方法** 次の `create-virtual-service` の例では、JSON 入力ファイルを使用し、仮想ノードプロバイダーを使用して仮想サービスを作成します。 ``` aws appmesh create-virtual-service \ --cli-input-json file://create-virtual-service-virtual-node.json ``` `create-virtual-service-virtual-node.json` の内容: ``` { "meshName": "app1", "spec": { "provider": { "virtualNode": { "virtualNodeName": "vnServiceA" } } }, "virtualServiceName": "serviceA.svc.cluster.local" } ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS App Mesh ユーザーガイド*」の「[仮想ノード](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_nodes.html)」を参照してください。 **例 2: 仮想ルータープロバイダーを使用して新しい仮想サービスを作成する方法** 次の `create-virtual-service` の例では、JSON 入力ファイルを使用し、仮想ルータープロバイダーを使用して仮想サービスを作成します。 ``` aws appmesh create-virtual-service \ --cli-input-json file://create-virtual-service-virtual-router.json ``` `create-virtual-service-virtual-router.json` の内容: ``` { "meshName": "app1", "spec": { "provider": { "virtualRouter": { "virtualRouterName": "vrServiceB" } } }, "virtualServiceName": "serviceB.svc.cluster.local" } ``` 出力: ``` { "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" } } ``` 詳細については、「*AWSApp Mesh ユーザーガイド*」の「仮想サービス」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateVirtualService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/create-virtual-service.html)」を参照してください。 ### `delete-mesh` 次のコード例は、`delete-mesh` を使用する方法を示しています。 **AWS CLI** **サービスメッシュを削除する方法** 次の `delete-mesh` の例では、指定されたサービスメッシュを削除します。 ``` aws appmesh delete-mesh \ --mesh-name app1 ``` 出力: ``` { "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" } } } ``` 詳細については、「*AWS App Mesh ユーザーガイド*」の「[サービスメッシュ](https://docs.aws.amazon.com/app-mesh/latest/userguide/meshes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteMesh](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/delete-mesh.html)」を参照してください。 ### `delete-route` 次のコード例は、`delete-route` を使用する方法を示しています。 **AWS CLI** **ルートを削除する方法** 以下の `delete-route` 例では、指定されたルートを削除します。 ``` aws appmesh delete-route \ --mesh-name app1 \ --virtual-router-name vrServiceB \ --route-name toVnServiceB-weighted ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS App Mesh ユーザーガイド*」の「[ルート](https://docs.aws.amazon.com/app-mesh/latest/userguide/routes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/delete-route.html)」を参照してください。 ### `delete-virtual-node` 次のコード例は、`delete-virtual-node` を使用する方法を示しています。 **AWS CLI** **仮想ノードを削除する方法** 以下の `delete-virtual-node` 例では、指定された仮想ノードを削除します。 ``` aws appmesh delete-virtual-node \ --mesh-name app1 \ --virtual-node-name vnServiceBv2 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS App Mesh ユーザーガイド*」の「[仮想ノード](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_nodes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteVirtualNode](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/delete-virtual-node.html)」を参照してください。 ### `delete-virtual-router` 次のコード例は、`delete-virtual-router` を使用する方法を示しています。 **AWS CLI** **仮想ルーターを削除する方法** 以下の `delete-virtual-router` 例では、指定された仮想ルーターを削除します。 ``` aws appmesh delete-virtual-router \ --mesh-name app1 \ --virtual-router-name vrServiceB ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS App Mesh ユーザーガイド*」の「[仮想ルーター](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_routers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteVirtualRouter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/delete-virtual-router.html)」を参照してください。 ### `delete-virtual-service` 次のコード例は、`delete-virtual-service` を使用する方法を示しています。 **AWS CLI** **仮想サービスを削除する方法** 以下の `delete-virtual-service` の例では、指定された仮想ノードを削除します。 ``` aws appmesh delete-virtual-service \ --mesh-name app1 \ --virtual-service-name serviceB.svc.cluster.local ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS App Mesh ユーザーガイド*」の「[仮想サービス](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_services.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteVirtualService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/delete-virtual-service.html)」を参照してください。 ### `describe-mesh` 次のコード例は、`describe-mesh` を使用する方法を示しています。 **AWS CLI** **サービスメッシュを記述する方法** 次の `describe-mesh` の例では、指定されたサービスメッシュに関する詳細情報を取得します。 ``` aws appmesh describe-mesh \ --mesh-name app1 ``` 出力: ``` { "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" } } } ``` 詳細については、「*AWS App Mesh ユーザーガイド*」の「[サービスメッシュ](https://docs.aws.amazon.com/app-mesh/latest/userguide/meshes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeMesh](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/describe-mesh.html)」を参照してください。 ### `describe-route` 次のコード例は、`describe-route` を使用する方法を示しています。 **AWS CLI** **ルートを記述する方法** 次の `describe-route` の例では、指定されたルートの詳細情報を返します。 ``` aws appmesh describe-route \ --mesh-name app1 \ --virtual-router-name vrServiceB \ --route-name toVnServiceB-weighted ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS App Mesh ユーザーガイド*」の「[ルート](https://docs.aws.amazon.com/app-mesh/latest/userguide/routes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/describe-route.html)」を参照してください。 ### `describe-virtual-node` 次のコード例は、`describe-virtual-node` を使用する方法を示しています。 **AWS CLI** **仮想ノードを記述する方法** 次の `describe-virtual-node` の例では、指定されたバーチャルノードの詳細情報を返します。 ``` aws appmesh describe-virtual-node \ --mesh-name app1 \ --virtual-node-name vnServiceBv1 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS App Mesh ユーザーガイド*」の「[仮想ノード](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_nodes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeVirtualNode](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/describe-virtual-node.html)」を参照してください。 ### `describe-virtual-router` 次のコード例は、`describe-virtual-router` を使用する方法を示しています。 **AWS CLI** **仮想ルーターを記述する方法** 次の `describe-virtual-router` の例では、指定された仮想ルーターの詳細情報を返します。 ``` aws appmesh describe-virtual-router \ --mesh-name app1 \ --virtual-router-name vrServiceB ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS App Mesh ユーザーガイド*」の「[仮想ルーター](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_routers.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[DescribeVirtualRouter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/describe-virtual-router.html)」を参照してください。 ### `describe-virtual-service` 次のコード例は、`describe-virtual-service` を使用する方法を示しています。 **AWS CLI** **仮想サービスを記述する方法** 次の `describe-virtual-service` の例では、指定されたバーチャルサービスに関する詳細情報を返します。 ``` aws appmesh describe-virtual-service \ --mesh-name app1 \ --virtual-service-name serviceB.svc.cluster.local ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS App Mesh ユーザーガイド*」の「[仮想サービス](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_services.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeVirtualService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/describe-virtual-service.html)」を参照してください。 ### `list-meshes` 次のコード例は、`list-meshes` を使用する方法を示しています。 **AWS CLI** **サービスメッシュを一覧表示する方法** 次の `list-meshes` の例では、現在の AWS リージョンのすべてのサービスメッシュを一覧表示します。 ``` aws appmesh list-meshes ``` 出力: ``` { "meshes": [ { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1", "meshName": "app1" } ] } ``` 詳細については、「*AWS App Mesh ユーザーガイド*」の「[サービスメッシュ](https://docs.aws.amazon.com/app-mesh/latest/userguide/meshes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListMeshes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/list-meshes.html)」を参照してください。 ### `list-routes` 次のコード例は、`list-routes` を使用する方法を示しています。 **AWS CLI** **ルートを一覧表示する方法** 次の `list-routes` の例では、指定された仮想ルーターのすべてのルートを一覧表示します。 ``` aws appmesh list-routes \ --mesh-name app1 \ --virtual-router-name vrServiceB ``` 出力: ``` { "routes": [ { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB/route/toVnServiceB", "meshName": "app1", "routeName": "toVnServiceB-weighted", "virtualRouterName": "vrServiceB" } ] } ``` 詳細については、「*AWS App Mesh ユーザーガイド*」の「[ルート](https://docs.aws.amazon.com/app-mesh/latest/userguide/routes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRoutes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/list-routes.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **リソースのタグを一覧表示する方法** 次の `list-tags-for-resource` の例では、指定されたリソースに割り当てられたすべてのタグを一覧表示します。 ``` aws appmesh list-tags-for-resource \ --resource-arn arn:aws:appmesh:us-east-1:123456789012:mesh/app1 ``` 出力: ``` { "tags": [ { "key": "key1", "value": "value1" }, { "key": "key2", "value": "value2" }, { "key": "key3", "value": "value3" } ] } ``` + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/list-tags-for-resource.html)」を参照してください。 ### `list-virtual-nodes` 次のコード例は、`list-virtual-nodes` を使用する方法を示しています。 **AWS CLI** **仮想ノードを一覧表示する方法** 次の `list-virtual-nodes` の例では、指定されたサービスメッシュ内のすべての仮想ノードを一覧表示します。 ``` aws appmesh list-virtual-nodes \ --mesh-name app1 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS App Mesh ユーザーガイド*」の「[仮想ノード](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_nodes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListVirtualNodes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/list-virtual-nodes.html)」を参照してください。 ### `list-virtual-routers` 次のコード例は、`list-virtual-routers` を使用する方法を示しています。 **AWS CLI** **仮想ルーターを一覧表示する方法** 次の `list-virtual-routers` の例では、指定されたサービスメッシュ内のすべての仮想ルーターを一覧表示します。 ``` aws appmesh list-virtual-routers \ --mesh-name app1 ``` 出力: ``` { "virtualRouters": [ { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB", "meshName": "app1", "virtualRouterName": "vrServiceB" } ] } ``` 詳細については、「*AWS App Mesh ユーザーガイド*」の「[仮想ルーター](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_routers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListVirtualRouters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/list-virtual-routers.html)」を参照してください。 ### `list-virtual-services` 次のコード例は、`list-virtual-services` を使用する方法を示しています。 **AWS CLI** **仮想サービスを一覧表示する方法** 次の `list-virtual-services` の例では、指定されたサービスメッシュ内のすべての仮想サービスを一覧表示します。 ``` aws appmesh list-virtual-services \ --mesh-name app1 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS App Mesh ユーザーガイド*」の「[仮想サービス](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_services.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListVirtualServices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/list-virtual-services.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **リソースにタグ付けする方法** 次の `tag-resource` の例では、指定されたリソースに値「`value1`」のタグ「`key1`」を追加します。 ``` aws appmesh tag-resource \ --resource-arn arn:aws:appmesh:us-east-1:123456789012:mesh/app1 \ --tags key=key1,value=value1 ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **リソースのタグを削除する方法** 次の `untag-resource` の例では、指定されたリソースから「`key1`」のキーを持つタグを削除します。 ``` aws appmesh untag-resource \ --resource-arn arn:aws:appmesh:us-east-1:123456789012:mesh/app1 \ --tag-keys key1 ``` このコマンドでは何も出力されません。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/untag-resource.html)」を参照してください。 ### `update-mesh` 次のコード例は、`update-mesh` を使用する方法を示しています。 **AWS CLI** **サービスメッシュを更新する方法** 次の `update-mesh` の例では、JSON 入力ファイルを使用してサービスメッシュを更新し、すべての外部エグレストラフィックを Envoy プロキシを介してそのまま転送できるようにします。 ``` aws appmesh update-mesh \ --cli-input-json file://update-mesh.json ``` `update-mesh.json` の内容: ``` { "meshName": "app1", "spec": { "egressFilter": { "type": "ALLOW_ALL" } } } ``` 出力: ``` { "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" } } } ``` 詳細については、「*AWS App Mesh ユーザーガイド*」の「[サービスメッシュ](https://docs.aws.amazon.com/app-mesh/latest/userguide/meshes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateMesh](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/update-mesh.html)」を参照してください。 ### `update-route` 次のコード例は、`update-route` を使用する方法を示しています。 **AWS CLI** **ルートを更新する方法** 次の `update-route` の例では、JSON 入力ファイルを使用してルートの重みを更新します。 ``` aws appmesh update-route \ --cli-input-json file://update-route-weighted.json ``` `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" } ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS App Mesh ユーザーガイド*」の「[ルート](https://docs.aws.amazon.com/app-mesh/latest/userguide/routes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/update-route.html)」を参照してください。 ### `update-virtual-node` 次のコード例は、`update-virtual-node` を使用する方法を示しています。 **AWS CLI** **仮想ノードを更新する方法** 次の `update-virtual-node` の例では、JSON 入力ファイルを使用して、仮想ノードにヘルスチェックを追加します。 ``` aws appmesh update-virtual-node \ --cli-input-json file://update-virtual-node.json ``` `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" } ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS App Mesh ユーザーガイド*」の「[仮想ノード](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_nodes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateVirtualNode](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/update-virtual-node.html)」を参照してください。 ### `update-virtual-router` 次のコード例は、`update-virtual-router` を使用する方法を示しています。 **AWS CLI** **仮想ルーターの更新する方法** 次の `update-virtual-router` の例では、JSON 入力ファイルを使用して仮想ルーターリスナーポートを更新します。 ``` aws appmesh update-virtual-router \ --cli-input-json file://update-virtual-router.json ``` `update-virtual-router.json` の内容: ``` { "meshName": "app1", "spec": { "listeners": [ { "portMapping": { "port": 8080, "protocol": "http" } } ] }, "virtualRouterName": "vrServiceB" } ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS App Mesh ユーザーガイド*」の「[仮想ルーター](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_routers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateVirtualRouter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/update-virtual-router.html)」を参照してください。 ### `update-virtual-service` 次のコード例は、`update-virtual-service` を使用する方法を示しています。 **AWS CLI** **仮想サービスを更新する方法** 次の `update-virtual-service` の例では、JSON 入力ファイルを使用し、仮想ルータープロバイダーを使用して仮想サービスを更新します。 ``` aws appmesh update-virtual-service \ --cli-input-json file://update-virtual-service.json ``` `update-virtual-service.json` の内容: ``` { "meshName": "app1", "spec": { "provider": { "virtualRouter": { "virtualRouterName": "vrServiceA" } } }, "virtualServiceName": "serviceA.svc.cluster.local" } ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS App Mesh ユーザーガイド*」の「[仮想サービス](https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_services.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateVirtualService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appmesh/update-virtual-service.html)」を参照してください。 # AWS CLI を使用した App Runner の例 次のコードサンプルは、App Runner で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `associate-custom-domain` 次の例では、`associate-custom-domain` を使用する方法を説明しています。 **AWS CLI** **ドメイン名と www サブドメインをサービスに関連付ける方法** 次の `associate-custom-domain` の例では、制御するカスタムドメイン名を App Runner サービスに関連付けます。ドメイン名はルートドメイン「`example.com`」で、大文字と小文字のサブドメイン「`www.example.com`」が含まれます。 ``` aws apprunner associate-custom-domain \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", "DomainName": "example.com", "EnableWWWSubdomain": true } ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateCustomDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/associate-custom-domain.html)」を参照してください。 ### `create-auto-scaling-configuration` 次の例では、`create-auto-scaling-configuration` を使用する方法を説明しています。 **AWS CLI** **高可用性の自動スケーリング構成を作成する方法** 次の `create-auto-scaling-configuration` の例では、`MinSize` を 5 に構成して高可用性に最適化された自動スケーリング構成を作成します。この構成では、App Runner は AWS リージョンに応じて、最大 5 つのアベイラビリティーゾーンにサービスインスタンスを分散しようとします。 呼び出しは、他の設定がデフォルトに設定されている `AutoScalingConfiguration` オブジェクトを返します。この例では、「`high-availability`」という名前の構成を作成する最初の呼び出しです。リビジョンは 1 に設定され、最新のリビジョンです。 ``` aws apprunner create-auto-scaling-configuration \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "AutoScalingConfigurationName": "high-availability", "MinSize": 5 } ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateAutoScalingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/create-auto-scaling-configuration.html)」を参照してください。 ### `create-connection` 次の例では、`create-connection` を使用する方法を説明しています。 **AWS CLI** **GitHub への接続を作成する方法** 次の `create-connection` の例では、プライベート GitHub コードリポジトリへの接続を作成します。呼び出しが成功した後の接続ステータスは `PENDING_HANDSHAKE` です。これは、プロバイダーとの認証ハンドシェイクがまだ行われていないためです。App Runner コンソールを使用してハンドシェイクを完了します。 ``` aws apprunner create-connection \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "ConnectionName": "my-github-connection", "ProviderType": "GITHUB" } ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS App Runner デベロッパーガイド*」の「[App Runner 接続の管理](https://docs.aws.amazon.com/apprunner/latest/dg/manage-connections.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/create-connection.html)」を参照してください。 ### `create-service` 次の例では、`create-service` を使用する方法を説明しています。 **AWS CLI** **例 1: ソースコードリポジトリサービスを作成する方法** 次の `create-service` の例では、Python ソースコードリポジトリに基づいて App Runner サービスを作成します。 ``` aws apprunner create-service \ --cli-input-json file://input.json ``` `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" } } ``` 出力: ``` { "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" } } } ``` **例 2: ソースコードリポジトリサービスを作成する方法** 次の `create-service` の例では、Python ソースコードリポジトリに基づいて App Runner サービスを作成します。 ``` aws apprunner create-service \ --cli-input-json file://input.json ``` `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" } } ``` 出力: ``` { "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" } } } ``` **例 3: ソースイメージリポジトリサービスを作成する方法** 次の `create-service` の例では、Elastic Container Registry (ECR) に保存されているイメージに基づいて App Runner サービスを作成します。 ``` aws apprunner create-service \ --cli-input-json file://input.json ``` `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" } } ``` 出力: ``` { "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" } } } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[CreateService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/create-service.html)」を参照してください。** ### `delete-auto-scaling-configuration` 次の例では、`delete-auto-scaling-configuration` を使用する方法を説明しています。 **AWS CLI** **例 1: 自動スケーリング構成の最新のアクティブなリビジョンを削除する方法** 次の `delete-auto-scaling-configuration` の例では、App Runner 自動スケーリング構成の最新アクティブリビジョンを削除します。最新のアクティブなリビジョンを削除するには、リビジョンコンポーネントなしで、構成名で終わる Amazon リソースネーム (ARN) を指定します。 この例では、このアクションの前に 2 つのリビジョンがあります。したがって、リビジョン 2 (最新) は削除されます。ただし、削除後に最新のアクティブなリビジョンではなくなるため、`"Latest": false` が表示されるようになりました。 ``` aws apprunner delete-auto-scaling-configuration \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability" } ``` 出力: ``` { "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 } } ``` **例 2: 自動スケーリング構成の特定のリビジョンを削除する方法** 次の `delete-auto-scaling-configuration` 例では、App Runner 自動スケーリング構成の特定のリビジョンを削除します。特定のリビジョンを削除するには、リビジョン番号を含む ARN を指定します。 この例では、このアクションの前にいくつかのリビジョンがあります。アクションはリビジョン `1` を削除します。 ``` aws apprunner delete-auto-scaling-configuration \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/1" } ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAutoScalingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/delete-auto-scaling-configuration.html)」を参照してください。 ### `delete-connection` 次の例では、`delete-connection` を使用する方法を説明しています。 **AWS CLI** **接続を削除する方法** 次の `delete-connection` の例では、App Runner 接続を削除します。正常な呼び出し後の接続ステータスは「`DELETED`」です。これは、接続が使用できなくなったためです。 ``` aws apprunner delete-connection \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github-connection" } ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/delete-connection.html)」を参照してください。 ### `delete-service` 次の例では、`delete-service` を使用する方法を説明しています。 **AWS CLI** **サービスを削除する方法** 次の `delete-service` の例では、App Runner サービスを削除します。 ``` aws apprunner delete-service \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa" } ``` 出力: ``` { "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" } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/delete-service.html)」を参照してください。 ### `describe-auto-scaling-configuration` 次の例では、`describe-auto-scaling-configuration` を使用する方法を説明しています。 **AWS CLI** **例 1: 自動スケーリング構成の最新のアクティブなリビジョンを記述する方法** 次の `describe-auto-scaling-configuration` の例では、App Runner 自動スケーリング構成の最新アクティブリビジョンの記述を取得します。最新のアクティブなリビジョンを記述するには、リビジョンコンポーネントなしで、構成名で終わる ARN を指定します。 この例では、2 つのリビジョンがあります。したがって、リビジョン `2` (最新) が説明されます。結果のオブジェクトには、`"Latest": true` が表示されます。 ``` aws apprunner describe-auto-scaling-configuration \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability" } ``` 出力: ``` { "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 } } ``` **例 2: 自動スケーリング構成の特定のリビジョンを記述する方法** 次の `describe-auto-scaling-configuration` 例では、App Runner 自動スケーリング構成の特定のリビジョンの記述を取得します。特定のリビジョンを削除するには、リビジョン番号を含む ARN を記述します。 この例では、複数のリビジョンが存在し、リビジョン `1` がクエリされます。結果のオブジェクトには、`"Latest": false` が表示されます。 ``` aws apprunner describe-auto-scaling-configuration \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "AutoScalingConfigurationArn": "arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/1" } ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAutoScalingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/describe-auto-scaling-configuration.html)」を参照してください。 ### `describe-custom-domains` 次の例では、`describe-custom-domains` を使用する方法を説明しています。 **AWS CLI** **サービスに関連付けられたカスタムドメイン名の説明を取得する方法** 次の `describe-custom-domains` の例では、App Runner サービスに関連付けられたカスタムドメイン名の説明とステータスを取得します。 ``` aws apprunner describe-custom-domains \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", "DomainName": "example.com", "EnableWWWSubdomain": true } ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeCustomDomains](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/describe-custom-domains.html)」を参照してください。 ### `describe-service` 次の例では、`describe-service` を使用する方法を説明しています。 **AWS CLI** **サービスを記述する方法** 次の `describe-service` の例では、App Runner サービスの記述を取得します。 ``` aws apprunner describe-service \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa" } ``` 出力: ``` { "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" } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/describe-service.html)」を参照してください。 ### `disassociate-custom-domain` 次の例では、`disassociate-custom-domain` を使用する方法を説明しています。 **AWS CLI** **サービスからドメイン名の関連付けを解除する方法** 次の `disassociate-custom-domain` 例では、App Runner サービスからドメイン「`example.com`」の関連付けを解除します。コールは、ルートドメインと関連付けられているサブドメイン「`www.example.com`」の関連付けも解除します。 ``` aws apprunner disassociate-custom-domain \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", "DomainName": "example.com" } ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLIコマンドリファレンス*」の「[DisassociateCustomDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/disassociate-custom-domain.html)」を参照してください。 ### `list-auto-scaling-configurations` 次の例では、`list-auto-scaling-configurations` を使用する方法を説明しています。 **AWS CLI** **App Runner 自動スケーリング構成のページ分割リストを取得する方法** 次の `list-auto-scaling-configurations` の例では、AWS アカウント内のすべての App Runner 自動スケーリング構成を一覧表示します。各レスポンスには、最大 5 つの自動スケーリング構成が一覧表示されます。 `AutoScalingConfigurationName` および `LatestOnly` は指定されません。これらのデフォルトにより、すべてのアクティブな構成の最新リビジョンが一覧表示されます。 この例では、レスポンスに 2 つの結果が含まれており、追加の結果がないため、`NextToken` は返されません。 ``` aws apprunner list-auto-scaling-configurations \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "MaxResults": 5 } ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAutoScalingConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/list-auto-scaling-configurations.html)」を参照してください。 ### `list-connections` 次の例では、`list-connections` を使用する方法を説明しています。 **AWS CLI** **例 1: すべての接続を一覧表示する方法** 次の `list-connections` の例では、AWS アカウント内のすべての App Runner 接続を一覧表示します。 ``` aws apprunner list-connections ``` 出力: ``` { "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" } ] } ``` **例 2: 接続を名前で一覧表示する方法** 次の `list-connections` の例では、接続をその名前で一覧表示します。 ``` aws apprunner list-connections \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "ConnectionName": "my-github-org-connection" } ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/list-connections.html)」を参照してください。 ### `list-operations` 次の例では、`list-operations` を使用する方法を説明しています。 **AWS CLI** **サービスで発生したオペレーションを一覧表示する方法** 次の `list-operations` の例では、これまでに App Runner サービスで発生したすべてのオペレーションを一覧表示します。この例では、サービスは新しく、タイプ「`CREATE_SERVICE`」のオペレーションが 1 つだけ発生しています。 ``` aws apprunner list-operations \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa" } ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListOperations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/list-operations.html)」を参照してください。 ### `list-services` 次の例では、`list-services` を使用する方法を説明しています。 **AWS CLI** **App Runner サービスのページ分割一覧を取得する方法** 次の `list-services` の例では、AWS アカウント内のすべての App Runner 接続を一覧表示します。各レスポンスには、最大 2 つのサービスが一覧表示されます。この例では、最初のリクエストを示しています。レスポンスには、次のリクエストで使用できる 2 つの結果とトークンが含まれます。後続のレスポンスにトークンが含まれていない場合、すべてのサービスが一覧表示されます。 ``` aws apprunner list-services \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "MaxResults": 2 } ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListServices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/list-services.html)」を参照してください。 ### `list-tags-for-resource` 次の例では、`list-tags-for-resource` を使用する方法を説明しています。 **AWS CLI** **App Runner サービスに関連付けられたタグを一覧表示する方法** 次の `list-tags-for-resource` の例では、App Runner サービスに関連付けられたすべてのタグを一覧表示します。 ``` aws apprunner list-tags-for-resource \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "ResourceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa" } ``` 出力: ``` { "Tags": [ { "Key": "Department", "Value": "Retail" }, { "Key": "CustomerId", "Value": "56439872357912" } ] } ``` + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/list-tags-for-resource.html)」を参照してください。 ### `pause-service` 次の例では、`pause-service` を使用する方法を説明しています。 **AWS CLI** **サービスを一時停止する方法** 次の `pause-service` の例では、App Runner サービスを一時停止します。 ``` aws apprunner pause-service \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa" } ``` 出力: ``` { "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" } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PauseService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/pause-service.html)」を参照してください。 ### `resume-service` 次の例では、`resume-service` を使用する方法を説明しています。 **AWS CLI** **サービスを再開する方法** 次の `resume-service` の例では、App Runner サービスを再開します。 ``` aws apprunner resume-service \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa" } ``` 出力: ``` { "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" } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ResumeService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/resume-service.html)」を参照してください。 ### `start-deployment` 次の例では、`start-deployment` を使用する方法を説明しています。 **AWS CLI** **手動デプロイを開始する方法** 次の `start-deployment` の例では、App Runner サービスへの手動デプロイを実行します。 ``` aws apprunner start-deployment \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa" } ``` 出力: ``` { "OperationId": "853a7d5b-fc9f-4730-831b-fd8037ab832a" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/start-deployment.html)」を参照してください。 ### `tag-resource` 次の例では、`tag-resource` を使用する方法を説明しています。 **AWS CLI** **App Runner サービスにタグを追加する方法** 次の `tag-resource` の例では、App Runner サービスを一時停止します。 ``` aws apprunner tag-resource \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "ResourceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", "Tags": [ { "Key": "Department", "Value": "Retail" }, { "Key": "CustomerId", "Value": "56439872357912" } ] } ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/tag-resource.html)」を参照してください。 ### `untag-resource` 次の例では、`untag-resource` を使用する方法を説明しています。 **AWS CLI** **App Runner サービスからタグを削除する方法** 次の `untag-resource` の例では、シークレットから 2 個のタグを削除します。 ``` aws apprunner untag-resource \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "ResourceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", "TagKeys": [ "Department", "CustomerId" ] } ``` このコマンドでは何も出力されません。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/untag-resource.html)」を参照してください。 ### `update-service` 次の例では、`update-service` を使用する方法を説明しています。 **AWS CLI** **メモリサイズを更新する方法** 次の `update-service` の例では、App Runner サービスのインスタンス (スケーリングユニット) のメモリサイズを 2048 MiB に更新します。 呼び出しが成功すると、App Runner は非同期更新プロセスを開始します。呼び出しによって返される `Service` 構造には、この呼び出しによって適用される新しいメモリ値が反映されます。 ``` aws apprunner update-service \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa", "InstanceConfiguration": { "Memory": "4 GB" } } ``` 出力: ``` { "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" } } } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[UpdateService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/apprunner/update-service.html)」を参照してください。** # AWS AppConfig examples using AWS CLI 次のコード例では、AWS AppConfig で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-application` 次のコード例は、`create-application` を使用する方法を示しています。 **AWS CLI** **アプリケーションを作成する方法** 次の `create-application` の例では、AWS AppConfig にアプリケーションを作成します。 ``` aws appconfig create-application \ --name "example-application" \ --description "An application used for creating an example." ``` 出力: ``` { "Description": "An application used for creating an example.", "Id": "339ohji", "Name": "example-application" } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の「[ステップ 1: AWS AppConfig アプリケーションの作成](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-application.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/create-application.html)」を参照してください。 ### `create-configuration-profile` 次のコード例は、`create-configuration-profile` を使用する方法を示しています。 **AWS CLI** **設定プロファイルを作成する方法** 次の `create-configuration-profile` の例は、Systems Manager の一機能である Parameter Store に保存されている設定を使用して構成プロファイルを作成します。 ``` 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" ``` 出力: ``` { "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 } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の「[ステップ 3: 構成および構成プロファイルの作成](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateConfigurationProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/create-configuration-profile.html)」を参照してください。 ### `create-environment` 次のコード例は、`create-environment` を使用する方法を示しています。 **AWS CLI** **環境を作成する方法** 次の `create-environment` の例では、create-application を使用して作成したアプリケーションを使用して Example-Environment という名前の AWS AppConfig 環境を作成します。 ``` aws appconfig create-environment \ --application-id "339ohji" \ --name "Example-Environment" ``` 出力: ``` { "ApplicationId": "339ohji", "Description": null, "Id": "54j1r29", "Monitors": null, "Name": "Example-Environment", "State": "ReadyForDeployment" } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の「[ステップ 2: 環境の作成](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-environment.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/create-environment.html)」を参照してください。 ### `create-extension-association` 次のコード例は、`create-extension-association` を使用する方法を示しています。 **AWS CLI** **拡張機能を作成する方法** 次の `create-extension-association` の例では、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 ``` 出力: ``` { "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 } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の「[AWS AppConfig 拡張機能の使用](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateExtensionAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/create-extension-association.html)」を参照してください。 ### `create-extension` 次のコード例は、`create-extension` を使用する方法を示しています。 **AWS CLI** **拡張機能を作成する方法** 次の `create-extension` の例では、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} ``` 出力: ``` { "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 } } } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の「[AWS AppConfig 拡張機能の使用](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateExtension](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/create-extension.html)」を参照してください。 ### `create-hosted-configuration-version` 次のコード例は、`create-hosted-configuration-version` を使用する方法を示しています。 **AWS CLI** **ホストされた構成バージョンを作成する方法** 次の `create-hosted-configuration-version` の例では、AWS AppConfig ホスト構成ストアで新しい構成を作成します。構成コンテンツは、まず base64 に変換する必要があります。 ``` aws appconfig create-hosted-configuration-version \ --application-id "339ohji" \ --configuration-profile-id "ur8hx2f" \ --content eyAiTmFtZSI6ICJFeGFtcGxlQXBwbGljYXRpb24iLCAiSWQiOiBFeGFtcGxlSUQsICJSYW5rIjogNyB9 \ --content-type "application/json" \ configuration_version_output_file ``` `configuration_version_output_file` の内容: ``` { "Name": "ExampleApplication", "Id": ExampleID, "Rank": 7 } ``` 出力: ``` { "ApplicationId": "339ohji", "ConfigurationProfileId": "ur8hx2f", "VersionNumber": "1", "ContentType": "application/json" } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の「[AWS AppConfig ホスト構成ストアについて](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html#appconfig-creating-configuration-and-profile-about-hosted-store)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateHostedConfigurationVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/create-hosted-configuration-version.html)」を参照してください。 ### `delete-application` 次のコード例は、`delete-application` を使用する方法を示しています。 **AWS CLI** **アプリケーションを削除するには** 以下の `delete-application` の例は、指定されたスタックを削除します。 ``` aws appconfig delete-application \ --application-id 339ohji ``` このコマンドでは何も出力されません。 詳細については、「*AWS AppConfig ユーザーガイド*」の「[ステップ 1: AWS AppConfig アプリケーションの作成](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-application.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/delete-application.html)」を参照してください。 ### `delete-configuration-profile` 次のコード例は、`delete-configuration-profile` を使用する方法を示しています。 **AWS CLI** **構成プロファイルを削除する方法** 次の `delete-configuration-profile` の例では、指定された構成プロファイルを削除します。 ``` aws appconfig delete-configuration-profile \ --application-id 339ohji \ --configuration-profile-id ur8hx2f ``` このコマンドでは何も出力されません。 詳細については、「*AWS AppConfig ユーザーガイド*」の「[ステップ 3: 構成および構成プロファイルの作成](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteConfigurationProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/delete-configuration-profile.html)」を参照してください。 ### `delete-deployment-strategy` 次のコード例は、`delete-deployment-strategy` を使用する方法を示しています。 **AWS CLI** **デプロイ戦略を削除する方法** 次の `delete-deployment-strategy` の例は、指定されたデプロイ戦略を削除します。 ``` aws appconfig delete-deployment-strategy \ --deployment-strategy-id 1225qzk ``` このコマンドでは何も出力されません。 詳細については、「*AWS AppConfig ユーザーガイド*」の「[ステップ 4: デプロイ戦略の作成](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-deployment-strategy.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDeploymentStrategy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/delete-deployment-strategy.html)」を参照してください。 ### `delete-environment` 次のコード例は、`delete-environment` を使用する方法を示しています。 **AWS CLI** **環境を削除する方法** 以下の `delete-environment` の例は、指定されたアプリケーション環境を削除します。 ``` aws appconfig delete-environment \ --application-id 339ohji \ --environment-id 54j1r29 ``` このコマンドでは何も出力されません。 詳細については、「*AWS AppConfig ユーザーガイド*」の「[ステップ 2: 環境の作成](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-environment.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/delete-environment.html)」を参照してください。 ### `delete-extension-association` 次のコード例は、`delete-extension-association` を使用する方法を示しています。 **AWS CLI** **拡張機能の関連付けを削除する方法** 次の `delete-extension-association` の例では、AWS AppConfig に新しい拡張機能の関連付けを削除します。 ``` aws appconfig delete-extension-association \ --region us-west-2 \ --extension-association-id a1b2c3d4 ``` このコマンドでは何も出力されません。 詳細については、「*AWS AppConfig ユーザーガイド*」の「[AWS AppConfig 拡張機能の使用](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteExtensionAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/delete-extension-association.html)」を参照してください。 ### `delete-extension` 次のコード例は、`delete-extension` を使用する方法を示しています。 **AWS CLI** **拡張機能を削除する方法** 次の `delete-extension` の例では、AWS AppConfig に新しい拡張機能を削除します。 ``` aws appconfig delete-extension \ --region us-west-2 \ --extension-identifier S3-backup-extension ``` このコマンドでは何も出力されません。 詳細については、「*AWS AppConfig ユーザーガイド*」の「[AWS AppConfig 拡張機能の使用](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteExtension](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/delete-extension.html)」を参照してください。 ### `delete-hosted-configuration-version` 次のコード例は、`delete-hosted-configuration-version` を使用する方法を示しています。 **AWS CLI** **ホストされた構成バージョンを削除する方法** 次の `delete-hosted-configuration-version` の例では、AWS AppConfig ホスト構成ストアでホストされた構成バージョンを削除します。 ``` aws appconfig delete-hosted-configuration-version \ --application-id 339ohji \ --configuration-profile-id ur8hx2f \ --version-number 1 ``` 出力:: このコマンドでは何も出力されません。 詳細については、「*AWS AppConfig ユーザーガイド*」の「[ステップ 3: 構成および構成プロファイルの作成](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteHostedConfigurationVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/delete-hosted-configuration-version.html)」を参照してください。 ### `get-application` 次のコード例は、`get-application` を使用する方法を示しています。 **AWS CLI** **アプリケーションの詳細を一覧表示する方法** 次の `get-application` の例では、指定されたアプリケーションの詳細を一覧表示します。 ``` aws appconfig get-application \ --application-id 339ohji ``` 出力: ``` { "Description": "An application used for creating an example.", "Id": "339ohji", "Name": "example-application" } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の「[AWS AppConfig 拡張機能について](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html#learn-more-appconfig-how-it-works)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/get-application.html)」を参照してください。 ### `get-configuration-profile` 次のコード例は、`get-configuration-profile` を使用する方法を示しています。 **AWS CLI** **構成プロファイルの詳細を取得する方法** 次の `get-configuration-profile` の例では、指定された構成プロファイルの詳細を返します。 ``` aws appconfig get-configuration-profile \ --application-id 339ohji \ --configuration-profile-id ur8hx2f ``` 出力: ``` { "ApplicationId": "339ohji", "Id": "ur8hx2f", "Name": "Example-Configuration-Profile", "LocationUri": "ssm-parameter://Example-Parameter", "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role" } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の「[ステップ 3: 構成および構成プロファイルの作成](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetConfigurationProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/get-configuration-profile.html)」を参照してください。 ### `get-configuration` 次のコード例は、`get-configuration` を使用する方法を示しています。 **AWS CLI** **構成の詳細を取得する方法** 次の `get-configuration` の例では、サンプルアプリケーションの構成の詳細を返します。後続の get-configuration 呼び出しでは、 `client-configuration-version` パラメータを使用して、バージョンが変更された場合にのみアプリケーションの設定を更新します。バージョンが変更された場合にのみ設定を更新すると、get-configuration を呼び出すことで発生する超過料金を回避できます。 ``` aws appconfig get-configuration \ --application "example-application" \ --environment "Example-Environment" \ --configuration "Example-Configuration-Profile" \ --client-id "test-id" \ configuration-output-file ``` `configuration-output-file` の内容: ``` { "Name": "ExampleApplication", "Id": ExampleID, "Rank": 7 } ``` 出力: ``` { "ConfigurationVersion": "1", "ContentType": "application/json" } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の[「ステップ 6: 構成の受信](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/get-configuration.html)」を参照してください。 ### `get-deployment-strategy` 次のコード例は、`get-deployment-strategy` を使用する方法を示しています。 **AWS CLI** **デプロイ戦略の詳細を取得する方法** 次の `get-deployment-strategy` の例は、指定されたデプロイ戦略の詳細を一覧表示します。 ``` aws appconfig get-deployment-strategy \ --deployment-strategy-id 1225qzk ``` 出力: ``` { "Id": "1225qzk", "Name": "Example-Deployment", "DeploymentDurationInMinutes": 15, "GrowthType": "LINEAR", "GrowthFactor": 25.0, "FinalBakeTimeInMinutes": 0, "ReplicateTo": "SSM_DOCUMENT" } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の「[ステップ 4: デプロイ戦略の作成](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-deployment-strategy.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDeploymentStrategy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/get-deployment-strategy.html)」を参照してください。 ### `get-deployment` 次のコード例は、`get-deployment` を使用する方法を示しています。 **AWS CLI** **デプロイの詳細を取得する方法** 次の `get-deployment` の例は、指定された環境とデプロイ内のアプリケーションへのデプロイの詳細を一覧表示します。 ``` aws appconfig get-deployment \ --application-id 339ohji \ --environment-id 54j1r29 \ --deployment-number 1 ``` 出力: ``` { "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" } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の[「ステップ 5: 構成のデプロイ](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-deploying.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/get-deployment.html)」を参照してください。 ### `get-environment` 次のコード例は、`get-environment` を使用する方法を示しています。 **AWS CLI** **環境の詳細を取得する方法** 次の `get-environment` の例は、指定された環境の詳細と状態を返します。 ``` aws appconfig get-environment \ --application-id 339ohji \ --environment-id 54j1r29 ``` 出力: ``` { "ApplicationId": "339ohji", "Id": "54j1r29", "Name": "Example-Environment", "State": "ReadyForDeployment" } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の「[ステップ 2: 環境の作成](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-environment.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/get-environment.html)」を参照してください。 ### `get-extension-association` 次のコード例は、`get-extension-association` を使用する方法を示しています。 **AWS CLI** **拡張機能の関連付けの詳細を取得する方法** 以下の `get-extension-association` の例では、機能拡張の関連付けに関する情報を表示します。 ``` aws appconfig get-extension-association \ --region us-west-2 \ --extension-association-id a1b2c3d4 ``` 出力: ``` { "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 } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の「[AWS AppConfig 拡張機能の使用](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetExtensionAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/get-extension-association.html)」を参照してください。 ### `get-extension` 次のコード例は、`get-extension` を使用する方法を示しています。 **AWS CLI** **拡張機能の詳細を取得する方法** 以下の `get-extension` の例では、機能拡張に関する情報を表示します。 ``` aws appconfig get-extension \ --region us-west-2 \ --extension-identifier S3-backup-extension ``` 出力: ``` { "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 } } } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の「[AWS AppConfig 拡張機能の使用](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetExtension](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/get-extension.html)」を参照してください。 ### `get-hosted-configuration-version` 次の例は、`get-hosted-configuration-version` を使用する方法を説明しています。 **AWS CLI** **ホスト構成の詳細を取得する方法** 次の `get-hosted-configuration-version` の例では、AWS AppConfig ホスト構成の設定の詳細を取得します。 ``` aws appconfig get-hosted-configuration-version \ --application-id 339ohji \ --configuration-profile-id ur8hx2f \ --version-number 1 \ hosted-configuration-version-output ``` `hosted-configuration-version-output` の内容: ``` { "Name": "ExampleApplication", "Id": ExampleID, "Rank": 7 } ``` 出力: ``` { "ApplicationId": "339ohji", "ConfigurationProfileId": "ur8hx2f", "VersionNumber": "1", "ContentType": "application/json" } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の「[AWS AppConfig ホスト構成ストアについて](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html#appconfig-creating-configuration-and-profile-about-hosted-store)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetHostedConfigurationVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/get-hosted-configuration-version.html)」を参照してください。 ### `list-applications` 次のコード例は、`list-applications` を使用する方法を示しています。 **AWS CLI** **使用可能なアプリケーションを一覧表示する方法** 次の `list-applications` の例では、AWS アカウントで使用可能なアプリケーションを一覧表示します。 ``` aws appconfig list-applications ``` 出力: ``` { "Items": [ { "Id": "339ohji", "Name": "test-application", "Description": "An application used for creating an example." }, { "Id": "rwalwu7", "Name": "Test-Application" } ] } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の「[ステップ 1: AWS AppConfig アプリケーションの作成](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-application.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListApplications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/list-applications.html)」を参照してください。 ### `list-configuration-profiles` 次のコード例は、`list-configuration-profiles` を使用する方法を示しています。 **AWS CLI** **使用可能な構成プロファイルを一覧表示する方法** 次の `list-configuration-profiles` の例では、指定されたアプリケーションで使用可能な構成プロファイルを一覧表示します。 ``` aws appconfig list-configuration-profiles \ --application-id 339ohji ``` 出力: ``` { "Items": [ { "ApplicationId": "339ohji", "Id": "ur8hx2f", "Name": "Example-Configuration-Profile", "LocationUri": "ssm-parameter://Example-Parameter" } ] } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の「[ステップ 3: 構成および構成プロファイルの作成](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListConfigurationProfiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/list-configuration-profiles.html)」を参照してください。 ### `list-deployment-strategies` 次のコード例は、`list-deployment-strategies` を使用する方法を示しています。 **AWS CLI** **利用可能なデプロイ戦略を一覧表示する方法** 次の `list-deployment-strategies` の例では、AWS アカウントで使用可能なデプロイ戦略を一覧表示します。 ``` aws appconfig list-deployment-strategies ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の「[ステップ 4: デプロイ戦略の作成](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-deployment-strategy.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDeploymentStrategies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/list-deployment-strategies.html)」を参照してください。 ### `list-deployments` 次のコード例は、`list-deployments` を使用する方法を示しています。 **AWS CLI** **使用可能なデプロイを一覧表示する方法** 次の `list-deployments` の例では、指定されたアプリケーションと環境の AWS アカウントで使用可能なデプロイを一覧表示します。 ``` aws appconfig list-deployments \ --application-id 339ohji \ --environment-id 54j1r29 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の[「ステップ 5: 構成のデプロイ](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-deploying.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/list-deployments.html)」を参照してください。 ### `list-environments` 次のコード例は、`list-environments` を使用する方法を示しています。 **AWS CLI** **使用可能な環境を一覧表示する方法** 次の `list-environments` の例では、指定されたアプリケーションの AWS アカウントで使用可能な環境を一覧表示します。 ``` aws appconfig list-environments \ --application-id 339ohji ``` 出力: ``` { "Items": [ { "ApplicationId": "339ohji", "Id": "54j1r29", "Name": "Example-Environment", "State": "ReadyForDeployment" } ] } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の「[ステップ 2: 環境の作成](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-environment.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListEnvironments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/list-environments.html)」を参照してください。 ### `list-extension-associations` 次のコード例は、`list-extension-associations` を使用する方法を示しています。 **AWS CLI** **AWS リージョンの AWS アカウント内のすべての AWS AppConfig 拡張機能の関連付けを一覧表示する方法** 次の `list-extension-associations` の例では、特定の AWS リージョンの現在の AWS アカウントのすべての AWS AppConfig 拡張機能の関連付けを一覧表示します。 ``` aws appconfig list-extension-associations \ --region us-west-2 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の「[AWS AppConfig 拡張機能の使用](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListExtensionAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/list-extension-associations.html)」を参照してください。 ### `list-extensions` 次のコード例は、`list-extensions` を使用する方法を示しています。 **AWS CLI** **AWS リージョンの AWS アカウント内のすべての AWS AppConfig 拡張機能を一覧表示する方法** 次の `list-extensions` の例では、特定の AWS リージョンの現在の AWS アカウントのすべての AWS AppConfig 拡張機能を一覧表示します。コマンドは、カスタム拡張機能と AWS オーサリングされた拡張機能を返します。 ``` aws appconfig list-extensions \ --region us-west-2 ``` 出力: ``` { "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." } ] } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の「[AWS AppConfig 拡張機能の使用](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListExtensions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/list-extensions.html)」を参照してください。 ### `list-hosted-configuration-versions` 次のコード例は、`list-hosted-configuration-versions` を使用する方法を示しています。 **AWS CLI** **利用可能なホスト構成バージョンを一覧表示する方法** 次の `list-hosted-configuration-versions` の例では、指定されたアプリケーションと構成プロファイルの AWS AppConfig ホスト構成ストアでホストされている構成バージョンを一覧表示します。 ``` aws appconfig list-hosted-configuration-versions \ --application-id 339ohji \ --configuration-profile-id ur8hx2f ``` 出力: ``` { "Items": [ { "ApplicationId": "339ohji", "ConfigurationProfileId": "ur8hx2f", "VersionNumber": 1, "ContentType": "application/json" } ] } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の「[AWS AppConfig ホスト構成ストアについて](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html#appconfig-creating-configuration-and-profile-about-hosted-store)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListHostedConfigurationVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/list-hosted-configuration-versions.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **アプリケーションのタグを一覧表示する方法** 次の `list-tags-for-resource` の例では、指定されたアプリケーションのタグを一覧表示します。 ``` aws appconfig list-tags-for-resource \ --resource-arn arn:aws:appconfig:us-east-1:682428703967:application/339ohji ``` 出力: ``` { "Tags": { "group1": "1" } } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の「[ステップ 1: AWS AppConfig アプリケーションの作成](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-application.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/list-tags-for-resource.html)」を参照してください。 ### `start-deployment` 次のコード例は、`start-deployment` を使用する方法を示しています。 **AWS CLI** **構成デプロイを開始する方法** 次の `start-deployment` の例では、指定された環境、デプロイ戦略、構成プロファイルを使用してアプリケーションへのデプロイを開始します。 ``` aws appconfig start-deployment \ --application-id 339ohji \ --environment-id 54j1r29 \ --deployment-strategy-id 1225qzk \ --configuration-profile-id ur8hx2f \ --configuration-version 1 ``` 出力: ``` { "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" } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の[「ステップ 5: 構成のデプロイ](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-deploying.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/start-deployment.html)」を参照してください。 ### `stop-deployment` 次のコード例は、`stop-deployment` を使用する方法を示しています。 **AWS CLI** **設定のデプロイを停止する方法** 次の `stop-deployment` の例では、指定された環境へのアプリケーション設定のデプロイを停止します。 ``` aws appconfig stop-deployment \ --application-id 339ohji \ --environment-id 54j1r29 \ --deployment-number 2 ``` 出力: ``` { "DeploymentNumber": 0, "DeploymentDurationInMinutes": 0, "GrowthFactor": 0.0, "FinalBakeTimeInMinutes": 0, "PercentageComplete": 0.0 } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の[「ステップ 5: 構成のデプロイ](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-deploying.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/stop-deployment.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **アプリケーションにタグ付けする方法** 次の `tag-resource` の例では、アプリケーションリソースにタグ付けします。 ``` aws appconfig tag-resource \ --resource-arn arn:aws:appconfig:us-east-1:682428703967:application/339ohji \ --tags '{"group1" : "1"}' ``` このコマンドでは何も出力されません。 詳細については、「*AWS AppConfig ユーザーガイド*」の「[ステップ 1: AWS AppConfig アプリケーションの作成](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-application.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **アプリケーションからタグを削除する方法** 次の `untag-resource` の例では、指定されたアプリケーションから group1 のタグを削除します。 ``` aws appconfig untag-resource \ --resource-arn arn:aws:appconfig:us-east-1:111122223333:application/339ohji \ --tag-keys '["group1"]' ``` このコマンドでは何も出力されません。 詳細については、「*AWS AppConfig ユーザーガイド*」の「[ステップ 1: AWS AppConfig アプリケーションの作成](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-application.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/untag-resource.html)」を参照してください。 ### `update-application` 次のコード例は、`update-application` を使用する方法を示しています。 **AWS CLI** **アプリケーションを更新する方法** 次の `update-application` の例では、指定されたアプリケーションの名前を更新します。 ``` aws appconfig update-application \ --application-id 339ohji \ --name "Example-Application" ``` 出力: ``` { "Id": "339ohji", "Name": "Example-Application", "Description": "An application used for creating an example." } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の「[ステップ 1: AWS AppConfig アプリケーションの作成](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-application.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/update-application.html)」を参照してください。 ### `update-configuration-profile` 次のコード例は、`update-configuration-profile` を使用する方法を示しています。 **AWS CLI** **構成プロファイルを更新する方法** 次の `update-configuration-profile` の例では、指定された構成プロファイルの説明を更新します。 ``` aws appconfig update-configuration-profile \ --application-id 339ohji \ --configuration-profile-id ur8hx2f \ --description "Configuration profile used for examples." ``` 出力: ``` { "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" } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の「[ステップ 3: 構成および構成プロファイルの作成](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateConfigurationProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/update-configuration-profile.html)」を参照してください。 ### `update-deployment-strategy` 次のコード例は、`update-deployment-strategy` を使用する方法を示しています。 **AWS CLI** **デプロイ戦略を更新する方法** 次の `update-deployment-strategy` の例では、指定されたデプロイ戦略の最終ベイク時間を 20 分に更新します。 ``` aws appconfig update-deployment-strategy \ --deployment-strategy-id 1225qzk \ --final-bake-time-in-minutes 20 ``` 出力: ``` { "Id": "1225qzk", "Name": "Example-Deployment", "DeploymentDurationInMinutes": 15, "GrowthType": "LINEAR", "GrowthFactor": 25.0, "FinalBakeTimeInMinutes": 20, "ReplicateTo": "SSM_DOCUMENT" } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の「[ステップ 4: デプロイ戦略の作成](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-deployment-strategy.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateDeploymentStrategy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/update-deployment-strategy.html)」を参照してください。 ### `update-environment` 次のコード例は、`update-environment` を使用する方法を示しています。 **AWS CLI** **環境を更新する方法** 次の `update-environment` の例では、環境の説明を更新します。 ``` aws appconfig update-environment \ --application-id 339ohji \ --environment-id 54j1r29 \ --description "An environment for examples." ``` 出力: ``` { "ApplicationId": "339ohji", "Id": "54j1r29", "Name": "Example-Environment", "Description": "An environment for examples.", "State": "RolledBack" } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の「[ステップ 2: 環境の作成](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-environment.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/update-environment.html)」を参照してください。 ### `update-extension-association` 次のコード例は、`update-extension-association` を使用する方法を示しています。 **AWS CLI** **AWS AppConfig 拡張機能の関連付けを更新する方法** 次の `update-extension-association` の例では、AWS AppConfig で拡張機能の関連付けに新しいパラメータ値を追加します。 ``` aws appconfig update-extension-association \ --region us-west-2 \ --extension-association-id a1b2c3d4 \ --parameters S3bucket=FinanceMobileApp ``` 出力: ``` { "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 } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の「[AWS AppConfig 拡張機能の使用](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateExtensionAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/update-extension-association.html)」を参照してください。 ### `update-extension` 次のコード例は、`update-extension` を使用する方法を示しています。 **AWS CLI** **AWS AppConfig 拡張機能を更新する方法** 次の `update-extension` の例では、AWS AppConfig で拡張機能にパラメータ値を追加します。 ``` aws appconfig update-extension \ --region us-west-2 \ --extension-identifier S3-backup-extension \ --parameters S3bucket={Required=true},CampaignID={Required=false} ``` 出力: ``` { "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 } } } ``` 詳細については、「*AWS AppConfig ユーザーガイド*」の「[AWS AppConfig 拡張機能の使用](https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateExtension](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/update-extension.html)」を参照してください。 ### `validate-configuration` 次のコード例は、`validate-configuration` を使用する方法を示しています。 **AWS CLI** **構成を検証する方法** 次の `validate-configuration` の例では、構成プロファイルのバリデータを使用して構成を検証します。 ``` aws appconfig validate-configuration \ --application-id abc1234 \ --configuration-profile-id ur8hx2f \ --configuration-version 1 ``` このコマンドでは何も出力されません。 詳細については、「*AWS AppConfig ユーザーガイド*」の「[ステップ 3: 構成および構成プロファイルの作成](https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ValidateConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/appconfig/validate-configuration.html)」を参照してください。 # AWS CLI を使用した Application Auto Scaling の例 次のコード例は、Application Auto Scaling で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `delete-scaling-policy` 次のコード例は、`delete-scaling-policy` を使用する方法を示しています。 **AWS CLI** **スケーリングポリシーを削除する方法** この例では、デフォルトのクラスターで実行されている Amazon ECS サービスウェブアプリのスケーリングポリシーを削除します。 コマンド: ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteScalingPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/delete-scaling-policy.html)」を参照してください。 ### `delete-scheduled-action` 次の例は、`delete-scheduled-action` を使用する方法を説明しています。 **AWS CLI** **スケジュールされたアクションを削除するには** 次の `delete-scheduled-action` の例では、指定された 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 ``` このコマンドでは何も出力されません。 詳細については、「*Application Auto Scaling ユーザーガイド*」の「[スケジュールされたスケーリング](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteScheduledAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/delete-scheduled-action.html)」を参照してください。 ### `deregister-scalable-target` 次のコード例は、`deregister-scalable-target` を使用する方法を示しています。 **AWS CLI** **スケーラブルターゲットを登録解除する方法** この例では、デフォルトのクラスターで実行されているウェブアプリと呼ばれる Amazon ECS サービスのスケーラブルターゲットを登録解除します。 コマンド: ``` aws application-autoscaling deregister-scalable-target --service-namespace ecs --scalable-dimension ecs:service:DesiredCount --resource-id service/default/web-app ``` この例では、カスタムリソースのスケーラブルターゲットを登録解除します。custom-resource-id.txt ファイルにはリソース ID を識別する文字列が含まれており、これはカスタムリソースの場合、Amazon API Gateway エンドポイント経由でのカスタムリソースへのパスを表します。 コマンド: ``` aws application-autoscaling deregister-scalable-target --service-namespace custom-resource --scalable-dimension custom-resource:ResourceType:Property --resource-id file://~/custom-resource-id.txt ``` custom-resource-id.txt ファイルの内容: ``` https://example.execute-api.us-west-2.amazonaws.com/prod/scalableTargetDimensions/1-23456789 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeregisterScalableTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/deregister-scalable-target.html)」を参照してください。 ### `describe-scalable-targets` 次のコード例は、`describe-scalable-targets` を使用する方法を示しています。 **AWS CLI** **スケーラブルターゲットを記述する方法** 次の `describe-scalable-targets` 例では、`ecs` サービス名前空間のスケーラブルターゲットについて説明します。 ``` aws application-autoscaling describe-scalable-targets \ --service-namespace ecs ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Application Auto Scaling ユーザーガイド*」の「[Application Auto Scaling と共に使用可能な AWS サービス](https://docs.aws.amazon.com/autoscaling/application/userguide/integrated-services-list.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeScalableTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/describe-scalable-targets.html)」を参照してください。 ### `describe-scaling-activities` 次のコード例は、`describe-scaling-activities` を使用する方法を示しています。 **AWS CLI** **例 1: 指定された Amazon ECS サービスのスケーリングアクティビティを記述する方法** 次の `describe-scaling-activities` の例では、`default` クラスターで実行されている「`web-app`」という Amazon ECS サービスのスケーリングアクティビティについて記述します。出力には、スケーリングポリシーによって開始されたスケーリングアクティビティが表示されます。 ``` aws application-autoscaling describe-scaling-activities \ --service-namespace ecs \ --resource-id service/default/web-app ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Application Auto Scaling ユーザーガイド*」の「[Application Auto Scaling のスケーリングアクティビティ](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scaling-activities.html)」を参照してください。 **例 2: 指定された DynamoDB テーブルのスケーリングアクティビティを記述する方法** 次の `describe-scaling-activities` の例では、`TestTable` という DynamoDB テーブルのスケーリングアクティビティについて記述します。出力には、2 つの異なるスケジュールされたアクションによって開始されたスケーリングアクティビティが表示されます。 ``` aws application-autoscaling describe-scaling-activities \ --service-namespace dynamodb \ --resource-id table/TestTable ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Application Auto Scaling ユーザーガイド*」の「[Application Auto Scaling のスケーリングアクティビティ](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scaling-activities.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeScalingActivities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/describe-scaling-activities.html)」を参照してください。 ### `describe-scaling-policies` 次の例は、`describe-scaling-policies` を使用する方法を説明しています。 **AWS CLI** **スケーリングポリシーを記述する方法** この例では、ECS サービス名前空間のスケーリングポリシーについて記述します。 コマンド: ``` aws application-autoscaling describe-scaling-policies --service-namespace ecs ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeScalingPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/describe-scaling-policies.html)」を参照してください。 ### `describe-scheduled-actions` 次のコード例は、`describe-scheduled-actions` を使用する方法を示しています。 **AWS CLI** **スケジュールが設定されたアクションを記述する方法** 次の `describe-scheduled-actions` の例では、指定されたサービス名前空間でスケジュールが設定されたアクションの詳細を表示します。 ``` aws application-autoscaling describe-scheduled-actions \ --service-namespace dynamodb ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Application Auto Scaling ユーザーガイド*」の「[スケジュールされたスケーリング](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeScheduledActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/describe-scheduled-actions.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **スケーラブルターゲットのタグを一覧表示する方法** 次の `list-tags-for-resource` の例では、ARN で指定されたスケーラブルターゲットにアタッチされているタグキーの名前と値を一覧表示します。 ``` aws application-autoscaling list-tags-for-resource \ --resource-arn arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123 ``` 出力: ``` { "Tags": { "environment": "production" } } ``` 詳細については、「*Application Auto Scaling ユーザーガイド*」の「[Application Auto Scaling のタグ付けサポート](https://docs.aws.amazon.com/autoscaling/application/userguide/resource-tagging-support.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/list-tags-for-resource.html)」を参照してください。 ### `put-scaling-policy` 次のコード例は、`put-scaling-policy` を使用する方法を示しています。 **AWS CLI** **例 1: 事前定義されたメトリクス指定を使用してターゲット追跡スケーリングポリシーを適用するには** 以下の `put-scaling-policy` の例では、デフォルトクラスター内の web-app と呼ばれる Amazon ECS サービスに、事前に定義されたメトリック仕様でターゲット追跡スケーリングポリシーを適用します。このポリシーでは、サービスの平均 CPU 使用率を 75% に保ち、スケールアウトとスケールインのクールダウン期間は 60 秒です。出力には、自動的に作成された 2 つの CloudWatch アラームの ARN と名前が含まれます。 ``` 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 ``` この例では、現在のディレクトリに次の内容の config.json ファイルがあることを前提としています。 ``` { "TargetValue": 75.0, "PredefinedMetricSpecification": { "PredefinedMetricType": "ECSServiceAverageCPUUtilization" }, "ScaleOutCooldown": 60, "ScaleInCooldown": 60 } ``` 出力: ``` { "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" } ] } ``` **例 2: カスタマイズされたメトリクス仕様を使用してターゲット追跡スケーリングポリシーを適用するには** 以下の `put-scaling-policy` の例では、デフォルトクラスター内の web-app と呼ばれる Amazon ECS サービスに、カスタマイズされたメトリック仕様でターゲット追跡スケーリングポリシーを適用します。このポリシーでは、サービスの平均使用率を 75% に保ち、スケールアウトとスケールインのクールダウン期間は 60 秒です。出力には、自動的に作成された 2 つの CloudWatch アラームの ARN と名前が含まれます。 ``` 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 ``` この例では、現在のディレクトリに次の内容の config.json ファイルがあることを前提としています。 ``` { "TargetValue":75.0, "CustomizedMetricSpecification":{ "MetricName":"MyUtilizationMetric", "Namespace":"MyNamespace", "Dimensions": [ { "Name":"MyOptionalMetricDimensionName", "Value":"MyOptionalMetricDimensionValue" } ], "Statistic":"Average", "Unit":"Percent" }, "ScaleOutCooldown": 60, "ScaleInCooldown": 60 } ``` 出力: ``` { "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" } ] } ``` **例 3: スケールアウトにのみターゲット追跡スケーリングポリシーを適用するには** 次の `put-scaling-policy` の例では、ターゲット追跡スケーリングポリシーを、デフォルトのクラスターで `web-app` という Amazon ECS サービスに適用します。このポリシーは、Application Load Balancer の `RequestCountPerTarget` メトリクスがしきい値を超えたときに ECS サービスをスケールアウトするために使用されます。出力には、自動的に作成された CloudWatch アラームの ARN と名前が含まれます。 ``` 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 ``` `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 } ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS Application Auto Scaling ユーザーガイド*」の「[Application Auto Scaling のターゲット追跡スケーリングポリシー](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutScalingPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/put-scaling-policy.html)」を参照してください。 ### `put-scheduled-action` 次の例は、`put-scheduled-action` を使用する方法を説明しています。 **AWS CLI** **スケジュールされたアクションを DynamoDB テーブルに追加する方法** この例では、TestTable という名前の DynamoDB テーブルにスケジュールされたアクションを追加して、定期的なスケジュールに合わせてスケールアウトします。特定のスケジュール (毎日午後 12:15 (UTC)) で、現在の容量が MinCapacity に指定された値を下回る場合、Application Auto Scaling は MinCapacity で指定された値にスケールアウトします。 コマンド: ``` 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 ``` 詳細については、「*Application Auto Scaling ユーザーガイド*」の「スケジュールされたスケーリング」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutScheduledAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/put-scheduled-action.html)」を参照してください。 ### `register-scalable-target` 次の例は、`register-scalable-target` を使用する方法を説明しています。 **AWS CLI** **例 1: ECS サービスをスケーラブルターゲットとして登録する方法** 以下の `register-scalable-target` の例は、Amazon ECS サービスを Application Auto Scaling に登録します。また、スケーラブルターゲットにキー名「`environment`」と値「`production`」を含むタグを追加します。 ``` 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 ``` 出力: ``` { "ScalableTargetARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123" } ``` その他の AWS サービスやカスタムリソースの例については、「*Application Auto Scaling ユーザーガイド*」の「[AWSApplication Auto Scaling で使用できるサービス](https://docs.aws.amazon.com/autoscaling/application/userguide/integrated-services-list.html)」のトピックを参照してください。 **例 2: スケーラブルターゲットのスケーリングアクティビティを一時停止する方法** 次の `register-scalable-target` の例では、既存のスケーラブルターゲットのスケーリングアクティビティを一時停止します。 ``` 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 ``` 出力: ``` { "ScalableTargetARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123" } ``` 詳細については、「*Application Auto Scaling ユーザーガイド*」の「[Application Auto Scaling のスケーリングの一時停止と再開](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-suspend-resume-scaling.html)」を参照してください。 **例 3: スケーラブルターゲットのスケーリングアクティビティを再開する方法** 次の `register-scalable-target` の例では、既存のスケーラブルターゲットのスケーリングアクティビティを再開します。 ``` 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 ``` 出力: ``` { "ScalableTargetARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123" } ``` 詳細については、「*Application Auto Scaling ユーザーガイド*」の「[Application Auto Scaling のスケーリングの一時停止と再開](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-suspend-resume-scaling.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegisterScalableTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/register-scalable-target.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **スケーラブルターゲットにタグを追加する方法** 次の `tag-resource` の例では、ARN で指定されたスケーラブルターゲットにキー名「`environment`」と値「`production`」を含むタグを追加します。 ``` aws application-autoscaling tag-resource \ --resource-arn arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123 \ --tags environment=production ``` このコマンドでは何も出力されません。 詳細については、「*Application Auto Scaling ユーザーガイド*」の「[Application Auto Scaling のタグ付けサポート](https://docs.aws.amazon.com/autoscaling/application/userguide/resource-tagging-support.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **スケーラブルターゲットからタグを削除する方法** 次の `untag-resource` の例では、ARN で指定されたスケーラブルターゲットにキー名「`environment`」を含むタグペアを削除します。 ``` aws application-autoscaling untag-resource \ --resource-arn arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123 \ --tag-keys "environment" ``` このコマンドでは何も出力されません。 詳細については、「*Application Auto Scaling ユーザーガイド*」の「[Application Auto Scaling のタグ付けサポート](https://docs.aws.amazon.com/autoscaling/application/userguide/resource-tagging-support.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-autoscaling/untag-resource.html)」を参照してください。 # AWS CLI を使用した Application Discovery Service の例 次のコード例では、Application Discovery Service で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `describe-agents` 次のコード例では、`describe-agents` を使用する方法を示しています。 **AWS CLI** **指定された collectionStatus 状態を持つエージェントを説明する** この例では、コレクションステータスが「STARTED」または「STOPPED」のコレクションエージェントを記述します。 コマンド: ``` aws discovery describe-agents --filters name="collectionStatus",values="STARTED","STOPPED",condition="EQUALS" --max-results 3 ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAgents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/discovery/describe-agents.html)」を参照してください。 ### `describe-configurations` 次のコード例では、`describe-configurations` を使用する方法を示しています。 **AWS CLI** **選択したアセット構成の説明** この例では、2 つの指定されたサーバーの構成を記述します。アクションは、構成 ID からアセットのタイプを検出します。コマンドごとに許可されるアセットのタイプは 1 つだけです。 コマンド: ``` aws discovery describe-configurations --configuration-ids "d-server-099385097ef9fbcfb" "d-server-0c4f2dd1fee22c6c1" ``` 出力: ``` { "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" } ] } ``` **選択したアセット構成の説明** この例では、2 つの指定されたアプリケーションの構成を記述します。アクションは、構成 ID からアセットのタイプを検出します。コマンドごとに許可されるアセットのタイプは 1 つだけです。 コマンド: ``` aws discovery describe-configurations --configuration-ids "d-application-0ac39bc0e4fad0e42" "d-application-02444a45288013764q" ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/discovery/describe-configurations.html)」を参照してください。 ### `list-configurations` 次のコード例では、`list-configurations` を使用する方法を示しています。 **AWS CLI** **一連のフィルタ条件を満たすサーバをすべて一覧表示する方法** このコマンド例では、Ubuntu を実行していない 2 つのホスト名パターンのいずれかに一致する検出されたサーバを一覧表示します。 コマンド: ``` 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" ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/discovery/list-configurations.html)」を参照してください。 # AWS CLI を使用した Application Signals の例 次のコード例は、Application Signals で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `batch-get-service-level-objective-budget-report` 次のコード例は、`batch-get-service-level-objective-budget-report` を使用する方法を示しています。 **AWS CLI** **1 つ以上のサービスレベル目標 (SLO) 予算レポートを取得します。** 次の `batch-get-service-level-objective-budget-report` 例では、1 つ以上のサービスレベル目標 (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" ``` 出力: ``` { "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": [] } ``` 詳細については、「*Amazon CloudWatch ユーザーガイド*」の「[Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchGetServiceLevelObjectiveBudgetReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/batch-get-service-level-objective-budget-report.html)」を参照してください。 ### `create-service-level-objective` 次のコード例は、`create-service-level-objective` を使用する方法を示しています。 **AWS CLI** **サービスレベル目標 (SLO) の作成方法** 次の `create-service-level-objective` 例では、サービスレベル目標 (SLO) を作成します。これにより、重要なビジネスオペレーションが顧客の期待を満たしていることを確認することができます。 ``` aws application-signals create-service-level-objective \ --name "SLOName" \ --description "Description of your SLO" \ --sli-config file://sli-config.json ``` `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" } ``` 出力: ``` { "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 } } } ``` 詳細については、「*Amazon CloudWatch ユーザーガイド*」の「[Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateServiceLevelObjective](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/create-service-level-objective.html)」を参照してください。 ### `delete-service-level-objective` 次のコード例は、`delete-service-level-objective` を使用する方法を示しています。 **AWS CLI** **指定されたサービスレベル目標を削除します。** 次の `delete-service-level-objective` の例では、指定されたサービスレベル目標を削除します。 ``` aws application-signals delete-service-level-objective \ --id "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName" ``` このコマンドでは何も出力されません。 詳細については、「*Amazon CloudWatch ユーザーガイド*」の「[Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteServiceLevelObjective](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/delete-service-level-objective.html)」を参照してください。 ### `get-service-level-objective` 次のコード例は、`get-service-level-objective` を使用する方法を示しています。 **AWS CLI** **アカウントで作成された 1 つの SLO に関する情報を返す方法** 次の `get-service-level-objective` 例では、アカウントで作成された 1 つの SLO に関する情報を返します。 ``` aws application-signals get-service-level-objective \ --id "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName" ``` 出力: ``` { "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 } } } ``` 詳細については、「*Amazon CloudWatch ユーザーガイド*」の「[Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetServiceLevelObjective](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/get-service-level-objective.html)」を参照してください。 ### `get-service` 次のコード例は、`get-service` を使用する方法を示しています。 **AWS CLI** **Application Signals によって検出されたサービスに関する情報を返す方法** 次の `get-service` 例は、Application Signals によって検出されたサービスに関する情報を返します。 ``` aws application-signals get-service \ --start-time 1732704000 \ --end-time 1732714500 \ --key-attributes Environment=lambda:default,Name=hello-world-python,Type=Service ``` 出力: ``` { "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" }] } ``` 詳細については、「*Amazon CloudWatch ユーザーガイド*」の「[Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/get-service.html)」を参照してください。 ### `list-service-dependencies` 次のコード例は、`list-service-dependencies` を使用する方法を示しています。 **AWS CLI** **指定したサービスのサービス依存関係のリストを返す方法** 次の `list-service-dependencies` 例は、指定したサービスのサービス依存関係のリストを返します。 ``` aws application-signals list-service-dependencies \ --start-time 1732021200 \ --end-time 1732107600 \ --key-attributes Environment=api-gateway:prod, Name=PetAdoptionStatusUpdater,Type=Service ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon CloudWatch ユーザーガイド*」の「[Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListServiceDependencies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/list-service-dependencies.html)」を参照してください。 ### `list-service-dependents` 次のコード例は、`list-service-dependents` を使用する方法を示しています。 **AWS CLI** **指定された時間範囲内に指定されたサービスを呼び出した依存関係のリストを返す方法** 次の `list-service-dependents` 例では、指定された時間範囲で指定されたサービスを呼び出した依存関係のリストを返します。 ``` aws application-signals list-service-dependents \ --start-time 1732021200 \ --end-time 1732107600 \ --key-attributes Environment=generic:default,Name=PetSite,Type=Service ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon CloudWatch ユーザーガイド*」の「[Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListServiceDependents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/list-service-dependents.html)」を参照してください。 ### `list-service-level-objectives` 次のコード例は、`list-service-level-objectives` を使用する方法を示しています。 **AWS CLI** **このアカウントで作成された SLO のリストを返します。** 次の `list-service-level-objectives` の例では、このアカウントに作成された SLO のリストを返します。 ``` aws application-signals list-service-level-objectives ``` 出力: ``` { "SloSummaries": [{ "Arn": "arn:aws:application-signals:us-east-1:123456789101:slo/test", "Name": "test", "CreatedTime": "2024-12-24T22:01:21.116000+05:30" }] } ``` 詳細については、「*Amazon CloudWatch ユーザーガイド*」の「[Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListServiceLevelObjectives](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/list-service-level-objectives.html)」を参照してください。 ### `list-service-operations` 次のコード例は、`list-service-operations` を使用する方法を示しています。 **AWS CLI** **Application Signals によって検出されたこのサービスのオペレーションのリストを返す方法** 次の `list-service-operations` 例では、Application Signals によって検出されたこのサービスのオペレーションのリストを返します。 ``` aws application-signals list-service-operations \ --start-time 1735017423 \ --end-time 1735103823 \ --key-attributes Environment=generic:default,Name=payforadoption,Type=Service ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon CloudWatch ユーザーガイド*」の「[Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListServiceOperations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/list-service-operations.html)」を参照してください。 ### `list-services` 次のコード例は、`list-services` を使用する方法を示しています。 **AWS CLI** **Application Signals によって検出されたサービスのリストを返す方法** 次の `list-services` 例では、Application Signals によって検出されたサービスのリストを返します。 ``` aws application-signals list-services \ --start-time 1734918791 \ --end-time 1734965591 ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon CloudWatch ユーザーガイド*」の「[Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[ListServices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/list-services.html)」を参照してください。** ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **CloudWatch リソースに関連付けられているタグを表示する方法** 次の `list-tags-for-resource` の例では、CloudWatch リソースに関連付けられているタグを表示します。 ``` aws application-signals list-tags-for-resource \ --resource-arn "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName" ``` 出力: ``` { "Tags": [{ "Key": "test", "Value": "value" }] } ``` 詳細については、「*Amazon CloudWatch ユーザーガイド*」の「[Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/list-tags-for-resource.html)」を参照してください。 ### `start-discovery` 次のコード例は、`start-discovery` を使用する方法を示しています。 **AWS CLI** **この Amazon Web Services アカウントが CloudWatch Application Signals を使用できるようにする方法** 次の `start-discovery` 例では、サービスにリンクされたロール *AWSServiceRoleForCloudWatchApplicationSignals* を作成することで、この Amazon Web Services アカウントが CloudWatch Application Signals を使用できるようにします。 ``` aws application-signals start-discovery ``` このコマンドでは何も出力されません。 詳細については、「*Amazon CloudWatch ユーザーガイド*」の「[Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartDiscovery](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/start-discovery.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **サービスレベルの目標など、指定された CloudWatch リソースに 1 つ以上のタグ (キーと値のペア) を割り当てる方法** 次の `tag-resource` 例では、サービスレベルの目標など、指定された CloudWatch リソースに 1 つ以上のタグ (キーと値のペア) を割り当てます。 ``` aws application-signals tag-resource \ --resource-arn "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName" \ --tags '{"Key":"test","Value":"value"}' ``` このコマンドでは何も出力されません。 詳細については、「*Amazon CloudWatch ユーザーガイド*」の「[Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **指定したリソースから 1 つ以上のタグを削除するには** 次の `untag-resource` 例では、指定されたリソースから 1 つ以上のタグを削除します。 ``` aws application-signals untag-resource \ --resource-arn "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName" \ --tag-keys "test" ``` このコマンドでは何も出力されません。 詳細については、「*Amazon CloudWatch ユーザーガイド*」の「[Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/untag-resource.html)」を参照してください。 ### `update-service-level-objective` 次のコード例は、`update-service-level-objective` を使用する方法を示しています。 **AWS CLI** **既存のサービスレベル目標 (SLO) を更新するには** 次の `update-service-level-objective` 例では、既存のサービスレベル目標 (SLO) を更新します。 ``` aws application-signals update-service-level-objective \ --cli-input-json file://update-slo.json ``` `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 } } ``` 出力: ``` { "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 } } } ``` 詳細については、「*Amazon CloudWatch ユーザーガイド*」の「[Application Signals](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateServiceLevelObjective](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/application-signals/update-service-level-objective.html)」を参照してください。 # AWS CLI を使用した AppRegistry の例 次のコードサンプルは、AppRegistry で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `associate-attribute-group` 次のコード例は、`associate-attribute-group` を使用する方法を示しています。 **AWS CLI** **属性グループを関連付けるには** 次の `associate-attribute-group` の例では、AWS アカウント内の特定の属性グループを AWS アカウント内の特定の属性グループに関連付けます。 ``` aws servicecatalog-appregistry associate-attribute-group \ --application "ExampleApplication" \ --attribute-group "ExampleAttributeGroup" ``` 出力: ``` { "applicationArn": "arn:aws:servicecatalog:us-west-2:813737243517:/applications/0ars38r6btoohvpvd9gqrptt9l", "attributeGroupArn": "arn:aws:servicecatalog:us-west-2:813737243517:/attribute-groups/01sj5xdwhbw54kejwnt09fnpcl" } ``` 詳細については、「*AWS Service Catalog AppRegistry 管理者ガイド*」の「[Associating and disassociating attribute groups](https://docs.aws.amazon.com/servicecatalog/latest/arguide/associate-attr-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateAttributeGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog-appregistry/associate-attribute-group.html)」を参照してください。 ### `create-application` 次のコード例は、`create-application` を使用する方法を示しています。 **AWS CLI** **アプリケーションを作成するには** 次の `create-application` の例では、AWS アカウントに新しいアプリケーションを作成します。 ``` aws servicecatalog-appregistry create-application \ --name "ExampleApplication" ``` 出力: ``` { "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": {} } } ``` 詳細については、「*AWS Service Catalog AppRegistry 管理者ガイド*」の「[Creating applications](https://docs.aws.amazon.com/servicecatalog/latest/arguide/create-apps.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog-appregistry/create-application.html)」を参照してください。 ### `create-attribute-group` 次のコード例は、`create-attribute-group` を使用する方法を示しています。 **AWS CLI** **属性グループを作成するには** 次の `create-attribute-group` の例では、AWS アカウントに新しい属性グループを作成します。 ``` aws servicecatalog-appregistry create-attribute-group \ --name "ExampleAttributeGroup" \ --attributes '{"SomeKey1":"SomeValue1","SomeKey2":"SomeValue2"}' ``` 出力: ``` { "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": {} } } ``` 詳細については、「*AWS Service Catalog AppRegistry 管理者ガイド*」の「[Creating attribute groups](https://docs.aws.amazon.com/servicecatalog/latest/arguide/create-attr-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateAttributeGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog-appregistry/create-attribute-group.html)」を参照してください。 ### `delete-application` 次のコード例は、`delete-application` を使用する方法を示しています。 **AWS CLI** **アプリケーションを削除するには** 次の `delete-application` の例では、AWS アカウント内の特定のアプリケーションを削除します。 ``` aws servicecatalog-appregistry delete-application \ --application "ExampleApplication3" ``` 出力: ``` { "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" } } ``` 詳細については、「AWS Service Catalog AppRegistry 管理者ガイド」の「[Deleting applications](https://docs.aws.amazon.com/servicecatalog/latest/arguide/delete-app-details.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog-appregistry/delete-application.html)」を参照してください。 ### `delete-attribute-group` 次のコード例は、`delete-attribute-group` を使用する方法を示しています。 **AWS CLI** **例 8: 属性グループを削除するには** 次の `delete-attribute-group` の例では、AWS アカウント内の特定の属性グループを削除します。 ``` aws servicecatalog-appregistry delete-attribute-group \ --attribute-group "ExampleAttributeGroup3" ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Service Catalog AppRegistry 管理者ガイド*」の「[Deleting attribute groups](https://docs.aws.amazon.com/servicecatalog/latest/arguide/delete-attr-group.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAttributeGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog-appregistry/delete-attribute-group.html)」を参照してください。 ### `get-application` 次のコード例は、`get-application` を使用する方法を示しています。 **AWS CLI** **アプリケーションを取得するには** 次の `get-application` の例では、AWS アカウント内の特定のアプリケーションに関するメタデータ情報を取得します。 ``` aws servicecatalog-appregistry get-application \ --application "ExampleApplication" ``` 出力: ``` { "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" } } } ``` 詳細については、「*AWS Service Catalog AppRegistry 管理者ガイド*」の「[Using Application details](https://docs.aws.amazon.com/servicecatalog/latest/arguide/access-app-details.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog-appregistry/get-application.html)」を参照してください。 ### `get-attribute-group` 次のコード例は、`get-attribute-group` を使用する方法を示しています。 **AWS CLI** **属性グループを取得するには** 次の `get-attribute-group` の例では、AWS アカウント内の特定の属性グループを取得します。 ``` aws servicecatalog-appregistry get-attribute-group \ --attribute-group "ExampleAttributeGroup" ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Service Catalog AppRegistry 管理者ガイド*」の「[属性グループのメタデータの管理](https://docs.aws.amazon.com/servicecatalog/latest/arguide/manage-metatdata.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAttributeGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog-appregistry/get-attribute-group.html)」を参照してください。 ### `list-applications` 次のコード例は、`list-applications` を使用する方法を示しています。 **AWS CLI** **アプリケーションを一覧表示するには** 次の `list-applications` の例では、AWS アカウント内のすべてのアプリケーションのリストを取得します。 ``` aws servicecatalog-appregistry list-applications ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS Service Catalog AppRegistry 管理者ガイド*」の「[Viewing Application details](https://docs.aws.amazon.com/servicecatalog/latest/arguide/view-app-details.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListApplications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog-appregistry/list-applications.html)」を参照してください。 ### `list-associated-attribute-groups` 次のコード例は、`list-associated-attribute-groups` を使用する方法を示しています。 **AWS CLI** **関連付けられた属性グループを一覧表示するには** 次の `list-associated-attribute-groups` の例では、AWS アカウント内の特定のアプリケーションに関連付けられている AWS アカウント内のすべての属性グループのリストを取得します。 ``` aws servicecatalog-appregistry list-associated-attribute-groups \ --application "ExampleApplication" ``` 出力: ``` { "attributeGroups": [ "01sj5xdwhbw54kejwnt09fnpcl" ] } ``` 詳細については、「*AWS Service Catalog AppRegistry 管理者ガイド*」の「[Associating and disassociating attribute groups](https://https://docs.aws.amazon.com/servicecatalog/latest/arguide/associate-attr-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAssociatedAttributeGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog-appregistry/list-associated-attribute-groups.html)」を参照してください。 ### `list-attribute-groups-for-application` 次のコード例は、`list-attribute-groups-for-application` を使用する方法を示しています。 **AWS CLI** **アプリケーションの属性グループを一覧表示するには** 次の `list-attribute-groups-for-application` の例では、AWS アカウント内の特定のアプリケーションに関連付けられている AWS アカウント内のすべての属性グループの詳細を一覧表示します。 ``` aws servicecatalog-appregistry list-attribute-groups-for-application \ --application "ExampleApplication" ``` 出力: ``` { "attributeGroupsDetails": [ { "id": "01sj5xdwhbw54kejwnt09fnpcl", "arn": "arn:aws:servicecatalog:us-west-2:813737243517:/attribute-groups/01sj5xdwhbw54kejwnt09fnpcl", "name": "ExampleAttributeGroup" } ] } ``` 詳細については、「*AWS Service Catalog AppRegistry 管理者ガイド*」の「[Viewing attribute group details](https://servicecatalog/latest/arguide/view-attr-group.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAttributeGroupsForApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog-appregistry/list-attribute-groups-for-application.html)」を参照してください。 ### `list-attribute-groups` 次のコード例は、`list-attribute-groups` を使用する方法を示しています。 **AWS CLI** **属性グループを一覧表示するには** 次の `list-attribute-groups` の例では、AWS アカウント内のすべての属性グループのリストを取得します。 ``` aws servicecatalog-appregistry list-attribute-groups ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS Service Catalog AppRegistry 管理者ガイド*」の「[Viewing attribute group details](https://docs.aws.amazon.com/servicecatalog/latest/arguide/view-attr-group.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAttributeGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog-appregistry/list-attribute-groups.html)」を参照してください。 ### `update-application` 次のコード例は、`update-application` を使用する方法を示しています。 **AWS CLI** **アプリケーションを更新するには** 次の `update-application` の例では、AWS アカウント内の特定のアプリケーションを更新して説明を含めるようにします。 ``` aws servicecatalog-appregistry update-application \ --application "ExampleApplication" \ --description "This is an example application" ``` 出力: ``` { "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" } } } ``` 詳細については、「*AWS Service Catalog AppRegistry 管理者ガイド*」の「[Editing applications](https://docs.aws.amazon.com/servicecatalog/latest/arguide/edit-apps.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog-appregistry/update-application.html)」を参照してください。 ### `update-attribute-group` 次のコード例は、`update-attribute-group` を使用する方法を示しています。 **AWS CLI** **属性グループを更新するには** 次の `update-attribute-group` の例では、AWS アカウント内の特定の属性グループを更新して、説明を含めるようにします。 ``` aws servicecatalog-appregistry update-attribute-group \ --attribute-group "ExampleAttributeGroup" \ --description "This is an example attribute group" ``` 出力: ``` { "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" } } } ``` 詳細については、「*AWS Service Catalog AppRegistry 管理者ガイド*」の「[Editing attribute groups](https://docs.aws.amazon.com/servicecatalog/latest/arguide/edit-attr-group.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateAttributeGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicecatalog-appregistry/update-attribute-group.html)」を参照してください。 # AWS CLI を使用した Athena の例 次のコード例では、Athena で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `batch-get-named-query` 次の例では、`batch-get-named-query` を使用する方法を説明しています。 **AWS CLI** **複数のクエリに関する情報を返す方法** 次の `batch-get-named-query` 例では、指定された ID を持つ名前付きクエリに関する情報を返します。 ``` aws athena batch-get-named-query \ --named-query-ids a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 a1b2c3d4-5678-90ab-cdef-EXAMPLE33333 ``` 出力: ``` { "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": [] } ``` 詳細については、*Amazon Athena ユーザーガイド*の「[Amazon Athena を使用した SQL クエリの実行](https://docs.aws.amazon.com/athena/latest/ug/querying-athena-tables.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchGetNamedQuery](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/batch-get-named-query.html)」を参照してください。 ### `batch-get-query-execution` 次の例では、`batch-get-query-execution` を使用する方法を説明しています。 **AWS CLI** **複数のクエリ実行に関する情報を返す方法** 次の `batch-get-query-execution` の例では、指定されたクエリ ID を持つクエリのクエリ実行情報を返します。 ``` aws athena batch-get-query-execution \ --query-execution-ids a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 ``` 出力: ``` { "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": [] } ``` 詳細については、*Amazon Athena ユーザーガイド*の「[Amazon Athena を使用した SQL クエリの実行](https://docs.aws.amazon.com/athena/latest/ug/querying-athena-tables.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchGetQueryExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/batch-get-query-execution.html)」を参照してください。 ### `create-data-catalog` 次の例では、`create-data-catalog` を使用する方法を説明しています。 **AWS CLI** **データカタログを作成する方法** 次の `create-data-catalog` の例では、`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 ``` このコマンドでは何も出力されません。結果を表示するには、`aws athena get-data-catalog --name dynamo_db_catalog` を使用します。 詳細については、「*Amazon Athena ユーザーガイド*」の「[カタログの登録: create-data-catalog](https://docs.aws.amazon.com/athena/latest/ug/datastores-hive-cli.html#datastores-hive-cli-registering-a-catalog)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDataCatalog](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/create-data-catalog.html)」を参照してください。 ### `create-named-query` 次の例では、`create-named-query` を使用する方法を説明しています。 **AWS CLI** **名前付きクエリを作成する方法** 次の `create-named-query` の例では、2016 年 1 月にシアトルからニューヨークへのフライトについて、出発と到着の両方が 10 分以上遅れている `flights_parquet` のテーブルにクエリを実行する `AthenaAdmin` のワークグループに保存されたクエリを作成します。テーブル内の空港コード値は二重引用符 (例:「SEA」) を含む文字列であるため、バックスラッシュでエスケープされ、一重引用符で囲まれます。 ``` 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 ``` 出力: ``` { "NamedQueryId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } ``` 詳細については、*Amazon Athena ユーザーガイド*の「[Amazon Athena を使用した SQL クエリの実行](https://docs.aws.amazon.com/athena/latest/ug/querying-athena-tables.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドレットリファレンス*」の「[CreateNamedQuery](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/create-named-query.html)」を参照してください。 ### `create-work-group` 次の例では、`create-work-group` を使用する方法を説明しています。 **AWS CLI** **ワークグループを作成する方法** 次の `create-work-group` の例では、クエリ結果の出力場所「`s3://amzn-s3-demo-bucket`」を持つ「`Data_Analyst_Group`」というワークグループを作成します。コマンドは、クエリ結果の出力場所を含むクライアント構成を上書きするワークグループを作成します。また、このコマンドは CloudWatch メトリクスを有効にし、ワークグループに 3 つのキーと値のタグペアを追加して、他のワークグループと区別します。`--configuration` 引数には、オプションを区切るカンマの前にスペースがないことに注意してください。 ``` 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" ``` このコマンドでは何も出力されません。結果を表示するには、`aws athena get-work-group --work-group Data_Analyst_Group` を使用します。 詳細については、「*Amazon Athena ユーザーガイド*」の「[ワークグループの管理](https://docs.aws.amazon.com/athena/latest/ug/workgroups-create-update-delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateWorkGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/create-work-group.html)」を参照してください。 ### `delete-data-catalog` 次の例では、`delete-data-catalog` を使用する方法を説明しています。 **AWS CLI** **データカタログを削除する方法** 次の `delete-data-catalog` の例では、`UnusedDataCatalog` データカタログを削除します。 ``` aws athena delete-data-catalog \ --name UnusedDataCatalog ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Athena ユーザーガイド*」の「[カタログの削除: delete-data-catalog](https://docs.aws.amazon.com/athena/latest/ug/datastores-hive-cli.html#datastores-hive-cli-deleting-a-catalog)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDataCatalog](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/delete-data-catalog.html)」を参照してください。 ### `delete-named-query` 次の例では、`delete-named-query` を使用する方法を説明しています。 **AWS CLI** **名前付きクエリを削除する方法** 次の `delete-named-query` の例では、指定された ID を持つ名前付きクエリを削除します。 ``` aws athena delete-named-query \ --named-query-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` このコマンドでは何も出力されません。 詳細については、*Amazon Athena ユーザーガイド*の「[Amazon Athena を使用した SQL クエリの実行](https://docs.aws.amazon.com/athena/latest/ug/querying-athena-tables.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteNamedQuery](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/delete-named-query.html)」を参照してください。 ### `delete-work-group` 次の例では、`delete-work-group` を使用する方法を説明しています。 **AWS CLI** **ワークグループを削除する方法** 次の `delete-work-group` の例では、`TeamB` のワークグループを削除します。 ``` aws athena delete-work-group \ --work-group TeamB ``` このコマンドでは何も出力されません。削除を確認するには、`aws athena list-work-groups` を使用します。 詳細については、「*Amazon Athena ユーザーガイド*」の「[ワークグループの管理](https://docs.aws.amazon.com/athena/latest/ug/workgroups-create-update-delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteWorkGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/delete-work-group.html)」を参照してください。 ### `get-data-catalog` 次の例では、`get-data-catalog` を使用する方法を説明しています。 **AWS CLI** **データカタログに関する情報を返す方法** 次の `get-data-catalog` の例では、`dynamo_db_catalog` データカタログのデータベースに関する情報を返します。 ``` aws athena get-data-catalog \ --name dynamo_db_catalog ``` 出力: ``` { "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" } } } ``` 詳細については、「*Amazon Athena ユーザーガイド*」の「[カタログの詳細を表示: get-data-catalog](https://docs.aws.amazon.com/athena/latest/ug/datastores-hive-cli.html#datastores-hive-cli-showing-details-of-a-catalog)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDataCatalog](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/get-data-catalog.html)」を参照してください。 ### `get-database` 次の例では、`get-database` を使用する方法を説明しています。 **AWS CLI** **データカタログ内のデータベースに関する情報を返す方法** 次の `get-database` の例では、`AwsDataCatalog` データカタログの `sampledb` データベースに関する情報を返します。 ``` aws athena get-database \ --catalog-name AwsDataCatalog \ --database-name sampledb ``` 出力: ``` { "Database": { "Name": "sampledb", "Description": "Sample database", "Parameters": { "CreatedBy": "Athena", "EXTERNAL": "TRUE" } } } ``` 詳細については、「*Amazon Athena ユーザーガイド*」の「[データベースの詳細を表示: get-database](https://docs.aws.amazon.com/athena/latest/ug/datastores-hive-cli.html#datastores-hive-cli-showing-details-of-a-database)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDatabase](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/get-database.html)」を参照してください。 ### `get-named-query` 次の例では、`get-named-query` を使用する方法を説明しています。 **AWS CLI** **名前付きクエリを返す方法** 次の `get-named-query` 例では、指定された ID を持つクエリに関する情報を返します。 ``` aws athena get-named-query \ --named-query-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` 出力: ``` { "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" } } ``` 詳細については、*Amazon Athena ユーザーガイド*の「[Amazon Athena を使用した SQL クエリの実行](https://docs.aws.amazon.com/athena/latest/ug/querying-athena-tables.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetNamedQuery](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/get-named-query.html)」を参照してください。 ### `get-query-execution` 次の例では、`get-query-execution` を使用する方法を説明しています。 **AWS CLI** **クエリ実行に関する情報を返す方法** 次の `get-query-execution` の例では、指定されたクエリ ID が持つクエリに関する情報を返します。 ``` aws athena get-query-execution \ --query-execution-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` 出力: ``` { "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" } } ``` 詳細については、*Amazon Athena ユーザーガイド*の「[Amazon Athena を使用した SQL クエリの実行](https://docs.aws.amazon.com/athena/latest/ug/querying-athena-tables.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetQueryExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/get-query-execution.html)」を参照してください。 ### `get-query-results` 次の例では、`get-query-results` を使用する方法を説明しています。 **AWS CLI** **クエリの結果を返す方法** 次の `get-query-results` の例では、指定されたクエリ ID が持つクエリに関する結果を返します。 ``` aws athena get-query-results \ --query-execution-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` 出力: ``` { "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 } ``` 詳細については、「*Amazon Athena ユーザーガイド*」の「[クエリ結果、出力ファイル、クエリ履歴の使用](https://docs.aws.amazon.com/athena/latest/ug/querying.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetQueryResults](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/get-query-results.html)」を参照してください。 ### `get-table-metadata` 次の例では、`get-table-metadata` を使用する方法を説明しています。 **AWS CLI** **テーブルのメタデータ情報を返す方法** 次の `get-table-metadata` の例では、`AwsDataCatalog` データカタログの `sampledb` データベースから、列名とそのデータ型を含む `counties` テーブルに関するメタデータ情報を返します。 ``` aws athena get-table-metadata \ --catalog-name AwsDataCatalog \ --database-name sampledb \ --table-name counties ``` 出力: ``` { "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" } } } ``` 詳細については、「*Amazon Athena ユーザーガイド*」の「[テーブルの詳細を表示: get-table-metadata](https://docs.aws.amazon.com/athena/latest/ug/datastores-hive-cli.html#datastores-hive-cli-showing-details-of-a-table)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetTableMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/get-table-metadata.html)」を参照してください。 ### `get-work-group` 次の例では、`get-work-group` を使用する方法を説明しています。 **AWS CLI** **ワークグループに関する情報を返す方法** 次の `get-work-group` の例では、`AthenaAdmin` ワークグループに関する情報を返します。 ``` aws athena get-work-group \ --work-group AthenaAdmin ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon Athena ユーザーガイド*」の「[ワークグループの管理](https://docs.aws.amazon.com/athena/latest/ug/workgroups-create-update-delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetWorkGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/get-work-group.html)」を参照してください。 ### `list-data-catalogs` 次の例では、`list-data-catalogs` を使用する方法を説明しています。 **AWS CLI** **Athena に登録されているデータカタログを一覧表示する方法** 次の `list-data-catalogs` の例では、Athena に登録されているデータカタログを一覧表示します。 ``` aws athena list-data-catalogs ``` 出力: ``` { "DataCatalogsSummary": [ { "CatalogName": "AwsDataCatalog", "Type": "GLUE" }, { "CatalogName": "cw_logs_catalog", "Type": "LAMBDA" }, { "CatalogName": "cw_metrics_catalog", "Type": "LAMBDA" } ] } ``` 詳細については、「*Amazon Athena ユーザーガイド*」の「[カタログの登録を一覧表示: list-data-catalogs](https://docs.aws.amazon.com/athena/latest/ug/datastores-hive-cli.html#datastores-hive-cli-listing-registered-catalogs)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDataCatalogs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/list-data-catalogs.html)」を参照してください。 ### `list-databases` 次の例では、`list-databases` を使用する方法を説明しています。 **AWS CLI** **データカタログ内のデータベースを一覧表示する方法** 次の `list-databases` の例では、`AwsDataCatalog` データカタログのデータベースを一覧表示します。 ``` aws athena list-databases \ --catalog-name AwsDataCatalog ``` 出力: ``` { "DatabaseList": [ { "Name": "default" }, { "Name": "mydatabase" }, { "Name": "newdb" }, { "Name": "sampledb", "Description": "Sample database", "Parameters": { "CreatedBy": "Athena", "EXTERNAL": "TRUE" } }, { "Name": "webdata" } ] } ``` 詳細については、「*Amazon Athena ユーザーガイド*」の「[カタログのデータベースを一覧表示: list-databases](https://docs.aws.amazon.com/athena/latest/ug/datastores-hive-cli.html#datastores-hive-cli-listing-databases)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDatabases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/list-databases.html)」を参照してください。 ### `list-named-queries` 次の例では、`list-named-queries` を使用する方法を説明しています。 **AWS CLI** **ワークグループの名前付きクエリを一覧表示する方法** 次の `list-named-queries` 例では、`AthenaAdmin` ワークグループの名前付きクエリを一覧表示します。 ``` aws athena list-named-queries \ --work-group AthenaAdmin ``` 出力: ``` { "NamedQueryIds": [ "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333" ] } ``` 詳細については、*Amazon Athena ユーザーガイド*の「[Amazon Athena を使用した SQL クエリの実行](https://docs.aws.amazon.com/athena/latest/ug/querying-athena-tables.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListNamedQueries](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/list-named-queries.html)」を参照してください。 ### `list-query-executions` 次の例では、`list-query-executions` を使用する方法を説明しています。 **AWS CLI** **指定されたワークグループ内のクエリのクエリ ID を一覧表示する方法** 次の `list-query-executions` の例では、`AthenaAdmin` ワークグループ内のクエリ ID を最大 10 個まで一覧表示します。 ``` aws athena list-query-executions \ --work-group AthenaAdmin \ --max-items 10 ``` 出力: ``` { "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=" } ``` 詳細については、「*Amazon Athena ユーザーガイド*」の「[クエリ結果、出力ファイル、クエリ履歴の使用](https://docs.aws.amazon.com/athena/latest/ug/querying.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[ListQueryExecutions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/list-query-executions.html)」を参照してください。 ### `list-table-metadata` 次の例では、`list-table-metadata` を使用する方法を説明しています。 **AWS CLI** **データカタログの指定されたデータベース内のテーブルのメタデータを一覧表示する方法** 次の `list-table-metadata` の例では、`AwsDataCatalog` データカタログの `geography` データベース内の最大 2 つのテーブルのメタデータ情報を返します。 ``` aws athena list-table-metadata \ --catalog-name AwsDataCatalog \ --database-name geography \ --max-items 2 ``` 出力: ``` { "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==" } ``` 詳細については、「*Amazon Athena ユーザーガイド*」の「[データベース内のすべてのテーブルのメタデータを表示: list-table-metadata](https://docs.aws.amazon.com/athena/latest/ug/datastores-hive-cli.html#datastores-hive-cli-showing-all-table-metadata)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTableMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/list-table-metadata.html)」を参照してください。 ### `list-tags-for-resource` 次の例では、`list-tags-for-resource` を使用する方法を説明しています。 **AWS CLI** **例 1: ワークグループのタグを一覧表示する方法** 次の `list-tags-for-resource` の例では、`Data_Analyst_Group` ワークグループのタグを一覧表示します。 ``` aws athena list-tags-for-resource \ --resource-arn arn:aws:athena:us-west-2:111122223333:workgroup/Data_Analyst_Group ``` 出力: ``` { "Tags": [ { "Key": "Division", "Value": "West" }, { "Key": "Team", "Value": "Big Data" }, { "Key": "Location", "Value": "Seattle" } ] } ``` **例 2: データカタログのタグを一覧表示する方法** 次の `list-tags-for-resource` の例では、`dynamo_db_catalog` データカタログのタグを一覧表示します。 ``` aws athena list-tags-for-resource \ --resource-arn arn:aws:athena:us-west-2:111122223333:datacatalog/dynamo_db_catalog ``` 出力: ``` { "Tags": [ { "Key": "Division", "Value": "Mountain" }, { "Key": "Organization", "Value": "Retail" }, { "Key": "Product_Line", "Value": "Shoes" }, { "Key": "Location", "Value": "Denver" } ] } ``` 詳細については、「*Amazon Athena ユーザーガイド*」の「[リソースのタグを一覧表示: list-tags-for-resource](https://docs.aws.amazon.com/athena/latest/ug/tags-operations.html#tags-operations-examples-cli-list-tags-for-resource)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/list-tags-for-resource.html)」を参照してください。 ### `list-work-groups` 次の例では、`list-work-groups` を使用する方法を説明しています。 **AWS CLI** **ワークグループを一覧表示** 次の `list-work-groups` の例では、現在のアカウントのワークグループを一覧表示します。 ``` aws athena list-work-groups ``` 出力: ``` { "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 } ] } ``` 詳細については、「*Amazon Athena ユーザーガイド*」の「[ワークグループの管理](https://docs.aws.amazon.com/athena/latest/ug/workgroups-create-update-delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListWorkGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/list-work-groups.html)」を参照してください。 ### `start-query-execution` 次の例では、`start-query-execution` を使用する方法を説明しています。 **AWS CLI** **例 1: 指定されたデータベースとデータカタログ内の指定されたテーブルでワークグループでクエリを実行する方法** 次の `start-query-execution` の例では、`AthenaAdmin` ワークグループを使用して、`AwsDataCatalog`データカタログの `cflogsdatabase` の `cloudfront_logs` テーブルでクエリを実行します。 ``` 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 ``` 出力: ``` { "QueryExecutionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } ``` 詳細については、*Amazon Athena ユーザーガイド*の「[Amazon Athena を使用した SQL クエリの実行](https://docs.aws.amazon.com/athena/latest/ug/querying-athena-tables.html)」を参照してください。 **例 2: 指定されたワークグループを使用して、指定されたデータカタログにデータベースを作成するクエリを実行する方法** 次の `start-query-execution` の例では、`AthenaAdmin` ワークグループを使用して、デフォルトのデータカタログ `AwsDataCatalog` にデータベース `newdb` を作成します。 ``` aws athena start-query-execution \ --query-string "create database if not exists newdb" \ --work-group "AthenaAdmin" ``` 出力: ``` { "QueryExecutionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11112" } ``` 詳細については、*Amazon Athena ユーザーガイド*の「[Amazon Athena を使用した SQL クエリの実行](https://docs.aws.amazon.com/athena/latest/ug/querying-athena-tables.html)」を参照してください。 **例 3: 指定されたデータベースとデータカタログのテーブルにビューを作成するクエリを実行する方法** 次の `start-query-execution` の例では、`cflogsdatabase` の `cloudfront_logs` テーブルに `SELECT` ステートメントを使用してビュー `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 ``` 出力: ``` { "QueryExecutionId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11113" } ``` 詳細については、*Amazon Athena ユーザーガイド*の「[Amazon Athena を使用した SQL クエリの実行](https://docs.aws.amazon.com/athena/latest/ug/querying-athena-tables.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartQueryExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/start-query-execution.html)」を参照してください。 ### `stop-query-execution` 次の例では、`stop-query-execution` を使用する方法を説明しています。 **AWS CLI** **実行中のクエリを停止する方法** 次の `stop-query-execution` の例では、指定されたクエリ ID を持つクエリを停止します。 ``` aws athena stop-query-execution \ --query-execution-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` このコマンドでは何も出力されません。 詳細については、*Amazon Athena ユーザーガイド*の「[Amazon Athena を使用した SQL クエリの実行](https://docs.aws.amazon.com/athena/latest/ug/querying-athena-tables.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopQueryExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/stop-query-execution.html)」を参照してください。 ### `tag-resource` 次の例では、`tag-resource` を使用する方法を説明しています。 **AWS CLI** **リソースにタグを追加する** 次の `tag-resource` の例では、`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 ``` このコマンドでは何も出力されません。結果を表示するには、`aws athena list-tags-for-resource --resource-arn arn:aws:athena:us-west-2:111122223333:datacatalog/dynamo_db_catalog` を使用します。 詳細については、「*Amazon Athena ユーザーガイド*」の「[リソースにタグを追加: tag-resource](https://docs.aws.amazon.com/athena/latest/ug/tags-operations.html#tags-operations-examples-cli-tag-resource)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/tag-resource.html)」を参照してください。 ### `untag-resource` 次の例では、`untag-resource` を使用する方法を説明しています。 **AWS CLI** **リソースからタグを削除する方法** 次の `untag-resource` の例では、`dynamo_db_catalog` データカタログリソースから `Specialization` および `Focus` キーと、関連する値を削除します。 ``` aws athena untag-resource \ --resource-arn arn:aws:athena:us-west-2:111122223333:datacatalog/dynamo_db_catalog \ --tag-keys Specialization Focus ``` このコマンドでは何も出力されません。`list-tags-for-resource` コマンドを使用して結果を表示します。 詳細については、「*Amazon Athena ユーザーガイド*」の「[リソースからタグを削除: untag-resource](https://docs.aws.amazon.com/athena/latest/ug/tags-operations.html#tags-operations-examples-cli-untag-resource)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/untag-resource.html)」を参照してください。 ### `update-data-catalog` 次の例では、`update-data-catalog` を使用する方法を説明しています。 **AWS CLI** **データカタログを更新する方法** 次の `update-data-catalog` の例では、Lambda 関数と `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 ``` このコマンドでは何も出力されません。結果を表示するには、`aws athena get-data-catalog --name cw_logs_catalog` を使用します。 詳細については、「*Amazon Athena ユーザーガイド*」の「[カタログを更新: update-data-catalog](https://docs.aws.amazon.com/athena/latest/ug/datastores-hive-cli.html#datastores-hive-cli-updating-a-catalog)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateDataCatalog](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/update-data-catalog.html)」を参照してください。 ### `update-work-group` 次の例では、`update-work-group` を使用する方法を説明しています。 **AWS CLI** **ワークグループを更新する方法** 次の `update-work-group` 例では、`Data_Analyst_Group` ワークグループを無効にします。ユーザーは無効なワークグループでクエリを実行または作成できませんが、メトリクス、データ使用量制限コントロール、ワークグループ設定、クエリ履歴、保存されたクエリを表示することはできます。 ``` aws athena update-work-group \ --work-group Data_Analyst_Group \ --state DISABLED ``` このコマンドでは何も出力されません。状態の変化を確認するには、 `aws athena get-work-group --work-group Data_Analyst_Group` を使用して出力の `State` プロパティを確認します。 詳細については、「*Amazon Athena ユーザーガイド*」の「[ワークグループの管理](https://docs.aws.amazon.com/athena/latest/ug/workgroups-create-update-delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateWorkGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/athena/update-work-group.html)」を参照してください。 # AWS CLI を使用した自動スケーリングの例 次のコード例では、Auto Scaling で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `attach-instances` 次のコード例では、`attach-instances` を使用する方法を示しています。 **AWS CLI** **Auto Scaling グループにインスタンスをアタッチする方法** この例では、指定されたインスタンスを、指定された Auto Scaling グループにアタッチします。 ``` aws autoscaling attach-instances \ --instance-ids i-061c63c5eb45f0416 \ --auto-scaling-group-name my-asg ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AttachInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/attach-instances.html)」を参照してください。 ### `attach-load-balancer-target-groups` 次のコード例では、`attach-load-balancer-target-groups` を使用する方法を示しています。 **AWS CLI** **ターゲットグループを Auto Scaling グループにアタッチする方法** この例では、指定されたターゲットグループを、指定された Auto Scaling グループにアタッチします。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「Amazon EC2 Auto Scaling ユーザーガイド」の「[Elastic Load Balancing を使用して Auto Scaling グループ内のインスタンス全体にトラフィックを分散させる](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AttachLoadBalancerTargetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/attach-load-balancer-target-groups.html)」を参照してください。 ### `attach-load-balancers` 次のコード例では、`attach-load-balancers` を使用する方法を示しています。 **AWS CLI** **Auto Scaling グループに Classic Load Balancer をアタッチする方法** この例では、指定された Classic Load Balancer を、指定された Auto Scaling グループにアタッチします。 ``` aws autoscaling attach-load-balancers \ --load-balancer-names my-load-balancer \ --auto-scaling-group-name my-asg ``` このコマンドでは何も出力されません。 詳細については、「Amazon EC2 Auto Scaling ユーザーガイド」の「[Elastic Load Balancing を使用して Auto Scaling グループ内のインスタンス全体にトラフィックを分散させる](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AttachLoadBalancers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/attach-load-balancers.html)」を参照してください。 ### `cancel-instance-refresh` 次のコード例では、`cancel-instance-refresh` を使用する方法を示しています。 **AWS CLI** **インスタンスの更新をキャンセルする方法** 次の `cancel-instance-refresh` 例のは、指定された Auto Scaling グループの進行中のインスタンスの更新をキャンセルします。 ``` aws autoscaling cancel-instance-refresh \ --auto-scaling-group-name my-asg ``` 出力: ``` { "InstanceRefreshId": "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b" } ``` 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の[インスタンスの更新のキャンセル](https://docs.aws.amazon.com/autoscaling/ec2/userguide/cancel-instance-refresh.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelInstanceRefresh](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/cancel-instance-refresh.html)」を参照してください。 ### `complete-lifecycle-action` 次のコード例では、`complete-lifecycle-action` を使用する方法を示しています。 **AWS CLI** **ライフサイクルアクションを完了する方法** この例では、インスタンスの起動または終了を完了できるように、指定されたライフサイクルアクションが完了したことを Amazon EC2 Auto Scaling に通知します。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、*Amazon EC2 Auto Scaling ユーザーガイド*の「[Amazon EC2 Auto Scaling ライフサイクルフック](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CompleteLifecycleAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/complete-lifecycle-action.html)」を参照してください。 ### `create-auto-scaling-group` 次のコード例では、`create-auto-scaling-group` を使用する方法を示しています。 **AWS CLI** **例 1: Auto Scaling グループを作成する方法** 次の `create-auto-scaling-group` の例では、リージョン内の複数のアベイラビリティーゾーンのサブネット内に Auto Scaling グループを作成します。インスタンスは、指定された起動テンプレートのデフォルトバージョンで起動されます。終了ポリシーやヘルスチェック構成など、他のほとんどの構成にはデフォルトが使用されることに注意してください。 ``` 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" ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Auto Scaling groups](https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html)」を参照してください。 **例 2: Application Load Balancer、Network Load Balancer、または Gateway Load Balancer をアタッチする方法** この例では、予想されるトラフィックをサポートするロードバランサーのターゲットグループの ARN を指定します。ヘルスチェックタイプは、Elastic Load Balancing がインスタンスを異常として報告したときに、Auto Scaling グループがそのインスタンスを置き換えるよう `ELB` を指定します。このコマンドは、ヘルスチェックの猶予期間 (`600` 秒) も定義します。猶予期間は、新しく起動したインスタンスが早期に終了するのを防ぐのに役立ちます。 ``` 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" ``` このコマンドでは何も出力されません。 詳細については、「Amazon EC2 Auto Scaling ユーザーガイド」の「[Elastic Load Balancing を使用して Auto Scaling グループ内のインスタンス全体にトラフィックを分散させる](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html)」を参照してください。** **例 3: プレイスメントグループを指定し、起動テンプレートの最新バージョンを使用する方法** この例では、単一のアベイラビリティーゾーン内のプレイスメントグループ内でインスタンスを起動します。これは、HPC ワークロードを使用する低レイテンシーのグループに役立ちます。この例では、グループの最小サイズ、最大サイズ、希望する容量も指定しています。 ``` 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" ``` このコマンドでは何も出力されません。 詳細については、「*Linux インスタンス用 Amazon EC2 ユーザーガイド*」の「[プレイスメントグループ](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html)」を参照してください。 **例 4: 単一のインスタンスの Auto Scaling グループを指定し、特定のバージョンの起動テンプレートを使用する方法** この例では、単一のインスタンスが強制的に実行されるように、最小容量と最大容量を `1` に設定した Auto Scaling グループを作成します。このコマンドは、既存の ENI の ID が指定されている起動テンプレートの v1 も指定します。eth0 の既存の ENI を指定する起動テンプレートを使用する際は、リクエストにサブネット ID を指定せずに、ネットワークインターフェイスと一致する Auto Scaling グループのアベイラビリティーゾーンを指定する必要があります。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Auto Scaling groups](https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html)」を参照してください。 **例 5: 別の終了ポリシーを指定する方法** この例では、起動構成を使用して Auto Scaling グループを作成し、最も古いインスタンスを最初に終了するように終了ポリシーを構成します。またこのコマンドは、`Role` キーと `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" ``` このコマンドでは何も出力されません。 詳細については、「Amazon EC2 Auto Scaling ユーザーガイド」の「[Amazon EC2 Auto Scaling 終了ポリシーを使用する](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html)」を参照してください。** **例 6: 起動ライフサイクルフックを指定する方法** この例では、インスタンス起動時のカスタムアクションをサポートするライフサイクルフックで Auto Scaling グループを設定します。 ``` aws autoscaling create-auto-scaling-group \ --cli-input-json file://~/config.json ``` `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" }] } ``` このコマンドでは何も出力されません。 詳細については、*Amazon EC2 Auto Scaling ユーザーガイド*の「[Amazon EC2 Auto Scaling ライフサイクルフック](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html)」を参照してください。 **例 7: 終了ライフサイクルフックを指定する方法** 次の例では、インスタンス終了時のカスタムアクションをサポートするライフサイクルフックで Auto Scaling グループを設定します。 ``` aws autoscaling create-auto-scaling-group \ --cli-input-json file://~/config.json ``` `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" } ``` このコマンドでは何も出力されません。 詳細については、*Amazon EC2 Auto Scaling ユーザーガイド*の「[Amazon EC2 Auto Scaling ライフサイクルフック](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html)」を参照してください。 **例 8: カスタム終了ポリシーを指定する方法** この例では、スケールイン時にどのインスタンスを安全に終了できるかを Amazon EC2 Auto Scaling に指示するカスタム Lambda 関数終了ポリシーを指定する Auto Scaling グループを作成します。 ``` 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" ``` このコマンドでは何も出力されません。 詳細については、「Amazon EC2 Auto Scaling ユーザーガイド」の「[Lambda を使用したカスタム終了ポリシーを作成する](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lambda-custom-termination-policy.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス」の「[CreateAutoScalingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/create-auto-scaling-group.html)」を参照してください。* ### `create-launch-configuration` 次のコード例では、`create-launch-configuration` を使用する方法を示しています。 **AWS CLI** **例 1: 起動構成を作成する方法** この例では、シンプルな起動構成を作成します。 ``` aws autoscaling create-launch-configuration \ --launch-configuration-name my-lc \ --image-id ami-04d5cc9b88example \ --instance-type m5.large ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[起動構成の作成](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html)」を参照してください。 **例 2: セキュリティグループ、キーペア、ブートストラッピングスクリプトを使用して起動構成を作成する方法** この例では、セキュリティグループ、キーペア、ユーザーデータに含まれるブートストラッピングスクリプトを使用して起動構成を作成します。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[起動構成の作成](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html)」を参照してください。 **例 3: IAM ロールを使用して起動構成を作成する方法** この例では、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 ``` このコマンドでは何も出力されません。 詳細については、*Amazon EC2 Auto Scaling ユーザーガイド*の「[Amazon EC2 インスタンスで実行されるアプリケーションに対する IAM ロール](https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html)」を参照してください。 **例 4: 起動構成で詳細モニタリングを有効にする方法** この例では、EC2 詳細モニタリングを有効にして起動構成を作成し、EC2 メトリクスを 1 分間隔で CloudWatch に送信します。 ``` aws autoscaling create-launch-configuration \ --launch-configuration-name my-lc \ --image-id ami-04d5cc9b88example \ --instance-type m5.large \ --instance-monitoring Enabled=true ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Auto Scaling インスタンスのモニタリング設定](https://docs.aws.amazon.com/autoscaling/ec2/userguide/enable-as-instance-metrics.html)」をご参照ください。 **例 5: スポットインスタンスを起動する起動構成を作成する方法** この例では、スポットインスタンスを唯一の購入オプションとして使用する起動構成を作成します。 ``` aws autoscaling create-launch-configuration \ --launch-configuration-name my-lc \ --image-id ami-04d5cc9b88example \ --instance-type m5.large \ --spot-price "0.50" ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[スポットインスタンスのリクエスト](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-launch-spot-instances.html)」を参照してください。 **例 6: EC2 インスタンスを使用した起動構成を作成する方法** この例では、既存のインスタンスの属性に基づいて起動構成を作成します。これにより、プレイスメントテナンシーと、`--placement-tenancy` オプションと `--no-associate-public-ip-address`オプションを含めることでパブリック IP アドレスが設定されるかどうかが上書きされます。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[EC2 インスタンスを使用して起動構成を作成する](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-lc-with-instanceID.html)」を参照してください。 **例 7: Amazon EBS ボリュームのブロックデバイスマッピングを使用して起動構成を作成する方法** この例では、デバイス名「`/dev/sdh`」とボリュームサイズが 20 の Amazon EBS `gp3` ボリュームのブロックデバイスマッピングを使用して起動構成を作成します。 ``` 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"}}]' ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 Auto Scaling API リファレンス*」の「[EBS](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_Ebs.html)」を参照してください。 JSON 形式のパラメータ値で引用符を囲む構文については、「*AWS Command Line Interface ユーザーガイド*」の「[AWS CLI で文字列に引用符とリテラルを使用する](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html)」を参照してください。 **例 8: インスタンスストアボリュームのブロックデバイスマッピングを使用して起動構成を作成する方法** この例では、デバイス名「`/dev/sdc`」のインスタンスストアボリュームとして `ephemeral1` で起動構成を作成します。 ``` 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"}]' ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 Auto Scaling API リファレンス*」の「[BlockDeviceMapping](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_BlockDeviceMapping.html)」を参照してください。 JSON 形式のパラメータ値で引用符を囲む構文については、「*AWS Command Line Interface ユーザーガイド*」の「[AWS CLI で文字列に引用符とリテラルを使用する](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html)」を参照してください。 **例 9: 起動構成を作成し、起動時にブロックデバイスがアタッチされないようにする方法** この例では、AMI のブロックデバイスマッピング（`/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":""}]' ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 Auto Scaling API リファレンス*」の「[BlockDeviceMapping](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_BlockDeviceMapping.html)」を参照してください。 JSON 形式のパラメータ値で引用符を囲む構文については、「*AWS Command Line Interface ユーザーガイド*」の「[AWS CLI で文字列に引用符とリテラルを使用する](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[CreateLaunchConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/create-launch-configuration.html)」を参照してください。 ### `create-or-update-tags` 次のコード例では、`create-or-update-tags` を使用する方法を示しています。 **AWS CLI** **Auto Scaling グループのタグを作成または変更する方法** この例では、指定された Auto Scaling グループに 2 つのタグを追加します。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Auto Scaling グループとインスタンスのタグ付け](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateOrUpdateTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/create-or-update-tags.html)」を参照してください。 ### `delete-auto-scaling-group` 次のコード例では、`delete-auto-scaling-group` を使用する方法を示しています。 **AWS CLI** **例 1: 指定された Auto Scaling グループを削除する方法** この例では、指定された Auto Scaling グループを削除します。 ``` aws autoscaling delete-auto-scaling-group \ --auto-scaling-group-name my-asg ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Auto Scaling インフラストラクチャを削除する](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-process-shutdown.html)」を参照してください。 **例 2: 指定された Auto Scaling グループを強制的に削除する方法** グループ内のインスタンスが終了するのを待たずに Auto Scaling グループを削除するには、`--force-delete` オプションを使用します。 ``` aws autoscaling delete-auto-scaling-group \ --auto-scaling-group-name my-asg \ --force-delete ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Auto Scaling インフラストラクチャを削除する](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-process-shutdown.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAutoScalingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/delete-auto-scaling-group.html)」を参照してください。 ### `delete-launch-configuration` 次のコード例では、`delete-launch-configuration` を使用する方法を示しています。 **AWS CLI** **起動構成を削除する方法** この例では、指定された起動構成を削除します。 ``` aws autoscaling delete-launch-configuration \ --launch-configuration-name my-launch-config ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Auto Scaling インフラストラクチャを削除する](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-process-shutdown.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteLaunchConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/delete-launch-configuration.html)」を参照してください。 ### `delete-lifecycle-hook` 次のコード例では、`delete-lifecycle-hook` を使用する方法を示しています。 **AWS CLI** **ライフサイクルフックを削除する方法** 指定されたライフサイクルフックを削除します。 ``` aws autoscaling delete-lifecycle-hook \ --lifecycle-hook-name my-lifecycle-hook \ --auto-scaling-group-name my-asg ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteLifecycleHook](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/delete-lifecycle-hook.html)」を参照してください。 ### `delete-notification-configuration` 次のコード例では、`delete-notification-configuration` を使用する方法を示しています。 **AWS CLI** **Auto Scaling 通知を削除する方法** この例では、指定された Auto Scaling グループから指定された通知を削除します。 ``` aws autoscaling delete-notification-configuration \ --auto-scaling-group-name my-asg \ --topic-arn arn:aws:sns:us-west-2:123456789012:my-sns-topic ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[通知設定を削除する](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html#delete-settingupnotifications)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteNotificationConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/delete-notification-configuration.html)」を参照してください。 ### `delete-policy` 次のコード例では、`delete-policy` を使用する方法を示しています。 **AWS CLI** **スケーリングポリシーを削除する方法** この例では、指定されたスケーリングポリシーを削除します。 ``` aws autoscaling delete-policy \ --auto-scaling-group-name my-asg \ --policy-name alb1000-target-tracking-scaling-policy ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeletePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/delete-policy.html)」を参照してください。 ### `delete-scheduled-action` 次のコード例では、`delete-scheduled-action` を使用する方法を示しています。 **AWS CLI** **Auto Scaling グループ用のスケジュール済みのアクションを削除する方法** この例では、指定された Auto Scaling グループから指定されたスケジュール済みの通知を削除します。 ``` aws autoscaling delete-scheduled-action \ --auto-scaling-group-name my-asg \ --scheduled-action-name my-scheduled-action ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteScheduledAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/delete-scheduled-action.html)」を参照してください。 ### `delete-tags` 次のコード例では、`delete-tags` を使用する方法を示しています。 **AWS CLI** **Auto Scaling グループからタグを削除する方法** この例では、指定された Auto Scaling グループから指定されたタグを削除します。 ``` aws autoscaling delete-tags \ --tags ResourceId=my-asg,ResourceType=auto-scaling-group,Key=Dept,Value=Research ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Auto Scaling グループとインスタンスのタグ付け](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/delete-tags.html)」を参照してください。 ### `delete-warm-pool` 次のコード例では、`delete-warm-pool` を使用する方法を示しています。 **AWS CLI** **例 1: ウォームプールを削除する方法** 次の例では、指定された Auto Scaling グループのウォームプールを削除します。 ``` aws autoscaling delete-warm-pool \ --auto-scaling-group-name my-asg ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Warm pools for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html)」を参照してください。 **例 2: ウォームプールを強制的に削除する方法** インスタンスが終了するのを待たずにウォームプールを削除するには、`--force-delete` オプションを使用します。 ``` aws autoscaling delete-warm-pool \ --auto-scaling-group-name my-asg \ --force-delete ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Warm pools for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteWarmPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/delete-warm-pool.html)」を参照してください。 ### `describe-account-limits` 次のコード例では、`describe-account-limits` を使用する方法を示しています。 **AWS CLI** **Amazon EC2 Auto Scaling アカウントの制限を記述する方法** この例では、AWS アカウントの Amazon EC2 Auto Scaling の制限について記述します。 ``` aws autoscaling describe-account-limits ``` 出力: ``` { "NumberOfLaunchConfigurations": 5, "MaxNumberOfLaunchConfigurations": 100, "NumberOfAutoScalingGroups": 3, "MaxNumberOfAutoScalingGroups": 20 } ``` 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Amazon EC2 Auto Scaling Service Quotas](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAccountLimits](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-account-limits.html)」を参照してください。 ### `describe-adjustment-types` 次のコード例では、`describe-adjustment-types` を使用する方法を示しています。 **AWS CLI** **使用可能なスケーリング調整タイプを記述する方法** この例では、使用可能な調整タイプについて記述します。 ``` aws autoscaling describe-adjustment-types ``` 出力: ``` { "AdjustmentTypes": [ { "AdjustmentType": "ChangeInCapacity" }, { "AdjustmentType": "ExactCapacity" }, { "AdjustmentType": "PercentChangeInCapacity" } ] } ``` 詳細については、*Amazon EC2 Auto Scaling ユーザーガイド*の「[スケーリング調整タイプ](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAdjustmentTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-adjustment-types.html)」を参照してください。 ### `describe-auto-scaling-groups` 次のコード例では、`describe-auto-scaling-groups` を使用する方法を示しています。 **AWS CLI** **例 1: 指定された Auto Scaling グループを記述する方法** この例では、指定された Auto Scaling グループを記述します。 ``` aws autoscaling describe-auto-scaling-groups \ --auto-scaling-group-names my-asg ``` 出力: ``` { "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": [] } ] } ``` **例 2: 指定された最初の 100 個の Auto Scaling グループを記述する方法** この例では、指定された複数の Auto Scaling グループを記述します。最大 100 個のグループ名を指定できます。 ``` aws autoscaling describe-auto-scaling-groups \ --max-items 100 \ --auto-scaling-group-names "group1" "group2" "group3" "group4" ``` 出力例については、例 1 を参照してください。 **例 3: 指定されたリージョンの Auto Scaling グループを記述する方法** この例では、指定されたリージョンの Auto Scaling グループを最大 75 グループまで記述します。 ``` aws autoscaling describe-auto-scaling-groups \ --max-items 75 \ --region us-east-1 ``` 出力例については、例 1 を参照してください。 **例 4: 指定された数の Auto Scaling グループを記述する方法** 特定の数の Auto Scaling グループを返すには、`--max-items` オプションを使用します。 ``` aws autoscaling describe-auto-scaling-groups \ --max-items 1 ``` 出力例については、例 1 を参照してください。 出力に `NextToken` フィールドが含まれている場合は、さらに多くのグループがあることを示しています。追加のグループを取得するには、次のように、以降の呼び出しで `--starting-token` オプションを使用してこのフィールドの値を使用します。 ``` aws autoscaling describe-auto-scaling-groups \ --starting-token Z3M3LMPEXAMPLE ``` 出力例については、例 1 を参照してください。 **例 5: 起動構成を使用している Auto Scaling グループを記述する方法** この例では、 `--query` オプションを使用して、起動構成を使用する Auto Scaling グループを記述します。 ``` aws autoscaling describe-auto-scaling-groups \ --query 'AutoScalingGroups[?LaunchConfigurationName!=`null`]' ``` 出力: ``` [ { "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": [] } ] ``` 詳細については、「*AWS コマンドラインインターフェイスユーザーガイド*」の「[AWS CLI 出力のフィルタリング](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*：の「[DescribeAutoScalingGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-auto-scaling-groups.html)」を参照してください。 ### `describe-auto-scaling-instances` 次のコード例では、`describe-auto-scaling-instances` を使用する方法を示しています。 **AWS CLI** **例 1: 1 つまたは複数のインスタンスを記述する方法** この例では、指定されたインスタンスを記述します。 ``` aws autoscaling describe-auto-scaling-instances \ --instance-ids i-06905f55584de02da ``` 出力: ``` { "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" } } ] } ``` **例 2: 1 つまたは複数のインスタンスを記述する方法** この例では、`--max-items` オプションを使用して、この呼び出しで返されるインスタンスの数を指定します。 ``` aws autoscaling describe-auto-scaling-instances \ --max-items 1 ``` 出力に `NextToken` フィールドが含まれている場合は、さらに多くのインスタンスがあることを示しています。追加のインスタンスを取得するには、次のように、以降の呼び出しで `--starting-token` オプションを使用してこのフィールドの値を使用します。 ``` aws autoscaling describe-auto-scaling-instances \ --starting-token Z3M3LMPEXAMPLE ``` 出力例については、例 1 を参照してください。 **例 3: 起動構成を使用するインスタンスを記述する方法** この例では、 `--query` オプションを使用して、起動構成を使用するインスタンスを記述します。 ``` aws autoscaling describe-auto-scaling-instances \ --query 'AutoScalingInstances[?LaunchConfigurationName!=`null`]' ``` 出力: ``` [ { "InstanceId": "i-088c57934a6449037", "InstanceType": "t2.micro", "AutoScalingGroupName": "my-asg", "AvailabilityZone": "us-west-2c", "LifecycleState": "InService", "HealthStatus": "HEALTHY", "LaunchConfigurationName": "my-lc", "ProtectedFromScaleIn": false } ] ``` 詳細については、「*AWS コマンドラインインターフェイスユーザーガイド*」の「[AWS CLI 出力のフィルタリング](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAutoScalingInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-auto-scaling-instances.html)」を参照してください。 ### `describe-auto-scaling-notification-types` 次のコード例では、`describe-auto-scaling-notification-types` を使用する方法を示しています。 **AWS CLI** **使用可能な通知タイプを記述する方法** この例では、使用可能な通知タイプについて記述します。 ``` aws autoscaling describe-auto-scaling-notification-types ``` 出力: ``` { "AutoScalingNotificationTypes": [ "autoscaling:EC2_INSTANCE_LAUNCH", "autoscaling:EC2_INSTANCE_LAUNCH_ERROR", "autoscaling:EC2_INSTANCE_TERMINATE", "autoscaling:EC2_INSTANCE_TERMINATE_ERROR", "autoscaling:TEST_NOTIFICATION" ] } ``` 詳細については、『*Amazon EC2 Auto Scaling ユーザーガイド*』の「[Auto Scaling グループのスケーリング時の Amazon SNS 通知の取得](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAutoScalingNotificationTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-auto-scaling-notification-types.html)」を参照してください。 ### `describe-instance-refreshes` 次のコード例では、`describe-instance-refreshes` を使用する方法を示しています。 **AWS CLI** **インスタンスの更新を記述する方法** 次の `describe-instance-refreshes` の例では、ステータスメッセージ (利用可能な場合) やステータス理由など、指定された Auto Scaling グループのすべてのインスタンス更新リクエストの記述を返します。 ``` aws autoscaling describe-instance-refreshes \ --auto-scaling-group-name my-asg ``` 出力: ``` { "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" } } ] } ``` 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[インスタンスの更新のステータスを確認](https://docs.aws.amazon.com/en_us/autoscaling/ec2/userguide/check-status-instance-refresh.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeInstanceRefreshes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-instance-refreshes.html)」を参照してください。 ### `describe-launch-configurations` 次のコード例では、`describe-launch-configurations` を使用する方法を示しています。 **AWS CLI** **例 1: 指定された起動構成を記述する方法** この例では、指定された起動構成について記述します。 ``` aws autoscaling describe-launch-configurations \ --launch-configuration-names my-launch-config ``` 出力: ``` { "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" } } ] } ``` **例 2: 指定された数の起動構成を記述する方法** 特定の数の起動構成を返すには、 `--max-items` オプションを使用します。 ``` aws autoscaling describe-launch-configurations \ --max-items 1 ``` 出力に `NextToken` フィールドが含まれている場合、起動構成がさらに増えます。追加の起動構成を取得するには、次のように、以降の呼び出しで `--starting-token` オプションを使用してこのフィールドの値を使用します。 ``` aws autoscaling describe-launch-configurations \ --starting-token Z3M3LMPEXAMPLE ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeLaunchConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-launch-configurations.html)」を参照してください。 ### `describe-lifecycle-hook-types` 次のコード例では、`describe-lifecycle-hook-types` を使用する方法を示しています。 **AWS CLI** **使用可能なライフサイクルフックのタイプを記述します** この例では、使用可能なライフサイクルフックのタイプを記述します。 ``` aws autoscaling describe-lifecycle-hook-types ``` 出力: ``` { "LifecycleHookTypes": [ "autoscaling:EC2_INSTANCE_LAUNCHING", "autoscaling:EC2_INSTANCE_TERMINATING" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeLifecycleHookTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-lifecycle-hook-types.html)」を参照してください。 ### `describe-lifecycle-hooks` 次のコード例では、`describe-lifecycle-hooks` を使用する方法を示しています。 **AWS CLI** **ライフサイクルフックを記述する方法** 指定された Auto Scaling グループのライフサイクルフックを記述します。 ``` aws autoscaling describe-lifecycle-hooks \ --auto-scaling-group-name my-asg ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeLifecycleHooks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-lifecycle-hooks.html)」を参照してください。 ### `describe-load-balancer-target-groups` 次のコード例では、`describe-load-balancer-target-groups` を使用する方法を示しています。 **AWS CLI** **Auto Scaling グループのロードバランサーターゲットグループを記述する方法** この例では、指定された Auto Scaling グループにアタッチされたロードバランサーターゲットグループを記述します。 ``` aws autoscaling describe-load-balancer-target-groups \ --auto-scaling-group-name my-asg ``` 出力: ``` { "LoadBalancerTargetGroups": [ { "LoadBalancerTargetGroupARN": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", "State": "Added" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeLoadBalancerTargetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-load-balancer-target-groups.html)」を参照してください。 ### `describe-load-balancers` 次のコード例では、`describe-load-balancers` を使用する方法を示しています。 **AWS CLI** **Auto Scaling グループのClassic Load Balancerを記述する方法** 指定された Auto Scaling グループの Classic Load Balancer を記述します。 ``` aws autoscaling describe-load-balancers \ --auto-scaling-group-name my-asg ``` 出力: ``` { "LoadBalancers": [ { "State": "Added", "LoadBalancerName": "my-load-balancer" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeLoadBalancers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-load-balancers.html)」を参照してください。 ### `describe-metric-collection-types` 次のコード例では、`describe-metric-collection-types` を使用する方法を示しています。 **AWS CLI** **使用可能なメトリクスコレクションタイプを記述する方法** この例では、使用可能なメトリクスコレクションタイプについて記述します。 ``` aws autoscaling describe-metric-collection-types ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Auto Scaling group metrics](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html#as-group-metrics)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeMetricCollectionTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-metric-collection-types.html)」を参照してください。 ### `describe-notification-configurations` 次のコード例では、`describe-notification-configurations` を使用する方法を示しています。 **AWS CLI** **例 1: 指定されたグループの通知構成を記述する方法** この例では、指定された Auto Scaling グループの通知構成を記述します。 ``` aws autoscaling describe-notification-configurations \ --auto-scaling-group-name my-asg ``` 出力: ``` { "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" } ] } ``` 詳細については、『*Amazon EC2 Auto Scaling ユーザーガイド*』の「[Auto Scaling グループのスケーリング時の Amazon SNS 通知の取得](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html)」を参照してください。 **例 1: 指定された数の通知構成を記述する方法** 特定の数の通知構成を返すには、 `max-items` パラメータを使用します。 ``` aws autoscaling describe-notification-configurations \ --auto-scaling-group-name my-auto-scaling-group \ --max-items 1 ``` 出力: ``` { "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" } ] } ``` 出力に `NextToken` フィールドが含まれている場合、通知構成がさらに増えます。追加の通知構成を取得するには、次のように、以降の呼び出しで `starting-token` オプションを使用してこのフィールドの値を使用します。 ``` aws autoscaling describe-notification-configurations \ --auto-scaling-group-name my-asg \ --starting-token Z3M3LMPEXAMPLE ``` 詳細については、『*Amazon EC2 Auto Scaling ユーザーガイド*』の「[Auto Scaling グループのスケーリング時の Amazon SNS 通知の取得](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeNotificationConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-notification-configurations.html)」を参照してください。 ### `describe-policies` 次のコード例では、`describe-policies` を使用する方法を示しています。 **AWS CLI** **例 1: 指定されたグループのスケーリングポリシーを記述する方法** この例では、指定された Auto Scaling グループのスケーリングポリシーを記述します。 ``` aws autoscaling describe-policies \ --auto-scaling-group-name my-asg ``` 出力: ``` { "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 } ] } ``` 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[ダイナミックスケーリング](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html)」を参照してください。 **例 2: 指定された名前のスケーリングポリシーを記述する方法** 特定のスケーリングポリシーを返すには、 `--policy-names` オプションを使用します。 ``` aws autoscaling describe-policies \ --auto-scaling-group-name my-asg \ --policy-names cpu40-target-tracking-scaling-policy ``` 出力例については、例 1 を参照してください。 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[ダイナミックスケーリング](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html)を参照してください。 **例 3: スケーリングポリシーの数を記述する方法** 特定の数のポリシーを返すには、`--max-items` オプションを使用します。 ``` aws autoscaling describe-policies \ --auto-scaling-group-name my-asg \ --max-items 1 ``` 出力例については、例 1 を参照してください。 出力に `NextToken` フィールドが含まれている場合は、後続の呼び出しで `--starting-token` オプションを使用してこのフィールドの値を使用し、追加のポリシーを取得します。 ``` aws autoscaling describe-policies --auto-scaling-group-name my-asg --starting-token Z3M3LMPEXAMPLE ``` 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[ダイナミックスケーリング](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html)を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribePolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-policies.html)」を参照してください。 ### `describe-scaling-activities` 次のコード例では、`describe-scaling-activities` を使用する方法を示しています。 **AWS CLI** **例 1: 指定されたグループのスケーリングアクティビティを記述する方法** この例では、指定された Auto Scaling グループのスケーリングアクティビティを記述します。 ``` aws autoscaling describe-scaling-activities \ --auto-scaling-group-name my-asg ``` 出力: ``` { "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\"}" } ] } ``` 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Verify a scaling activity for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-verify-scaling-activity.html)」を参照してください。 **例 2: 削除されたグループのスケーリングアクティビティを記述する方法** Auto Scaling グループが削除された後にスケーリングアクティビティを説明するには、`--include-deleted-groups` オプションを追加します。 ``` aws autoscaling describe-scaling-activities \ --auto-scaling-group-name my-asg \ --include-deleted-groups ``` 出力: ``` { "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" } ] } ``` 詳細については、「Amazon EC2 Auto Scaling ユーザーガイド」の「[Amazon EC2 Auto Scaling をトラブルシューティングする](https://docs.aws.amazon.com/autoscaling/ec2/userguide/CHAP_Troubleshooting.html)」を参照してください。** **例 3: 指定された数のスケーリングアクティビティを記述する方法** 特定の数のアクティビティを返すには、`--max-items` オプションを使用します。 ``` aws autoscaling describe-scaling-activities \ --max-items 1 ``` 出力: ``` { "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\"}" } ] } ``` 出力に `NextToken` フィールドが含まれている場合は、さらに多くのアクティビティがあることを示しています。追加のアクティビティを取得するには、次のように、以降の呼び出しで `--starting-token` オプションを使用してこのフィールドの値を使用します。 ``` aws autoscaling describe-scaling-activities \ --starting-token Z3M3LMPEXAMPLE ``` 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Verify a scaling activity for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-verify-scaling-activity.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeScalingActivities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-scaling-activities.html)」を参照してください。 ### `describe-scaling-process-types` 次のコード例では、`describe-scaling-process-types` を使用する方法を示しています。 **AWS CLI** **使用可能なプロセスタイプを記述する方法** この例では、使用可能なプロセスタイプを記述します。 ``` aws autoscaling describe-scaling-process-types ``` 出力: ``` { "Processes": [ { "ProcessName": "AZRebalance" }, { "ProcessName": "AddToLoadBalancer" }, { "ProcessName": "AlarmNotification" }, { "ProcessName": "HealthCheck" }, { "ProcessName": "InstanceRefresh" }, { "ProcessName": "Launch" }, { "ProcessName": "ReplaceUnhealthy" }, { "ProcessName": "ScheduledActions" }, { "ProcessName": "Terminate" } ] } ``` 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[スケーリングプロセスの中断と再開](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeScalingProcessTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-scaling-process-types.html)」を参照してください。 ### `describe-scheduled-actions` 次のコード例では、`describe-scheduled-actions` を使用する方法を示しています。 **AWS CLI** **例 1: スケジュール済みのすべてのアクションを記述する方法** この例では、スケジュール済みのすべてのアクションを記述します。 ``` aws autoscaling describe-scheduled-actions ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Scheduled scaling（スケジュールされたスケーリング）](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scheduled-scaling.html)」を参照してください。 **例 2: 指定されたグループのスケジュール済みのアクションを記述する方法** 特定の Auto Scaling グループのスケジュール済みのアクションを説明するには、 `--auto-scaling-group-name` オプションを使用します。 ``` aws autoscaling describe-scheduled-actions \ --auto-scaling-group-name my-asg ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Scheduled scaling（スケジュールされたスケーリング）](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scheduled-scaling.html)」を参照してください。 **例 3: 指定されたスケジュール済みのアクションを記述する方法** 特定のスケジュール済みのアクションを説明するには、`--scheduled-action-names` オプションを使用します。 ``` aws autoscaling describe-scheduled-actions \ --scheduled-action-names my-recurring-action ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Scheduled scaling（スケジュールされたスケーリング）](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scheduled-scaling.html)」を参照してください。 **例 4: 指定された開始時刻でスケジュール済みのアクションを記述する方法** 特定の時間に開始されるスケジュール済みのアクションを説明するには、`--start-time` オプションを使用します。 ``` aws autoscaling describe-scheduled-actions \ --start-time "2023-12-01T04:00:00Z" ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Scheduled scaling（スケジュールされたスケーリング）](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scheduled-scaling.html)」を参照してください。 **例 5: 指定された時間に終了するスケジュール済みのアクションを記述する方法** 特定の時間に終了するスケジュール済みのアクションを説明するには、`--end-time` オプションを使用します。 ``` aws autoscaling describe-scheduled-actions \ --end-time "2023-12-01T04:00:00Z" ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Scheduled scaling（スケジュールされたスケーリング）](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scheduled-scaling.html)」を参照してください。 **例 6: 指定された数のスケーリングアクティビティを記述する方法** 特定の数のアクティビティを返すには、`--max-items` オプションを使用します。 ``` aws autoscaling describe-scheduled-actions \ --auto-scaling-group-name my-asg \ --max-items 1 ``` 出力: ``` { "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" } ] } ``` 出力に `NextToken` フィールドが含まれている場合は、さらに多くのスケジュール済みのアクションがあることを示しています。追加のスケジュール済みのアクションを取得するには、次のように、以降の呼び出しで `--starting-token` オプションを使用してこのフィールドの値を使用します。 ``` aws autoscaling describe-scheduled-actions \ --auto-scaling-group-name my-asg \ --starting-token Z3M3LMPEXAMPLE ``` 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Scheduled scaling（スケジュールされたスケーリング）](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scheduled-scaling.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeScheduledActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-scheduled-actions.html)」を参照してください。 ### `describe-tags` 次のコード例では、`describe-tags` を使用する方法を示しています。 **AWS CLI** **すべてのタグを記述する方法** この例では、すべてのタグを記述します。 ``` aws autoscaling describe-tags ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Auto Scaling グループとインスタンスのタグ付け](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html)」を参照してください。 **例 2: 指定されたグループのタグを記述する方法** 特定の Auto Scaling グループのタグを説明するには、`--filters` オプションを使用します。 ``` aws autoscaling describe-tags --filters Name=auto-scaling-group,Values=my-asg ``` 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Auto Scaling グループとインスタンスのタグ付け](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html)」を参照してください。 **例 3: 指定された数のタグを記述する方法** 特定の数のタグを返すには、`--max-items` オプションを使用します。 ``` aws autoscaling describe-tags \ --max-items 1 ``` 出力に `NextToken` フィールドが含まれている場合は、さらに多くのタグがあることを示しています。追加のタグを取得するには、次のように、以降の呼び出しで `--starting-token` オプションを使用してこのフィールドの値を使用します。 ``` aws autoscaling describe-tags \ --filters Name=auto-scaling-group,Values=my-asg \ --starting-token Z3M3LMPEXAMPLE ``` 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Auto Scaling グループとインスタンスのタグ付け](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-tags.html)」を参照してください。 ### `describe-termination-policy-types` 次のコード例では、`describe-termination-policy-types` を使用する方法を示しています。 **AWS CLI** **使用可能な終了ポリシータイプを記述する方法** この例では、使用可能な終了ポリシータイプを記述します。 ``` aws autoscaling describe-termination-policy-types ``` 出力: ``` { "TerminationPolicyTypes": [ "AllocationStrategy", "ClosestToNextInstanceHour", "Default", "NewestInstance", "OldestInstance", "OldestLaunchConfiguration", "OldestLaunchTemplate" ] } ``` 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[スケールイン時にどの Auto Scaling インスタンスを終了するか設定する](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTerminationPolicyTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-termination-policy-types.html)」を参照してください。 ### `describe-warm-pool` 次のコード例では、`describe-warm-pool` を使用する方法を示しています。 **AWS CLI** **ウォームプールを記述する方法** この例では、指定された Auto Scaling グループのウォームプールを記述します。 ``` aws autoscaling describe-warm-pool \ --auto-scaling-group-name my-asg ``` 出力: ``` { "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" } } ] } ``` 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Warm pools for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeWarmPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/describe-warm-pool.html)」を参照してください。 ### `detach-instances` 次のコード例では、`detach-instances` を使用する方法を示しています。 **AWS CLI** **Auto Scaling グループからインスタンスをデタッチする方法** この例では、指定されたインスタンスを指定された Auto Scaling グループからデタッチします。 ``` aws autoscaling detach-instances \ --instance-ids i-030017cfa84b20135 \ --auto-scaling-group-name my-asg \ --should-decrement-desired-capacity ``` 出力: ``` { "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\"}" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DetachInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/detach-instances.html)」を参照してください。 ### `detach-load-balancer-target-groups` 次のコード例では、`detach-load-balancer-target-groups` を使用する方法を示しています。 **AWS CLI** **Auto Scaling グループからロードバランサーのターゲットグループをデタッチする方法** この例では、指定されたロードバランサーのターゲットグループを指定された Auto Scaling グループからデタッチします。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Auto Scaling グループへのロードバランサーのアタッチ](https://docs.aws.amazon.com/autoscaling/ec2/userguide/attach-load-balancer-asg.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DetachLoadBalancerTargetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/detach-load-balancer-target-groups.html)」を参照してください。 ### `detach-load-balancers` 次のコード例では、`detach-load-balancers` を使用する方法を示しています。 **AWS CLI** **Auto Scaling グループから Classic Load Balancer をデタッチする方法** この例では、指定された Classic Load Balancer を指定された Auto Scaling グループからデタッチします。 ``` aws autoscaling detach-load-balancers \ --load-balancer-names my-load-balancer \ --auto-scaling-group-name my-asg ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Auto Scaling グループへのロードバランサーのアタッチ](https://docs.aws.amazon.com/autoscaling/ec2/userguide/attach-load-balancer-asg.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DetachLoadBalancers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/detach-load-balancers.html)」を参照してください。 ### `disable-metrics-collection` 次のコード例では、`disable-metrics-collection` を使用する方法を示しています。 **AWS CLI** **Auto Scaling グループのメトリクス収集を無効にする方法** この例では、指定された Auto Scaling グループの `GroupDesiredCapacity` メトリクスの収集を無効にします。 ``` aws autoscaling disable-metrics-collection \ --auto-scaling-group-name my-asg \ --metrics GroupDesiredCapacity ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Auto Scaling グループとインスタンスの CloudWatch メトリクスのモニタリング](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html)」をご参照ください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisableMetricsCollection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/disable-metrics-collection.html)」を参照してください。 ### `enable-metrics-collection` 次のコード例では、`enable-metrics-collection` を使用する方法を示しています。 **AWS CLI** **例 1: Auto Scaling グループのメトリクス収集を有効にする方法** この例では、指定された Auto Scaling グループのデータの収集を有効にします。 ``` aws autoscaling enable-metrics-collection \ --auto-scaling-group-name my-asg \ --granularity "1Minute" ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Auto Scaling グループとインスタンスの CloudWatch メトリクスのモニタリング](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html)」をご参照ください。 **例 2: Auto Scaling グループの指定されたメトリックスのデータを収集する方法** 特定のメトリックスのデータを収集するには、`--metrics` オプションを使用します。 ``` aws autoscaling enable-metrics-collection \ --auto-scaling-group-name my-asg \ --metrics GroupDesiredCapacity --granularity "1Minute" ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Auto Scaling グループとインスタンスの CloudWatch メトリクスのモニタリング](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html)」をご参照ください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EnableMetricsCollection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/enable-metrics-collection.html)」を参照してください。 ### `enter-standby` 次のコード例では、`enter-standby` を使用する方法を示しています。 **AWS CLI** **インスタンスをスタンバイモードに移行する方法** この例では、指定されたインスタンスをスタンバイモードにします。これは、現在稼働中のインスタンスの更新またはトラブルシューティングに役立ちます。 ``` aws autoscaling enter-standby \ --instance-ids i-061c63c5eb45f0416 \ --auto-scaling-group-name my-asg \ --should-decrement-desired-capacity ``` 出力: ``` { "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\"}" } ] } ``` 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Amazon EC2 Auto Scaling インスタンスのライフサイクル](https://docs.aws.amazon.com/autoscaling/ec2/userguide/detach-instance-asg.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EnterStandby](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/enter-standby.html)」を参照してください。 ### `execute-policy` 次のコード例では、`execute-policy` を使用する方法を示しています。 **AWS CLI** **スケーリングポリシーを実行する方法** この例では、指定された Auto Scaling グループに「`my-step-scale-out-policy`」という名前のスケーリングポリシーを実行します。 ``` aws autoscaling execute-policy \ --auto-scaling-group-name my-asg \ --policy-name my-step-scale-out-policy \ --metric-value 95 \ --breach-threshold 80 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[ステップとシンプルなスケーリングポリシー](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ExecutePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/execute-policy.html)」を参照してください。 ### `exit-standby` 次のコード例では、`exit-standby` を使用する方法を示しています。 **AWS CLI** **インスタンスをスタンバイモードから移動する方法** 指定されたインスタンスのスタンバイモードを解除します。 ``` aws autoscaling exit-standby \ --instance-ids i-061c63c5eb45f0416 \ --auto-scaling-group-name my-asg ``` 出力: ``` { "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\"}" } ] } ``` 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Auto Scaling グループからの一時的なインスタンスの削除](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-enter-exit-standby.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ExitStandby](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/exit-standby.html)」を参照してください。 ### `put-lifecycle-hook` 次のコード例では、`put-lifecycle-hook` を使用する方法を示しています。 **AWS CLI** **例 1: ライフサイクルフックを作成する方法** この例では、新しく起動した任意のインスタンスで呼び出すライフサイクルフックを作成します。タイムアウトは 4800 秒です。これは、ユーザーデータスクリプトが終了するまでインスタンスを待機状態に保つ場合や、EventBridge を使用して AWS Lambda 関数を呼び出す場合に便利です。 ``` 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 ``` このコマンドでは何も出力されません。同じ名前のライフサイクルフックがすでに存在する場合、新しいライフサイクルフックによって上書きされます。 詳細については、*Amazon EC2 Auto Scaling ユーザーガイド*の「[Amazon EC2 Auto Scaling ライフサイクルフック](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html)」を参照してください。 **例 2: Amazon SNS の E メールメッセージを送信してインスタンスの状態遷移を通知する方法** この例では、インスタンスの起動時に通知を受信するために使用する Amazon SNS トピックと IAM ロールを含むライフサイクルフックを作成します。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、*Amazon EC2 Auto Scaling ユーザーガイド*の「[Amazon EC2 Auto Scaling ライフサイクルフック](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html)」を参照してください。 **例 3: Amazon SQS キューにメッセージを公開する方法** この例では、メタデータを含むメッセージを指定された 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" ``` このコマンドでは何も出力されません。 詳細については、*Amazon EC2 Auto Scaling ユーザーガイド*の「[Amazon EC2 Auto Scaling ライフサイクルフック](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutLifecycleHook](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/put-lifecycle-hook.html)」を参照してください。 ### `put-notification-configuration` 次のコード例では、`put-notification-configuration` を使用する方法を示しています。 **AWS CLI** **通知を追加する方法** この例では、指定された Auto Scaling グループに指定された通知を追加します。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、『*Amazon EC2 Auto Scaling ユーザーガイド*』の「[Auto Scaling グループのスケーリング時の Amazon SNS 通知の取得](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html#as-configure-asg-for-sns)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutNotificationConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/put-notification-configuration.html)」を参照してください。 ### `put-scaling-policy` 次のコード例では、`put-scaling-policy` を使用する方法を示しています。 **AWS CLI** **ターゲット追跡スケーリングポリシーを Auto Scaling グループを追加する方法** 次の `put-scaling-policy` 例では、指定された Auto Scaling グループにターゲットトラッキングスケーリングポリシーを適用します。出力には、自動的に作成された 2 つの CloudWatch アラームの ARN と名前が含まれます。同じ名前のスケーリングポリシーが既に存在する場合は、新しいスケーリングポリシーで上書きされます。 ``` 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 ``` `config.json` の内容: ``` { "TargetValue": 1000.0, "PredefinedMetricSpecification": { "PredefinedMetricType": "ALBRequestCountPerTarget", "ResourceLabel": "app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff" } } ``` 出力: ``` { "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" } ] } ``` その他の例については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[AWS コマンドラインインターフェイス(AWS CLI) のスケーリングポリシーの例](https://docs.aws.amazon.com/autoscaling/ec2/userguide/examples-scaling-policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutScalingPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/put-scaling-policy.html)」を参照してください。 ### `put-scheduled-update-group-action` 次のコード例では、`put-scheduled-update-group-action` を使用する方法を示しています。 **AWS CLI** **例 1: スケジュール済みのアクションを Auto Scaling グループに追加する方法** この例では、指定された Auto Scaling グループから指定されたスケジュール済みの通知を追加します。 ``` 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 ``` このコマンドでは何も出力されません。同じ名前のスケジュールされたアクションが既に存在する場合、新しいスケジュールされたアクションで上書きされます。 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[スケジュールされたスケーリング](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scheduled-scaling.html)」を参照してください。 **例 2: 定期的なスケジュールを指定する方法** この例では、毎年 1 月、6 月、12 月の 1 日の 00:30 に実行する定期スケジュールでスケーリングするスケジュール済みのアクションを作成します。 ``` 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 ``` このコマンドでは何も出力されません。同じ名前のスケジュールされたアクションが既に存在する場合、新しいスケジュールされたアクションで上書きされます。 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[スケジュールされたスケーリング](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-scheduled-scaling.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[PutScheduledUpdateGroupAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/put-scheduled-update-group-action.html)」を参照してください。 ### `put-warm-pool` 次のコード例では、`put-warm-pool` を使用する方法を示しています。 **AWS CLI** **ウォームプールを作成する方法** 次の例では、特定の Auto Scaling グループのウォームプールを作成します。 ``` aws autoscaling put-warm-pool \ --auto-scaling-group-name my-asg \ --min-size 2 ``` このコマンドでは何も出力されません。ウォームプールが既に存在する場合は、更新されます。 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Warm pools for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutWarmPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/put-warm-pool.html)」を参照してください。 ### `record-lifecycle-action-heartbeat` 次のコード例では、`record-lifecycle-action-heartbeat` を使用する方法を示しています。 **AWS CLI** **ライフサイクルアクションハートビートを記録する方法** この例では、ライフサイクルアクションのハートビートを記録して、インスタンスを保留状態に保ちます。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、*Amazon EC2 Auto Scaling ユーザーガイド*の「[Amazon EC2 Auto Scaling ライフサイクルフック](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RecordLifecycleActionHeartbeat](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/record-lifecycle-action-heartbeat.html)」を参照してください。 ### `resume-processes` 次のコード例では、`resume-processes` を使用する方法を示しています。 **AWS CLI** **停止されたプロセスを再開する方法** この例では、指定された Auto Scaling グループの指定された一時停止スケーリングプロセスを再開します。 ``` aws autoscaling resume-processes \ --auto-scaling-group-name my-asg \ --scaling-processes AlarmNotification ``` このコマンドでは何も出力されません。 詳細については、「[Amazon EC2 Auto Scaling ユーザーガイド](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html)」の「*スケーリングプロセスの中断と再開*」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ResumeProcesses](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/resume-processes.html)」を参照してください。 ### `rollback-instance-refresh` 次のコード例では、`rollback-instance-refresh` を使用する方法を示しています。 **AWS CLI** **インスタンスの更新をロールバックする方法** 次の `rollback-instance-refresh` 例では、指定された Auto Scaling グループの進行中のインスタンスの更新をロールバックします。 ``` aws autoscaling rollback-instance-refresh \ --auto-scaling-group-name my-asg ``` 出力: ``` { "InstanceRefreshId": "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b" } ``` 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Undo changes with a rollback](https://docs.aws.amazon.com/autoscaling/ec2/userguide/instance-refresh-rollback.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RollbackInstanceRefresh](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/rollback-instance-refresh.html)」を参照してください。 ### `set-desired-capacity` 次のコード例では、`set-desired-capacity` を使用する方法を示しています。 **AWS CLI** **Auto Scaling グループに希望する容量を設定する方法** この例では、指定された Auto Scaling グループの希望する容量を設定します。 ``` aws autoscaling set-desired-capacity \ --auto-scaling-group-name my-asg \ --desired-capacity 2 \ --honor-cooldown ``` 正常に完了すると、このコマンドはプロンプトに戻ります。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetDesiredCapacity](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/set-desired-capacity.html)」を参照してください。 ### `set-instance-health` 次のコード例では、`set-instance-health` を使用する方法を示しています。 **AWS CLI** **インスタンスのヘルスステータスをチェックする方法** 指定されたインスタンスのヘルスステータスを `Unhealthy` に設定します。 ``` aws autoscaling set-instance-health \ --instance-id i-061c63c5eb45f0416 \ --health-status Unhealthy ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetInstanceHealth](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/set-instance-health.html)」を参照してください。 ### `set-instance-protection` 次のコード例では、`set-instance-protection` を使用する方法を示しています。 **AWS CLI** **例 1: インスタンスに対するインスタンスの保護設定を変更する方法** この例では、指定されたインスタンスのインスタンス保護を有効にします。 ``` aws autoscaling set-instance-protection \ --instance-ids i-061c63c5eb45f0416 \ --auto-scaling-group-name my-asg --protected-from-scale-in ``` このコマンドでは何も出力されません。 **例 2: インスタンスに対するインスタンスの保護設定を無効にする方法** この例では、指定されたインスタンスのインスタンス保護を無効にします。 ``` aws autoscaling set-instance-protection \ --instance-ids i-061c63c5eb45f0416 \ --auto-scaling-group-name my-asg \ --no-protected-from-scale-in ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetInstanceProtection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/set-instance-protection.html)」を参照してください。 ### `start-instance-refresh` 次のコード例では、`start-instance-refresh` を使用する方法を示しています。 **AWS CLI** **例 1: コマンドラインパラメータを使用してインスタンスの更新を開始する方法** 次の `start-instance-refresh` 例では、コマンドライン引数を使用してインスタンスの更新を開始します。オプションの `preferences` パラメータは、`60` 秒の `InstanceWarmup` と `50` パーセント `MinHealthyPercentage` を指定します。 ``` aws autoscaling start-instance-refresh \ --auto-scaling-group-name my-asg \ --preferences '{"InstanceWarmup": 60, "MinHealthyPercentage": 50}' ``` 出力: ``` { "InstanceRefreshId": "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b" } ``` 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[インスタンスの更新を開始](https://docs.aws.amazon.com/en_us/autoscaling/ec2/userguide/start-instance-refresh.html)」を参照してください。 **例 2: JSON ファイルを使用してインスタンスの更新を開始する方法** 次の `start-instance-refresh` 例では、JSON ファイルを使用してインスタンスの更新を開始します。次の例に示すように、Auto Scaling グループを指定し、JSON ファイルで必要な各種構成を定義できます。 ``` aws autoscaling start-instance-refresh \ --cli-input-json file://config.json ``` `config.json` の内容: ``` { "AutoScalingGroupName": "my-asg", "DesiredConfiguration": { "LaunchTemplate": { "LaunchTemplateId": "lt-068f72b729example", "Version": "$Default" } }, "Preferences": { "InstanceWarmup": 60, "MinHealthyPercentage": 50, "AutoRollback": true, "ScaleInProtectedInstances": Ignore, "StandbyInstances": Terminate } } ``` 出力: ``` { "InstanceRefreshId": "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b" } ``` 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[インスタンスの更新を開始](https://docs.aws.amazon.com/en_us/autoscaling/ec2/userguide/start-instance-refresh.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartInstanceRefresh](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/start-instance-refresh.html)」を参照してください。 ### `suspend-processes` 次のコード例では、`suspend-processes` を使用する方法を示しています。 **AWS CLI** **Auto Scaling プロセスを一時停止する方法** この例では、指定された Auto Scaling グループの指定されたスケーリングプロセスを一時停止します。 ``` aws autoscaling suspend-processes \ --auto-scaling-group-name my-asg \ --scaling-processes AlarmNotification ``` このコマンドでは何も出力されません。 詳細については、「[Amazon EC2 Auto Scaling ユーザーガイド](https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html)」の「*スケーリングプロセスの中断と再開*」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SuspendProcesses](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/suspend-processes.html)」を参照してください。 ### `terminate-instance-in-auto-scaling-group` 次のコード例では、`terminate-instance-in-auto-scaling-group` を使用する方法を示しています。 **AWS CLI** **Auto Scaling グループのインスタンスを終了する方法** この例では、グループのサイズを更新せずに、指定された Auto Scaling グループの指定されたインスタンスを終了します。指定されたインスタンスが終了した後、Amazon EC2 Auto Scaling は代替インスタンスを起動します。 ``` aws autoscaling terminate-instance-in-auto-scaling-group \ --instance-id i-061c63c5eb45f0416 \ --no-should-decrement-desired-capacity ``` 出力: ``` { "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\"}" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TerminateInstanceInAutoScalingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/terminate-instance-in-auto-scaling-group.html)」を参照してください。 ### `update-auto-scaling-group` 次のコード例では、`update-auto-scaling-group` を使用する方法を示しています。 **AWS CLI** **例 1: Auto Scaling グループのサイズ制限を更新する方法** この例では、最小サイズが 2、最大サイズが 10 で、指定された Auto Scaling グループを更新します。 ``` aws autoscaling update-auto-scaling-group \ --auto-scaling-group-name my-asg \ --min-size 2 \ --max-size 10 ``` このコマンドでは何も出力されません。 詳細については、「Amazon EC2 Auto Scaling ユーザーガイド」の「[Auto Scaling グループにキャパシティの制限を設定する](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-capacity-limits.html)」を参照してください。** **例 2: Elastic Load Balancing ヘルスチェックを追加し、使用するアベイラビリティーゾーンとサブネットを指定する方法** この例では、指定された Auto Scaling グループを更新して、Elastic Load Balancing のヘルスチェックを追加します。またこのコマンドは、複数のアベイラビリティーゾーンのサブネット ID のリストを使用して、`--vpc-zone-identifier` の値も更新します。 ``` 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" ``` このコマンドでは何も出力されません。 詳細については、「Amazon EC2 Auto Scaling ユーザーガイド」の「[Elastic Load Balancing を使用して Auto Scaling グループ内のインスタンス全体にトラフィックを分散させる](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html)」を参照してください。** **例 3: プレイスメントグループと終了ポリシーを更新する方法** この例では、プレイスメントグループと終了ポリシーを更新します。 ``` aws autoscaling update-auto-scaling-group \ --auto-scaling-group-name my-asg \ --placement-group my-placement-group \ --termination-policies "OldestInstance" ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[Auto Scaling groups](https://docs.aws.amazon.com/autoscaling/ec2/userguide/AutoScalingGroup.html)」を参照してください。 **例 4: 起動テンプレートの最新バージョンを使用する方法** この例では、最新の起動テンプレートバージョンを使用するように、指定された Auto Scaling グループを更新します。 ``` aws autoscaling update-auto-scaling-group \ --auto-scaling-group-name my-asg \ --launch-template LaunchTemplateId=lt-1234567890abcde12,Version='$Latest' ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[起動テンプレート](https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchTemplates.html)」を参照してください。 **例 5: 特定のバージョンの起動テンプレートを使用する方法** この例では、最新バージョンやデフォルトバージョンではなく、指定された起動テンプレートのバージョンを使用するように、指定された Auto Scaling グループを更新します。 ``` aws autoscaling update-auto-scaling-group \ --auto-scaling-group-name my-asg \ --launch-template LaunchTemplateName=my-template-for-auto-scaling,Version='2' ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「[起動テンプレート](https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchTemplates.html)」を参照してください。 **例 6: 混合インスタンスポリシーを定義し、容量のリバランスを有効にする方法** この例では、指定された Auto Scaling グループを更新して、混合インスタンスポリシーを使用し、容量のリバランスを有効にします。この構造により、スポット容量とオンデマンド容量でグループを指定し、アーキテクチャごとに異なる起動テンプレートを使用できます。 ``` aws autoscaling update-auto-scaling-group \ --cli-input-json file://~/config.json ``` `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" } } } ``` このコマンドでは何も出力されません。 詳細については「Amazon EC2 Auto Scaling ユーザーガイド」の「[複数のインスタンスタイプと購入オプションを使用する Auto Scaling グループ](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateAutoScalingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling/update-auto-scaling-group.html)」を参照してください。 # AWS CLI を使用した自動スケーリングプランの例 次のコード例では、自動スケーリングプランで AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-scaling-plan` 次の例では、`create-scaling-plan` を使用する方法を説明しています。 **AWS CLI** **スケーリングプランを作成する方法** 次の `create-scaling-plan` の例では、既に作成された JSON ファイル (config.json という名前) を使用して「`my-scaling-plan`」という名前のスケーリングプランを作成します。スケーリングプランの構造には、「`my-asg`」という名前の自動スケーリンググループのスケーリング命令が含まれています。`TagFilters` プロパティをアプリケーションソースとして指定し、予測スケーリングと動的スケーリングを有効にします。 ``` aws autoscaling-plans create-scaling-plan \ --scaling-plan-name my-scaling-plan \ --cli-input-json file://~/config.json ``` `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 } ] } ] } ``` 出力: ``` { "ScalingPlanVersion": 1 } ``` 詳細については、「[AWS自動スケーリングユーザーガイド](https://docs.aws.amazon.com/autoscaling/plans/userguide/what-is-aws-auto-scaling.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateScalingPlan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling-plans/create-scaling-plan.html)」を参照してください。 ### `delete-scaling-plan` 次の例では、`delete-scaling-plan` を使用する方法を説明しています。 **AWS CLI** **スケーリングプランを削除する方法** 次の `delete-scaling-plan` の例では、指定されたスケーリングプランを削除します。 ``` aws autoscaling-plans delete-scaling-plan \ --scaling-plan-name my-scaling-plan \ --scaling-plan-version 1 ``` このコマンドでは何も出力されません。 詳細については、「[AWS自動スケーリングユーザーガイド](https://docs.aws.amazon.com/autoscaling/plans/userguide/what-is-aws-auto-scaling.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteScalingPlan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling-plans/delete-scaling-plan.html)」を参照してください。 ### `describe-scaling-plan-resources` 次の例では、`describe-scaling-plan-resources` を使用する方法を説明しています。 **AWS CLI** **スケーリングプランのスケーラブルリソースを記述する方法** 次の `describe-scaling-plan-resources` の例では、指定されたスケーリングプランに関連付けられている単一のスケーラブルリソース (自動スケーリンググループ) の詳細を表示します。 ``` aws autoscaling-plans describe-scaling-plan-resources \ --scaling-plan-name my-scaling-plan \ --scaling-plan-version 1 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS自動スケーリングユーザーガイド*」の「[AWS 自動スケーリングとは](https://docs.aws.amazon.com/autoscaling/plans/userguide/what-is-aws-auto-scaling.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeScalingPlanResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling-plans/describe-scaling-plan-resources.html)」を参照してください。 ### `describe-scaling-plans` 次の例では、`describe-scaling-plans` を使用する方法を説明しています。 **AWS CLI** **スケーリングプランを記述する方法** 次の `describe-scaling-plans` の例では、指定されたスケーリングプランの詳細を表示します。 ``` aws autoscaling-plans describe-scaling-plans \ --scaling-plan-names scaling-plan-with-asg-and-ddb ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS自動スケーリングユーザーガイド*」の「[AWS 自動スケーリングとは](https://docs.aws.amazon.com/autoscaling/plans/userguide/what-is-aws-auto-scaling.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeScalingPlans](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling-plans/describe-scaling-plans.html)」を参照してください。 ### `get-scaling-plan-resource-forecast-data` 次の例では、`get-scaling-plan-resource-forecast-data` を使用する方法を説明しています。 **AWS CLI** **ロード予測データを取得する方法** この例では、指定されたスケーリングプランに関連付けられているスケーラブルリソース (自動スケーリンググループ) のロード予測データを取得します。 ``` 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" ``` 出力: ``` { "Datapoints": [...] } ``` 詳細については、「*AWS自動スケーリングユーザーガイド*」の「[AWS 自動スケーリングとは](https://docs.aws.amazon.com/autoscaling/plans/userguide/what-is-aws-auto-scaling.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetScalingPlanResourceForecastData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling-plans/get-scaling-plan-resource-forecast-data.html)」を参照してください。 ### `update-scaling-plan` 次の例では、`update-scaling-plan` を使用する方法を説明しています。 **AWS CLI** **スケーリングプランを更新する方法** 次の `update-scaling-plan` の例では、指定されたスケーリングプランの自動スケーリンググループのスケーリングメトリクスを変更します。 ``` 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}' ``` このコマンドでは何も出力されません。 詳細については、「*AWS自動スケーリングユーザーガイド*」の「[AWS 自動スケーリングとは](https://docs.aws.amazon.com/autoscaling/plans/userguide/what-is-aws-auto-scaling.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateScalingPlan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/autoscaling-plans/update-scaling-plan.html)」を参照してください。 # AWS Backup examples using AWS CLI 次のコード例では、AWS Backup で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-backup-plan` 次の例では、`create-backup-plan` を使用する方法を説明しています。 **AWS CLI** **バックアッププランを作成する方法** 次の `create-backup-plan` の例では、35 日間の保持期間を持つ指定されたバックアッププランを作成します。 ``` 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}}]}" ``` 出力: ``` { "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" } ``` 詳細については、「*AWS デベロッパーガイド*」の「[バックアッププランの作成](https://docs.aws.amazon.com/aws-backup/latest/devguide/creating-a-backup-plan.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドレットリファレンス*」の「[CreateBackupPlan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/backup/create-backup-plan.html)」を参照してください。 ### `create-backup-vault` 次の例では、`create-backup-vault` を使用する方法を説明しています。 **AWS CLI** **バックアップボールトを作成する方法** 次の `create-backup-vault` 例では、指定された名前のバックアップボールトを作成します。 ``` aws backup create-backup-vault --backup-vault-name sample-vault ``` このコマンドでは何も出力されません。出力: ``` { "BackupVaultName": "sample-vault", "BackupVaultArn": "arn:aws:backup:us-west-2:123456789012:backup-vault:sample-vault", "CreationDate": 1568928338.385 } ``` 詳細については、「*AWS デベロッパーガイド*」の「[バックアッププランの作成](https://docs.aws.amazon.com/aws-backup/latest/devguide/creating-a-vault.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateBackupVault](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/backup/create-backup-vault.html)」を参照してください。 ### `get-backup-plan-from-template` 次の例では、`get-backup-plan-from-template` を使用する方法を説明しています。 **AWS CLI** **テンプレートから既存のバックアッププランを取得する方法** 次の `get-backup-plan-from-template` の例では、35 日間の保持期間を持つ日次バックアップを指定するテンプレートから既存のバックアッププランを取得します。 ``` aws backup get-backup-plan-from-template \ --backup-plan-template-id "87c0c1ef-254d-4180-8fef-2e76a2c38aaa" ``` 出力: ``` { "BackupPlanDocument": { "Rules": [ { "RuleName": "DailyBackups", "ScheduleExpression": "cron(0 5 ? * * *)", "StartWindowMinutes": 480, "Lifecycle": { "DeleteAfterDays": 35 } } ] } } ``` 詳細については、「*AWS デベロッパーガイド*」の「[バックアッププランの作成](https://docs.aws.amazon.com/aws-backup/latest/devguide/creating-a-backup-plan.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetBackupPlanFromTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/backup/get-backup-plan-from-template.html)」を参照してください。 ### `get-backup-plan` 次の例では、`get-backup-plan` を使用する方法を説明しています。 **AWS CLI** **バックアッププランの詳細を取得する方法** 次の `get-backup-plan` の例では、指定されたバックアッププランの詳細を表示します。 ``` aws backup get-backup-plan \ --backup-plan-id "fcbf5d8f-bd77-4f3a-9c97-f24fb3d373a5" ``` 出力: ``` { "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 } ``` 詳細については、「*AWS デベロッパーガイド*」の「[バックアッププランの作成](https://docs.aws.amazon.com/aws-backup/latest/devguide/creating-a-backup-plan.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetBackupPlan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/backup/get-backup-plan.html)」を参照してください。 ### `list-backup-jobs` 次の例では、`list-backup-jobs` を使用する方法を説明しています。 **AWS CLI** **例 1: すべてのバックアップジョブを一覧表示する方法** 次の `list-backup-jobs` の例では、AWS アカウントのバックアップジョブに関するメタデータを返します。 ``` aws backup list-backup-jobs ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS バックアップデベロッパーガイド*」の「[バックアッププランの作成](https://https://docs.aws.amazon.com/aws-backup/latest/devguide/creating-a-backup.html)」を参照してください。 **例 2: 完了したバックアップジョブを一覧表示する方法** 次の `list-backup-jobs` の例では、AWS アカウントの完了したバックアップジョブに関するメタデータを返します。 ``` aws backup list-backup-jobs \ --by-state COMPLETED ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS バックアップデベロッパーガイド*」の「[バックアッププランの作成](https://https://docs.aws.amazon.com/aws-backup/latest/devguide/creating-a-backup.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListBackupJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/backup/list-backup-jobs.html)」を参照してください。 # AWS Batch examples using AWS CLI 次のコード例では、AWS Batch で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `cancel-job` 次のコード例では、`cancel-job` を使用する方法を示しています。 **AWS CLI** **ジョブをキャンセルする方法** この例では、指定されたジョブ ID のジョブをキャンセルします。 コマンド: ``` aws batch cancel-job --job-id bcf0b186-a532-4122-842e-2ccab8d54efb --reason "Cancelling job." ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/cancel-job.html)」を参照してください。 ### `create-compute-environment` 次のコード例では、`create-compute-environment` を使用する方法を示しています。 **AWS CLI** **オンデマンドインスタンスを使用してマネージドコンピューティング環境を作成する方法** この例では、オンデマンドで起動される特定の C4 インスタンスタイプを持つマネージドコンピューティング環境を作成します。コンピューティング環境は C4OnDemand と呼ばれます。 コマンド: ``` aws batch create-compute-environment --cli-input-json file:///C4OnDemand.json ``` 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" } ``` 出力: ``` { "computeEnvironmentName": "C4OnDemand", "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand" } ``` **スポットインスタンスでマネージドコンピューティング環境を作成する方法** この例では、スポット入札価格がインスタンスタイプのオンデマンド価格の 20% 以下のときに起動される M4 インスタンスタイプを使用してマネージドコンピューティング環境を作成します。コンピューティング環境は M4Spot と呼ばれます。 コマンド: ``` aws batch create-compute-environment --cli-input-json file:///M4Spot.json ``` 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" } ``` 出力: ``` { "computeEnvironmentName": "M4Spot", "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/M4Spot" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateComputeEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/create-compute-environment.html)」を参照してください。 ### `create-job-queue` 次のコード例では、`create-job-queue` を使用する方法を示しています。 **AWS CLI** **単一のコンピューティング環境で優先度の低いジョブキューを作成する方法** この例では、M4Spot コンピューティング環境を使用する LowPriority というジョブキューを作成します。 コマンド: ``` aws batch create-job-queue --cli-input-json file:///LowPriority.json ``` JSON ファイル形式: ``` { "jobQueueName": "LowPriority", "state": "ENABLED", "priority": 10, "computeEnvironmentOrder": [ { "order": 1, "computeEnvironment": "M4Spot" } ] } ``` 出力: ``` { "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/LowPriority", "jobQueueName": "LowPriority" } ``` **2 つのコンピューティング環境で優先度の高いジョブキューを作成する方法** この例では、1 の順序で C4OnDemand コンピューティング環境を使用し、2 の順序で M4Spot コンピューティング環境を使用する、HighPriority というジョブキューを作成します。スケジューラは、まず C4OnDemand コンピューティング環境にジョブを配置しようとします。 コマンド: ``` aws batch create-job-queue --cli-input-json file:///HighPriority.json ``` JSON ファイル形式: ``` { "jobQueueName": "HighPriority", "state": "ENABLED", "priority": 1, "computeEnvironmentOrder": [ { "order": 1, "computeEnvironment": "C4OnDemand" }, { "order": 2, "computeEnvironment": "M4Spot" } ] } ``` 出力: ``` { "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority", "jobQueueName": "HighPriority" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateJobQueue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/create-job-queue.html)」を参照してください。 ### `delete-compute-environment` 次のコード例では、`delete-compute-environment` を使用する方法を示しています。 **AWS CLI** **コンピューティング環境を削除する方法** この例では、P2OnDemand コンピューティング環境を削除します。 コマンド: ``` aws batch delete-compute-environment --compute-environment P2OnDemand ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteComputeEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/delete-compute-environment.html)」を参照してください。 ### `delete-job-queue` 次のコード例では、`delete-job-queue` を使用する方法を示しています。 **AWS CLI** **ジョブキューを削除する方法** この例では、GPGPU ジョブキューを削除します。 コマンド: ``` aws batch delete-job-queue --job-queue GPGPU ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteJobQueue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/delete-job-queue.html)」を参照してください。 ### `deregister-job-definition` 次のコード例では、`deregister-job-definition` を使用する方法を示しています。 **AWS CLI** **タスク定義を登録解除する方法** この例では、 sleep10 というジョブ定義を登録解除します。 コマンド: ``` aws batch deregister-job-definition --job-definition sleep10 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeregisterJobDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/deregister-job-definition.html)」を参照してください。 ### `describe-compute-environments` 次のコード例では、`describe-compute-environments` を使用する方法を示しています。 **AWS CLI** **コンピューティング環境を記述する方法** この例では、P2OnDemand コンピューティング環境を記述します。 コマンド: ``` aws batch describe-compute-environments --compute-environments P2OnDemand ``` 出力: ``` { "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" } ] } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeComputeEnvironments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/describe-compute-environments.html)」を参照してください。** ### `describe-job-definitions` 次のコード例では、`describe-job-definitions` を使用する方法を示しています。 **AWS CLI** **アクティブなジョブ定義を記述する方法** この例では、アクティブなすべてのジョブ定義について記述します。 コマンド: ``` aws batch describe-job-definitions --status ACTIVE ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeJobDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/describe-job-definitions.html)」を参照してください。 ### `describe-job-queues` 次のコード例では、`describe-job-queues` を使用する方法を示しています。 **AWS CLI** **ジョブキューを記述する方法** この例では、HighPriority ジョブキューを記述します。 コマンド: ``` aws batch describe-job-queues --job-queues HighPriority ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeJobQueues](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/describe-job-queues.html)」を参照してください。 ### `describe-jobs` 次のコード例では、`describe-jobs` を使用する方法を示しています。 **AWS CLI** **ジョブについて記述する方法** 次の `describe-jobs` の例では、指定されたジョブ ID を持つジョブを記述します。 ``` aws batch describe-jobs \ --jobs bcf0b186-a532-4122-842e-2ccab8d54efb ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/describe-jobs.html)」を参照してください。 ### `list-jobs` 次のコード例では、`list-jobs` を使用する方法を示しています。 **AWS CLI** **実行中のジョブを一覧表示する方法** この例では、HighPriority ジョブキューで実行中のジョブを一覧表示します。 コマンド: ``` aws batch list-jobs --job-queue HighPriority ``` 出力: ``` { "jobSummaryList": [ { "jobName": "example", "jobId": "e66ff5fd-a1ff-4640-b1a2-0b0a142f49bb" } ] } ``` **送信されたジョブを一覧表示する方法** この例では、SUBMITTED ジョブステータスの HighPriority ジョブキュー内のジョブを一覧表示します。 コマンド: ``` aws batch list-jobs --job-queue HighPriority --job-status SUBMITTED ``` 出力: ``` { "jobSummaryList": [ { "jobName": "example", "jobId": "68f0c163-fbd4-44e6-9fd1-25b14a434786" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/list-jobs.html)」を参照してください。 ### `register-job-definition` 次のコード例では、`register-job-definition` を使用する方法を示しています。 **AWS CLI** **ジョブ定義を登録する方法** この例では、単純なコンテナジョブのジョブ定義を登録します。 コマンド: ``` aws batch register-job-definition --job-definition-name sleep30 --type container --container-properties '{ "image": "busybox", "vcpus": 1, "memory": 128, "command": [ "sleep", "30"]}' ``` 出力: ``` { "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep30:1", "jobDefinitionName": "sleep30", "revision": 1 } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegisterJobDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/register-job-definition.html)」を参照してください。 ### `submit-job` 次のコード例では、`submit-job` を使用する方法を示しています。 **AWS CLI** **ジョブを送信する方法** この例では、example という単純なコンテナジョブを HighPriority ジョブキューに送信します。 コマンド: ``` aws batch submit-job --job-name example --job-queue HighPriority --job-definition sleep60 ``` 出力: ``` { "jobName": "example", "jobId": "876da822-4198-45f2-a252-6cea32512ea8" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SubmitJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/submit-job.html)」を参照してください。 ### `terminate-job` 次のコード例では、`terminate-job` を使用する方法を示しています。 **AWS CLI** **ジョブを終了する方法** この例では、指定されたジョブ ID でジョブを終了します。 コマンド: ``` aws batch terminate-job --job-id 61e743ed-35e4-48da-b2de-5c8333821c84 --reason "Terminating job." ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TerminateJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/terminate-job.html)」を参照してください。 ### `update-compute-environment` 次のコード例では、`update-compute-environment` を使用する方法を示しています。 **AWS CLI** **コンピューティング環境を作成する方法** この例では、削除できるように P2OnDemand コンピューティング環境を無効にします。 コマンド: ``` aws batch update-compute-environment --compute-environment P2OnDemand --state DISABLED ``` 出力: ``` { "computeEnvironmentName": "P2OnDemand", "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateComputeEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/update-compute-environment.html)」を参照してください。 ### `update-job-queue` 次のコード例では、`update-job-queue` を使用する方法を示しています。 **AWS CLI** **ジョブキューを作成する方法** この例では、削除できるようにジョブキューを無効にします。 コマンド: ``` aws batch update-job-queue --job-queue GPGPU --state DISABLED ``` 出力: ``` { "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/GPGPU", "jobQueueName": "GPGPU" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateJobQueue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/batch/update-job-queue.html)」を参照してください。 # AWS Budgets examples using AWS CLI 次のコード例では、AWS Budgets で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-budget` 次のコード例では、`create-budget` を使用する方法を示しています。 **AWS CLI** **使用量の予算を作成する方法** 次の `create-budget` コマンドは、コストと使用状況の予算を作成します。 ``` aws budgets create-budget \ --account-id 111122223333 \ --budget file://budget.json \ --notifications-with-subscribers file://notifications-with-subscribers.json ``` `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" } ``` `notifications-with-subscribers.json` の内容: ``` [ { "Notification": { "ComparisonOperator": "GREATER_THAN", "NotificationType": "ACTUAL", "Threshold": 80, "ThresholdType": "PERCENTAGE" }, "Subscribers": [ { "Address": "example@example.com", "SubscriptionType": "EMAIL" } ] } ] ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateBudget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/create-budget.html)」を参照してください。 ### `create-notification` 次のコード例では、`create-notification` を使用する方法を示しています。 **AWS CLI** **指定されたコストと使用量の予算の通知を作成する方法** この例では、指定されたコストと使用量の予算の通知を作成します。 コマンド: ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateNotification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/create-notification.html)」を参照してください。 ### `create-subscriber` 次のコード例では、`create-subscriber` を使用する方法を示しています。 **AWS CLI** **コストと使用量の予算に関連付けられた通知のサブスクライバーを作成する方法** この例では、指定された通知のサブスクライバーを作成します。 コマンド: ``` 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 ``` + API の詳細については、「*AWS CLI コマンドレットリファレンス*」の「[CreateSubscriber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/create-subscriber.html)」を参照してください。 ### `delete-budget` 次のコード例では、`delete-budget` を使用する方法を示しています。 **AWS CLI** **使用量の予算を削除する方法** この例では、指定されたコストと使用量の予算を削除します。 コマンド: ``` aws budgets delete-budget --account-id 111122223333 --budget-name "Example Budget" ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteBudget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/delete-budget.html)」を参照してください。 ### `delete-notification` 次のコード例では、`delete-notification` を使用する方法を示しています。 **AWS CLI** **予算から通知を削除する方法** この例では、指定された予算から指定された通知を削除します。 コマンド: ``` aws budgets delete-notification --account-id 111122223333 --budget-name "Example Budget" --notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteNotification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/delete-notification.html)」を参照してください。 ### `delete-subscriber` 次のコード例では、`delete-subscriber` を使用する方法を示しています。 **AWS CLI** **通知からサブスクライバーを削除する方法** この例では、指定された通知から指定されたサブスクライバーを削除します。 コマンド: ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteSubscriber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/delete-subscriber.html)」を参照してください。 ### `describe-budget` 次のコード例では、`describe-budget` を使用する方法を示しています。 **AWS CLI** **アカウントに関連付けられた予算を取得する方法** この例では、指定されたコストと使用量の予算を取得します。 コマンド: ``` aws budgets describe-budget --account-id 111122223333 --budget-name "Example Budget" ``` 出力: ``` { "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" ] } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeBudget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/describe-budget.html)」を参照してください。 ### `describe-budgets` 次のコード例では、`describe-budgets` を使用する方法を示しています。 **AWS CLI** **アカウントに関連付けられた予算を取得する方法** この例では、アカウントのコストと使用状況の予算を取得します。 コマンド: ``` aws budgets describe-budgets --account-id 111122223333 --max-results 20 ``` 出力: ``` { "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" ] } } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeBudgets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/describe-budgets.html)」を参照してください。 ### `describe-notifications-for-budget` 次のコード例では、`describe-notifications-for-budget` を使用する方法を示しています。 **AWS CLI** **予算の通知を取得する方法** この例では、コストと使用状況の予算の通知を取得します。 コマンド: ``` aws budgets describe-notifications-for-budget --account-id 111122223333 --budget-name "Example Budget" --max-results 5 ``` 出力: ``` { "Notifications": [ { "Threshold": 80.0, "ComparisonOperator": "GREATER_THAN", "NotificationType": "ACTUAL" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeNotificationsForBudget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/describe-notifications-for-budget.html)」を参照してください。 ### `describe-subscribers-for-notification` 次のコード例では、`describe-subscribers-for-notification` を使用する方法を示しています。 **AWS CLI** **予算の通知のサブスクライバーを取得する方法** この例では、コストと使用状況の予算通知のサブスクライバーを取得します。 コマンド: ``` 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 ``` 出力: ``` { "Subscribers": [ { "SubscriptionType": "EMAIL", "Address": "example2@example.com" }, { "SubscriptionType": "EMAIL", "Address": "example@example.com" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeSubscribersForNotification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/describe-subscribers-for-notification.html)」を参照してください。 ### `update-budget` 次のコード例では、`update-budget` を使用する方法を示しています。 **AWS CLI** **コストと使用状況の予算の予算を置き換える方法** この例では、コストと使用量の予算を新しい予算に置き換えます。 コマンド: ``` 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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateBudget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/update-budget.html)」を参照してください。 ### `update-notification` 次のコード例では、`update-notification` を使用する方法を示しています。 **AWS CLI** **コストと使用量の予算の通知を置き換える方法** この例では、コストと使用状況の予算の 80% の通知を 90% の通知に置き換えます。 コマンド: ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateNotification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/update-notification.html)」を参照してください。 ### `update-subscriber` 次のコード例では、`update-subscriber` を使用する方法を示しています。 **AWS CLI** **コストと使用状況の予算のサブスクライバーを置き換える方法** この例では、サブスクライバーをコストと使用量の予算に置き換えます。 コマンド: ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateSubscriber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/update-subscriber.html)」を参照してください。 # AWS CLI を使用した Amazon Chime の例 次のコードサンプルは、Amazon Chime で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `associate-phone-number-with-user` 次のコード例では、`associate-phone-number-with-user` を使用する方法を示しています。 **AWS CLI** **電話番号をユーザーに関連付ける方法** 次の `associate-phone-number-with-user` の例では、指定された電話番号をユーザーに関連付けます。 ``` 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" ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Chime 管理ガイド*」の「[ユーザーの電話番号の管理](https://docs.aws.amazon.com/chime/latest/ag/user-phone.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[AssociatePhoneNumberWithUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/associate-phone-number-with-user.html)」を参照してください。 ### `associate-signin-delegate-groups-with-account` 次のコード例は、`associate-signin-delegate-groups-with-account` を使用する方法を示しています。 **AWS CLI** **サインイン代理グループを関連付ける方法** 次の `associate-signin-delegate-groups-with-account` の例では、指定されたサインイン代理グループを、指定された Amazon Chime アカウントと関連付けます。 ``` aws chime associate-signin-delegate-groups-with-account \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --signin-delegate-groups GroupName=my_users ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Chime 管理ガイド*」の「[ユーザーアクセスと許可の管理](https://docs.aws.amazon.com/chime/latest/ag/manage-access.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateSigninDelegateGroupsWithAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/associate-signin-delegate-groups-with-account.html)」を参照してください。 ### `batch-create-room-membership` 次のコード例では、`batch-create-room-membership` を使用する方法を示しています。 **AWS CLI** **複数のルームメンバーシップを作成する方法** 次の `batch-create-room-membership` の例では、チャットルームのメンバーとしてチャットルームに複数のユーザーを追加します。また、管理者ロールとメンバーロールをユーザーに割り当てます。 ``` 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" ``` 出力: ``` { "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": [] } ``` 詳細については、「*Amazon Chime ユーザーガイド*」の「[チャットルームの作成](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html)」を参照してください。 + API の詳細については、「AWS CLI* コマンドリファレンス*」の「[BatchCreateRoomMembership](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/batch-create-room-membership.html)」を参照してください。 ### `batch-delete-phone-number` 次のコード例では、`batch-delete-phone-number` を使用する方法を示しています。 **AWS CLI** **複数の電話番号を削除する方法** 次の `batch-delete-phone-number` の例では、指定された電話番号をすべて削除します。 ``` aws chime batch-delete-phone-number \ --phone-number-ids "%2B12065550100" "%2B12065550101" ``` このコマンドでは何も出力されません。出力: ``` { "PhoneNumberErrors": [] } ``` 詳細については、「*Amazon Chime 管理ガイド*」の「[電話番号の使用方法](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchDeletePhoneNumber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/batch-delete-phone-number.html)」を参照してください。 ### `batch-suspend-user` 次のコード例では、`batch-suspend-user` を使用する方法を示しています。 **AWS CLI** **複数のユーザーを一時利用停止する方法** 次の `batch-suspend-user` の例では、指定された 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" ``` 出力: ``` { "UserErrors": [] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchSuspendUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/batch-suspend-user.html)」を参照してください。 ### `batch-unsuspend-user` 次のコード例では、`batch-unsuspend-user` を使用する方法を示しています。 **AWS CLI** **複数のユーザーの一時利用停止を解除する方法** 次の `batch-unsuspend-user` の例では、指定された 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" ``` 出力: ``` { "UserErrors": [] } ``` + API の詳細については、「AWS CLI* コマンドリファレンス*」の「[BatchUnsuspendUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/batch-unsuspend-user.html)」を参照してください。 ### `batch-update-phone-number` 次のコード例では、`batch-update-phone-number` を使用する方法を示しています。 **AWS CLI** **複数の電話番号製品タイプを同時に更新する方法** 次の `batch-update-phone-number` の例では、指定されたすべての電話番号の製品タイプを更新します。 ``` aws chime batch-update-phone-number \ --update-phone-number-request-items PhoneNumberId=%2B12065550100,ProductType=BusinessCalling PhoneNumberId=%2B12065550101,ProductType=BusinessCalling ``` 出力: ``` { "PhoneNumberErrors": [] } ``` **複数の電話番号呼び出し名を同時に更新する方法** 次の `batch-update-phone-number` の例では、指定されたすべての電話番号の呼び出し名を更新します。 ``` aws chime batch-update-phone-number \ --update-phone-number-request-items PhoneNumberId=%2B14013143874,CallingName=phonenumber1 PhoneNumberId=%2B14013144061,CallingName=phonenumber2 ``` 出力: ``` { "PhoneNumberErrors": [] } ``` 詳細については、「*Amazon Chime 管理ガイド*」の「[電話番号の使用方法](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchUpdatePhoneNumber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/batch-update-phone-number.html)」を参照してください。 ### `batch-update-user` 次のコード例では、`batch-update-user` を使用する方法を示しています。 **AWS CLI** **つのコマンドで複数のユーザーを更新する方法** 次の `batch-update-user` の例では、指定された Amazon Chime アカウント内のリストされた各ユーザーの `LicenseType` を更新します。 ``` 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" ``` 出力: ``` { "UserErrors": [] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchUpdateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/batch-update-user.html)」を参照してください。 ### `create-account` 次のコード例では、`create-account` を使用する方法を示しています。 **AWS CLI** **アカウントを作成する方法** 次の `create-account` の例では、管理者の AWS アカウントの下に Amazon Chime アカウントを作成します。 ``` aws chime create-account \ --name MyChimeAccount ``` 出力: ``` { "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" }, ] } } ``` 詳細については、「*Amazon Chime 管理者ガイド*」の「[はじめに](https://docs.aws.amazon.com/chime/latest/ag/getting-started.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[CreateAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/create-account.html)」を参照してください。** ### `create-bot` 次のコード例では、`create-bot` を使用する方法を示しています。 **AWS CLI** **Amazon Chime ボットを作成する方法** 次の `create-bot` の例では、指定された Amazon Chime Enterprise アカウントのボットを作成します。 ``` aws chime create-bot \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --display-name "myBot" \ --domain "example.com" ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Chime デベロッパーガイド*」の「[Amazon Chime でチャットボットを連携する](https://docs.aws.amazon.com/chime/latest/dg/integrate-bots.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateBot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/create-bot.html)」を参照してください。 ### `create-phone-number-order` 次のコード例では、`create-phone-number-order` を使用する方法を示しています。 **AWS CLI** **電話番号の順序を作成する方法** 次の `create-phone-number-order` の例では、指定された電話番号の順序を作成します。 ``` aws chime create-phone-number-order \ --product-type VoiceConnector \ --e164-phone-numbers "+12065550100" "+12065550101" "+12065550102" ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Chime 管理ガイド*」の「[電話番号の使用方法](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreatePhoneNumberOrder](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/create-phone-number-order.html)」を参照してください。 ### `create-room-membership` 次のコード例は、`create-room-membership` を使用する方法を示しています。 **AWS CLI** **ルームメンバーシップを作成する方法** 次の `create-room-membership` の例では、指定されたユーザーをチャットルームメンバーとしてチャットルームに追加します。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Chime ユーザーガイド*」の「[チャットルームの作成](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateRoomMembership](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/create-room-membership.html)」を参照してください。 ### `create-room` 次のコード例では、`create-room` を使用する方法を示しています。 **AWS CLI** **チャットルームを作成するには** 次の `create-room` の例では、指定された Amazon Chime アカウントのチャットルームを作成します。 ``` aws chime create-room \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --name chatRoom ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Chime ユーザーガイド*」の「[チャットルームの作成](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateRoom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/create-room.html)」を参照してください。 ### `create-user` 次のコード例では、`create-user` を使用する方法を示しています。 **AWS CLI** **共有デバイスのユーザープロファイルを作成する方法** 次の `create-user` の例では、指定された E メールアドレスの共有デバイスプロファイルを作成します。 ``` aws chime create-user \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --email roomdevice@example.com \ --user-type SharedDevice ``` 出力: ``` { "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 } } } ``` ユーザー作成の詳細については、「*Amazon Chime 管理ガイド*」の「[セットアップの準備](https://docs.aws.amazon.com/chime/latest/ag/prepare-setup.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/create-user.html)」を参照してください。 ### `delete-account` 次のコード例は、`delete-account` を使用する方法を示しています。 **AWS CLI** **アカウントを削除する方法** 次の `delete-account` の例では、指定されたアカウントを削除します。 ``` aws chime delete-account --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Chime 管理ガイド*」の「[アカウントの削除](https://docs.aws.amazon.com/chime/latest/ag/enterprise-account.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/delete-account.html)」を参照してください。 ### `delete-phone-number` 次のコード例では、`delete-phone-number` を使用する方法を示しています。 **AWS CLI** **電話番号を削除する方法** 次の `delete-phone-number` の例では、指定された電話番号を削除キューに移動します。 ``` aws chime delete-phone-number \ --phone-number-id "+12065550100" ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Chime 管理ガイド*」の「[電話番号の使用方法](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeletePhoneNumber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/delete-phone-number.html)」を参照してください。 ### `delete-room-membership` 次のコード例は、`delete-room-membership` を使用する方法を示しています。 **AWS CLI** **チャットルームのメンバーとしてユーザーを削除する方法** 次の `delete-room-membership` の例では、指定されたチャットルームから指定されたメンバーを削除します。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Chime ユーザーガイド*」の「[チャットルームの作成](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRoomMembership](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/delete-room-membership.html)」を参照してください。 ### `delete-room` 次のコード例では、`delete-room` を使用する方法を示しています。 **AWS CLI** **チャットルームを削除する方法** 次の `delete-room` の例では、指定されたチャットルームを削除し、チャットルームメンバーシップを削除します。 ``` aws chime delete-room \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Chime ユーザーガイド*」の「[チャットルームの作成](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRoom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/delete-room.html)」を参照してください。 ### `disassociate-phone-number-from-user` 次のコード例は、`disassociate-phone-number-from-user` を使用する方法を示しています。 **AWS CLI** **ユーザーから電話番号の関連付けを解除する方法** 次の `disassociate-phone-number-from-user` の例では、指定されたユーザーから電話番号の関連付けを解除します。 ``` aws chime disassociate-phone-number-from-user \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --user-id 1ab2345c-67de-8901-f23g-45h678901j2k ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Chime 管理ガイド*」の「[ユーザーの電話番号の管理](https://docs.aws.amazon.com/chime/latest/ag/user-phone.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociatePhoneNumberFromUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/disassociate-phone-number-from-user.html)」を参照してください。 ### `disassociate-signin-delegate-groups-from-account` 次のコード例は、`disassociate-signin-delegate-groups-from-account` を使用する方法を示しています。 **AWS CLI** **サインイン代理グループの関連付けを解除する方法** 次の `disassociate-signin-delegate-groups-from-account` の例では、指定されたサインイン代理グループと指定された Amazon Chime アカウントとの関連付けを解除します。 ``` aws chime disassociate-signin-delegate-groups-from-account \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --group-names "my_users" ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Chime 管理ガイド*」の「[ユーザーアクセスと許可の管理](https://docs.aws.amazon.com/chime/latest/ag/manage-access.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateSigninDelegateGroupsFromAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/disassociate-signin-delegate-groups-from-account.html)」を参照してください。 ### `get-account-settings` 次のコード例では、`get-account-settings` を使用する方法を示しています。 **AWS CLI** **アカウントの設定を取得する方法** 次の `get-account-settings` の例では、指定されたアカウントのアカウント設定を取得します。 ``` aws chime get-account-settings --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE ``` 出力: ``` { "AccountSettings": { "DisableRemoteControl": false, "EnableDialOut": false } } ``` 詳細については、「*Amazon Chime 管理ガイド*」の「[Amazon Chime アカウントの管理](https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAccountSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-account-settings.html)」を参照してください。 ### `get-account` 次のコード例では、`get-account` を使用する方法を示しています。 **AWS CLI** **アカウントの詳細を取得する方法** 次の `get-account` の例では、指定された Amazon Chime アカウントに関する詳細を取得します。 ``` aws chime get-account \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE ``` 出力: ``` { "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" }, ] } } ``` 詳細については、「*Amazon Chime 管理ガイド*」の「[Amazon Chime アカウントの管理](https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-account.html)」を参照してください。 ### `get-bot` 次のコード例では、`get-bot` を使用する方法を示しています。 **AWS CLI** **ボットの詳細を取得する方法** 次の `get-bot` の例では、指定されたポリシーの詳細を表示します。 ``` aws chime get-bot \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --bot-id 123abcd4-5ef6-789g-0h12-34j56789012k ``` 出力: ``` { "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" } } ``` 詳細については、「[Amazon Chime デベロッパーガイド](https://docs.aws.amazon.com/chime/latest/dg/update-bots.html)」の「*チャットボットの更新*」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetBot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-bot.html)」を参照してください。 ### `get-global-settings` 次のコード例では、`get-global-settings` を使用する方法を示しています。 **AWS CLI** **グローバル設定を取得する方法** 次の `get-global-settings` の例では、管理者の AWS アカウントに関連付けられた Amazon Chime Business Calling および Amazon Chime Voice Connectors の通話詳細レコードの保存に使用される S3 バケット名を取得します。 ``` aws chime get-global-settings ``` 出力: ``` { "BusinessCalling": { "CdrBucket": "s3bucket" }, "VoiceConnector": { "CdrBucket": "s3bucket" } } ``` 詳細については、「*Amazon Chime 管理ガイド*」の「[グローバル設定の管理](https://docs.aws.amazon.com/chime/latest/ag/manage-global.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetGlobalSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-global-settings.html)」を参照してください。 ### `get-phone-number-order` 次のコード例では、`get-phone-number-order` を使用する方法を示しています。 **AWS CLI** **電話番号の注文の詳細を取得する方法** 次の `get-phone-number-order` の例では、指定された電話番号の注文の詳細を表示します。 ``` aws chime get-phone-number-order \ --phone-number-order-id abc12345-de67-89f0-123g-h45i678j9012 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Chime 管理ガイド*」の「[電話番号の使用方法](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPhoneNumberOrder](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-phone-number-order.html)」を参照してください。 ### `get-phone-number-settings` 次のコード例では、`get-phone-number-settings` を使用する方法を示しています。 **AWS CLI** **アウトバウンド呼び出し名を取得する方法** 次の `get-phone-number-settings` の例では、呼び出し元のユーザーの AWS アカウントのデフォルトのアウトバウンド呼び出し名を取得します。 ``` aws chime get-phone-number-settings ``` このコマンドでは何も出力されません。出力: ``` { "CallingName": "myName", "CallingNameUpdatedTimestamp": "2019-10-28T18:56:42.911Z" } ``` 詳細については、「*Amazon Chime 管理ガイド*」の「[電話番号の使用方法](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPhoneNumberSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-phone-number-settings.html)」を参照してください。 ### `get-phone-number` 次のコード例では、`get-phone-number` を使用する方法を示しています。 **AWS CLI** **電話番号の詳細を取得する方法** 次の `get-phone-number` の例では、指定された電話番号の詳細を表示します。 ``` aws chime get-phone-number \ --phone-number-id +12065550100 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Chime 管理ガイド*」の「[電話番号の使用方法](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPhoneNumber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-phone-number.html)」を参照してください。 ### `get-room` 次のコード例は、`get-room` を使用する方法を示しています。 **AWS CLI** **チャットルームの詳細を取得する方法** 次の `get-room` の例では、指定されたチャットルームの詳細を表示します。 ``` aws chime get-room \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Chime ユーザーガイド*」の「[チャットルームの作成](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRoom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-room.html)」を参照してください。 ### `get-user-settings` 次のコード例では、`get-user-settings` を使用する方法を示しています。 **AWS CLI** **ユーザー設定を取得する方法** 次の `get-user-settings` の例では、指定されたユーザー設定を表示します。 ``` aws chime get-user-settings \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --user-id 1ab2345c-67de-8901-f23g-45h678901j2k ``` 出力: ``` { "UserSettings": { "Telephony": { "InboundCalling": true, "OutboundCalling": true, "SMS": true } } } ``` 詳細については、「*Amazon Chime 管理ガイド*」の「[ユーザーの電話番号の管理](https://docs.aws.amazon.com/chime/latest/ag/user-phone.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetUserSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-user-settings.html)」を参照してください。 ### `get-user` 次のコード例では、`get-user` を使用する方法を示しています。 **AWS CLI** **ポリシーの詳細を取得する方法** 次の `get-user` の例では、指定されたユーザーの詳細を取得します。 ``` aws chime get-user \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Chime 管理ガイド*」の「[ユーザーの管理](https://docs.aws.amazon.com/chime/latest/ag/manage-users.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/get-user.html)」を参照してください。 ### `invite-users` 次のコード例は、`invite-users` を使用する方法を示しています。 **AWS CLI** **Amazon Chime に参加するようにユーザーを招待する方法** 次の `invite-users` の例では、指定された Amazon Chime アカウントにユーザーを招待する E メールを送信します。 ``` aws chime invite-users \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --user-email-list "alejandror@example.com" "janed@example.com" ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Chime 管理ガイド*」の「[ユーザーの招待と一時利用停止](https://docs.aws.amazon.com/chime/latest/ag/manage-access.html#invite-users-team)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[InviteUsers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/invite-users.html)」を参照してください。 ### `list-accounts` 次のコード例では、`list-accounts` を使用する方法を示しています。 **AWS CLI** **アカウントの一覧を取得する方法** 次の `list-accounts` の例では、管理者の AWS アカウントの Amazon Chime アカウントの一覧を取得します。 ``` aws chime list-accounts ``` 出力: ``` { "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" }, ] } ] } ``` 詳細については、「*Amazon Chime 管理ガイド*」の「[Amazon Chime アカウントの管理](https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[ListAccounts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/list-accounts.html)」を参照してください。** ### `list-bots` 次のコード例では、`list-bots` を使用する方法を示しています。 **AWS CLI** **ボットの一覧を取得する方法** 次の `list-bots` の例では、指定された Amazon Chime Enterprise アカウントに関連付けられているボットを一覧表示します。 ``` aws chime list-bots \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Chime デベロッパーガイド*」の「[Amazon Chime でチャットボットを使用する](https://docs.aws.amazon.com/chime/latest/dg/use-bots.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListBots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/list-bots.html)」を参照してください。 ### `list-phone-number-orders` 次のコード例では、`list-phone-number-orders` を使用する方法を示しています。 **AWS CLI** **電話番号の注文を一覧表示する方法** 次の `list-phone-number-orders` の例では、Amazon Chime 管理者のアカウントに関連付けられた電話番号の注文を一覧表示します。 ``` aws chime list-phone-number-orders ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Chime 管理ガイド*」の「[電話番号の使用方法](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPhoneNumberOrders](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/list-phone-number-orders.html)」を参照してください。 ### `list-phone-numbers` 次のコード例では、`list-phone-numbers` を使用する方法を示しています。 **AWS CLI** **Amazon Chime アカウントの電話番号を一覧表示する方法** 次の `list-phone-numbers` の例では、Amazon Chime アカウントに関連付けられた電話番号を一覧表示します。 ``` aws chime list-phone-numbers ``` このコマンドでは何も出力されません。出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Chime 管理ガイド*」の「[電話番号の使用方法](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPhoneNumbers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/list-phone-numbers.html)」を参照してください。 ### `list-room-memberships` 次のコード例は、`list-room-memberships` を使用する方法を示しています。 **AWS CLI** **ルームメンバーシップを一覧表示する方法** 次の `list-room-memberships` の例では、指定されたチャットルームのメンバーシップの詳細を一覧表示します。 ``` aws chime list-room-memberships \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Chime ユーザーガイド*」の「[チャットルームの作成](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRoomMemberships](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/list-room-memberships.html)」を参照してください。 ### `list-rooms` 次のコード例では、`list-rooms` を使用する方法を示しています。 **AWS CLI** **チャットルームを一覧表示する方法** 次の `list-rooms` の例では、指定されたアカウントのチャットルームを一覧表示します。一覧は、指定されたメンバーが属するチャットルームにのみフィルタリングされます。 ``` aws chime list-rooms \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --member-id 1ab2345c-67de-8901-f23g-45h678901j2k ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Chime ユーザーガイド*」の「[チャットルームの作成](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRooms](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/list-rooms.html)」を参照してください。 ### `list-users` 次のコード例では、`list-users` を使用する方法を示しています。 **AWS CLI** **アカウントのユーザーを一覧表示する方法** 次の `list-users` の例では、指定された Amazon Chime アカウントのユーザーを一覧表示します。 ``` aws chime list-users --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE ``` 出力: ``` { "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 } } ] } ``` 詳細については、「*Amazon Chime 管理ガイド*」の「[ユーザーの管理](https://docs.aws.amazon.com/chime/latest/ag/manage-users.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListUsers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/list-users.html)」を参照してください。 ### `logout-user` 次のコード例は、`logout-user` を使用する方法を示しています。 **AWS CLI** **ユーザーをログアウトさせる方法** 次の `logout-user` の例では、指定されたユーザーをログアウトさせます。 ``` aws chime logout-user \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[LogoutUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/logout-user.html)」を参照してください。 ### `regenerate-security-token` 次のコード例は、`regenerate-security-token` を使用する方法を示しています。 **AWS CLI** **セキュリティトークンを再生成する方法** 次の `regenerate-security-token` の例では、指定されたボットのセキュリティトークンを再生成します。 ``` aws chime regenerate-security-token \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --bot-id 123abcd4-5ef6-789g-0h12-34j56789012k ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Chime デベロッパーガイド*」の「[認証チャットボットのリクエスト](https://docs.aws.amazon.com/chime/latest/dg/auth-bots.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegenerateSecurityToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/regenerate-security-token.html)」を参照してください。 ### `reset-personal-pin` 次のコード例では、`reset-personal-pin` を使用する方法を示しています。 **AWS CLI** **ユーザーの個人用会議 PIN をリセットする方法** 次の `reset-personal-pin` の例では、指定されたユーザーの個人用会議 PIN をリセットします。 ``` aws chime reset-personal-pin \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Chime 管理ガイド*」の「[個人用会議 PIN の変更](https://docs.aws.amazon.com/chime/latest/ag/change-PINs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ResetPersonalPin](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/reset-personal-pin.html)」を参照してください。 ### `restore-phone-number` 次のコード例では、`restore-phone-number` を使用する方法を示しています。 **AWS CLI** **電話番号を復元する方法** 次の `restore-phone-number` の例では、指定された電話番号を削除キューから復元します。 ``` aws chime restore-phone-number \ --phone-number-id "+12065550100" ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Chime 管理ガイド*」の「[電話番号の使用方法](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RestorePhoneNumber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/restore-phone-number.html)」を参照してください。 ### `search-available-phone-numbers` 次のコード例では、`search-available-phone-numbers` を使用する方法を示しています。 **AWS CLI** **使用可能な電話番号を検索する方法** 次の `search-available-phone-numbers` の例では、使用可能な電話番号を市外局番で検索します。 ``` aws chime search-available-phone-numbers \ --area-code "206" ``` 出力: ``` { "E164PhoneNumbers": [ "+12065550100", "+12065550101", "+12065550102", "+12065550103", "+12065550104", "+12065550105", "+12065550106", "+12065550107", "+12065550108", "+12065550109", ] } ``` 詳細については、「*Amazon Chime 管理ガイド*」の「[電話番号の使用方法](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html)」を参照してください。 + API の詳細については、 「*AWS CLI コマンドリファレンス*」の「[SearchAvailablePhoneNumbers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/search-available-phone-numbers.html)」を参照してください。 ### `update-account-settings` 次のコード例では、`update-account-settings` を使用する方法を示しています。 **AWS CLI** **アカウントの設定を更新する方法** 次の `update-account-settings` の例では、指定された Amazon Chime アカウントの共有画面のリモートコントロールを無効にします。 ``` aws chime update-account-settings \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --account-settings DisableRemoteControl=true ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateAccountSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-account-settings.html)」を参照してください。 ### `update-account` 次のコード例では、`update-account` を使用する方法を示しています。 **AWS CLI** **アカウントを更新する方法** 次の `update-account` の例では、指定されたアカウント名を更新します。 ``` aws chime update-account \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --name MyAccountName ``` 出力: ``` { "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" }, ] } } ``` 詳細については、「*Amazon Chime 管理ガイド*」の「[アカウントの名前変更](https://docs.aws.amazon.com/chime/latest/ag/rename-account.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-account.html)」を参照してください。 ### `update-bot` 次のコード例では、`update-bot` を使用する方法を示しています。 **AWS CLI** **ボットを更新する方法** 次の `update-bot` の例では、指定されたボットのステータスを更新して、実行を停止します。 ``` aws chime update-bot \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --bot-id 123abcd4-5ef6-789g-0h12-34j56789012k \ --disabled ``` 出力: ``` { "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" } } ``` 詳細については、「[Amazon Chime デベロッパーガイド](https://docs.aws.amazon.com/chime/latest/dg/update-bots.html)」の「*チャットボットの更新*」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateBot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-bot.html)」を参照してください。 ### `update-global-settings` 次のコード例では、`update-global-settings` を使用する方法を示しています。 **AWS CLI** **グローバル設定を更新する方法** 次の `update-global-settings` の例では、管理者の AWS アカウントに関連付けられた Amazon Chime Business Calling および Amazon Chime Voice Connectors の通話詳細レコードの保存に使用される S3 バケットを更新します。 ``` aws chime update-global-settings \ --business-calling CdrBucket="s3bucket" \ --voice-connector CdrBucket="s3bucket" ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Chime 管理ガイド*」の「[グローバル設定の管理](https://docs.aws.amazon.com/chime/latest/ag/manage-global.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateGlobalSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-global-settings.html)」を参照してください。 ### `update-phone-number-settings` 次のコード例では、`update-phone-number-settings` を使用する方法を示しています。 **AWS CLI** **アウトバウンド呼び出し名を更新する方法** 次の `update-phone-number-settings` の例では、管理者の AWS アカウントのデフォルトのアウトバウンド呼び出し名を更新します。 ``` aws chime update-phone-number-settings \ --calling-name "myName" ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Chime 管理ガイド*」の「[電話番号の使用方法](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdatePhoneNumberSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-phone-number-settings.html)」を参照してください。 ### `update-phone-number` 次のコード例では、`update-phone-number` を使用する方法を示しています。 **AWS CLI** **例 1: 電話番号の製品タイプを更新する方法** 次の `update-phone-number` の例では、指定された電話番号の製品タイプを更新します。 ``` aws chime update-phone-number \ --phone-number-id "+12065550100" \ --product-type "BusinessCalling" ``` 出力: ``` { "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" } } ``` **例 2: 電話番号のアウトバウンド呼び出し名を更新する方法** 次の `update-phone-number` の例では、指定された電話番号のアウトバウンド呼び出し名を更新します。 aws chime update-phone-number --phone-number-id "\$112065550100" --calling-name "phonenumber2" 出力: ``` { "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" } } ``` 詳細については、「*Amazon Chime 管理ガイド*」の「[電話番号の使用方法](https://docs.aws.amazon.com/chime/latest/ag/phone-numbers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdatePhoneNumber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-phone-number.html)」を参照してください。 ### `update-room-membership` 次のコード例は、`update-room-membership` を使用する方法を示しています。 **AWS CLI** **ルームメンバーシップを更新する方法** 次の `update-room-membership` の例では、指定されたチャットルームメンバーのロールを `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 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Chime ユーザーガイド*」の「[チャットルームの作成](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateRoomMembership](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-room-membership.html)」を参照してください。 ### `update-room` 次のコード例では、`update-room` を使用する方法を示しています。 **AWS CLI** **チャットルームを更新する方法** 次の `update-room` の例では、指定されたチャットルームの名前を変更します。 ``` aws chime update-room \ --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ --room-id abcd1e2d-3e45-6789-01f2-3g45h67i890j \ --name teamRoom ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Chime ユーザーガイド*」の「[チャットルームの作成](https://docs.aws.amazon.com/chime/latest/ug/chime-chat-room.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateRoom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-room.html)」を参照してください。 ### `update-user-settings` 次のコード例では、`update-user-settings` を使用する方法を示しています。 **AWS CLI** **ユーザー設定を更新する方法** 次の `update-user-settings` の例では、指定されたユーザーがインバウンドコールとアウトバウンドコールを行い、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}" ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Chime 管理ガイド*」の「[ユーザーの電話番号の管理](https://docs.aws.amazon.com/chime/latest/ag/user-phone.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateUserSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-user-settings.html)」を参照してください。 ### `update-user` 次のコード例では、`update-user` を使用する方法を示しています。 **AWS CLI** **ユーザーの詳細を更新する方法** この例では、指定されたユーザーの指定された詳細を更新します。 コマンド: ``` aws chime update-user \ --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE \ --license-type "Basic" ``` 出力: ``` { "User": { "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/chime/update-user.html)」を参照してください。 # AWS CLI を使用した Cloud Control API の例 次のコード例では、Cloud Control API で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-resource` 次の例では、`create-resource` を使用する方法を説明しています。 **AWS CLI** **リソースを作成する方法** 次の `create-resource` の例では、ResourceExample という名前の AWS ::Kinesis::Stream リソースを作成します。保持期間は 168 時間、シャード数は 3 です。 ``` aws cloudcontrol create-resource \ --type-name AWS::Kinesis::Stream \ --desired-state "{\"Name\": \"ResourceExample\",\"RetentionPeriodHours\":168, \"ShardCount\":3}" ``` 出力: ``` { "ProgressEvent": { "EventTime": 1632506656.706, "TypeName": "AWS::Kinesis::Stream", "OperationStatus": "IN_PROGRESS", "Operation": "CREATE", "Identifier": "ResourceExample", "RequestToken": "20999d87-e304-4725-ad84-832dcbfd7fc5" } } ``` 詳細については、「*Cloud Control API ユーザーガイド*」の「[リソースの作成](https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-create.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[CreateResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudcontrol/create-resource.html)」を参照してください。** ### `delete-resource` 次の例では、`delete-resource` を使用する方法を説明しています。 **AWS CLI** **リソースを削除する方法** 次の `delete-resource` の例では、 AWS アカウントから識別子 ResourceExample を持つ AWS ::Kinesis::Stream リソースを削除します。 ``` aws cloudcontrol delete-resource \ --type-name AWS::Kinesis::Stream \ --identifier ResourceExample ``` 出力: ``` { "ProgressEvent": { "TypeName": "AWS::Kinesis::Stream", "Identifier": "ResourceExample", "RequestToken": "e48f26ff-d0f9-4ab8-a878-120db1edf111", "Operation": "DELETE", "OperationStatus": "IN_PROGRESS", "EventTime": 1632950300.14 } } ``` 詳細については、「*Cloud Control API ユーザーガイド*」の「[リソースの削除](https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudcontrol/delete-resource.html)」を参照してください。 ### `get-resource-request-status` 次の例では、`get-resource-request-status` を使用する方法を説明しています。 **AWS CLI** **リソースリクエストのステータス情報を取得する方法** 次の `get-resource-request-status` の例では、指定されたリソースリクエストに関するステータス情報を返します。 ``` aws cloudcontrol get-resource-request-status \ --request-token "e1a6b86e-46bd-41ac-bfba-001234567890" ``` 出力: ``` { "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" } } ``` 詳細については、「*Cloud Control API ユーザーガイド*」の「[リソースのオペレーションリクエストの管理](https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetResourceRequestStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudcontrol/get-resource-request-status.html)」を参照してください。 ### `get-resource` 次の例では、`get-resource` を使用する方法を説明しています。 **AWS CLI** **リソースの現在の状態を取得する方法** 次の `get-resource` の例では、ResourceExample という名前の AWS::Kinesis::Stream リソースの現在の状態を返します。 ``` aws cloudcontrol get-resource \ --type-name AWS::Kinesis::Stream \ --identifier ResourceExample ``` 出力: ``` { "TypeName": "AWS::Kinesis::Stream", "ResourceDescription": { "Identifier": "ResourceExample", "Properties": "{\"Arn\":\"arn:aws:kinesis:us-west-2:099908667365:stream/ResourceExample\",\"RetentionPeriodHours\":168,\"Name\":\"ResourceExample\",\"ShardCount\":3}" } } ``` 詳細については、「*Cloud Control API ユーザーガイド*」の「[リソースの現在の状態の読み込み](https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-read.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudcontrol/get-resource.html)」を参照してください。 ### `list-resource-requests` 次の例では、`list-resource-requests` を使用する方法を説明しています。 **AWS CLI** **アクティブなリソースオペレーションリクエストを一覧表示する方法** 次の `list-resource-requests` の例では、AWS アカウントで失敗した CREATE および UPDATE オペレーションのリソースリクエストを一覧表示します。 ``` aws cloudcontrol list-resource-requests \ --resource-request-status-filter Operations=CREATE,OperationStatuses=FAILED ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Cloud Control API ユーザーガイド*」の「[リソースのオペレーションリクエストの管理](https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListResourceRequests](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudcontrol/list-resource-requests.html)」を参照してください。 ### `list-resources` 次の例では、`list-resources` を使用する方法を説明しています。 **AWS CLI** **特定のタイプのリソースを一覧表示する方法** 次の `list-resources` の例では、 AWS アカウントでプロビジョニングされた AWS::Kinesis::Stream リソースを一覧表示します。 ``` aws cloudcontrol list-resources \ --type-name AWS::Kinesis::Stream ``` 出力: ``` { "TypeName": "AWS::Kinesis::Stream", "ResourceDescriptions": [ { "Identifier": "MyKinesisStream", "Properties": "{\"Name\":\"MyKinesisStream\"}" }, { "Identifier": "AnotherStream", "Properties": "{\"Name\":\"AnotherStream\"}" } ] } ``` 詳細については、「*Cloud Control API ユーザーガイド*」の「[リソースの検索](https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-list.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudcontrol/list-resources.html)」を参照してください。 ### `update-resource` 次の例では、`update-resource` を使用する方法を説明しています。 **AWS CLI** **既存のリソースのプロパティを更新する方法** 次の `update-resource` の例では、「ExampleLogGroup」という名前の AWS::Logs::LogGroup リソースの保持ポリシーを 90 日に更新します。 ``` aws cloudcontrol update-resource \ --type-name AWS::Logs::LogGroup \ --identifier ExampleLogGroup \ --patch-document "[{\"op\":\"replace\",\"path\":\"/RetentionInDays\",\"value\":90}]" ``` 出力: ``` { "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" } } ``` 詳細については、「*Cloud Control API ユーザーガイド*」の「[リソースの更新](https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-update.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudcontrol/update-resource.html)」を参照してください。 # AWS Cloud Map examples using AWS CLI 次のコード例では、AWS Cloud Map で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-http-namespace` 次のコード例は、`create-http-namespace` を使用する方法を示しています。 **AWS CLI** **HTTP 名前空間を作成するには** 次の `create-http-namespace` の例では、HTTP 名前空間 `example.com` を作成します。 ``` aws servicediscovery create-http-namespace \ --name example.com \ --creator-request-id example-request-id ``` 出力: ``` { "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd" } ``` オペレーションが成功したことを確認するには、`get-operation` を実行します。詳細については、「[get-operation](https://docs.aws.amazon.com/cli/latest/reference/servicediscovery/get-operation.html)」を参照してください。 名前空間の作成の詳細については、「*AWS Cloud Map Developer Guide*」の「[Creating an AWS Cloud Map namespace to group application services](https://docs.aws.amazon.com/cloud-map/latest/dg/creating-namespaces.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateHttpNamespace](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/create-http-namespace.html)」を参照してください。 ### `create-private-dns-namespace` 次のコード例は、`create-private-dns-namespace` を使用する方法を示しています。 **AWS CLI** **プライベート DNS 名前空間を作成するには** 次の `create-private-dns-namespace` の例では、プライベート DNS 名前空間を作成します。 ``` aws servicediscovery create-private-dns-namespace \ --name example.com \ --vpc vpc-1c56417b ``` 出力: ``` { "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd" } ``` オペレーションが成功したことを確認するには、`get-operation` を実行します。詳細については、「[get-operation](https://docs.aws.amazon.com/cli/latest/reference/servicediscovery/get-operation.html)」を参照してください。 詳細については、*AWS Cloud Map デベロッパーガイド*の「[名前空間の作成](https://docs.aws.amazon.com/cloud-map/latest/dg/creating-namespaces.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreatePrivateDnsNamespace](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/create-private-dns-namespace.html)」を参照してください。 ### `create-public-dns-namespace` 次のコード例は、`create-public-dns-namespace` を使用する方法を示しています。 **AWS CLI** **パブリック DNS 名前空間を作成するには** 次の `create-public-dns-namespace` の例では、パブリック DNS 名前空間 `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}} ``` 出力: ``` { "OperationId": "gv4g5meo7ndmeh4fqskygvk23d2fijwa-k9302yzd" } ``` オペレーションが成功したことを確認するには、`get-operation` を実行します。 名前空間の作成の詳細については、「*AWS Cloud Map Developer Guide*」の「[Creating an AWS Cloud Map namespace to group application services](https://docs.aws.amazon.com/cloud-map/latest/dg/creating-namespaces.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreatePublicDnsNamespace](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/create-public-dns-namespace.html)」を参照してください。 ### `create-service` 次の例は、`create-service` を使用する方法を説明しています。 **AWS CLI** **例 1: 名前空間 ID を使用してサービスを作成するには** 次の `create-service` の例では、サービスを作成します。 ``` aws servicediscovery create-service \ --name myservice \ --namespace-id ns-ylexjili4cdxy3xm \ --dns-config "RoutingPolicy=MULTIVALUE,DnsRecords=[{Type=A,TTL=60}]" ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Cloud Map デベロッパーガイド*」の「[アプリケーションコンポーネントの AWS Cloud Map サービスを作成する](https://docs.aws.amazon.com/cloud-map/latest/dg/creating-services.html)」を参照してください。 **例 2: 名前空間 ARN を使用してサービスを作成するには** 次の `create-service` の例では、名前空間 ID の代わりに名前空間 ARN を使用してサービスを作成します。共有名前空間でサービスを作成するときは、名前空間 ARN を指定する必要があります。 ``` 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}]" ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Cloud Map デベロッパーガイド*」の「[共有 AWS Cloud Map 名前空間](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[CreateService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/create-service.html)」を参照してください。** ### `delete-namespace` 次の例は、`delete-namespace` を使用する方法を説明しています。 **AWS CLI** **例 1: 名前空間を削除するには** 次の `delete-namespace` の例では、名前空間を削除します。 ``` aws servicediscovery delete-namespace \ --id ns-abcd1234xmpl5678 ``` 出力: ``` { "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" } ``` オペレーションが成功したことを確認するには、`get-operation` を実行します。詳細については、「[get-operation](https://docs.aws.amazon.com/cli/latest/reference/servicediscovery/get-operation.html)」を参照してください。 詳細については、「*AWS Cloud Map デベロッパーガイド*」の「[AWS Cloud Map 名前空間の削除](https://docs.aws.amazon.com/cloud-map/latest/dg/deleting-namespaces.html)」を参照してください。 **例 2: 名前空間 ARN を使用して名前空間を削除するには** 次の `delete-namespace` の例では、ARN を使用して名前空間を削除します。 ``` aws servicediscovery delete-namespace \ --id arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-abcd1234xmpl5678 ``` 出力: ``` { "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" } ``` 詳細については、「*AWS Cloud Map デベロッパーガイド*」の「[AWS Cloud Map 名前空間の削除](https://docs.aws.amazon.com/cloud-map/latest/dg/deleting-namespaces.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteNamespace](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/delete-namespace.html)」を参照してください。 ### `delete-service-attributes` 次の例は、`delete-service-attributes` を使用する方法を説明しています。 **AWS CLI** **例 1: サービス属性を削除するには** 次の `delete-service-attributes` の例では、指定されたサービスに関連付けられているキー `Port` を持つサービス属性を削除します。 ``` aws servicediscovery delete-service-attributes \ --service-id srv-abcd1234xmpl5678 \ --attributes Port ``` このコマンドでは何も出力されません。 詳細については、「*AWS Cloud Map Developer Guide*」の「[AWS Cloud Map services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html)」を参照してください。 **例 2: ARN を使用してサービス属性を削除するには** 次の `delete-service-attributes` の例では、サービス ARN を使用してサービス属性を削除します。アカウントと共有されている名前空間で作成されたサービスに関連付けられた属性を削除するには、ARN を指定する必要があります。 ``` aws servicediscovery delete-service-attributes \ --service-id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678 \ --attributes Port ``` このコマンドでは何も出力されません。 詳細については、「*AWS Cloud Map デベロッパーガイド*」の「[AWS Cloud Map サービス](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html)」および「[共有 AWS Cloud Map 名前空間](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteServiceAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/delete-service-attributes.html)」を参照してください。 ### `delete-service` 次の例は、`delete-service` を使用する方法を説明しています。 **AWS CLI** **例 1: サービスを削除するには** 次の `delete-service` の例では、サービスを削除します。 ``` aws servicediscovery delete-service \ --id srv-abcd1234xmpl5678 ``` このコマンドでは何も出力されません。 詳細については、「*AWS Cloud Map デベロッパーガイド*」の「[AWS Cloud Map サービスの削除](https://docs.aws.amazon.com/cloud-map/latest/dg/deleting-services.html)」を参照してください。 **例 2: ARN を使用してサービスを削除するには** 次の `delete-service` の例では、ARN を使用してサービスを削除します。 ``` aws servicediscovery delete-service \ --id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678 ``` このコマンドでは何も出力されません。 詳細については、「*AWS Cloud Map デベロッパーガイド*」の「[AWS Cloud Map サービスの削除](https://docs.aws.amazon.com/cloud-map/latest/dg/deleting-services.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/delete-service.html)」を参照してください。 ### `deregister-instance` 次の例は、`deregister-instance` を使用する方法を説明しています。 **AWS CLI** **例 1: サービスインスタンスの登録を解除するには** 次の `deregister-instance` の例では、サービスインスタンスの登録を解除します。 ``` aws servicediscovery deregister-instance \ --service-id srv-p5zdwlg5uvvzjita \ --instance-id myservice-53 ``` 出力: ``` { "OperationId": "4yejorelbukcjzpnr6tlmrghsjwpngf4-k98rnaiq" } ``` オペレーションが成功したことを確認するには、`get-operation` を実行します。詳細については、「[get-operation](https://docs.aws.amazon.com/cli/latest/reference/servicediscovery/get-operation.html)」を参照してください。 詳細については、「*AWS Cloud Map デベロッパーガイド*」の「[サービスインスタンスの登録解除](https://docs.aws.amazon.com/cloud-map/latest/dg/deregistering-instances.html)」を参照してください。 **例 2: 共有名前空間のサービス ARN を使用してサービスインスタンスの登録を解除するには** 次の `deregister-instance` の例では、サービス ID の代わりにサービス ARN を使用してサービスインスタンスの登録を解除します。アカウントと共有されている名前空間で作成されたサービスからインスタンスを登録解除するには、ARN を指定する必要があります。 ``` aws servicediscovery deregister-instance \ --service-id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita \ --instance-id web-server-01 ``` 出力: ``` { "OperationId": "gv4g5meo7ndmkqjrhpn39wk42xmpl" } ``` 詳細については、「*AWS Cloud Map デベロッパーガイド*」の「[共有 AWS Cloud Map 名前空間](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html)」と「[AWS Cloud Map サービスインスタンスの登録を解除する](https://docs.aws.amazon.com/cloud-map/latest/dg/deregistering-instances.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeregisterInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/deregister-instance.html)」を参照してください。 ### `discover-instances-revision` 次の例は、`discover-instances-revision` を使用する方法を説明しています。 **AWS CLI** **例 1: インスタンスのリビジョンを検出するには** 次の `discover-instances-revision` の例では、インスタンスのリビジョンの増加を検出します。 ``` aws servicediscovery discover-instances-revision \ --namespace-name example.com \ --service-name myservice ``` 出力: ``` { "InstancesRevision": 123456 } ``` 詳細については、「*AWS Cloud Map Developer Guide*」の「[AWS Cloud Map service instances](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-instances.html)」を参照してください。 **例 2: 特定の所有者アカウントからインスタンスのリビジョンを検出するには** 次の `discover-instances-revision` の例では、特定の所有者アカウントからのインスタンスのリビジョンを検出します。owner-account パラメータは、アカウントと共有されている名前空間内のインスタンスに必要です。 ``` aws servicediscovery discover-instances-revision \ --namespace-name shared-namespace \ --service-name shared-service \ --owner-account 123456789111 ``` 出力: ``` { "InstancesRevision": 1234567890 } ``` 詳細については、「*AWS Cloud Map デベロッパーガイド*」の「[共有 AWS Cloud Map 名前空間](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html)」と「[AWS Cloud Map サービスインスタンス](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-instances.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DiscoverInstancesRevision](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/discover-instances-revision.html)」を参照してください。 ### `discover-instances` 次の例は、`discover-instances` を使用する方法を説明しています。 **AWS CLI** **例 1: 登録済みインスタンスを検出するには** 次の `discover-instances` の例では、登録済みインスタンスを検出します。 ``` aws servicediscovery discover-instances \ --namespace-name example.com \ --service-name myservice \ --max-results 10 \ --health-status ALL ``` 出力: ``` { "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 } ``` 詳細については、「*AWS Cloud Map Developer Guide*」の「[AWS Cloud Map service instances](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-instances.html)」を参照してください。 **例 2: 特定の所有者アカウントからインスタンスを検出するには** 次の `discover-instances` の例では、特定の所有者アカウントから登録されたインスタンスを検出します。このパラメータは、アカウントと共有されている名前空間内のインスタンスを検出するために必要です。 ``` aws servicediscovery discover-instances \ --namespace-name shared-namespace \ --service-name shared-service \ --owner-account 123456789111 ``` 出力: ``` { "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 } ``` 詳細については、「*AWS Cloud Map デベロッパーガイド*」の「[共有 AWS Cloud Map 名前空間](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html)」と「[AWS Cloud Map サービスインスタンス](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-instances.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DiscoverInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/discover-instances.html)」を参照してください。 ### `get-instance` 次の例は、`get-instance` を使用する方法を説明しています。 **AWS CLI** **例 1: インスタンスの詳細を取得するには** 次の `get-instance` の例では、サービスの属性を取得します。 ``` aws servicediscovery get-instance \ --service-id srv-e4anhexample0004 --instance-id i-abcd1234 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Cloud Map Developer Guide*」の「[AWS Cloud Map service instances](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-instances.html)」を参照してください。 **例 2: 共有名前空間のサービス ARN を使用してインスタンスの詳細を取得するには** 次の `get-instance` の例では、サービス ID の代わりにサービス ARN を使用してインスタンスの属性を取得します。アカウントと共有されている名前空間に関連付けられたインスタンスの詳細を取得するには、ARN を指定する必要があります。この例で返されたインスタンスは、アカウント `123456789012` が所有する名前空間にアカウント `123456789111` によって登録されました。 ``` aws servicediscovery get-instance \ --service-id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita \ --instance-id web-server-01 ``` 出力: ``` { "ResourceOwner": "123456789012", "Instance": { "Id": "web-server-01", "Attributes": { "AWS_INSTANCE_IPV4": "203.0.113.15", "AWS_INSTANCE_PORT": "80" }, "CreatedByAccount": "123456789111" } } ``` クロスアカウント名前空間の共有の詳細については、「*AWS Cloud Map デベロッパーガイド*」の「[共有 AWS Cloud Map 名前空間](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/get-instance.html)」を参照してください。 ### `get-instances-health-status` 次の例は、`get-instances-health-status` を使用する方法を説明しています。 **AWS CLI** **例 1: サービスに関連付けられているインスタンスのヘルスステータスを取得するには** 次の `get-instances-health-status` の例では、指定されたサービスに関連付けられているインスタンスのヘルスステータスを取得します。 ``` aws servicediscovery get-instances-health-status \ --service-id srv-e4anhexample0004 ``` 出力: ``` { "Status": { "i-abcd1234": "HEALTHY", "i-abcd1235": "UNHEALTHY" } } ``` 詳細については、「*AWS Cloud Map Developer Guide*」の「[AWS Cloud Map service instances](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-instances.html)」を参照してください。 **例 2: 共有名前空間のサービス ARN を使用してインスタンスのヘルスステータスを取得するには** 次の `get-instances-health-status` の例では、サービス ID の代わりにサービス ARN を使用してインスタンスのヘルスステータスを取得します。リクエスタのアカウントと共有されている名前空間に関連付けられたインスタンスのヘルスステータスを取得するには、ARN を指定する必要があります。 ``` aws servicediscovery get-instances-health-status \ --service-id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita ``` 出力: ``` { "Status": { "web-server-01": "HEALTHY", "web-server-02": "UNHEALTHY" } } ``` 詳細については、「*AWS Cloud Map デベロッパーガイド*」の「[AWS Cloud Map サービスインスタンス](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-instances.html)」と「[共有 AWS Cloud Map 名前空間](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetInstancesHealthStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/get-instances-health-status.html)」を参照してください。 ### `get-namespace` 次の例は、`get-namespace` を使用する方法を説明しています。 **AWS CLI** **例 1: 名前空間の詳細を取得するには** 次の `get-namespace` の例では、指定された名前空間に関する情報を取得します。 ``` aws servicediscovery get-namespace \ --id ns-abcd1234xmpl5678 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Cloud Map Developer Guide*」の「[AWS Cloud Map namespaces](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-namespaces.html)」を参照してください。 **例 2: ARN を使用して名前空間の詳細を取得するには** 次の `get-namespace` の例では、ARN を使用して指定された名前空間に関する情報を取得します。アカウントと共有されている名前空間の詳細を取得するには、ARN を指定する必要があります。 ``` aws servicediscovery get-namespace \ --id arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-abcd1234xmpl5678 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Cloud Map デベロッパーガイド*」の「[共有 AWS Cloud Map 名前空間](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetNamespace](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/get-namespace.html)」を参照してください。 ### `get-operation` 次の例は、`get-operation` を使用する方法を説明しています。 **AWS CLI** **例 1: オペレーションの結果を取得するには** 次の `get-operation` の例では、名前空間の作成オペレーションの結果を取得します。 ``` aws servicediscovery get-operation \ --operation-id abcd1234xmpl5678abcd1234xmpl5678-abcd1234 ``` 出力: ``` { "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" } } } ``` 詳細については、「*AWS Cloud Map Developer Guide*」の「[Creating an AWS Cloud Map namespace to group application services](https://docs.aws.amazon.com/cloud-map/latest/dg/creating-namespaces.html)」を参照してください。 **例 2: 特定の所有者アカウントからオペレーションを取得するには** 次の `get-operation` の例では、特定の名前空間所有者アカウントに関連付けられたオペレーションの結果を取得します。このパラメータは、アカウントと共有されている名前空間に関連付けられたオペレーションの結果を取得するために必要です。 ``` aws servicediscovery get-operation \ --operation-id abcd1234xmpl5678abcd1234xmpl5678-abcd1234 \ --owner-account 123456789111 ``` 出力: ``` { "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" } } } ``` 詳細については、「*AWS Cloud Map デベロッパーガイド*」の「[共有 AWS Cloud Map 名前空間](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetOperation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/get-operation.html)」を参照してください。 ### `get-service-attributes` 次の例は、`get-service-attributes` を使用する方法を説明しています。 **AWS CLI** **例 1: サービスの属性を取得するには** 次の `get-service-attributes` の例では、サービスの属性を取得します。 ``` aws servicediscovery get-service-attributes \ --service-id srv-abcd1234xmpl5678 ``` 出力: ``` { "ServiceAttributes": { "ServiceArn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678", "ResourceOwner": "123456789012", "Attributes": { "Port": "80" } } } ``` 詳細については、「*AWS Cloud Map Developer Guide*」の「[AWS Cloud Map services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html)」を参照してください。 **例 2: ARN を使用してサービスの属性を取得するには** 次の `get-service-attributes` の例では、ARN を使用してサービスの属性を取得します。アカウントと共有されている名前空間で作成されたサービスの属性を取得するには、ARN を指定する必要があります。 ``` aws servicediscovery get-service-attributes \ --service-id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678 ``` 出力: ``` { "ServiceAttributes": { "ServiceArn": "arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678", "ResourceOwner": "123456789012", "Attributes": { "Port": "80" } } } ``` 詳細については、「*AWS Cloud Map デベロッパーガイド*」の「[AWS Cloud Map サービス](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html)」および「[共有 AWS Cloud Map 名前空間](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetServiceAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/get-service-attributes.html)」を参照してください。 ### `get-service` 次の例は、`get-service` を使用する方法を説明しています。 **AWS CLI** **例 1: サービスの設定を取得するには** 次の `get-service` の例では、指定されたサービスの設定を取得します。 ``` aws servicediscovery get-service \ --id srv-abcd1234xmpl5678 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Cloud Map Developer Guide*」の「[AWS Cloud Map services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html)」を参照してください。 **例 2: ARN を使用してサービスの設定を取得するには** 次の `get-service` の例では、ARN を使用して指定されたサービスの設定を取得します。ARN の指定は、アカウントと共有されている名前空間で作成されたサービスに関する情報を取得するときに必要です。発信者アカウント `123456789111` は、アカウント `123456789012` によって共有されている名前空間にサービスを作成しました。 ``` aws servicediscovery get-service \ --id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Cloud Map デベロッパーガイド*」の「[アプリケーションコンポーネントの AWS Cloud Map サービスを作成する](https://docs.aws.amazon.com/cloud-map/latest/dg/creating-services.html)」および「[共有 AWS Cloud Map 名前空間](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/get-service.html)」を参照してください。 ### `list-instances` 次の例は、`list-instances` を使用する方法を説明しています。 **AWS CLI** **例 1: サービスインスタンスを一覧表示するには** 次の `list-instances` の例では、サービスインスタンスを一覧表示します。 ``` aws servicediscovery list-instances \ --service-id srv-qzpwvt2tfqcegapy ``` 出力: ``` { "Instances": [ { "Id": "i-06bdabbae60f65a4e", "Attributes": { "AWS_INSTANCE_IPV4": "172.2.1.3", "AWS_INSTANCE_PORT": "808" }, "CreatedByAccount": "123456789012" } ], "ResourceOwner": "123456789012" } ``` 詳細については、「*AWS Cloud Map デベロッパーガイド*」の「[AWS Cloud Map サービスインスタンス](https://docs.aws.amazon.com/cloud-map/latest/dg/listing-instances.html)」を参照してください。 **例 2: サービス ARN を使用してサービスインスタンスを一覧表示するには** 次の `list-instances` の例では、サービス ID の代わりにサービス ARN を使用するサービスインスタンスを一覧表示します。アカウントと共有されている名前空間に関連付けられたインスタンスを一覧表示するには、ARN の指定が必要です。 ``` aws servicediscovery list-instances \ --service-id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-p5zdwlg5uvvzjita ``` 出力: ``` { "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" } ] } ``` クロスアカウント名前空間の共有の詳細については、「*AWS Cloud Map デベロッパーガイド*」の「[共有 AWS Cloud Map 名前空間](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html)」と「[AWS Cloud Map サービスインスタンスの一覧表示](https://docs.aws.amazon.com/cloud-map/latest/dg/listing-instances.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/list-instances.html)」を参照してください。 ### `list-namespaces` 次の例は、`list-namespaces` を使用する方法を説明しています。 **AWS CLI** **例 1: 名前空間を一覧表示するには** 次の `list-namespaces` の例では、名前空間を一覧表示します。 ``` aws servicediscovery list-namespaces ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS Cloud Map デベロッパーガイド*」の「[AWS Cloud Map 名前空間の一覧表示](https://docs.aws.amazon.com/cloud-map/latest/dg/listing-namespaces.html)」を参照してください。 **例 2: 他のアカウントで共有されている名前空間を一覧表示するには** 次の `list-namespaces` の例では、`RESOURCE_OWNER` フィルターを使用して他の AWS アカウントによって発信者アカウントと共有されている名前空間を一覧表示します。 ``` aws servicediscovery list-namespaces \ --filters Name=RESOURCE_OWNER,Values=OTHER_ACCOUNTS,Condition=EQ ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS Cloud Map デベロッパーガイド*」の「[共有 AWS Cloud Map 名前空間](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListNamespaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/list-namespaces.html)」を参照してください。 ### `list-operations` 次のコード例は、`list-operations` を使用する方法を示しています。 **AWS CLI** **指定された条件を満たすオペレーションを一覧表示するには** 次の `list-operations` の例では、ステータスが `PENDING` または `SUCCESS` のオペレーションを一覧表示します。 ``` aws servicediscovery list-operations \ --service-id srv-e4anhexample0004 \ --filters Name=STATUS,Condition=IN,Values=PENDING,SUCCESS ``` 出力: ``` { "Operations": [ { "Id": "76yy8ovhpdz0plmjzbsnqgnrqvpv2qdt-kexample", "Status": "SUCCESS" }, { "Id": "prysnyzpji3u2ciy45nke83x2zanl7yk-dexample", "Status": "SUCCESS" }, { "Id": "ko4ekftir7kzlbechsh7xvcdgcpk66gh-7example", "Status": "PENDING" } ] } ``` 詳細については、「*AWS Cloud Map Developer Guide*」の「[What is AWS Cloud Map?](https://docs.aws.amazon.com/cloud-map/latest/dg/what-is-cloud-map.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListOperations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/list-operations.html)」を参照してください。 ### `list-services` 次の例は、`list-services` を使用する方法を説明しています。 **AWS CLI** **例 1: サービスを一覧表示するには** 次の `list-services` の例では、サービスを一覧表示します。 ``` aws servicediscovery list-services ``` 出力: ``` { "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 } ] } ``` 詳細については、「*AWS Cloud Map デベロッパーガイド*」の「[名前空間における AWS Cloud Map サービス](https://docs.aws.amazon.com/cloud-map/latest/dg/listing-services.html)」を参照してください。 **例 2: 共有名前空間で作成されたサービスを一覧表示するには** 次の `list-services` の例では、`RESOURCE_OWNER` フィルターを使用して他の AWS アカウントによって発信者アカウント `123456789012` と共有されている名前空間で作成されたサービスを一覧表示します。 ``` aws servicediscovery list-services \ --filters Name=RESOURCE_OWNER,Values=OTHER_ACCOUNTS,Condition=EQ ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS Cloud Map デベロッパーガイド*」の「[共有 AWS Cloud Map 名前空間](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html)」と「[名前空間における AWS Cloud Map サービスの一覧表示](https://docs.aws.amazon.com/cloud-map/latest/dg/listing-services.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[ListServices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/list-services.html)」を参照してください。** ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **指定されたリソースに関連付けられているタグを一覧表示するには** 次の `list-tags-for-resource` の例では、指定されたリソースのタグを一覧表示します。 ``` aws servicediscovery list-tags-for-resource \ --resource-arn arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-e4anhexample0004 ``` 出力: ``` { "Tags": [ { "Key": "Project", "Value": "Zeta" }, { "Key": "Department", "Value": "Engineering" } ] } ``` 詳細については、「*AWS Cloud Map Developer Guide*」の「[Tagging your AWS Cloud Map resources](https://docs.aws.amazon.com/cloud-map/latest/dg/listing-instances.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/list-tags-for-resource.html)」を参照してください。 ### `register-instance` 次の例は、`register-instance` を使用する方法を説明しています。 **AWS CLI** **例 1: サービス ID を使用してサービスインスタンスを登録するには** 次の `register-instance` の例では、サービスインスタンスを登録します。 ``` aws servicediscovery register-instance \ --service-id srv-p5zdwlg5uvvzjita \ --instance-id myservice-53 \ --attributes=AWS_INSTANCE_IPV4=172.2.1.3,AWS_INSTANCE_PORT=808 ``` 出力: ``` { "OperationId": "4yejorelbukcjzpnr6tlmrghsjwpngf4-k95yg2u7" } ``` オペレーションが成功したことを確認するには、`get-operation` を実行します。詳細については、「[get-operation](https://docs.aws.amazon.com/cli/latest/reference/servicediscovery/get-operation.html)」を参照してください。 インスタンスの登録の詳細については、「*AWS Cloud Map デベロッパーガイド*」の「[AWS Cloud Map サービスインスタンスとしてリソースを登録する](https://docs.aws.amazon.com/cloud-map/latest/dg/registering-instances.html)」を参照してください。 **例 2: サービス ARN を使用してサービスインスタンスを登録するには** 次の `register-instance` の例では、サービス ARN を使用してサービスインスタンスを登録します。アカウントと共有されているサービスにインスタンスを登録する場合は、ARN の指定が必要です。 ``` 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 ``` 出力: ``` { "OperationId": "gv4g5meo7ndmkqjrhpn39wk42xmpl" } ``` クロスアカウント名前空間の共有の詳細については、「*AWS Cloud Map デベロッパーガイド*」の「[共有 AWS Cloud Map 名前空間](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegisterInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/register-instance.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **指定されたリソースにタグを関連付けるには** 次の `tag-resource` の例では、指定された名前空間に値 `Engineering` を持つ `Department` タグを関連付けます。 ``` aws servicediscovery tag-resource \ --resource-arn arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-e4anhexample0004 \ --tags Key=Department, Value=Engineering ``` このコマンドでは何も出力されません。 詳細については、「*AWS Cloud Map Developer Guide*」の「[Tagging your AWS Cloud Map resources](https://docs.aws.amazon.com/cloud-map/latest/dg/listing-instances.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **指定されたリソースからタグを削除するには** 次の `untag-resource` の例では、指定された名前空間から `Department` タグを削除します。 ``` aws servicediscovery untag-resource \ --resource-arn arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-e4anhexample0004 \ --tags Key=Department, Value=Engineering ``` このコマンドでは何も出力されません。 詳細については、「*AWS Cloud Map Developer Guide*」の「[Tagging your AWS Cloud Map resources](https://docs.aws.amazon.com/cloud-map/latest/dg/listing-instances.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/untag-resource.html)」を参照してください。 ### `update-http-namespace` 次の例は、`update-http-namespace` を使用する方法を説明しています。 **AWS CLI** **例 1: HTTP 名前空間を更新するには** 次の `update-http-namespace` の例では、指定された HTTP 名前空間の説明を更新します。 ``` aws servicediscovery update-http-namespace \ --id ns-abcd1234xmpl5678 \ --updater-request-id abcd1234-5678-90ab-cdef-xmpl12345678 \ --namespace Description="The updated namespace description." ``` 出力: ``` { "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" } ``` オペレーションが成功したことを確認するには、`get-operation` を実行します。詳細については、「[get-operation](https://docs.aws.amazon.com/cli/latest/reference/servicediscovery/get-operation.html)」を参照してください。 詳細については、「*AWS Cloud Map Developer Guide*」の「[AWS Cloud Map namespaces](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-namespaces.html)」を参照してください。 **例 2: ARN を使用して HTTP 名前空間を更新するには** 次の `update-http-namespace` の例では、ARN を使用して指定された HTTP 名前空間の説明を更新します。 ``` 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." ``` 出力: ``` { "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" } ``` 詳細については、「*AWS Cloud Map Developer Guide*」の「[AWS Cloud Map namespaces](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-namespaces.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateHttpNamespace](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/update-http-namespace.html)」を参照してください。 ### `update-instance-custom-health-status` 次の例は、`update-instance-custom-health-status` を使用する方法を説明しています。 **AWS CLI** **例 1: カスタムヘルスチェックを更新するには** 次の `update-instance-custom-health-status` の例では、指定されたサービスおよびサンプルサービスインスタンスのカスタムヘルスチェックのステータスを `HEALTHY` に更新します。 ``` aws servicediscovery update-instance-custom-health-status \ --service-id srv-e4anhexample0004 \ --instance-id example \ --status HEALTHY ``` このコマンドでは何も出力されません。 詳細については、「*AWS Cloud Map Developer Guide*」の「[AWS Cloud Map service health check configuration](https://docs.aws.amazon.com/cloud-map/latest/dg/services-health-checks.html)」を参照してください。 **例 2: サービス ARN を使用してカスタムヘルスチェックを更新するには** 次の `update-instance-custom-health-status` の例では、サービス ARN を使用してカスタムヘルスチェックのステータスを更新します。ARN は、アカウントと共有されている名前空間に関連付けられたインスタンスのヘルスステータスを更新するときに必要です。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*AWS Cloud Map デベロッパーガイド*」の「[AWS Cloud Map サービスヘルスチェック設定](https://docs.aws.amazon.com/cloud-map/latest/dg/services-health-checks.html)」および「[クロスアカウント AWS Cloud Map 名前空間の共有](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateInstanceCustomHealthStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/update-instance-custom-health-status.html)」を参照してください。 ### `update-private-dns-namespace` 次の例は、`update-private-dns-namespace` を使用する方法を説明しています。 **AWS CLI** **例 1: ID を使用してプライベート DNS 名前空間を更新するには** 次の `update-private-dns-namespace` の例では、名前空間 ID を使用してプライベート DNS 名前空間の説明を更新します。 ``` aws servicediscovery update-private-dns-namespace \ --id ns-abcd1234xmpl5678 \ --updater-request-id abcd1234-5678-90ab-cdef-xmpl12345678 \ --namespace Description="The updated namespace description." ``` 出力: ``` { "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" } ``` オペレーションが成功したことを確認するには、`get-operation` を実行します。 詳細については、「*AWS Cloud Map Developer Guide*」の「[AWS Cloud Map namespaces](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-namespaces.html)」を参照してください。 **例 2: ARN を使用してプライベート DNS 名前空間を更新するには** 次の `update-private-dns-namespace` の例では、ARN を使用してプライベート DNS 名前空間を更新します。 ``` 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." ``` 出力: ``` { "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" } ``` 詳細については、「*AWS Cloud Map Developer Guide*」の「[AWS Cloud Map namespaces](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-namespaces.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdatePrivateDnsNamespace](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/update-private-dns-namespace.html)」を参照してください。 ### `update-public-dns-namespace` 次の例は、`update-public-dns-namespace` を使用する方法を説明しています。 **AWS CLI** **例 1: ID を使用してパブリック DNS 名前空間を更新するには** 次の `update-public-dns-namespace` の例では、名前空間 ID を使用してパブリック DNS 名前空間の説明を更新します。 ``` aws servicediscovery update-public-dns-namespace \ --id ns-abcd1234xmpl5678 \ --updater-request-id abcd1234-5678-90ab-cdef-xmpl12345678 \ --namespace Description="The updated namespace description." ``` 出力: ``` { "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" } ``` オペレーションが成功したことを確認するには、`get-operation` を実行します。 詳細については、「*AWS Cloud Map Developer Guide*」の「[AWS Cloud Map namespaces](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-namespaces.html)」を参照してください。 **例 2: ARN を使用してパブリック DNS 名前空間を更新するには** 次の `update-public-dns-namespace` の例では、ARN を使用してパブリック DNS 名前空間を更新します。 ``` 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." ``` 出力: ``` { "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" } ``` 詳細については、「*AWS Cloud Map Developer Guide*」の「[AWS Cloud Map namespaces](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-namespaces.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdatePublicDnsNamespace](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/update-public-dns-namespace.html)」を参照してください。 ### `update-service-attributes` 次の例は、`update-service-attributes` を使用する方法を説明しています。 **AWS CLI** **例 1: サービスを更新して属性を追加するには** 次の `update-service-attributes` の例では、指定されたサービスを更新して、キー `Port` と値 `80` を持つサービス属性を追加します。 ``` aws servicediscovery update-service-attributes \ --service-id srv-abcd1234xmpl5678 \ --attributes Port=80 ``` このコマンドでは何も出力されません。 詳細については、「*AWS Cloud Map Developer Guide*」の「[AWS Cloud Map services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html)」を参照してください。 **例 2: ARN を使用してサービス属性を更新するには** 次の `update-service-attributes` の例では、ARN を使用してサービスを更新し、サービス属性を追加します。アカウントと共有されている名前空間で作成されたサービスに属性を追加するには、ARN を指定する必要があります。 ``` aws servicediscovery update-service-attributes \ --service-id arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678 \ --attributes Port=80 ``` このコマンドでは何も出力されません。 詳細については、「*AWS Cloud Map デベロッパーガイド*」の「[AWS Cloud Map サービス](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html)」および「[共有 AWS Cloud Map 名前空間](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateServiceAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/update-service-attributes.html)」を参照してください。 ### `update-service` 次の例は、`update-service` を使用する方法を説明しています。 **AWS CLI** **例 1: サービスを更新するには** 次の `update-service` の例では、 サービスを更新して `DnsConfig` および `HealthCheckConfig` 設定を更新します。 ``` aws servicediscovery update-service \ --id srv-abcd1234xmpl5678 \ --service "DnsConfig={DnsRecords=[{Type=A,TTL=60}]},HealthCheckConfig={Type=HTTP,ResourcePath=/,FailureThreshold=2}" ``` 出力: ``` { "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" } ``` オペレーションが成功したことを確認するには、`get-operation` を実行します。 サービスの更新の詳細については、「*AWS Cloud Map Developer Guide*」の「[Updating an AWS Cloud Map service](https://docs.aws.amazon.com/cloud-map/latest/dg/editing-services.html)」を参照してください。 **例 2: ARN を使用してサービスを更新するには** 次の `update-service` の例では、ARN を使用してサービスを更新します。アカウントと共有されている名前空間で作成されるサービスには、ARN を指定する必要があります。 ``` 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}" ``` 出力: ``` { "OperationId": "abcd1234-5678-90ab-cdef-xmpl12345678" } ``` 詳細については、「*AWS Cloud Map デベロッパーガイド*」の「[AWS Cloud Map サービスのアップデート](https://docs.aws.amazon.com/cloud-map/latest/dg/editing-services.html)」と「[共有 AWS Cloud Map 名前空間](https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[UpdateService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/servicediscovery/update-service.html)」を参照してください。** # AWS Cloud9 examples using AWS CLI 次のコード例では、AWS Cloud9 で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-environment-ec2` 次のコード例では、`create-environment-ec2` を使用する方法を示しています。 **AWS CLI** **AWS Cloud9 EC2 開発環境を作成する方法** 次の `create-environment-ec2` の例では、指定された設定で AWS Cloud9 開発環境を作成し、Amazon Elastic Compute Cloud (Amazon EC2) インスタンスを起動し、インスタンスから環境に接続します。 ``` 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 ``` 出力: ``` { "environmentId": "8a34f51ce1e04a08882f1e811bd706EX" } ``` 詳細については、「*AWS Cloud9 ユーザーガイド*」の「[EC2 環境の作成](https://docs.aws.amazon.com/cloud9/latest/user-guide/create-environment-main.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateEnvironmentEc2](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloud9/create-environment-ec2.html)」を参照してください。 ### `create-environment-membership` 次のコード例では、`create-environment-membership` を使用する方法を示しています。 **AWS CLI** **環境メンバーを AWS Cloud9 開発環境に追加する方法** この例では、指定された環境メンバーを指定された AWS Cloud9 開発環境に追加します。 コマンド: ``` aws cloud9 create-environment-membership --environment-id 8a34f51ce1e04a08882f1e811bd706EX --user-arn arn:aws:iam::123456789012:user/AnotherDemoUser --permissions read-write ``` 出力: ``` { "membership": { "environmentId": "8a34f51ce1e04a08882f1e811bd706EX", "userId": "AIDAJ3LOROMOUXTBSU6EX", "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser", "permissions": "read-write" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateEnvironmentMembership](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloud9/create-environment-membership.html)」を参照してください。 ### `delete-environment-membership` 次のコード例では、`delete-environment-membership` を使用する方法を示しています。 **AWS CLI** **環境メンバーを AWS Cloud9 開発環境から削除する方法** この例では、指定された環境メンバーを指定された AWS Cloud9 開発環境に削除します。 コマンド: ``` aws cloud9 delete-environment-membership --environment-id 8a34f51ce1e04a08882f1e811bd706EX --user-arn arn:aws:iam::123456789012:user/AnotherDemoUser ``` 出力: ``` None. ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteEnvironmentMembership](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloud9/delete-environment-membership.html)」を参照してください。 ### `delete-environment` 次のコード例では、`delete-environment` を使用する方法を示しています。 **AWS CLI** **AWS Cloud9 開発環境を削除する方法** この例では、指定された AWS Cloud9 開発環境を削除します。環境が Amazon EC2 インスタンスに接続されている場合、インスタンスを終了します。 コマンド: ``` aws cloud9 delete-environment --environment-id 8a34f51ce1e04a08882f1e811bd706EX ``` 出力: ``` None. ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloud9/delete-environment.html)」を参照してください。 ### `describe-environment-memberships` 次のコード例では、`describe-environment-memberships` を使用する方法を示しています。 **AWS CLI** **AWS Cloud9 開発環境の環境メンバーに関する情報を取得します。** この例では、指定された AWS Cloud9 開発環境の環境メンバーに関する情報を取得します。 コマンド: ``` aws cloud9 describe-environment-memberships --environment-id 8a34f51ce1e04a08882f1e811bd706EX ``` 出力: ``` { "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" } ] } ``` **AWS Cloud9 開発環境の所有者に関する情報を取得する方法** この例では、指定された AWS Cloud9 開発環境の所有者に関する情報を取得します。 コマンド: ``` aws cloud9 describe-environment-memberships --environment-id 8a34f51ce1e04a08882f1e811bd706EX --permissions owner ``` 出力: ``` { "memberships": [ { "environmentId": "8a34f51ce1e04a08882f1e811bd706EX", "userId": "AIDAJNUEDQAQWFELJDLEX", "userArn": "arn:aws:iam::123456789012:user/MyDemoUser", "permissions": "owner" } ] } ``` **複数の AWS Cloud9 開発環境の環境メンバーに関する情報を取得します。** この例では、複数の AWS Cloud9 開発環境の指定された環境メンバーに関する情報を取得します。 コマンド: ``` aws cloud9 describe-environment-memberships --user-arn arn:aws:iam::123456789012:user/MyDemoUser ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEnvironmentMemberships](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloud9/describe-environment-memberships.html)」を参照してください。 ### `describe-environment-status` 次のコード例では、`describe-environment-status` を使用する方法を示しています。 **AWS CLI** **AWS Cloud9 開発環境に関するステータス情報を取得する方法** この例では、指定された AWS Cloud9 開発環境のステータス情報を取得します。 コマンド: ``` aws cloud9 describe-environment-status --environment-id 685f892f431b45c2b28cb69eadcdb0EX ``` 出力: ``` { "status": "ready", "message": "Environment is ready to use" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEnvironmentStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloud9/describe-environment-status.html)」を参照してください。 ### `describe-environments` 次のコード例では、`describe-environments` を使用する方法を示しています。 **AWS CLI** **AWS Cloud9 開発環境に関する情報を取得する許可を付与** この例では、指定された AWS Cloud9 開発環境の情報を取得します。 コマンド: ``` aws cloud9 describe-environments --environment-ids 685f892f431b45c2b28cb69eadcdb0EX 349c86d4579e4e7298d500ff57a6b2EX ``` 出力: ``` { "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" } } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEnvironments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloud9/describe-environments.html)」を参照してください。 ### `list-environments` 次のコード例では、`list-environments` を使用する方法を示しています。 **AWS CLI** **AWS Cloud9 開発環境の識別子の一覧を取得する方法** この例では、AWS Cloud9 開発環境の識別子の一覧を取得します。 コマンド: ``` aws cloud9 list-environments ``` 出力: ``` { "environmentIds": [ "685f892f431b45c2b28cb69eadcdb0EX", "1980b80e5f584920801c09086667f0EX" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListEnvironments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloud9/list-environments.html)」を参照してください。 ### `update-environment-membership` 次のコード例では、`update-environment-membership` を使用する方法を示しています。 **AWS CLI** **AWS Cloud9 開発環境の既存の環境メンバーの設定を変更する方法** この例では、指定された AWS Cloud9 開発環境の指定された既存の環境メンバーの設定を変更します。 コマンド: ``` aws cloud9 update-environment-membership --environment-id 8a34f51ce1e04a08882f1e811bd706EX --user-arn arn:aws:iam::123456789012:user/AnotherDemoUser --permissions read-only ``` 出力: ``` { "membership": { "environmentId": "8a34f51ce1e04a08882f1e811bd706EX", "userId": "AIDAJ3LOROMOUXTBSU6EX", "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser", "permissions": "read-only" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateEnvironmentMembership](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloud9/update-environment-membership.html)」を参照してください。 ### `update-environment` 次のコード例では、`update-environment` を使用する方法を示しています。 **AWS CLI** **既存の AWS Cloud9 開発環境の設定を変更する方法** この例では、指定された既存の AWS Cloud9 開発環境の指定された設定を変更します。 コマンド: ``` aws cloud9 update-environment --environment-id 8a34f51ce1e04a08882f1e811bd706EX --name my-changed-demo-env --description "My changed demonstration development environment." ``` 出力: ``` None. ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloud9/update-environment.html)」を参照してください。 # CloudFormation examples using AWS CLI 次のコード例では、CloudFormation で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `activate-type` 次のコード例は、`activate-type` の使用方法を示しています。 **AWS CLI** **タイプをアクティブ化する方法** 次の `activate-type` の例はサードパーティーのパブリック拡張機能をアクティブ化し、スタックテンプレートで使用できるようにします。 ``` aws cloudformation activate-type \ --region us-west-2 \ --type RESOURCE \ --type-name Example::Test::1234567890abcdef0 \ --type-name-alias Example::Test::Alias ``` 出力: ``` { "Arn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/Example-Test-Alias" } ``` 詳細については、「*AWS CloudFormation ユーザーガイド*」の「[AWSCloudFormation レジストリの使用](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ActivateType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/activate-type.html)」を参照してください。 ### `batch-describe-type-configurations` 次のコード例は、`batch-describe-type-configurations` の使用方法を示しています。 **AWS CLI** **タイプ構成を一括記述する方法** 次の `batch-describe-type-configurations` の例は、タイプのデータを設定します。 ``` 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" ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS CloudFormation ユーザーガイド*」の「[AWSCloudFormation レジストリの使用](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchDescribeTypeConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/batch-describe-type-configurations.html)」を参照してください。 ### `cancel-update-stack` 次のコード例は、`cancel-update-stack` の使用方法を示しています。 **AWS CLI** **進行中のスタック更新をキャンセルする方法** 以下の `cancel-update-stack` コマンドは、`myteststack` スタックで行われているスタック更新をキャンセルします。 ``` aws cloudformation cancel-update-stack --stack-name myteststack ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelUpdateStack](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/cancel-update-stack.html)」を参照してください。 ### `continue-update-rollback` 次のコード例は、`continue-update-rollback` の使用方法を示しています。 **AWS CLI** **更新のロールバックを再試行する** 以下の `continue-update-rollback` の例は、前回失敗したスタック更新からのロールバック操作を再開します。 ``` aws cloudformation continue-update-rollback \ --stack-name my-stack ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ContinueUpdateRollback](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/continue-update-rollback.html)」を参照してください。 ### `create-change-set` 次のコード例は、`create-change-set` の使用方法を示しています。 **AWS CLI** **変更セットを作成する方法** 次の `create-change-set` の例は、`CAPABILITY_IAM` 機能を持つ変更セットを作成します。ファイル「`template.yaml`」は、IAM リソースを含むスタックを定義する現在のフォルダ内の AWS CloudFormation テンプレートです。 ``` aws cloudformation create-change-set \ --stack-name my-application \ --change-set-name my-change-set \ --template-body file://template.yaml \ --capabilities CAPABILITY_IAM ``` 出力: ``` { "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" } ``` + API の詳細については、「* AWS CLIコマンドリファレンス*」の「[CreateChangeSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/create-change-set.html)」を参照してください。 ### `create-generated-template` 次の例は、`create-generated-template` を使用する方法を説明しています。 **AWS CLI** **スキャンしたリソースから生成済みテンプレートを作成する** 次の `create-generated-template` の例では、スキャンされたリソースから `MyTemplate` という名前の生成済みテンプレートを作成します。 ``` aws cloudformation create-generated-template \ --generated-template-name MyTemplate \ --resources file://resources.json ``` `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" } } ] ``` 出力: ``` { "Arn": "arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/7fc8512c-d8cb-4e02-b266-d39c48344e48", "Name": "MyTemplate" } ``` 詳細については、「AWS CloudFormation ユーザーガイド」の「[IaC ジェネレーターでスキャンされたリソースから CloudFormation テンプレートを作成する](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/iac-generator-create-template-from-scanned-resources.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateGeneratedTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/create-generated-template.html)」を参照してください。 ### `create-stack-instances` 次の例は、`create-stack-instances` を使用する方法を説明しています。 **AWS CLI** **スタックインスタンスを作成する方法** 次の `create-stack-instances` の例は、2 つのアカウントと 4 つのリージョンにスタックセットのインスタンスを作成します。耐障害性の設定により、一部のスタックが作成できない場合でも、すべてのアカウントとリージョンで更新が試行されます。 ``` 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 ``` 出力: ``` { "OperationId": "d7995c31-83c2-xmpl-a3d4-e9ca2811563f" } ``` `create-stack-set` コマンドを使用してスタックを作成します。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateStackInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/create-stack-instances.html)」を参照してください。 ### `create-stack-refactor` 次の例は、`create-stack-refactor` を使用する方法を説明しています。 **AWS CLI** **スタックリファクタリングオペレーションのスタック定義を作成するには** 次の `create-stack-refactor` 例では、スタックリファクタリング用のスタック定義を作成します。 ``` aws cloudformation create-stack-refactor \ --stack-definitions \ StackName=Stack1,TemplateBody@=file://template1-updated.yaml \ StackName=Stack2,TemplateBody@=file://template2-updated.yaml ``` 出力: ``` { "StackRefactorId": "9c384f70-4e07-4ed7-a65d-fee5eb430841" } ``` 詳細については、「*AWS CloudFormation ユーザーガイド*」の「[スタックリファクタリング](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-refactoring.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateStackRefactor](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/create-stack-refactor.html)」を参照してください。 ### `create-stack-set` 次の例は、`create-stack-set` を使用する方法を説明しています。 **AWS CLI** **スタックセットを作成する方法** 次の `create-stack-set` の例は、指定された YAML ファイルテムプレートを使用してスタックセットを作成します。 `template.yaml` は、スタックを定義する現在のフォルダ内の AWS CloudFormation テンプレートです。 ``` aws cloudformation create-stack-set \ --stack-set-name my-stack-set \ --template-body file://template.yaml \ --description "SNS topic" ``` 出力: ``` { "StackSetId": "my-stack-set:8d0f160b-d157-xmpl-a8e6-c0ce8e5d8cc1" } ``` `create-stack-instances` コマンドを使用して、スタックセットにスタックインスタンスを追加します。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateStackSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/create-stack-set.html)」を参照してください。 ### `create-stack` 次のコード例は、`create-stack` の使用方法を示しています。 **AWS CLI** **AWS CloudFormation スタックを作成する方法** 次の `create-stacks` コマンドは、`sampletemplate.json` テンプレートを使用して「`myteststack`」という名称のスタックを作成します。 ``` aws cloudformation create-stack --stack-name myteststack --template-body file://sampletemplate.json --parameters ParameterKey=KeyPairName,ParameterValue=TestKey ParameterKey=SubnetIDs,ParameterValue=SubnetID1\\,SubnetID2 ``` 出力: ``` { "StackId": "arn:aws:cloudformation:us-east-1:123456789012:stack/myteststack/466df9e0-0dff-08e3-8e2f-5088487c4896" } ``` 詳細については、「AWS CloudFormation ユーザーガイド」の「スタック」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateStack](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/create-stack.html)」を参照してください。 ### `deactivate-type` 次のコード例は、`deactivate-type` の使用方法を示しています。 **AWS CLI** **タイプを非アクティブ化する方法** 次の `deactivate-type` の例は、このアカウントとリージョンで以前にアクティブ化されたパブリック拡張機能を非アクティブ化します。 ``` aws cloudformation deactivate-type \ --region us-west-2 \ --type MODULE \ --type-name Example::Test::Type::MODULE ``` このコマンドでは何も出力されません。 詳細については、「*AWS CloudFormation ユーザーガイド*」の「[AWS CloudFormation レジストリの使用](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeactivateType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/deactivate-type.html)」を参照してください。 ### `delete-change-set` 次のコード例は、`delete-change-set` の使用方法を示しています。 **AWS CLI** **変更セットを削除する方法** 次の `delete-change-set` の例は、変更セット名とスタック名を指定して変更セットを削除します。 ``` aws cloudformation delete-change-set \ --stack-name my-stack \ --change-set-name my-change-set ``` このコマンドでは何も出力されません。 次の `delete-change-set` の例は、変更セットの完全な ARN を指定して変更セットを削除します。 ``` aws cloudformation delete-change-set \ --change-set-name arn:aws:cloudformation:us-east-2:123456789012:changeSet/my-change-set/4eca1a01-e285-xmpl-8026-9a1967bfb4b0 ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteChangeSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/delete-change-set.html)」を参照してください。 ### `delete-generated-template` 次の例は、`delete-generated-template` を使用する方法を説明しています。 **AWS CLI** **生成されたテンプレートを削除するには** 次の `delete-generated-template` の例では、指定されたテンプレートを削除します。 ``` aws cloudformation delete-generated-template \ --generated-template-name MyTemplate ``` このコマンドでは何も出力されません。 詳細については、「*AWS CloudFormation ユーザーガイド*」の「[既存のリソースからテンプレートを生成する](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteGeneratedTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/delete-generated-template.html)」を参照してください。 ### `delete-stack-instances` 次の例は、`delete-stack-instances` を使用する方法を説明しています。 **AWS CLI** **スタックインスタンスを削除する方法** 次の `delete-stack-instances` の例は、2 つのリージョンの 2 つのアカウントに設定されたスタックのインスタンスを削除し、スタックを終了します。 ``` aws cloudformation delete-stack-instances \ --stack-set-name my-stack-set \ --accounts 123456789012 567890123456 \ --regions us-east-1 us-west-1 \ --no-retain-stacks ``` 出力: ``` { "OperationId": "ad49f10c-fd1d-413f-a20a-8de6e2fa8f27" } ``` 空のスタックセットを削除するには、`delete-stack-set` コマンドを使用します。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteStackInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/delete-stack-instances.html)」を参照してください。 ### `delete-stack-set` 次のコード例は、`delete-stack-set` の使用方法を示しています。 **AWS CLI** **スタックセットを削除する方法** 次のコマンドは、指定された空のスタックセットを削除します。スタックセットは空である必要があります。 ``` aws cloudformation delete-stack-set \ --stack-set-name my-stack-set ``` このコマンドでは何も出力されません。 スタックセットからインスタンスを削除するには、 `delete-stack-instances` コマンドを使用します。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteStackSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/delete-stack-set.html)」を参照してください。 ### `delete-stack` 次のコード例は、`delete-stack` の使用方法を示しています。 **AWS CLI** **スタックを削除する方法** 以下の `delete-stack` 例は、指定されたスタックを削除します。 ``` aws cloudformation delete-stack \ --stack-name my-stack ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteStack](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/delete-stack.html)」を参照してください。 ### `deploy` 次のコード例は、`deploy` の使用方法を示しています。 **AWS CLI** 次のコマンドは、「`template.json`」という名前のテンプレートを「`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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[Deploy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/deploy.html)」を参照してください。 ### `deregister-type` 次のコード例は、`deregister-type` の使用方法を示しています。 **AWS CLI** **タイプバージョンの登録を解除する方法** 次の `deregister-type` の例は、CloudFormation レジストリでのアクティブな使用から指定されたタイプバージョンを削除し、CloudFormation オペレーションで使用できなくなります。 ``` aws cloudformation deregister-type \ --type RESOURCE \ --type-name My::Logs::LogGroup \ --version-id 00000002 ``` このコマンドでは何も出力されません。 詳細については、「*AWS CloudFormation ユーザーガイド*」の「[CloudFormation レジストリの使用](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeregisterType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/deregister-type.html)」を参照してください。 ### `describe-account-limits` 次のコード例は、`describe-account-limits` の使用方法を示しています。 **AWS CLI** **アカウント制限に関する情報を取得する方法** 次のコマンドは、現在のアカウントのリージョン制限のリストを取得します。 ``` aws cloudformation describe-account-limits ``` 出力: ``` { "AccountLimits": [ { "Name": "StackLimit", "Value": 200 }, { "Name": "StackOutputsLimit", "Value": 60 }, { "Name": "ConcurrentResourcesLimit", "Value": 2500 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAccountLimits](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-account-limits.html)」を参照してください。 ### `describe-change-set` 次のコード例は、`describe-change-set` の使用方法を示しています。 **AWS CLI** **変更セットについて情報を取得する方法** 次の `describe-change-set` の例は、変更セット名とスタック名で指定された変更セットの詳細を表示します。 ``` aws cloudformation describe-change-set \ --change-set-name my-change-set \ --stack-name my-stack ``` 次の `describe-change-set` の例は、変更セットの完全な ARN で指定された変更セットの詳細を表示します。 ``` aws cloudformation describe-change-set \ --change-set-name arn:aws:cloudformation:us-west-2:123456789012:changeSet/my-change-set/bc9555ba-a949-xmpl-bfb8-f41d04ec5784 ``` 出力: ``` { "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 } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeChangeSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-change-set.html)」を参照してください。 ### `describe-generated-template` 次の例は、`describe-generated-template` を使用する方法を説明しています。 **AWS CLI** **生成されたテンプレートを記述するには** 次の `describe-generated-template` の例では、指定したテンプレートについて記述しています。 ``` aws cloudformation describe-generated-template \ --generated-template-name MyTemplate ``` 出力: ``` { "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 } ``` 詳細については、「*AWS CloudFormation ユーザーガイド*」の「[既存のリソースからテンプレートを生成する](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeGeneratedTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-generated-template.html)」を参照してください。 ### `describe-publisher` 次の例は、`describe-publisher` を使用する方法を説明しています。 **AWS CLI** **パブリッシャーを記述する方法** 次の `describe-publisher` の例は、パブリッシャーの情報を設定します。 ``` aws cloudformation describe-publisher \ --region us-west-2 \ --publisher-id 000q6TfUovXsEMmgKowxDZLlwqr2QUsh ``` 出力: ``` { "PublisherId": "000q6TfUovXsEMmgKowxDZLlwqr2QUshd2e75c8c", "PublisherStatus": "VERIFIED", "IdentityProvider": "AWS_Marketplace", "PublisherProfile": "https://aws.amazon.com/marketplace/seller-profile?id=2c5dc1f0-17cd-4259-8e46-822a83gdtegd" } ``` 詳細については、「*AWS CloudFormation ユーザーガイド*」の「[AWS CloudFormation レジストリの使用](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribePublisher](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-publisher.html)」を参照してください。 ### `describe-resource-scan` 次の例は、`describe-resource-scan` を使用する方法を説明しています。 **AWS CLI** **リソーススキャンを記述するには** 次の `describe-resource-scan` の例では、指定されたスキャン ID を持つリソースを記述します。 ``` aws cloudformation describe-resource-scan --region \ --resource-scan-id arn:aws:cloudformation:us-east-1:123456789012:resourceScan/0a699f15-489c-43ca-a3ef-3e6ecfa5da60 ``` 出力: ``` { "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 } ``` 詳細については、「*AWS CloudFormation ユーザーガイド*」の「[既存のリソースからテンプレートを生成する](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeResourceScan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-resource-scan.html)」を参照してください。 ### `describe-stack-drift-detection-status` 次の例は、`describe-stack-drift-detection-status` を使用する方法を説明しています。 **AWS CLI** **ドリフト検出オペレーションのステータスを確認する方法** 次の `describe-stack-drift-detection-status` の例は、ドリフト検出オペレーションのステータスを表示します。この ID を取得するには、`detect-stack-drift` コマンドを実行します。 ``` aws cloudformation describe-stack-drift-detection-status \ --stack-drift-detection-id 1a229160-e4d9-xmpl-ab67-0a4f93df83d4 ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeStackDriftDetectionStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-stack-drift-detection-status.html)」を参照してください。 ### `describe-stack-events` 次のコード例は、`describe-stack-events` の使用方法を示しています。 **AWS CLI** **スタックイベントを記述する方法** 次の `describe-stack-events` の例は、指定されたスタックの最新イベントを 2 件表示します。 ``` 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==" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeStackEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-stack-events.html)」を参照してください。 ### `describe-stack-instance` 次のコード例は、`describe-stack-instance` の使用方法を示しています。 **AWS CLI** **スタックインスタンスを記述する方法** 次のコマンドは、指定されたアカウントとリージョンで指定されたスタックセットのインスタンスについて記述します。スタックセットは現在のリージョンとアカウントにあり、インスタンスはアカウント「`123456789012`」の `us-west-2` リージョンにあります。 ``` aws cloudformation describe-stack-instance \ --stack-set-name my-stack-set \ --stack-instance-account 123456789012 \ --stack-instance-region us-west-2 ``` 出力: ``` { "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=)." } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeStackInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-stack-instance.html)」を参照してください。 ### `describe-stack-refactor` 次の例は、`describe-stack-refactor` を使用する方法を説明しています。 **AWS CLI** **スタックリファクタリングオペレーションを記述するには** 次の `describe-stack-refactor` の例では、指定されたスタックリファクタリング ID を持つスタックリファクタリングオペレーションについて記述しています。 ``` aws cloudformation describe-stack-refactor \ --stack-refactor-id 9c384f70-4e07-4ed7-a65d-fee5eb430841 ``` 出力: ``` { "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" } ``` 詳細については、「*AWS CloudFormation ユーザーガイド*」の「[スタックリファクタリング](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-refactoring.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeStackRefactor](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-stack-refactor.html)」を参照してください。 ### `describe-stack-resource-drifts` 次の例は、`describe-stack-resource-drifts` を使用する方法を説明しています。 **AWS CLI** **スタック定義からドリフトしたリソースに関する情報を取得する方法** 次のコマンドは、指定されたスタックのドリフトされたリソースに関する情報を表示します。ドリフト検出を開始するには、 `detect-stack-drift` コマンドを使用します。 ``` aws cloudformation describe-stack-resource-drifts \ --stack-name my-stack ``` 出力には、帯域外に変更した AWS Lambda 関数が表示されます。 ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeStackResourceDrifts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-stack-resource-drifts.html)」を参照してください。 ### `describe-stack-resource` 次のコード例は、`describe-stack-resource` の使用方法を示しています。 **AWS CLI** **リソースに関する情報を取得する方法** 次の `describe-stack-resource` の例は、指定されたスタック内にある「`MyFunction`」という名称のリソースに関する詳細情報を表示します。 ``` aws cloudformation describe-stack-resource \ --stack-name MyStack \ --logical-resource-id MyFunction ``` 出力: ``` { "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" } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeStackResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-stack-resource.html)」を参照してください。 ### `describe-stack-resources` 次のコード例は、`describe-stack-resources` の使用方法を示しています。 **AWS CLI** **リソースに関する情報を取得する方法** 次の `describe-stack-resources` 例は、指定されたスタック内にあるリソースの詳細情報を表示します。 ``` aws cloudformation describe-stack-resources \ --stack-name my-stack ``` 出力: ``` { "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" } } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeStackResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-stack-resources.html)」を参照してください。 ### `describe-stack-set-operation` 次のコード例は、`describe-stack-set-operation` の使用方法を示しています。 **AWS CLI** **スタックセットオペレーションに関する情報を取得する方法** 次の describe-stack-set-operation の例は、指定されたスタックセットの更新オペレーションの詳細を表示します。 ``` aws cloudformation describe-stack-set-operation \ --stack-set-name enable-config \ --operation-id 35d45ebc-ed88-xmpl-ab59-0197a1fc83a0 ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeStackSetOperation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-stack-set-operation.html)」を参照してください。 ### `describe-stack-set` 次のコード例は、`describe-stack-set` の使用方法を示しています。 **AWS CLI** **リソースに関する情報を取得する方法** 次の describe-stack-set の例は、指定されたスタックセットに関する詳細を表示します。 ``` aws cloudformation describe-stack-set \ --stack-set-name my-stack-set ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeStackSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-stack-set.html)」を参照してください。 ### `describe-stacks` 次のコード例は、`describe-stacks` の使用方法を示しています。 **AWS CLI** **AWS CloudFormation スタックを記述する方法** 以下の `describe-stacks` 例は、`myteststack` スタックの概要情報を表示します。 ``` aws cloudformation describe-stacks --stack-name myteststack ``` 出力: ``` { "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 } ] } ``` 詳細については、「*AWS CloudFormation ユーザーガイド*」の「スタック」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeStacks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-stacks.html)」を参照してください。 ### `describe-type-registration` 次のコード例は、`describe-type-registration` の使用方法を示しています。 **AWS CLI** **タイプ登録情報を表示する方法** 次の `describe-type-registration` の例は、タイプのステータス、タイプ、バージョンなど、指定されたタイプ登録に関する情報を表示します。 ``` aws cloudformation describe-type-registration \ --registration-token a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` 出力: ``` { "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" } ``` 詳細については、「*AWS CloudFormation ユーザーガイド*」の「[CloudFormation レジストリの使用](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTypeRegistration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-type-registration.html)」を参照してください。 ### `describe-type` 次のコード例は、`describe-type` の使用方法を示しています。 **AWS CLI** **使用状況の情報を表示する方法** 次の `describe-type` の例は、指定されたキーペアの情報を表示します。 ``` aws cloudformation describe-type \ --type-name My::Logs::LogGroup \ --type RESOURCE ``` 出力: ``` { "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]" } ``` 詳細については、「*AWS CloudFormation ユーザーガイド*」の「[CloudFormation レジストリの使用](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/describe-type.html)」を参照してください。 ### `detect-stack-drift` 次のコード例は、`detect-stack-drift` の使用方法を示しています。 **AWS CLI** **ドリフトしたリソースを検出する方法** 次の `detect-stack-drift` の例は、指定されたスタックでドリフト検出を開始します。 ``` aws cloudformation detect-stack-drift \ --stack-name my-stack ``` 出力: ``` { "StackDriftDetectionId": "1a229160-e4d9-xmpl-ab67-0a4f93df83d4" } ``` その後、 `describe-stack-resource-drifts` コマンドでこの ID を使用してドリフトされたリソースを記述できます。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DetectStackDrift](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/detect-stack-drift.html)」を参照してください。 ### `detect-stack-resource-drift` 次のコード例は、`detect-stack-resource-drift` の使用方法を示しています。 **AWS CLI** **リソースのドリフトを検出する方法** 次の `detect-stack-resource-drift` の例は、ドリフト用に「`MyStack`」という名前のスタックで「`MyFunction`」という名称のリソースをチェックします。 ``` aws cloudformation detect-stack-resource-drift \ --stack-name MyStack \ --logical-resource-id MyFunction ``` 出力には、帯域外に変更した AWS Lambda 関数が表示されます。 ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DetectStackResourceDrift](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/detect-stack-resource-drift.html)」を参照してください。 ### `detect-stack-set-drift` 次のコード例は、`detect-stack-set-drift` の使用方法を示しています。 **AWS CLI** **スタックセットと、関連するスタックインスタンスのドリフトを検出する方法** 次の `detect-stack-set-drift` の例は、指定されたスタックセットに対で、そのスタックセットに関連付けられたすべてのスタックインスタンスを含むドリフト検出オペレーションを開始し、ドリフトオペレーションのステータスを追跡するために使用できるオペレーション ID を返します。 ``` aws cloudformation detect-stack-set-drift \ --stack-set-name stack-set-drift-example ``` 出力: ``` { "OperationId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } ``` 詳細については、*「AWS CloudFormation ユーザーガイド」*の[「スタックセットにおける管理されていない設定変更の検出」](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html)を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DetectStackSetDrift](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/detect-stack-set-drift.html)」を参照してください。 ### `estimate-template-cost` 次のコード例は、`estimate-template-cost` の使用方法を示しています。 **AWS CLI** **テンプレートコストを見積もる方法** 以下の `estimate-template-cost` の例は、現在のフォルダ内にある「`template.yaml`」という名称のテンプレートに関するコスト見積もりを生成します。 ``` aws cloudformation estimate-template-cost \ --template-body file://template.yaml ``` 出力: ``` { "Url": "http://calculator.s3.amazonaws.com/calc5.html?key=cloudformation/7870825a-xmpl-4def-92e7-c4f8dd360cca" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EstimateTemplateCost](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/estimate-template-cost.html)」を参照してください。 ### `execute-change-set` 次のコード例は、`execute-change-set` の使用方法を示しています。 **AWS CLI** **変更セットを実行する方法** 次の `execute-change-set` の例は、変更セット名とスタック名によって指定された変更セットを実行します。 ``` aws cloudformation execute-change-set \ --change-set-name my-change-set \ --stack-name my-stack ``` 次の `execute-change-set` の例は、変更セットの完全な ARN で指定された変更セットを実行します。 ``` aws cloudformation execute-change-set \ --change-set-name arn:aws:cloudformation:us-west-2:123456789012:changeSet/my-change-set/bc9555ba-a949-xmpl-bfb8-f41d04ec5784 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ExecuteChangeSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/execute-change-set.html)」を参照してください。 ### `execute-stack-refactor` 次の例は、`execute-stack-refactor` を使用する方法を説明しています。 **AWS CLI** **スタックリファクタリングオペレーションを完了するには** 次の `execute-stack-refactor` の例では、指定されたスタックリファクタリング ID を使用してスタックリファクタリングオペレーションを完了します。 ``` aws cloudformation execute-stack-refactor \ --stack-refactor-id 9c384f70-4e07-4ed7-a65d-fee5eb430841 ``` このコマンドでは何も出力されません。 詳細については、「*AWS CloudFormation ユーザーガイド*」の「[スタックリファクタリング](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-refactoring.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ExecuteStackRefactor](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/execute-stack-refactor.html)」を参照してください。 ### `get-stack-policy` 次の例は、`get-stack-policy` を使用する方法を説明しています。 **AWS CLI** **スタックポリシーを表示する方法** 次の `get-stack-policy` の例は、指定されたスタック用のスタックポリシーを表示します。ポリシーをスタックにアタッチするには、`set-stack-policy` コマンドを使用します。 ``` aws cloudformation get-stack-policy \ --stack-name my-stack ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetStackPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/get-stack-policy.html)」を参照してください。 ### `get-template-summary` 次のコード例は、`get-template-summary` の使用方法を示しています。 **AWS CLI** **テンプレートの概要を表示する方法** 次のコマンドは、指定されたテンプレートファイルのリソースとメタデータに関する概要情報を示しています。 ``` aws cloudformation get-template-summary \ --template-body file://template.yaml ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetTemplateSummary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/get-template-summary.html)」を参照してください。 ### `get-template` 次のコード例は、`get-template` の使用方法を示しています。 **AWS CLI** **AWS CloudFormation スタックのテンプレート本文を表示する方法** 以下の `get-template` の例は、`myteststack` スタックのテンプレートを示しています。 ``` aws cloudformation get-template --stack-name myteststack ``` 出力: ``` { "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" } } } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/get-template.html)」を参照してください。 ### `list-change-sets` 次のコード例は、`list-change-sets` の使用方法を示しています。 **AWS CLI** **変更セットを一覧表示する方法** 次の `list-change-sets` の例は、指定されたスタックの保留中の変更セットの一覧を表示します。 ``` aws cloudformation list-change-sets \ --stack-name my-stack ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListChangeSets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-change-sets.html)」を参照してください。 ### `list-exports` 次のコード例は、`list-exports` の使用方法を示しています。 **AWS CLI** **エクスポートを一覧表示する方法** 次の `list-exports` の例は、現在のリージョンのスタックからのエクスポートを一覧表示します。 ``` aws cloudformation list-exports ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListExports](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-exports.html)」を参照してください。 ### `list-generated-templates` 次の例は、`list-generated-templates` を使用する方法を説明しています。 **AWS CLI** **生成されたテンプレートを一覧表示するには** 次の `list-generated-templates` の例では、すべての生成されたテンプレートを一覧表示します。 ``` aws cloudformation list-generated-templates ``` 出力: ``` { "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 } ] } ``` 詳細については、「*AWS CloudFormation ユーザーガイド*」の「[既存のリソースからテンプレートを生成する](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListGeneratedTemplates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-generated-templates.html)」を参照してください。 ### `list-imports` 次の例は、`list-imports` を使用する方法を説明しています。 **AWS CLI** **インポートを一覧表示する方法** 次の `list-imports` の例は、指定されたエクスポートをインポートするスタックを一覧表示します。使用可能なエクスポートの一覧を取得するには、 `list-exports` コマンドを使用します。 ``` aws cloudformation list-imports \ --export-name private-vpc-vpcid ``` 出力: ``` { "Imports": [ "my-database-stack" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListImports](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-imports.html)」を参照してください。 ### `list-resource-scan-related-resources` 次の例は、`list-resource-scan-related-resources` を使用する方法を説明しています。 **AWS CLI** **リソーススキャンから関連リソースを一覧表示するには** 次の `list-resource-scan-related-resources` の例では、`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 ``` `resources.json` の内容: ``` [ { "ResourceType": "AWS::EKS::Cluster", "ResourceIdentifier": { "ClusterName": "MyAppClusterName" } }, { "ResourceType": "AWS::AutoScaling::AutoScalingGroup", "ResourceIdentifier": { "AutoScalingGroupName": "MyAppASGName" } } ] ``` 出力: ``` { "RelatedResources": [ { "ResourceType": "AWS::EKS::Nodegroup", "ResourceIdentifier": { "NodegroupName": "MyAppNodegroupName" }, "ManagedByStack": false }, { "ResourceType": "AWS::IAM::Role", "ResourceIdentifier": { "RoleId": "arn:aws::iam::123456789012:role/MyAppIAMRole" }, "ManagedByStack": false } ] } ``` 詳細については、「AWS CloudFormation ユーザーガイド」の「[IaC ジェネレーターでスキャンされたリソースから CloudFormation テンプレートを作成する](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/iac-generator-create-template-from-scanned-resources.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListResourceScanRelatedResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-resource-scan-related-resources.html)」を参照してください。 ### `list-resource-scan-resources` 次の例は、`list-resource-scan-resources` を使用する方法を説明しています。 **AWS CLI** **リソーススキャンからリソースを一覧表示するには** 次の `list-resource-scan-resources` の例では、指定されたリソーススキャンのリソースを、リソース識別子でフィルタリングして一覧表示します。 ``` 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 ``` 出力: ``` { "Resources": [ { "ResourceType": "AWS::EKS::Cluster", "ResourceIdentifier": { "ClusterName": "MyAppClusterName" }, "ManagedByStack": false }, { "ResourceType": "AWS::AutoScaling::AutoScalingGroup", "ResourceIdentifier": { "AutoScalingGroupName": "MyAppASGName" }, "ManagedByStack": false } ] } ``` 詳細については、「AWS CloudFormation ユーザーガイド」の「[IaC ジェネレーターでスキャンされたリソースから CloudFormation テンプレートを作成する](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/iac-generator-create-template-from-scanned-resources.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListResourceScanResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-resource-scan-resources.html)」を参照してください。 ### `list-stack-instances` 次の例は、`list-stack-instances` を使用する方法を説明しています。 **AWS CLI** **スタックのインスタンスを一覧表示する方法** 次の `list-stack-instances` の例は、指定されたスタックセットから作成されたインスタンスを一覧表示します。 ``` aws cloudformation list-stack-instances \ --stack-set-name enable-config ``` サンプル出力には、エラーが原因で更新に失敗したスタックに関する詳細が含まれます。 ``` { "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)." } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListStackInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-stack-instances.html)」を参照してください。 ### `list-stack-refactor-actions` 次の例は、`list-stack-refactor-actions` を使用する方法を説明しています。 **AWS CLI** **スタックリファクタリングオペレーションのアクションを一覧表示するには** 次の `list-stack-refactor-actions` の例では、指定されたスタックリファクタリング ID を持つスタックリファクタリングオペレーションのアクションを一覧表示します。 ``` aws cloudformation list-stack-refactor-actions \ --stack-refactor-id 9c384f70-4e07-4ed7-a65d-fee5eb430841 ``` 出力: ``` { "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" } } } ] } ``` 詳細については、「*AWS CloudFormation ユーザーガイド*」の「[スタックリファクタリング](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-refactoring.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListStackRefactorActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-stack-refactor-actions.html)」を参照してください。 ### `list-stack-resources` 次の例は、`list-stack-resources` を使用する方法を説明しています。 **AWS CLI** **スタック内のリソースを一覧表示する方法** 以下のコマンドは、指定されたスタック内にあるリソースを一覧表示します。 ``` aws cloudformation list-stack-resources \ --stack-name my-stack ``` 出力: ``` { "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" } } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListStackResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-stack-resources.html)」を参照してください。 ### `list-stack-set-operation-results` 次のコード例は、`list-stack-set-operation-results` の使用方法を示しています。 **AWS CLI** **スタックセットオペレーション結果を一覧表示する方法** 次のコマンドは、指定されたスタックセット内のインスタンスに対する更新オペレーションの結果を表示します。 ``` aws cloudformation list-stack-set-operation-results \ --stack-set-name enable-config \ --operation-id 35d45ebc-ed88-xmpl-ab59-0197a1fc83a0 ``` 出力: ``` { "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" } ] } ``` **注:** アカウントゲート関数を作成しない限り、`AccountGateResult` の `SKIPPED` ステータスが正常なオペレーションとなります。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListStackSetOperationResults](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-stack-set-operation-results.html)」を参照してください。 ### `list-stack-set-operations` 次のコード例は、`list-stack-set-operations` の使用方法を示しています。 **AWS CLI** **スタックセットオペレーションを一覧表示する方法** 次の `list-stack-set-operations` の例は、指定されたスタックセットの最新のオペレーションを一覧表示します。 ``` aws cloudformation list-stack-set-operations \ --stack-set-name my-stack-set ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListStackSetOperations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-stack-set-operations.html)」を参照してください。 ### `list-stack-sets` 次のコード例は、`list-stack-sets` の使用方法を示しています。 **AWS CLI** **スタックセットを一覧表示する方法** 次の `list-stack-sets` の例は、現在のリージョンとアカウントのスタックセットを一覧表示します。 ``` aws cloudformation list-stack-sets ``` 出力: ``` { "Summaries": [ { "StackSetName": "enable-config", "StackSetId": "enable-config:296a3360-xmpl-40af-be78-9341e95bf743", "Description": "Enable AWS Config", "Status": "ACTIVE" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListStackSets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-stack-sets.html)」を参照してください。 ### `list-stacks` 次のコード例は、`list-stacks` の使用方法を示しています。 **AWS CLI** **AWS CloudFormation スタックを一覧表示する方法** 以下の `list-stacks` コマンドは、ステータスが `CREATE_COMPLETE` になっているすべてのスタックの概要を表示します。 ``` aws cloudformation list-stacks --stack-status-filter CREATE_COMPLETE ``` 出力: ``` [ { "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" } ] ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListStacks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-stacks.html)」を参照してください。 ### `list-type-registrations` 次のコード例は、`list-type-registrations` の使用方法を示しています。 **AWS CLI** **タイプの登録完了済みを一覧表示する方法** 次の `list-type-registrations` の例は、指定されたタイプの完了したタイプ登録を一覧表示します。 ``` aws cloudformation list-type-registrations \ --type RESOURCE \ --type-name My::Logs::LogGroup \ --registration-status-filter COMPLETE ``` 出力: ``` { "RegistrationTokenList": [ "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333" ] } ``` 詳細については、「*AWS CloudFormation ユーザーガイド*」の「[CloudFormation レジストリの使用](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTypeRegistrations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-type-registrations.html)」を参照してください。 ### `list-type-versions` 次のコード例は、`list-type-versions` の使用方法を示しています。 **AWS CLI** **拡張機能のバージョンを一覧表示する方法** 次の `list-type-versions` の例は、拡張機能のバージョンに関する概要情報を返します。 ``` aws cloudformation list-type-versions \ --endpoint https://example.com \ --region us-west-2 \ --type RESOURCE \ --type-name My::Resource::Example \ --publisher-id 123456789012 ``` このコマンドでは何も出力されません。 詳細については、「*AWS CloudFormation ユーザーガイド*」の「[AWS CloudFormation レジストリの使用](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTypeVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-type-versions.html)」を参照してください。 ### `list-types` 次のコード例は、`list-types` の使用方法を示しています。 **AWS CLI** **アカウントのプライベートリソースタイプを一覧表示する方法** 次の `list-types` の例は、現在の AWS アカウントで現在登録されているプライベートリソースタイプを一覧表示します。 ``` aws cloudformation list-types ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS CloudFormation ユーザーガイド*」の「[CloudFormation レジストリの使用](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/list-types.html)」を参照してください。 ### `package` 次のコード例は、`package` の使用方法を示しています。 **AWS CLI** 次のコマンドは、ローカルアーティファクトを S3 バケット `bucket-name` にアップロードして「`template.json`」という名称のテンプレートをエクスポートし、エクスポートされたテンプレートを `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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[Package](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/package.html)」を参照してください。 ### `publish-type` 次のコード例は、`publish-type` の使用方法を示しています。 **AWS CLI** **拡張機能を公開する方法** 次の `publish-type` の例は、指定された拡張機能を CloudFormation レジストリにこのリージョンのパブリック拡張機能として公開します。 ``` aws cloudformation publish-type \ --region us-west-2 \ --type RESOURCE \ --type-name Example::Test::1234567890abcdef0 ``` 出力: ``` { "PublicTypeArn":"arn:aws:cloudformation:us-west-2::type/resource/000q6TfUovXsEMmgKowxDZLlwqr2QUshd2e75c8c/Example-Test-1234567890abcdef0/1.0.0" } ``` 詳細については、「*AWS CloudFormation ユーザーガイド*」の「[AWS CloudFormation レジストリの使用](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PublishType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/publish-type.html)」を参照してください。 ### `register-publisher` 次のコード例は、`register-publisher` の使用方法を示しています。 **AWS CLI** **パブリッシャーを登録する方法** 次の `register-publisher` の例は、パブリッシャーを登録し、利用規約パラメータを受け入れます。 ``` aws cloudformation register-publisher \ --region us-west-2 \ --accept-terms-and-conditions ``` 出力: ``` { "PublisherId": "000q6TfUovXsEMmgKowxDZLlwqr2QUshd2e75c8c" } ``` 詳細については、「*AWS CloudFormation ユーザーガイド*」の「[AWS CloudFormation レジストリの使用](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegisterPublisher](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/register-publisher.html)」を参照してください。 ### `register-type` 次のコード例は、`register-type` の使用方法を示しています。 **AWS CLI** **リソースタイプを登録する方法** 次の `register-type` の例は、指定されたリソースタイプをユーザーのアカウントにプライベートリソースタイプとして登録します。 ``` aws cloudformation register-type \ --type-name My::Organization::ResourceName \ --schema-handler-package s3://bucket_name/my-organization-resource_name.zip \ --type RESOURCE ``` 出力: ``` { "RegistrationToken": "f5525280-104e-4d35-bef5-8f1f1example" } ``` 詳細については、「*CloudFormation コマンドラインインターフェイスユーザーガイド*」の「[リソースプロバイダーの登録](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-register.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegisterType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/register-type.html)」を参照してください。 ### `set-stack-policy` 次のコード例は、`set-stack-policy` の使用方法を示しています。 **AWS CLI** **スタックポリシーを適用する方法** 次の `set-stack-policy` の例は、指定されたスタック内の指定されたリソースの更新を無効にします。`stack-policy.json` は、スタック内のリソースで許可されるオペレーションを定義する JSON ドキュメントです。 ``` aws cloudformation set-stack-policy \ --stack-name my-stack \ --stack-policy-body file://stack-policy.json ``` 出力: ``` { "Statement" : [ { "Effect" : "Allow", "Action" : "Update:*", "Principal": "*", "Resource" : "*" }, { "Effect" : "Deny", "Action" : "Update:*", "Principal": "*", "Resource" : "LogicalResourceId/bucket" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetStackPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/set-stack-policy.html)」を参照してください。 ### `set-type-configuration` 次のコード例は、`set-type-configuration` の使用方法を示しています。 **AWS CLI** **データを設定する方法** 次の `set-type-configuration` の例は、指定されたアカウントとリージョンに登録された CloudFormation 拡張機能の設定データを指定します。 ``` aws cloudformation set-type-configuration \ --region us-west-2 \ --type RESOURCE \ --type-name Example::Test::Type \ --configuration-alias default \ --configuration "{\"CredentialKey\": \"testUserCredential\"}" ``` 出力: ``` { "ConfigurationArn": "arn:aws:cloudformation:us-west-2:123456789012:type-configuration/resource/Example-Test-Type/default" } ``` 詳細については、「*AWS CloudFormation ユーザーガイド*」の「[AWS CloudFormation レジストリの使用](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetTypeConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/set-type-configuration.html)」を参照してください。 ### `set-type-default-version` 次のコード例は、`set-type-default-version` の使用方法を示しています。 **AWS CLI** **タイプのデフォルトバージョンを設定する方法** 次の `set-type-default-version` の例は、このタイプのデフォルトとして使用するように指定されたタイプバージョンを設定します。 ``` aws cloudformation set-type-default-version \ --type RESOURCE \ --type-name My::Logs::LogGroup \ --version-id 00000003 ``` このコマンドでは何も出力されません。 詳細については、「*AWS CloudFormation ユーザーガイド*」の「[CloudFormation レジストリの使用](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetTypeDefaultVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/set-type-default-version.html)」を参照してください。 ### `signal-resource` 次のコード例は、`signal-resource` の使用方法を示しています。 **AWS CLI** **リソースにシグナルを送信する方法** 次の `signal-resource` の例は、「`my-stack`」という名称のスタックで「`MyWaitCondition`」という名称の待機条件を満たすように `success` にシグナルを送信します。 ``` aws cloudformation signal-resource \ --stack-name my-stack \ --logical-resource-id MyWaitCondition \ --unique-id 1234 \ --status SUCCESS ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SignalResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/signal-resource.html)」を参照してください。 ### `start-resource-scan` 次の例は、`start-resource-scan` を使用する方法を説明しています。 **AWS CLI** **リソーススキャンを開始するには** 次の `start-resource-scan` の例では、現在のアカウントとリージョン内のすべての既存のリソースをスキャンするリソーススキャンを開始します。 ``` aws cloudformation start-resource-scan ``` 出力: ``` { "ResourceScanId": "arn:aws:cloudformation:us-east-1:123456789012:resourceScan/0a699f15-489c-43ca-a3ef-3e6ecfa5da60" } ``` 詳細については、「*AWS CloudFormation ユーザーガイド*」の「[CloudFormation IaC ジェネレーターを使用してリソーススキャンを開始する](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/iac-generator-start-resource-scan.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartResourceScan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/start-resource-scan.html)」を参照してください。 ### `stop-stack-set-operation` 次の例は、`stop-stack-set-operation` を使用する方法を説明しています。 **AWS CLI** **スタックセットオペレーションを停止する方法** 次の `stop-stack-set-operation` の例は、指定されたスタックセットの進行中の更新オペレーションを停止します。 ``` aws cloudformation stop-stack-set-operation \ --stack-set-name my-stack-set \ --operation-id 1261cd27-490b-xmpl-ab42-793a896c69e6 ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopStackSetOperation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/stop-stack-set-operation.html)」を参照してください。 ### `test-type` 次のコード例は、`test-type` の使用方法を示しています。 **AWS CLI** **拡張機能をテストする方法** 次の `test-type` の例は、CloudFormation レジストリ内での公開に必要なすべての要件を満たしていることを確認するため、登録済みの拡張機能をテストします。 ``` aws cloudformation test-type \ --arn arn:aws:cloudformation:us-west-2:123456789012:type/resource/Sample-Test-Resource123/00000001 ``` 出力: ``` { "TypeVersionArn": "arn:aws:cloudformation:us-west-2:123456789012:type/resource/Sample-Test-Resource123/00000001" } ``` 詳細については、「*AWS CloudFormation ユーザーガイド*」の「[AWS CloudFormation レジストリの使用](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TestType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/test-type.html)」を参照してください。 ### `update-stack-instances` 次のコード例は、`update-stack-instances` の使用方法を示しています。 **AWS CLI** **スタックインスタンスを更新する方法** 次の `update-stack-instances` の例は、最新の設定で 2 つのリージョンの 2 つのアカウントのスタックインスタンスの更新を再試行します。指定された耐障害性の設定により、一部のスタックが更新できない場合でも、すべてのアカウントとリージョンで更新が試行されます。 ``` 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 ``` 出力: ``` { "OperationId": "103ebdf2-21ea-xmpl-8892-de5e30733132" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateStackInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/update-stack-instances.html)」を参照してください。 ### `update-stack-set` 次のコード例は、`update-stack-set` の使用方法を示しています。 **AWS CLI** **テストセットを更新する方法** 次の `update-stack-set` の例は、指定されたスタックセットで「`Owner`」のキー名と「`IT`」の値を持つタグをスタックインスタンスに追加します。 ``` aws cloudformation update-stack-set \ --stack-set-name my-stack-set \ --use-previous-template \ --tags Key=Owner,Value=IT ``` 出力: ``` { "OperationId": "e2b60321-6cab-xmpl-bde7-530c6f47950e" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateStackSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/update-stack-set.html)」を参照してください。 ### `update-stack` 次のコード例は、`update-stack` の使用方法を示しています。 **AWS CLI** **AWS CloudFormation スタックを更新する方法** 以下の `update-stack` コマンドは、`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 ``` 以下の `update-stack` コマンドは、`mystack` スタックの `SubnetIDs` パラメータ値のみを更新します。パラメータ値を指定しない場合は、テンプレートで指定されているデフォルト値が使用されます。 ``` 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 ``` 以下の `update-stack` コマンドは、`mystack` スタックに 2 つのスタック通知トピックを追加します。 ``` 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" ``` 詳細については、「*AWSCloudFormation ユーザーガイド*」の「[AWSCloudFormation スタックの更新](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateStack](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/update-stack.html)」を参照してください。 ### `update-termination-protection` 次のコード例は、`update-termination-protection` の使用方法を示しています。 **AWS CLI** **削除保護を有効化する方法** 次の `update-termination-protection` の例は、指定されたスタックで削除保護を有効にします。 ``` aws cloudformation update-termination-protection \ --stack-name my-stack \ --enable-termination-protection ``` 出力: ``` { "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateTerminationProtection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/update-termination-protection.html)」を参照してください。 ### `validate-template` 次のコード例は、`validate-template` の使用方法を示しています。 **AWS CLI** **AWS CloudFormation テンプレートを検証する方法** 以下の `validate-template` コマンドは、`sampletemplate.json` テンプレートを検証します。 ``` aws cloudformation validate-template --template-body file://sampletemplate.json ``` 出力: ``` { "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": [] } ``` 詳細については、「*AWSCloudFormation ユーザーガイド*」の「AWS CloudFormation テンプレートの使用」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ValidateTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudformation/validate-template.html)」を参照してください。 # AWS CLI を使用した CloudFront の例 次のコード例は、CloudFront で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `associate-distribution-tenant-web-acl` 次のコード例は、`associate-distribution-tenant-web-acl` を使用する方法を示しています。 **AWS CLI** **ウェブ ACL と CloudFront ディストリビューションテナントを関連付けるには** 次の `associate-distribution-tenant-web-acl` の例では、ウェブ ACL を ETag `E13V1IB3VIYABC` を持つ CloudFront ディストリビューションに関連付けます。 ``` 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 ``` 出力: ``` { "ETag": "E1VC38T7YXBABC", "Id": "dt_2wjDZi3hD1ivOXf6rpZJO1AB", "WebACLArn": "arn:aws:wafv2:us-east-1:123456789012:global/webacl/web-global-example/626900da-5f64-418b-ba9b-743f37123ABC" } ``` 詳細については、「*Amazon CloudFront デベロッパーガイド*」の「[AWS WAF 保護を使用する](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-awswaf.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateDistributionTenantWebAcl](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/associate-distribution-tenant-web-acl.html)」を参照してください。 ### `associate-distribution-web-acl` 次のコード例は、`associate-distribution-web-acl` を使用する方法を示しています。 **AWS CLI** **ウェブ ACL と CloudFront ディストリビューションを関連付けるには** 次の `associate-distribution-web-acl` の例では、ウェブ ACL を 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 ``` 出力: ``` { "ETag": "E3QE7ED60U0ABC", "Id": "E1XNX8R2GOAABC", "WebACLArn": "arn:aws:wafv2:us-east-1:123456789012:global/webacl/web-global-example/626900da-5f64-418b-ba9b-743f3746cABC" } ``` 詳細については、「*Amazon CloudFront デベロッパーガイド*」の「[AWS WAF 保護を使用する](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-awswaf.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateDistributionWebAcl](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/associate-distribution-web-acl.html)」を参照してください。 ### `create-cloud-front-origin-access-identity` 次のコード例は、`create-cloud-front-origin-access-identity` を使用する方法を示しています。 **AWS CLI** **CloudFront オリジンアクセスアイデンティティを作成するには** 次の例では、コマンドライン引数として OAI 設定を指定して、CloudFront オリジンアクセスアイデンティティ (OAI) を作成しています。 ``` aws cloudfront create-cloud-front-origin-access-identity \ --cloud-front-origin-access-identity-config \ CallerReference="cli-example",Comment="Example OAI" ``` 次の例に示すように、同じことは、JSON ファイルで OAI 設定を指定することでも実現できます。 ``` aws cloudfront create-cloud-front-origin-access-identity \ --cloud-front-origin-access-identity-config file://OAI-config.json ``` `OAI-config.json` ファイルは、以下を含む現在のディレクトリ内にある JSON ドキュメントです。 ``` { "CallerReference": "cli-example", "Comment": "Example OAI" } ``` OAI 設定をコマンドライン引数で指定する場合も、JSON ファイルで指定する場合も、出力は変わりません。 ``` { "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" } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCloudFrontOriginAccessIdentity](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/create-cloud-front-origin-access-identity.html)」を参照してください。 ### `create-connection-group` 次のコード例は、`create-connection-group` を使用する方法を示しています。 **AWS CLI** **CloudFront で接続グループを作成するには** 次の `create-connection-group` の例では、有効な接続グループを作成し、エニーキャスト静的 IP リストを指定し、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}]" ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon CloudFront デベロッパーガイド*」の「[カスタム接続グループの作成 (オプション)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-connection-group.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateConnectionGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/create-connection-group.html)」を参照してください。 ### `create-distribution-tenant` 次のコード例は、`create-distribution-tenant` を使用する方法を示しています。 **AWS CLI** **例 1: カスタム証明書を使用する CloudFront ディストリビューションテナントを作成するには** 次の `create-distribution-tenant` の例では、WAF を無効にし、地域制限を追加し、別の TLS 証明書を使用するようにカスタマイズを指定する CloudFront ディストリビューションテナントを作成します。 ``` aws cloudfront create-distribution-tenant \ --cli-input-json file://tenant.json ``` `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" } } } ``` 出力: ``` { "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" } } ``` **例 2: 継承された証明書を使用するディストリビューションテナントを作成するには** 次の `create-distribution-tenant` の例では、ディストリビューションテナントを作成し、マルチテナントディストリビューションから継承された TLS 証明書を指定します。 ``` aws cloudfront create-distribution-tenant \ --cli-input-json file://tenant.json ``` `tenant.json` の内容: ``` { "DistributionId": "E1HVIAU7U12ABC", "Domains": [ { "Domain": "example.com" } ], "Parameters": [ { "Name": "tenantName", "Value": "first-tenant" } ], "Enabled": true, "Name": "new-tenant-no-cert" } ``` 出力: ``` { "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" } } ``` **例 3: CloudFront がホストする検証トークンを使用する CloudFront ディストリビューションテナントを作成するには** 次の `create-distribution-tenant` の例では、ディストリビューションテナントを作成し、ドメイン名に CloudFront がホストする検証トークンを使用します。 ``` aws cloudfront create-distribution-tenant \ --cli-input-json file://tenant.json ``` `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" } } ``` **重要:** このコマンドを正常に実行するには、新しいドメイン (example.com) がディストリビューションテナントに関連付けられている接続グループのルーティングエンドポイントを指すように CNAME DNS レコードを設定する必要があります。CloudFront がこのリクエストを正常に完了する前に、この CNAME レコードも伝播させる必要があります。 出力: ``` { "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" } } ``` **例 4: セルフホスト型の検証トークンを使用する CloudFront ディストリビューションテナントを作成するには** 次の `create-distribution-tenant` の例では、CloudFront ディストリビューションテナントを作成し、セルフホスト型の検証トークンを使用します。 ``` aws cloudfront create-distribution-tenant \ --cli-input-json file://tenant.json ``` `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" } } ``` 出力: ``` { "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" } } ``` **重要:** このコマンドの実行後、ディストリビューションテナントは検証なしで作成されます。トラフィックの受信を開始する準備ができたときにマネージド証明書のリクエストを検証し、DNS を設定するには、「*Amazon CloudFront デベロッパーガイド*」の「[ドメイン設定を完了する](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/managed-cloudfront-certificates.html#complete-domain-ownership)」を参照してください。 ディストリビューションテナントの作成の詳細については、「*Amazon CloudFront デベロッパーガイド*」の「[ディストリビューションを作成する](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-creating-console.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDistributionTenant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/create-distribution-tenant.html)」を参照してください。 ### `create-distribution-with-tags` 次のコード例は、`create-distribution-with-tags` を使用する方法を示しています。 **AWS CLI** **タグ付きの CloudFront ディストリビューションを作成するには** 次の `create-distribution-with-tags` の例では、`dist-config-with-tags.json` という名前の JSON ファイルにディストリビューション設定とタグを指定して、2 つのタグを持つディストリビューションを作成しています。 ``` aws cloudfront create-distribution-with-tags \ --distribution-config-with-tags file://dist-config-with-tags.json ``` `dist-config-with-tags.json` ファイルは現在のフォルダ内の JSON ドキュメントです。ファイルの先頭にある `Tags` オブジェクトに、次の 2 つのタグが含まれていることに注目してください。 `Name = ExampleDistribution``Project = ExampleProject` `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 } } ``` 出力: ``` { "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 } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDistributionWithTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/create-distribution-with-tags.html)」を参照してください。 ### `create-distribution` 次のコード例は、`create-distribution` を使用する方法を示しています。 **AWS CLI** **例 1: CloudFront ディストリビューションを作成するには** 次の `create-distribution` の例では、`amzn-s3-demo-bucket` という名前の S3 バケットのディストリビューションを作成し、コマンドライン引数を使用してデフォルトのルートオブジェクトとして `index.html` を指定しています。 ``` aws cloudfront create-distribution \ --origin-domain-name amzn-s3-demo-bucket.s3.amazonaws.com \ --default-root-object index.html ``` 出力: ``` { "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 } } } ``` **例 2: JSON ファイルを使用して CloudFront ディストリビューションを作成するには** 次の `create-distribution` の例では、`amzn-s3-demo-bucket` という名前の S3 バケットのディストリビューションを作成し、JSON ファイルを使用してデフォルトのルートオブジェクトとして `index.html` を指定しています。 ``` aws cloudfront create-distribution \ --distribution-config file://dist-config.json ``` `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 } ``` 出力例については、例 1 を参照してください。 **例 3: 証明書を使用して CloudFront マルチテナントディストリビューションを作成するには** 次の `create-distribution` の例では、マルチテナントをサポートする CloudFront ディストリビューションを作成し、TLS 証明書を指定します。 ``` aws cloudfront create-distribution \ --distribution-config file://dist-config.json ``` `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 } } } ] } } ``` 出力: ``` { "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" } } } ``` 詳細については、「*Amazon CloudFront デベロッパーガイド*」の「[ディストリビューションの設定](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-working-with.html)」を参照してください。 **例 4: 証明書を使用しないで CloudFront マルチテナントディストリビューションを作成するには** 次の `create-distribution` の例では、マルチテナントをサポートしているが TLS 証明書はサポートしない CloudFront ディストリビューションを作成します。 ``` aws cloudfront create-distribution \ --distribution-config file://dist-config.json ``` `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 } } } ] } } ``` 出力: ``` { "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" } } } ``` 詳細については、「*Amazon CloudFront デベロッパーガイド*」の「[ディストリビューションの設定](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-working-with.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[CreateDistribution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/create-distribution.html)」を参照してください。** ### `create-field-level-encryption-config` 次のコード例は、`create-field-level-encryption-config` を使用する方法を示しています。 **AWS CLI** **CloudFront のフィールドレベル暗号化の設定を作成するには** 次の例では、`fle-config.json` という名前の JSON ファイルに設定パラメータを指定して、フィールドレベル暗号化の設定を作成しています。フィールドレベル暗号化の設定を作成する前に、フィールドレベル暗号化のプロファイルが必要です。プロファイルを作成するには、create-field-level-encryption-profile コマンドを参照してください。 CloudFront のフィールドレベル暗号化の詳細については、「*Amazon CloudFront 開発者ガイド*」の「[フィールドレベル暗号化を使用した機密データの保護](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html)」を参照してください。 ``` aws cloudfront create-field-level-encryption-config \ --field-level-encryption-config file://fle-config.json ``` `fle-config.json` ファイルは、以下を含む現在のフォルダ内にある JSON ドキュメントです。 ``` { "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" } ] } } } ``` 出力: ``` { "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" } ] } } } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateFieldLevelEncryptionConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/create-field-level-encryption-config.html)」を参照してください。 ### `create-field-level-encryption-profile` 次のコード例は、`create-field-level-encryption-profile` を使用する方法を示しています。 **AWS CLI** **CloudFront のフィールドレベル暗号化のプロファイルを作成するには** 次の例では、`fle-profile-config.json` という名前の JSON ファイルにパラメータを指定して、フィールドレベル暗号化のプロファイルを作成しています。フィールドレベル暗号化のプロファイルを作成する前に、CloudFront パブリックキーが必要です。CloudFront パブリックキーを作成するには、create-public-key コマンドを参照してください。 CloudFront のフィールドレベル暗号化の詳細については、「*Amazon CloudFront 開発者ガイド*」の「[フィールドレベル暗号化を使用した機密データの保護](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html)」を参照してください。 ``` aws cloudfront create-field-level-encryption-profile \ --field-level-encryption-profile-config file://fle-profile-config.json ``` `fle-profile-config.json` ファイルは、以下を含む現在のフォルダ内にある JSON ドキュメントです。 ``` { "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" ] } } ] } } ``` 出力: ``` { "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" ] } } ] } } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateFieldLevelEncryptionProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/create-field-level-encryption-profile.html)」を参照してください。 ### `create-invalidation-for-distribution-tenant` 次のコード例は、`create-invalidation-for-distribution-tenant` を使用する方法を示しています。 **AWS CLI** **ディストリビューションテナントの CloudFront の無効化を作成するには** 次の `create-invalidation-for-distribution-tenant` の例では、CloudFront ディストリビューションテナント内ですべてのファイルの無効化を作成します。 ``` aws cloudfront create-invalidation-for-distribution-tenant \ --id dt_2wjDZi3hD1ivOXf6rpZJO1AB \ --invalidation-batch '{"Paths": {"Quantity": 1, "Items": ["/*"]}, "CallerReference": "invalidation-$(date +%s)"}' ``` 出力: ``` { "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)" } } } ``` 詳細については、「*Amazon CloudFront デベロッパーガイド*」の「[ファイルを無効化してコンテンツを削除する](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateInvalidationForDistributionTenant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/create-invalidation-for-distribution-tenant.html)」を参照してください。 ### `create-invalidation` 次のコード例は、`create-invalidation` を使用する方法を示しています。 **AWS CLI** **CloudFront ディストリビューションでキャッシュ削除を作成するには** 次の `create-invalidation` 例では、指定した CloudFront ディストリビューションで指定したファイルのキャッシュ削除を作成します。 ``` aws cloudfront create-invalidation \ --distribution-id EDFDVBD6EXAMPLE \ --paths "/example-path/example-file.jpg" "/example-path/example-file2.png" ``` 出力: ``` { "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" } } } ``` 前の例では、AWS CLI が自動的にランダム `CallerReference` を生成しました。独自の `CallerReference` を指定したり、キャッシュ削除パラメータをコマンドライン引数として渡さないようにしたりするには、JSON ファイルを使用できます。次の例では、`inv-batch.json` という名前の JSON ファイルでキャッシュ削除パラメータを指定して、2 つのファイルのキャッシュ削除を作成します。 ``` aws cloudfront create-invalidation \ --distribution-id EDFDVBD6EXAMPLE \ --invalidation-batch file://inv-batch.json ``` `inv-batch.json` の内容: ``` { "Paths": { "Quantity": 2, "Items": [ "/example-path/example-file.jpg", "/example-path/example-file2.png" ] }, "CallerReference": "cli-example" } ``` 出力: ``` { "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" } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateInvalidation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/create-invalidation.html)」を参照してください。 ### `create-public-key` 次のコード例は、`create-public-key` を使用する方法を示しています。 **AWS CLI** **CloudFront パブリックキーを作成するには** 次の例では、`pub-key-config.json` という名前の JSON ファイルでパラメータを指定して、CloudFront パブリックキーを作成します。このコマンドを使用するには、事前に PEM でエンコードされたパブリックキーが必要です。詳細については、「Amazon CloudFront 開発者ガイド」の「[RSA キーペアを作成する](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/field-level-encryption.html#field-level-encryption-setting-up-step1)」を参照してください。** ``` aws cloudfront create-public-key \ --public-key-config file://pub-key-config.json ``` `pub-key-config.json` ファイルは、以下を含む現在のフォルダ内にある JSON ドキュメントです。パブリックキーは 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" } ``` 出力: ``` { "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" } } } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[CreatePublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/create-public-key.html)」を参照してください。** ### `delete-cloud-front-origin-access-identity` 次のコード例は、`delete-cloud-front-origin-access-identity` を使用する方法を示しています。 **AWS CLI** **CloudFront オリジンアクセスアイデンティティを削除するには** 次の例では、`E74FTE3AEXAMPLE` という ID のオリジンアクセスアイデンティティ (OAI) を削除しています。OAI を削除するには、OAI の ID と `ETag` が必要です。OAI ID は、create-cloud-front-origin-access-identity コマンドと list-cloud-front-origin-access-identities コマンドの出力で返されます。`ETag` を取得するには、get-cloud-front-origin-access-identity コマンドまたは get-cloud-front-origin-access-identity-config コマンドを使用します。`--if-match` オプションを使用して、OAI の `ETag` を指定します。 ``` aws cloudfront delete-cloud-front-origin-access-identity \ --id E74FTE3AEXAMPLE \ --if-match E2QWRUHEXAMPLE ``` 成功した場合は、コマンドの出力はありません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCloudFrontOriginAccessIdentity](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/delete-cloud-front-origin-access-identity.html)」を参照してください。 ### `delete-connection-group` 次のコード例は、`delete-connection-group` を使用する方法を示しています。 **AWS CLI** **接続グループを削除するには** 次の `delete-connection-group` の例では、接続グループを削除します。接続グループは無効にする必要があり、どの CloudFront リソースにも関連付けることはできません。 ``` aws cloudfront delete-connection-group \ --id cg_2wjLpjbHkLUdhWAjHllcOeABC \ --if-match ETVPDKIKX0DABC ``` 成功した場合は、コマンドの出力はありません。 接続グループの管理の詳細については、「*Amazon CloudFront デベロッパーガイド*」の「[カスタム接続グループを作成する (オプション)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-connection-group.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteConnectionGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/delete-connection-group.html)」を参照してください。 ### `delete-distribution-tenant` 次のコード例は、`delete-distribution-tenant` を使用する方法を示しています。 **AWS CLI** **ディストリビューションテナントを削除するには** 次の `delete-distribution-tenant` の例では、ETag `ETVPDKIKX0DABC` を使用してディストリビューションテナントを削除します。ディストリビューションテナントは無効にする必要があり、どの CloudFront リソースにも関連付けることはできません。 ``` aws cloudfront delete-distribution-tenant \ --id dt_2wjMUbg3NHZEQ7OfoalP5zi1AB \ --if-match ETVPDKIKX0DABC ``` 成功した場合は、コマンドの出力はありません。 詳細については、「*Amazon CloudFront デベロッパーガイド*」の「[ディストリビューションを削除する](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/HowToDeleteDistribution.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDistributionTenant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/delete-distribution-tenant.html)」を参照してください。 ### `delete-distribution` 次のコード例は、`delete-distribution` を使用する方法を示しています。 **AWS CLI** **CloudFront ディストリビューションを削除するには** 次の例では、ID `EDFDVBD6EXAMPLE` の付いた CloudFront ディストリビューションを削除します。ディストリビューションを削除する前に、ディストリビューションを無効にする必要があります。ディストリビューションを無効にするには、update-distribution コマンドを使用します。詳細については、update-distribution の例を参照してください。 ディストリビューションを無効にすると、ディストリビューションを削除できます。ディストリビューションを削除するには、`--if-match` オプションを使用してディストリビューション の`ETag` を指定する必要があります。`ETag` を取得するには、get-distribution コマンドまたは get-distribution-config コマンドを使用します。 ``` aws cloudfront delete-distribution \ --id EDFDVBD6EXAMPLE \ --if-match E2QWRUHEXAMPLE ``` 成功した場合は、コマンドの出力はありません。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[DeleteDistribution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/delete-distribution.html)」を参照してください。** ### `delete-field-level-encryption-config` 次のコード例は、`delete-field-level-encryption-config` を使用する方法を示しています。 **AWS CLI** **CloudFront のフィールドレベル暗号化の設定を削除するには** 次の例では、`C3KM2WVD605UAY` という ID を持つ CloudFront のフィールドレベル暗号化の設定を削除しています。フィールドレベル暗号化の設定を削除するには、その ID と `ETag` が必要です。ID は create-field-level-encryption-config コマンドと list-field-level-encryption-configs コマンドの出力で返されます。`ETag` を取得するには、get-field-level-encryption コマンドまたは get-field-level-encryption-config コマンドを使用します。`--if-match` オプションを使用して、設定の `ETag` を指定します。 ``` aws cloudfront delete-field-level-encryption-config \ --id C3KM2WVD605UAY \ --if-match E26M4BIAV81ZF6 ``` 成功した場合は、コマンドの出力はありません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteFieldLevelEncryptionConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/delete-field-level-encryption-config.html)」を参照してください。 ### `delete-field-level-encryption-profile` 次のコード例は、`delete-field-level-encryption-profile` を使用する方法を示しています。 **AWS CLI** **CloudFront のフィールドレベル暗号化のプロファイルを削除するには** 次の例では、`PPK0UOSIF5WSV` という ID を持つ CloudFront のフィールドレベル暗号化のプロファイルを削除しています。フィールドレベル暗号化のプロファイルを削除するには、その ID と `ETag` が必要です。ID は create-field-level-encryption-profile コマンドと list-field-level-encryption-profiles コマンドの出力で返されます。`ETag` を取得するには、get-field-level-encryption-profile コマンドまたは get-field-level-encryption-profile-config コマンドを使用します。`--if-match` オプションを使用して、プロファイルの `ETag` を指定します。 ``` aws cloudfront delete-field-level-encryption-profile \ --id PPK0UOSIF5WSV \ --if-match EJETYFJ9CL66D ``` 成功した場合は、コマンドの出力はありません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteFieldLevelEncryptionProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/delete-field-level-encryption-profile.html)」を参照してください。 ### `delete-public-key` 次のコード例は、`delete-public-key` を使用する方法を示しています。 **AWS CLI** **CloudFront パブリックキーを削除するには** 次の例では、`KDFB19YGCR002` という ID を持つ CloudFront パブリックキーを削除しています。パブリックキーを削除するには、その ID と `ETag` が必要です。ID は create-public-key コマンドと list-public-keys コマンドの出力で返されます。`ETag` を取得するには、get-public-key コマンドまたは get-public-key-config コマンドを使用します。`--if-match` オプションを使用して、パブリックキーの `ETag` を指定します。 ``` aws cloudfront delete-public-key \ --id KDFB19YGCR002 \ --if-match E2QWRUHEXAMPLE ``` 成功した場合は、コマンドの出力はありません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeletePublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/delete-public-key.html)」を参照してください。 ### `disassociate-distribution-tenant-web-acl` 次のコード例は、`disassociate-distribution-tenant-web-acl` を使用する方法を示しています。 **AWS CLI** **ウェブ ACL とディストリビューションテナントの関連付けを解除するには** 次の `disassociate-distribution-tenant-web-acl` の例では、ETag `E1PA6795UKMABC` を使用してディストリビューションテナントからウェブ ACL の関連付けを解除します。 ``` aws cloudfront disassociate-distribution-tenant-web-acl \ --id dt_2wjDZi3hD1ivOXf6rpZJOSNE1AB \ --if-match E1PA6795UKMABC ``` 出力: ``` { "ETag": "E13V1IB3VIYABC", "Id": "dt_2wjDZi3hD1ivOXf6rpZJOSNE1AB" } ``` 詳細については、「*Amazon CloudFront デベロッパーガイド*」の「[AWS WAF セキュリティ保護を無効にする](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/disable-waf.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateDistributionTenantWebAcl](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/disassociate-distribution-tenant-web-acl.html)」を参照してください。 ### `disassociate-distribution-web-acl` 次のコード例は、`disassociate-distribution-web-acl` を使用する方法を示しています。 **AWS CLI** **ウェブ ACL と CloudFront ディストリビューションの関連付けを解除するには** 次の `disassociate-distribution-web-acl` の例では、ETag `E13V1IB3VIYABC` を使用してウェブ ACL と CloudFront ディストリビューション間の関連付けを解除します。 ``` aws cloudfront disassociate-distribution-web-acl \ --id E1XNX8R2GOAABC \ --if-match EEZQ9Z24VM1ABC ``` 出力: ``` { "ETag": "E2YWS1C2J3OABC", "Id": "E1XNX8R2GOAABC" } ``` 詳細については、「*Amazon CloudFront デベロッパーガイド*」の「[AWS WAF セキュリティ保護を無効にする](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/disable-waf.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateDistributionWebAcl](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/disassociate-distribution-web-acl.html)」を参照してください。 ### `get-cloud-front-origin-access-identity-config` 次のコード例は、`get-cloud-front-origin-access-identity-config` を使用する方法を示しています。 **AWS CLI** **CloudFront オリジンアクセスアイデンティティ設定を取得するには** 次の例では、ID が `E74FTE3AEXAMPLE` である CloudFront オリジンアクセスアイデンティティ (OAI) に関するメタデータ (`ETag` を含む) を取得します。OAI ID は、create-cloud-front-origin-access-identity コマンドと list-cloud-front-origin-access-identities コマンドの出力で返されます。 ``` aws cloudfront get-cloud-front-origin-access-identity-config --id E74FTE3AEXAMPLE ``` 出力: ``` { "ETag": "E2QWRUHEXAMPLE", "CloudFrontOriginAccessIdentityConfig": { "CallerReference": "cli-example", "Comment": "Example OAI" } } ``` + API の詳細については、「AWS CLI コマンドリファレンス」の「[GetCloudFrontOriginAccessIdentityConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-cloud-front-origin-access-identity-config.html)」を参照してください。** ### `get-cloud-front-origin-access-identity` 次のコード例は、`get-cloud-front-origin-access-identity` を使用する方法を示しています。 **AWS CLI** **CloudFront オリジンアクセスアイデンティティを取得するには** 次の例では、ID が `E74FTE3AEXAMPLE` である CloudFront オリジンアクセスアイデンティティ (OAI) を、`ETag` および関連する S3 正規 ID を含めて取得します。OAI ID は、create-cloud-front-origin-access-identity コマンドと list-cloud-front-origin-access-identities コマンドの出力で返されます。 ``` aws cloudfront get-cloud-front-origin-access-identity --id E74FTE3AEXAMPLE ``` 出力: ``` { "ETag": "E2QWRUHEXAMPLE", "CloudFrontOriginAccessIdentity": { "Id": "E74FTE3AEXAMPLE", "S3CanonicalUserId": "cd13868f797c227fbea2830611a26fe0a21ba1b826ab4bed9b7771c9aEXAMPLE", "CloudFrontOriginAccessIdentityConfig": { "CallerReference": "cli-example", "Comment": "Example OAI" } } } ``` + API の詳細については、「AWS CLI コマンドリファレンス」の「[GetCloudFrontOriginAccessIdentity](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-cloud-front-origin-access-identity.html)」を参照してください。** ### `get-connection-group-by-routing-endpoint` 次のコード例は、`get-connection-group-by-routing-endpoint` を使用する方法を示しています。 **AWS CLI** **ルーティングエンドポイントで接続グループを取得するには** 次の `get-connection-group-by-routing-endpoint` の例では、ルーティングエンドポイントを使用して接続グループに関する情報を取得します。 ``` aws cloudfront get-connection-group-by-routing-endpoint \ --routing-endpoint dvdg9gprgabc.cloudfront.net ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon CloudFront デベロッパーガイド*」の「[カスタム接続グループの作成 (オプション)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-connection-group.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetConnectionGroupByRoutingEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-connection-group-by-routing-endpoint.html)」を参照してください。 ### `get-connection-group` 次のコード例は、`get-connection-group` を使用する方法を示しています。 **AWS CLI** **CloudFront 接続グループを取得するには** 次の `get-connection-group` の例では、CloudFront 接続グループに関する情報を取得します。 ``` aws cloudfront get-connection-group \ --identifier cg_2wjDWTBKTlRB87cAaUQFaakABC ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon CloudFront デベロッパーガイド*」の「[カスタム接続グループの作成 (オプション)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-connection-group.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetConnectionGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-connection-group.html)」を参照してください。 ### `get-distribution-config` 次のコード例は、`get-distribution-config` を使用する方法を示しています。 **AWS CLI** **CloudFront ディストリビューション設定を取得するには** 次の例では、ID `EDFDVBD6EXAMPLE` の CloudFront ディストリビューションに関するメタデータ (`ETag` を含む) を取得します。ディストリビューション ID は create-distribution コマンドと list-distributions コマンドで返されます。 ``` aws cloudfront get-distribution-config \ --id EDFDVBD6EXAMPLE ``` 出力: ``` { "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 } } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[GetDistributionConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-distribution-config.html)」を参照してください。** ### `get-distribution-tenant-by-domain` 次のコード例は、`get-distribution-tenant-by-domain` を使用する方法を示しています。 **AWS CLI** **ドメイン別にディストリビューションテナント情報を取得するには** 次の `get-distribution-tenant-by-domain` の例では、指定されたドメインを使用してディストリビューションテナントに関する情報を取得します。 ``` aws cloudfront get-distribution-tenant-by-domain \ --domain example.com ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon CloudFront デベロッパーガイド*」の「[Understand how multi-tenant distributions work](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDistributionTenantByDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-distribution-tenant-by-domain.html)」を参照してください。 ### `get-distribution-tenant` 次のコード例は、`get-distribution-tenant` を使用する方法を示しています。 **AWS CLI** **CloudFront ディストリビューションテナントに関する詳細を取得するには** 次の `get-distribution-tenant` の例では、CloudFront ディストリビューションテナントに関する情報を取得します。 ``` aws cloudfront get-distribution-tenant \ --id dt_2wjDZi3hD1ivOXf6rpZJOSNE1AB ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon CloudFront デベロッパーガイド*」の「[Understand how multi-tenant distributions work](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDistributionTenant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-distribution-tenant.html)」を参照してください。 ### `get-distribution` 次のコード例は、`get-distribution` を使用する方法を示しています。 **AWS CLI** **CloudFront ディストリビューションを取得するには** 次の `get-distribution` の例では、ID が `EDFDVBD6EXAMPLE` である CloudFront ディストリビューション (`ETag` を含む) を取得します。ディストリビューション ID は create-distribution コマンドと list-distributions コマンドで返されます。 ``` aws cloudfront get-distribution \ --id EDFDVBD6EXAMPLE ``` 出力: ``` { "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 } } } ``` + API の詳細については、「AWS CLI コマンドリファレンス」の「[GetDistribution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-distribution.html)」を参照してください。** ### `get-field-level-encryption-config` 次のコード例は、`get-field-level-encryption-config` を使用する方法を示しています。 **AWS CLI** **CloudFront のフィールドレベル暗号化の設定に関するメタデータを取得するには** 次の例では、`C3KM2WVD605UAY` という ID を持つ CloudFront のフィールドレベル暗号化の設定に関するメタデータ (`ETag` を含む) を取得しています。 ``` aws cloudfront get-field-level-encryption-config --id C3KM2WVD605UAY ``` 出力: ``` { "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" } ] } } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetFieldLevelEncryptionConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-field-level-encryption-config.html)」を参照してください。 ### `get-field-level-encryption-profile-config` 次のコード例は、`get-field-level-encryption-profile-config` を使用する方法を示しています。 **AWS CLI** **CloudFront のフィールドレベル暗号化のプロファイル設定を取得するには** 次の例では、`PPK0UOSIF5WSV` という ID を持つ CloudFront のフィールドレベル暗号化のプロファイルに関するメタデータ (`ETag` を含む) を取得しています。 ``` aws cloudfront get-field-level-encryption-profile-config --id PPK0UOSIF5WSV ``` 出力: ``` { "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" ] } } ] } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetFieldLevelEncryptionProfileConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-field-level-encryption-profile-config.html)」を参照してください。 ### `get-field-level-encryption-profile` 次のコード例は、`get-field-level-encryption-profile` を使用する方法を示しています。 **AWS CLI** **CloudFront のフィールドレベル暗号化のプロファイルを取得するには** 次の例では、`PPK0UOSIF5WSV` という ID を持つ CloudFront のフィールドレベル暗号化のプロファイル (`ETag` を含む) を取得しています。 ``` aws cloudfront get-field-level-encryption-profile --id PPK0UOSIF5WSV ``` 出力: ``` { "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" ] } } ] } } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetFieldLevelEncryptionProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-field-level-encryption-profile.html)」を参照してください。 ### `get-field-level-encryption` 次のコード例は、`get-field-level-encryption` を使用する方法を示しています。 **AWS CLI** **CloudFront のフィールドレベル暗号化の設定を取得するには** 次の例では、`C3KM2WVD605UAY` という ID を持つ CloudFront のフィールドレベル暗号化の設定 (`ETag` を含む) を取得しています。 ``` aws cloudfront get-field-level-encryption --id 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" } ] } } } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetFieldLevelEncryption](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-field-level-encryption.html)」を参照してください。 ### `get-invalidation-for-distribution-tenant` 次のコード例は、`get-invalidation-for-distribution-tenant` を使用する方法を示しています。 **AWS CLI** **ディストリビューションテナントの無効化を取得するには** 次の `get-invalidation-for-distribution-tenant` の例では、ディストリビューションテナントの無効化に関する情報を取得します。 ``` aws cloudfront get-invalidation-for-distribution-tenant \ --distribution-tenant-id dt_2wjDZi3hD1ivOXf6rpZJOSNE1AB \ --id I4CU23QAPKMUDUU06F9OFGFABC ``` 出力: ``` { "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" } } } ``` 詳細については、「*Amazon CloudFront デベロッパーガイド*」の「[ファイルを無効化してコンテンツを削除する](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetInvalidationForDistributionTenant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-invalidation-for-distribution-tenant.html)」を参照してください。 ### `get-invalidation` 次のコード例は、`get-invalidation` を使用する方法を示しています。 **AWS CLI** **CloudFront の無効化を取得するには** 次の例では、`EDFDVBD6EXAMPLE` という ID を持つ CloudFront ディストリビューションについて、`I2J0I21PCUYOIK` という ID の無効化を取得しています。 ``` aws cloudfront get-invalidation --id I2J0I21PCUYOIK --distribution-id EDFDVBD6EXAMPLE ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetInvalidation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-invalidation.html)」を参照してください。 ### `get-managed-certificate-details` 次のコード例は、`get-managed-certificate-details` を使用する方法を示しています。 **AWS CLI** **マネージド証明書の詳細を取得するには** 次の `get-managed-certificate-details` の例では、CloudFront マネージド ACM 証明書の詳細を取得します。 ``` aws cloudfront get-managed-certificate-details \ --identifier dt_2wjDZi3hD1ivOXf6rpZJOSNE1AB ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*Amazon CloudFront デベロッパーガイド*」の「[CloudFront ディストリビューションテナントの証明書をリクエストする](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/managed-cloudfront-certificates.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetManagedCertificateDetails](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-managed-certificate-details.html)」を参照してください。 ### `get-public-key-config` 次のコード例は、`get-public-key-config` を使用する方法を示しています。 **AWS CLI** **CloudFront パブリックキーの設定を取得するには** 次の例では、`KDFB19YGCR002` という ID を持つ CloudFront パブリックキーに関するメタデータ (`ETag` を含む) を取得します。パブリックキー ID は create-public-key コマンドと list-public-keys コマンドで返されます。 ``` aws cloudfront get-public-key-config --id KDFB19YGCR002 ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPublicKeyConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-public-key-config.html)」を参照してください。 ### `get-public-key` 次のコード例は、`get-public-key` を使用する方法を示しています。 **AWS CLI** **CloudFront パブリックキーを取得するには** 次の例では、`KDFB19YGCR002` という ID を持つ CloudFront パブリックキー (`ETag` を含む) を取得します。パブリックキー ID は create-public-key コマンドと list-public-keys コマンドで返されます。 ``` aws cloudfront get-public-key --id 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" } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/get-public-key.html)」を参照してください。 ### `list-cloud-front-origin-access-identities` 次のコード例は、`list-cloud-front-origin-access-identities` を使用する方法を示しています。 **AWS CLI** **CloudFront オリジンアクセスアイデンティティを一覧表示するには** 次の例では、AWS アカウント内の CloudFront オリジンアクセスアイデンティティ (OAI) の一覧を取得します。 ``` aws cloudfront list-cloud-front-origin-access-identities ``` 出力: ``` { "CloudFrontOriginAccessIdentityList": { "Items": [ { "Id": "E74FTE3AEXAMPLE", "S3CanonicalUserId": "cd13868f797c227fbea2830611a26fe0a21ba1b826ab4bed9b7771c9aEXAMPLE", "Comment": "Example OAI" }, { "Id": "EH1HDMBEXAMPLE", "S3CanonicalUserId": "1489f6f2e6faacaae7ff64c4c3e6956c24f78788abfc1718c3527c263bf7a17EXAMPLE", "Comment": "Test OAI" }, { "Id": "E2X2C9TEXAMPLE", "S3CanonicalUserId": "cbfeebb915a64749f9be546a45b3fcfd3a31c779673c13c4dd460911ae402c2EXAMPLE", "Comment": "Example OAI #2" } ] } } ``` + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListCloudFrontOriginAccessIdentities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/list-cloud-front-origin-access-identities.html)」を参照してください。** ### `list-connection-groups` 次のコード例は、`list-connection-groups` を使用する方法を示しています。 **AWS CLI** **接続グループを一覧表示するには** 次の `list-connection-groups` の例では、AWS アカウントで使用可能な接続グループを一覧表示します。 ``` aws cloudfront list-connection-groups ``` 出力: ``` { "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 } ] } ``` 詳細については、「*Amazon CloudFront デベロッパーガイド*」の「[カスタム接続グループの作成 (オプション)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-connection-group.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListConnectionGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/list-connection-groups.html)」を参照してください。 ### `list-distribution-tenants-by-customization` 次のコード例は、`list-distribution-tenants-by-customization` を使用する方法を示しています。 **AWS CLI** **カスタマイズ別にディストリビューションテナントを一覧表示するには** 次の `list-distribution-tenants-by-customization` の例では、指定されたウェブ ACL を使用するディストリビューションテナントを一覧表示します。 ``` 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 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon CloudFront デベロッパーガイド*」の「[ディストリビューションテナントのカスタマイズ](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/tenant-customization.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDistributionTenantsByCustomization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/list-distribution-tenants-by-customization.html)」を参照してください。 ### `list-distribution-tenants` 次のコード例は、`list-distribution-tenants` を使用する方法を示しています。 **AWS CLI** **CloudFront ディストリビューションテナントを一覧表示するには** 次の `list-distribution-tenants` の例では、関連付けられた接続グループごとに AWS アカウント内の 3 つの CloudFront ディストリビューションテナントを一覧表示します。 ``` aws cloudfront list-distribution-tenants \ --association-filter ConnectionGroupId=cg_2whCJoXMYCjHcxaLGrkllvyABC \ --max-items 3 ``` 出力: ``` { "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==" } ``` 詳細については、「*Amazon CloudFront デベロッパーガイド*」の「[Understand how multi-tenant distributions work](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-config-options.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDistributionTenants](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/list-distribution-tenants.html)」を参照してください。 ### `list-distributions-by-connection-mode` 次のコード例は、`list-distributions-by-connection-mode` を使用する方法を示しています。 **AWS CLI** **接続モードごとに CloudFront ディストリビューションを一覧表示するには** 次の `list-distributions-by-connection-mode` の例では、指定された接続モードの CloudFront ディストリビューションを一覧表示します。 ``` aws cloudfront list-distributions-by-connection-mode \ --connection-mode tenant-only ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*Amazon CloudFront デベロッパーガイド*」の「[カスタム接続グループの作成 (オプション)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-connection-group.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDistributionsByConnectionMode](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/list-distributions-by-connection-mode.html)」を参照してください。 ### `list-distributions` 次のコード例は、`list-distributions` を使用する方法を示しています。 **AWS CLI** **CloudFront ディストリビューションを一覧表示するには** 次の例では、AWS アカウントの CloudFront ディストリビューションのリストを取得します。 ``` aws cloudfront list-distributions ``` 出力: ``` { "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 } ] } } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[ListDistributions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/list-distributions.html)」を参照してください。** ### `list-domain-conflicts` 次のコード例は、`list-domain-conflicts` を使用する方法を示しています。 **AWS CLI** **CloudFront ディストリビューションのドメイン競合を一覧表示するには** 次の `list-domain-conflicts` の例では、CloudFront ディストリビューションのドメイン競合を一覧表示します。 ``` aws cloudfront list-domain-conflicts \ --domain example.com \ --domain-control-validation-resource "DistributionTenantId=dt_2x9GhoK0TZRsohWzv1b9It8J1AB" ``` 出力: ``` { "DomainConflicts": [ { "Domain": "example.com", "ResourceType": "distribution-tenant", "ResourceId": "***************ohWzv1b9It8J1AB", "AccountId": "123456789012" } ] } ``` 詳細については、「*Amazon CloudFront デベロッパーガイド*」の「[代替ドメイン名を別のディストリビューションに移動する](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/alternate-domain-names-move.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDomainConflicts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/list-domain-conflicts.html)」を参照してください。 ### `list-field-level-encryption-configs` 次のコード例は、`list-field-level-encryption-configs` を使用する方法を示しています。 **AWS CLI** **CloudFront のフィールドレベル暗号化の設定を一覧表示するには** 次の例では、AWS アカウントの CloudFront のフィールドレベル暗号化の設定のリストを取得しています。 ``` aws cloudfront list-field-level-encryption-configs ``` 出力: ``` { "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" } ] } } } ] } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListFieldLevelEncryptionConfigs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/list-field-level-encryption-configs.html)」を参照してください。 ### `list-field-level-encryption-profiles` 次のコード例は、`list-field-level-encryption-profiles` を使用する方法を示しています。 **AWS CLI** **CloudFront のフィールドレベル暗号化のプロファイルを一覧表示するには** 次の例では、AWS アカウントの CloudFront のフィールドレベル暗号化のプロファイルのリストを取得しています。 ``` aws cloudfront list-field-level-encryption-profiles ``` 出力: ``` { "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" } ] } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListFieldLevelEncryptionProfiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/list-field-level-encryption-profiles.html)」を参照してください。 ### `list-invalidations-for-distribution-tenant` 次のコード例は、`list-invalidations-for-distribution-tenant` を使用する方法を示しています。 **AWS CLI** **CloudFront ディストリビューションテナントの無効化を一覧表示するには** 次の `list-invalidations-for-distribution-tenant` の例では、CloudFront ディストリビューションテナントの無効化を一覧表示します。 ``` aws cloudfront list-invalidations-for-distribution-tenant \ --id dt_2wjDZi3hD1ivOXf6rpZJOSNE1AB ``` 出力: ``` { "InvalidationList": { "Items": [ { "Id": "I4CU23QAPKMUDUU06F9OFGFABC", "CreateTime": "2025-05-06T15:46:12.824000+00:00", "Status": "Completed" } ] } } ``` 詳細については、「*Amazon CloudFront デベロッパーガイド*」の「[ファイルを無効化してコンテンツを削除する](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListInvalidationsForDistributionTenant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/list-invalidations-for-distribution-tenant.html)」を参照してください。 ### `list-invalidations` 次のコード例は、`list-invalidations` を使用する方法を示しています。 **AWS CLI** **CloudFront の無効化を一覧表示するには** 次の例では、`EDFDVBD6EXAMPLE` という ID を持つ CloudFront ディストリビューションの無効化のリストを取得しています。 ``` aws cloudfront list-invalidations --distribution-id EDFDVBD6EXAMPLE ``` 出力: ``` { "InvalidationList": { "Marker": "", "Items": [ { "Status": "Completed", "Id": "YNY2LI2BVJ4NJU", "CreateTime": "2019-08-31T21:15:52.042Z" } ], "IsTruncated": false, "MaxItems": 100, "Quantity": 1 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListInvalidations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/list-invalidations.html)」を参照してください。 ### `list-public-keys` 次のコード例は、`list-public-keys` を使用する方法を示しています。 **AWS CLI** **CloudFront パブリックキーを一覧表示するには** 次の例では、AWS アカウントの CloudFront パブリックキーの一覧を取得しています。 ``` aws cloudfront list-public-keys ``` 出力: ``` { "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" } ] } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPublicKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/list-public-keys.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **CloudFront ディストリビューションのタグを一覧表示するには** 次の例は、CloudFront ディストリビューションのタグのリストを取得しています。 ``` aws cloudfront list-tags-for-resource \ --resource arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE ``` 出力: ``` { "Tags": { "Items": [ { "Key": "DateCreated", "Value": "2019-12-04" }, { "Key": "Name", "Value": "Example name" }, { "Key": "Project", "Value": "Example project" } ] } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/list-tags-for-resource.html)」を参照してください。 ### `sign` 次のコード例は、`sign` を使用する方法を示しています。 **AWS CLI** **CloudFront URL に署名するには** 次の例では、CloudFront URL に署名しています。URL に署名するには、キーペア ID (AWS マネジメントコンソールでは**アクセスキー ID** と呼ばれます) と、信頼された署名者の CloudFront キーペアのプライベートキーが必要です。署名付き URL の詳細については、「*Amazon CloudFront 開発者ガイド*」の「[署名付き URL と署名付き Cookie を使用してプライベートコンテンツを供給する](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html)」を参照してください。 ``` 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 ``` 出力: ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[Sign](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/sign.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **CloudFront ディストリビューションにタグを追加するには** 次の `tag-resource` の例では、指定された CloudFront ディストリビューションに 2 つのタグを追加しています。 ``` aws cloudfront tag-resource \ --resource arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE \ --tags 'Items=[{Key=Name,Value="Example name"},{Key=Project,Value="Example project"}]' ``` 次の例に示すように、コマンドライン引数を使用する代わりに、JSON ファイルでタグを指定できます。 ``` aws cloudfront tag-resource \ --resource arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE \ --tags file://tags.json ``` `tags.json` の内容: ``` { "Items": [ { "Key": "Name", "Value": "Example name" }, { "Key": "Project", "Value": "Example project" } ] } ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **CloudFront ディストリビューションからタグを削除するには** 次の例では、コマンドライン引数を使用して CloudFront ディストリビューションから 2 つのタグを削除しています。 ``` aws cloudfront untag-resource \ --resource arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE \ --tag-keys Items=Name,Project ``` 次の例に示すように、コマンドライン引数を使用する代わりに、JSON ファイルでタグキーを指定できます。 ``` aws cloudfront untag-resource \ --resource arn:aws:cloudfront::123456789012:distribution/EDFDVBD6EXAMPLE \ --tag-keys file://tag-keys.json ``` `tag-keys.json` ファイルは、以下を含む現在のフォルダ内にある JSON ドキュメントです。 ``` { "Items": [ "Name", "Project" ] } ``` 成功した場合は、コマンドの出力はありません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/untag-resource.html)」を参照してください。 ### `update-cloud-front-origin-access-identity` 次のコード例は、`update-cloud-front-origin-access-identity` を使用する方法を示しています。 **AWS CLI** **CloudFront オリジンアクセスアイデンティティを更新するには** 次のリクエスト例では、`E74FTE3AEXAMPLE` という ID のオリジンアクセスアイデンティティ (OAI) を更新しています。更新できるフィールドは、OAI の `Comment` のみです。 OAI を更新するには、OAI の ID と `ETag` が必要です。OAI ID は、create-cloud-front-origin-access-identity コマンドと list-cloud-front-origin-access-identities コマンドの出力で返されます。`ETag` を取得するには、get-cloud-front-origin-access-identity コマンドまたは get-cloud-front-origin-access-identity-config コマンドを使用します。`--if-match` オプションを使用して、OAI の `ETag` を指定します。 ``` 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" ``` 次の例に示すように、同じことは、JSON ファイルで OAI 設定を指定することでも実現できます。 ``` aws cloudfront update-cloud-front-origin-access-identity \ --id E74FTE3AEXAMPLE \ --if-match E2QWRUHEXAMPLE \ --cloud-front-origin-access-identity-config file://OAI-config.json ``` `OAI-config.json` ファイルは、以下を含む現在のディレクトリ内にある JSON ドキュメントです。 ``` { "CallerReference": "cli-example", "Comment": "Example OAI Updated" } ``` OAI 設定をコマンドライン引数で指定する場合も、JSON ファイルで指定する場合も、出力は変わりません。 ``` { "ETag": "E9LHASXEXAMPLE", "CloudFrontOriginAccessIdentity": { "Id": "E74FTE3AEXAMPLE", "S3CanonicalUserId": "cd13868f797c227fbea2830611a26fe0a21ba1b826ab4bed9b7771c9aEXAMPLE", "CloudFrontOriginAccessIdentityConfig": { "CallerReference": "cli-example", "Comment": "Example OAI Updated" } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateCloudFrontOriginAccessIdentity](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/update-cloud-front-origin-access-identity.html)」を参照してください。 ### `update-connection-group` 次のコード例は、`update-connection-group` を使用する方法を示しています。 **AWS CLI** **CloudFront 接続グループを更新するには** 次の `update-connection-group` の例では、CloudFront 接続グループを無効にし、IPv6 を無効にします。 ``` aws cloudfront update-connection-group \ --id cg_2yHsDkcPKeUlVkk3aEgLKcjABC \ --no-ipv6-enabled \ --no-enabled \ --if-match E3UN6WX5RRO2ABC ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon CloudFront デベロッパーガイド*」の「[カスタム接続グループの作成 (オプション)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-connection-group.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateConnectionGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/update-connection-group.html)」を参照してください。 ### `update-distribution-tenant` 次のコード例は、`update-distribution-tenant` を使用する方法を示しています。 **AWS CLI** **CloudFront ディストリビューションテナントを更新するには** 次の `update-distribution-tenant` の例では、新しいパラメータ値で CloudFront ディストリビューションテナントを更新し、地域制限に国を追加します。 ``` aws cloudfront update-distribution-tenant \ --cli-input-json file://update-tenant.json ``` `update-tenant.json` の内容: ``` { "Id": "dt_2yMvQgam3QkJo2z54FDl91dk1AB", "IfMatch": "E1F83G8C2ARABC", "Parameters": [ { "Name": "testParam", "Value": "newParameterValue" } ], "Customizations": { "WebAcl": { "Action": "disable" }, "GeoRestrictions": { "RestrictionType": "whitelist", "Locations": [ "DE", "GB", "ES" ] } } } ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon CloudFront デベロッパーガイド*」の「[ディストリビューションテナントのカスタマイズ](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/tenant-customization.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateDistributionTenant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/update-distribution-tenant.html)」を参照してください。 ### `update-distribution` 次のコード例は、`update-distribution` を使用する方法を示しています。 **AWS CLI** **例 1: CloudFront ディストリビューションのデフォルトルートオブジェクトを更新するには** 次の例では、ID が `EDFDVBD6EXAMPLE` の CloudFront ディストリビューションのデフォルトルートオブジェクトを `index.html` に更新します。 ``` aws cloudfront update-distribution \ --id EDFDVBD6EXAMPLE \ --default-root-object index.html ``` 出力: ``` { "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 } } } ``` **例 2: CloudFront ディストリビューションを更新するには** 次の例では、`dist-config-disable.json` という名前の JSON ファイルでディストリビューション設定を指定して、ID `EMLARXS9EXAMPLE` を持つ CloudFront ディストリビューションを無効にします。ディストリビューションを更新するには、`--if-match` オプションを使用してディストリビューションの `ETag` を指定する必要があります。`ETag` を取得するには、get-distribution コマンドまたは get-distribution-config コマンドを使用します。JSON ファイルでは `Enabled` フィールドが `false` に設定されていることに注意してください。 次の例を使用してディストリビューションを無効にした後は、delete-distribution コマンドを使用してディストリビューションを削除できます。 ``` aws cloudfront update-distribution \ --id EMLARXS9EXAMPLE \ --if-match E2QWRUHEXAMPLE \ --distribution-config file://dist-config-disable.json ``` `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 } ``` 出力: ``` { "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 } } } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[UpdateDistribution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/update-distribution.html)」を参照してください。** ### `update-domain-association` 次のコード例は、`update-domain-association` を使用する方法を示しています。 **AWS CLI** **ドメインの関連付けを更新するには** 次の `update-domain-association` の例では、ETag `E23ZP02F085ABC` を使用してディストリビューションテナントのドメインの関連付けを更新します。 ``` aws cloudfront update-domain-association \ --domain example.com \ --target-resource DistributionTenantId=dt_2x9GhoK0TZRsohWzv1b9It8J1AB \ --if-match E23ZP02F085ABC ``` 出力: ``` { "ETag": "ETVPDKIKX0ABC", "Domain": "example.com", "ResourceId": "dt_2x9GhoK0TZRsohWzv1b9It8J1AB" } ``` 詳細については、「*Amazon CloudFront デベロッパーガイド*」の「[代替ドメイン名を別のディストリビューションに移動する](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/alternate-domain-names-move.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateDomainAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/update-domain-association.html)」を参照してください。 ### `update-field-level-encryption-config` 次のコード例は、`update-field-level-encryption-config` を使用する方法を示しています。 **AWS CLI** **CloudFront のフィールドレベル暗号化の設定を更新するには** 次の例では、JSON ファイルにパラメータを指定することで、`C3KM2WVD605UAY` という ID を持つフィールドレベル暗号化の設定の `Comment` フィールドを更新しています。 フィールドレベル暗号化の設定を更新するには、設定の ID と `ETag` が必要です。ID は create-field-level-encryption-config コマンドと list-field-level-encryption-configs コマンドの出力で返されます。`ETag` を取得するには、get-field-level-encryption コマンドまたは get-field-level-encryption-config コマンドを使用します。`--if-match` オプションを使用して、設定の `ETag` を指定します。 ``` aws cloudfront update-field-level-encryption-config \ --id C3KM2WVD605UAY \ --if-match E2P4Z4VU7TY5SG \ --field-level-encryption-config file://fle-config.json ``` `fle-config.json` ファイルは、以下を含む現在のディレクトリ内にある JSON ドキュメントです。 ``` { "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" } ] } } } ``` 出力: ``` { "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" } ] } } } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateFieldLevelEncryptionConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/update-field-level-encryption-config.html)」を参照してください。 ### `update-field-level-encryption-profile` 次のコード例は、`update-field-level-encryption-profile` を使用する方法を示しています。 **AWS CLI** **CloudFront のフィールドレベル暗号化のプロファイルを更新するには** 次の例では、`PPK0UOSIF5WSV` という ID を持つフィールドレベル暗号化のプロファイルを更新しています。この例では、JSON ファイルにパラメータを指定して、プロファイルの `Name` と `Comment` を更新し、2 番目の `FieldPatterns` 項目を追加します。 フィールドレベル暗号化のプロファイルを更新するには、プロファイルの ID と `ETag` が必要です。ID は create-field-level-encryption-profile コマンドと list-field-level-encryption-profiles コマンドの出力で返されます。`ETag` を取得するには、get-field-level-encryption-profile コマンドまたは get-field-level-encryption-profile-config コマンドを使用します。`--if-match` オプションを使用して、プロファイルの `ETag` を指定します。 ``` aws cloudfront update-field-level-encryption-profile \ --id PPK0UOSIF5WSV \ --if-match E1QQG65FS2L2GC \ --field-level-encryption-profile-config file://fle-profile-config.json ``` `fle-profile-config.json` ファイルは、以下を含む現在のディレクトリ内にある JSON ドキュメントです。 ``` { "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" ] } } ] } } ``` 出力: ``` { "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" ] } } ] } } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateFieldLevelEncryptionProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/update-field-level-encryption-profile.html)」を参照してください。 ### `verify-dns-configuration` 次のコード例は、`verify-dns-configuration` を使用する方法を示しています。 **AWS CLI** **ドメインの DNS 設定を確認するには** 次の `verify-dns-configuration` の例では、ドメインの DNS 設定を確認します。 ``` aws cloudfront verify-dns-configuration \ --domain example.com \ --identifier dt_2x9GhoK0TZRsohWzv1b9It8J1AB ``` 出力: ``` { "DnsConfigurationList": [ { "Domain": "example.com", "Status": "valid-configuration" } ] } ``` 詳細については、「*Amazon CloudFront デベロッパーガイド*」の「[代替ドメイン名を別のディストリビューションに移動する](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/alternate-domain-names-move.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[VerifyDnsConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudfront/verify-dns-configuration.html)」を参照してください。 # AWS CLI を使用した Amazon CloudSearch の例 次のコード例は、Amazon CloudSearch で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `upload-documents` 次のコード例は、`upload-documents` を使用する方法を示しています。 **AWS CLI** 次の `upload-documents` コマンドは、JSON ドキュメントのバッチを 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 ``` 出力: ``` { "status": "success", "adds": 5000, "deletes": 0 } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UploadDocuments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudsearchdomain/upload-documents.html)」を参照してください。 # AWS CLI を使用した CloudTrail の例 次のコード例は、CloudTrail で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `add-tags` 次のコード例は、`add-tags` を使用する方法を示しています。 **AWS CLI** **証跡にタグを追加するには** 次の `add-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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/add-tags.html)」を参照してください。 ### `create-subscription` 次のコード例は、`create-subscription` を使用する方法を示しています。 **AWS CLI** **証跡の AWS リソースを作成して設定するには** 次の `create-subscription` コマンドは、`Trail1` の新しい S3 バケットと SNS トピックを作成します。 ``` aws cloudtrail create-subscription \ --name Trail1 \ --s3-new-bucket amzn-s3-demo-bucket \ --sns-new-topic my-topic ``` 出力: ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/create-subscription.html)」を参照してください。 ### `create-trail` 次のコード例は、`create-trail` を使用する方法を示しています。 **AWS CLI** **証跡を作成するには** 次の `create-trail` の例では、`Trail1` という名前のマルチリージョン証跡を作成し、S3 バケットを指定します。 ``` aws cloudtrail create-trail \ --name Trail1 \ --s3-bucket-name amzn-s3-demo-bucket \ --is-multi-region-trail ``` 出力: ``` { "IncludeGlobalServiceEvents": true, "Name": "Trail1", "TrailARN": "arn:aws:cloudtrail:us-west-2:123456789012:trail/Trail1", "LogFileValidationEnabled": false, "IsMultiRegionTrail": true, "S3BucketName": "amzn-s3-demo-bucket" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateTrail](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/create-trail.html)」を参照してください。 ### `delete-trail` 次のコード例は、`delete-trail` を使用する方法を示しています。 **AWS CLI** **証跡を削除するには** 次の `delete-trail` コマンドは `Trail1` という名前の証跡を削除します。 ``` aws cloudtrail delete-trail --name Trail1 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteTrail](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/delete-trail.html)」を参照してください。 ### `describe-trails` 次のコード例は、`describe-trails` を使用する方法を示しています。 **AWS CLI** **証跡を記述するには** 次の `describe-trails` の例では、`Trail1` と `Trail2` の設定を返します。 ``` aws cloudtrail describe-trails \ --trail-name-list Trail1 Trail2 ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTrails](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/describe-trails.html)」を参照してください。 ### `get-event-selectors` 次のコード例は、`get-event-selectors` を使用する方法を示しています。 **AWS CLI** **証跡のイベントセレクターの設定を表示するには** 次の `get-event-selectors` コマンドは `Trail1` の設定を返します。 ``` aws cloudtrail get-event-selectors --trail-name Trail1 ``` 出力: ``` { "EventSelectors": [ { "IncludeManagementEvents": true, "DataResources": [], "ReadWriteType": "All" } ], "TrailARN": "arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail1" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetEventSelectors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/get-event-selectors.html)」を参照してください。 ### `get-trail-status` 次のコード例は、`get-trail-status` を使用する方法を示しています。 **AWS CLI** **証跡のステータスを取得するには** 次の `get-trail-status` コマンドは `Trail1` の配信およびログの詳細を返します。 ``` aws cloudtrail get-trail-status --name Trail1 ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetTrailStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/get-trail-status.html)」を参照してください。 ### `list-public-keys` 次のコード例は、`list-public-keys` を使用する方法を示しています。 **AWS CLI** **証跡のすべてのパブリックキーを一覧表示するには** 次の `list-public-keys` コマンドは、指定された時間範囲内に、対応するプライベートキーがダイジェストファイルの署名に使用されたすべてのパブリックキーを返します。 ``` aws cloudtrail list-public-keys --start-time 2016-01-01T20:30:00.000Z ``` 出力: ``` { "PublicKeyList": [ { "ValidityStartTime": 1453076702.0, "ValidityEndTime": 1455668702.0, "Value": "MIIBCgKCAQEAlSS3cl92HDycr/MTj0moOhas8habjrraXw+KzlWF0axSI2tcF+3iJ9BKQAVSKxGwxwu3m0wG3J+kUl1xboEcEPHYoIYMbgfSw7KGnuDKwkLzsQWhUJ0cIbOHASox1vv/5fNXkrHhGbDCHeVXm804c83nvHUEFYThr1PfyP/8HwrCtR3FX5OANtQCP61C1nJtSSkC8JSQUOrIP4CuwJjc+4WGDk+BGH5m9iuiAKkipEHWmUl8/P7XpfpWQuk4h8g3pXZOrNXr08lbh4d39svj7UqdhvOXoBISp9t/EXYuePGEtBdrKD9Dz+VHwyUPtBQvYr9BnkF88qBnaPNhS44rzwIDAQAB", "Fingerprint": "7f3f401420072e50a65a141430817ab3" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPublicKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/list-public-keys.html)」を参照してください。 ### `list-tags` 次のコード例は、`list-tags` を使用する方法を示しています。 **AWS CLI** **証跡のタグを一覧表示するには** 次の `list-tags` コマンドは、`Trail1` と `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 ``` 出力: ``` { "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" } ] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/list-tags.html)」を参照してください。 ### `lookup-events` 次のコード例は、`lookup-events` を使用する方法を示しています。 **AWS CLI** **証跡のイベントを検索するには** 次の `lookup-events` コマンドは、`EventName` 属性 で API アクティビティイベントを検索します。 ``` aws cloudtrail lookup-events --lookup-attributes AttributeKey=EventName,AttributeValue=ConsoleLogin ``` 出力: ``` { "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": [] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[LookupEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/lookup-events.html)」を参照してください。 ### `put-event-selectors` 次のコード例は、`put-event-selectors` を使用する方法を示しています。 **AWS CLI** **例 1: 高度なイベントセレクターを使用して、管理イベントおよびデータイベントをログに記録する証跡を設定する** 高度なイベントセレクターおよび高度なイベントセレクターの条件を追加できます。証跡のすべての条件とセレクターには、最大 500 個の値を設定できます。高度なイベントセレクターを使用すると、使用可能なすべてのデータイベントタイプをログに記録できます。高度なイベントセレクターまたは基本的なイベントセレクターのいずれかを使用できますが、両方を使用することはできません。高度なイベントセレクターを証跡に適用すると、既存の基本的なイベントセレクターは上書きされます。 次の `put-event-selectors` の例では、`myTrail` という名前の証跡の高度なイベントセレクターを作成し、すべての管理イベント、1 つの S3 バケットを除くすべての S3 PutObject および DeleteObject API コール、`myFunction` という名前の Lambda 関数のデータ API コール、`myTopic` という名前の SNS トピックの Publish API コールをログに記録します。 ``` 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"] }]}]' ``` 出力: ``` { "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" ] } ] } ] } ``` 詳細については、「*AWS CloudTrail ユーザーガイド*」の「[アドバンストイベントセレクタを使用してイベントをログに記録する](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-advanced)」を参照してください。 **例 2: すべての管理イベントとデータイベントをログに記録する証跡のイベントセレクターを設定する** 証跡あたり最大 5 つのイベントセレクタと、証跡あたり最大 250 の データリソースを設定できます。イベントセレクターは、基本的なイベントセレクターとも呼ばれます。イベントセレクターを使用して、S3 オブジェクト、Lambda 関数、および DynnamoDB テーブルの管理イベントとデータイベントをログに記録できます。その他のリソースタイプのデータイベントをログに記録するには、高度なイベントセレクターを使用する必要があります。 次の `put-event-selectors` の例では、`TrailName` という名前の証跡のイベントセレクターを作成します。このセレクターには、すべての管理イベント、2 つの Amazon S3 バケット/プレフィックスの組み合わせに対するデータイベント、`hello-world-python-function` という名前の 1 つの AWS Lambda 関数に対するデータイベントが含まれます。 ``` 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"]}]}]' ``` 出力: ``` { "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" } ``` 詳細については、「*AWS CloudTrail ユーザーガイド*」の「[基本的なイベントセレクターを使用してイベントをログに記録する](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-basic)」を参照してください。 **例 3: 管理イベント、S3 オブジェクト上のすべての S3 データイベント、およびアカウントの関数上のすべての Lambda データイベントをログに記録する証跡のイベントセレクターを設定する** 次の `put-event-selectors` の例では、`TrailName2` という名前の証跡のイベントセレクターを作成します。このセレクターには、すべての管理イベント、AWS アカウントのすべての Amazon S3 バケットおよび AWS Lambda 関数に関するデータイベントが含まれます。 ``` 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"]}]}]' ``` 出力: ``` { "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" } ``` 詳細については、「*AWS CloudTrail ユーザーガイド*」の「[基本的なイベントセレクターを使用してイベントをログに記録する](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-basic)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutEventSelectors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/put-event-selectors.html)」を参照してください。 ### `remove-tags` 次のコード例は、`remove-tags` を使用する方法を示しています。 **AWS CLI** **証跡のタグを削除するには** 次の `remove-tags` コマンドは、`Trail1` の指定したタグを削除します。 ``` aws cloudtrail remove-tags --resource-id arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail1 --tags-list Key=name Key=location ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/remove-tags.html)」を参照してください。 ### `start-logging` 次のコード例は、`start-logging` を使用する方法を示しています。 **AWS CLI** **証跡のログ記録を開始するには** 次の `start-logging` コマンドを実行して、`Trail1` のログ記録をオンにします。 ``` aws cloudtrail start-logging --name Trail1 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartLogging](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/start-logging.html)」を参照してください。 ### `stop-logging` 次のコード例は、`stop-logging` を使用する方法を示しています。 **AWS CLI** **証跡のログ記録を停止するには** 次の `stop-logging` コマンドを実行して、`Trail1` のログ記録をオフにします。 ``` aws cloudtrail stop-logging --name Trail1 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopLogging](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/stop-logging.html)」を参照してください。 ### `update-subscription` 次のコード例は、`update-subscription` を使用する方法を示しています。 **AWS CLI** **証跡の設定を更新するには** 次の `update-subscription` の例では、証跡を更新して新しい S3 バケットと SNS トピックを指定します。 ``` aws cloudtrail update-subscription \ --name Trail1 \ --s3-new-bucket amzn-s3-demo-bucket \ --sns-new-topic my-topic-new ``` 出力: ``` 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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/update-subscription.html)」を参照してください。 ### `update-trail` 次のコード例は、`update-trail` を使用する方法を示しています。 **AWS CLI** **証跡を更新するには** 次の `update-trail` の例では、ログ配信に既存のバケットを使用するように証跡を更新します。 ``` aws cloudtrail update-trail \ --name Trail1 \ --s3-bucket-name amzn-s3-demo-bucket ``` 出力: ``` { "IncludeGlobalServiceEvents": true, "Name": "Trail1", "TrailARN": "arn:aws:cloudtrail:us-west-2:123456789012:trail/Trail1", "LogFileValidationEnabled": false, "IsMultiRegionTrail": true, "S3BucketName": "amzn-s3-demo-bucket" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateTrail](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/update-trail.html)」を参照してください。 ### `validate-logs` 次のコード例は、`validate-logs` を使用する方法を示しています。 **AWS CLI** **ログファイルを検証するには** 次の `validate-logs` コマンドは、`Trail1` のログを検証します。 ``` aws cloudtrail validate-logs --trail-arn arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail1 --start-time 20160129T19:00:00Z ``` 出力: ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ValidateLogs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudtrail/validate-logs.html)」を参照してください。 # AWS CLI を使用した CloudWatch の例 次のコード例は、CloudWatch で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `delete-alarms` 次のコード例は、`delete-alarms` を使用する方法を示しています。 **AWS CLI** **アラームを削除するには** 次の例は、`delete-alarms` コマンドを使用して、「myalarm」という名前の Amazon CloudWatch アラームを削除します。 ``` aws cloudwatch delete-alarms --alarm-names myalarm ``` 出力: ``` This command returns to the prompt if successful. ``` + API の詳細については、AWS CLI コマンドリファレンスの「[DeleteAlarms](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/delete-alarms.html)」を参照してください。** ### `delete-anomaly-detector` 次のコード例は、`delete-anomaly-detector` を使用する方法を示しています。 **AWS CLI** **指定された異常検出モデルを削除する方法** 次の`delete-anomaly-detector` の例では、指定されたアカウントで異常検出モデルを削除します。 ``` aws cloudwatch delete-anomaly-detector \ --namespace AWS/Logs \ --metric-name IncomingBytes \ --stat SampleCount ``` このコマンドでは何も出力されません。 詳細については、「*Amazon CloudWatch ユーザーガイド*」の「[異常検出モデルの削除](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Anomaly_Detection_Alarm.html#Delete_Anomaly_Detection_Model)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAnomalyDetector](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/delete-anomaly-detector.html)」を参照してください。 ### `delete-dashboards` 次のコード例は、`delete-dashboards` を使用する方法を示しています。 **AWS CLI** **指定されたダッシュボードを削除する方法** 次の `delete-dashboards` の例では、指定されたアカウントの `Dashboard-A` および `Dashboard-B` という名前の 2 つのダッシュボードを削除します。 ``` aws cloudwatch delete-dashboards \ --dashboard-names Dashboard-A Dashboard-B ``` このコマンドでは何も出力されません。 詳細については、「Amazon CloudWatch ユーザーガイド」の「[Amazon CloudWatch のダッシュボード](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Dashboards.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDashboards](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/delete-dashboards.html)」を参照してください。 ### `delete-insight-rules` 次のコード例は、`delete-insight-rules` を使用する方法を示しています。 **AWS CLI** **指定した Contributor Insights のルールを削除するには** 次の `delete-insight-rules` の例では、指定したアカウントから `Rule-A` および `Rule-B` という名前の 2 つの Contributor Insights ルールを削除します。 ``` aws cloudwatch delete-insight-rules \ --rule-names Rule-A Rule-B ``` 出力: ``` { "Failures": [] } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[Contributor Insights を使用して高カーディナリティデータを分析する](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DeleteInsightRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/delete-insight-rules.html)」を参照してください。 ### `delete-metric-stream` 次のコード例は、`delete-metric-stream` を使用する方法を示しています。 **AWS CLI** **指定したメトリクスストリームを削除するには** 次の `delete-metric-stream` の例では、指定したアカウントから `QuickPartial-gSCKvO` という名前のメトリクスストリームを削除します。 ``` aws cloudwatch delete-metric-stream \ --name QuickPartial-gSCKvO ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[メトリクスストリームを使用する](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DeleteMetricStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/delete-metric-stream.html)」を参照してください。 ### `describe-alarm-history` 次のコード例は、`describe-alarm-history` を使用する方法を示しています。 **AWS CLI** **アラームの履歴を取得するには** 次の例は、`describe-alarm-history` コマンドを使用して、「myalarm」という名前の Amazon CloudWatch アラームの履歴を取得します。 ``` aws cloudwatch describe-alarm-history --alarm-name "myalarm" --history-item-type StateUpdate ``` 出力: ``` { "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" } ] } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeAlarmHistory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/describe-alarm-history.html)」を参照してください。** ### `describe-alarms-for-metric` 次のコード例は、`describe-alarms-for-metric` を使用する方法を示しています。 **AWS CLI** **メトリクスに関連するアラームについての情報を表示するには** 次の例は、`describe-alarms-for-metric` コマンドを使用して、Amazon EC2 CPUUtilization メトリクスと、ID i-0c986c72 のインスタンスに関連するすべてのアラームに関する情報を表示します。 ``` aws cloudwatch describe-alarms-for-metric --metric-name CPUUtilization --namespace AWS/EC2 --dimensions Name=InstanceId,Value=i-0c986c72 ``` 出力: ``` { "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" } ] } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeAlarmsForMetric](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/describe-alarms-for-metric.html)」を参照してください。** ### `describe-alarms` 次のコード例は、`describe-alarms` を使用する方法を示しています。 **AWS CLI** **アラームに関する情報を一覧表示するには** 次の例は、`describe-alarms` コマンドを使用して、「myalarm」という名前のアラームに関する情報を表示します。 ``` aws cloudwatch describe-alarms --alarm-names "myalarm" ``` 出力: ``` { "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" } ] } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeAlarms](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/describe-alarms.html)」を参照してください。** ### `describe-anomaly-detectors` 次のコード例は、`describe-anomaly-detectors` を使用する方法を示しています。 **AWS CLI** **異常検出モデルのリストを取得する方法** 次の `describe-anomaly-detectors` の例では、指定されたアカウントの `AWS/Logs` 名前空間に関連付けられた異常検出モデルに関する情報が表示されます。 ``` aws cloudwatch describe-anomaly-detectors \ --namespace AWS/Logs ``` 出力: ``` { "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" } } ] } ``` 詳細については、「*Amazon CloudWatch ユーザーガイド*」の「[CloudWatch 異常検出の使用](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Anomaly_Detection.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAnomalyDetectors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/describe-anomaly-detectors.html)」を参照してください。 ### `describe-insight-rules` 次のコード例は、`describe-insight-rules` を使用する方法を示しています。 **AWS CLI** **Contributor Insights ルールのリストを取得するには** 次の `describe-insight-rules` の例では、指定したアカウントのすべての Contributor Insights ルールを表示します。 ``` aws cloudwatch describe-insight-rules ``` 出力: ``` { "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 } ] } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[Contributor Insights を使用して高カーディナリティデータを分析する](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DescribeInsightRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/describe-insight-rules.html)」を参照してください。 ### `disable-alarm-actions` 次のコード例は、`disable-alarm-actions` を使用する方法を示しています。 **AWS CLI** **アラームのアクションを無効化するには** 次の例は、`disable-alarm-actions` コマンドを使用して、「myalarm」という名前のアラームのアクションをすべて無効化します。 ``` aws cloudwatch disable-alarm-actions --alarm-names myalarm ``` 正常に完了すると、このコマンドはプロンプトに戻ります。 + API の詳細については、AWS CLI コマンドリファレンスの「[DisableAlarmActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/disable-alarm-actions.html)」を参照してください。** ### `disable-insight-rules` 次のコード例は、`disable-insight-rules` を使用する方法を示しています。 **AWS CLI** **指定した Contributor Insights ルールを無効にするには** 次の `disable-insight-rules` の例では、指定したアカウントの `Rule-A` および `Rule-B` という名前の 2 つの Contributor Insights ルールを無効にします。 ``` aws cloudwatch disable-insight-rules \ --rule-names Rule-A Rule-B ``` 出力: ``` { "Failures": [] } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[Contributor Insights を使用して高カーディナリティデータを分析する](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DisableInsightRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/disable-insight-rules.html)」を参照してください。 ### `enable-alarm-actions` 次のコード例は、`enable-alarm-actions` を使用する方法を示しています。 **AWS CLI** **アラームのすべてのアクションを有効化するには** 次の例は、`enable-alarm-actions` コマンドを使用して、「myalarm」という名前のアラームのアクションをすべて有効化します。 ``` aws cloudwatch enable-alarm-actions --alarm-names myalarm ``` 正常に完了すると、このコマンドはプロンプトに戻ります。 + API の詳細については、AWS CLI コマンドリファレンスの「[EnableAlarmActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/enable-alarm-actions.html)」を参照してください。** ### `enable-insight-rules` 次のコード例は、`enable-insight-rules` を使用する方法を示しています。 **AWS CLI** **指定した Contributor Insights ルールを有効にするには** 次の `enable-insight-rules` の例では、指定したアカウントの `Rule-A` および `Rule-B` という名前の 2 つの Contributor Insights ルールを有効にします。 ``` aws cloudwatch enable-insight-rules \ --rule-names Rule-A Rule-B ``` 出力: ``` { "Failures": [] } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[Contributor Insights を使用して高カーディナリティデータを分析する](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[EnableInsightRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/enable-insight-rules.html)」を参照してください。 ### `get-dashboard` 次のコード例は、`get-dashboard` を使用する方法を示しています。 **AWS CLI** **ダッシュボードに関する情報を取得する方法** 次の `get-dashboard` の例では、指定されたアカウントで `Dashboard-A` という名前のダッシュボードに関する情報が表示されます。 ``` aws cloudwatch get-dashboard \ --dashboard-name Dashboard-A ``` 出力: ``` { "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" } ``` 詳細については、「Amazon CloudWatch ユーザーガイド」の「[Amazon CloudWatch のダッシュボード](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Dashboards.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDashboard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/get-dashboard.html)」を参照してください。 ### `get-insight-rule-report` 次のコード例は、`get-insight-rule-report` を使用する方法を示しています。 **AWS CLI** **Contributor Insights ルールによって収集された時系列データを取得するには** 次の `get-insight-rule-report` の例では、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 ``` 出力: ``` { "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": [] } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[Contributor Insights を使用して高カーディナリティデータを分析する](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[GetInsightRuleReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/get-insight-rule-report.html)」を参照してください。 ### `get-metric-data` 次のコード例は、`get-metric-data` を使用する方法を示しています。 **AWS CLI** **例 1: 数式を使用して指定された EC2 の平均合計 IOPS を取得する方法** 次の `get-metric-data` の例では、`EBSReadOps` と `EBSWriteOps` メトリクスを組み合わせた Metric Math 式を使用して、InstanceID `i-abcdef` を持つ EC2 インスタンスの CloudWatch メトリクス値を取得します。 ``` 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 ``` `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 } ] ``` 出力: ``` { "MetricDataResults": [ { "Id": "m3", "Label": "Avg Total IOPS", "Timestamps": [ "2024-09-29T22:10:00+00:00" ], "Values": [ 96.85 ], "StatusCode": "Complete" } ], "Messages": [] } ``` **例 2: CloudWatch 請求メトリクスを使用して推定 AWS 請求額をモニタリングする方法** 次の `get-metric-data` の例では、AWS/Billing 名前空間から `EstimatedCharges` CloudWatch メトリクスを取得します。 ``` 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 ``` 出力: ``` { "MetricDataResults": [ { "Id": "m1", "Label": "EstimatedCharges", "Timestamps": [ "2024-09-26T12:00:00+00:00" ], "Values": [ 542.38 ], "StatusCode": "Complete" } ], "Messages": [] } ``` 詳細については、「*Amazon CloudWatch ユーザーガイド*」の「[CloudWatch メトリクスで数式の使用](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetMetricData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/get-metric-data.html)」を参照してください。 ### `get-metric-statistics` 次のコード例は、`get-metric-statistics` を使用する方法を示しています。 **AWS CLI** **EC2 インスタンスあたりの CPU 使用率を取得するには** 次の例は、`get-metric-statistics` コマンドを使用して、ID i-abcdef の EC2 インスタンスの CPU 使用率を取得します。 ``` 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 ``` 出力: ``` { "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" } ``` **複数のディメンションを指定する** 次の例は、複数のディメンションを指定する方法を示しています。各ディメンションは名前/値のペアとして指定され、名前と値の間にはカンマが入ります。複数のディメンションはスペースで区切ります。また、1 つのメトリクスに複数のディメンションを含む場合は、定義されているディメンションごとに値を指定する必要があります。 `get-metric-statistics` コマンドのその他の使用例については、「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 ``` + API の詳細については、AWS CLI コマンドリファレンスの「[GetMetricStatistics](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/get-metric-statistics.html)」を参照してください。** ### `get-metric-stream` 次のコード例は、`get-metric-stream` を使用する方法を示しています。 **AWS CLI** **メトリクスストリームに関する情報を取得するには** 次の `get-metric-stream` の例では、指定したアカウントの `QuickFull-GuaFbs` という名前のメトリクスストリームに関する情報が表示されます。 ``` aws cloudwatch get-metric-stream \ --name QuickFull-GuaFbs ``` 出力: ``` { "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 } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[メトリクスストリームを使用する](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[GetMetricStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/get-metric-stream.html)」を参照してください。 ### `get-metric-widget-image` 次のコード例は、`get-metric-widget-image` を使用する方法を示しています。 **AWS CLI** **CPUUtilization のスナップショットグラフを取得する方法** 次の `get-metric-widget-image` の例では、ID `i-abcde` を持つ EC2 インスタンスの `CPUUtilization` メトリクスのスナップショットグラフを取得し、取得したイメージを「image.png」という名前のファイルとしてローカルマシンに保存します。 ``` aws cloudwatch get-metric-widget-image \ --metric-widget '{"metrics":[["AWS/EC2","CPUUtilization","InstanceId","i-abcde"]]}' \ --output-format png \ --output text | base64 --decode > image.png ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetMetricWidgetImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/get-metric-widget-image.html)」を参照してください。 ### `list-dashboards` 次のコード例は、`list-dashboards` を使用する方法を示しています。 **AWS CLI** **ダッシュボードのリストを取得する方法** 次の `list-dashboards` の例では、指定されたアカウントですべてのダッシュボードを一覧表示します。 ``` aws cloudwatch list-dashboards ``` 出力: ``` { "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 } ] } ``` 詳細については、「Amazon CloudWatch ユーザーガイド」の「[Amazon CloudWatch のダッシュボード](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Dashboards.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDashboards](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/list-dashboards.html)」を参照してください。 ### `list-metric-streams` 次のコード例は、`list-metric-streams` を使用する方法を示しています。 **AWS CLI** **メトリクスストリームのリストを取得するには** 次の `list-metric-streams` の例では、指定したアカウントのすべてのメトリクスストリームを一覧表示します。 ``` aws cloudwatch list-metric-streams ``` 出力: ``` { "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" } ] } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[メトリクスストリームを使用する](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[ListMetricStreams](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/list-metric-streams.html)」を参照してください。 ### `list-metrics` 次のコード例は、`list-metrics` を使用する方法を示しています。 **AWS CLI** **Amazon SNS のメトリクスを一覧表示するには** 次の `list-metrics` の例は、Amazon SNS のメトリクスを表示します。 ``` aws cloudwatch list-metrics \ --namespace "AWS/SNS" ``` 出力: ``` { "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" } ] } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[ListMetrics](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/list-metrics.html)」を参照してください。** ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **既存のアラームに関連付けられているタグを一覧表示するには\$1** 次の `list-tags-for-resource` の例では、指定したアカウントの `demo` という名前のアラームに関連付けられているすべてのタグを一覧表示します。 ``` aws cloudwatch list-tags-for-resource \ --resource-arn arn:aws:cloudwatch:us-east-1:123456789012:alarm:demo ``` 出力: ``` { "Tags": [ { "Key": "stack", "Value": "Production" }, { "Key": "team", "Value": "Devops" } ] } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[アラームとタグ付け](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_alarms_and_tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/list-tags-for-resource.html)」を参照してください。 ### `put-anomaly-detector` 次のコード例は、`put-anomaly-detector` を使用する方法を示しています。 **AWS CLI** **異常検出モデルを作成する方法** 次の `put-anomaly-detector` の例では、CloudWatch メトリクスの異常検出モデルを作成します。 ``` aws cloudwatch put-anomaly-detector \ --namespace AWS/Logs \ --metric-name IncomingBytes \ --stat SampleCount ``` このコマンドでは何も出力されません。 詳細については、「*Amazon CloudWatch ユーザーガイド*」の「[CloudWatch 異常検出の使用](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Anomaly_Detection.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutAnomalyDetector](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/put-anomaly-detector.html)」を参照してください。 ### `put-composite-alarm` 次のコード例は、`put-composite-alarm` を使用する方法を示しています。 **AWS CLI** **複合 CloudWatch アラームを作成するには** 次の `put-composite-alarm` の例では、指定したアカウントに `ProdAlarm` という名前の複合アラームを作成します。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[複合アラームを作成する](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Create_Composite_Alarm_How_To.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[PutCompositeAlarm](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/put-composite-alarm.html)」を参照してください。 ### `put-dashboard` 次のコード例は、`put-dashboard` を使用する方法を示しています。 **AWS CLI** **ダッシュボードを作成するには** 次の `put-dashboard` の例では、指定されたアカウントで `Dashboard-A` という名前のダッシュボードを作成します。 ``` 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"}}]}' ``` 出力: ``` { "DashboardValidationMessages": [] } ``` 詳細については、「*Amazon CloudWatchユーザーガイド*」の「[CloudWatch ダッシュボードの作成](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/create_dashboard.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[PutDashboard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/put-dashboard.html)」を参照してください。 ### `put-insight-rule` 次のコード例は、`put-insight-rule` を使用する方法を示しています。 **AWS CLI** **Contributor Insights ルールを作成するには** 次の `put-insight-rule` の例では、指定したアカウントに `VPCFlowLogsContributorInsights` という名前の Contributor Insights ルールを作成します。 ``` aws cloudwatch put-insight-rule \ --rule-name VPCFlowLogsContributorInsights \ --rule-definition file://insight-rule.json \ --rule-state ENABLED ``` `insight-rule.json` の内容: ``` { "Schema": { "Name": "CloudWatchLogRule", "Version": 1 }, "AggregateOn": "Count", "Contribution": { "Filters": [], "Keys": [ "tcp-flag" ] }, "LogFormat": "CLF", "LogGroupNames": [ "/vpc/flowlogs/*" ], "Fields": { "23": "tcp-flag" } } ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[CloudWatch で Contributor Insights ルールを作成する](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights-CreateRule.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[PutInsightRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/put-insight-rule.html)」を参照してください。 ### `put-metric-alarm` 次のコード例は、`put-metric-alarm` を使用する方法を示しています。 **AWS CLI** **CPU 使用率が 70% を超えたときに Amazon Simple Notification Service の E メールメッセージを送信するには** 次の例では、`put-metric-alarm` コマンドを使用して、CPU 使用率が 70% を超えたときに、Amazon Simple Notification Service に E メールメッセージを送信します。 ``` 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 ``` 正常に完了すると、このコマンドはプロンプトに戻ります。同じ名前のアラームが既に存在する場合は、新しいアラームで上書きされます。 **複数のディメンションを指定するには** 次の例は、複数のディメンションを指定する方法を示しています。各ディメンションは名前/値のペアとして指定され、名前と値の間にはカンマが入ります。複数のディメンションはスペースで区切ります。 ``` 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 ``` + API の詳細については、AWS CLI コマンドリファレンスの「[PutMetricAlarm](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/put-metric-alarm.html)」を参照してください。** ### `put-metric-data` 次のコード例は、`put-metric-data` を使用する方法を示しています。 **AWS CLI** **Amazon CloudWatch にカスタムメトリクスをパブリッシュするには** 次の例は、`put-metric-data` コマンドを使用して、Amazon CloudWatch にカスタムメトリクスをパブリッシュします。 ``` aws cloudwatch put-metric-data --namespace "Usage Metrics" --metric-data file://metric.json ``` メトリクス自体の値は、JSON ファイル `metric.json` に保存されます。 ファイルの内容は次のとおりです。 ``` [ { "MetricName": "New Posts", "Timestamp": "Wednesday, June 12, 2013 8:28:20 PM", "Value": 0.50, "Unit": "Count" } ] ``` 詳細については、「Amazon CloudWatch ユーザーガイド」の「カスタムメトリクスをパブリッシュする」を参照してください。** **複数のディメンションを指定するには** 次の例は、複数のディメンションを指定する方法を示しています。各ディメンションは Name=Value ペアとして指定されます。複数のディメンションはコンマで区切ります。 ``` aws cloudwatch put-metric-data --metric-name Buffers --namespace MyNameSpace --unit Bytes --value 231434333 --dimensions InstanceID=1-23456789,InstanceType=m1.small ``` + API の詳細については、AWS CLI コマンドリファレンスの「[PutMetricData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/put-metric-data.html)」を参照してください。** ### `put-metric-stream` 次のコード例は、`put-metric-stream` を使用する方法を示しています。 **AWS CLI** **メトリクスストリームを作成するには** 次の `QuickFull-GuaFb` の例では、指定したアカウントに `put-metric-stream` という名前のメトリクスストリームを作成します。 ``` 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 ``` 出力: ``` { "Arn": "arn:aws:cloudwatch:us-east-1:123456789012:metric-stream/QuickFull-GuaFbs" } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[メトリクスストリームを設定する](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-metric-streams-setup.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[PutMetricStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/put-metric-stream.html)」を参照してください。 ### `set-alarm-state` 次のコード例は、`set-alarm-state` を使用する方法を示しています。 **AWS CLI** **アラームの状態を一時的に変更するには** 次の例では、`set-alarm-state` コマンドを使用して「myalarm」という名前の Amazon CloudWatch アラームの状態を一時的に変更し、テスト目的で ALARM 状態に設定します。 ``` aws cloudwatch set-alarm-state --alarm-name "myalarm" --state-value ALARM --state-reason "testing purposes" ``` 正常に完了すると、このコマンドはプロンプトに戻ります。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetAlarmState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/set-alarm-state.html)」を参照してください。 ### `start-metric-streams` 次のコード例は、`start-metric-streams` を使用する方法を示しています。 **AWS CLI** **指定したメトリクスストリームを開始するには** 次の `start-metric-streams` の例では、指定したアカウントの `QuickFull-GuaFbs` という名前のメトリクスストリームを開始します。 ``` aws cloudwatch start-metric-streams \ --names QuickFull-GuaFbs ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[メトリクスストリームを使用する](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[StartMetricStreams](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/start-metric-streams.html)」を参照してください。 ### `stop-metric-streams` 次のコード例は、`stop-metric-streams` を使用する方法を示しています。 **AWS CLI** **指定したメトリクスストリームを停止するには** 次の `stop-metric-streams` の例では、指定したアカウントの `QuickFull-GuaFbs` という名前のメトリクスストリームを停止します。 ``` aws cloudwatch stop-metric-streams \ --names QuickFull-GuaFbs ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[メトリクスストリームを使用する](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[StopMetricStreams](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/stop-metric-streams.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **指定したリソースに 1 つ以上のタグを追加するには** 次の `tag-resource` の例では、指定したアカウントの `demo` という名前の CloudWatch アラームに 2 つのタグを追加します。 ``` aws cloudwatch tag-resource \ --resource-arn arn:aws:cloudwatch:us-east-1:123456789012:alarm:demo \ --tags Key=stack,Value=Production Key=team,Value=Devops ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[Amazon CloudWatch リソースのタグ付け](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **指定したリソースから 1 つ以上のタグを削除するには** 次の `untag-resource` の例では、指定したアカウントの `demo` という名前の CloudWatch アラームから 2 つのタグを削除します。 ``` aws cloudwatch untag-resource \ --resource-arn arn:aws:cloudwatch:us-east-1:123456789012:alarm:demo \ --tag-keys stack team ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[Amazon CloudWatch リソースのタグ付け](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/untag-resource.html)」を参照してください。 # AWS CLI を使う CloudWatch Logs の例 次のコード例は、CloudWatch Logs で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-log-group` 次のコード例は、`create-log-group` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、`my-logs` という名前のロググループを作成します。 ``` aws logs create-log-group --log-group-name my-logs ``` + API の詳細については、AWS CLI コマンドリファレンスの「[CreateLogGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/create-log-group.html)」を参照してください。** ### `create-log-stream` 次のコード例は、`create-log-stream` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、ロググループ `my-logs` に `20150601` という名前のログストリームを作成します。 ``` aws logs create-log-stream --log-group-name my-logs --log-stream-name 20150601 ``` + API の詳細については、AWS CLI コマンドリファレンスの「[CreateLogStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/create-log-stream.html)」を参照してください。** ### `delete-log-group` 次のコード例は、`delete-log-group` を使用する方法を示しています。 **AWS CLI** 以下のコマンドは、`my-logs` という名前のロググループを削除します。 ``` aws logs delete-log-group --log-group-name my-logs ``` + API の詳細については、AWS CLI コマンドリファレンスの「[DeleteLogGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/delete-log-group.html)」を参照してください。** ### `delete-log-stream` 次のコード例は、`delete-log-stream` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、`my-logs` という名前のロググループから `20150531` という名前のログストリームを削除します。 ``` aws logs delete-log-stream --log-group-name my-logs --log-stream-name 20150531 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteLogStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/delete-log-stream.html)」を参照してください。 ### `delete-retention-policy` 次のコード例は、`delete-retention-policy` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、`my-logs` という名前のロググループに以前に適用された保持ポリシーを削除します。 ``` aws logs delete-retention-policy --log-group-name my-logs ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRetentionPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/delete-retention-policy.html)」を参照してください。 ### `describe-log-groups` 次のコード例は、`describe-log-groups` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、`my-logs` という名前のロググループを記述します。 ``` aws logs describe-log-groups --log-group-name-prefix my-logs ``` 出力: ``` { "logGroups": [ { "storedBytes": 0, "metricFilterCount": 0, "creationTime": 1433189500783, "logGroupName": "my-logs", "retentionInDays": 5, "arn": "arn:aws:logs:us-west-2:0123456789012:log-group:my-logs:*" } ] } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeLogGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/describe-log-groups.html)」を参照してください。** ### `describe-log-streams` 次のコード例は、`describe-log-streams` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、ロググループ `my-logs` のプレフィックス `2015` で始まるすべてのログストリームを表示します。 ``` aws logs describe-log-streams --log-group-name my-logs --log-stream-name-prefix 2015 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeLogStreams](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/describe-log-streams.html)」を参照してください。 ### `get-log-events` 次のコード例は、`get-log-events` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、ロググループ `my-logs` の `20150601` という名前のログストリームからログイベントを取得します。 ``` aws logs get-log-events --log-group-name my-logs --log-stream-name 20150601 ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetLogEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/get-log-events.html)」を参照してください。 ### `put-log-events` 次のコード例は、`put-log-events` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、ロググループ `my-logs` の `20150601` という名前のログストリームにログイベントを配置します。 ``` aws logs put-log-events --log-group-name my-logs --log-stream-name 20150601 --log-events file://events ``` 出力: ``` { "nextSequenceToken": "49542672486831074009579604567656788214806863282469607346" } ``` 上記の例では、現在のディレクトリにある `events` という名前のファイルからイベントの JSON 配列を読み取ります。 ``` [ { "timestamp": 1433190184356, "message": "Example Event 1" }, { "timestamp": 1433190184358, "message": "Example Event 2" }, { "timestamp": 1433190184360, "message": "Example Event 3" } ] ``` 以降の各呼び出しでは、前の呼び出しで提供された次のシーケンストークンをシーケンストークンオプションで指定する必要があります。 ``` aws logs put-log-events --log-group-name my-logs --log-stream-name 20150601 --log-events file://events2 --sequence-token "49542672486831074009579604567656788214806863282469607346" ``` 出力: ``` { "nextSequenceToken": "49542672486831074009579604567900991230369019956308219826" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutLogEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/put-log-events.html)」を参照してください。 ### `put-retention-policy` 次のコード例は、`put-retention-policy` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、`my-logs` という名前のロググループに 5 日間の保持ポリシーを追加します。 ``` aws logs put-retention-policy --log-group-name my-logs --retention-in-days 5 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutRetentionPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/logs/put-retention-policy.html)」を参照してください。 # AWS CLI を使用した CloudWatch Network Monitoring の例 次のコード例は、CloudWatch Network Monitoring で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-monitor` 次のコード例は、`create-monitor` を使用する方法を示しています。 **AWS CLI** **例 1: 集計期間付きのネットワークモニターを作成するには** 次の `create-monitor` の例では、`aggregationPeriod` を `30` 秒に設定した `Example_NetworkMonitor` という名前のモニターを作成します。関連するプローブがないため、モニターのイニシャル `state` は `INACTIVE` となります。状態は、プローブが追加された場合にのみ `ACTIVE` に変わります。[update-monitor](https://docs.aws.amazon.com/cli/latest/reference/networkmonitor/update-monitor.html) コマンドまたは [create-probe](https://docs.aws.amazon.com/cli/latest/reference/networkmonitor/create-probe.html) コマンドを使用して、このモニターにプローブを追加できます。 ``` aws networkmonitor create-monitor \ --monitor-name Example_NetworkMonitor \ --aggregation-period 30 ``` 出力: ``` { "monitorArn": "arn:aws:networkmonitor:region:111122223333:monitor/Example_NetworkMonitor", "monitorName": "Example_NetworkMonitor", "state": "INACTIVE", "aggregationPeriod": 30, "tags": {} } ``` 詳細については、「*Amazon CloudWatch User Guide*」の「[How Amazon CloudWatch Network Monitor Works](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html)」を参照してください。 **例 2: TCP を使用してプローブ付きのネットワークモニターを作成し、タグを含めるには** 次の `create-monitor` の例では、`Example_NetworkMonitor` という名前のモニターを作成します。コマンドは、`ICMP` プロトコルを使用して 1 つのプローブも作成し、タグを含めます。リクエストで `aggregationPeriod` が渡されないため、デフォルトとして `60` 秒が設定されます。プローブ付きのモニターの `state` は、モニターが `ACTIVE` になるまで `PENDING` になります。これには数分かかる場合があります。その時点で、`state` は `ACTIVE` に変わり、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 ``` 出力: ``` { "monitorArn": "arn:aws:networkmonitor:region111122223333:monitor/Example_NetworkMonitor", "monitorName": "Example_NetworkMonitor", "state": "PENDING", "aggregationPeriod": 60, "tags": { "Monitor": "Monitor1" } } ``` 詳細については、「*Amazon CloudWatch User Guide*」の「[How Amazon CloudWatch Network Monitor Works](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html)」を参照してください。 **例 3: ICMP を使用してプローブ付きのネットワークモニターを作成し、タグを含めるには** 次の `create-monitor` の例では、`aggregationPeriod` が `30` 秒の `Example_NetworkMonitor` という名前のモニターを作成します。コマンドは、`ICMP` プロトコルを使用して 1 つのプローブも作成し、タグを含めます。リクエストで `aggregationPeriod` が渡されないため、デフォルトとして `60` 秒が設定されます。プローブ付きのモニターの `state` は、モニターが `ACTIVE` になるまで `PENDING` になります。これには数分かかる場合があります。その時点で、`state` は `ACTIVE` に変わり、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 ``` 出力: ``` { "monitorArn": "arn:aws:networkmonitor:region:111122223333:monitor/Example_NetworkMonitor", "monitorName": "Example_NetworkMonitor", "state": "PENDING", "aggregationPeriod": 30, "tags": { "Monitor": "Monitor1" } } ``` 詳細については、「*Amazon CloudWatch User Guide*」の「[How Amazon CloudWatch Network Monitor Works](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateMonitor](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmonitor/create-monitor.html)」を参照してください。 ### `create-probe` 次のコード例は、`create-probe` を使用する方法を示しています。 **AWS CLI** **例 1: TCP を使用するプローブを作成し、ネットワークモニターに追加するには** 次の `create-probe` の例では、`TCP` `protocol` を使用するプローブを作成し、プローブを `Example_NetworkMonitor` という名前のモニターに追加します。作成されると、プローブ付きのモニターの `state` は、モニターが `ACTIVE` になるまで `PENDING` になります。これには数分かかる場合があります。その時点で state は `ACTIVE` に変わり、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} ``` 出力: ``` { "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" } } ``` **例 2: ICMP を使用してプローブを使用するプローブ作成し、ネットワークモニターに追加するには** 次の `create-probe` の例では、`ICMP` `protocol` を使用するプローブを作成し、プローブを `Example_NetworkMonitor` という名前のモニターに追加します。作成されると、プローブ付きのモニターの `state` は、モニターが `ACTIVE` になるまで `PENDING` になります。これには数分かかる場合があります。その時点で state は `ACTIVE` に変わり、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} ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon CloudWatch User Guide*」の「[How Amazon CloudWatch Network Monitor Works](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateProbe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmonitor/create-probe.html)」を参照してください。 ### `delete-monitor` 次のコード例は、`delete-monitor` を使用する方法を示しています。 **AWS CLI** **モニターを削除するには** 次の `delete-monitor` の例では、`Example_NetworkMonitor` という名前のモニターを削除します。 ``` aws networkmonitor delete-monitor \ --monitor-name Example_NetworkMonitor ``` このコマンドでは何も出力されません。 詳細については、「*Amazon CloudWatch User Guide*」の「[How Amazon CloudWatch Network Monitor Works](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteMonitor](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmonitor/delete-monitor.html)」を参照してください。 ### `delete-probe` 次のコード例は、`delete-probe` を使用する方法を示しています。 **AWS CLI** **プローブを削除するには** 次の `delete-probe` の例では、`Example_NetworkMonitor` という名前のネットワークモニターから ID が `probe-12345` のプローブを削除します。 ``` aws networkmonitor delete-probe \ --monitor-name Example_NetworkMonitor \ --probe-id probe-12345 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon CloudWatch User Guide*」の「[How Amazon CloudWatch Network Monitor Works](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteProbe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmonitor/delete-probe.html)」を参照してください。 ### `get-monitor` 次のコード例は、`get-monitor` を使用する方法を示しています。 **AWS CLI** **モニター情報を取得するには** 次の `get-monitor` の例では、`Example_NetworkMonitor` という名前のモニターに関する情報を取得します。 ``` aws networkmonitor get-monitor \ --monitor-name Example_NetworkMonitor ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon CloudWatch User Guide*」の「[How Amazon CloudWatch Network Monitor Works](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetMonitor](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmonitor/get-monitor.html)」を参照してください。 ### `get-probe` 次のコード例は、`get-probe` を使用する方法を示しています。 **AWS CLI** **プローブの詳細を表示するには** 次の `get-probe` の例では、`Example_NetworkMonitor` という名前のモニターに関連付けられた `probeID` `probe-12345` を持つプローブの詳細を返します。 ``` aws networkmonitor get-probe \ --monitor-name Example_NetworkMonitor \ --probe-id probe-12345 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon CloudWatch User Guide*」の「[How Amazon CloudWatch Network Monitor Works](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetProbe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmonitor/get-probe.html)」を参照してください。 ### `list-monitors` 次のコード例は、`list-monitors` を使用する方法を示しています。 **AWS CLI** **例 1: すべてのモニター (単一モニター) を一覧表示するには** 次の `list-monitors` の例では、単一モニターのみのリストを返します。モニター `state` は `ACTIVE` で、`aggregationPeriod` は 60 秒です。 ``` aws networkmonitor list-monitors ``` 出力: ``` { "monitors": [{ "monitorArn": "arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor", "monitorName": "Example_NetworkMonitor", "state": "ACTIVE", "aggregationPeriod": 60, "tags": { "Monitor": "Monitor1" } } ] } ``` 詳細については、「*Amazon CloudWatch User Guide*」の「[How Amazon CloudWatch Network Monitor Works](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html)」を参照してください。 **例 2: すべてのモニターを一覧表示するには (複数のモニター)** 次の `list-monitors` の例では、3 台のモニターのリストを返します。1 台のモニターの `state` は `ACTIVE` であり、CloudWatch メトリクスを生成します。他の 2 台のモニターの状態は `INACTIVE` であり、CloudWatch メトリクスを生成しません。3 台のモニターはすべて 60 秒の `aggregationPeriod` を使用します。 ``` aws networkmonitor list-monitors ``` 出力: ``` { "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": {} } ] } ``` 詳細については、「*Amazon CloudWatch User Guide*」の「[How Amazon CloudWatch Network Monitor Works](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListMonitors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmonitor/list-monitors.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **リソースのタグを一覧表示するには** 次の `list-tags-for-resource` の例では、`Example_NetworkMonitor` という名前のモニターのタグのリストを返します。 ``` aws networkmonitor list-tags-for-resource \ --resource-arn arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor ``` 出力: ``` { "tags": { "Environment": "Dev", "Application": "PetStore" } } ``` 詳細については、「*Amazon CloudWatch User Guide*」の「[How Amazon CloudWatch Network Monitor Works](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmonitor/list-tags-for-resource.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **リソースにタグを付けるには** 次の `tag-resource` の例では、`Example_NetworkMonitor` という名前のモニターに `Environment=Dev` と `Application=PetStore` のタグを付けます。 ``` aws networkmonitor tag-resource \ --resource-arn arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor \ --tags Environment=Dev,Application=PetStore ``` このコマンドでは何も出力されません。 詳細については、「*Amazon CloudWatch User Guide*」の「[How Amazon CloudWatch Network Monitor Works](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmonitor/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **リソースのタグを削除するには** 次の `untag-resource` の例では、`Example_NetworkMonitor` という名前のモニターとの関連付けから、`Environment Application` のキーと値のペアを持つ `tag-keys` パラメータを削除します。 ``` aws networkmonitor untag-resource \ --resource-arn arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor \ --tag-keys Environment Application ``` このコマンドでは何も出力されません。 詳細については、「*Amazon CloudWatch User Guide*」の「[How Amazon CloudWatch Network Monitor Works](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmonitor/untag-resource.html)」を参照してください。 ### `update-monitor` 次のコード例は、`update-monitor` を使用する方法を示しています。 **AWS CLI** **モニターを更新するには** 次の `update-monitor` の例では、モニターの `aggregationPeriod` を `60` 秒から `30` 秒に変更します。 ``` aws networkmonitor update-monitor \ --monitor-name Example_NetworkMonitor \ --aggregation-period 30 ``` 出力: ``` { "monitorArn": "arn:aws:networkmonitor:region:012345678910:monitor/Example_NetworkMonitor", "monitorName": "Example_NetworkMonitor", "state": "PENDING", "aggregationPeriod": 30, "tags": { "Monitor": "Monitor1" } } ``` 詳細については、「*Amazon CloudWatch User Guide*」の「[How Amazon CloudWatch Network Monitor Works](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateMonitor](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmonitor/update-monitor.html)」を参照してください。 ### `update-probe` 次のコード例は、`update-probe` を使用する方法を示しています。 **AWS CLI** **プローブを更新するには** 次の `update-probe` の例では、プローブの元の `destination` IP アドレスを更新し、`packetSize` を `60` に更新します。 ``` aws networkmonitor update-probe \ --monitor-name Example_NetworkMonitor \ --probe-id probe-12345 \ --destination 10.0.0.150 \ --packet-size 60 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon CloudWatch User Guide*」の「[How Amazon CloudWatch Network Monitor Works](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/nw-monitor-how-it-works.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateProbe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmonitor/update-probe.html)」を参照してください。 # AWS CLI を使用した CloudWatch Observability Access Monitor の例 次のコード例は、CloudWatch Observability Access Monitor で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-link` 次のコード例は、`create-link` を使用する方法を示しています。 **AWS CLI** **リンクを作成するには** 次の `create-link` の例では、ソースアカウントと、モニタリングアカウントに作成したシンクとの間にリンクを作成します。 ``` 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 ``` 出力: ``` { "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": {} } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[CloudWatch のクロスアカウントオブザーバビリティ](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/create-link.html)」を参照してください。 ### `create-sink` 次のコード例は、`create-sink` を使用する方法を示しています。 **AWS CLI** **シンクを作成するには** 次の `create-sink` の例では、現在のアカウントにシンクを作成し、CloudWatch クロスアカウントオブザーバビリティでモニタリングアカウントとして使用できるようにします。 ``` aws oam create-sink \ --name DemoSink ``` 出力: ``` { "Arn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345", "Id": "a1b2c3d4-5678-90ab-cdef-example12345", "Name": "DemoSink", "Tags": {} } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[CloudWatch のクロスアカウントオブザーバビリティ](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[CreateSink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/create-sink.html)」を参照してください。 ### `delete-link` 次のコード例は、`delete-link` を使用する方法を示しています。 **AWS CLI** **リンクを削除するには** 次の `delete-link` の例では、モニタリングアカウントシンクとソースアカウントとの間のリンクを削除します。 ``` aws oam delete-link \ --identifier arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111 ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[CloudWatch のクロスアカウントオブザーバビリティ](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/delete-link.html)」を参照してください。 ### `delete-sink` 次のコード例は、`delete-sink` を使用する方法を示しています。 **AWS CLI** **シンクを削除するには** 次の `delete-sink` の例では、シンクを削除します。シンクを削除する前に、そのシンクへのすべてのリンクを削除する必要があります。 ``` aws oam delete-sink \ --identifier arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345 ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[CloudWatch のクロスアカウントオブザーバビリティ](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DeleteSink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/delete-sink.html)」を参照してください。 ### `get-link` 次のコード例は、`get-link` を使用する方法を示しています。 **AWS CLI** **1 つのリンクに関する完全な情報を返すには** 次の `get-link` の例では、リンクに関する完全な情報を返します。 ``` aws oam get-link \ --identifier arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111 ``` 出力: ``` { "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": {} } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[CloudWatch のクロスアカウントオブザーバビリティ](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[GetLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/get-link.html)」を参照してください。 ### `get-sink-policy` 次のコード例は、`get-sink-policy` を使用する方法を示しています。 **AWS CLI** **シンクにアタッチされている現在のポリシーを返すには** 次の `get-sink-policy` の例では、シンクにアタッチされている現在のポリシーを返します。 ``` aws oam get-sink-policy \ --sink-identifier arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345 ``` 出力: ``` { "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\"]}}}]}" } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[CloudWatch のクロスアカウントオブザーバビリティ](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[GetSinkPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/get-sink-policy.html)」を参照してください。 ### `get-sink` 次のコード例は、`get-sink` を使用する方法を示しています。 **AWS CLI** **1 つのモニタリングアカウントシンクに関する完全な情報を返すには** 次の `get-sink` の例では、モニタリングアカウントシンクに関する完全な情報を返します。 ``` aws oam get-sink \ --identifier arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345 ``` 出力: ``` { "Arn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345", "Id": "a1b2c3d4-5678-90ab-cdef-example12345", "Name": "DemoSink", "Tags": {} } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[CloudWatch のクロスアカウントオブザーバビリティ](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[GetSink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/get-sink.html)」を参照してください。 ### `list-attached-links` 次のコード例は、`list-attached-links` を使用する方法を示しています。 **AWS CLI** **このモニタリングアカウントシンクにリンクされているソースアカウントリンクのリストを返すには** 次の `list-attached-links` の例では、このモニタリングアカウントシンクにリンクされているソースアカウントリンクのリストを返します。 ``` aws oam list-attached-links \ --sink-identifier arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345 ``` 出力: ``` { "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" ] }] } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[CloudWatch のクロスアカウントオブザーバビリティ](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[ListAttachedLinks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/list-attached-links.html)」を参照してください。 ### `list-links` 次のコード例は、`list-links` を使用する方法を示しています。 **AWS CLI** **1 つのモニタリングアカウントシンクのリンクのリストを返すには** 次の `list-links` の例では、1 つのモニタリングアカウントシンクのリンクのリストを返します。このオペレーションをソースアカウントで実行すると、このソースアカウントのモニタリングアカウントシンクへのリンクのリストが返されます。 ``` aws oam list-links ``` 出力: ``` { "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" }] } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[CloudWatch のクロスアカウントオブザーバビリティ](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[ListLinks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/list-links.html)」を参照してください。 ### `list-sinks` 次のコード例は、`list-sinks` を使用する方法を示しています。 **AWS CLI** **モニタリングアカウントに作成されたシンクのリストを返すには** 次の `list-sinks` の例では、モニタリングアカウントに作成されたシンクのリストを返します。このオペレーションはモニタリングアカウントで実行します。 ``` aws oam list-sinks ``` 出力: ``` { "Items": [ { "Arn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345", "Id": "a1b2c3d4-5678-90ab-cdef-example12345", "Name": "DemoSink" } ] } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[CloudWatch のクロスアカウントオブザーバビリティ](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[ListSinks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/list-sinks.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **リソースに関連付けられているタグを表示するには** 次の `list-tags-for-resource` の例では、シンクに関連付けられているタグを表示します。 ``` aws oam list-tags-for-resource \ --resource-arn arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345 ``` 出力: ``` { "Tags": { "Team": "Devops" } } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[CloudWatch のクロスアカウントオブザーバビリティ](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/list-tags-for-resource.html)」を参照してください。 ### `put-sink-policy` 次のコード例は、`put-sink-policy` を使用する方法を示しています。 **AWS CLI** **リソースポリシーを作成または更新するには** 次の `put-sink-policy` の例では、モニタリングアカウントシンクにリンクするためのアクセス許可をソースアカウントに付与するリソースポリシーを作成します。 ``` 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 ``` 出力: ``` { "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\"]}}}]}" } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[CloudWatch のクロスアカウントオブザーバビリティ](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[PutSinkPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/put-sink-policy.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **指定したリソースに 1 つ以上のタグを割り当てるには** 次の `tag-resource` の例では、シンク `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 ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[CloudWatch のクロスアカウントオブザーバビリティ](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **指定したリソースから 1 つ以上のタグを削除するには** 次の `untag-resource` の例では、キーが `team` のタグをシンク `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 ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[CloudWatch のクロスアカウントオブザーバビリティ](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/untag-resource.html)」を参照してください。 ### `update-link` 次のコード例は、`update-link` を使用する方法を示しています。 **AWS CLI** **ソースアカウントからそのリンクされたモニタリングアカウントシンクに共有されるデータのタイプを変更するには** 次の `update-link` の例では、リンク `arn:aws:oam:us-east-2:123456789111:link/0123e691-e7ef-43fa-1234-c57c837fced0` をリソースタイプ `AWS::CloudWatch::Metric` と `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" ``` 出力: ``` { "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": {} } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[CloudWatch のクロスアカウントオブザーバビリティ](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Unified-Cross-Account.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/oam/update-link.html)」を参照してください。 # AWS CLI を使用した CloudWatch Observability Admin の例 次のコード例は、CloudWatch Observability Admin で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `get-telemetry-evaluation-status-for-organization` 次のコード例は、`get-telemetry-evaluation-status-for-organization` を使用する方法を示しています。 **AWS CLI** **組織のテレメトリオンボーディングステータスを取得するには** 次の `get-telemetry-evaluation-status-for-organization` の例では、組織のテレメトリ設定機能の現在のオンボーディングステータスを返します。 ``` aws observabilityadmin get-telemetry-evaluation-status-for-organization ``` 出力: ``` { "Status": "RUNNING" } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[CloudWatch テレメトリ設定の監査](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-cloudwatch.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[GetTelemetryEvaluationStatusForOrganization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/observabilityadmin/get-telemetry-evaluation-status-for-organization.html)」を参照してください。 ### `get-telemetry-evaluation-status` 次のコード例は、`get-telemetry-evaluation-status` を使用する方法を示しています。 **AWS CLI** **アカウントのテレメトリオンボーディングステータスを取得するには** 次の `get-telemetry-evaluation-status` の例では、指定したアカウントのテレメトリ設定機能の現在のオンボーディングステータスを返します。 ``` aws observabilityadmin get-telemetry-evaluation-status ``` 出力: ``` { "Status": "RUNNING" } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[CloudWatch テレメトリ設定の監査](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-cloudwatch.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[GetTelemetryEvaluationStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/observabilityadmin/get-telemetry-evaluation-status.html)」を参照してください。 ### `list-resource-telemetry-for-organization` 次のコード例は、`list-resource-telemetry-for-organization` を使用する方法を示しています。 **AWS CLI** **組織のテレメトリ設定を取得するには** 次の `list-resource-telemetry-for-organization` の例では、指定した組織でテレメトリ設定によってサポートされている AWS リソースについてテレメトリ設定のリストを返します。 ``` aws observabilityadmin list-resource-telemetry-for-organization \ --resource-types AWS::EC2::Instance ``` 出力: ``` { "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 } ] } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[CloudWatch テレメトリ設定の監査](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-cloudwatch.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[ListResourceTelemetryForOrganization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/observabilityadmin/list-resource-telemetry-for-organization.html)」を参照してください。 ### `list-resource-telemetry` 次のコード例は、`list-resource-telemetry` を使用する方法を示しています。 **AWS CLI** **アカウントのテレメトリ設定を取得するには** 次の `list-resource-telemetry` の例では、指定したアカウントでテレメトリ設定によってサポートされている AWS リソースについてテレメトリ設定のリストを返します。 ``` aws observabilityadmin list-resource-telemetry \ --resource-types AWS::EC2::Instance ``` 出力: ``` { "TelemetryConfigurations": [ { "AccountIdentifier": "111111111111", "TelemetryConfigurationState": { "Logs": "NotApplicable", "Metrics": "Disabled", "Traces": "NotApplicable" }, "ResourceType": "AWS::EC2::Instance", "ResourceIdentifier": "i-0e979d278b040f856", "ResourceTags": { "Name": "apache" }, "LastUpdateTimeStamp": 1732744260182 } ] } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[CloudWatch テレメトリ設定の監査](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-cloudwatch.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[ListResourceTelemetry](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/observabilityadmin/list-resource-telemetry.html)」を参照してください。 ### `start-telemetry-evaluation-for-organization` 次のコード例は、`start-telemetry-evaluation-for-organization` を使用する方法を示しています。 **AWS CLI** **テレメトリ設定機能を有効にするには** 次の `start-telemetry-evaluation-for-organization` の例では、組織のテレメトリ設定機能を有効にします。 ``` aws observabilityadmin start-telemetry-evaluation-for-organization ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[CloudWatch テレメトリ監査を有効にする](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-turn-on.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[StartTelemetryEvaluationForOrganization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/observabilityadmin/start-telemetry-evaluation-for-organization.html)」を参照してください。 ### `start-telemetry-evaluation` 次のコード例は、`start-telemetry-evaluation` を使用する方法を示しています。 **AWS CLI** **テレメトリ設定機能を有効にするには** 次の `start-telemetry-evaluation` の例では、指定したアカウントのテレメトリ設定機能を有効にします。 ``` aws observabilityadmin start-telemetry-evaluation ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[CloudWatch テレメトリ監査を有効にする](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-turn-on.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[StartTelemetryEvaluation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/observabilityadmin/start-telemetry-evaluation.html)」を参照してください。 ### `stop-telemetry-evaluation-for-organization` 次のコード例は、`stop-telemetry-evaluation-for-organization` を使用する方法を示しています。 **AWS CLI** **テレメトリ設定機能を無効にするには** 次の `stop-telemetry-evaluation-for-organization` の例では、組織のテレメトリ設定機能を無効にします。 ``` aws observabilityadmin stop-telemetry-evaluation-for-organization ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[CloudWatch テレメトリ監査を無効にする](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-turn-off.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[StopTelemetryEvaluationForOrganization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/observabilityadmin/stop-telemetry-evaluation-for-organization.html)」を参照してください。 ### `stop-telemetry-evaluation` 次のコード例は、`stop-telemetry-evaluation` を使用する方法を示しています。 **AWS CLI** **テレメトリ設定機能を無効にするには** 次の `stop-telemetry-evaluation` の例では、指定したアカウントのテレメトリ設定機能を無効にします。 ``` aws observabilityadmin stop-telemetry-evaluation ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[CloudWatch テレメトリ監査を無効にする](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/telemetry-config-turn-off.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[StopTelemetryEvaluation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/observabilityadmin/stop-telemetry-evaluation.html)」を参照してください。 # AWS CLI を使用した CloudWatch Synthetics の例 次のコード例は、CloudWatch Synthetics で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `associate-resource` 次のコード例は、`associate-resource` を使用する方法を示しています。 **AWS CLI** **Canary をグループに関連付けるには** 次の `associate-resource` の例では、Canary を `demo_group` という名前のグループに関連付けます。 ``` aws synthetics associate-resource \ --group-identifier demo_group \ --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[合成モニタリング (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[AssociateResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/associate-resource.html)」を参照してください。 ### `create-canary` 次のコード例は、`create-canary` を使用する方法を示しています。 **AWS CLI** **Canary を作成するには** 次の `create-canary` の例では、`demo_canary` という名前の 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 ``` 出力: ``` { "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": {} } } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[合成モニタリング (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[CreateCanary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/create-canary.html)」を参照してください。 ### `create-group` 次のコード例は、`create-group` を使用する方法を示しています。 **AWS CLI** **グループを作成するには** 次の `create-group` の例では、`demo_group` という名前のグループが作成されます。 ``` aws synthetics create-group \ --name demo_group ``` 出力: ``` { "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" } } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[合成モニタリング (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/create-group.html)」を参照してください。 ### `delete-canary` 次のコード例は、`delete-canary` を使用する方法を示しています。 **AWS CLI** **Canary を完全に削除するには** 次の `delete-canary` の例では、`demo_canary` という名前の Canary を削除します。 ``` aws synthetics delete-canary \ --name demo_canary ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[合成モニタリング (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DeleteCanary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/delete-canary.html)」を参照してください。 ### `delete-group` 次のコード例は、`delete-group` を使用する方法を示しています。 **AWS CLI** **グループを削除するには** 次の `delete-group` の例では、`demo_group` という名前のグループを削除します。 ``` aws synthetics delete-group \ --group-identifier demo_group ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[合成モニタリング (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/delete-group.html)」を参照してください。 ### `describe-canaries-last-run` 次のコード例は、`describe-canaries-last-run` を使用する方法を示しています。 **AWS CLI** **各 Canary の最新の実行からの情報を表示するには** 次の `describe-canaries-last-run` の例では、作成した各 Canary の最新の実行を返します。 ``` aws synthetics describe-canaries-last-run ``` 出力: ``` { "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" } } ] } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[合成モニタリング (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DescribeCanariesLastRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/describe-canaries-last-run.html)」を参照してください。 ### `describe-canaries` 次のコード例は、`describe-canaries` を使用する方法を示しています。 **AWS CLI** **アカウントの Canary を一覧表示するには** 次の `describe-canaries` の例では、アカウントの Canary の詳細を一覧表示します。 ``` aws synthetics describe-canaries ``` 出力: ``` { "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" } } ] } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[合成モニタリング (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DescribeCanaries](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/describe-canaries.html)」を参照してください。 ### `describe-runtime-versions` 次のコード例は、`describe-runtime-versions` を使用する方法を示しています。 **AWS CLI** **Synthetics Canary ランタイムバージョンのリストを返すには** 次の `describe-runtime-versions` の例では、Synthetics Canary ランタイムバージョンのリストを返します。 ``` aws synthetics describe-runtime-versions ``` 出力: ``` { "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" } ] } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[合成モニタリング (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DescribeRuntimeVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/describe-runtime-versions.html)」を参照してください。 ### `disassociate-resource` 次のコード例は、`disassociate-resource` を使用する方法を示しています。 **AWS CLI** **グループから Canary を削除するには** 次の `disassociate-resource` の例では、`demo_group` という名前のグループから Canary を削除します。 ``` aws synthetics disassociate-resource \ --group-identifier demo_group \ --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[合成モニタリング (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DisassociateResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/disassociate-resource.html)」を参照してください。 ### `get-canary-runs` 次のコード例は、`get-canary-runs` を使用する方法を示しています。 **AWS CLI** **指定した Canary の実行リストを取得するには** 次の `get-canary-runs` の例では、`demo_canary` という名前の Canary の実行リストを取得します。 ``` aws synthetics get-canary-runs \ --name demo_canary ``` 出力: ``` { "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" } ] } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[合成モニタリング (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[GetCanaryRuns](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/get-canary-runs.html)」を参照してください。 ### `get-canary` 次のコード例は、`get-canary` を使用する方法を示しています。 **AWS CLI** **1 つの Canary に関する完全な情報を取得するには** 次の `get-canary` の例では、`demo_canary` という名前の Canary に関する完全な情報を取得します。 ``` aws synthetics get-canary \ --name demo_canary ``` 出力: ``` { "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" } } } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[合成モニタリング (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[GetCanary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/get-canary.html)」を参照してください。 ### `get-group` 次のコード例は、`get-group` を使用する方法を示しています。 **AWS CLI** **1 つのグループに関する情報を返すには** 次の `get-group` の例では、`demo_group` という名前のグループに関する情報を返します。 ``` aws synthetics get-group \ --group-identifier demo_group ``` 出力: ``` { "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" } } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[合成モニタリング (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/get-group.html)」を参照してください。 ### `list-associated-groups` 次のコード例は、`list-associated-groups` を使用する方法を示しています。 **AWS CLI** **グループのリストを返すには** 次の `list-associated-groups` の例では、`demo_canary` という名前の Canary に関連付けられているグループのリストを返します。 ``` aws synthetics list-associated-groups \ --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary ``` 出力: ``` { "Groups": [ { "Id": "example123", "Name": "demo_group", "Arn": "arn:aws:synthetics:us-east-1:123456789012:group:example123" } ] } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[合成モニタリング (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[ListAssociatedGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/list-associated-groups.html)」を参照してください。 ### `list-group-resources` 次のコード例は、`list-group-resources` を使用する方法を示しています。 **AWS CLI** **指定したグループに関連付けられている Canary の ARN のリストを返すには** 次の `list-group-resources` の例では、`demo_group` という名前のグループに関連付けられている Canary の ARN のリストを返します。 ``` aws synthetics list-group-resources \ --group-identifier demo_group ``` 出力: ``` { "Resources": [ "arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary" ] } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[合成モニタリング (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListGroupResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/list-group-resources.html)」を参照してください。 ### `list-groups` 次のコード例は、`list-groups` を使用する方法を示しています。 **AWS CLI** **アカウントのすべてのグループのリストを返すには** 次の `list-groups` の例では、アカウントのすべてのグループのリストを返します。 ``` aws synthetics list-groups ``` 出力: ``` { "Groups": [ { "Id": "example123", "Name": "demo_group", "Arn": "arn:aws:synthetics:us-east-1:123456789012:group:example123" } ] } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[合成モニタリング (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/list-groups.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **例 1: Canary に関連付けられているタグを表示するには** 次の `list-tags-for-resource` の例では、`demo_canary` という名前の Canary に関連付けられているタグを返します。 ``` aws synthetics list-tags-for-resource \ --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary ``` 出力: ``` { "Tags": { "blueprint": "heartbeat" } } ``` **例 2: グループに関連付けられているタグを表示するには** 次の `list-tags-for-resource` の例では、`demo_group` という名前のグループに関連付けられているタグを返します。 ``` aws synthetics list-tags-for-resource \ --resource-arn arn:aws:synthetics:us-east-1:123456789012:group:example123 ``` 出力: ``` { "Tags": { "team": "Devops" } } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[合成モニタリング (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/list-tags-for-resource.html)」を参照してください。 ### `start-canary` 次のコード例は、`start-canary` を使用する方法を示しています。 **AWS CLI** **Canary を実行するには** 次の `start-canary` の例では、`demo_canary` という名前の Canary を実行します。 ``` aws synthetics start-canary \ --name demo_canary ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[合成モニタリング (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[StartCanary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/start-canary.html)」を参照してください。 ### `stop-canary` 次のコード例は、`stop-canary` を使用する方法を示しています。 **AWS CLI** **Canary を停止するには** 次の `stop-canary` の例では、`demo_canary` という名前の Canary を停止します。 ``` aws synthetics stop-canary \ --name demo_canary ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[合成モニタリング (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[StopCanary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/stop-canary.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **例 1: Canary にタグを割り当てるには** 次の `tag-resource` の例では、`demo_canary` という名前の Canary にタグを割り当てます。 ``` aws synthetics tag-resource \ --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary \ --tags blueprint=heartbeat ``` このコマンドでは何も出力されません。 **例 2: グループにタグを割り当てるには** 次の `tag-resource` の例では、`demo_group` という名前のグループにタグを割り当てます。 ``` aws synthetics tag-resource \ --resource-arn arn:aws:synthetics:us-east-1:123456789012:group:example123 \ --tags team=Devops ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[合成モニタリング (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **例 1: Canary からタグを削除するには** 次の `untag-resource` の例では、`demo_canary` という名前の Canary からタグを削除します。 ``` aws synthetics untag-resource \ --resource-arn arn:aws:synthetics:us-east-1:123456789012:canary:demo_canary \ --tag-keys blueprint ``` このコマンドでは何も出力されません。 **例 2: グループからタグを削除するには** 次の `untag-resource` の例では、`demo_group` という名前のグループからタグを削除します。 ``` aws synthetics untag-resource \ --resource-arn arn:aws:synthetics:us-east-1:123456789012:group:example123 \ --tag-keys team ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[合成モニタリング (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/untag-resource.html)」を参照してください。 ### `update-canary` 次のコード例は、`update-canary` を使用する方法を示しています。 **AWS CLI** **Canary を更新するには** 次の `update-canary` の例では、`demo_canary` という名前の Canary の設定を更新します。 ``` aws synthetics update-canary \ --name demo_canary \ --schedule Expression="rate(15 minutes)" ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[合成モニタリング (Canary)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[UpdateCanary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/synthetics/update-canary.html)」を参照してください。 # AWS CLI を使用した CodeArtifact の例 次のコード例は、CodeArtifact で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `associate-external-connection` 次のコード例は、`associate-external-connection` を使用する方法を示しています。 **AWS CLI** **リポジトリに外部接続を追加するには** 次の `associate-external-connection` の例では、test-repo という名前のリポジトリに npmjs.com への外部接続を追加します。 ``` aws codeartifact associate-external-connection \ --repository test-repo \ --domain test-domain \ --external-connection public:npmjs ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[Add an external connection](https://docs.aws.amazon.com/codeartifact/latest/ug/external-connection.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateExternalConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/associate-external-connection.html)」を参照してください。 ### `copy-package-versions` 次のコード例は、`copy-package-versions` を使用する方法を示しています。 **AWS CLI** **あるリポジトリから別のリポジトリにパッケージバージョンをコピーするには** 次の `copy-package-versions` では、test-package という名前のパッケージのバージョン 4.0.0 および 5.0.0 を my-repo から 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"]' ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[Copy packages between repositories](https://docs.aws.amazon.com/codeartifact/latest/ug/copy-package.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CopyPackageVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/copy-package-versions.html)」を参照してください。 ### `create-domain` 次のコード例は、`create-domain` を使用する方法を示しています。 **AWS CLI** **ドメインを作成するには** 次の `create-domain` の例では、test-domain という名前のドメインを作成します。 ``` aws codeartifact create-domain \ --domain test-domain ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[Create a domain](https://docs.aws.amazon.com/codeartifact/latest/ug/domain-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/create-domain.html)」を参照してください。 ### `create-repository` 次のコード例は、`create-repository` を使用する方法を示しています。 **AWS CLI** **リポジトリを作成するには** () 次の `create-repository` の例では、test-domain という名前のドメイン内に test-repo という名前のリポジトリを作成します。 ``` aws codeartifact create-repository \ --domain test-domain \ --domain-owner 111122223333 \ --repository test-repo \ --description "This is a test repository." ``` 出力: ``` { "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": [] } } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[Create a domain](https://docs.aws.amazon.com/codeartifact/latest/ug/create-repo.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/create-repository.html)」を参照してください。 ### `delete-domain-permissions-policy` 次のコード例は、`delete-domain-permissions-policy` を使用する方法を示しています。 **AWS CLI** **ドメインからアクセス許可ポリシードキュメントを削除するには** 次の `delete-domain-permissions-policy` の例では、test-domain という名前のドメインからアクセス許可ポリシーを削除します。 ``` aws codeartifact delete-domain-permissions-policy \ --domain test-domain ``` 出力: ``` { "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" } } ] } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[Delete a domain policy](https://docs.aws.amazon.com/codeartifact/latest/ug/domain-policies.html#deleting-a-domain-policy)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDomainPermissionsPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/delete-domain-permissions-policy.html)」を参照してください。 ### `delete-domain` 次のコード例は、`delete-domain` を使用する方法を示しています。 **AWS CLI** **ドメインを削除するには** 次の `delete-domain` の例では、`test-domain` という名前のドメインを削除します。 ``` aws codeartifact delete-domain \ --domain test-domain ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[Delete a domain](https://docs.aws.amazon.com/codeartifact/latest/ug/delete-domain.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/delete-domain.html)」を参照してください。 ### `delete-package-versions` 次のコード例は、`delete-package-versions` を使用する方法を示しています。 **AWS CLI** **パッケージのバージョンを削除するには** 次の `delete-package-versions` の例では、test-package という名前のパッケージのバージョン 4.0.0 を削除します。 ``` aws codeartifact delete-package-versions \ --domain test-domain \ --repo test-repo \ --format npm \ --package test-package \ --versions 4.0.0 ``` 出力: ``` { "successfulVersions": { "4.0.0": { "revision": "Ciqe5/9yicvkJT13b5/LdLpCyE6fqA7poa9qp+FilPs=", "status": "Deleted" } }, "failedVersions": {} } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[Delete a package version](https://docs.aws.amazon.com/codeartifact/latest/ug/delete-package.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeletePackageVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/delete-package-versions.html)」を参照してください。 ### `delete-repository-permissions-policy` 次のコード例は、`delete-repository-permissions-policy` を使用する方法を示しています。 **AWS CLI** **リポジトリからアクセス許可ポリシーを削除するには** 次の `delete-repository-permissions-policy` の例では、test-repo という名前のリポジトリからアクセス許可ポリシーを削除します。 ``` aws codeartifact delete-repository-permissions-policy \ --domain test-domain \ --repository test-repo ``` 出力: ``` { "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": "*" } ] } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[Delete a policy](https://docs.aws.amazon.com/codeartifact/latest/ug/repo-policies.html#deleting-a-policy)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRepositoryPermissionsPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/delete-repository-permissions-policy.html)」を参照してください。 ### `delete-repository` 次のコード例は、`delete-repository` を使用する方法を示しています。 **AWS CLI** **リポジトリを削除するには** () 次の `delete-repository` の例では、`test-domain` という名前のドメイン内にある `test-repo` という名前のリポジトリを削除します。 ``` aws codeartifact delete-repository \ --domain test-domain \ --repository test-repo ``` 出力: ``` { "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": [] } } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[Delete a repository](https://docs.aws.amazon.com/codeartifact/latest/ug/delete-repo.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/delete-repository.html)」を参照してください。 ### `describe-domain` 次のコード例は、`describe-domain` を使用する方法を示しています。 **AWS CLI** **ドメインに関する情報を取得するには** 次の `describe-domain` の例では、test-domain という名前のドメインに対して DomainDescription オブジェクトを返します。 ``` aws codeartifact describe-domain \ --domain test-domain ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[Domain overview](https://docs.aws.amazon.com/codeartifact/latest/ug/domain-overview.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/describe-domain.html)」を参照してください。 ### `describe-repository` 次のコード例は、`describe-repository` を使用する方法を示しています。 **AWS CLI** **リポジトリに関する情報を取得するには** 次の `describe-repository` の例では、test-repo という名前のリポジトリに対して RepositoryDescription オブジェクトを返します。 ``` aws codeartifact describe-repository \ --domain test-domain \ --repository test-repo ``` 出力: ``` { "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": [] } } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[Create a domain](https://docs.aws.amazon.com/codeartifact/latest/ug/create-repo.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/describe-repository.html)」を参照してください。 ### `disassociate-external-connection` 次のコード例は、`disassociate-external-connection` を使用する方法を示しています。 **AWS CLI** **リポジトリから外部接続を削除するには** 次の `disassociate-external-connection` の例では、test-repo という名前のリポジトリから npmjs.com への外部接続を削除します。 ``` aws codeartifact disassociate-external-connection \ --repository test-repo \ --domain test-domain \ --external-connection public:npmjs ``` 出力: ``` { "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": [] } } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[Remove an external connection](https://docs.aws.amazon.com/codeartifact/latest/ug/external-connection.html#removing-an-external-connection)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateExternalConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/disassociate-external-connection.html)」を参照してください。 ### `dispose-package-versions` 次のコード例は、`dispose-package-versions` を使用する方法を示しています。 **AWS CLI** **パッケージバージョンのアセットを削除し、そのステータスを [廃棄] に設定するには** 次の `dispose-package-versions` の例では、test-package のバージョン 4.0.0 のアセットを削除し、そのステータスを [廃棄] に設定します。 ``` aws codeartifact dispose-package-versions \ --domain test-domain \ --repo test-repo \ --format npm \ --package test-package \ --versions 4.0.0 ``` 出力: ``` { "successfulVersions": { "4.0.0": { "revision": "Ciqe5/9yicvkJT13b5/LdLpCyE6fqA7poa9qp+FilPs=", "status": "Disposed" } }, "failedVersions": {} } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[Working with packages in CodeArtifact](https://docs.aws.amazon.com/codeartifact/latest/ug/packages.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisposePackageVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/dispose-package-versions.html)」を参照してください。 ### `get-authorization-token` 次のコード例は、`get-authorization-token` を使用する方法を示しています。 **AWS CLI** **認証トークンを取得するには** 次の `get-authorization-token` の例では、CodeArtifact 認証トークンを取得します。 ``` aws codeartifact get-authorization-token \ --domain test-domain \ --query authorizationToken \ --output text ``` 出力: ``` This command will return the authorization token. You can store the output in an environment variable when calling the command. ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[Configure pip without the login command](https://docs.aws.amazon.com/codeartifact/latest/ug/python-configure-without-pip.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAuthorizationToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/get-authorization-token.html)」を参照してください。 ### `get-domain-permissions-policy` 次のコード例は、`get-domain-permissions-policy` を使用する方法を示しています。 **AWS CLI** **ドメインのアクセス許可ポリシードキュメントを取得するには** 次の `get-domain-permissions-policy` の例では、test-domain という名前のドメインにアタッチされたアクセス許可ポリシーを取得します。 ``` aws codeartifact get-domain-permissions-policy \ --domain test-domain ``` 出力: ``` { "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" } } ] } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[Read a domain policy](https://docs.aws.amazon.com/codeartifact/latest/ug/domain-policies.html#reading-a-domain-policy)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDomainPermissionsPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/get-domain-permissions-policy.html)」を参照してください。 ### `get-package-version-asset` 次のコード例は、`get-package-version-asset` を使用する方法を示しています。 **AWS CLI** **パッケージバージョンからアセットを取得するには** 次の `get-package-version-asset` の例では、test-package という名前の npm パッケージのバージョン 4.0.0 の `package.tgz` アセットを取得します。 ``` 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 ``` 出力: ``` 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=" } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[List package version assets](https://docs.aws.amazon.com/codeartifact/latest/ug/list-assets.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPackageVersionAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/get-package-version-asset.html)」を参照してください。 ### `get-package-version-readme` 次のコード例は、`get-package-version-readme` を使用する方法を示しています。 **AWS CLI** **パッケージバージョンの readme ファイルを取得するには** 次の `get-package-version-readme` の例では、test-package という名前の npm パッケージのバージョン 4.0.0 の readme ファイルを取得します。 ``` aws codeartifact get-package-version-readme \ --domain test-domain \ --repo test-repo \ --format npm \ --package test-package \ --package-version 4.0.0 ``` 出力: ``` { "format": "npm", "package": "test-package", "version": "4.0.0", "readme": "
\n ... more content ... \n", "versionRevision": "Ciqe5/9yicvkJT13b5/LdLpCyE6fqA7poa9qp+FilPs=" } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[View package version readme file](https://docs.aws.amazon.com/codeartifact/latest/ug/describe-package-version.html#view-package-readme)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPackageVersionReadme](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/get-package-version-readme.html)」を参照してください。 ### `get-repository-endpoint` 次のコード例は、`get-repository-endpoint` を使用する方法を示しています。 **AWS CLI** **リポジトリの URL エンドポイントを取得するには** 次の `get-repository-endpoint` の例では、test-repo リポジトリに対して npm エンドポイントを返します。 ``` aws codeartifact get-repository-endpoint \ --domain test-domain \ --repository test-repo \ --format npm ``` 出力: ``` { "repositoryEndpoint": "https://test-domain-111122223333.d.codeartifact.us-west-2.amazonaws.com/npm/test-repo/" } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[Connect to a repository](https://docs.aws.amazon.com/codeartifact/latest/ug/connect-repo.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRepositoryEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/get-repository-endpoint.html)」を参照してください。 ### `get-repository-permissions-policy` 次のコード例は、`get-repository-permissions-policy` を使用する方法を示しています。 **AWS CLI** **リポジトリのアクセス許可ポリシードキュメントを取得するには** 次の `get-repository-permissions-policy` の例では、test-repo という名前のリポジトリにアタッチされたアクセス許可ポリシーを取得します。 ``` aws codeartifact get-repository-permissions-policy \ --domain test-domain \ --repository test-repo ``` 出力: ``` { "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": "*" } ] } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[Read a policy](https://docs.aws.amazon.com/codeartifact/latest/ug/repo-policies.html#setting-a-policy)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRepositoryPermissionsPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/get-repository-permissions-policy.html)」を参照してください。 ### `list-domains` 次のコード例は、`list-domains` を使用する方法を示しています。 **AWS CLI** **ドメインを一覧表示するには** 次の `list-domains` の例では、呼び出しを行う AWS アカウントが所有するすべてのドメインの概要を返します。 ``` aws codeartifact list-domains ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[Working with domains in CodeArtifact](https://docs.aws.amazon.com/codeartifact/latest/ug/domains.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDomains](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/list-domains.html)」を参照してください。 ### `list-package-version-assets` 次のコード例は、`list-package-version-assets` を使用する方法を示しています。 **AWS CLI** **パッケージバージョンのアセットを表示するには** 次の `list-package-version-assets` の例では、test-package という名前の npm パッケージのバージョン 4.0.0 のアセットを取得します。 ``` aws codeartifact list-package-version-assets \ --domain test-domain \ --repo test-repo \ --format npm \ --package test-package \ --package-version 4.0.0 ``` 出力: ``` { "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" } } ] } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[List package version assets](https://docs.aws.amazon.com/codeartifact/latest/ug/list-assets.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPackageVersionAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/list-package-version-assets.html)」を参照してください。 ### `list-package-version-dependencies` 次のコード例は、`list-package-version-dependencies` を使用する方法を示しています。 **AWS CLI** **パッケージバージョンの依存関係を表示するには** 次の `list-package-version-dependencies` 例では、test-package という名前の npm パッケージのバージョン 4.0.0 の依存関係を取得します。 ``` aws codeartifact list-package-version-dependencies \ --domain test-domain \ --repo test-repo \ --format npm \ --package test-package \ --package-version 4.0.0 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[View and update package version details and dependencies](https://docs.aws.amazon.com/codeartifact/latest/ug/describe-package-version.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPackageVersionDependencies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/list-package-version-dependencies.html)」を参照してください。 ### `list-package-versions` 次のコード例は、`list-package-versions` を使用する方法を示しています。 **AWS CLI** **パッケージのパッケージバージョンを一覧表示するには** 次の `list-package-versions` の例では、`kind-of` という名前のパッケージに対してパッケージバージョンのリストを返します。 ``` aws codeartifact list-package-versions \ --package kind-of \ --domain test-domain \ --repository test-repo \ --format npm ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[List package versions](https://docs.aws.amazon.com/codeartifact/latest/ug/list-packages-versions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPackageVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/list-package-versions.html)」を参照してください。 ### `list-packages` 次のコード例は、`list-packages` を使用する方法を示しています。 **AWS CLI** **リポジトリ内のパッケージを一覧表示するには** 次の `list-packages` の例では、`test-domain` という名前のドメインにある `test-repo` という名前のリポジトリのパッケージを一覧表示します。 ``` aws codeartifact list-packages \ --domain test-domain \ --repository test-repo ``` 出力: ``` { "packages": [ { "format": "npm", "package": "lodash" } { "format": "python", "package": "test-package" } ] } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[List package names](https://docs.aws.amazon.com/codeartifact/latest/ug/list-packages.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPackages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/list-packages.html)」を参照してください。 ### `list-repositories-in-domain` 次のコード例は、`list-repositories-in-domain` を使用する方法を示しています。 **AWS CLI** **ドメインのリポジトリを一覧表示するには** 次の `list-repositories-in-domain` の例では、test-domain ドメイン内のすべてのリポジトリの概要を返します。 ``` aws codeartifact list-repositories-in-domain \ --domain test-domain ``` 出力: ``` { "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." } ] } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[List repositories](https://docs.aws.amazon.com/codeartifact/latest/ug/list-repos.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRepositoriesInDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/list-repositories-in-domain.html)」を参照してください。 ### `list-repositories` 次のコード例は、`list-repositories` を使用する方法を示しています。 **AWS CLI** **リポジトリを一覧表示するには** 次の `list-repositories` の例では、呼び出しを行う AWS アカウントが所有するドメイン内にあるすべてのリポジトリの概要を返します。 ``` aws codeartifact list-repositories ``` 出力: ``` { "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." } ] } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[List repositories](https://docs.aws.amazon.com/codeartifact/latest/ug/list-repos.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRepositories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/list-repositories.html)」を参照してください。 ### `login` 次のコード例は、`login` を使用する方法を示しています。 **AWS CLI** **ログインコマンドを使用してリポジトリへの認証を設定するには** 次の `login` の例では、test-domain という名前のドメインにある test-repo という名前のリポジトリを使用して npm パッケージマネージャーを設定します。 ``` aws codeartifact login \ --domain test-domain \ --repository test-repo \ --tool npm ``` 出力: ``` 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 ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[Getting started with the AWS CLI](https://docs.aws.amazon.com/codeartifact/latest/ug/getting-started-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[Login](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/login.html)」を参照してください。 ### `put-domain-permissions-policy` 次のコード例は、`put-domain-permissions-policy` を使用する方法を示しています。 **AWS CLI** **アクセス許可ポリシーをドメインにアタッチするには** 次の `put-domain-permissions-policy` の例では、policy.json ファイルで定義されているアクセス許可ポリシーを test-domain という名前のドメインにアタッチします。 ``` aws codeartifact put-domain-permissions-policy \ --domain test-domain \ --policy-document file://PATH/TO/policy.json ``` 出力: ``` { "policy": { "resourceArn": "arn:aws:codeartifact:region-id:111122223333:domain/test-domain", "document": "{ ...policy document content...}", "revision": "MQlyyTQRASRU3HB58gBtSDHXG7Q3hvxxxxxxx=" } } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[Set a domain policy](https://docs.aws.amazon.com/codeartifact/latest/ug/domain-policies.html#set-domain-policy)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutDomainPermissionsPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/put-domain-permissions-policy.html)」を参照してください。 ### `put-repository-permissions-policy` 次のコード例は、`put-repository-permissions-policy` を使用する方法を示しています。 **AWS CLI** **アクセス許可ポリシーをリポジトリにアタッチするには** 次の `put-repository-permissions-policy` の例では、policy.json ファイルで定義されているアクセス許可ポリシーを test-repo という名前のリポジトリにアタッチします。 ``` aws codeartifact put-repository-permissions-policy \ --domain test-domain \ --repository test-repo \ --policy-document file://PATH/TO/policy.json ``` 出力: ``` { "policy": { "resourceArn": "arn:aws:codeartifact:region-id:111122223333:repository/test-domain/test-repo", "document": "{ ...policy document content...}", "revision": "MQlyyTQRASRU3HB58gBtSDHXG7Q3hvxxxxxxx=" } } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[Set a policy](https://docs.aws.amazon.com/codeartifact/latest/ug/repo-policies.html#setting-a-policy)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutRepositoryPermissionsPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/put-repository-permissions-policy.html)」を参照してください。 ### `update-package-versions-status` 次のコード例は、`update-package-versions-status` を使用する方法を示しています。 **AWS CLI** **パッケージバージョンのステータスを更新するには** 次の `update-package-versions-status` の例では、test-package パッケージのバージョン 4.0.0 のステータスを [アーカイブ済み] に更新します。 ``` aws codeartifact update-package-versions-status \ --domain test-domain \ --repo test-repo \ --format npm \ --package test-package \ --versions 4.0.0 \ --target-status Archived ``` 出力: ``` { "successfulVersions": { "4.0.0": { "revision": "Ciqe5/9yicvkJT13b5/LdLpCyE6fqA7poa9qp+FilPs=", "status": "Archived" } }, "failedVersions": {} } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[Update package version status](https://docs.aws.amazon.com/codeartifact/latest/ug/describe-package-version.html#update-package-version-status)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdatePackageVersionsStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/update-package-versions-status.html)」を参照してください。 ### `update-repository` 次のコード例は、`update-repository` を使用する方法を示しています。 **AWS CLI** **リポジトリを更新するには** 次の `update-repository` の例では、test-domain という名前のドメインの test-repo という名前のリポジトリの説明を「これは更新された説明です」に更新します。 ``` aws codeartifact update-repository \ --domain test-domain \ --repository test-repo \ --description "this is an updated description" ``` 出力: ``` { "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": [] } } ``` 詳細については、「*AWS CodeArtifact ユーザーガイド*」の「[View or modify a repository configuration](https://docs.aws.amazon.com/codeartifact/latest/ug/config-repos.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeartifact/update-repository.html)」を参照してください。 # AWS CLI を使用した CodeBuild の例 次のコード例は、CodeBuild で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `batch-delete-builds` 次のコード例は、`batch-delete-builds` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild でビルドを削除するには。** 次の `batch-delete-builds` の例では、指定した ID を持つ CodeBuild のビルドを削除します。 ``` aws codebuild batch-delete-builds --ids my-build-project-one:a1b2c3d4-5678-9012-abcd-11111EXAMPLE my-build-project-two:a1b2c3d4-5678-9012-abcd-22222EXAMPLE ``` 出力: ``` { "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" ] } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Delete Builds (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/delete-builds.html#delete-builds-cli)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchDeleteBuilds](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/batch-delete-builds.html)」を参照してください。 ### `batch-get-build-batches` 次のコード例は、`batch-get-build-batches` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild でビルドの詳細を表示するには。** 次の `batch-get-build-batches` の例では、指定した ID を持つ CodeBuild のビルドバッチの情報を取得します。 ``` aws codebuild batch-get-build-batches \ --ids codebuild-demo-project:e9c4f4df-3f43-41d2-ab3a-60fe2EXAMPLE ``` 出力: ``` { "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": [] } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「AWS CodeBuild )\$1\$1」の「Batch builds」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchGetBuildBatches](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/batch-get-build-batches.html)」を参照してください。 ### `batch-get-builds` 次のコード例は、`batch-get-builds` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild でビルドの詳細を表示するには。** 次の `batch-get-builds` の例では、指定した ID を持つ CodeBuild のビルドの情報を取得します。 ``` aws codebuild batch-get-builds --ids codebuild-demo-project:e9c4f4df-3f43-41d2-ab3a-60fe2EXAMPLE codebuild-demo-project:815e755f-bade-4a7e-80f0-efe51EXAMPLE ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[View Build Details (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/view-build-details.html#view-build-details-cli)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchGetBuilds](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/batch-get-builds.html)」を参照してください。 ### `batch-get-projects` 次のコード例は、`batch-get-projects` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild ビルドプロジェクトの名前のリストを取得するには。** 次の `batch-get-projects` の例では、名前で指定した CodeBuild ビルドプロジェクトのリストを取得します。 ``` aws codebuild batch-get-projects --names codebuild-demo-project codebuild-demo-project2 my-other-demo-project ``` 次の出力では、指定されたビルドプロジェクト名のうち、見つからなかったものがすべて `projectsNotFound` 配列にリストされています。`projects` 配列は、情報が見つかった各ビルドプロジェクトの詳細を示しています。 ``` { "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": [] } ] } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[View a Build Project's Details (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/view-project-details.html#view-project-details-cli)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchGetProjects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/batch-get-projects.html)」を参照してください。 ### `batch-get-report-groups` 次のコード例は、`batch-get-report-groups` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild の 1 つ以上のレポートグループに関する情報を取得するには。** 次の `batch-get-report-groups` の例では、指定した ARN を持つレポートグループの情報を取得します。 ``` aws codebuild batch-get-report-groups \ --report-group-arns arn:aws:codebuild:::report-group/ ``` 出力: ``` { "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": [] } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Working with report groups](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report-group.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchGetReportGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/batch-get-report-groups.html)」を参照してください。 ### `batch-get-reports` 次のコード例は、`batch-get-reports` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild で 1 つ以上のレポートに関する情報を取得するには。** 次の `batch-get-reports` の例では、指定した ARN を持つレポートの情報を取得します。 ``` aws codebuild batch-get-reports \ --report-arns arn:aws:codebuild:::report/: arn:aws:codebuild:::report/: ``` 出力: ``` { "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": [] } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Working with reports](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchGetReports](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/batch-get-reports.html)」を参照してください。 ### `create-project` 次のコード例は、`create-project` を使用する方法を示しています。 **AWS CLI** **例 1: AWS CodeBuild ビルドプロジェクトを作成するには** 次の `create-project` 例は、S3 バケットのソースファイルを使用して CodeBuild ビルドプロジェクトを作成します。 ``` 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" ``` 出力: ``` { "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 } } ``` **例 2: パラメータ用の JSON 入力ファイルを使用して AWS CodeBuild ビルドプロジェクトを作成するには** 次の `create-project` 例では、JSON 入力ファイルにすべての必須パラメータを渡して CodeBuild ビルドプロジェクトを作成します。`--generate-cli-skeleton parameter` のみを含むコマンドを実行して、入力ファイルテンプレートを作成します。 ``` aws codebuild create-project --cli-input-json file://create-project.json ``` 入力 JSON ファイル `create-project.json` には、以下の内容が含まれます。 ``` { "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" } ``` 出力: ``` { "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" } } ``` 詳細については、「AWS CodeBuild ユーザーガイド」の「[ビルドプロジェクトの作成 (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/create-project.html#create-project-cli)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[CreateProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/create-project.html)」を参照してください。** ### `create-report-group` 次のコード例は、`create-report-group` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild でレポートグループを作成するには。** 次の `create-report-group` の例では、新しいレポートグループを作成します。 ``` aws codebuild create-report-group \ --cli-input-json file://create-report-group-source.json ``` 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 } } } ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Working with report groups](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report-group.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateReportGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/create-report-group.html)」を参照してください。 ### `create-webhook` 次のコード例は、`create-webhook` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild プロジェクトのウェブフックフィルターを作成するには** 次の `create-webhook` の例では、2 つのフィルタグループを持つ `my-project` という名前の CodeBuild プロジェクトのウェブフックを作成します。最初のフィルタグループでは、正規表現 `^refs/heads/master$` と一致する Git 参照名および `^refs/heads/myBranch$` と一致するヘッド参照を持つブランチに対してプルリクエストを作成、更新、または再開することを指定します。2 番目のフィルタグループでは、正規表現 `^refs/heads/myBranch$` と一致しない Git 参照名を持つブランチでプッシュリクエストを指定します。 ``` 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}]]" ``` 出力: ``` { "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 } ] ] } } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Filter GitHub Webhook Events (SDK)](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-github-pull-request.html#sample-github-pull-request-filter-webhook-events-sdk)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateWebhook](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/create-webhook.html)」を参照してください。 ### `delete-build-batch` 次のコード例は、`delete-build-batch` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild でバッチビルドを削除するには。** 次の `delete-build-batch` の例では、指定されたバッチビルドを削除します。 ``` aws codebuild delete-build-batch \ --id : ``` 出力: ``` { "statusCode": "BATCH_DELETED", "buildsDeleted": [ "arn:aws:codebuild:::build/:", "arn:aws:codebuild:::build/:", "arn:aws:codebuild:::build/:", "arn:aws:codebuild:::build/:" ], "buildsNotDeleted": [] } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Batch builds in AWS CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/batch-build.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteBuildBatch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/delete-build-batch.html)」を参照してください。 ### `delete-project` 次のコード例は、`delete-project` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild ビルドプロジェクトを削除するには** 次の `delete-project` の例では、指定された CodeBuild ビルドプロジェクトを削除します。 ``` aws codebuild delete-project --name my-project ``` このコマンドでは何も出力されません。 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Delete a Build Project (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/delete-project.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/delete-project.html)」を参照してください。 ### `delete-report-group` 次のコード例は、`delete-report-group` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild でレポートグループを削除するには。** 次の `delete-report-group` の例では、指定された ARN を持つレポートグループを削除します。 ``` aws codebuild delete-report-group \ --arn arn:aws:codebuild:::report-group/ ``` このコマンドでは何も出力されません。 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Working with report groups](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report-group.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteReportGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/delete-report-group.html)」を参照してください。 ### `delete-report` 次のコード例は、`delete-report` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild でレポートを削除するには。** 次の `delete-report` の例では、指定されたレポートを削除します。 ``` aws codebuild delete-report \ --arn arn:aws:codebuild:::report/: ``` このコマンドでは何も出力されません。 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Working with reports](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/delete-report.html)」を参照してください。 ### `delete-source-credentials` 次のコード例は、`delete-source-credentials` を使用する方法を示しています。 **AWS CLI** **ソースプロバイダーから切断し、そのアクセストークンを削除するには。** 次の `delete-source-credentials` の例では、ソースプロバイダーから切断し、そのトークンを削除します。ソースプロバイダーへの接続に使用されるソース認証情報の ARN によって、どのソース認証情報が使用されるかが決定します。 ``` aws codebuild delete-source-credentials --arn arn-of-your-credentials ``` 出力: ``` { "arn": "arn:aws:codebuild:your-region:your-account-id:token/your-server-type" } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Connect Source Providers with Access Tokens (CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-access-tokens.html#sample-access-tokens-cli)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteSourceCredentials](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/delete-source-credentials.html)」を参照してください。 ### `delete-webhook` 次のコード例は、`delete-webhook` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild プロジェクトからウェブフックフィルターを削除するには** 次の `delete-webhook` の例では、指定された CodeBuild プロジェクトからウェブフックを削除します。 ``` aws codebuild delete-webhook --project-name my-project ``` このコマンドでは何も出力されません。 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Stop Running Builds Automatically (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/run-build.html#run-build-cli-auto-stop)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteWebhook](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/delete-webhook.html)」を参照してください。 ### `describe-code-coverages` 次のコード例は、`describe-code-coverages` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild でコードカバレッジテストの結果に関する詳細情報を取得するには。** 次の `describe-code-coverages` の例では、指定されたレポートのコードカバレッジテストの結果に関する情報を取得します。 ``` aws codebuild describe-code-coverages \ --report-arn arn:aws:codebuild:::report/: ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Code coverage reports](https://docs.aws.amazon.com/codebuild/latest/userguide/code-coverage-report.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeCodeCoverages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/describe-code-coverages.html)」を参照してください。 ### `describe-test-cases` 次のコード例は、`describe-test-cases` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild のテストケースに関する詳細情報を取得するには。** 次の `describe-test-cases` の例では、指定されたレポートのテストケースに関する情報を取得します。 ``` aws codebuild describe-test-cases \ --report-arn arn:aws:codebuild:::report/: ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Working with test reporting in AWS CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/test-reporting.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTestCases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/describe-test-cases.html)」を参照してください。 ### `import-source-credentials` 次のコード例は、`import-source-credentials` を使用する方法を示しています。 **AWS CLI** **ソースプロバイダーの認証情報をインポートし、AWS CodeBuild ユーザーをソースプロバイダーに接続するには。** 次の `import-source-credentials` の例では、認証タイプに BASIC\$1AUTH を使用する Bitbucket リポジトリのトークンをインポートします。 ``` aws codebuild import-source-credentials --server-type BITBUCKET --auth-type BASIC_AUTH --token my-Bitbucket-password --username my-Bitbucket-username ``` 出力: ``` { "arn": "arn:aws:codebuild:us-west-2:123456789012:token/bitbucket" } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Connect Source Providers with Access Tokens (CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-access-tokens.html#sample-access-tokens-cli)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ImportSourceCredentials](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/import-source-credentials.html)」を参照してください。 ### `invalidate-project-cache` 次のコード例は、`invalidate-project-cache` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild ビルドプロジェクトのキャッシュをリセットするには。** 次の `invalidate-project-cache` の例では、指定された CodeBuild プロジェクトのキャッシュをリセットします。 ``` aws codebuild invalidate-project-cache --project-name my-project ``` このコマンドでは何も出力されません。 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Build Caching in CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/build-caching.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[InvalidateProjectCache](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/invalidate-project-cache.html)」を参照してください。 ### `list-build-batches-for-project` 次のコード例は、`list-build-batches-for-project` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild で特定のビルドプロジェクトのバッチビルドを一覧表示するには。** 次の `list-build-batches-for-project` の例では、指定したプロジェクトの CodeBuild バッチビルドを一覧表示します。 ``` aws codebuild list-build-batches-for-project \ --project-name "" ``` 出力: ``` { "ids": [ ":", ":" ] } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Batch builds in AWS CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/batch-build.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListBuildBatchesForProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-build-batches-for-project.html)」を参照してください。 ### `list-build-batches` 次のコード例は、`list-build-batches` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild でバッチビルドを一覧表示するには。** 次の `list-build-batches` の例では、現在のアカウントの CodeBuild バッチビルドを一覧表示します。 ``` aws codebuild list-build-batches ``` 出力: ``` { "ids": [ ":", ":" ] } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「AWS CodeBuild )\$1\$1」の「Batch builds」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListBuildBatches](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-build-batches.html)」を参照してください。 ### `list-builds-for-project` 次のコード例は、`list-builds-for-project` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild ビルドプロジェクトのビルドのリストを表示するには。** 次の `list-builds-for-project` の例では、指定された CodeBuild ビルドプロジェクトのビルド ID を降順で一覧表示します。 ``` aws codebuild list-builds-for-project --project-name codebuild-demo-project --sort-order DESCENDING ``` 出力: ``` { "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" ] } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[View a List of Build IDs for a Build Project (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/view-builds-for-project.html#view-builds-for-project-cli)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListBuildsForProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-builds-for-project.html)」を参照してください。 ### `list-builds` 次のコード例は、`list-builds` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild ビルド ID のリストを取得するには。** 次の `list-builds` の例では、昇順にソートされた CodeBuild ID のリストを取得します。 ``` aws codebuild list-builds --sort-order ASCENDING ``` 出力には、より多くの出力が利用できることを示す `nextToken` 値が含まれます。 ``` { "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" ] } ``` このコマンドを再度実行し、前のレスポンスの `nextToken` 値をパラメータとして指定して、出力の次の部分を取得します。レスポンスに `nextToken` 値が返されなくなるまで繰り返します。 ``` aws codebuild list-builds --sort-order ASCENDING --next-token 4AEA6u7J...The full token has been omitted for brevity...MzY2OA== ``` 出力の次の部分: ``` { "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" ] } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[View a List of Build IDs (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/view-build-list.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListBuilds](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-builds.html)」を参照してください。 ### `list-curated-environment-images` 次のコード例は、`list-curated-environment-images` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild によって管理され、ビルドに使用できる Docker イメージのリストを取得するには。** 次の `list-curated-environment-images` の例では、CodeBuild によって管理され、ビルドに使用できる Docker イメージを一覧表示します。 ``` aws codebuild list-curated-environment-images ``` 出力: ``` { "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 ... ] } ] } ] } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」で 「[Docker Images Provided by CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListCuratedEnvironmentImages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-curated-environment-images.html)」を参照してください。 ### `list-projects` 次のコード例は、`list-projects` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild ビルドプロジェクトの名前のリストを取得するには。** 次の `list-projects` の例では、CodeBuild ビルドプロジェクトを名前で昇順にソートしたリストを取得します。 ``` aws codebuild list-projects --sort-by NAME --sort-order ASCENDING ``` 出力には、より多くの出力が利用できることを示す `nextToken` 値が含まれます。 ``` { "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" ] } ``` このコマンドを再度実行し、前のレスポンスの `nextToken` 値をパラメータとして指定して、出力の次の部分を取得します。レスポンスに `nextToken` 値が返されなくなるまで繰り返します。 ``` 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" ] } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[View a List of Build Project Names (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/view-project-list.html#view-project-list-cli)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListProjects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-projects.html)」を参照してください。 ### `list-report-groups` 次のコード例は、`list-report-groups` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild でレポートグループ ARN のリストを取得するには。** 次の `list-report-groups` の例では、リージョン内のアカウントのレポートグループ ARN を取得します。 ``` aws codebuild list-report-groups ``` 出力: ``` { "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" ] } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Working with report groups](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report-group.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListReportGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-report-groups.html)」を参照してください。 ### `list-reports-for-report-group` 次のコード例は、`list-reports-for-report-group` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild のレポートグループ内のレポートのリストを取得するには。** 次の `list-report-for-report-groups` の例では、リージョン内のアカウントの指定されたレポートグループのレポートを取得します。 ``` aws codebuild list-reports-for-report-group \ --report-group-arn arn:aws:codebuild:::report-group/ ``` 出力: ``` { "reports": [ "arn:aws:codebuild:::report/report-1", "arn:aws:codebuild:::report/report-2", "arn:aws:codebuild:::report/report-3" ] } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Working with report groups](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report-group.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListReportsForReportGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-reports-for-report-group.html)」を参照してください。 ### `list-reports` 次のコード例は、`list-reports` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild の現在のアカウントのレポートのリストを取得するには。** 次の `list-reports` の例では、現在のアカウントのレポートの ARN を取得します。 ``` aws codebuild list-reports ``` 出力: ``` { "reports": [ "arn:aws:codebuild:::report/:", "arn:aws:codebuild:::report/:", "arn:aws:codebuild:::report/:" ] } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Working with reports](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListReports](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-reports.html)」を参照してください。 ### `list-shared-projects` 次のコード例は、`list-shared-projects` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild で共有プロジェクトを一覧表示するには。** 次の `list-shared-projects` の例では、現在のアカウントで利用可能な CodeBuild 共有プロジェクトを一覧表示します。 ``` aws codebuild list-shared-projects ``` 出力: ``` { "projects": [ "arn:aws:codebuild:::project/", "arn:aws:codebuild:::project/" ] } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Working with shared projects](https://docs.aws.amazon.com/codebuild/latest/userguide/project-sharing.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListSharedProjects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-shared-projects.html)」を参照してください。 ### `list-shared-report-groups` 次のコード例は、`list-shared-report-groups` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild の共有レポートグループ ARN のリストを取得するには。** 次の `list-shared-report-groups` の例では、リージョン内のアカウントのレポートグループ ARN を取得します。 ``` aws codebuild list-shared-report-groups ``` 出力: ``` { "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" ] } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Working with report groups](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report-group.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListSharedReportGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-shared-report-groups.html)」を参照してください。 ### `list-source-credentials` 次のコード例は、`list-source-credentials` を使用する方法を示しています。 **AWS CLI** **sourceCredentialsObjects のリストを表示するには** 次の `list-source-credentials` の例では、1 つの Bitbucket アカウントと 1 つの GitHub アカウントに接続された AWS アカウントのトークンを一覧表示します。レスポンス内の各 `sourceCredentialsInfos` オブジェクトには、接続されたソース認証情報が含まれています。 ``` aws codebuild list-source-credentials ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Connect Source Providers with Access Tokens (CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-access-tokens.html#sample-access-tokens-cli)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListSourceCredentials](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/list-source-credentials.html)」を参照してください。 ### `retry-build-batch` 次のコード例は、`retry-build-batch` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild で失敗したバッチビルドを再試行するには。** 次の `retry-build-batch` の例では、指定されたバッチビルドを再起動します。 ``` aws codebuild retry-build-batch \ --id : ``` 出力: ``` { "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" } } ] } } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Batch builds in AWS CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/batch-build.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RetryBuildBatch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/retry-build-batch.html)」を参照してください。 ### `retry-build` 次のコード例は、`retry-build` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild で失敗したビルドを再試行するには。** 次の `retry-build` の例では、指定されたビルドを再起動します。 ``` aws codebuild retry-build \ --id : ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Batch builds in AWS CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/batch-build.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RetryBuild](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/retry-build.html)」を参照してください。 ### `start-build-batch` 次のコード例は、`start-build-batch` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild でバッチビルドを開始するには。** 次の `start-build-batch` の例では、指定されたプロジェクトのバッチビルドを開始します。 ``` aws codebuild start-build-batch \ --project-name ``` 出力: ``` { "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 } } } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Batch builds in AWS CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/batch-build.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartBuildBatch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/start-build-batch.html)」を参照してください。 ### `start-build` 次のコード例は、`start-build` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild ビルドプロジェクトのビルド実行を開始するには。** 次の `start-build` の例では、指定した CodeBuild プロジェクトのビルドを開始します。ビルドは、タイムアウトするまでにビルドをキューに入れることができる分数に関するプロジェクト設定と、プロジェクトのアーティファクト設定の両方を上書きします。 ``` 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"} ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Run a Build (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/run-build.html#run-build-cli)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartBuild](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/start-build.html)」を参照してください。 ### `stop-build-batch` 次のコード例は、`stop-build-batch` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild で進行中のバッチビルドを停止するには。** 次の `stop-build-batch` の例では、指定されたバッチビルドを停止します。 ``` aws codebuild stop-build-batch \ --id : ``` 出力: ``` { "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" } } ] } } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Batch builds in AWS CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/batch-build.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopBuildBatch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/stop-build-batch.html)」を参照してください。 ### `stop-build` 次のコード例は、`stop-build` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild ビルドプロジェクトのビルドを停止するには。** 次の `stop-build` の例では、指定された CodeBuild ビルドを停止します。 ``` aws codebuild stop-build --id my-demo-project:12345678-a1b2-c3d4-e5f6-11111EXAMPLE ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Stop a Build (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/stop-build.html#stop-build-cli)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopBuild](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/stop-build.html)」を参照してください。 ### `update-project` 次のコード例は、`update-project` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild でのビルドプロジェクトの設定を変更するには。** 次の `update-project`の例では、my-demo-project という名前の指定された CodeBuild ビルドプロジェクトの設定を変更します。 ``` 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" ``` 出力には、更新された設定が表示されます。 ``` { "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" } } } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Change a Build Project's Settings (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/change-project.html#change-project-cli)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/update-project.html)」を参照してください。 ### `update-report-group` 次のコード例は、`update-report-group` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild でレポートグループを更新するには。** 次の `update-report-group` の例では、レポートグループのエクスポートタイプを「NO\$1EXPORT」に変更します。 ``` aws codebuild update-report-group \ --arn arn:aws:codebuild:::report-group/cli-created-report-group \ --export-config="exportConfigType=NO_EXPORT" ``` 出力: ``` { "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": [] } } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Working with report groups](https://docs.aws.amazon.com/codebuild/latest/userguide/test-report-group.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateReportGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/update-report-group.html)」を参照してください。 ### `update-webhook` 次のコード例は、`update-webhook` を使用する方法を示しています。 **AWS CLI** **AWS CodeBuild プロジェクトのウェブフックを更新するには** 次の `update-webhook` の例では、2 つのフィルタグループを使用して、指定された CodeBuild プロジェクトのウェブフックを更新します。`--rotate-secret` パラメータは、コード変更によってビルドがトリガーされるたびに GitHub がプロジェクトのシークレットキーをローテーションするように指定します。最初のフィルタグループでは、正規表現 `^refs/heads/master$` と一致する Git 参照名および `^refs/heads/myBranch$` と一致するヘッド参照を持つブランチに対してプルリクエストを作成、更新、または再開することを指定します。2 番目のフィルタグループでは、正規表現 `^refs/heads/myBranch$` と一致しない Git 参照名を持つブランチでプッシュリクエストを指定します。 ``` 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}]]" ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS CodeBuild ユーザーガイド*」の「[Change a Build Project's Settings (AWS CLI)](https://docs.aws.amazon.com/codebuild/latest/userguide/change-project.html#change-project-cli)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateWebhook](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codebuild/update-webhook.html)」を参照してください。 # AWS CLI を使用した CodeCommit の例 次のコード例は、CodeCommit で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `associate-approval-rule-template-with-repository` 次のコード例は、`associate-approval-rule-template-with-repository` を使用する方法を示しています。 **AWS CLI** **承認ルールテンプレートをリポジトリに関連付けるには** 次の `associate-approval-rule-template-with-repository` の例では、指定された承認ルールテンプレートを `MyDemoRepo` という名前のリポジトリに関連付けます。 ``` aws codecommit associate-approval-rule-template-with-repository \ --repository-name MyDemoRepo \ --approval-rule-template-name 2-approver-rule-for-main ``` このコマンドでは何も出力されません。 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Associate an Approval Rule Template with a Repository](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-associate-template.html#associate-template-repository)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateApprovalRuleTemplateWithRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/associate-approval-rule-template-with-repository.html)」を参照してください。 ### `batch-associate-approval-rule-template-with-repositories` 次のコード例は、`batch-associate-approval-rule-template-with-repositories` を使用する方法を示しています。 **AWS CLI** **1 回のオペレーションで複数のリポジトリに承認ルールテンプレートを関連付けるには** 次の `batch-associate-approval-rule-template-with-repositories` の例では、指定された承認ルールテンプレートを `MyDemoRepo` および `MyOtherDemoRepo` という名前のリポジトリに関連付けます。 注意: 承認ルールテンプレートは、それらが作成される AWS リージョンに固有です。それらは、その AWS リージョンのリポジトリにのみ関連付けることができます。 ``` aws codecommit batch-associate-approval-rule-template-with-repositories \ --repository-names MyDemoRepo, MyOtherDemoRepo \ --approval-rule-template-name 2-approver-rule-for-main ``` 出力: ``` { "associatedRepositoryNames": [ "MyDemoRepo", "MyOtherDemoRepo" ], "errors": [] } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Associate an Approval Rule Template with a Repository](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-associate-template.html#batch-associate-template-repositories)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchAssociateApprovalRuleTemplateWithRepositories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/batch-associate-approval-rule-template-with-repositories.html)」を参照してください。 ### `batch-describe-merge-conflicts` 次のコード例は、`batch-describe-merge-conflicts` を使用する方法を示しています。 **AWS CLI** **2 つのコミット識別子間のマージにおいて、すべてのファイルまたはファイルのサブセットにあるマージ競合についての情報を取得するには** 次の `batch-describe-merge-conflicts` の例では、`feature-randomizationfeature` という名前の送信元ブランチと `main` という名前の送信先ブランチを `MyDemoRepo` という名前のリポジトリで `THREE_WAY_MERGE` 戦略を使用してマージするときのマージ競合を判断します。 ``` aws codecommit batch-describe-merge-conflicts \ --source-commit-specifier feature-randomizationfeature \ --destination-commit-specifier main \ --merge-option THREE_WAY_MERGE \ --repository-name MyDemoRepo ``` 出力: ``` { "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" } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Resolve Conflicts in a Pull Request](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-resolve-conflict-pull-request.html#batch-describe-merge-conflicts)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchDescribeMergeConflicts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/batch-describe-merge-conflicts.html)」を参照してください。 ### `batch-disassociate-approval-rule-template-from-repositories` 次のコード例は、`batch-disassociate-approval-rule-template-from-repositories` を使用する方法を示しています。 **AWS CLI** **1 回のオペレーションで複数のリポジトリから承認ルールテンプレートの関連付けを解除するには** 次の `batch-disassociate-approval-rule-template-from-repositories` の例では、指定された承認ルールテンプレートと `MyDemoRepo` および `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 ``` 出力: ``` { "disassociatedRepositoryNames": [ "MyDemoRepo", "MyOtherDemoRepo" ], "errors": [] } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Disassociate an Approval Rule Template](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-disassociate-template.html#batch-disassociate-template)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchDisassociateApprovalRuleTemplateFromRepositories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/batch-disassociate-approval-rule-template-from-repositories.html)」を参照してください。 ### `batch-get-commits` 次のコード例は、`batch-get-commits` を使用する方法を示しています。 **AWS CLI** **複数のコミットに関する情報を表示するには** 次の `batch-get-commits` の例では、指定されたコミットの詳細情報を表示します。 ``` aws codecommit batch-get-commits \ --repository-name MyDemoRepo \ --commit-ids 317f8570EXAMPLE 4c925148EXAMPLE ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[View Commit Details](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-view-commit-details.html#how-to-view-commit-details-cli-batch-get-commits)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchGetCommits](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/batch-get-commits.html)」を参照してください。 ### `batch-get-repositories` 次のコード例は、`batch-get-repositories` を使用する方法を示しています。 **AWS CLI** **複数のリポジトリの詳細情報を表示するには** この例では、複数の AWS CodeCommit リポジトリの詳細情報を示しています。 ``` aws codecommit batch-get-repositories \ --repository-names MyDemoRepo MyOtherDemoRepo ``` 出力: ``` { "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": [] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchGetRepositories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/batch-get-repositories.html)」を参照してください。 ### `create-approval-rule-template` 次のコード例は、`create-approval-rule-template` を使用する方法を示しています。 **AWS CLI** **承認ルールテンプレートを作成するには** 次の `create-approval-rule-template` の例では、`2-approver-rule-for-main ``. The template requires two users who assume the role of ``CodeCommitReview` という名前の承認ルールテンプレートを作成し、`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/*\"]}]}" ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Create an Approval Rule Template](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-create-template.html#create-template-cli)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateApprovalRuleTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/create-approval-rule-template.html)」を参照してください。 ### `create-branch` 次のコード例は、`create-branch` を使用する方法を示しています。 **AWS CLI** **ブランチを作成するには** この例では、AWS CodeCommit リポジトリにブランチを作成しています。このコマンドは、エラーがある場合にのみ出力を生成します。 コマンド: ``` aws codecommit create-branch --repository-name MyDemoRepo --branch-name MyNewBranch --commit-id 317f8570EXAMPLE ``` 出力: ``` None. ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateBranch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/create-branch.html)」を参照してください。 ### `create-commit` 次のコード例は、`create-commit` を使用する方法を示しています。 **AWS CLI** **コミットを作成するには** 次の `create-commit` の例では、`main` ブランチの `MyDemoRepo` という名前のリポジトリに `readme.md` ファイルを追加する、リポジトリの初期コミットを作成する方法を示します。 ``` aws codecommit create-commit \ --repository-name MyDemoRepo \ --branch-name main \ --put-files "filePath=readme.md,fileContent='Welcome to our team repository.'" ``` 出力: ``` { "filesAdded": [ { "blobId": "5e1c309d-EXAMPLE", "absolutePath": "readme.md", "fileMode": "NORMAL" } ], "commitId": "4df8b524-EXAMPLE", "treeId": "55b57003-EXAMPLE", "filesDeleted": [], "filesUpdated": [] } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Create a Commit in AWS CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-create-commit.html#how-to-create-commit-cli)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCommit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/create-commit.html)」を参照してください。 ### `create-pull-request-approval-rule` 次のコード例は、`create-pull-request-approval-rule` を使用する方法を示しています。 **AWS CLI** **プルリクエストの承認ルールを作成するには** 次の `create-pull-request-approval-rule` の例では、指定されたプルリクエストに `Require two approved approvers` という名前の承認ルールを作成します。このルールは、承認プールから 2 つの承認が必要であることを指定しています。プールには、`123456789012` AWS アカウントで `CodeCommitReview` のロールを引き受けて CodeCommit にアクセスするすべてのユーザーが含まれます。また、同じ AWS アカウントの `Nikhil_Jayashankar` という名前の IAM ユーザーまたはフェデレーションユーザーも含まれます。 ``` 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/*\"]}]}" ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Create an Approval Rule](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-create-pull-request-approval-rule.html#how-to-create-pull-request-approval-rule-cli)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreatePullRequestApprovalRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/create-pull-request-approval-rule.html)」を参照してください。 ### `create-pull-request` 次のコード例は、`create-pull-request` を使用する方法を示しています。 **AWS CLI** **プルリクエストを作成するには** 次の `create-pull-request` の例では、「火曜日までにこれらの変更を確認してください」という説明の付いた「Pronunciation difficulty analyzer」という名前のプルリクエストを作成します。このリクエストは「jane-branch」送信元ブランチを対象とし、「MyDemoRepo」という名前の AWS CodeCommit リポジトリのデフォルトブランチ「main」にマージされます。 ``` 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 ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreatePullRequest](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/create-pull-request.html)」を参照してください。 ### `create-repository` 次のコード例は、`create-repository` を使用する方法を示しています。 **AWS CLI** **リポジトリを作成するには** () この例ではリポジトリを作成し、ユーザーの AWS アカウントと関連付けています。 コマンド: ``` aws codecommit create-repository --repository-name MyDemoRepo --repository-description "My demonstration repository" ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/create-repository.html)」を参照してください。 ### `create-unreferenced-merge-commit` 次のコード例は、`create-unreferenced-merge-commit` を使用する方法を示しています。 **AWS CLI** **2 つのコミット指定子をマージした結果を表す非参照コミットを作成するには** 次の `create-unreferenced-merge-commit` の例では、`MyDemoRepo` という名前のリポジトリで THREE\$1WAY\$1MERGE 戦略を使用して、`bugfix-1234` という名前の送信元ブランチと `main` という名前の送信先ブランチ間のマージ結果を表すコミットを作成します。 ``` 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." ``` 出力: ``` { "commitId": "4f178133EXAMPLE", "treeId": "389765daEXAMPLE" } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Resolve Conflicts in a Pull Request](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-resolve-conflict-pull-request.html#batch-describe-merge-conflicts)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateUnreferencedMergeCommit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/create-unreferenced-merge-commit.html)」を参照してください。 ### `credential-helper` 次のコード例は、`credential-helper` を使用する方法を示しています。 **AWS CLI** **AWS CodeCommit を使用して AWS CLI に含まれる認証情報ヘルパーを設定するには** `credential-helper` ユーティリティは、AWS CLI から直接呼び出されるように設計されていません。代わりに、ローカルコンピュータをセットアップするための `git config` コマンドでパラメータとして使用することを目的としています。Git が CodeCommit リポジトリとの通信で AWS に対する認証を必要とする場合は、HTTPS と暗号化された署名済みバージョンの IAM ユーザー認証情報または Amazon EC2 インスタンスロールを Git で使用できます。 ``` git config --global credential.helper '!aws codecommit credential-helper $@' git config --global credential.UseHttpPath true ``` 出力: ``` [credential] helper = !aws codecommit credential-helper $@ UseHttpPath = true ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「Setting up for AWS CodeCommit Using Other Methods」を参照してください。内容を注意深く読み、「*AWS CodeCommit ユーザーガイド*」の「For HTTPS Connections on Linux, macOS, or Unix」または「For HTTPS Connections on Windows」のいずれかのトピックに記載されている手順に従います。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CredentialHelper](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/credential-helper.html)」を参照してください。 ### `delete-approval-rule-template` 次のコード例は、`delete-approval-rule-template` を使用する方法を示しています。 **AWS CLI** **承認ルールテンプレートを削除するには** 次の `delete-approval-rule-template` の例では、指定された承認ルールテンプレートを削除します。 ``` aws codecommit delete-approval-rule-template \ --approval-rule-template-name 1-approver-for-all-pull-requests ``` 出力: ``` { "approvalRuleTemplateId": "41de97b7-EXAMPLE" } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Delete an Approval Rule Template](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-delete-template.html#delete-template)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteApprovalRuleTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/delete-approval-rule-template.html)」を参照してください。 ### `delete-branch` 次のコード例は、`delete-branch` を使用する方法を示しています。 **AWS CLI** **ブランチを削除するには** この例では、AWS CodeCommit リポジトリでブランチを削除する方法を示しています。 コマンド: ``` aws codecommit delete-branch --repository-name MyDemoRepo --branch-name MyNewBranch ``` 出力: ``` { "branch": { "commitId": "317f8570EXAMPLE", "branchName": "MyNewBranch" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteBranch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/delete-branch.html)」を参照してください。 ### `delete-comment-content` 次のコード例は、`delete-comment-content` を使用する方法を示しています。 **AWS CLI** **コメントの内容を削除するには** コメントを自分で作成した場合のみコメントのコンテンツを削除できます。この例では、システム生成 ID が `ff30b348EXAMPLEb9aa670f` のコメントの内容を削除する方法を示しています。 ``` aws codecommit delete-comment-content \ --comment-id ff30b348EXAMPLEb9aa670f ``` 出力: ``` { "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 } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCommentContent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/delete-comment-content.html)」を参照してください。 ### `delete-file` 次のコード例は、`delete-file` を使用する方法を示しています。 **AWS CLI** **ファイルを削除するには** 次の `delete-file` の例は、`MyDemoRepo` という名前のリポジトリで、最新のコミット ID が `c5709475EXAMPLE` のブランチ `main` から `README.md` という名前のファイルを削除する方法を示します。 ``` aws codecommit delete-file \ --repository-name MyDemoRepo \ --branch-name main \ --file-path README.md \ --parent-commit-id c5709475EXAMPLE ``` 出力: ``` { "blobId":"559b44fEXAMPLE", "commitId":"353cf655EXAMPLE", "filePath":"README.md", "treeId":"6bc824cEXAMPLE" } ``` 詳細については、「*AWS CodeCommit API リファレンス*」ガイドの「[Edit or Delete a File in AWS CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-edit-file.html?shortFooter=true#how-to-edit-file-cli)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteFile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/delete-file.html)」を参照してください。 ### `delete-pull-request-approval-rule` 次のコード例は、`delete-pull-request-approval-rule` を使用する方法を示しています。 **AWS CLI** **プルリクエストの承認ルールを削除するには** 次の `delete-pull-request-approval-rule` の例では、指定されたプルリクエストの `My Approval Rule` という名前の承認ルールを削除しています。 ``` aws codecommit delete-pull-request-approval-rule \ --approval-rule-name "My Approval Rule" \ --pull-request-id 15 ``` 出力: ``` { "approvalRuleId": "077d8e8a8-EXAMPLE" } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Edit or Delete an Approval Rule](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-edit-delete-pull-request-approval-rule.html#delete-pull-request-approval-rule)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeletePullRequestApprovalRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/delete-pull-request-approval-rule.html)」を参照してください。 ### `delete-repository` 次のコード例は、`delete-repository` を使用する方法を示しています。 **AWS CLI** **リポジトリを削除するには** () この例では、AWS CodeCommit リポジトリを削除する方法を示しています。 コマンド: ``` aws codecommit delete-repository --repository-name MyDemoRepo ``` 出力: ``` { "repositoryId": "f7579e13-b83e-4027-aaef-650c0EXAMPLE" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/delete-repository.html)」を参照してください。 ### `describe-merge-conflicts` 次のコード例は、`describe-merge-conflicts` を使用する方法を示しています。 **AWS CLI** **マージの競合に関する詳細情報を取得するには** 次の `describe-merge-conflicts` の例では、THREE\$1WAY\$1MERGE 戦略を使用して、指定された送信元ブランチと送信先ブランチで `readme.md` という名前のファイルのマージの競合を判別します。 ``` 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 ``` 出力: ``` { "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" } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Resolve Conflicts in a Pull Request](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-resolve-conflict-pull-request.html#describe-merge-conflicts)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeMergeConflicts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/describe-merge-conflicts.html)」を参照してください。 ### `describe-pull-request-events` 次のコード例は、`describe-pull-request-events` を使用する方法を示しています。 **AWS CLI** **プルリクエストのイベントを表示するには** 次の `describe-pull-request-events` の例では、ID が「8」のプルリクエストのイベントを取得しています。 ``` aws codecommit describe-pull-request-events --pull-request-id 8 ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribePullRequestEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/describe-pull-request-events.html)」を参照してください。 ### `disassociate-approval-rule-template-from-repository` 次のコード例は、`disassociate-approval-rule-template-from-repository` を使用する方法を示しています。 **AWS CLI** **承認ルールテンプレートをリポジトリから関連付け解除するには** 次の `disassociate-approval-rule-template-from-repository` の例では、指定された承認ルールテンプレートを `MyDemoRepo` という名前のリポジトリから関連付け解除しています。 ``` aws codecommit disassociate-approval-rule-template-from-repository \ --repository-name MyDemoRepo \ --approval-rule-template-name 1-approver-rule-for-all-pull-requests ``` このコマンドでは何も出力されません。 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Disassociate an Approval Rule Template](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-disassociate-template.html#disassociate-template)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateApprovalRuleTemplateFromRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/disassociate-approval-rule-template-from-repository.html)」を参照してください。 ### `evaluate-pull-request-approval-rules` 次のコード例は、`evaluate-pull-request-approval-rules` を使用する方法を示しています。 **AWS CLI** **プルリクエストの承認ルールがすべて満たされているかどうかを評価するには** 次の `evaluate-pull-request-approval-rules` の例では、指定されたプルリクエストの承認ルールの状態を評価しています。この例では、プルリクエストの承認ルールが満たされていないため、コマンドの出力には `approved` の値として `false` が表示されます。 ``` aws codecommit evaluate-pull-request-approval-rules \ --pull-request-id 27 \ --revision-id 9f29d167EXAMPLE ``` 出力: ``` { "evaluation": { "approved": false, "approvalRulesNotSatisfied": [ "Require two approved approvers" ], "overridden": false, "approvalRulesSatisfied": [] } } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Merge a Pull Request](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-merge-pull-request.html#evaluate-pull-request-approval-rules)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EvaluatePullRequestApprovalRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/evaluate-pull-request-approval-rules.html)」を参照してください。 ### `get-approval-rule-template` 次のコード例は、`get-approval-rule-template` を使用する方法を示しています。 **AWS CLI** **承認ルールテンプレートの内容を取得するには** 次の `get-approval-rule-template` の例では、`1-approver-rule-for-all-pull-requests` という名前の承認ルールテンプレートの内容を取得しています。 ``` aws codecommit get-approval-rule-template \ --approval-rule-template-name 1-approver-rule-for-all-pull-requests ``` 出力: ``` { "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." } } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Manage Approval Rule Templates](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-manage-templates.html#get-template)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetApprovalRuleTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-approval-rule-template.html)」を参照してください。 ### `get-blob` 次のコード例は、`get-blob` を使用する方法を示しています。 **AWS CLI** **Git blob オブジェクトに関する情報を表示するには** 次の `get-blob` の例では、「MyDemoRepo」という名前の AWS CodeCommit リポジトリで、ID が「2eb4af3bEXAMPLE」の Git blob に関する情報を取得しています。 ``` aws codecommit get-blob --repository-name MyDemoRepo --blob-id 2eb4af3bEXAMPLE ``` 出力: ``` { "content": "QSBCaW5hcnkgTGFyToEXAMPLE=" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetBlob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-blob.html)」を参照してください。 ### `get-branch` 次のコード例は、`get-branch` を使用する方法を示しています。 **AWS CLI** **ブランチに関する情報を取得するには** この例では、AWS CodeCommit リポジトリ内のブランチに関する情報を取得しています。 コマンド: ``` aws codecommit get-branch --repository-name MyDemoRepo --branch-name MyNewBranch ``` 出力: ``` { "BranchInfo": { "commitID": "317f8570EXAMPLE", "branchName": "MyNewBranch" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetBranch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-branch.html)」を参照してください。 ### `get-comment-reactions` 次のコード例は、`get-comment-reactions` を使用する方法を示しています。 **AWS CLI** **コメントへの絵文字リアクションを表示するには** 次の `get-comment-reactions` の例では、ID が `abcd1234EXAMPLEb5678efgh` のコメントに対するすべての絵文字リアクションを一覧表示しています。シェルのフォントが絵文字バージョン 1.0 の表示をサポートしている場合、`emoji` の出力に絵文字が表示されます。 ``` aws codecommit get-comment-reactions \ --comment-id abcd1234EXAMPLEb5678efgh ``` 出力: ``` { "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" ] } ] } } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Comment on a commit in AWS CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-commit-comment.html#how-to-commit-comment-cli-commit-emoji-view)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetCommentReactions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-comment-reactions.html)」を参照してください。 ### `get-comment` 次のコード例は、`get-comment` を使用する方法を示しています。 **AWS CLI** **コメントの詳細を表示するには** この例では、システム生成コメント ID が `ff30b348EXAMPLEb9aa670f` のコメントの詳細を表示する方法を示しています。 ``` aws codecommit get-comment \ --comment-id ff30b348EXAMPLEb9aa670f ``` 出力: ``` { "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 } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetComment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-comment.html)」を参照してください。 ### `get-comments-for-compared-commit` 次のコード例は、`get-comments-for-compared-commit` を使用する方法を示しています。 **AWS CLI** **コミットについてのコメントを表示するには** この例では、`MyDemoRepo` という名前のリポジトリで 2 つのコミット間の比較に対して作成されたコメントを表示する方法を示しています。 ``` aws codecommit get-comments-for-compared-commit \ --repository-name MyDemoRepo \ --before-commit-ID 6e147360EXAMPLE \ --after-commit-id 317f8570EXAMPLE ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetCommentsForComparedCommit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-comments-for-compared-commit.html)」を参照してください。 ### `get-comments-for-pull-request` 次のコード例は、`get-comments-for-pull-request` を使用する方法を示しています。 **AWS CLI** **プルリクエストのコメントを表示するには** この例では、`MyDemoRepo` という名前のリポジトリにあるプルリクエストのコメントを表示する方法を示しています。 ``` aws codecommit get-comments-for-pull-request \ --repository-name MyDemoRepo \ --before-commit-ID 317f8570EXAMPLE \ --after-commit-id 5d036259EXAMPLE ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetCommentsForPullRequest](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-comments-for-pull-request.html)」を参照してください。 ### `get-commit` 次のコード例は、`get-commit` を使用する方法を示しています。 **AWS CLI** **リポジトリのコミットに関する情報を表示するには** この例では、「MyDemoRepo」という名前の AWS CodeCommit リポジトリで、システム生成 ID が「7e9fd3091thisisanexamplethisisanexample1」のコミットに関する詳細を示しています。 コマンド: ``` aws codecommit get-commit --repository-name MyDemoRepo --commit-id 7e9fd3091thisisanexamplethisisanexample1 ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetCommit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-commit.html)」を参照してください。 ### `get-differences` 次のコード例は、`get-differences` を使用する方法を示しています。 **AWS CLI** **リポジトリ内のコミット指定子の違いに関する情報を取得するには** この例では、MyDemoRepo という名前の AWS CodeCommit リポジトリにある名前が変更されたフォルダ内の 2 つのコミット指定子 (ブランチ、タグ、HEAD、またはコミット ID などの他の完全修飾参照) の間の変更に関するメタデータ情報を示しています。この例では、これらのオプションを使用して結果を制限する方法をより詳細に説明するために、--before-commit-specifier、--before-path、--after-path などの必須ではないオプションがいくつか含まれています。レスポンスには、ファイルモードのアクセス許可が含まれます。 コマンド: ``` 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 ``` 出力: ``` { "differences": [ { "afterBlob": { "path": "blob.txt", "blobId": "2eb4af3b1thisisanexamplethisisanexample1", "mode": "100644" }, "changeType": "M", "beforeBlob": { "path": "blob.txt", "blobId": "bf7fcf281thisisanexamplethisisanexample1", "mode": "100644" } } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDifferences](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-differences.html)」を参照してください。 ### `get-file` 次のコード例は、`get-file` を使用する方法を示しています。 **AWS CLI** **AWS CodeCommit リポジトリ内のファイルの base-64 でエンコードされた内容を取得するには** 次の `get-file` の例では、`MyDemoRepo` という名前のリポジトリ内の `main` という名前のブランチから、`README.md` という名前のファイルの base-64 でエンコードされた内容を取得する方法を示しています。 ``` aws codecommit get-file \ --repository-name MyDemoRepo \ --commit-specifier main \ --file-path README.md ``` 出力: ``` { "blobId":"559b44fEXAMPLE", "commitId":"c5709475EXAMPLE", "fileContent":"IyBQaHVzEXAMPLE", "filePath":"README.md", "fileMode":"NORMAL", "fileSize":1563 } ``` 詳細については、「*AWS CodeCommit API リファレンス*」ガイドの「[GetFile](https://docs.aws.amazon.com/codecommit/latest/APIReference/API_GetFile.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetFile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-file.html)」を参照してください。 ### `get-folder` 次のコード例は、`get-folder` を使用する方法を示しています。 **AWS CLI** **AWS CodeCommit リポジトリ内のフォルダの内容を取得するには** 次の `get-folder` の例では、`MyDemoRepo` という名前のリポジトリから最上位フォルダの内容を取得する方法を示しています。 ``` aws codecommit get-folder --repository-name MyDemoRepo --folder-path "" ``` 出力: ``` { "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" } ``` 詳細については、「*AWS CodeCommit API リファレンス*」ガイドの「GetFolder」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetFolder](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-folder.html)」を参照してください。 ### `get-merge-commit` 次のコード例は、`get-merge-commit` を使用する方法を示しています。 **AWS CLI** **マージコミットに関する詳細情報を取得するには** 次の `get-merge-commit` の例では、`MyDemoRepo` という名前のリポジトリで `main` という名前の送信先ブランチと `bugfix-bug1234` という名前の送信元ブランチのマージコミットに関する詳細を表示しています。 ``` aws codecommit get-merge-commit \ --source-commit-specifier bugfix-bug1234 \ --destination-commit-specifier main \ --repository-name MyDemoRepo ``` 出力: ``` { "sourceCommitId": "c5709475EXAMPLE", "destinationCommitId": "317f8570EXAMPLE", "baseCommitId": "fb12a539EXAMPLE", "mergeCommitId": "ffc4d608eEXAMPLE" } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[View Commit Details](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-view-commit-details.html#how-to-view-commit-details-cli-merge-commit)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetMergeCommit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-merge-commit.html)」を参照してください。 ### `get-merge-conflicts` 次のコード例は、`get-merge-conflicts` を使用する方法を示しています。 **AWS CLI** **プルリクエストにマージの競合があるかどうかを確認するには** 次の `get-merge-conflicts` の例では、`feature-randomizationfeature` という名前の送信元ブランチの先端と、`MyDemoRepo` という名前のリポジトリ内の「main」という名前の送信先ブランチの間にマージの競合があるかどうかを示しています。 ``` aws codecommit get-merge-conflicts \ --repository-name MyDemoRepo \ --source-commit-specifier feature-randomizationfeature \ --destination-commit-specifier main \ --merge-option THREE_WAY_MERGE ``` 出力: ``` { "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" } } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetMergeConflicts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-merge-conflicts.html)」を参照してください。 ### `get-merge-options` 次のコード例は、`get-merge-options` を使用する方法を示しています。 **AWS CLI** **指定した 2 つのブランチのマージに使用できるマージオプションに関する情報を取得するには** 次の `get-merge-options` の例では、`MyDemoRepo` という名前のリポジトリ内の `main` という名前の送信先ブランチに `bugfix-bug1234` という名前の送信元ブランチをマージするために使用できるマージオプションを決定しています。 ``` aws codecommit get-merge-options \ --source-commit-specifier bugfix-bug1234 \ --destination-commit-specifier main \ --repository-name MyDemoRepo ``` 出力: ``` { "mergeOptions": [ "FAST_FORWARD_MERGE", "SQUASH_MERGE", "THREE_WAY_MERGE" ], "sourceCommitId": "18059494EXAMPLE", "destinationCommitId": "ffd3311dEXAMPLE", "baseCommitId": "ffd3311dEXAMPLE" } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Resolve Conflicts in a Pull Request](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-resolve-conflict-pull-request.html#get-merge-options)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetMergeOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-merge-options.html)」を参照してください。 ### `get-pull-request-approval-states` 次のコード例は、`get-pull-request-approval-states` を使用する方法を示しています。 **AWS CLI** **プルリクエストの承認を表示するには** 次の `get-pull-request-approval-states` の例では、指定されたプルリクエストの承認を返しています。 ``` aws codecommit get-pull-request-approval-states \ --pull-request-id 8 \ --revision-id 9f29d167EXAMPLE ``` 出力: ``` { "approvals": [ { "userArn": "arn:aws:iam::123456789012:user/Mary_Major", "approvalState": "APPROVE" } ] } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[View Pull Requests](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-view-pull-request.html#get-pull-request-approval-state)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPullRequestApprovalStates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-pull-request-approval-states.html)」を参照してください。 ### `get-pull-request-override-state` 次のコード例は、`get-pull-request-override-state` を使用する方法を示しています。 **AWS CLI** **プルリクエストの上書きステータスに関する情報を取得するには** 次の `get-pull-request-override-state` の例では、指定されたプルリクエストの上書きステータスを返しています。この例では、プルリクエストの承認ルールが Mary Major という名前のユーザーによって上書きされたため、出力は `true` の値を返します。 ``` aws codecommit get-pull-request-override-state \ --pull-request-id 34 \ --revision-id 9f29d167EXAMPLE ``` 出力: ``` { "overridden": true, "overrider": "arn:aws:iam::123456789012:user/Mary_Major" } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Override Approval Rules on a Pull Request](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-override-approval-rules.html#get-override-status)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPullRequestOverrideState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-pull-request-override-state.html)」を参照してください。 ### `get-pull-request` 次のコード例は、`get-pull-request` を使用する方法を示しています。 **AWS CLI** **プルリクエストの詳細を表示するには** この例では、ID が `27` のプルリクエストに関する情報を表示する方法を示しています。 ``` aws codecommit get-pull-request \ --pull-request-id 27 ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPullRequest](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-pull-request.html)」を参照してください。 ### `get-repository-triggers` 次のコード例は、`get-repository-triggers` を使用する方法を示しています。 **AWS CLI** **リポジトリ内のトリガーに関する情報を取得するには** この例では、`MyDemoRepo` という名前の AWS CodeCommit リポジトリ用に設定されたトリガーの詳細を示しています。 ``` aws codecommit get-repository-triggers \ --repository-name MyDemoRepo ``` 出力: ``` { "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" ] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRepositoryTriggers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-repository-triggers.html)」を参照してください。 ### `get-repository` 次のコード例は、`get-repository` を使用する方法を示しています。 **AWS CLI** **リポジトリに関する情報を取得するには** この例では、AWS CodeCommit リポジトリに関する詳細を示しています。 ``` aws codecommit get-repository \ --repository-name MyDemoRepo ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/get-repository.html)」を参照してください。 ### `list-approval-rule-templates` 次のコード例は、`list-approval-rule-templates` を使用する方法を示しています。 **AWS CLI** **AWS リージョンのすべての承認ルールテンプレートを一覧表示するには** 次の `list-approval-rule-templates` の例では、指定されたリージョン内のすべての承認ルールテンプレートを一覧表示しています。AWS リージョンがパラメータとして指定されていない場合、コマンドはコマンドの実行に使用される AWS CLI プロファイルで指定されたリージョンの承認ルールテンプレートを返します。 ``` aws codecommit list-approval-rule-templates \ --region us-east-2 ``` 出力: ``` { "approvalRuleTemplateNames": [ "2-approver-rule-for-main", "1-approver-rule-for-all-pull-requests" ] } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Manage Approval Rule Templates](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-manage-templates.html#list-templates)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListApprovalRuleTemplates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/list-approval-rule-templates.html)」を参照してください。 ### `list-associated-approval-rule-templates-for-repository` 次のコード例は、`list-associated-approval-rule-templates-for-repository` を使用する方法を示しています。 **AWS CLI** **リポジトリに関連付けられているすべてのテンプレートを一覧表示するには** 次の `list-associated-approval-rule-templates-for-repository` の例では、`MyDemoRepo` という名前のリポジトリに関連付けられているすべての承認ルールテンプレートを一覧表示しています。 ``` aws codecommit list-associated-approval-rule-templates-for-repository \ --repository-name MyDemoRepo ``` 出力: ``` { "approvalRuleTemplateNames": [ "2-approver-rule-for-main", "1-approver-rule-for-all-pull-requests" ] } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Manage Approval Rule Templates](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-manage-templates.html#list-associated-templates)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAssociatedApprovalRuleTemplatesForRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/list-associated-approval-rule-templates-for-repository.html)」を参照してください。 ### `list-branches` 次のコード例は、`list-branches` を使用する方法を示しています。 **AWS CLI** **ブランチ名のリストを表示するには** この例では、AWS CodeCommit リポジトリ内のすべてのブランチ名を一覧表示しています。 ``` aws codecommit list-branches \ --repository-name MyDemoRepo ``` 出力: ``` { "branches": [ "MyNewBranch", "main" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListBranches](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/list-branches.html)」を参照してください。 ### `list-pull-requests` 次のコード例は、`list-pull-requests` を使用する方法を示しています。 **AWS CLI** **リポジトリでプルリクエストのリストを表示するには** この例では、「MyDemoRepo」という名前の AWS CodeCommit リポジトリで、ARN が「arn:aws:iam::111111111111:user/Li\$1Juan」でステータスが「CLOSED」の IAM ユーザーが作成したプルリクエストを一覧表示する方法を示しています。 ``` aws codecommit list-pull-requests --author-arn arn:aws:iam::111111111111:user/Li_Juan --pull-request-status CLOSED --repository-name MyDemoRepo ``` 出力: ``` { "nextToken": "", "pullRequestIds": ["2","12","16","22","23","35","30","39","47"] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPullRequests](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/list-pull-requests.html)」を参照してください。 ### `list-repositories-for-approval-rule-template` 次のコード例は、`list-repositories-for-approval-rule-template` を使用する方法を示しています。 **AWS CLI** **テンプレートに関連付けられているすべてのリポジトリを一覧表示するには** 次の `list-repositories-for-approval-rule-template` の例では、指定された承認ルールテンプレートに関連付けられているすべてのリポジトリを一覧表示しています。 ``` aws codecommit list-repositories-for-approval-rule-template \ --approval-rule-template-name 2-approver-rule-for-main ``` 出力: ``` { "repositoryNames": [ "MyDemoRepo", "MyClonedRepo" ] } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Manage Approval Rule Templates](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-manage-templates.html#list-associated-repositories)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRepositoriesForApprovalRuleTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/list-repositories-for-approval-rule-template.html)」を参照してください。 ### `list-repositories` 次のコード例は、`list-repositories` を使用する方法を示しています。 **AWS CLI** **リポジトリのリストを表示するには** この例では、ユーザーの AWS アカウントに関連付けられているすべての AWS CodeCommit リポジトリを一覧表示しています。 コマンド: ``` aws codecommit list-repositories ``` 出力: ``` { "repositories": [ { "repositoryName": "MyDemoRepo" "repositoryId": "f7579e13-b83e-4027-aaef-650c0EXAMPLE", }, { "repositoryName": "MyOtherDemoRepo" "repositoryId": "cfc29ac4-b0cb-44dc-9990-f6f51EXAMPLE" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRepositories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/list-repositories.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **リポジトリの AWS タグを表示するには** 次の `list-tags-for-resource` の例では、指定されたリポジトリのタグキーとタグ値を一覧表示しています。 ``` aws codecommit list-tags-for-resource \ --resource-arn arn:aws:codecommit:us-west-2:111111111111:MyDemoRepo ``` 出力: ``` { "tags": { "Status": "Secret", "Team": "Saanvi" } } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[View Tags for a Repository](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-tag-repository-list.html#how-to-tag-repository-list-cli)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/list-tags-for-resource.html)」を参照してください。 ### `merge-branches-by-fast-forward` 次のコード例は、`merge-branches-by-fast-forward` を使用する方法を示しています。 **AWS CLI** **早送りマージ戦略を使用して 2 つのブランチをマージするには** 次の `merge-branches-by-fast-forward` の例では、指定された送信元ブランチを、`MyDemoRepo` という名前のリポジトリ内の指定された送信先ブランチとマージしています。 ``` aws codecommit merge-branches-by-fast-forward \ --source-commit-specifier bugfix-bug1234 \ --destination-commit-specifier bugfix-bug1233 \ --repository-name MyDemoRepo ``` 出力: ``` { "commitId": "4f178133EXAMPLE", "treeId": "389765daEXAMPLE" } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Compare and Merge Branches](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-compare-branches.html#merge-branches-by-fast-forward)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[MergeBranchesByFastForward](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/merge-branches-by-fast-forward.html)」を参照してください。 ### `merge-branches-by-squash` 次のコード例は、`merge-branches-by-squash` を使用する方法を示しています。 **AWS CLI** **スカッシュマージ戦略を使用して 2 つのブランチをマージするには** 次の `merge-branches-by-squash` の例では、指定された送信元ブランチを、`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 ``` 出力: ``` { "commitId": "4f178133EXAMPLE", "treeId": "389765daEXAMPLE" } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Compare and Merge Branches](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-compare-branches.html#merge-branches-by-squash)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[MergeBranchesBySquash](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/merge-branches-by-squash.html)」を参照してください。 ### `merge-branches-by-three-way` 次のコード例は、`merge-branches-by-three-way` を使用する方法を示しています。 **AWS CLI** **3 方向マージ戦略を使用して 2 つのブランチをマージするには** 次の `merge-branches-by-three-way` の例では、指定された送信元ブランチを、`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 ``` 出力: ``` { "commitId": "4f178133EXAMPLE", "treeId": "389765daEXAMPLE" } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Compare and Merge Branches](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-compare-branches.html#merge-branches-by-three-way)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[MergeBranchesByThreeWay](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/merge-branches-by-three-way.html)」を参照してください。 ### `merge-pull-request-by-fast-forward` 次のコード例は、`merge-pull-request-by-fast-forward` を使用する方法を示しています。 **AWS CLI** **プルリクエストをマージして閉じるには** この例では、`MyDemoRepo` という名前のリポジトリで、ID が「47」、ソースコミット ID が「99132ab0EXAMPLE」のプルリクエストをマージしてクローズする方法を示しています。 ``` aws codecommit merge-pull-request-by-fast-forward \ --pull-request-id 47 \ --source-commit-id 99132ab0EXAMPLE \ --repository-name MyDemoRepo ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Merge a Pull Request](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-merge-pull-request.html#merge-pull-request-by-fast-forward)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[MergePullRequestByFastForward](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/merge-pull-request-by-fast-forward.html)」を参照してください。 ### `merge-pull-request-by-squash` 次のコード例は、`merge-pull-request-by-squash` を使用する方法を示しています。 **AWS CLI** **スカッシュマージ戦略を使用してプルリクエストをマージするには** 次の `merge-pull-request-by-squash` の例では、`MyDemoRepo` という名前のリポジトリで ACCEPT\$1SOURCE の競合解決戦略を使用して、指定されたプルリクエストをマージして閉じています。 ``` 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" ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Merge a Pull Request](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-merge-pull-request.html#merge-pull-request-by-squash)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[MergePullRequestBySquash](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/merge-pull-request-by-squash.html)」を参照してください。 ### `merge-pull-request-by-three-way` 次のコード例は、`merge-pull-request-by-three-way` を使用する方法を示しています。 **AWS CLI** **3 方向マージ戦略を使用してプルリクエストをマージするには** 次の `merge-pull-request-by-three-way` の例では、`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" ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Merge a Pull Request](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-merge-pull-request.html#merge-pull-request-by-three-way)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[MergePullRequestByThreeWay](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/merge-pull-request-by-three-way.html)」を参照してください。 ### `override-pull-request-approval-rules` 次のコード例は、`override-pull-request-approval-rules` を使用する方法を示しています。 **AWS CLI** **プルリクエストの承認ルール要件を上書きするには** 次の `override-pull-request-approval-rules` の例では、指定されたプルリクエストの承認ルールを上書きしています。代わりに上書きを取り消すには、`--override-status` パラメータ値を `REVOKE` に設定します。 ``` aws codecommit override-pull-request-approval-rules \ --pull-request-id 34 \ --revision-id 927df8d8EXAMPLE \ --override-status OVERRIDE ``` このコマンドでは何も出力されません。 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Override Approval Rules on a Pull Request](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-override-approval-rules.html#override-approval-rules)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[OverridePullRequestApprovalRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/override-pull-request-approval-rules.html)」を参照してください。 ### `post-comment-for-compared-commit` 次のコード例は、`post-comment-for-compared-commit` を使用する方法を示しています。 **AWS CLI** **コミットに対するコメントを作成するには** この例では、`MyDemoRepo` という名前のリポジトリ内の 2 つのコミットを比較して、変更に対するコメント `"Can you add a test case for this?"` を `cl_sample.js` ファイルに追加する方法を示しています。 ``` 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 ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PostCommentForComparedCommit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/post-comment-for-compared-commit.html)」を参照してください。 ### `post-comment-for-pull-request` 次のコード例は、`post-comment-for-pull-request` を使用する方法を示しています。 **AWS CLI** **プルリクエストにコメントを追加するには** 次の `post-comment-for-pull-request` の例では、「これらは、どこでも使用されていないようです。削除できますか。」 というコメントを、`MyDemoRepo` という名前のリポジトリの ID が `47` のプルリクエストの `ahs_count.py` ファイルへの変更に追加しています。 ``` 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 ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PostCommentForPullRequest](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/post-comment-for-pull-request.html)」を参照してください。 ### `post-comment-reply` 次のコード例は、`post-comment-reply` を使用する方法を示しています。 **AWS CLI** **コミットまたはプルリクエストのコメントに返信するには** この例では、システム生成 ID が `abcd1234EXAMPLEb5678efgh` のコメントに返信 `"Good catch. I'll remove them."` を追加する方法を示しています。 ``` aws codecommit post-comment-reply \ --in-reply-to abcd1234EXAMPLEb5678efgh \ --content "Good catch. I'll remove them." \ --client-request-token 123Example ``` 出力: ``` { "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": [] } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PostCommentReply](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/post-comment-reply.html)」を参照してください。 ### `put-comment-reaction` 次のコード例は、`put-comment-reaction` を使用する方法を示しています。 **AWS CLI** **絵文字を使用してコミットのコメントに返信するには** 次の `put-comment-reaction` の例では、ID `abcd1234EXAMPLEb5678efgh` のコメントに絵文字リアクション値 `:thumbsup:` で返信しています。 ``` aws codecommit put-comment-reaction \ --comment-id abcd1234EXAMPLEb5678efgh \ --reaction-value :thumbsup: ``` このコマンドでは何も出力されません。 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Comment on a commit in AWS CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-commit-comment.html#how-to-commit-comment-cli-commit-reply-emoji)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutCommentReaction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/put-comment-reaction.html)」を参照してください。 ### `put-file` 次のコード例は、`put-file` を使用する方法を示しています。 **AWS CLI** **リポジトリにファイルを追加するには** 次の `put-file` の例では、「ExampleSolution.py」という名前のファイルを「MyDemoRepo」という名前のリポジトリの「feature-randomizationfeature」という名前のブランチに追加しています。最新のコミットの ID は「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." ``` 出力: ``` { "blobId": "2eb4af3bEXAMPLE", "commitId": "317f8570EXAMPLE", "treeId": "347a3408EXAMPLE" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutFile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/put-file.html)」を参照してください。 ### `put-repository-triggers` 次のコード例は、`put-repository-triggers` を使用する方法を示しています。 **AWS CLI** **リポジトリでトリガーを追加または更新するには** この例では、MyDemoRepo という名前のリポジトリのすべてのトリガーの構造を含む、既に作成された JSON ファイル (ここでは MyTriggers.json) を使用して、「MyFirstTrigger」と「MySecondTrigger」という名前のトリガーを更新する方法を示しています。既存のトリガーの JSON を取得する方法については、get-repository-triggers コマンドを参照してください。 ``` aws codecommit put-repository-triggers \ --repository-name MyDemoRepo file://MyTriggers.json ``` `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" ] } ] } ``` 出力: ``` { "configurationId": "6fa51cd8-35c1-EXAMPLE" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutRepositoryTriggers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/put-repository-triggers.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **既存のリポジトリに AWS タグを追加するには** 次の `tag-resource` の例では、指定されたリポジトリに 2 つのタグを付けています。 ``` aws codecommit tag-resource \ --resource-arn arn:aws:codecommit:us-west-2:111111111111:MyDemoRepo \ --tags Status=Secret,Team=Saanvi ``` このコマンドでは何も出力されません。 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Add a Tag to a Repository](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-tag-repository-add.html#how-to-tag-repository-add-cli)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/tag-resource.html)」を参照してください。 ### `test-repository-triggers` 次のコード例は、`test-repository-triggers` を使用する方法を示しています。 **AWS CLI** **リポジトリ内のトリガーをテストするには** この例では、MyDemoRepo という名前の AWS CodeCommit リポジトリで「MyFirstTrigger」という名前のトリガーをテストする方法を示しています。この例では、リポジトリのイベントは Amazon Simple Notification Service (Amazon SNS) トピックから通知をトリガーします。 コマンド: ``` 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 ``` 出力: ``` { "successfulExecutions": [ "MyFirstTrigger" ], "failedExecutions": [] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TestRepositoryTriggers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/test-repository-triggers.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **リポジトリから AWS タグを削除するには** 次の `untag-resource` の例では、`MyDemoRepo` という名前のリポジトリから指定されたキーのタグを削除しています。 ``` aws codecommit untag-resource \ --resource-arn arn:aws:codecommit:us-west-2:111111111111:MyDemoRepo \ --tag-keys Status ``` このコマンドでは何も出力されません。 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Remove a Tag from a Repository](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-tag-repository-delete.html#how-to-tag-repository-delete-cli)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/untag-resource.html)」を参照してください。 ### `update-approval-rule-template-content` 次のコード例は、`update-approval-rule-template-content` を使用する方法を示しています。 **AWS CLI** **承認ルールテンプレートの内容を更新するには** 次の `update-approval-rule-template-content` の例では、指定された承認ルールテンプレートの内容を変更し、`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/*\"]}]}" ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Manage Approval Rule Templates](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-manage-templates.html#update-template-content)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateApprovalRuleTemplateContent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-approval-rule-template-content.html)」を参照してください。 ### `update-approval-rule-template-description` 次のコード例は、`update-approval-rule-template-description` を使用する方法を示しています。 **AWS CLI** **承認ルールテンプレートの説明を更新するには** 次の `update-approval-rule-template-description` の例では、指定された承認ルールテンプレートの説明を `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" ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Manage Approval Rule Templates](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-manage-templates.html#update-template-description)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateApprovalRuleTemplateDescription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-approval-rule-template-description.html)」を参照してください。 ### `update-approval-rule-template-name` 次のコード例は、`update-approval-rule-template-name` を使用する方法を示しています。 **AWS CLI** **承認ルールテンプレートの名前を更新するには** 次の `update-approval-rule-template-name` の例では、承認ルールテンプレートの名前を `1-approver-rule` から「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 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Manage Approval Rule Templates](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-manage-templates.html#update-template-description)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateApprovalRuleTemplateName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-approval-rule-template-name.html)」を参照してください。 ### `update-comment` 次のコード例は、`update-comment` を使用する方法を示しています。 **AWS CLI** **コミットに対するコメントを更新するには** この例では、ID が `442b498bEXAMPLE5756813` のコメントに `"Fixed as requested. I'll update the pull request."` という内容を追加する方法を示しています。 ``` aws codecommit update-comment \ --comment-id 442b498bEXAMPLE5756813 \ --content "Fixed as requested. I'll update the pull request." ``` 出力: ``` { "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 } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateComment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-comment.html)」を参照してください。 ### `update-default-branch` 次のコード例は、`update-default-branch` を使用する方法を示しています。 **AWS CLI** **リポジトリのデフォルトブランチを変更するには** この例では、AWS CodeCommit リポジトリのデフォルトブランチを変更しています。このコマンドは、エラーがある場合にのみ出力を生成します。 コマンド: ``` aws codecommit update-default-branch --repository-name MyDemoRepo --default-branch-name MyNewBranch ``` 出力: ``` None. ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateDefaultBranch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-default-branch.html)」を参照してください。 ### `update-pull-request-approval-rule-content` 次のコード例は、`update-pull-request-approval-rule-content` を使用する方法を示しています。 **AWS CLI** **プルリクエストの承認ルールを編集するには** 次の `update-pull-request-approval-rule-content` の例では、指定した承認ルールを更新し、`123456789012` AWS アカウントの任意の IAM ユーザーを含む承認プールから 1 人のユーザー承認を必須にしています。 ``` 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/*\"]}]}}" ``` 出力: ``` { "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", } } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Edit or Delete an Approval Rule](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-edit-delete-pull-request-approval-rule.html#update-pull-request-approval-rule-content)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdatePullRequestApprovalRuleContent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-pull-request-approval-rule-content.html)」を参照してください。 ### `update-pull-request-approval-state` 次のコード例は、`update-pull-request-approval-state` を使用する方法を示しています。 **AWS CLI** **プルリクエストを承認するか承認を取り消すには** 次の `update-pull-request-approval-state` の例では、ID が `27` でリビジョン ID が `9f29d167EXAMPLE` のプルリクエストを承認しています。代わりに承認を取り消す場合は、`--approval-state` パラメータ値を `REVOKE` に設定します。 ``` aws codecommit update-pull-request-approval-state \ --pull-request-id 27 \ --revision-id 9f29d167EXAMPLE \ --approval-state "APPROVE" ``` このコマンドでは何も出力されません。 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[Review a Pull Request](https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-review-pull-request.html#update-pull-request-approval-state)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdatePullRequestApprovalState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-pull-request-approval-state.html)」を参照してください。 ### `update-pull-request-description` 次のコード例は、`update-pull-request-description` を使用する方法を示しています。 **AWS CLI** **プルリクエストの説明を変更するには** この例では、ID が `47` のプルリクエストの説明を変更する方法を示しています。 ``` aws codecommit update-pull-request-description \ --pull-request-id 47 \ --description "Updated the pull request to remove unused global variable." ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdatePullRequestDescription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-pull-request-description.html)」を参照してください。 ### `update-pull-request-status` 次のコード例は、`update-pull-request-status` を使用する方法を示しています。 **AWS CLI** **プルリクエストのステータスを変更するには** この例では、`MyDemoRepo` という名前の AWS CodeCommit リポジトリで、ID が `42` のプルリクエストのステータスを `CLOSED` に変更する方法を示しています。 ``` aws codecommit update-pull-request-status \ --pull-request-id 42 \ --pull-request-status CLOSED ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdatePullRequestStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-pull-request-status.html)」を参照してください。 ### `update-pull-request-title` 次のコード例は、`update-pull-request-title` を使用する方法を示しています。 **AWS CLI** **プルリクエストのタイトルを変更するには** この例では、ID が `47` のプルリクエストのタイトルを変更する方法を示しています。 ``` aws codecommit update-pull-request-title \ --pull-request-id 47 \ --title "Consolidation of global variables - updated review" ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdatePullRequestTitle](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-pull-request-title.html)」を参照してください。 ### `update-repository-description` 次のコード例は、`update-repository-description` を使用する方法を示しています。 **AWS CLI** **リポジトリの説明を変更するには** この例では、AWS CodeCommit リポジトリの説明を変更しています。このコマンドは、エラーがある場合にのみ出力を生成します。 コマンド: ``` aws codecommit update-repository-description --repository-name MyDemoRepo --repository-description "This description was changed" ``` 出力: ``` None. ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateRepositoryDescription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-repository-description.html)」を参照してください。 ### `update-repository-name` 次のコード例は、`update-repository-name` を使用する方法を示しています。 **AWS CLI** **リポジトリの名前を変更するには** この例では、AWS CodeCommit リポジトリの名前を変更しています。このコマンドは、エラーがある場合にのみ出力を生成します。AWS CodeCommit リポジトリの名前を変更すると、ユーザーがリポジトリへの接続で必要な SSH および HTTPS URL が変更されます。ユーザーは、接続設定を更新するまでこのリポジトリに接続できなくなります。また、リポジトリの ARN が変更されるため、リポジトリ名を変更すると、このリポジトリの ARN に依存するすべての IAM ユーザーポリシーが無効になります。 コマンド: ``` aws codecommit update-repository-name --old-name MyDemoRepo --new-name MyRenamedDemoRepo ``` 出力: ``` None. ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateRepositoryName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codecommit/update-repository-name.html)」を参照してください。 # AWS CLI を使用した CodeDeploy の例 次のコード例は、CodeDeploy で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `add-tags-to-on-premises-instances` 次のコード例は、`add-tags-to-on-premises-instances` を使用する方法を示しています。 **AWS CLI** **オンプレミスインスタンスにタグを追加するには** 次の `add-tags-to-on-premises-instances` の例では、AWS CodeDeploy で同じオンプレミスインスタンスタグを 2 つのオンプレミスインスタンスに関連付けています。オンプレミスインスタンスは、AWS CodeDeploy に登録されません。 ``` aws deploy add-tags-to-on-premises-instances \ --instance-names AssetTag12010298EX AssetTag23121309EX \ --tags Key=Name,Value=CodeDeployDemo-OnPrem ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddTagsToOnPremisesInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/add-tags-to-on-premises-instances.html)」を参照してください。 ### `batch-get-application-revisions` 次のコード例は、`batch-get-application-revisions` を使用する方法を示しています。 **AWS CLI** **アプリケーションリビジョンに関する情報を取得するには** 次の `batch-get-application-revisions` の例では、GitHub リポジトリに保存されている指定されたリビジョンに関する情報を取得しています。 ``` aws deploy batch-get-application-revisions \ --application-name my-codedeploy-application \ --revisions "[{\"gitHubLocation\": {\"commitId\": \"fa85936EXAMPLEa31736c051f10d77297EXAMPLE\",\"repository\": \"my-github-token/my-repository\"},\"revisionType\": \"GitHub\"}]" ``` 出力: ``` { "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": "" } ``` 詳細については、「*AWS CodeDeploy API リファレンス*」の「[BatchGetApplicationRevisions](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_BatchGetApplicationRevisions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchGetApplicationRevisions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/batch-get-application-revisions.html)」を参照してください。 ### `batch-get-applications` 次のコード例は、`batch-get-applications` を使用する方法を示しています。 **AWS CLI** **複数のアプリケーションに関する情報を取得するには** 次の `batch-get-applications` の例では、ユーザーの AWS アカウントに関連付けられている複数のアプリケーションに関する情報を表示しています。 ``` aws deploy batch-get-applications --application-names WordPress_App MyOther_App ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchGetApplications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/batch-get-applications.html)」を参照してください。 ### `batch-get-deployment-groups` 次のコード例は、`batch-get-deployment-groups` を使用する方法を示しています。 **AWS CLI** **1 つまたは複数のデプロイグループに関する情報を取得するには** 次の `batch-get-deployment-groups` の例では、指定された CodeDeploy アプリケーションに関連付けられている 2 つのデプロイグループに関する情報を取得しています。 ``` aws deploy batch-get-deployment-groups \ --application-name my-codedeploy-application \ --deployment-group-names "[\"my-deployment-group-1\",\"my-deployment-group-2\"]" ``` 出力: ``` { "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": "" } ``` 詳細については、「*AWS CodeDeploy API リファレンス*」の「[BatchGetDeploymentGroups](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_BatchGetDeploymentGroups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchGetDeploymentGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/batch-get-deployment-groups.html)」を参照してください。 ### `batch-get-deployment-targets` 次のコード例は、`batch-get-deployment-targets` を使用する方法を示しています。 **AWS CLI** **デプロイに関連付けられているターゲットを取得するには** 次の `batch-get-deployment-targets` の例では、指定されたデプロイに関連付けられたターゲットの 1 つに関する情報を返しています。 ``` aws deploy batch-get-deployment-targets \ --deployment-id "d-1A2B3C4D5" \ --target-ids "i-01a2b3c4d5e6f1111" ``` 出力: ``` { "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" } } ] } ``` 詳細については、「*AWS CodeDeploy API リファレンス*」の「[BatchGetDeploymentTargets](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_BatchGetDeploymentTargets.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchGetDeploymentTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/batch-get-deployment-targets.html)」を参照してください。 ### `batch-get-deployments` 次のコード例は、`batch-get-deployments` を使用する方法を示しています。 **AWS CLI** **複数のデプロイに関する情報を取得するには** 次の `batch-get-deployments` の例では、ユーザーの AWS アカウントに関連付けられている複数のデプロイに関する情報を表示しています。 ``` aws deploy batch-get-deployments --deployment-ids d-A1B2C3111 d-A1B2C3222 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchGetDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/batch-get-deployments.html)」を参照してください。 ### `batch-get-on-premises-instances` 次のコード例は、`batch-get-on-premises-instances` を使用する方法を示しています。 **AWS CLI** **1 つまたは複数のオンプレミスインスタンスに関する情報を取得するには** 次の `batch-get-on-premises-instances` の例では、2 つのオンプレミスインスタンスに関する情報を取得しています。 ``` aws deploy batch-get-on-premises-instances --instance-names AssetTag12010298EX AssetTag23121309EX ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchGetOnPremisesInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/batch-get-on-premises-instances.html)」を参照してください。 ### `continue-deployment` 次のコード例は、`continue-deployment` を使用する方法を示しています。 **AWS CLI** **指定された待機時間が経過するのを待たずにトラフィックの再ルーティングを開始するには。** 次の `continue-deployment` の例では、置き換え先環境のインスタンスへトラフィックを移行する準備ができている元の環境のインスタンスからのトラフィックの再ルーティングを開始します。 ``` aws deploy continue-deployment \ --deployment-id "d-A1B2C3111" \ --deployment-wait-type "READY_WAIT" ``` このコマンドでは何も出力されません。 詳細については、「*AWS CodeDeploy API リファレンス*」の「[ContinueDeployment](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_ContinueDeployment.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ContinueDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/continue-deployment.html)」を参照してください。 ### `create-application` 次のコード例は、`create-application` を使用する方法を示しています。 **AWS CLI** **アプリケーションを作成するには** 次の `create-application` の例では、アプリケーションを作成し、ユーザーの AWS アカウントと関連付けています。 ``` aws deploy create-application --application-name MyOther_App ``` 出力: ``` { "applicationId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/create-application.html)」を参照してください。 ### `create-deployment-config` 次のコード例は、`create-deployment-config` を使用する方法を示しています。 **AWS CLI** **カスタムデプロイ設定を作成するには** 次の `create-deployment-config` の例では、カスタムデプロイ設定を作成し、ユーザーの AWS アカウントに関連付けています。 ``` aws deploy create-deployment-config \ --deployment-config-name ThreeQuartersHealthy \ --minimum-healthy-hosts type=FLEET_PERCENT,value=75 ``` 出力: ``` { "deploymentConfigId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDeploymentConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/create-deployment-config.html)」を参照してください。 ### `create-deployment-group` 次のコード例は、`create-deployment-group` を使用する方法を示しています。 **AWS CLI** **デプロイグループを作成するには** 次の `create-deployment-group` の例では、デプロイグループを作成し、指定されたアプリケーションとユーザーの AWS アカウントに関連付けています。 ``` 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 ``` 出力: ``` { "deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDeploymentGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/create-deployment-group.html)」を参照してください。 ### `create-deployment` 次のコード例は、`create-deployment` を使用する方法を示しています。 **AWS CLI** **例 1: EC2/オンプレミスコンピューティングプラットフォームを使用して CodeDeploy デプロイを作成するには** 次の `create-deployment` の例では、デプロイを作成し、ユーザーの AWS アカウントに関連付けています。 ``` 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 ``` 出力: ``` { "deploymentId": "d-A1B2C3111" } ``` **例 2: Amazon ECS コンピューティングプラットフォームを使用して CodeDeploy デプロイを作成するには** 次の `create-deployment` の例では、次の 2 つのファイルを使用して Amazon ECS サービスをデプロイしています。 `create-deployment.json` ファイルの内容。 ``` { "applicationName": "ecs-deployment", "deploymentGroupName": "ecs-deployment-dg", "revision": { "revisionType": "S3", "s3Location": { "bucket": "ecs-deployment-bucket", "key": "appspec.yaml", "bundleType": "YAML" } } } ``` このファイルは、次に `ecs-deployment-bucket` という S3 バケットから次のファイル `appspec.yaml` を取得しています。 ``` 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" ``` コマンド: ``` aws deploy create-deployment \ --cli-input-json file://create-deployment.json \ --region us-east-1 ``` 出力: ``` { "deploymentId": "d-1234ABCDE" } ``` 詳細については、「*AWS CodeDeploy API リファレンス*」の「[CreateDeployment](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[CreateDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/create-deployment.html)」を参照してください。** ### `delete-application` 次のコード例は、`delete-application` を使用する方法を示しています。 **AWS CLI** **アプリケーションを削除するには** 次の `delete-application` の例では、ユーザーの AWS アカウントに関連付けられている指定されたアプリケーションを削除しています。 ``` aws deploy delete-application --application-name WordPress_App ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/delete-application.html)」を参照してください。 ### `delete-deployment-config` 次のコード例は、`delete-deployment-config` を使用する方法を示しています。 **AWS CLI** **デプロイ設定を削除するには** 次の `delete-deployment-config` の例では、ユーザーの AWS アカウントに関連付けられているカスタムデプロイ設定を削除しています。 ``` aws deploy delete-deployment-config --deployment-config-name ThreeQuartersHealthy ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDeploymentConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/delete-deployment-config.html)」を参照してください。 ### `delete-deployment-group` 次のコード例は、`delete-deployment-group` を使用する方法を示しています。 **AWS CLI** **デプロイグループを削除するには** 次の `delete-deployment-group` の例では、指定されたアプリケーションに関連付けられているデプロイグループを削除しています。 ``` aws deploy delete-deployment-group \ --application-name WordPress_App \ --deployment-group-name WordPress_DG ``` 出力: ``` { "hooksNotCleanedUp": [] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDeploymentGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/delete-deployment-group.html)」を参照してください。 ### `delete-git-hub-account-token` 次のコード例は、`delete-git-hub-account-token` を使用する方法を示しています。 **AWS CLI** **GitHub アカウント接続を削除するには** 次の `delete-git-hub-account-token` の例では、指定された GitHub アカウントの接続を削除しています。 ``` aws deploy delete-git-hub-account-token --token-name my-github-account ``` 出力: ``` { "tokenName": "my-github-account" } ``` 詳細については、「*AWS CodeDeploy API リファレンス*」の「[DeleteGitHubAccountToken](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_DeleteGitHubAccountToken.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteGitHubAccountToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/delete-git-hub-account-token.html)」を参照してください。 ### `deregister-on-premises-instance` 次のコード例は、`deregister-on-premises-instance` を使用する方法を示しています。 **AWS CLI** **オンプレミスインスタンスの登録を解除するには** 次の `deregister-on-premises-instance` の例では、AWS CodeDeploy へのオンプレミスインスタンスの登録を解除していますが、インスタンスに関連付けられた IAM ユーザーを削除したり、AWS CodeDeploy でオンプレミスインスタンスタグとインスタンスとの関連付けを解除したりすることはありません。また、インスタンスから AWS CodeDeploy エージェントをアンインストールしたり、インスタンスからオンプレミス設定ファイルを削除したりすることもありません。 ``` aws deploy deregister-on-premises-instance --instance-name AssetTag12010298EX ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeregisterOnPremisesInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/deregister-on-premises-instance.html)」を参照してください。 ### `deregister` 次のコード例は、`deregister` を使用する方法を示しています。 **AWS CLI** **オンプレミスインスタンスの登録を解除するには** 次の `deregister` の例では、AWS CodeDeploy へのオンプレミスインスタンスの登録を解除しています。インスタンスに関連付けられた IAM ユーザーは削除されません。AWS CodeDeploy でオンプレミスタグとインスタンスとの関連付けを解除します。AWS CodeDeploy エージェントをインスタンスからアンインストールしたり、インスタンスからオンプレミス設定ファイルを削除したりすることはありません。 ``` aws deploy deregister \ --instance-name AssetTag12010298EX \ --no-delete-iam-user \ --region us-west-2 ``` 出力: ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[Deregister](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/deregister.html)」を参照してください。 ### `get-application-revision` 次のコード例は、`get-application-revision` を使用する方法を示しています。 **AWS CLI** **アプリケーションリビジョンに関する情報を取得するには** 次の `get-application-revision` の例では、指定されたアプリケーションに関連付けられているアプリケーションリビジョンに関する情報を表示しています。 ``` aws deploy get-application-revision \ --application-name WordPress_App \ --s3-location bucket=amzn-s3-demo-bucket,bundleType=zip,eTag=dd56cfdEXAMPLE8e768f9d77fEXAMPLE,key=WordPressApp.zip ``` 出力: ``` { "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" } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetApplicationRevision](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-application-revision.html)」を参照してください。 ### `get-application` 次のコード例は、`get-application` を使用する方法を示しています。 **AWS CLI** **アプリケーションに関する情報を取得するには** 次の `get-application` の例では、ユーザーの AWS アカウントに関連付けられているアプリケーションに関する情報を表示しています。 ``` aws deploy get-application --application-name WordPress_App ``` 出力: ``` { "application": { "applicationName": "WordPress_App", "applicationId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "createTime": 1407878168.078, "linkedToGitHub": false } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-application.html)」を参照してください。 ### `get-deployment-config` 次のコード例は、`get-deployment-config` を使用する方法を示しています。 **AWS CLI** **デプロイ設定に関する情報を取得するには** 次の `get-deployment-config` の例では、ユーザーの AWS アカウントに関連付けられているデプロイ設定に関する情報を表示しています。 ``` aws deploy get-deployment-config --deployment-config-name ThreeQuartersHealthy ``` 出力: ``` { "deploymentConfigInfo": { "deploymentConfigId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "minimumHealthyHosts": { "type": "FLEET_PERCENT", "value": 75 }, "createTime": 1411081164.379, "deploymentConfigName": "ThreeQuartersHealthy" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDeploymentConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-deployment-config.html)」を参照してください。 ### `get-deployment-group` 次のコード例は、`get-deployment-group` を使用する方法を示しています。 **AWS CLI** **デプロイグループに関する情報を表示するには** 次の `get-deployment-group` の例では、指定されたアプリケーションに関連付けられているデプロイグループに関する情報を表示しています。 ``` aws deploy get-deployment-group \ --application-name WordPress_App \ --deployment-group-name WordPress_DG ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDeploymentGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-deployment-group.html)」を参照してください。 ### `get-deployment-instance` 次のコード例は、`get-deployment-instance` を使用する方法を示しています。 **AWS CLI** **デプロイインスタンスに関する情報を取得するには** 次の `get-deployment-instance` の例では、指定されたデプロイに関連付けられているデプロイインスタンスに関する情報を表示しています。 ``` aws deploy get-deployment-instance --deployment-id d-QA4G4F9EX --instance-id i-902e9fEX ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDeploymentInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-deployment-instance.html)」を参照してください。 ### `get-deployment-target` 次のコード例は、`get-deployment-target` を使用する方法を示しています。 **AWS CLI** **デプロイターゲットに関する情報を返すには** 次の `get-deployment-target` の例では、指定されたデプロイに関連付けられているデプロイターゲットに関する情報を返しています。 ``` aws deploy get-deployment-target \ --deployment-id "d-A1B2C3111" \ --target-id "i-a1b2c3d4e5f611111" ``` 出力: ``` { "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" } } } ``` 詳細については、「*AWS CodeDeploy API リファレンス*」の「[GetDeploymentTarget](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_GetDeploymentTarget.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDeploymentTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-deployment-target.html)」を参照してください。 ### `get-deployment` 次のコード例は、`get-deployment` を使用する方法を示しています。 **AWS CLI** **デプロイに関する情報を取得するには** 次の `get-deployment` の例では、ユーザーの AWS アカウントに関連付けられているデプロイに関する情報を表示しています。 ``` aws deploy get-deployment --deployment-id d-A1B2C3123 ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-deployment.html)」を参照してください。 ### `get-on-premises-instance` 次のコード例は、`get-on-premises-instance` を使用する方法を示しています。 **AWS CLI** **オンプレミスインスタンスに関する情報を取得するには** 次の `get-on-premises-instance` の例では、指定されたオンプレミスインスタンスに関する情報を取得しています。 ``` aws deploy get-on-premises-instance --instance-name AssetTag12010298EX ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetOnPremisesInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/get-on-premises-instance.html)」を参照してください。 ### `install` 次のコード例は、`install` を使用する方法を示しています。 **AWS CLI** **オンプレミスインスタンスをインストールするには** 次の `install` の例では、オンプレミスの設定ファイルを、インスタンスの指定された場所から AWS CodeDeploy エージェントが見つけやすいインスタンスの場所へコピーしています。また、インスタンスに AWS CodeDeploy エージェントもインストールします。IAM ユーザーを作成したり、オンプレミスインスタンスを AWS CodeDeploy に登録したり、インスタンスの AWS CodeDeploy にオンプレミスインスタンスタグを関連付けたりすることはありません。 ``` 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 ``` 出力: ``` Creating the on-premises instance configuration file... DONE Installing the AWS CodeDeploy Agent... DONE ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[Install](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/install.html)」を参照してください。 ### `list-application-revisions` 次のコード例は、`list-application-revisions` を使用する方法を示しています。 **AWS CLI** **アプリケーションリビジョンに関する情報を取得するには** 次の `list-application-revisions` の例では、指定されたアプリケーションに関連付けられているすべてのアプリケーションリビジョンに関する情報を表示しています。 ``` 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 ``` 出力: ``` { "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" } } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListApplicationRevisions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-application-revisions.html)」を参照してください。 ### `list-applications` 次のコード例は、`list-applications` を使用する方法を示しています。 **AWS CLI** **アプリケーションに関する情報を取得するには** 次の `list-applications` の例では、ユーザーの AWS アカウントに関連付けられているすべてのアプリケーションに関する情報を表示しています。 ``` aws deploy list-applications ``` 出力: ``` { "applications": [ "WordPress_App", "MyOther_App" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListApplications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-applications.html)」を参照してください。 ### `list-deployment-configs` 次のコード例は、`list-deployment-configs` を使用する方法を示しています。 **AWS CLI** **デプロイ設定に関する情報を取得するには** 次の `list-deployment-configs` の例では、ユーザーの AWS アカウントに関連付けられているすべてのデプロイ設定に関する情報を表示しています。 ``` aws deploy list-deployment-configs ``` 出力: ``` { "deploymentConfigsList": [ "ThreeQuartersHealthy", "CodeDeployDefault.AllAtOnce", "CodeDeployDefault.HalfAtATime", "CodeDeployDefault.OneAtATime" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDeploymentConfigs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-deployment-configs.html)」を参照してください。 ### `list-deployment-groups` 次のコード例は、`list-deployment-groups` を使用する方法を示しています。 **AWS CLI** **デプロイグループに関する情報を取得するには** 次の `list-deployment-groups` の例では、指定されたアプリケーションに関連付けられているすべてのデプロイグループに関する情報を表示しています。 ``` aws deploy list-deployment-groups --application-name WordPress_App ``` 出力: ``` { "applicationName": "WordPress_App", "deploymentGroups": [ "WordPress_DG", "WordPress_Beta_DG" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDeploymentGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-deployment-groups.html)」を参照してください。 ### `list-deployment-instances` 次のコード例は、`list-deployment-instances` を使用する方法を示しています。 **AWS CLI** **デプロイインスタンスに関する情報を取得するには** 次の `list-deployment-instances` の例では、指定されたデプロイに関連付けられているすべてのデプロイインスタンスに関する情報を表示しています。 ``` aws deploy list-deployment-instances \ --deployment-id d-A1B2C3111 \ --instance-status-filter Succeeded ``` 出力: ``` { "instancesList": [ "i-EXAMPLE11", "i-EXAMPLE22" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDeploymentInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-deployment-instances.html)」を参照してください。 ### `list-deployment-targets` 次のコード例は、`list-deployment-targets` を使用する方法を示しています。 **AWS CLI** **デプロイに関連付けられているターゲット ID のリストを取得するには** 次の `list-deployment-targets` の例では、「Failed」または「InProgress」のステータスを持つデプロイに関連付けられたターゲット ID のリストを取得しています。 ``` aws deploy list-deployment-targets \ --deployment-id "d-A1B2C3111" \ --target-filters "{\"TargetStatus\":[\"Failed\",\"InProgress\"]}" ``` 出力: ``` { "targetIds": [ "i-0f1558aaf90e5f1f9" ] } ``` 詳細については、「*AWS CodeDeploy API リファレンス*」の「[ListDeploymentTargets](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_ListDeploymentTargets.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDeploymentTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-deployment-targets.html)」を参照してください。 ### `list-deployments` 次のコード例は、`list-deployments` を使用する方法を示しています。 **AWS CLI** **デプロイに関する情報を取得するには** 次の `list-deployments` の例では、指定されたアプリケーションとデプロイグループに関連付けられているすべてのデプロイに関する情報を表示しています。 ``` 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 ``` 出力: ``` { "deployments": [ "d-EXAMPLE11", "d-EXAMPLE22", "d-EXAMPLE33" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-deployments.html)」を参照してください。 ### `list-git-hub-account-token-names` 次のコード例は、`list-git-hub-account-token-names` を使用する方法を示しています。 **AWS CLI** **GitHub アカウントへの保存された接続の名前を一覧表示するには** 次の `list-git-hub-account-token-names` の例では、現在の AWS ユーザーの GitHub アカウントへの保存された接続の名前を一覧表示しています。 ``` aws deploy list-git-hub-account-token-names ``` 出力: ``` { "tokenNameList": [ "my-first-token", "my-second-token", "my-third-token" ] } ``` 詳細については、「*AWS CodeDeploy API リファレンス*」の「[ListGitHubAccountTokenNames](https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_ListGitHubAccountTokenNames.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListGitHubAccountTokenNames](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-git-hub-account-token-names.html)」を参照してください。 ### `list-on-premises-instances` 次のコード例は、`list-on-premises-instances` を使用する方法を示しています。 **AWS CLI** **1 つまたは複数のオンプレミスインスタンスに関する情報を取得するには** 次の `list-on-premises-instances` の例では、AWS CodeDeploy に登録され、AWS CodeDeploy でインスタンスに関連付けられている指定されたオンプレミスインスタンスタグを持つインスタンスで使用可能なオンプレミスインスタンス名のリストを取得しています。 ``` aws deploy list-on-premises-instances \ --registration-status Registered \ --tag-filters Key=Name,Value=CodeDeployDemo-OnPrem,Type=KEY_AND_VALUE ``` 出力: ``` { "instanceNames": [ "AssetTag12010298EX" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListOnPremisesInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-on-premises-instances.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **リソースのタグを一覧表示するには (アプリケーション)** 次の `list-tags-for-resource` の例では、CodeDeploy の testApp という名前のアプリケーションに適用されるタグを一覧表示しています。 ``` aws deploy list-tags-for-resource \ --resource-arn arn:aws:codedeploy:us-west-2:111122223333:application:testApp ``` 出力: ``` { "Tags": [ { "Key": "Type", "Value": "testType" }, { "Key": "Name", "Value": "testName" } ] } ``` 詳細については、「*AWS CodeDeploy ユーザーガイド*」の「[Tagging instances for deployment groups in CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-tagging.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/list-tags-for-resource.html)」を参照してください。 ### `push` 次のコード例は、`push` を使用する方法を示しています。 **AWS CLI** **AWS CodeDeploy 互換のアプリケーションリビジョンをバンドルして Amazon S3 にデプロイするには** 次の `push` の例では、アプリケーションリビジョンをバンドルして Amazon S3 にデプロイし、アプリケーションリビジョンを指定されたアプリケーションに関連付けています。 ``` 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/ ``` 出力では、`create-deployment` コマンドを使用して、アップロードされたアプリケーションリビジョンを使用するデプロイを作成する方法について説明しています。 ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[Push](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/push.html)」を参照してください。 ### `register-application-revision` 次のコード例は、`register-application-revision` を使用する方法を示しています。 **AWS CLI** **アップロード済みのアプリケーションリビジョンに関する情報を登録するには** 次の `register-application-revision` の例では、Amazon S3 に保存されているアップロード済みのアプリケーションリビジョンに関する情報を 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 ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegisterApplicationRevision](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/register-application-revision.html)」を参照してください。 ### `register-on-premises-instance` 次のコード例は、`register-on-premises-instance` を使用する方法を示しています。 **AWS CLI** **オンプレミスインスタンスを登録するには** 次の `register-on-premises-instance` の例では、オンプレミスインスタンスを AWS CodeDeploy に登録しています。指定された IAM ユーザーを作成したり、AWS CodeDeploy でオンプレミスインスタンスタグを登録されたインスタンスに関連付けたりすることはありません。 ``` aws deploy register-on-premises-instance \ --instance-name AssetTag12010298EX \ --iam-user-arn arn:aws:iam::80398EXAMPLE:user/CodeDeployDemoUser-OnPrem ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegisterOnPremisesInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/register-on-premises-instance.html)」を参照してください。 ### `register` 次のコード例は、`register` を使用する方法を示しています。 **AWS CLI** **オンプレミスインスタンスを登録するには** 次の `register` の例では、オンプレミスインスタンスを AWS CodeDeploy に登録し、AWS CodeDeploy で指定されたオンプレミスインスタンスタグを登録されたインスタンスに関連付け、インスタンスにコピーできるオンプレミス設定ファイルを作成しています。IAM ユーザーを作成したり、インスタンスに AWS CodeDeploy エージェントをインストールしたりすることはありません。 ``` 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 ``` 出力: ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[Register](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/register.html)」を参照してください。 ### `remove-tags-from-on-premises-instances` 次のコード例は、`remove-tags-from-on-premises-instances` を使用する方法を示しています。 **AWS CLI** **1 つまたは複数のオンプレミスインスタンスからタグを削除するには** 次の `remove-tags-from-on-premises-instances` の例では、AWS CodeDeploy の指定されたオンプレミスタグとオンプレミスインスタンスとの関連付けを解除しています。AWS CodeDeploy のオンプレミスインスタンスの登録を解除したり、インスタンスから AWS CodeDeploy エージェントをアンインストールしたり、インスタンスからオンプレミス設定ファイルを削除したり、インスタンスに関連付けられている IAM ユーザーを削除したりすることはありません。 ``` aws deploy remove-tags-from-on-premises-instances \ --instance-names AssetTag12010298EX AssetTag23121309EX \ --tags Key=Name,Value=CodeDeployDemo-OnPrem ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveTagsFromOnPremisesInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/remove-tags-from-on-premises-instances.html)」を参照してください。 ### `stop-deployment` 次のコード例は、`stop-deployment` を使用する方法を示しています。 **AWS CLI** **デプロイを停止するには** 次の `stop-deployment` の例では、ユーザーの AWS アカウントに関連付けられている進行中のデプロイを停止しようとしています。 aws deploy stop-deployment --deployment-id d-A1B2C3111 出力: ``` { "status": "Succeeded", "statusMessage": "No more commands will be scheduled for execution in the deployment instances" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/stop-deployment.html)」を参照してください。 ### `tag-resource` 次の例は、`tag-resource` を使用する方法を説明しています。 **AWS CLI** **リソースにタグを付けるには (アプリケーション)** 次の `tag-resource` の例では、CodeDeploy の testApp という名前のアプリケーションに、キー Name と Type、値 testName と testType を持つ 2 つのタグを追加しています。 ``` aws deploy tag-resource \ --resource-arn arn:aws:codedeploy:us-west-2:111122223333:application:testApp \ --tags Key=Name,Value=testName Key=Type,Value=testType ``` このコマンドが成功した場合、出力は生成されません。 詳細については、「*AWS CodeDeploy ユーザーガイド*」の「[Tagging instances for deployment groups in CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/tag-resource.html)」を参照してください。 ### `uninstall` 次のコード例は、`uninstall` を使用する方法を示しています。 **AWS CLI** **オンプレミスインスタンスをアンインストールするには** 次の `uninstall` の例では、オンプレミスインスタンスから AWS CodeDeploy エージェントをアンインストールし、インスタンスからオンプレミス設定ファイルを削除しています。AWS CodeDeploy のインスタンスの登録を解除したり、AWS CodeDeploy のオンプレミスインスタンスタグとインスタンスとの関連付けを解除したり、インスタンスに関連付けられている IAM ユーザーを削除したりすることはありません。 ``` aws deploy uninstall ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[Uninstall](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/uninstall.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **リソースからタグを削除するには (アプリケーション)** 次の `untag-resource` の例では、CodeDeploy の testApp という名前のアプリケーションから、キー Name と Type を持つ 2 つのタグを削除しています。 ``` aws deploy untag-resource \ --resource-arn arn:aws:codedeploy:us-west-2:111122223333:application:testApp \ --tag-keys Name Type ``` このコマンドが成功した場合、出力は生成されません。 詳細については、「*AWS CodeDeploy ユーザーガイド*」の「[Tagging instances for deployment groups in CodeDeploy](https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-tagging.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/untag-resource.html)」を参照してください。 ### `update-application` 次のコード例は、`update-application` を使用する方法を示しています。 **AWS CLI** **アプリケーションの詳細を変更するには** 次の `update-application` の例では、ユーザーの AWS アカウントに関連付けられているアプリケーションの名前を変更しています。 ``` aws deploy update-application \ --application-name WordPress_App \ --new-application-name My_WordPress_App ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/update-application.html)」を参照してください。 ### `update-deployment-group` 次のコード例は、`update-deployment-group` を使用する方法を示しています。 **AWS CLI** **デプロイグループに関する情報を変更するには** 次の `update-deployment-group` の例では、指定されたアプリケーションに関連付けられているデプロイグループの設定を変更しています。 ``` 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 ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateDeploymentGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/deploy/update-deployment-group.html)」を参照してください。 # AWS CLI を使用した CodeGuru Reviewer の例 次のコード例は、CodeGuru Reviewer で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `associate-repository` 次のコード例は、`associate-repository` を使用する方法を示しています。 **AWS CLI** **例 1: Bitbucket リポジトリの関連付けを作成するには** 次の `associate-repository` の例では、既存の Bitbucket リポジトリを使用してリポジトリの関連付けを作成しています。 ``` 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 }' ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon CodeGuru Reviewer ユーザーガイド*」の「[Create a Bitbucket repository association in Amazon CodeGuru Reviewer](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/create-bitbucket-association.html)」を参照してください。 **例 2: GitHub Enterprise リポジトリの関連付けを作成するには** 次の `associate-repository` の例では、既存の GitHub Enterprise リポジトリを使用してリポジトリの関連付けを作成しています。 ``` 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 }' ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon CodeGuru Reviewer ユーザーガイド*」の「[Create a GitHub Enterprise Server repository association in Amazon CodeGuru Reviewer](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/create-github-enterprise-association.html)」を参照してください。 **例 3: AWS CodeCommit リポジトリの関連付けを作成するには** 次の `associate-repository` の例では、既存の AWS CodeCommit リポジトリを使用してリポジトリの関連付けを作成しています。 ``` aws codeguru-reviewer associate-repository \ --repository CodeCommit={Name=mySampleRepo} ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon CodeGuru Reviewer ユーザーガイド*」の「[Create an AWS CodeCommit repository association in Amazon CodeGuru Reviewer](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/create-codecommit-association.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/associate-repository.html)」を参照してください。 ### `create-code-review` 次のコード例は、`create-code-review` を使用する方法を示しています。 **AWS CLI** **コードレビューを作成するには。** 次の `create-code-review` では、`my-repository-name` という名前の AWS CodeCommit リポジトリの `mainline` ブランチにコードのレビューを作成しています。 ``` 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"}}}' ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon CodeGuru Reviewer ユーザーガイド*」の「[Create code reviews in Amazon CodeGuru Reviewer](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/create-code-reviews.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCodeReview](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/create-code-review.html)」を参照してください。 ### `describe-code-review` 次のコード例は、`describe-code-review` を使用する方法を示しています。 **AWS CLI** **コードレビューに関する詳細を一覧表示するには。** 次の `describe-code-review` では、「my-repo-name」という名前の AWS CodeCommit リポジトリの「mainline」ブランチにあるコードのレビューに関する情報を一覧表示しています。 ``` 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" } } ``` 詳細については、「*Amazon CodeGuru Reviewer ユーザーガイド*」の「[View code review details](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/view-code-review-details.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeCodeReview](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/describe-code-review.html)」を参照してください。 ### `describe-recommendation-feedback` 次のコード例は、`describe-recommendation-feedback` を使用する方法を示しています。 **AWS CLI** **推奨事項に対するフィードバックの情報を表示するには** 次の `describe-recommendation-feedback` は、推奨事項に対するフィードバックの情報を示しています。この推奨事項には `ThumbsUp` リアクションが 1 つあります。 ``` 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 ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon CodeGuru Reviewer ユーザーガイド*」の「[View recommendations and provide feedback](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/give-feedback-from-code-review-details.html)」および「[Step 4: Provide feedback](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/provide-feedback.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeRecommendationFeedback](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/describe-recommendation-feedback.html)」を参照してください。 ### `describe-repository-association` 次のコード例は、`describe-repository-association` を使用する方法を示しています。 **AWS CLI** **例 1: GitHub リポジトリの関連付けに関する情報を返すには** 次の `describe-repository-association` の例では、GitHub Enterprise リポジトリを使用して `Associated` 状態にあるリポジトリの関連付けに関する情報を返しています。 ``` aws codeguru-reviewer describe-repository-association \ --association-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon CodeGuru Reviewer ユーザーガイド*」の「[Create a GitHub Enterprise Server repository association in Amazon CodeGuru Reviewer](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/create-github-enterprise-association.html)」を参照してください。 **例 2: 失敗したリポジトリの関連付けに関する情報を返すには** 次の `describe-repository-association` の例では、GitHub Enterprise リポジトリを使用して `Failed` 状態にあるリポジトリの関連付けに関する情報を返しています。 ``` aws codeguru-reviewer describe-repository-association \ --association-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon CodeGuru Reviewer ユーザーガイド*」の「[Create a GitHub Enterprise Server repository association in Amazon CodeGuru Reviewer](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/create-github-enterprise-association.html)」を参照してください。 **例 3: リポジトリの関連付けの解除に関する情報を返すには** 次の `describe-repository-association` の例では、GitHub Enterprise リポジトリを使用して `Disassociating` 状態にあるリポジトリの関連付けに関する情報を返しています。 ``` aws codeguru-reviewer describe-repository-association \ --association-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon CodeGuru Reviewer ユーザーガイド*」の「[Create a GitHub Enterprise Server repository association in Amazon CodeGuru Reviewer](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/create-github-enterprise-association.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeRepositoryAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/describe-repository-association.html)」を参照してください。 ### `disassociate-repository` 次のコード例は、`disassociate-repository` を使用する方法を示しています。 **AWS CLI** **リポジトリの関連付けを解除するには** 次の `disassociate-repository` では、AWS CodeCommit リポジトリを使用しているリポジトリの関連付けを解除しています。 ``` aws codeguru-reviewer disassociate-repository \ --association-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon CodeGuru Reviewer ユーザーガイド*」の「[Disassociate a repository in CodeGuru Reviewer](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/disassociate-repository-association.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/disassociate-repository.html)」を参照してください。 ### `list-code-reviews` 次のコード例は、`list-code-reviews` を使用する方法を示しています。 **AWS CLI** **過去 90 日間に AWS アカウントで作成されたコードレビューを一覧表示するには。** 次の `list-code-reviews` の例では、プルリクエストを使用して過去 90 日間に作成されたコードレビューを一覧表示しています。 ``` aws codeguru-reviewer list-code-reviews \ --type PullRequest ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon CodeGuru Reviewer ユーザーガイド*」の「[View all code reviews](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/view-all-code-reviews.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListCodeReviews](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/list-code-reviews.html)」を参照してください。 ### `list-recommendation-feedback` 次のコード例は、`list-recommendation-feedback` を使用する方法を示しています。 **AWS CLI** **関連付けられたリポジトリの推奨事項に対する顧客からの推奨事項のフィードバックを一覧表示するには** 次の `list-recommendation-feedback` では、コードレビューに関するすべての推奨事項に対する顧客からのフィードバックを一覧表示しています。このコードレビューには、顧客から「ThumbsUp」のフィードバックが １ つあります。 ``` 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 ``` 出力: ``` { "RecommendationFeedbackSummaries": [ { "RecommendationId": "3be1b2e5d7ef6e298a06499379ee290c9c596cf688fdcadb08285ddb0dd390eb", "Reactions": [ "ThumbsUp" ], "UserId": "aws-user-id" } ] } ``` 詳細については、「*Amazon CodeGuru Reviewer ユーザーガイド*」の「[Step 4: Provide feedback](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/provide-feedback.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRecommendationFeedback](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/list-recommendation-feedback.html)」を参照してください。 ### `list-recommendations` 次のコード例は、`list-recommendations` を使用する方法を示しています。 **AWS CLI** **完了したコードレビューの推奨事項を一覧表示するには** 次の `list-recommendations` の例では、完了したコードレビューの推奨事項を一覧表示しています。このコードレビューには 1 つの推奨事項があります。 ``` aws codeguru-reviewer list-recommendations \ --code-review-arn arn:aws:codeguru-reviewer:us-west-2:544120495673:code-review:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon CodeGuru Reviewer ユーザーガイド*」の「[Step 4: Provide feedback](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/provide-feedback.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRecommendations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/list-recommendations.html)」を参照してください。 ### `list-repository-associations` 次のコード例は、`list-repository-associations` を使用する方法を示しています。 **AWS CLI** **AWS アカウントのリポジトリの関連付けを一覧表示するには** 次の `list-repository-associations` の例では、アカウントのリポジトリ関連付けサマリーオブジェクトのリストを返しています。返されたリストは、`ProviderType`、`Name`、`State`、および `Owner` でフィルタリングできます。 ``` aws codeguru-reviewer list-repository-associations ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon CodeGuru Reviewer ユーザーガイド*」の「[View all repository associations in CodeGuru Reviewer](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/repository-association-view-all.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRepositoryAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/list-repository-associations.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **関連付けられたリポジトリのタグを一覧表示するには** 次の `list-tags-for-resource` では、関連付けられたリポジトリのタグを一覧表示しています。この関連付けられたリポジトリには 2 つのタグがあります。 ``` aws codeguru-reviewer list-tags-for-resource \ --resource-arn arn:aws:codeguru-reviewer:us-west-2:123456789012:association:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` 出力: ``` { "Tags": { "Status": "Secret", "Team": "Saanvi" } } ``` 詳細については、「*Amazon CodeGuru Reviewer ユーザーガイド*」の「[View tags for a CodeGuru Reviewer associated repository (AWS CLI)](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/how-to-tag-associated-repository-view-cli.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/list-tags-for-resource.html)」を参照してください。 ### `put-recommendation-feedback` 次のコード例は、`put-recommendation-feedback` を使用する方法を示しています。 **AWS CLI** **コードレビューに推奨事項を追加するには** 次の `put-recommendation-feedback` では、コードレビューに `ThumbsUp` の推奨事項を付けています。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon CodeGuru Reviewer ユーザーガイド*」の「[Step 4: Provide feedback](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/provide-feedback.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutRecommendationFeedback](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/put-recommendation-feedback.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **関連付けられたリポジトリにタグを追加するには** 次の `tag-resource` では、関連付けられたリポジトリに 2 つのタグを追加しています。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon CodeGuru Reviewer ユーザーガイド*」の「[Add a tag to a CodeGuru Reviewer associated repository (AWS CLI)](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/how-to-tag-associated-repository-add-cli.html)」および「[Add or update tags for a CodeGuru Reviewer associated repository (AWS CLI)](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/how-to-tag-associated-repository-update-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **関連付けられたリポジトリのタグを解除するには** 次の `untag-resource` では、キー「Secret」と「Team」を持つ 2 つのタグを関連するリポジトリから削除しています。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon CodeGuru Reviewer ユーザーガイド*」の「[Remove tags from a CodeGuru Reviewer associated repository (AWS CLI)](https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/how-to-tag-associated-repository-remove-cli.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codeguru-reviewer/untag-resource.html)」を参照してください。 # AWS CLI を使用した CodePipeline の例 次のコード例は、CodePipeline で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `acknowledge-job` 次のコード例は、`acknowledge-job` を使用する方法を示しています。 **AWS CLI** **指定したジョブに関する情報を取得するには** この例では、指定したジョブが存在する場合、そのジョブのステータスなどの情報を返します。これは、ジョブワーカーとカスタムアクションにのみ使用されます。nonce の値とジョブ ID を判別するには、aws codepipeline poll-for-jobs を使用します。 コマンド: ``` aws codepipeline acknowledge-job --job-id f4f4ff82-2d11-EXAMPLE --nonce 3 ``` 出力: ``` { "status": "InProgress" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AcknowledgeJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/acknowledge-job.html)」を参照してください。 ### `create-custom-action-type` 次のコード例は、`create-custom-action-type` を使用する方法を示しています。 **AWS CLI** **カスタムアクションを作成するには** この例では、カスタムアクションの構造を含む、作成済みの JSON ファイル (ここでは MyCustomAction.json) を使用して AWS CodePipeline のカスタムアクションを作成しています。ファイルの構造など、カスタムアクションを作成するための要件の詳細については、「AWS CodePipeline ユーザーガイド」を参照してください。 ``` aws codepipeline create-custom-action-type --cli-input-json file://MyCustomAction.json ``` 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 } } ``` このコマンドは、カスタムアクションの構造を返します。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCustomActionType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/create-custom-action-type.html)」を参照してください。 ### `create-pipeline` 次のコード例は、`create-pipeline` を使用する方法を示しています。 **AWS CLI** **パイプラインを作成するには** この例では、パイプラインの構造を含む作成済みの JSON ファイル (ここでは MySecondPipeline.json) を使用して AWS CodePipeline にパイプラインを作成しています。ファイルの構造など、パイプラインを作成するための要件の詳細については、「AWS CodePipeline ユーザーガイド」を参照してください。 コマンド: ``` aws codepipeline create-pipeline --cli-input-json file://MySecondPipeline.json ``` 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 } } ``` 出力: ``` This command returns the structure of the pipeline. ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreatePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/create-pipeline.html)」を参照してください。 ### `delete-custom-action-type` 次のコード例は、`delete-custom-action-type` を使用する方法を示しています。 **AWS CLI** **カスタムアクションを削除するには** この例では、削除するアクションのタイプ、プロバイダー名、バージョン番号を含む、作成済みの JSON ファイル (ここでは DeleteMyCustomAction.json) を使用して、AWS CodePipeline のカスタムアクションを削除しています。list-action-types コマンドを使用して、カテゴリ、バージョン、プロバイダーの正しい値を表示します。 コマンド: ``` aws codepipeline delete-custom-action-type --cli-input-json file://DeleteMyCustomAction.json ``` JSON ファイルのサンプルの内容: ``` { "category": "Build", "version": "1", "provider": "MyJenkinsProviderName" } ``` 出力: ``` None. ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCustomActionType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/delete-custom-action-type.html)」を参照してください。 ### `delete-pipeline` 次のコード例は、`delete-pipeline` を使用する方法を示しています。 **AWS CLI** **パイプラインを削除するには** この例では、AWS CodePipeline から MySecondPipeline という名前のパイプラインを削除しています。list-pipelines コマンドを使用して、AWS アカウントに関連付けられているパイプラインのリストを表示します。 コマンド: ``` aws codepipeline delete-pipeline --name MySecondPipeline ``` 出力: ``` None. ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeletePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/delete-pipeline.html)」を参照してください。 ### `delete-webhook` 次のコード例は、`delete-webhook` を使用する方法を示しています。 **AWS CLI** **ウェブフックを削除するには** 次の `delete-webhook` の例では、GitHub バージョン 1 ソースアクションのウェブフックを削除します。ウェブフックを削除する前に、`deregister-webhook-with-third-party` コマンドを使用してそのウェブフックの登録を解除する必要があります。 ``` aws codepipeline delete-webhook \ --name my-webhook ``` このコマンドでは何も出力されません。 詳細については、「*AWS CodePipeline ユーザーガイド*」の「[Delete the webhook for your GitHub source](https://docs.aws.amazon.com/codepipeline/latest/userguide/appendix-github-oauth.html#pipelines-webhooks-delete)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteWebhook](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/delete-webhook.html)」を参照してください。 ### `deregister-webhook-with-third-party` 次のコード例は、`deregister-webhook-with-third-party` を使用する方法を示しています。 **AWS CLI** **ウェブフックの登録を解除するには** 次の `deregister-webhook-with-third-party` の例では、GitHub バージョン 1 ソースアクションのウェブフックを削除します。ウェブフックを削除する前に、その登録を解除する必要があります。 ``` aws codepipeline deregister-webhook-with-third-party \ --webhook-name my-webhook ``` このコマンドでは何も出力されません。 詳細については、「*AWS CodePipeline ユーザーガイド*」の「[Delete the webhook for your GitHub source](https://docs.aws.amazon.com/codepipeline/latest/userguide/appendix-github-oauth.html#pipelines-webhooks-delete)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeregisterWebhookWithThirdParty](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/deregister-webhook-with-third-party.html)」を参照してください。 ### `disable-stage-transition` 次のコード例は、`disable-stage-transition` を使用する方法を示しています。 **AWS CLI** **パイプライン内のステージへの移行を無効にするには** この例では、AWS CodePipeline の MyFirstPipeline パイプラインのベータステージへの移行を無効にしています。 コマンド: ``` aws codepipeline disable-stage-transition --pipeline-name MyFirstPipeline --stage-name Beta --transition-type Inbound ``` 出力: ``` None. ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisableStageTransition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/disable-stage-transition.html)」を参照してください。 ### `enable-stage-transition` 次のコード例は、`enable-stage-transition` を使用する方法を示しています。 **AWS CLI** **パイプライン内のステージへの移行を有効にするには** この例では、AWS CodePipeline の MyFirstPipeline パイプラインのベータステージへの移行を有効にしています。 コマンド: ``` aws codepipeline enable-stage-transition --pipeline-name MyFirstPipeline --stage-name Beta --transition-type Inbound ``` 出力: ``` None. ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EnableStageTransition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/enable-stage-transition.html)」を参照してください。 ### `get-job-details` 次のコード例は、`get-job-details` を使用する方法を示しています。 **AWS CLI** **ジョブの詳細を取得するには** この例では、ID が f4f4ff82-2d11-EXAMPLE で表されるジョブに関する詳細を返しています。このコマンドはカスタムアクションにのみ使用されます。このコマンドが呼び出されると、カスタムアクションに必要な場合、AWS CodePipeline はパイプラインのアーティファクトを保存するために使用される Amazon S3 バケットの一時的な認証情報を返します。このコマンドは、アクションに定義されているシークレット値がある場合は、それも返します。 コマンド: ``` aws codepipeline get-job-details --job-id f4f4ff82-2d11-EXAMPLE ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetJobDetails](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/get-job-details.html)」を参照してください。 ### `get-pipeline-state` 次のコード例は、`get-pipeline-state` を使用する方法を示しています。 **AWS CLI** **パイプラインの状態に関する情報を取得するには** この例では、MyFirstPipeline という名前のパイプラインの最新の状態を返しています。 コマンド: ``` aws codepipeline get-pipeline-state --name MyFirstPipeline ``` 出力: ``` { "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 } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPipelineState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/get-pipeline-state.html)」を参照してください。 ### `get-pipeline` 次のコード例は、`get-pipeline` を使用する方法を示しています。 **AWS CLI** **パイプラインの構造を表示するには** この例では、MyFirstPipeline という名前のパイプラインの構造を返しています。 コマンド: ``` aws codepipeline get-pipeline --name MyFirstPipeline ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/get-pipeline.html)」を参照してください。 ### `list-action-executions` 次のコード例は、`list-action-executions` を使用する方法を示しています。 **AWS CLI** **アクション実行を一覧表示するには** 次の `list-action-executions` の例では、パイプラインのアクションの実行に関する詳細として、アクション実行 ID、入力アーティファクト、出力アーティファクト、実行結果、ステータスなどを表示しています。 ``` aws codepipeline list-action-executions \ --pipeline-name myPipeline ``` 出力: ``` { "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" } } }, . . . . ``` 詳細については、「*AWS CodePipeline ユーザーガイド*」の「[View action executions (CLI)](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-view-cli.html#pipelines-action-executions-cli)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListActionExecutions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-action-executions.html)」を参照してください。 ### `list-action-types` 次のコード例は、`list-action-types` を使用する方法を示しています。 **AWS CLI** **使用可能なアクションタイプを表示するには** 単独で使用する list-action-types コマンドは、AWS アカウントで使用できるすべてのアクションの構造を返します。この例では、--action-owner-filter オプションを使用して、カスタムアクションのみを返しています。 コマンド: ``` aws codepipeline list-action-types --action-owner-filter Custom ``` 出力: ``` { "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}" } } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListActionTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-action-types.html)」を参照してください。 ### `list-pipeline-executions` 次のコード例は、`list-pipeline-executions` を使用する方法を示しています。 **AWS CLI** **パイプラインの実行履歴を表示するには** 次の `list-pipeline-executions` の例では、AWS アカウントのパイプラインのパイプライン実行履歴を表示しています。 ``` aws codepipeline list-pipeline-executions \ --pipeline-name MyPipeline ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS CodePipeline ユーザーガイド*」の「[View execution history](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-view-cli.html#pipelines-executions-cli)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPipelineExecutions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-pipeline-executions.html)」を参照してください。 ### `list-pipelines` 次のコード例は、`list-pipelines` を使用する方法を示しています。 **AWS CLI** **パイプラインのリストを表示するには** この例では、ユーザーの AWS アカウントに関連付けられているすべての AWS CodePipeline パイプラインを一覧表示しています。 コマンド: ``` aws codepipeline list-pipelines ``` 出力: ``` { "pipelines": [ { "updated": 1439504274.641, "version": 1, "name": "MyFirstPipeline", "created": 1439504274.641 }, { "updated": 1436461837.992, "version": 2, "name": "MySecondPipeline", "created": 1436460801.381 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPipelines](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-pipelines.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **タグを一覧表示するには** 次の `list-tags-for-resource` の例では、指定されたパイプラインリソースにアタッチされたすべてのタグのリストを取得しています。 ``` aws codepipeline list-tags-for-resource \ --resource-arn arn:aws:codepipeline:us-east-1:123456789012:MyPipeline ``` 出力: ``` { "tags": { "Project": "ProjectA", "IscontainerBased": "true" } } ``` 詳細については、「*AWS CodePipeline ユーザーガイド*」の「[View tags for a pipeline (CLI)](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-tag.html#pipelines-tag-list-cli)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-tags-for-resource.html)」を参照してください。 ### `list-webhooks` 次のコード例は、`list-webhooks` を使用する方法を示しています。 **AWS CLI** **ウェブフックを一覧表示するには** 次の `list-webhooks` の例では、指定されたパイプラインリソースにアタッチされたすべてのタグのリストを取得しています。 ``` aws codepipeline list-webhooks \ --endpoint-url "https://codepipeline.eu-central-1.amazonaws.com" \ --region "eu-central-1" ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS CodePipeline ユーザーガイド*」の「[List webhooks in your account](https://docs.aws.amazon.com/codepipeline/latest/userguide/appendix-github-oauth.html#pipelines-webhooks-view)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListWebhooks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/list-webhooks.html)」を参照してください。 ### `poll-for-jobs` 次のコード例は、`poll-for-jobs` を使用する方法を示しています。 **AWS CLI** **使用可能なジョブを表示するには** この例では、ジョブワーカーが実行するジョブに関する情報を返しています。この例では、事前定義済みの JSON ファイル (MyActionTypeInfo.json) を使用して、ジョブワーカーがジョブを処理するアクションタイプに関する情報を提供しています。このコマンドはカスタムアクションにのみ使用されます。このコマンドが呼び出されると、AWS CodePipeline はパイプラインのアーティファクトを保存するために使用される Amazon S3 バケットの一時的な認証情報を返します。このコマンドは、アクションに定義されているシークレット値がある場合は、それも返します。 コマンド: ``` aws codepipeline poll-for-jobs --cli-input-json file://MyActionTypeInfo.json ``` JSON ファイルのサンプルの内容: ``` { "actionTypeId": { "category": "Test", "owner": "Custom", "provider": "MyJenkinsProviderName", "version": "1" }, "maxBatchSize": 5, "queryParam": { "ProjectName": "MyJenkinsTestProject" } } ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PollForJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/poll-for-jobs.html)」を参照してください。 ### `put-webhook` 次のコード例は、`put-webhook` を使用する方法を示しています。 **AWS CLI** **ウェブフックを作成するには** 次の `put-webhook` の例では、GitHub バージョン 1 ソースアクションのウェブフックを作成しています。ウェブフックを作成したら、register-webhook-with-third-party コマンドを使用してウェブフックを登録する必要があります。 ``` aws codepipeline put-webhook \ --cli-input-json file://webhook_json.json \ --region "eu-central-1" ``` `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" } } } ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS CodePipeline ユーザーガイド*」の「[Create a webhook for a GitHub source](https://docs.aws.amazon.com/codepipeline/latest/userguide/appendix-github-oauth.html#pipelines-webhooks-create)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutWebhook](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/put-webhook.html)」を参照してください。 ### `retry-stage-execution` 次のコード例は、`retry-stage-execution` を使用する方法を示しています。 **AWS CLI** **失敗したアクションを再試行するには** 次の `retry-stage-execution` の例では、失敗したアクションを持つステージを再試行しています。 ``` aws codepipeline retry-stage-execution \ --pipeline-name MyPipeline \ --stage-name Deploy \ --pipeline-execution-id b59babff-5f34-EXAMPLE \ --retry-mode FAILED_ACTIONS ``` 出力: ``` { "pipelineExecutionId": "b59babff-5f34-EXAMPLE" } ``` 詳細については、「*AWS CodePipeline ユーザーガイド*」の「[Retry failed actions (CLI)](https://docs.aws.amazon.com/codepipeline/latest/userguide/actions-retry.html#actions-retry-cli)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RetryStageExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/retry-stage-execution.html)」を参照してください。 ### `start-pipeline-execution` 次のコード例は、`start-pipeline-execution` を使用する方法を示しています。 **AWS CLI** **パイプラインを介して最新のリビジョンを実行するには** この例では、「MyFirstPipeline」という名前のパイプラインを介して、パイプラインのソースステージに存在する最新のリビジョンを実行しています。 コマンド: ``` aws codepipeline start-pipeline-execution --name MyFirstPipeline ``` 出力: ``` { "pipelineExecutionId": "3137f7cb-7cf7-EXAMPLE" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartPipelineExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/start-pipeline-execution.html)」を参照してください。 ### `stop-pipeline-execution` 次のコード例は、`stop-pipeline-execution` を使用する方法を示しています。 **AWS CLI** **パイプライン実行を停止するには** 次の `stop-pipeline-execution` の例では、デフォルトで進行中のアクションが完了するまで待機し、その後パイプラインを停止しています。実行がすでに [停止] 状態になっている場合、[Stop and wait (停止して待機)] を選択することはできません。実行がすでに [停止] 状態になっている場合、[Stop and abandon (停止して中止)] を選択することはできません。 ``` aws codepipeline stop-pipeline-execution \ --pipeline-name MyFirstPipeline \ --pipeline-execution-id d-EXAMPLE \ --reason "Stopping pipeline after the build action is done" ``` このコマンドは出力なしを返します。 詳細については、「*AWS CodePipeline ユーザーガイド*」の「[Stop a pipeline execution (CLI)](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-stop.html#pipelines-stop-cli)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopPipelineExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/stop-pipeline-execution.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **リソースにタグを付けるには** 次の `tag-resource` の例では、提供されたタグのセットをパイプラインに関連付けています。このコマンドを使用して、タグを追加または編集します。 ``` aws codepipeline tag-resource \ --resource-arn arn:aws:codepipeline:us-east-1:123456789012:MyPipeline \ --tags key=Project,value=ProjectA key=IscontainerBased,value=true ``` このコマンドでは何も出力されません。 詳細については、「*AWS CodePipeline ユーザーガイド*」の「[Add tags to a pipeline (CLI)](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-tag.html#pipelines-tag-add-cli)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンス**の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **接続リソースから AWS のタグを削除するには** 次の `untag-resource` の例では、指定されたリソースからタグを削除しています。 ``` aws codepipeline untag-resource \ --resource-arn arn:aws:codepipeline:us-east-1:123456789012:MyPipeline \ --tag-keys Project IscontainerBased ``` このコマンドでは何も出力されません。 詳細については、「*AWS CodePipeline ユーザーガイド*」の「[Remove tags from a pipeline (CLI)](https://docs.aws.amazon.com/codepipeline/latest/userguide/pipelines-tag.html#pipelines-tag-delete-cli)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/untag-resource.html)」を参照してください。 ### `update-pipeline` 次のコード例は、`update-pipeline` を使用する方法を示しています。 **AWS CLI** **パイプラインの構造を更新するには** この例では、update-pipeline コマンドで --cli-input-json 引数を使用しています。この例では、事前定義済みの JSON ファイル (MyFirstPipeline.json) を使用してパイプラインの構造を更新しています。AWSCodePipeline は JSON ファイルに含まれるパイプライン名を認識し、パイプライン構造の変更されたフィールドの変更を適用してパイプラインを更新します。 事前定義された JSON ファイルを作成するときは、次のガイドラインを使用します。 get-pipeline コマンドを使用して取得したパイプライン構造を使用する場合は、JSON ファイル内のパイプライン構造からメタデータセクション (「metadata」: \$1 \$1 行と、「created」、「pipelineARN」、「updated」フィールド) を削除する必要があります。パイプライン名は変更できません。 コマンド: ``` aws codepipeline update-pipeline --cli-input-json file://MyFirstPipeline.json ``` サンプル 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 } } ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdatePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codepipeline/update-pipeline.html)」を参照してください。 # AWS CLI を使用した AWS CodeStar Notifications の例 次のコード例は、AWS CodeStar Notifications で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-notification-rule` 次のコード例は、`create-notification-rule` を使用する方法を示しています。 **AWS CLI** **通知ルールを作成するには** 次の `create-notification-rule` の例では、`rule.json` という名前の JSON ファイルを使用して、指定された AWS アカウントで `MyDemoRepo` という名前のリポジトリに `MyNotificationRule` という名前の通知ルールを作成しています。ブランチとタグが作成されると、詳細タイプが `FULL` の通知が指定されたターゲットである Amazon SNS トピックに送信されます。 ``` aws codestar-notifications create-notification-rule \ --cli-input-json file://rule.json ``` `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" } ``` 出力: ``` { "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE" } ``` 詳細については、「*AWS Developer Tools Console ユーザーガイド*」の「[Create a Notification rule](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateNotificationRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/create-notification-rule.html)」を参照してください。 ### `delete-notification-rule` 次のコード例は、`delete-notification-rule` を使用する方法を示しています。 **AWS CLI** **通知ルールを削除するには** 次の `delete-notification-rule` の例では、指定された通知ルールを削除しています。 ``` aws codestar-notifications delete-notification-rule \ --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE ``` 出力: ``` { "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE" } ``` 詳細については、「*AWS Developer Tools Console ユーザーガイド*」の「[Delete a Notification Rule](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteNotificationRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/delete-notification-rule.html)」を参照してください。 ### `delete-target` 次のコード例は、`delete-target` を使用する方法を示しています。 **AWS CLI** **通知ルールのターゲットを削除するには** 次の `delete-target` の例では、指定したターゲットを、ターゲットとして使用するように設定されているすべての通知ルールから削除し、次にそのターゲットも削除しています。 ``` aws codestar-notifications delete-target \ --target-address arn:aws:sns:us-east-1:123456789012:MyNotificationTopic \ --force-unsubscribe-all ``` このコマンドでは何も出力されません。 詳細については、「*AWS Developer Tools Console ユーザーガイド*」の「[Delete a Notification Rule Target](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-target-delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/delete-target.html)」を参照してください。 ### `describe-notification-rule` 次のコード例は、`describe-notification-rule` を使用する方法を示しています。 **AWS CLI** **通知ルールの詳細を取得するには** 次の `describe-notification-rule` の例では、指定された通知ルールの詳細を取得しています。 ``` aws codestar-notifications describe-notification-rule \ --arn arn:aws:codestar-notifications:us-west-2:123456789012:notificationrule/dc82df7a-EXAMPLE ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Developer Tools Console ユーザーガイド*」の「[View Notification Rules](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-view.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeNotificationRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/describe-notification-rule.html)」を参照してください。 ### `list-event-types` 次のコード例は、`list-event-types` を使用する方法を示しています。 **AWS CLI** **通知ルールのイベントタイプのリストを取得するには** 次の `list-event-types` の例では、CodeDeploy アプリケーションで使用可能なすべての通知イベントタイプのフィルタリングされたリストを取得しています。フィルターを使用しない場合、コマンドはすべてのリソースタイプに対するすべての通知イベントタイプを返します。 ``` aws codestar-notifications list-event-types \ --filters Name=SERVICE_NAME,Value=CodeDeploy ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS Developer Tools Console ユーザーガイド*」の「[Create a Notification Rule](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListEventTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/list-event-types.html)」を参照してください。 ### `list-notification-rules` 次のコード例は、`list-notification-rules` を使用する方法を示しています。 **AWS CLI** **通知ルールのリストを取得するには** 次の `list-notification-rules` の例では、指定された AWS リージョン内におけるすべての通知ルールのリストを取得しています。 ``` aws codestar-notifications list-notification-rules --region us-east-1 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS Developer Tools Console ユーザーガイド*」の「[View Notification Rules](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-view.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListNotificationRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/list-notification-rules.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **通知ルールにアタッチされたタグのリストを取得するには** 次の `list-tags-for-resource` の例では、指定された通知ルールにアタッチされたすべてのタグのリストを取得しています。この例では現在、通知ルールに関連付けられているタグがありません。 ``` aws codestar-notifications list-tags-for-resource \ --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE ``` 出力: ``` { "Tags": {} } ``` 詳細については、「*AWS Developer Tools Console ユーザーガイド*」の「[Create a Notification Rule](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-create.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/list-tags-for-resource.html)」を参照してください。 ### `list-targets` 次のコード例は、`list-targets` を使用する方法を示しています。 **AWS CLI** **通知ルールのターゲットのリストを取得するには** 次の `list-targets` の例では、指定された AWS リージョン内におけるすべての通知ルールのターゲットのリストを取得しています。 ``` aws codestar-notifications list-targets \ --region us-east-1 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS Developer Tools Console ユーザーガイド*」の「[View Notification Rule Targets](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-target-view.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/list-targets.html)」を参照してください。 ### `subscribe` 次のコード例は、`subscribe` を使用する方法を示しています。 **AWS CLI** **通知ルールにターゲットを追加するには** 次の `subscribe` の例では、指定された通知ルールのターゲットとして Amazon SNS トピックを追加しています。 ``` 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 ``` 出力: ``` { "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE" } ``` 詳細については、「*AWSDeveloper Tools Console ユーザーガイド*」の「[Add or Remove an Amazon SNS Topic as a Target for a Notification Rule](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-target-change-rule.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[Subscribe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/subscribe.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **通知ルールにタグを追加するには** 次の `tag-resource` の例では、指定された通知ルールにキー名が `Team`、値が `Li_Juan` のタグを追加しています。 ``` aws codestar-notifications tag-resource \ --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE \ --tags Team=Li_Juan ``` 出力: ``` { "Tags": { "Team": "Li_Juan" } } ``` 詳細については、「*AWS Developer Tools Console ユーザーガイド*」の「[Create a Notification Rule](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/tag-resource.html)」を参照してください。 ### `unsubscribe` 次のコード例は、`unsubscribe` を使用する方法を示しています。 **AWS CLI** **通知ルールからターゲットを削除するには** 次の `unsubscribe` の例では、指定された通知ルールのターゲットである Amazon SNS トピックを削除しています。 ``` 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 ``` 出力: ``` { "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE" "TargetAddress": "arn:aws:sns:us-east-1:123456789012:MyNotificationTopic" } ``` 詳細については、「*AWSDeveloper Tools Console ユーザーガイド*」の「[Add or Remove an Amazon SNS Topic as a Target for a Notification Rule](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-target-change-rule.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[Unsubscribe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/unsubscribe.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **通知ルールからタグを削除するには** 次の `untag-resource` の例では、指定された通知ルールからキー名が `Team` のタグを削除しています。 ``` aws codestar-notifications untag-resource \ --arn arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/fe1efd35-EXAMPLE \ --tag-keys Team ``` このコマンドでは何も出力されません。 詳細については、「*AWS Developer Tools console ユーザーガイド*」の「[Edit a Notification Rule](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/notification-rule-edit.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/untag-resource.html)」を参照してください。 ### `update-notification-rule` 次のコード例は、`update-notification-rule` を使用する方法を示しています。 **AWS CLI** **通知ルールを更新するには** 次の `update-notification-rule` の例では、`update.json` という名前の JSON ファイルを使用して、AWS アカウント `123456789012` で `MyNotificationRule` という名前の通知ルールを更新しています。 ``` aws codestar-notifications update-notification-rule \ --cli-input-json file://update.json ``` `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" } ``` 出力: ``` { "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE" } ``` 詳細については、「*AWS Developer Tools console ユーザーガイド*」の「[Edit a notification rule](https://docs.aws.amazon.com/dtconsole/latest/userguide/notification-rule-edit.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateNotificationRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-notifications/update-notification-rule.html)」を参照してください。 # AWS CLI を使用した CodeConnections の例 次のコード例は、CodeConnections で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-connection` 次のコード例は、`create-connection` を使用する方法を示しています。 **AWS CLI** **接続を作成するには** 次の `create-connection` の例では、サードパーティーのリポジトリへの接続を作成する方法を示しています。この例では、サードパーティーのプロバイダーが Bitbucket である接続を作成しています。 AWS CLI または AWS CloudFormation を使用して作成された接続は、デフォルトで [保留中] ステータスになっています。CLI または AWS CloudFormation を使用して接続を作成した後、コンソールを使用して接続を編集し、ステータスを [使用可能] にします。 ``` aws codestar-connections create-connection \ --provider-type Bitbucket \ --connection-name MyConnection ``` 出力: ``` { "ConnectionArn": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f" } ``` 詳細については、「*Developer Tools console ユーザーガイド*」の「[Create a connection](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/create-connection.html)」を参照してください。 ### `create-host` 次のコード例は、`create-host` を使用する方法を示しています。 **AWS CLI** **ホストを作成するには** 次の `create-host` の例では、ホストを作成して、サードパーティーのプロバイダーがインストールされているインフラストラクチャのエンドポイントを表す方法を示しています。この例では、サードパーティーのインストールされたプロバイダーが GitHub Enterprise Server であるホストを作成しています。 AWS CLI で作成されたホストは、デフォルトでステータスが [保留中] になっています。CLI でホストを作成した後、コンソールまたは CLI を使用してホストを設定し、ステータスを [使用可能] にします。 ``` aws codestar-connections create-host \ --name MyHost \ --provider-type GitHubEnterpriseServer \ --provider-endpoint "https://my-instance.dev" ``` 出力: ``` { "HostArn": "arn:aws:codestar-connections:us-east-1:123456789012:host/My-Host-28aef605" } ``` 詳細については、「*Developer Tools console ユーザーガイド*」の「[Create a host (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-host-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateHost](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/create-host.html)」を参照してください。 ### `delete-connection` 次のコード例は、`delete-connection` を使用する方法を示しています。 **AWS CLI** **接続を削除するには** 次の `delete-connection` の例では、接続を削除する方法を示しています。 ``` aws codestar-connections delete-connection \ --connection-arn arn:aws:codestar-connections:us-west-2:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f ``` このコマンドでは何も出力されません。 詳細については、「*Developer Tools console ユーザーガイド*」の「[Delete a connection (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-delete.html#connections-delete-cli)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/delete-connection.html)」を参照してください。 ### `delete-host` 次のコード例は、`delete-host` を使用する方法を示しています。 **AWS CLI** **ホストを削除するには** 次の `delete-host` の例では、ホストを削除する方法を示しています。ホストを削除する前に、ホストに関連付けられたすべての接続を削除する必要があります。 ``` aws codestar-connections delete-host \ --host-arn "arn:aws:codestar-connections:us-east-1 :123456789012:host/My-Host-28aef605" ``` このコマンドでは何も出力されません。 詳細については、「*Developer Tools console ユーザーガイド*」の「[Delete a host (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-host-delete.html#connections-host-delete-cli)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteHost](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/delete-host.html)」を参照してください。 ### `get-connection` 次のコード例は、`get-connection` を使用する方法を示しています。 **AWS CLI** **接続に関する情報を取得するには** 次の `get-connection` の例では、接続の詳細を示します。 ``` aws codestar-connections get-connection \ --connection-arn arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f ``` 出力: ``` { "Connection": { "ConnectionName": "MyConnection", "ConnectionArn": "arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f", "ProviderType": "Bitbucket", "OwnerAccountId": "123456789012", "ConnectionStatus": "AVAILABLE" } } ``` 詳細については、「*Developer Tools console ユーザーガイド*」の「[View connection details](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-view-details.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/get-connection.html)」を参照してください。 ### `get-host` 次のコード例は、`get-host` を使用する方法を示しています。 **AWS CLI** **ホストに関する情報を取得するには** 次の `get-host` の例では、ホストの詳細を示します。 ``` aws codestar-connections get-host \ --host-arn arn:aws:codestar-connections:us-east-1:123456789012:host/MyHost-28aef605 ``` 出力: ``` { "Name": "MyHost", "Status": "AVAILABLE", "ProviderType": "GitHubEnterpriseServer", "ProviderEndpoint": "https://test-instance-1.dev/" } ``` 詳細については、「*Developer Tools console ユーザーガイド*」の「[View host details (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-host-view.html#connections-host-view-cli)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetHost](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/get-host.html)」を参照してください。 ### `list-connections` 次のコード例は、`list-connections` を使用する方法を示しています。 **AWS CLI** **接続を一覧表示するには** 次の `list-connections` の例では、Bitbucket プロバイダタイプのアカウント内のすべての接続のリストを取得しています。 ``` aws codestar-connections list-connections \ --provider-type Bitbucket \ --max-results 5 \ --next-token: next-token ``` 出力: ``` { "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" } ``` 詳細については、「*Developer Tools console ユーザーガイド*」の「[List connections (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-list.html#connections-list-cli)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/list-connections.html)」を参照してください。 ### `list-hosts` 次のコード例は、`list-hosts` を使用する方法を示しています。 **AWS CLI** **ホストを一覧表示するには** 次の `list-hosts` の例では、アカウント内のすべてのホストのリストを取得しています。 ``` aws codestar-connections list-hosts ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Developer Tools console ユーザーガイド*」の「[List hosts (CLI)](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-host-list.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListHosts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/list-hosts.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **タグを一覧表示するには** 次の `list-tags-for-resource` の例では、指定された接続リソースにアタッチされたすべてのタグのリストを取得しています。 ``` aws codestar-connections list-tags-for-resource \ --resource-arn arn:aws:codestar-connections:us-east-1:123456789012:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f ``` 出力: ``` { "Tags": [ { "Key": "Project", "Value": "ProjectA" }, { "Key": "ReadOnly", "Value": "true" } ] } ``` 詳細については、「*Developer Tools console ユーザーガイド*」の「[View tags for a connections resource](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-tag.html#connections-tag-view)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/list-tags-for-resource.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **リソースにタグを付けるには** 次の `tag-resource` の例では、提供されたタグのセットを接続に関連付けています。このコマンドを使用して、タグを追加または編集します。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*Developer Tools console ユーザーガイド*」の「[Add tags to a connections resource](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-tag.html#connections-tag-add)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンス**の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **接続リソースから AWS のタグを削除するには** 次の `untag-resource` では、指定されたリソースからタグを削除しています。 ``` 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 ``` 出力: ``` { "Tags": [] } ``` 詳細については、「*Developer Tools console ユーザーガイド*」の「[Remove tags from a connections resource](https://docs.aws.amazon.com/dtconsole/latest/userguide/connections-tag.html#connections-tag-delete)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/codestar-connections/untag-resource.html)」を参照してください。 # AWS CLI を使用した Amazon Cognito ID の例 次のコード例は、Amazon Cognito ID で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-identity-pool` 次のコード例は、`create-identity-pool` を使用する方法を示しています。 **AWS CLI** **Cognito アイデンティティプールプロバイダーを含むアイデンティティプールを作成するには** この例では MyIdentityPool という名前のアイデンティティプールを作成します。これには Cognito アイデンティティプールプロバイダーが含まれます。認証されていないアイデンティティは許可されません。 コマンド: ``` 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 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateIdentityPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/create-identity-pool.html)」を参照してください。 ### `delete-identities` 次のコード例は、`delete-identities` を使用する方法を示しています。 **AWS CLI** **アイデンティティプールを削除するには** この例ではアイデンティティプールを削除しています。 コマンド: ``` aws cognito-identity delete-identity-pool --identity-ids-to-delete "us-west-2:11111111-1111-1111-1111-111111111111" ``` 出力: ``` { "UnprocessedIdentityIds": [] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteIdentities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/delete-identities.html)」を参照してください。 ### `delete-identity-pool` 次のコード例は、`delete-identity-pool` を使用する方法を示しています。 **AWS CLI** **アイデンティティプールを削除するには** 次の `delete-identity-pool` 例では、指定したアイデンティティプールを削除します。 コマンド: ``` aws cognito-identity delete-identity-pool \ --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111" ``` このコマンドでは何も出力されません。 + API の詳細については、AWS CLI コマンドリファレンスの「[DeleteIdentityPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/delete-identity-pool.html)」を参照してください。** ### `describe-identity-pool` 次のコード例は、`describe-identity-pool` を使用する方法を示しています。 **AWS CLI** **アイデンティティプールを記述するには** この例では、アイデンティティプールをを記述します。 コマンド: ``` aws cognito-identity describe-identity-pool --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111" ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeIdentityPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/describe-identity-pool.html)」を参照してください。 ### `get-identity-pool-roles` 次のコード例は、`get-identity-pool-roles` を使用する方法を示しています。 **AWS CLI** **アイデンティティプールのロールを取得するには** この例ではアイデンティティプールのロールを取得しています。 コマンド: ``` aws cognito-identity get-identity-pool-roles --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111" ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetIdentityPoolRoles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/get-identity-pool-roles.html)」を参照してください。 ### `list-identity-pools` 次のコード例は、`list-identity-pools` を使用する方法を示しています。 **AWS CLI** **アイデンティティプールを一覧表示するには** この例ではアイデンティティプールを一覧表示します。最大 20 個のアイデンティティが一覧表示されます。 コマンド: ``` aws cognito-identity list-identity-pools --max-results 20 ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListIdentityPools](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/list-identity-pools.html)」を参照してください。 ### `set-identity-pool-roles` 次のコード例は、`set-identity-pool-roles` を使用する方法を示しています。 **AWS CLI** **アイデンティティプールのロールを設定するには** 次の `set-identity-pool-roles` の例では、アイデンティティプールのロールを設定しています。 ``` 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" ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetIdentityPoolRoles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/set-identity-pool-roles.html)」を参照してください。 ### `update-identity-pool` 次のコード例は、`update-identity-pool` を使用する方法を示しています。 **AWS CLI** **アイデンティティプールを更新するには** この例では、アイデンティティプールを更新しています。名前を「MyIdentityPool」に設定します。Cognito をアイデンティティプロバイダとして追加します。認証されていないアイデンティティは許可されません。 コマンド: ``` 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 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateIdentityPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-identity/update-identity-pool.html)」を参照してください。 # AWS CLI を使用する Amazon Cognito ID プロバイダーの例 次のコード例は、Amazon Cognito ID プロバイダーで AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `add-custom-attributes` 次のコード例は、`add-custom-attributes` を使用する方法を示しています。 **AWS CLI** **カスタム属性を追加するには** この例では、カスタム属性 CustomAttr1 をユーザープールに追加しています。これは文字列型のため、1 文字以上 15 文字以下にする必要があります。この値は必須ではありません。 コマンド: ``` 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}" ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddCustomAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/add-custom-attributes.html)」を参照してください。 ### `admin-add-user-to-group` 次のコード例は、`admin-add-user-to-group` を使用する方法を示しています。 **AWS CLI** **ユーザーをグループに追加するには** この例では、MyGroup にユーザー Jane を追加しています。 コマンド: ``` aws cognito-idp admin-add-user-to-group --user-pool-id us-west-2_aaaaaaaaa --username Jane --group-name MyGroup ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AdminAddUserToGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-add-user-to-group.html)」を参照してください。 ### `admin-confirm-sign-up` 次のコード例は、`admin-confirm-sign-up` を使用する方法を示しています。 **AWS CLI** **ユーザー登録を確認するには** この例では、ユーザー jane@example.com を確認しています。 コマンド: ``` aws cognito-idp admin-confirm-sign-up --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AdminConfirmSignUp](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-confirm-sign-up.html)」を参照してください。 ### `admin-create-user` 次のコード例は、`admin-create-user` を使用する方法を示しています。 **AWS CLI** **ユーザーを作成するには** 次の `admin-create-user` の例では、指定された設定の E メールアドレスと電話番号のユーザーを作成しています。 ``` 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 ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AdminCreateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-create-user.html)」を参照してください。 ### `admin-delete-user-attributes` 次のコード例は、`admin-delete-user-attributes` を使用する方法を示しています。 **AWS CLI** **ユーザー属性を削除するには** この例では、ユーザー diego@example.com のカスタム属性 CustomAttr1 を削除しています。 コマンド: ``` aws cognito-idp admin-delete-user-attributes --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --user-attribute-names "custom:CustomAttr1" ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AdminDeleteUserAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-delete-user-attributes.html)」を参照してください。 ### `admin-delete-user` 次のコード例は、`admin-delete-user` を使用する方法を示しています。 **AWS CLI** **ユーザーを削除するには** この例では、ユーザーを削除します。 コマンド: ``` aws cognito-idp admin-delete-user --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AdminDeleteUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-delete-user.html)」を参照してください。 ### `admin-disable-provider-for-user` 次のコード例は、`admin-disable-provider-for-user` を使用する方法を示しています。 **AWS CLI** **フェデレーションユーザーをローカルユーザープロファイルからリンク解除するには** 次の `admin-disable-provider-for-user` の例では、Google ユーザーをローカルプロファイルからリンク解除します。 ``` aws cognito-idp admin-disable-provider-for-user \ --user-pool-id us-west-2_EXAMPLE \ --user ProviderAttributeName=Cognito_Subject,ProviderAttributeValue=0000000000000000,ProviderName=Google ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[フェデレーションユーザーを既存のユーザープロファイルにリンクする](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation-consolidate-users.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[AdminDisableProviderForUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-disable-provider-for-user.html)」を参照してください。 ### `admin-disable-user` 次のコード例は、`admin-disable-user` を使用する方法を示しています。 **AWS CLI** **ユーザーによるサインインを禁止するには** 次の `admin-disable-user` の例では、ユーザー `diego@example.com` によるサインインを禁止します。 ``` aws cognito-idp admin-disable-user \ --user-pool-id us-west-2_EXAMPLE \ --username diego@example.com ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[ユーザーの管理](https://docs.aws.amazon.com/cognito/latest/developerguide/managing-users.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[AdminDisableUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-disable-user.html)」を参照してください。 ### `admin-enable-user` 次のコード例は、`admin-enable-user` を使用する方法を示しています。 **AWS CLI** **ユーザーによるサインインを有効にするには** 次の `admin-enable-user` の例では、ユーザー diego@example.com によるサインインを有効にします。 ``` aws cognito-idp admin-enable-user \ --user-pool-id us-west-2_EXAMPLE \ --username diego@example.com ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[ユーザーの管理](https://docs.aws.amazon.com/cognito/latest/developerguide/managing-users.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[AdminEnableUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-enable-user.html)」を参照してください。 ### `admin-forget-device` 次のコード例は、`admin-forget-device` を使用する方法を示しています。 **AWS CLI** **デバイスの「記憶済み」状態を解除するには** この例では、ユーザー名 jane@example.com のデバイスの「記憶済み」状態を解除しています コマンド: ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AdminForgetDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-forget-device.html)」を参照してください。 ### `admin-get-device` 次のコード例は、`admin-get-device` を使用する方法を示しています。 **AWS CLI** **デバイスを取得するには** 次の `admin-get-device` の例では、ユーザー `diego` の 1 つのデバイスを表示します。 ``` 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 ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[ユーザープール内のユーザーデバイスの使用](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AdminGetDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-get-device.html)」を参照してください。 ### `admin-get-user` 次のコード例は、`admin-get-user` を使用する方法を示しています。 **AWS CLI** **ユーザーを取得するには** この例では、ユーザー名 jane@example.com に関する情報を取得します。 コマンド: ``` aws cognito-idp admin-get-user --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com ``` 出力: ``` { "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 } ``` + API の詳細については、「AWS CLI コマンドリファレンス」の「[AdminGetUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-get-user.html)」を参照してください。** ### `admin-initiate-auth` 次のコード例は、`admin-initiate-auth` を使用する方法を示しています。 **AWS CLI** **管理者としてユーザーのサインインを許可するには** 次の `admin-initiate-auth` の例では、ユーザー diego@example.com のサインインを許可します。この例には、脅威保護のためのメタデータと Lambda トリガーのための ClientMetadata も含まれています。ユーザーは TOTP MFA 用に設定されており、認証を完了する前に、認証アプリケーションからコードの入力を求めるチャレンジを受け取ります。 ``` 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\"}" ``` 出力: ``` { "ChallengeName": "SOFTWARE_TOKEN_MFA", "Session": "AYABeExample...", "ChallengeParameters": { "FRIENDLY_DEVICE_NAME": "MyAuthenticatorApp", "USER_ID_FOR_SRP": "diego@example.com" } } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[管理認証フロー](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow.html#amazon-cognito-user-pools-admin-authentication-flow)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[AdminInitiateAuth](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-initiate-auth.html)」を参照してください。** ### `admin-link-provider-for-user` 次のコード例は、`admin-link-provider-for-user` を使用する方法を示しています。 **AWS CLI** **ローカルユーザーをフェデレーションユーザーにリンクするには** 次の `admin-link-provider-for-user` の例では、ローカルユーザー diego を、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 ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[フェデレーションユーザーを既存のユーザープロファイルにリンクする](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation-consolidate-users.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[AdminLinkProviderForUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-link-provider-for-user.html)」を参照してください。 ### `admin-list-devices` 次のコード例は、`admin-list-devices` を使用する方法を示しています。 **AWS CLI** **ユーザーのデバイスを一覧表示するには** 次の `admin-list-devices` の例では、ユーザー diego のデバイスを一覧表示します。 ``` aws cognito-idp admin-list-devices \ --user-pool-id us-west-2_EXAMPLE \ --username diego \ --limit 1 ``` 出力: ``` { "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 } ] } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[ユーザープール内のユーザーデバイスの使用](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AdminListDevices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-list-devices.html)」を参照してください。 ### `admin-list-groups-for-user` 次のコード例は、`admin-list-groups-for-user` を使用する方法を示しています。 **AWS CLI** **ユーザーのグループを一覧表示するには** この例では、ユーザー名 jane@example.com のグループを一覧表示しています。 コマンド: ``` aws cognito-idp admin-list-groups-for-user --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AdminListGroupsForUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-list-groups-for-user.html)」を参照してください。 ### `admin-list-user-auth-events` 次のコード例は、`admin-list-user-auth-events` を使用する方法を示しています。 **AWS CLI** **ユーザーの承認イベントを一覧表示するには** 次の `admin-list-user-auth-events` の例では、ユーザー diego の最新のユーザーアクティビティログイベントを一覧表示します。 ``` aws cognito-idp admin-list-user-auth-events \ --user-pool-id us-west-2_ywDJHlIfU \ --username brcotter+050123 \ --max-results 1 ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[ユーザーイベント履歴の表示とエクスポート](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-adaptive-authentication.html#user-pool-settings-adaptive-authentication-event-user-history)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AdminListUserAuthEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-list-user-auth-events.html)」を参照してください。 ### `admin-remove-user-from-group` 次のコード例は、`admin-remove-user-from-group` を使用する方法を示しています。 **AWS CLI** **グループからユーザーを削除するには** この例では、SampleGroup から jane@example.com を削除しています。 コマンド: ``` aws cognito-idp admin-remove-user-from-group --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com --group-name SampleGroup ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AdminRemoveUserFromGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-remove-user-from-group.html)」を参照してください。 ### `admin-reset-user-password` 次のコード例は、`admin-reset-user-password` を使用する方法を示しています。 **AWS CLI** **ユーザーのパスワードをリセットするには** この例では、diego@example.com のパスワードをリセットしています。 コマンド: ``` aws cognito-idp admin-reset-user-password --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AdminResetUserPassword](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-reset-user-password.html)」を参照してください。 ### `admin-respond-to-auth-challenge` 次のコード例は、`admin-respond-to-auth-challenge` を使用する方法を示しています。 **AWS CLI** **認証チャレンジに応答するには** 認証チャレンジに応答する方法は、認証フロー、ユーザープールの設定、ユーザーの設定によって異なります。次の `admin-respond-to-auth-challenge` の例では、diego@example.com の TOTP MFA コードを提供し、サインインを完了する方法を示します。このユーザープールではデバイスの記憶がオンになっているため、認証結果として新しいデバイスキーも返されます。 ``` 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... ``` 出力: ``` { "ChallengeParameters": {}, "AuthenticationResult": { "AccessToken": "eyJra456defEXAMPLE", "ExpiresIn": 3600, "TokenType": "Bearer", "RefreshToken": "eyJra123abcEXAMPLE", "IdToken": "eyJra789ghiEXAMPLE", "NewDeviceMetadata": { "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeviceGroupKey": "-ExAmPlE1" } } } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[管理認証フロー](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow.html#amazon-cognito-user-pools-admin-authentication-flow)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[AdminRespondToAuthChallenge](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-respond-to-auth-challenge.html)」を参照してください。 ### `admin-set-user-mfa-preference` 次のコード例は、`admin-set-user-mfa-preference` を使用する方法を示しています。 **AWS CLI** **ユーザーの MFA を設定するには** この例では、ユーザー名 diego@example.com の SMS MFA 設定を行っています。 コマンド: ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AdminSetUserMfaPreference](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-set-user-mfa-preference.html)」を参照してください。 ### `admin-set-user-password` 次のコード例は、`admin-set-user-password` を使用する方法を示しています。 **AWS CLI** **管理者としてユーザーのパスワードを設定するには** 次の `admin-set-user-password` の例では、diego@example.com のパスワードを永続的に設定します。 ``` aws cognito-idp admin-set-user-password \ --user-pool-id us-west-2_EXAMPLE \ --username diego@example.com \ --password MyExamplePassword1! \ --permanent ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[パスワード、パスワード復旧、パスワードポリシー](https://docs.aws.amazon.com/cognito/latest/developerguide/managing-users-passwords.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[AdminSetUserPassword](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-set-user-password.html)」を参照してください。 ### `admin-set-user-settings` 次のコード例は、`admin-set-user-settings` を使用する方法を示しています。 **AWS CLI** **ユーザー設定を行うには** この例では、ユーザー名 diego@example.com の MFA 配信設定を EMAIL に設定しています。 コマンド: ``` aws cognito-idp admin-set-user-settings --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --mfa-options DeliveryMedium=EMAIL ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AdminSetUserSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-set-user-settings.html)」を参照してください。 ### `admin-update-auth-event-feedback` 次のコード例は、`admin-update-auth-event-feedback` を使用する方法を示しています。 **AWS CLI** **認証イベントにフィードバックを提供するには** この例では、event-id で識別される承認イベントのフィードバック値を Valid に設定します。 コマンド: ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AdminUpdateAuthEventFeedback](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-update-auth-event-feedback.html)」を参照してください。 ### `admin-update-device-status` 次のコード例は、`admin-update-device-status` を使用する方法を示しています。 **AWS CLI** **デバイスステータスを更新するには** この例では、device-key によって識別されるデバイスの記憶状態を not\$1remembered に設定しています。 コマンド: ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AdminUpdateDeviceStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-update-device-status.html)」を参照してください。 ### `admin-update-user-attributes` 次のコード例は、`admin-update-user-attributes` を使用する方法を示しています。 **AWS CLI** **ユーザー属性を更新するには** この例では、ユーザー diego@example.com のカスタムユーザー属性 CustomAttr1 を更新しています。 コマンド: ``` 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" ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AdminUpdateUserAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-update-user-attributes.html)」を参照してください。 ### `admin-user-global-sign-out` 次のコード例は、`admin-user-global-sign-out` を使用する方法を示しています。 **AWS CLI** **管理者としてユーザーのサインアウトを許可するには** 次の `admin-user-global-sign-out` の例では、ユーザー diego@example.com のサインアウトを許可します。 ``` aws cognito-idp admin-user-global-sign-out \ --user-pool-id us-west-2_EXAMPLE \ --username diego@example.com ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[ユーザープールによる認証](https://docs.aws.amazon.com/cognito/latest/developerguide/authentication.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[AdminUserGlobalSignOut](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/admin-user-global-sign-out.html)」を参照してください。 ### `associate-software-token` 次のコード例は、`associate-software-token` を使用する方法を示しています。 **AWS CLI** **MFA 認証アプリケーション用のシークレットキーを生成するには** 次の `associate-software-token` の例では、サインインしてアクセストークンを受け取ったユーザーの TOTP シークレットキーを生成します。生成されたシークレットキーは、認証アプリケーションに手動で入力することも、ユーザーがスキャン可能な QR コードとしてアプリケーションでレンダリングすることもできます。 ``` aws cognito-idp associate-software-token \ --access-token eyJra456defEXAMPLE ``` 出力: ``` { "SecretCode": "QWERTYUIOP123456EXAMPLE" } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[TOTP ソフトウェアトークン MFA](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa-totp.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[AssociateSoftwareToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/associate-software-token.html)」を参照してください。 ### `change-password` 次のコード例は、`change-password` を使用する方法を示しています。 **AWS CLI** **パスワードを変更するには** この例では、パスワードを変更しています。 コマンド: ``` aws cognito-idp change-password --previous-password OldPassword --proposed-password NewPassword --access-token ACCESS_TOKEN ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ChangePassword](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/change-password.html)」を参照してください。 ### `confirm-device` 次のコード例は、`confirm-device` を使用する方法を示しています。 **AWS CLI** **ユーザーデバイスを確認するには** 次の `confirm-device` の例では、現在のユーザー用に新しく記憶されたデバイスを追加します。 ``` 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 ``` 出力: ``` { "UserConfirmationNecessary": false } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[ユーザープール内のユーザーデバイスの使用](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[ConfirmDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/confirm-device.html)」を参照してください。 ### `confirm-forgot-password` 次のコード例は、`confirm-forgot-password` を使用する方法を示しています。 **AWS CLI** **忘れたパスワードを確認するには** この例では、ユーザー名 diego@example.com が忘れたパスワードを確認しています。 コマンド: ``` aws cognito-idp confirm-forgot-password --client-id 3n4b5urk1ft4fl3mg5e62d9ado --username=diego@example.com --password PASSWORD --confirmation-code CONF_CODE ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ConfirmForgotPassword](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/confirm-forgot-password.html)」を参照してください。 ### `confirm-sign-up` 次のコード例は、`confirm-sign-up` を使用する方法を示しています。 **AWS CLI** **サインアップを確認するには** この例では、ユーザー名 diego@example.com のサインアップを確認します。 コマンド: ``` aws cognito-idp confirm-sign-up --client-id 3n4b5urk1ft4fl3mg5e62d9ado --username=diego@example.com --confirmation-code CONF_CODE ``` + API の詳細については、「AWS CLI コマンドリファレンス」の「[ConfirmSignUp](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/confirm-sign-up.html)」を参照してください。** ### `create-group` 次のコード例は、`create-group` を使用する方法を示しています。 **AWS CLI** **グループを作成するには** この例では、説明付きのグループを作成しています。 コマンド: ``` aws cognito-idp create-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyNewGroup --description "New group." ``` 出力: ``` { "Group": { "GroupName": "MyNewGroup", "UserPoolId": "us-west-2_aaaaaaaaa", "Description": "New group.", "LastModifiedDate": 1548270073.795, "CreationDate": 1548270073.795 } } ``` **ロールと優先順位を持つグループを作成するには** この例では、説明付きのグループを作成しています。また、ロールと優先順位も含まれます。 コマンド: ``` 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 ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/create-group.html)」を参照してください。 ### `create-identity-provider` 次のコード例は、`create-identity-provider` を使用する方法を示しています。 **AWS CLI** **例 1: メタデータ URL を使用してユーザープール SAML ID プロバイダー (IdP) を作成するには** 次の `create-identity-provider` の例では、パブリック URL からのメタデータ、属性マッピング、2 つの識別子を使用して、新しい SAML IdP を作成します。 ``` 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 ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[サードパーティー経由のユーザープールへのサインインの追加](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html)」を参照してください。 **例 2: メタデータファイルを使用してユーザープール SAML ID プロバイダー (IdP) を作成するには** 次の `create-identity-provider` の例では、ファイルからのメタデータ、属性マッピング、2 つの識別子を使用して、新しい SAML IdP を作成します。`--provider-details` パラメータのファイル構文はオペレーティングシステムによって異なる場合があります。このオペレーションでは JSON 入力ファイルを作成するのが最も簡単です。 ``` aws cognito-idp create-identity-provider \ --cli-input-json file://.\SAML-identity-provider.json ``` `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" } ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[サードパーティー経由のユーザープールへのサインインの追加](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[CreateIdentityProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/create-identity-provider.html)」を参照してください。 ### `create-resource-server` 次のコード例は、`create-resource-server` を使用する方法を示しています。 **AWS CLI** **ユーザープールのクライアントを作成するには** 次の `create-resource-server` の例では、カスタムスコープを設定した新しいリソースサーバーを作成します。 ``` 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" ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[スコープ、M2M、リソースサーバーを使用した API](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[CreateResourceServer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/create-resource-server.html)」を参照してください。 ### `create-user-import-job` 次のコード例は、`create-user-import-job` を使用する方法を示しています。 **AWS CLI** **ユーザーインポートジョブを作成するには** この例では、MyImportJob という名前のユーザーインポートジョブを作成しています。 ユーザーをインポートする方法の詳細については、「Importing Users into User Pools From a CSV File」を参照してください。 コマンド: ``` 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 ``` 出力: ``` { "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 } } ``` 署名付き URL を使用して、.csv ファイルを curl でアップロードします。 コマンド: ``` curl -v -T "PATH_TO_CSV_FILE" -H "x-amz-server-side-encryption:aws:kms" "PRE_SIGNED_URL" ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateUserImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/create-user-import-job.html)」を参照してください。 ### `create-user-pool-client` 次のコード例は、`create-user-pool-client` を使用する方法を示しています。 **AWS CLI** **ユーザープールのクライアントを作成するには** 次の `create-user-pool-client` の例では、クライアントシークレット、明示的な読み取りおよび書き込み属性、ユーザー名とパスワードおよび SRP フローでのサインイン、3 つの IdP でのサインイン、OAuth スコープのサブセットへのアクセス、PinPoint 分析、拡張認証セッション有効期間を設定した新しいユーザープールクライアントを作成します。 ``` 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 ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[アプリケーションクライアントによるアプリケーション固有の設定](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateUserPoolClient](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/create-user-pool-client.html)」を参照してください。 ### `create-user-pool-domain` 次のコード例は、`create-user-pool-domain` を使用する方法を示しています。 **AWS CLI** **例 1: ユーザープールドメインを作成するには** 次の `create-user-pool-domain` の例では、新しいカスタムドメインを作成します。 ``` 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 ``` 出力: ``` { "CloudFrontDomain": "example1domain.cloudfront.net" } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[ユーザープールドメインの設定](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html)」を参照してください。 **例 2: ユーザープールドメインを作成するには** 次の `create-user-pool-domain` の例では、サービス所有プレフィックスを付加した新しいドメインを作成します。 ``` aws cognito-idp create-user-pool-domain \ --user-pool-id us-west-2_EXAMPLE2 \ --domain mydomainprefix ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[ユーザープールドメインの設定](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateUserPoolDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/create-user-pool-domain.html)」を参照してください。 ### `create-user-pool` 次のコード例は、`create-user-pool` を使用する方法を示しています。 **AWS CLI** **最小構成のユーザープールを作成するには** この例では、デフォルト値を使用して MyUserPool という名前のユーザープールを作成します。必要な属性やアプリケーションクライアントはありません。MFA およびアドバンストセキュリティは無効化されています。 コマンド: ``` aws cognito-idp create-user-pool --pool-name MyUserPool ``` 出力: ``` { "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": {} } } ``` **つの必須属性でユーザープールを作成するには** この例では、ユーザープール MyUserPool を作成します。プールは、E メールをユーザー名属性として受け入れるように設定されています。また、Amazon Simple Email Service を使用して、E メールの送信元アドレスを検証済みのアドレスに設定します。 コマンド: ``` 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" ``` 出力: ``` { "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": {} } } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[CreateUserPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/create-user-pool.html)」を参照してください。** ### `delete-group` 次のコード例は、`delete-group` を使用する方法を示しています。 **AWS CLI** **グループを削除するには** この例では、グループを削除しています。 コマンド: ``` aws cognito-idp delete-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyGroupName ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/delete-group.html)」を参照してください。 ### `delete-identity-provider` 次のコード例は、`delete-identity-provider` を使用する方法を示しています。 **AWS CLI** **ID プロバイダーを削除するには** この例では、ID プロバイダーを削除しています。 コマンド: ``` aws cognito-idp delete-identity-provider --user-pool-id us-west-2_aaaaaaaaa --provider-name Facebook ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteIdentityProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/delete-identity-provider.html)」を参照してください。 ### `delete-resource-server` 次のコード例は、`delete-resource-server` を使用する方法を示しています。 **AWS CLI** **リソースサーバーを削除するには** この例では、weather.example.com という名前のリソースサーバーを削除しています。 コマンド: ``` aws cognito-idp delete-resource-server --user-pool-id us-west-2_aaaaaaaaa --identifier weather.example.com ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteResourceServer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/delete-resource-server.html)」を参照してください。 ### `delete-user-attributes` 次のコード例は、`delete-user-attributes` を使用する方法を示しています。 **AWS CLI** **ユーザー属性を削除するには** 次の `delete-user-attributes` の例では、現在サインインしているユーザーからカスタム属性「custom:attribute」を削除します。 ``` aws cognito-idp delete-user-attributes \ --access-token ACCESS_TOKEN \ --user-attribute-names "custom:department" ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[ユーザー属性の使用](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteUserAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/delete-user-attributes.html)」を参照してください。 ### `delete-user-pool-client` 次のコード例は、`delete-user-pool-client` を使用する方法を示しています。 **AWS CLI** **ユーザープールクライアントを削除するには** この例では、ユーザープールクライアントを削除しています。 コマンド: ``` aws cognito-idp delete-user-pool-client --user-pool-id us-west-2_aaaaaaaaa --client-id 38fjsnc484p94kpqsnet7mpld0 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteUserPoolClient](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/delete-user-pool-client.html)」を参照してください。 ### `delete-user-pool-domain` 次のコード例は、`delete-user-pool-domain` を使用する方法を示しています。 **AWS CLI** **ユーザープールのドメインを削除するには** 次の `delete-user-pool-domain` の例では、`my-domain` という名前のユーザープールのドメインを削除しています。 ``` aws cognito-idp delete-user-pool-domain \ --user-pool-id us-west-2_aaaaaaaaa \ --domain my-domain ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteUserPoolDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/delete-user-pool-domain.html)」を参照してください。 ### `delete-user-pool` 次のコード例は、`delete-user-pool` を使用する方法を示しています。 **AWS CLI** **ユーザープールを削除するには** この例では、ユーザープール ID、us-west-2\$1aaaaaaaaa を使用してユーザープールを削除しています。 コマンド: ``` aws cognito-idp delete-user-pool --user-pool-id us-west-2_aaaaaaaaa ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteUserPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/delete-user-pool.html)」を参照してください。 ### `delete-user` 次のコード例は、`delete-user` を使用する方法を示しています。 **AWS CLI** **ユーザーを削除するには** この例では、ユーザーを削除します。 コマンド: ``` aws cognito-idp delete-user --access-token ACCESS_TOKEN ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/delete-user.html)」を参照してください。 ### `describe-identity-provider` 次のコード例は、`describe-identity-provider` を使用する方法を示しています。 **AWS CLI** **ID プロバイダーを記述するには** この例では、Facebook という名前の ID プロバイダーを記述します。 コマンド: ``` aws cognito-idp describe-identity-provider --user-pool-id us-west-2_aaaaaaaaa --provider-name Facebook ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeIdentityProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/describe-identity-provider.html)」を参照してください。 ### `describe-resource-server` 次のコード例は、`describe-resource-server` を使用する方法を示しています。 **AWS CLI** **リソースサーバーを記述するには** この例では、リソースサーバー weather.example.com を記述します。 コマンド: ``` aws cognito-idp describe-resource-server --user-pool-id us-west-2_aaaaaaaaa --identifier weather.example.com ``` 出力: ``` { "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" } ] } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeResourceServer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/describe-resource-server.html)」を参照してください。 ### `describe-risk-configuration` 次のコード例は、`describe-risk-configuration` を使用する方法を示しています。 **AWS CLI** **リスク設定を記述するには** この例では、プール us-west-2\$1aaaaaaaa に関連するリスク設定を記述します。 コマンド: ``` aws cognito-idp describe-risk-configuration --user-pool-id us-west-2_aaaaaaaaa ``` 出力: ``` { "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" } } } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeRiskConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/describe-risk-configuration.html)」を参照してください。 ### `describe-user-import-job` 次のコード例は、`describe-user-import-job` を使用する方法を示しています。 **AWS CLI** **ユーザーインポートジョブを記述するには** この例では、ユーザー入力ジョブを記述します。 ユーザーをインポートする方法の詳細については、「Importing Users into User Pools From a CSV File」を参照してください。 コマンド: ``` aws cognito-idp describe-user-import-job --user-pool-id us-west-2_aaaaaaaaa --job-id import-TZqNQvDRnW ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeUserImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/describe-user-import-job.html)」を参照してください。 ### `describe-user-pool-client` 次のコード例は、`describe-user-pool-client` を使用する方法を示しています。 **AWS CLI** **ユーザープールクライアントを記述するには** この例では、ユーザープールクライアントを記述します。 コマンド: ``` aws cognito-idp describe-user-pool-client --user-pool-id us-west-2_aaaaaaaaa --client-id 38fjsnc484p94kpqsnet7mpld0 ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeUserPoolClient](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/describe-user-pool-client.html)」を参照してください。 ### `describe-user-pool-domain` 次のコード例は、`describe-user-pool-domain` を使用する方法を示しています。 **AWS CLI** **ユーザープールクライアントを記述するには** この例では、my-domain という名前のユーザープールドメインを記述します。 コマンド: ``` aws cognito-idp describe-user-pool-domain --domain my-domain ``` 出力: ``` { "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": {} } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeUserPoolDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/describe-user-pool-domain.html)」を参照してください。 ### `describe-user-pool` 次のコード例は、`describe-user-pool` を使用する方法を示しています。 **AWS CLI** **ユーザープールを記述するには** 次の例では、ユーザープール ID が us-west-2\$1EXAMPLE のユーザープールについて説明します。 ``` aws cognito-idp describe-user-pool \ --user-pool-id us-west-2_EXAMPLE ``` 出力: ``` { "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" } ] } } } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Amazon Cognito user pools](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeUserPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/describe-user-pool.html)」を参照してください。 ### `forget-device` 次のコード例は、`forget-device` を使用する方法を示しています。 **AWS CLI** **デバイスの「記憶済み」状態を解除するには** この例では、デバイスの「記憶済み」状態を解除します。 コマンド: ``` aws cognito-idp forget-device --device-key us-west-2_abcd_1234-5678 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ForgetDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/forget-device.html)」を参照してください。 ### `forgot-password` 次のコード例は、`forgot-password` を使用する方法を示しています。 **AWS CLI** **強制的にパスワードを変更するには** 次の `forgot-password` の例では、パスワードを変更するようにメッセージを jane@example.com に送信しています。 ``` aws cognito-idp forgot-password --client-id 38fjsnc484p94kpqsnet7mpld0 --username jane@example.com ``` 出力: ``` { "CodeDeliveryDetails": { "Destination": "j***@e***.com", "DeliveryMedium": "EMAIL", "AttributeName": "email" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ForgotPassword](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/forgot-password.html)」を参照してください。 ### `get-csv-header` 次のコード例は、`get-csv-header` を使用する方法を示しています。 **AWS CLI** **csv ヘッダーを作成するには** この例では、csv ヘッダーを作成しています。 ユーザーをインポートする方法の詳細については、「Importing Users into User Pools From a CSV File」を参照してください。 コマンド: ``` aws cognito-idp get-csv-header --user-pool-id us-west-2_aaaaaaaaa ``` 出力: ``` { "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" ] } ``` ... Importing Users into User Pools From a CSV File: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetCsvHeader](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-csv-header.html)」を参照してください。 ### `get-device` 次のコード例は、`get-device` を使用する方法を示しています。 **AWS CLI** **デバイスを取得するには** 次の `get-device` の例では、現在サインインしているユーザーの 1 つのデバイスを表示します。 ``` aws cognito-idp get-device \ --access-token eyJra456defEXAMPLE \ --device-key us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[ユーザープール内のユーザーデバイスの使用](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[GetDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-device.html)」を参照してください。 ### `get-group` 次のコード例は、`get-group` を使用する方法を示しています。 **AWS CLI** **グループに関する情報を取得するには** 次の `get-group` の例では、`MyGroup` という名前のユーザーグループのプロパティを一覧表示します。このグループには、優先順位とそれに関連付けられた IAM ロールがあります。 ``` aws cognito-idp get-group \ --user-pool-id us-west-2_EXAMPLE \ --group-name MyGroup ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[ユーザープールへのグループの追加](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-user-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-group.html)」を参照してください。 ### `get-identity-provider-by-identifier` 次のコード例は、`get-identity-provider-by-identifier` を使用する方法を示しています。 **AWS CLI** **IdP 識別子から ID プロバイダーの設定を取得するには** 次の `get-identity-provider-by-identifier` の例では、識別子 `mysso` を持つ ID プロバイダーの設定が返されます。 ``` aws cognito-idp get-identity-provider-by-identifier \ --user-pool-id us-west-2_EXAMPLE \ --idp-identifier mysso ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Third-party IdP sign-in](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetIdentityProviderByIdentifier](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-identity-provider-by-identifier.html)」を参照してください。 ### `get-log-delivery-configuration` 次のコード例は、`get-log-delivery-configuration` を使用する方法を示しています。 **AWS CLI** **ログ配信設定を表示するには** 次の `get-log-delivery-configuration` の例では、リクエストされたユーザープールのログエクスポート設定を表示します。 ``` aws cognito-idp get-log-delivery-configuration \ --user-pool-id us-west-2_EXAMPLE ``` 出力: ``` { "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" } } ] } } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Exporting user pool logs](https://docs.aws.amazon.com/cognito/latest/developerguide/exporting-quotas-and-usage.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetLogDeliveryConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-log-delivery-configuration.html)」を参照してください。 ### `get-signing-certificate` 次のコード例は、`get-signing-certificate` を使用する方法を示しています。 **AWS CLI** **SAML 署名証明書を表示するには** 次の `get-signing-certificate` の例では、リクエストユーザープールの SAML 2.0 署名証明書を表示します。 ``` aws cognito-idp get-signing-certificate \ --user-pool-id us-west-2_EXAMPLE ``` 出力: ``` { "Certificate": "[Certificate content]" } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[SAML signing and encryption](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-SAML-signing-encryption.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetSigningCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-signing-certificate.html)」を参照してください。 ### `get-ui-customization` 次のコード例は、`get-ui-customization` を使用する方法を示しています。 **AWS CLI** **アプリケーションクライアントのホストされた UI カスタマイズの従来の設定を表示するには** 次の `get-ui-customization` の例では、ユーザープールから設定を継承しないアプリケーションクライアントのホスト UI カスタマイズの従来の設定を表示します。 ``` aws cognito-idp get-ui-customization \ --user-pool-id us-west-2_EXAMPLE \ --client-id 1example23456789 ``` 出力: ``` { "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" } } ``` 詳細については、*Amazon Cognito デベロッパーガイド*」の「[Hosted UI (classic) branding](https://docs.aws.amazon.com/cognito/latest/developerguide/hosted-ui-classic-branding.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetUiCustomization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-ui-customization.html)」を参照してください。 ### `get-user-attribute-verification-code` 次のコード例は、`get-user-attribute-verification-code` を使用する方法を示しています。 **AWS CLI** **属性検証コードを現在のユーザーに送信するには** 次の `get-user-attribute-verification-code` の例では、現在サインインしているユーザーの E メールアドレスに属性検証コードを送信します。 ``` aws cognito-idp get-user-attribute-verification-code \ --access-token eyJra456defEXAMPLE \ --attribute-name email ``` 出力: ``` { "CodeDeliveryDetails": { "Destination": "a***@e***", "DeliveryMedium": "EMAIL", "AttributeName": "email" } } ``` 詳細については、「Amazon Cognito デベロッパーガイド」の「[ユーザーアカウントのサインアップと確認](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetUserAttributeVerificationCode](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-user-attribute-verification-code.html)」を参照してください。 ### `get-user-auth-factors` 次のコード例は、`get-user-auth-factors` を使用する方法を示しています。 **AWS CLI** **現在のユーザーが使用できる認証要素を一覧表示するには** 次の `get-user-auth-factors` の例では、現在サインインしているユーザーが使用できる認証要素を一覧表示します。 ``` aws cognito-idp get-user-auth-factors \ --access-token eyJra456defEXAMPLE ``` 出力: ``` { "Username": "testuser", "ConfiguredUserAuthFactors": [ "PASSWORD", "EMAIL_OTP", "SMS_OTP", "WEB_AUTHN" ] } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Authentication](https://docs.aws.amazon.com/cognito/latest/developerguide/authentication.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetUserAuthFactors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-user-auth-factors.html)」を参照してください。 ### `get-user-pool-mfa-config` 次のコード例は、`get-user-pool-mfa-config` を使用する方法を示しています。 **AWS CLI** **ユーザープールの多要素認証と WebAuthn 設定を表示するには** 次の `get-user-pool-mfa-config` の例では、リクエストされたユーザープールの MFA および WebAuthn 設定を表示します。 ``` aws cognito-idp get-user-pool-mfa-config \ --user-pool-id us-west-2_EXAMPLE ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Adding MFA](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetUserPoolMfaConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-user-pool-mfa-config.html)」を参照してください。 ### `get-user` 次のコード例は、`get-user` を使用する方法を示しています。 **AWS CLI** **現在のユーザーの詳細を取得するには** 次の `get-user` の例では、現在サインインしているユーザーのプロファイルを表示します。 ``` aws cognito-idp get-user \ --access-token eyJra456defEXAMPLE ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[ユーザーの管理](https://docs.aws.amazon.com/cognito/latest/developerguide/managing-users.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/get-user.html)」を参照してください。 ### `global-sign-out` 次のコード例は、`global-sign-out` を使用する方法を示しています。 **AWS CLI** **現在のユーザーをサインアウトするには** 次の `global-sign-out` の例では、現在のユーザーをサインアウトします。 ``` aws cognito-idp global-sign-out \ --access-token eyJra456defEXAMPLE ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[ユーザーの管理](https://docs.aws.amazon.com/cognito/latest/developerguide/managing-users.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GlobalSignOut](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/global-sign-out.html)」を参照してください。 ### `initiate-auth` 次のコード例は、`initiate-auth` を使用する方法を示しています。 **AWS CLI** **ユーザーをサインインするには** 次の `initiate-auth` の例では、基本的なユーザー名-パスワードフローを使用してユーザーにサインインし、追加のチャレンジはありません。 ``` 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 ``` 出力: ``` { "AuthenticationResult": { "AccessToken": "eyJra456defEXAMPLE", "ExpiresIn": 3600, "TokenType": "Bearer", "RefreshToken": "eyJra123abcEXAMPLE", "IdToken": "eyJra789ghiEXAMPLE", "NewDeviceMetadata": { "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeviceGroupKey": "-v7w9UcY6" } } } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Authentication](https://docs.aws.amazon.com/cognito/latest/developerguide/authentication.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[InitiateAuth](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/initiate-auth.html)」を参照してください。 ### `list-devices` 次のコード例は、`list-devices` を使用する方法を示しています。 **AWS CLI** **ユーザーのデバイスを一覧表示するには** 次の `list-devices` の例では、現在のユーザーが登録したデバイスを一覧表示します。 ``` aws cognito-idp list-devices \ --access-token eyJra456defEXAMPLE ``` 出力: ``` { "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 } ] } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Working with devices](https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-device-tracking.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDevices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-devices.html)」を参照してください。 ### `list-groups` 次のコード例は、`list-groups` を使用する方法を示しています。 **AWS CLI** **ユーザープールのグループを一覧表示するには** 次の `list-groups` の例では、リクエストされたユーザープールの最初の 2 つのグループを一覧表示します。 ``` aws cognito-idp list-groups \ --user-pool-id us-west-2_EXAMPLE \ --max-items 2 ``` 出力: ``` { "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]" } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[ユーザープールへのグループの追加](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-user-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-groups.html)」を参照してください。 ### `list-identity-providers` 次のコード例は、`list-identity-providers` を使用する方法を示しています。 **AWS CLI** **ID プロバイダーを一覧表示するには** 次の `list-identity-providers` の例では、リクエストされたユーザープールの最初の 2 つの ID プロバイダーを一覧表示します。 ``` aws cognito-idp list-identity-providers \ --user-pool-id us-west-2_EXAMPLE \ --max-items 2 ``` 出力: ``` { "Providers": [ { "CreationDate": 1619477386.504, "LastModifiedDate": 1703798328.142, "ProviderName": "Azure", "ProviderType": "SAML" }, { "CreationDate": 1642698776.175, "LastModifiedDate": 1642699086.453, "ProviderName": "LoginWithAmazon", "ProviderType": "LoginWithAmazon" } ], "NextToken": "[Pagination token]" } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Third-party IdP sign-in](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListIdentityProviders](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-identity-providers.html)」を参照してください。 ### `list-resource-servers` 次のコード例は、`list-resource-servers` を使用する方法を示しています。 **AWS CLI** **リソースサーバーを一覧表示するには** 次の `list-resource-servers` の例では、リクエストされたユーザープールの最初の 2 つのリソースサーバーを一覧表示します。 ``` aws cognito-idp list-resource-servers \ --user-pool-id us-west-2_EXAMPLE \ --max-results 2 ``` 出力: ``` { "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]" } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Access control with resource servers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-define-resource-servers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListResourceServers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-resource-servers.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **ユーザープールのタグを一覧表示するには** 次の `list-tags-for-resource` の例では、リクエストされた ARN を使用してユーザープールに割り当てられたタグを一覧表示します。 ``` aws cognito-idp list-tags-for-resource \ --resource-arn arn:aws:cognito-idp:us-west-2:123456789012:userpool/us-west-2_EXAMPLE ``` 出力: ``` { "Tags": { "administrator": "Jie", "tenant": "ExampleCorp" } } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Tagging Amazon Cognito resources](https://docs.aws.amazon.com/cognito/latest/developerguide/tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-tags-for-resource.html)」を参照してください。 ### `list-user-import-jobs` 次のコード例は、`list-user-import-jobs` を使用する方法を示しています。 **AWS CLI** **ユーザーインポートジョブとステータスを一覧表示するには** 次の `list-user-import-jobs` の例では、リクエストされたユーザープールの最初の 3 つのユーザーインポートジョブとその詳細を一覧表示します。 ``` aws cognito-idp list-user-import-jobs \ --user-pool-id us-west-2_EXAMPLE \ --max-results 3 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Importing users from a CSV file](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListUserImportJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-user-import-jobs.html)」を参照してください。 ### `list-user-pool-clients` 次のコード例は、`list-user-pool-clients` を使用する方法を示しています。 **AWS CLI** **アプリクライアントを一覧表示するには** 次の `list-user-pool-clients` の例では、リクエストされたユーザープールの最初の 3 つのアプリクライアントを一覧表示します。 ``` aws cognito-idp list-user-pool-clients \ --user-pool-id us-west-2_EXAMPLE \ --max-results 3 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[App clients](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListUserPoolClients](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-user-pool-clients.html)」を参照してください。 ### `list-user-pools` 次のコード例は、`list-user-pools` を使用する方法を示しています。 **AWS CLI** **ユーザープールを一覧表示するには** 次の `list-user-pools` の例では、現在の CLI 認証情報の AWS アカウントで使用可能なユーザープールを 3 つ一覧表示します。 ``` aws cognito-idp list-user-pools \ --max-results 3 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Amazon Cognito user pools](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListUserPools](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-user-pools.html)」を参照してください。** ### `list-users-in-group` 次のコード例は、`list-users-in-group` を使用する方法を示しています。 **AWS CLI** **グループ内のユーザーを一覧表示するには** この例では、MyGroup グループのユーザーを一覧表示しています。 コマンド: ``` aws cognito-idp list-users-in-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyGroup ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListUsersInGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-users-in-group.html)」を参照してください。 ### `list-users` 次のコード例は、`list-users` を使用する方法を示しています。 **AWS CLI** **例 1: サーバー側のフィルターを使用してユーザーを一覧表示するには** 次の `list-users` の例では、リクエストされたユーザープールの E メールアドレスが `testuser` で始まる 3 人のユーザーを一覧表示します。 ``` aws cognito-idp list-users \ --user-pool-id us-west-2_EXAMPLE \ --filter email^=\"testuser\" \ --max-items 3 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Managing and searching for users](https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html)」を参照してください。 **例 2: クライアント側のフィルターを使用してユーザーを一覧表示するには** 次の `list-users` の例では、属性を持つ 3 人のユーザーの属性を一覧表示します。この場合は、E メールアドレスに、E メールドメイン「@example.com」が含まれています。他の属性がこの文字列を含んでいる場合、その属性も表示されます。2 番目のユーザーは、クエリに一致する属性を持たず、表示される出力から除外されますが、サーバーのレスポンスからは除外されません。 ``` aws cognito-idp list-users \ --user-pool-id us-west-2_EXAMPLE \ --max-items 3 --query Users\[\*\].Attributes\[\?Value\.contains\(\@\,\'@example.com\'\)\] ``` 出力: ``` [ [ { "Name": "email", "Value": "admin@example.com" } ], [], [ { "Name": "email", "Value": "operator@example.com" } ] ] ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Managing and searching for users](https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListUsers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-users.html)」を参照してください。 ### `list-web-authn-credentials` 次のコード例は、`list-web-authn-credentials` を使用する方法を示しています。 **AWS CLI** **パスキーの認証情報を一覧表示するには** 次の `list-web-authn-credentials` の例では、現在のユーザーのパスキー、WebAuthn、または認証情報を一覧表示します。登録されているデバイスは 1 つです。 ``` aws cognito-idp list-web-authn-credentials \ --access-token eyJra456defEXAMPLE ``` 出力: ``` { "Credentials": [ { "AuthenticatorAttachment": "cross-platform", "CreatedAt": 1736293876.115, "CredentialId": "8LApgk4-lNUFHbhm2w6Und7-uxcc8coJGsPxiogvHoItc64xWQc3r4CEXAMPLE", "FriendlyCredentialName": "Roaming passkey", "RelyingPartyId": "auth.example.com" } ] } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[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)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListWebAuthnCredentials](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/list-web-authn-credentials.html)」を参照してください。 ### `resend-confirmation-code` 次のコード例は、`resend-confirmation-code` を使用する方法を示しています。 **AWS CLI** **確認コードを再送信するには** 次の `resend-confirmation-code` 例では、ユーザー `jane` に確認コードを送信します。 ``` aws cognito-idp resend-confirmation-code \ --client-id 12a3b456c7de890f11g123hijk \ --username jane ``` 出力: ``` { "CodeDeliveryDetails": { "Destination": "j***@e***.com", "DeliveryMedium": "EMAIL", "AttributeName": "email" } } ``` 詳細については、「Amazon Cognito デベロッパーガイド」の「[ユーザーアカウントのサインアップと確認](https://docs.aws.amazon.com/cognito/latest/developerguide/signing-up-users-in-your-app.html)」を参照してください。** + API の詳細については、「AWS CLI コマンドリファレンス」の「[ResendConfirmationCode](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/resend-confirmation-code.html)」を参照してください。** ### `respond-to-auth-challenge` 次のコード例は、`respond-to-auth-challenge` を使用する方法を示しています。 **AWS CLI** **例 1: NEW\$1PASSWORD\$1REQUIRED チャレンジに応答するには** 次の `respond-to-auth-challenge` の例では、initiate-auth によって返された NEW\$1PASSWORD\$1REQUIRED チャレンジに応答します。ユーザー `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 ``` 出力: ``` { "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" } } } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Authentication](https://docs.aws.amazon.com/cognito/latest/developerguide/authentication.html)」を参照してください。 **例 2: SELECT\$1MFA\$1TYPE チャレンジに応答するには** 次の `respond-to-auth-challenge` の例では、現在のユーザーの MFA オプションとして TOTP MFA を選択します。ユーザーは、MFA タイプを選択して 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 ``` 出力: ``` { "ChallengeName": "SOFTWARE_TOKEN_MFA", "Session": "AYABeEv5HklEXAMPLE", "ChallengeParameters": { "FRIENDLY_DEVICE_NAME": "transparent" } } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Adding MFA](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html)」を参照してください。 **例 3: SOFTWARE\$1TOKEN\$1MFA チャレンジに応答するには** 次の `respond-to-auth-challenge` の例では、TOTP MFA コードを提供し、サインインを完了する方法を示します。 ``` 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 ``` 出力: ``` { "AuthenticationResult": { "AccessToken": "eyJra456defEXAMPLE", "ExpiresIn": 3600, "TokenType": "Bearer", "RefreshToken": "eyJra123abcEXAMPLE", "IdToken": "eyJra789ghiEXAMPLE", "NewDeviceMetadata": { "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeviceGroupKey": "-v7w9UcY6" } } } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Adding MFA](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[RespondToAuthChallenge](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/respond-to-auth-challenge.html)」を参照してください。** ### `revoke-token` 次のコード例は、`revoke-token` を使用する方法を示しています。 **AWS CLI** **更新トークンを取り消すには** 次の `revoke-token` では、リクエストされた更新トークンと、関連するアクセストークンを取り消します。 ``` aws cognito-idp revoke-token \ --token eyJjd123abcEXAMPLE \ --client-id 1example23456789 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Revoking tokens](https://docs.aws.amazon.com/cognito/latest/developerguide/token-revocation.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[RevokeToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/revoke-token.html)」を参照してください。** ### `set-log-delivery-configuration` 次のコード例は、`set-log-delivery-configuration` を使用する方法を示しています。 **AWS CLI** **ユーザープールからのログのエクスポートを設定するには** 次の `set-log-delivery-configuration` の例では、ロググループへのユーザー通知エラーのログ記録と 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} ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Exporting user pool logs](https://docs.aws.amazon.com/cognito/latest/developerguide/exporting-quotas-and-usage.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetLogDeliveryConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/set-log-delivery-configuration.html)」を参照してください。 ### `set-risk-configuration` 次のコード例は、`set-risk-configuration` を使用する方法を示しています。 **AWS CLI** **脅威保護のリスク設定を行うには** 次の `set-risk-configuration` の例では、リクエストされたアプリクライアントで脅威保護のメッセージとアクション、侵害された認証情報、および IP アドレス例外を設定します。NotifyConfiguration オブジェクトは複雑であるため、JSON 入力がこのコマンドのベストプラクティスです。 ``` aws cognito-idp set-risk-configuration \ --cli-input-json file://set-risk-configuration.json ``` `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" } ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Threat protection](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-threat-protection.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetRiskConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/set-risk-configuration.html)」を参照してください。 ### `set-ui-customization` 次のコード例は、`set-ui-customization` を使用する方法を示しています。 **AWS CLI** **例 1: アプリクライアントのクラシックホスト UI をカスタマイズするには** 次の `set-ui-customization` の例では、リクエストされたアプリクライアントをいくつかのカスタム CSS で設定し、Amazon Cognito ロゴをアプリケーションロゴとして使用します。 ``` 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 ``` 出力: ``` { "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" } } ``` **例 2: すべてのアプリクライアントのデフォルトの UI カスタマイズを設定するには** 次の `set-ui-customization` の例では、クライアント固有の設定を持たないすべてのアプリクライアントに対して、リクエストされたユーザープールを設定します。このコマンドは、いくつかのカスタム CSS を適用し、Amazon Cognito ロゴをアプリケーションロゴとして使用します。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、*Amazon Cognito デベロッパーガイド*」の「[Hosted UI (classic) branding](https://docs.aws.amazon.com/cognito/latest/developerguide/hosted-ui-classic-branding.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetUiCustomization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/set-ui-customization.html)」を参照してください。 ### `set-user-mfa-preference` 次のコード例は、`set-user-mfa-preference` を使用する方法を示しています。 **AWS CLI** **ユーザーの MFA を設定するには** 次の `set-user-mfa-preference` の例では、TOTP MFA を使用するように現在のユーザーを設定し、他のすべての 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 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Adding MFA](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetUserMfaPreference](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/set-user-mfa-preference.html)」を参照してください。 ### `set-user-pool-mfa-config` 次のコード例は、`set-user-pool-mfa-config` を使用する方法を示しています。 **AWS CLI** **ユーザープール MFA と WebAuthn を設定するには** 次の `set-user-pool-mfa-config` の例では、使用可能なすべての MFA メソッドでオプションの MFA を使用して、リクエストされたユーザープールを設定し、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 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Adding MFA](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html)」と「[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)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetUserPoolMfaConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/set-user-pool-mfa-config.html)」を参照してください。 ### `set-user-settings` 次のコード例は、`set-user-settings` を使用する方法を示しています。 **AWS CLI** **ユーザー設定を行うには** この例では、MFA 配信設定を EMAIL に設定しています。 コマンド: ``` aws cognito-idp set-user-settings --access-token ACCESS_TOKEN --mfa-options DeliveryMedium=EMAIL ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetUserSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/set-user-settings.html)」を参照してください。 ### `sign-up` 次のコード例は、`sign-up` を使用する方法を示しています。 **AWS CLI** **ユーザーをサインアップするには** この例では jane@example.com をサインアップします。 コマンド: ``` 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" ``` 出力: ``` { "UserConfirmed": false, "UserSub": "e04d60a6-45dc-441c-a40b-e25a787d4862" } ``` + API の詳細については、「AWS CLI コマンドリファレンス」の「[SignUp](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/sign-up.html)」を参照してください。** ### `start-user-import-job` 次のコード例は、`start-user-import-job` を使用する方法を示しています。 **AWS CLI** **インポートジョブを開始するには** 次の `start-user-import-job` の例では、リクエストされたユーザープールで、リクエストされたインポートジョブを開始します。 ``` aws cognito-idp start-user-import-job \ --user-pool-id us-west-2_EXAMPLE \ --job-id import-mAgUtd8PMm ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Importing users into a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartUserImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/start-user-import-job.html)」を参照してください。 ### `start-web-authn-registration` 次のコード例は、`start-web-authn-registration` を使用する方法を示しています。 **AWS CLI** **サインインしたユーザーのパスキー登録情報を取得するには** 次の `start-web-authn-registration` の例では、現在のユーザーの WebAuthn 登録オプションを生成します。 ``` aws cognito-idp start-web-authn-registration \ --access-token eyJra456defEXAMPLE ``` 出力: ``` { "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" } } } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[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)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartWebAuthnRegistration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/start-web-authn-registration.html)」を参照してください。 ### `stop-user-import-job` 次のコード例は、`stop-user-import-job` を使用する方法を示しています。 **AWS CLI** **インポートジョブを停止するには** 次の `stop-user-import-job` の例では、リクエストされたユーザープールで、リクエストされた実行中のユーザーインポートジョブを停止します。 ``` aws cognito-idp stop-user-import-job \ --user-pool-id us-west-2_EXAMPLE \ --job-id import-mAgUtd8PMm ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Importing users into a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopUserImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/stop-user-import-job.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **ユーザープールにタグ付けするには** 次の `tag-resource` の例では、リクエストされたユーザープールに `administrator` および `department` タグを適用します。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Tagging Amazon Cognito resources](https://docs.aws.amazon.com/cognito/latest/developerguide/tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **ユーザープールからタグを削除するには** 次の `untag-resource` の例では、リクエストされたユーザープールから `administrator` および `department` タグを削除します。 ``` aws cognito-idp untag-resource \ --resource-arn arn:aws:cognito-idp:us-west-2:767671399759:userpool/us-west-2_l5cxwdm2K \ --tag-keys administrator tenant ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Tagging Amazon Cognito resources](https://docs.aws.amazon.com/cognito/latest/developerguide/tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/untag-resource.html)」を参照してください。 ### `update-auth-event-feedback` 次のコード例は、`update-auth-event-feedback` を使用する方法を示しています。 **AWS CLI** **認証イベントフィードバックを更新するには** この例では、認証イベントフィードバックを更新しています。イベント「Valid」をマークします。 コマンド: ``` 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" ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateAuthEventFeedback](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-auth-event-feedback.html)」を参照してください。 ### `update-device-status` 次のコード例は、`update-device-status` を使用する方法を示しています。 **AWS CLI** **デバイスステータスを更新するには** この例では、デバイスのステータスを「not\$1remembered」に更新しています。 コマンド: ``` aws cognito-idp update-device-status --access-token ACCESS_TOKEN --device-key DEVICE_KEY --device-remembered-status "not_remembered" ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateDeviceStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-device-status.html)」を参照してください。 ### `update-group` 次のコード例は、`update-group` を使用する方法を示しています。 **AWS CLI** **グループを更新するには** この例では、MyGroup の説明と優先順位を更新しています。 コマンド: ``` aws cognito-idp update-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyGroup --description "New description" --precedence 2 ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-group.html)」を参照してください。 ### `update-identity-provider` 次のコード例は、`update-identity-provider` を使用する方法を示しています。 **AWS CLI** **ユーザープール ID プロバイダーを更新するには** 次の `update-identity-provider` の例では、リクエストされたユーザープールの OIDC プロバイダー「MyOIDCIdP」を更新します。 ``` aws cognito-idp update-identity-provider \ --cli-input-json file://update-identity-provider.json ``` `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" } ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Configuring a domain](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateIdentityProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-identity-provider.html)」を参照してください。 ### `update-managed-login-branding` 次のコード例は、`update-managed-login-branding` を使用する方法を示しています。 **AWS CLI** **マネージドログインブランディングのスタイルを更新するには** 次の `update-managed-login-branding` の例では、リクエストされたアプリケーションクライアントブランドディングのスタイルを更新します。 ``` aws cognito-idp update-managed-login-branding \ --cli-input-json file://update-managed-login-branding.json ``` `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" } ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Apply branding to managed login pages](https://docs.aws.amazon.com/cognito/latest/developerguide/managed-login-branding.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateManagedLoginBranding](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-managed-login-branding.html)」を参照してください。 ### `update-resource-server` 次のコード例は、`update-resource-server` を使用する方法を示しています。 **AWS CLI** **リソースサーバーを更新するには** この例では、リソースサーバー Weather を更新しています。新しいスコープが追加されます。 コマンド: ``` 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" ``` 出力: ``` { "ResourceServer": { "UserPoolId": "us-west-2_aaaaaaaaa", "Identifier": "weather.example.com", "Name": "Happy", "Scopes": [ { "ScopeName": "NewScope", "ScopeDescription": "New scope description" } ] } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateResourceServer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-resource-server.html)」を参照してください。 ### `update-user-attributes` 次のコード例は、`update-user-attributes` を使用する方法を示しています。 **AWS CLI** **ユーザー属性を更新するには** この例では、ユーザー属性「nickname」を更新しています。 コマンド: ``` aws cognito-idp update-user-attributes --access-token ACCESS_TOKEN --user-attributes Name="nickname",Value="Dan" ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateUserAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-user-attributes.html)」を参照してください。 ### `update-user-pool-client` 次のコード例は、`update-user-pool-client` を使用する方法を示しています。 **AWS CLI** **アプリクライアントを更新するには** 次の `update-user-pool-client` の例では、リクエストされたアプリクライアントの設定を更新します。 ``` 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 ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[アプリケーションクライアントによるアプリケーション固有の設定](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateUserPoolClient](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-user-pool-client.html)」を参照してください。 ### `update-user-pool-domain` 次のコード例は、`update-user-pool-domain` を使用する方法を示しています。 **AWS CLI** **カスタムドメイン名を更新するには** 次の `update-user-pool-domain` の例では、リクエストされたユーザープールのカスタムドメインのブランディングバージョンと証明書を設定します。 ``` 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 ``` 出力: ``` { "CloudFrontDomain": "example.cloudfront.net", "ManagedLoginVersion": 2 } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Managed login](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-managed-login.html)」と「[Configuring a domain](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateUserPoolDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-user-pool-domain.html)」を参照してください。 ### `update-user-pool` 次のコード例は、`update-user-pool` を使用する方法を示しています。 **AWS CLI** **ユーザープールを更新するには** 次の `update-user-pool` の例では、使用可能な各設定オプションの構文例を使用して、ユーザープールを変更しています。ユーザープールを更新するには、以前に設定されたすべてのオプションを指定する必要があります。指定しない場合は、デフォルト値にリセットされます。 ``` 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"\}\] ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Cognito Developer Guide*」の「[Updating user pool configuration](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-updating.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateUserPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/update-user-pool.html)」を参照してください。 ### `verify-software-token` 次のコード例は、`verify-software-token` を使用する方法を示しています。 **AWS CLI** **TOTP 認証システムの登録を確認するには** 次の `verify-software-token` の例では、現在のユーザーの TOTP 登録を完了します。 ``` aws cognito-idp verify-software-token \ --access-token eyJra456defEXAMPLE \ --user-code 123456 ``` 出力: ``` { "Status": "SUCCESS" } ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Adding MFA to a user pool](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-mfa.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[VerifySoftwareToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/verify-software-token.html)」を参照してください。 ### `verify-user-attribute` 次のコード例は、`verify-user-attribute` を使用する方法を示しています。 **AWS CLI** **属性の変更を確認するには** 次の `verify-user-attribute` の例では、現在のユーザーの E メール属性の変更を検証します。 ``` aws cognito-idp verify-user-attribute \ --access-token eyJra456defEXAMPLE \ --attribute-name email \ --code 123456 ``` 詳細については、「*Amazon Cognito デベロッパーガイド*」の「[Configuring email or phone verification](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[VerifyUserAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cognito-idp/verify-user-attribute.html)」を参照してください。 # AWS CLI を使用する Amazon Comprehend の例 次のコード例は、Amazon Comprehend で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `batch-detect-dominant-language` 次のコード例は、`batch-detect-dominant-language` を使用する方法を示しています。 **AWS CLI** **複数の入力テキストの主要言語を検出するには** 次の `batch-detect-dominant-language` の例では、複数の入力テキストを分析し、それぞれの主要言語を返しています。予測ごとに、事前トレーニング済みモデルの信頼スコアも出力されます。 ``` 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." ``` 出力: ``` { "ResultList": [ { "Index": 0, "Languages": [ { "LanguageCode": "en", "Score": 0.9986501932144165 } ] } ], "ErrorList": [] } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[主要言語](https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchDetectDominantLanguage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/batch-detect-dominant-language.html)」を参照してください。 ### `batch-detect-entities` 次のコード例は、`batch-detect-entities` を使用する方法を示しています。 **AWS CLI** **複数の入力テキストからエンティティを検出するには** 次の `batch-detect-entities` の例では、複数の入力テキストを分析し、それぞれの名前付きエンティティを返しています。予測ごとに、事前トレーニング済みモデルの信頼スコアも出力されます。 ``` 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." ``` 出力: ``` { "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": [] } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[エンティティ](https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchDetectEntities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/batch-detect-entities.html)」を参照してください。 ### `batch-detect-key-phrases` 次のコード例は、`batch-detect-key-phrases` を使用する方法を示しています。 **AWS CLI** **複数のテキスト入力のキーフレーズを検出するには** 次の `batch-detect-key-phrases` の例では、複数の入力テキストを分析し、それぞれの主要な名詞フレーズを返しています。予測ごとに、事前トレーニング済みモデルの信頼スコアも出力されます。 ``` 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." ``` 出力: ``` { "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": [] } ``` 詳細については、「Amazon Comprehend 開発者ガイド」の「[キーフレーズ](https://docs.aws.amazon.com/comprehend/latest/dg/how-key-phrases.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchDetectKeyPhrases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/batch-detect-key-phrases.html)」を参照してください。 ### `batch-detect-sentiment` 次のコード例は、`batch-detect-sentiment` を使用する方法を示しています。 **AWS CLI** **複数の入力テキストの一般的な感情を検出するには** 次の `batch-detect-sentiment` の例では、入力テキストを分析し、一般的な感情 (それぞれの `POSITIVE`、`NEUTRAL`、`MIXED`、または `NEGATIVE`) を返しています。 ``` 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 ``` 出力: ``` { "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": [] } ``` 詳細については、「Amazon Comprehend デベロッパーガイド」の「[感情](https://docs.aws.amazon.com/comprehend/latest/dg/how-sentiment.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchDetectSentiment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/batch-detect-sentiment.html)」を参照してください。 ### `batch-detect-syntax` 次のコード例は、`batch-detect-syntax` を使用する方法を示しています。 **AWS CLI** **複数の入力テキスト内の単語の構文と品詞を調べるには** 次の `batch-detect-syntax` の例では、複数の入力テキストの構文を分析し、さまざまな品詞を返しています。予測ごとに、事前トレーニング済みモデルの信頼スコアも出力されます。 ``` 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 ``` 出力: ``` { "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": [] } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[構文分析](https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchDetectSyntax](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/batch-detect-syntax.html)」を参照してください。 ### `batch-detect-targeted-sentiment` 次のコード例は、`batch-detect-targeted-sentiment` を使用する方法を示しています。 **AWS CLI** **複数の入力テキストの感情とそれぞれの名前付きエンティティを検出するには** 次の `batch-detect-targeted-sentiment` の例では、複数の入力テキストを分析し、名前付きエンティティとそれぞれのエンティティにアタッチされた一般的な感情を返しています。予測ごとに、事前トレーニング済みモデルの信頼スコアも出力されます。 ``` 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." ``` 出力: ``` { "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": [] } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Targeted Sentiment](https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchDetectTargetedSentiment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/batch-detect-targeted-sentiment.html)」を参照してください。 ### `classify-document` 次のコード例は、`classify-document` を使用する方法を示しています。 **AWS CLI** **モデル固有のエンドポイントを使用してドキュメントを分類するには** 次の `classify-document` の例では、カスタムモデルのエンドポイントを使用してドキュメントを分類しています。この例のモデルは、スパムまたは非スパム (「ハム」) としてラベル付けされた SMS メッセージを含むデータセットでトレーニングされました。 ``` 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" ``` 出力: ``` { "Classes": [ { "Name": "spam", "Score": 0.9998599290847778 }, { "Name": "ham", "Score": 0.00014001205272506922 } ] } ``` 詳細については、「Amazon Comprehend 開発者ガイド」の「[カスタム分類](https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ClassifyDocument](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/classify-document.html)」を参照してください。 ### `contains-pii-entities` 次のコード例は、`contains-pii-entities` を使用する方法を示しています。 **AWS CLI** **PII 情報の有無について入力テキストを分析するには** 次の `contains-pii-entities` の例では、入力テキストを分析して個人を特定できる情報 (PII) の有無を確認し、名前、住所、銀行口座番号、電話番号などの識別された PII エンティティタイプのラベルを返しています。 ``` 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." ``` 出力: ``` { "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 } } ``` サポートされる PII エンティティタイプの一覧の詳細については、「Amazon Comprehend 開発者ガイド」の「[個人を特定できる情報 (PII)](https://docs.aws.amazon.com/comprehend/latest/dg/pii.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ContainsPiiEntities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/contains-pii-entities.html)」を参照してください。 ### `create-dataset` 次のコード例は、`create-dataset` を使用する方法を示しています。 **AWS CLI** **フライホイールデータセットを作成するには** 次の `create-dataset` の例では、フライホイールのデータセットを作成しています。このデータセットは、`--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 ``` `file://inputConfig.json` の内容: ``` { "DataFormat": "COMPREHEND_CSV", "DocumentClassifierInputDataConfig": { "S3Uri": "s3://amzn-s3-demo-bucket/training-data.csv" } } ``` 出力: ``` { "DatasetArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity/dataset/example-dataset" } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Flywheel Overview](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDataset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/create-dataset.html)」を参照してください。 ### `create-document-classifier` 次のコード例は、`create-document-classifier` を使用する方法を示しています。 **AWS CLI** **ドキュメントを分類するドキュメント分類子を作成するには** 次の `create-document-classifier` の例では、ドキュメント分類子モデルのトレーニングプロセスを開始します。トレーニングデータファイル「`training.csv`」は、`--input-data-config` タグにあります。`training.csv` は 2 列のドキュメントで、1 番目の列にはラベルまたは分類が、2 番目の列にはドキュメントが表示されます。 ``` 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 ``` 出力: ``` { "DocumentClassifierArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier" } ``` 詳細については、「Amazon Comprehend 開発者ガイド」の「[カスタム分類](https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[CreateDocumentClassifier](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/create-document-classifier.html)」を参照してください。** ### `create-endpoint` 次のコード例は、`create-endpoint` を使用する方法を示しています。 **AWS CLI** **カスタムモデルのエンドポイントを作成するには** 次の `create-endpoint` の例では、以前にトレーニングしたカスタムモデルの同期推論用のエンドポイントを作成しています。 ``` 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 ``` 出力: ``` { "EndpointArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/example-classifier-endpoint-1" } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のエンドポイントの管理](https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/create-endpoint.html)」を参照してください。 ### `create-entity-recognizer` 次のコード例は、`create-entity-recognizer` を使用する方法を示しています。 **AWS CLI** **カスタムエンティティレコグナイザーを作成するには** 次の `create-entity-recognizer` の例では、カスタムエンティティレコグナイザーモデルのトレーニングプロセスを開始しています。この例では、トレーニングドキュメントを含む CSV ファイル (`raw_text.csv`)、および CSV エンティティリスト (`entity_list.csv`) を使用してモデルをトレーニングします。`entity-list.csv` には、テキスト列とタイプ列が含まれています。 ``` 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 ``` 出力: ``` { "EntityRecognizerArn": "arn:aws:comprehend:us-west-2:111122223333:example-entity-recognizer/entityrecognizer1" } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Custom entity recognition](https://docs.aws.amazon.com/comprehend/latest/dg/custom-entity-recognition.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateEntityRecognizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/create-entity-recognizer.html)」を参照してください。 ### `create-flywheel` 次のコード例は、`create-flywheel` を使用する方法を示しています。 **AWS CLI** **フライホイールを作成するには** 次の `create-flywheel` の例では、ドキュメント分類またはエンティティ認識モデルの継続的なトレーニングを調整するためのフライホイールを作成しています。この例でのフライホイールは、`--active-model-arn` タグで指定された既存のトレーニング済みモデルを管理するために作成されています。フライホイールが作成されると、`--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" ``` 出力: ``` { "FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel" } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Flywheel Overview](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateFlywheel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/create-flywheel.html)」を参照してください。 ### `delete-document-classifier` 次のコード例は、`delete-document-classifier` を使用する方法を示しています。 **AWS CLI** **カスタムドキュメント分類子を削除するには** 次の `delete-document-classifier` の例では、カスタムドキュメント分類子モデルを削除します。 ``` aws comprehend delete-document-classifier \ --document-classifier-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier-1 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のエンドポイントの管理](https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[DeleteDocumentClassifier](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/delete-document-classifier.html)」を参照してください。** ### `delete-endpoint` 次のコード例は、`delete-endpoint` を使用する方法を示しています。 **AWS CLI** **カスタムモデルのエンドポイントを削除するには** 次の `delete-endpoint` の例では、モデル固有のエンドポイントを削除しています。モデルを削除するには、すべてのエンドポイントを削除する必要があります。 ``` aws comprehend delete-endpoint \ --endpoint-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/example-classifier-endpoint-1 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のエンドポイントの管理](https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/delete-endpoint.html)」を参照してください。 ### `delete-entity-recognizer` 次のコード例は、`delete-entity-recognizer` を使用する方法を示しています。 **AWS CLI** **カスタムエンティティレコグナイザーモデルを削除するには** 次の `delete-entity-recognizer` の例では、カスタムエンティティレコグナイザーモデルを削除しています。 ``` aws comprehend delete-entity-recognizer \ --entity-recognizer-arn arn:aws:comprehend:us-west-2:111122223333:entity-recognizer/example-entity-recognizer-1 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のエンドポイントの管理](https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteEntityRecognizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/delete-entity-recognizer.html)」を参照してください。 ### `delete-flywheel` 次のコード例は、`delete-flywheel` を使用する方法を示しています。 **AWS CLI** **フライホイールを削除するには** 次の `delete-flywheel` の例では、フライホイールを削除しています。フライホイールに関連付けられたデータレイクまたはモデルは削除されません。 ``` aws comprehend delete-flywheel \ --flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel-1 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Flywheel Overview](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteFlywheel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/delete-flywheel.html)」を参照してください。 ### `delete-resource-policy` 次のコード例は、`delete-resource-policy` を使用する方法を示しています。 **AWS CLI** **リソースベースのポリシーを削除するには** 次の `delete-resource-policy` の例では、Amazon Comprehend リソースからリソースベースのポリシーを削除しています。 ``` aws comprehend delete-resource-policy \ --resource-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier-1/version/1 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Copying custom models between AWS accounts](https://docs.aws.amazon.com/comprehend/latest/dg/custom-copy.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteResourcePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/delete-resource-policy.html)」を参照してください。 ### `describe-dataset` 次のコード例は、`describe-dataset` を使用する方法を示しています。 **AWS CLI** **フライホイールデータセットを記述するには** 次の `describe-dataset` の例では、フライホイールのデータセットのプロパティを取得しています。 ``` aws comprehend describe-dataset \ --dataset-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity/dataset/example-dataset ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Flywheel Overview](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDataset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-dataset.html)」を参照してください。 ### `describe-document-classification-job` 次のコード例は、`describe-document-classification-job` を使用する方法を示しています。 **AWS CLI** **ドキュメント分類ジョブを記述するには** 次の `describe-document-classification-job` の例では、非同期ドキュメント分類ジョブのプロパティを取得します。 ``` aws comprehend describe-document-classification-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` 出力: ``` { "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" } } ``` 詳細については、「Amazon Comprehend 開発者ガイド」の「[カスタム分類](https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeDocumentClassificationJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-document-classification-job.html)」を参照してください。** ### `describe-document-classifier` 次のコード例は、`describe-document-classifier` を使用する方法を示しています。 **AWS CLI** **ドキュメント分類子を記述するには** 次の `describe-document-classifier` の例では、カスタムドキュメント分類子モデルのプロパティを取得します。 ``` aws comprehend describe-document-classifier \ --document-classifier-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier-1 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[カスタムモデルの作成と管理](https://docs.aws.amazon.com/comprehend/latest/dg/manage-models.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDocumentClassifier](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-document-classifier.html)」を参照してください。 ### `describe-dominant-language-detection-job` 次のコード例は、`describe-dominant-language-detection-job` を使用する方法を示しています。 **AWS CLI** **主要言語の検出ジョブを記述するには。** 次の `describe-dominant-language-detection-job` の例では、非同期主要言語検出ジョブのプロパティを取得しています。 ``` aws comprehend describe-dominant-language-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDominantLanguageDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-dominant-language-detection-job.html)」を参照してください。 ### `describe-endpoint` 次のコード例は、`describe-endpoint` を使用する方法を示しています。 **AWS CLI** **特定のエンドポイントを記述するには** 次の `describe-endpoint` の例では、モデル固有のエンドポイントのプロパティを取得しています。 ``` aws comprehend describe-endpoint \ --endpoint-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/example-classifier-endpoint ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のエンドポイントの管理](https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-endpoint.html)」を参照してください。** ### `describe-entities-detection-job` 次のコード例は、`describe-entities-detection-job` を使用する方法を示しています。 **AWS CLI** **エンティティ検出ジョブを記述するには** 次の `describe-entities-detection-job` の例では、非同期エンティティ検出ジョブのプロパティを取得しています。 ``` aws comprehend describe-entities-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEntitiesDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-entities-detection-job.html)」を参照してください。 ### `describe-entity-recognizer` 次のコード例は、`describe-entity-recognizer` を使用する方法を示しています。 **AWS CLI** **エンティティレコグナイザーを記述するには** 次の `describe-entity-recognizer` の例では、カスタムエンティティレコグナイザーモデルのプロパティを取得しています。 ``` aws comprehend describe-entity-recognizer \ entity-recognizer-arn arn:aws:comprehend:us-west-2:111122223333:entity-recognizer/business-recongizer-1/version/1 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Custom entity recognition](https://docs.aws.amazon.com/comprehend/latest/dg/custom-entity-recognition.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEntityRecognizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-entity-recognizer.html)」を参照してください。 ### `describe-events-detection-job` 次のコード例は、`describe-events-detection-job` を使用する方法を示しています。 **AWS CLI** **イベント検出ジョブを記述するには。** 次の `describe-events-detection-job` の例では、非同期イベント検出ジョブのプロパティを取得しています。 ``` aws comprehend describe-events-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` 出力: ``` { "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" ] } } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEventsDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-events-detection-job.html)」を参照してください。 ### `describe-flywheel-iteration` 次のコード例は、`describe-flywheel-iteration` を使用する方法を示しています。 **AWS CLI** **フライホイールイテレーションを記述するには** 次の `describe-flywheel-iteration` の例では、フライホイールイテレーションのプロパティを取得しています。 ``` aws comprehend describe-flywheel-iteration \ --flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel \ --flywheel-iteration-id 20232222AEXAMPLE ``` 出力: ``` { "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/" } } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Flywheel Overview](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeFlywheelIteration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-flywheel-iteration.html)」を参照してください。 ### `describe-flywheel` 次のコード例は、`describe-flywheel` を使用する方法を示しています。 **AWS CLI** **フライホイールを記述するには** 次の `describe-flywheel` の例では、フライホイールのプロパティを取得しています。この例では、フライホイールに関連付けられたモデルは、ドキュメントをスパムまたは非スパム (「ハム」) として分類するようにトレーニングされたカスタム分類子モデルです。 ``` aws comprehend describe-flywheel \ --flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Flywheel Overview](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeFlywheel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-flywheel.html)」を参照してください。 ### `describe-key-phrases-detection-job` 次のコード例は、`describe-key-phrases-detection-job` を使用する方法を示しています。 **AWS CLI** **キーフレーズ検出ジョブを記述するには** 次の `describe-key-phrases-detection-job` の例では、非同期キーフレーズ検出ジョブのプロパティを取得しています。 ``` aws comprehend describe-key-phrases-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeKeyPhrasesDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-key-phrases-detection-job.html)」を参照してください。 ### `describe-pii-entities-detection-job` 次のコード例は、`describe-pii-entities-detection-job` を使用する方法を示しています。 **AWS CLI** **PII エンティティ検出ジョブを記述するには** 次の `describe-pii-entities-detection-job` の例では、非同期 PII エンティティ検出ジョブのプロパティを取得しています。 ``` aws comprehend describe-pii-entities-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribePiiEntitiesDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-pii-entities-detection-job.html)」を参照してください。 ### `describe-resource-policy` 次のコード例は、`describe-resource-policy` を使用する方法を示しています。 **AWS CLI** **モデルにアタッチされたリソースポリシーを記述するには** 次の `describe-resource-policy` の例では、モデルにアタッチされたリソースベースのポリシーのプロパティを取得しています。 ``` aws comprehend describe-resource-policy \ --resource-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1 ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Copying custom models between AWS accounts](https://docs.aws.amazon.com/comprehend/latest/dg/custom-copy.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeResourcePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-resource-policy.html)」を参照してください。 ### `describe-sentiment-detection-job` 次のコード例は、`describe-sentiment-detection-job` を使用する方法を示しています。 **AWS CLI** **感情検出ジョブを記述するには** 次の `describe-sentiment-detection-job` の例では、非同期感情検出ジョブのプロパティを取得しています。 ``` aws comprehend describe-sentiment-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeSentimentDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-sentiment-detection-job.html)」を参照してください。 ### `describe-targeted-sentiment-detection-job` 次のコード例は、`describe-targeted-sentiment-detection-job` を使用する方法を示しています。 **AWS CLI** **ターゲット感情検出ジョブを記述するには** 次の `describe-targeted-sentiment-detection-job` の例では、非同期ターゲット感情検出ジョブのプロパティを取得しています。 ``` aws comprehend describe-targeted-sentiment-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTargetedSentimentDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-targeted-sentiment-detection-job.html)」を参照してください。 ### `describe-topics-detection-job` 次のコード例は、`describe-topics-detection-job` を使用する方法を示しています。 **AWS CLI** **トピック検出ジョブを説明するには** 次の `describe-topics-detection-job` の例では、非同期トピック検出ジョブのプロパティを取得します。 ``` aws comprehend describe-topics-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeTopicsDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/describe-topics-detection-job.html)」を参照してください。** ### `detect-dominant-language` 次のコード例は、`detect-dominant-language` を使用する方法を示しています。 **AWS CLI** **入力テキストの主要言語を検出するには** 以下の `detect-dominant-language` は、入力テキストを分析し、主要言語を特定します。事前トレーニング済みモデルの信頼スコアも出力されます。 ``` aws comprehend detect-dominant-language \ --text "It is a beautiful day in Seattle." ``` 出力: ``` { "Languages": [ { "LanguageCode": "en", "Score": 0.9877256155014038 } ] } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[主要言語](https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DetectDominantLanguage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/detect-dominant-language.html)」を参照してください。 ### `detect-entities` 次のコード例は、`detect-entities` を使用する方法を示しています。 **AWS CLI** **入力テキストの名前付きエンティティを検出するには** 次の `detect-entities` の例では、入力テキストを分析し、名前付きエンティティを返します。予測ごとに、事前トレーニング済みモデルの信頼スコアも出力されます。 ``` 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." ``` 出力: ``` { "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 } ] } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[エンティティ](https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[DetectEntities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/detect-entities.html)」を参照してください。** ### `detect-key-phrases` 次のコード例は、`detect-key-phrases` を使用する方法を示しています。 **AWS CLI** **入力テキスト内のキーフレーズを検出するには** 次の `detect-key-phrases` の例では、入力テキストを分析し、主要な名詞フレーズを特定します。予測ごとに、事前トレーニング済みモデルの信頼スコアも出力されます。 ``` 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." ``` 出力: ``` { "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 } ] } ``` 詳細については、「Amazon Comprehend 開発者ガイド」の「[キーフレーズ](https://docs.aws.amazon.com/comprehend/latest/dg/how-key-phrases.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[DetectKeyPhrases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/detect-key-phrases.html)」を参照してください。** ### `detect-pii-entities` 次のコード例は、`detect-pii-entities` を使用する方法を示しています。 **AWS CLI** **入力テキストの PII エンティティを検出するには** 次の `detect-pii-entities` の例では、入力テキストを分析し、個人を特定できる情報 (PII) を含むエンティティを特定します。予測ごとに、事前トレーニング済みモデルの信頼スコアも出力されます。 ``` 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." ``` 出力: ``` { "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 } ] } ``` サポートされる PII エンティティタイプの一覧の詳細については、「Amazon Comprehend 開発者ガイド」の「[個人を特定できる情報 (PII)](https://docs.aws.amazon.com/comprehend/latest/dg/pii.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[DetectPiiEntities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/detect-pii-entities.html)」を参照してください。** ### `detect-sentiment` 次のコード例は、`detect-sentiment` を使用する方法を示しています。 **AWS CLI** **入力テキストの感情を検出するには** 次の `detect-sentiment` の例では、入力テキストを分析し、一般的な感情 (`POSITIVE`、`NEUTRAL`、`MIXED`、または `NEGATIVE`) の推論を返します。 ``` aws comprehend detect-sentiment \ --language-code en \ --text "It is a beautiful day in Seattle" ``` 出力: ``` { "Sentiment": "POSITIVE", "SentimentScore": { "Positive": 0.9976957440376282, "Negative": 9.653854067437351e-05, "Neutral": 0.002169104292988777, "Mixed": 3.857641786453314e-05 } } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[感情](https://docs.aws.amazon.com/comprehend/latest/dg/how-sentiment.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DetectSentiment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/detect-sentiment.html)」を参照してください。 ### `detect-syntax` 次のコード例は、`detect-syntax` を使用する方法を示しています。 **AWS CLI** **入力テキスト内の品詞を検出するには** 次の `detect-syntax` の例では、入力テキストの構文を分析し、さまざまな品詞を返します。予測ごとに、事前トレーニング済みモデルの信頼スコアも出力されます。 ``` aws comprehend detect-syntax \ --language-code en \ --text "It is a beautiful day in Seattle." ``` 出力: ``` { "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 } } ] } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[構文分析](https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DetectSyntax](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/detect-syntax.html)」を参照してください。 ### `detect-targeted-sentiment` 次のコード例は、`detect-targeted-sentiment` を使用する方法を示しています。 **AWS CLI** **入力テキスト内の名前付きエンティティのターゲット感情を検出するには** 次の `detect-targeted-sentiment` の例では、入力テキストを分析し、名前付きエンティティと、各エンティティに関連付けられたターゲット感情を返します。予測ごとに、事前トレーニング済みモデルの信頼スコアも出力されます。 ``` 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" ``` 出力: ``` { "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 } ] } ] } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Targeted Sentiment](https://docs.aws.amazon.com/comprehend/latest/dg/how-targeted-sentiment.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DetectTargetedSentiment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/detect-targeted-sentiment.html)」を参照してください。 ### `import-model` 次のコード例は、`import-model` を使用する方法を示しています。 **AWS CLI** **モデルをインポートするには** 次の `import-model` の例では、別の AWS アカウントからモデルをインポートしています。アカウント `444455556666` のドキュメント分類子モデルには、アカウント `111122223333` がモデルをインポートできるようにするリソースベースのポリシーがあります。 ``` aws comprehend import-model \ --source-model-arn arn:aws:comprehend:us-west-2:444455556666:document-classifier/example-classifier ``` 出力: ``` { "ModelArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier" } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Copying custom models between AWS accounts](https://docs.aws.amazon.com/comprehend/latest/dg/custom-copy.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ImportModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/import-model.html)」を参照してください。 ### `list-datasets` 次のコード例は、`list-datasets` を使用する方法を示しています。 **AWS CLI** **すべてのフライホイールデータセットを一覧表示するには** 次の `list-datasets` の例では、フライホイールに関連付けられているすべてのデータセットを一覧表示しています。 ``` aws comprehend list-datasets \ --flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/flywheel-entity ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Flywheel Overview](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDatasets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-datasets.html)」を参照してください。 ### `list-document-classification-jobs` 次のコード例は、`list-document-classification-jobs` を使用する方法を示しています。 **AWS CLI** **すべてのドキュメント分類ジョブを一覧表示するには** 次の `list-document-classification-jobs` の例では、すべてのドキュメント分類ジョブを一覧表示しています。 ``` aws comprehend list-document-classification-jobs ``` 出力: ``` { "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" } ] } ``` 詳細については、「Amazon Comprehend 開発者ガイド」の「[カスタム分類](https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDocumentClassificationJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-document-classification-jobs.html)」を参照してください。 ### `list-document-classifier-summaries` 次のコード例は、`list-document-classifier-summaries` を使用する方法を示しています。 **AWS CLI** **作成されたすべてのドキュメント分類子の概要を一覧表示するには** 次の `list-document-classifier-summaries` の例では、作成されたすべてのドキュメント分類子の概要を一覧表示しています。 ``` aws comprehend list-document-classifier-summaries ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[カスタムモデルの作成と管理](https://docs.aws.amazon.com/comprehend/latest/dg/manage-models.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDocumentClassifierSummaries](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-document-classifier-summaries.html)」を参照してください。 ### `list-document-classifiers` 次のコード例は、`list-document-classifiers` を使用する方法を示しています。 **AWS CLI** **すべてのドキュメント分類子を一覧表示するには** 次の `list-document-classifiers` の例は、トレーニング済みおよびトレーニング中のすべてのドキュメント分類子モデルを一覧表示します。 ``` aws comprehend list-document-classifiers ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[カスタムモデルの作成と管理](https://docs.aws.amazon.com/comprehend/latest/dg/manage-models.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDocumentClassifiers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-document-classifiers.html)」を参照してください。 ### `list-dominant-language-detection-jobs` 次のコード例は、`list-dominant-language-detection-jobs` を使用する方法を示しています。 **AWS CLI** **すべての主要言語検出ジョブを一覧表示するには** 次の `list-dominant-language-detection-jobs` の例では、進行中および完了したすべての非同期主要言語検出ジョブを一覧表示しています。 ``` aws comprehend list-dominant-language-detection-jobs ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDominantLanguageDetectionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-dominant-language-detection-jobs.html)」を参照してください。 ### `list-endpoints` 次のコード例は、`list-endpoints` を使用する方法を示しています。 **AWS CLI** **すべてのエンドポイントを一覧表示するには** 次の `list-endpoints` の例では、すべてのアクティブなモデル固有のエンドポイントを一覧表示しています。 ``` aws comprehend list-endpoints ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のエンドポイントの管理](https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-endpoints.html)」を参照してください。 ### `list-entities-detection-jobs` 次のコード例は、`list-entities-detection-jobs` を使用する方法を示しています。 **AWS CLI** **すべてのエンティティ検出ジョブを一覧表示するには** 次の `list-entities-detection-jobs` の例では、すべての非同期エンティティ検出ジョブを一覧表示しています。 ``` aws comprehend list-entities-detection-jobs ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[エンティティ](https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListEntitiesDetectionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-entities-detection-jobs.html)」を参照してください。 ### `list-entity-recognizer-summaries` 次のコード例は、`list-entity-recognizer-summaries` を使用する方法を示しています。 **AWS CLI** **作成されたすべてのエンティティレコグナイザーの概要を一覧表示するには** 次の `list-entity-recognizer-summaries` の例では、すべてのエンティティレコグナイザーの概要を一覧表示しています。 ``` aws comprehend list-entity-recognizer-summaries ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Custom entity recognition](https://docs.aws.amazon.com/comprehend/latest/dg/custom-entity-recognition.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListEntityRecognizerSummaries](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-entity-recognizer-summaries.html)」を参照してください。 ### `list-entity-recognizers` 次のコード例は、`list-entity-recognizers` を使用する方法を示しています。 **AWS CLI** **すべてのカスタムエンティティレコグナイザーを一覧表示するには** 次の `list-entity-recognizers` の例では、作成されたすべてのカスタムエンティティレコグナイザーを一覧表示しています。 ``` aws comprehend list-entity-recognizers ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Custom entity recognition](https://docs.aws.amazon.com/comprehend/latest/dg/custom-entity-recognition.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListEntityRecognizers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-entity-recognizers.html)」を参照してください。 ### `list-events-detection-jobs` 次のコード例は、`list-events-detection-jobs` を使用する方法を示しています。 **AWS CLI** **すべてのイベント検出ジョブを一覧表示するには** 次の `list-events-detection-jobs` の例では、すべての非同期イベント検出ジョブを一覧表示しています。 ``` aws comprehend list-events-detection-jobs ``` 出力: ``` { "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" ] } ] } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListEventsDetectionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-events-detection-jobs.html)」を参照してください。 ### `list-flywheel-iteration-history` 次のコード例は、`list-flywheel-iteration-history` を使用する方法を示しています。 **AWS CLI** **すべてのフライホイールイテレーション履歴を一覧表示するには** 次の `list-flywheel-iteration-history` の例では、すべてのフライホイールイテレーションを一覧表示しています。 ``` aws comprehend list-flywheel-iteration-history --flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel ``` 出力: ``` { "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/" } ] } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Flywheel Overview](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListFlywheelIterationHistory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-flywheel-iteration-history.html)」を参照してください。 ### `list-flywheels` 次のコード例は、`list-flywheels` を使用する方法を示しています。 **AWS CLI** **すべてのフライホイールを一覧表示するには** 次の `list-flywheels` の例では、作成されたすべてのフライホイールを一覧表示しています。 ``` aws comprehend list-flywheels ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Flywheel Overview](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListFlywheels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-flywheels.html)」を参照してください。 ### `list-key-phrases-detection-jobs` 次のコード例は、`list-key-phrases-detection-jobs` を使用する方法を示しています。 **AWS CLI** **すべてのキーフレーズ検出ジョブを一覧表示するには** 次の `list-key-phrases-detection-jobs` の例では、進行中および完了したすべての非同期キーフレーズ検出ジョブを一覧表示しています。 ``` aws comprehend list-key-phrases-detection-jobs ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListKeyPhrasesDetectionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-key-phrases-detection-jobs.html)」を参照してください。 ### `list-pii-entities-detection-jobs` 次のコード例は、`list-pii-entities-detection-jobs` を使用する方法を示しています。 **AWS CLI** **すべての PII エンティティ検出ジョブを一覧表示するには** 次の `list-pii-entities-detection-jobs` の例では、進行中および完了したすべての非同期 PII 検出ジョブを一覧表示しています。 ``` aws comprehend list-pii-entities-detection-jobs ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPiiEntitiesDetectionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-pii-entities-detection-jobs.html)」を参照してください。 ### `list-sentiment-detection-jobs` 次のコード例は、`list-sentiment-detection-jobs` を使用する方法を示しています。 **AWS CLI** **すべての感情検出ジョブを一覧表示するには** 次の `list-sentiment-detection-jobs` の例では、進行中および完了したすべての非同期感情検出ジョブを一覧表示しています。 ``` aws comprehend list-sentiment-detection-jobs ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListSentimentDetectionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-sentiment-detection-jobs.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **リソースのタグを一覧表示するには** 次の `list-tags-for-resource` の例では、Amazon Comprehend リソースのタグを一覧表示しています。 ``` aws comprehend list-tags-for-resource \ --resource-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1 ``` 出力: ``` { "ResourceArn": "arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1", "Tags": [ { "Key": "Department", "Value": "Finance" }, { "Key": "location", "Value": "Seattle" } ] } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Tagging your resources](https://docs.aws.amazon.com/comprehend/latest/dg/tagging.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-tags-for-resource.html)」を参照してください。 ### `list-targeted-sentiment-detection-jobs` 次のコード例は、`list-targeted-sentiment-detection-jobs` を使用する方法を示しています。 **AWS CLI** **すべてのターゲット感情検出ジョブを一覧表示するには** 次の `list-targeted-sentiment-detection-jobs` の例では、進行中および完了したすべての非同期ターゲット感情検出ジョブを一覧表示しています。 ``` aws comprehend list-targeted-sentiment-detection-jobs ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTargetedSentimentDetectionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-targeted-sentiment-detection-jobs.html)」を参照してください。 ### `list-topics-detection-jobs` 次のコード例は、`list-topics-detection-jobs` を使用する方法を示しています。 **AWS CLI** **トピック検出ジョブをすべて一覧表示するには** 次の `list-topics-detection-jobs` の例では、進行中および完了した非同期トピック検出ジョブをすべて一覧表示します。 ``` aws comprehend list-topics-detection-jobs ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTopicsDetectionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/list-topics-detection-jobs.html)」を参照してください。 ### `put-resource-policy` 次のコード例は、`put-resource-policy` を使用する方法を示しています。 **AWS CLI** **リソースベースのポリシーをアタッチするには** 次の `put-resource-policy` の例では、リソースベースのポリシーをモデルにアタッチして、別の AWS アカウントでインポートできるようにしています。ポリシーがアカウント `111122223333` のモデルにアタッチされ、アカウント `444455556666` がモデルをインポートできます。 ``` 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"]}}]}' ``` 出力: ``` { "PolicyRevisionId": "aaa111d069d07afaa2aa3106aEXAMPLE" } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Copying custom models between AWS accounts](https://docs.aws.amazon.com/comprehend/latest/dg/custom-copy.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutResourcePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/put-resource-policy.html)」を参照してください。 ### `start-document-classification-job` 次のコード例は、`start-document-classification-job` を使用する方法を示しています。 **AWS CLI** **ドキュメント分類ジョブを開始するには** 次の `start-document-classification-job` の例では、`--input-data-config` タグで指定されたアドレスにあるすべてのファイルに対して、カスタムモデルを使用してドキュメント分類ジョブを開始します。この例では、入力 S3 バケットには、`SampleSMStext1.txt`、`SampleSMStext2.txt`、`SampleSMStext3.txt` が含まれています。このモデルは以前、迷惑メールと迷惑メールでない正規のメール、または SMS メッセージにドキュメントを分類するトレーニングを受けていました。ジョブが完了すると、`output.tar.gz` は `--output-data-config` タグで指定された場所に配置されます。`output.tar.gz` には各ドキュメントの分類を一覧表示する `predictions.jsonl` が含まれています。Json の出力は、1 ファイルに 1 行で出力されますが、ここでは読みやすい形式で表示されています。 ``` 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 ``` `SampleSMStext1.txt` の内容: ``` "CONGRATULATIONS! TXT 2155550100 to win $5000" ``` `SampleSMStext2.txt` の内容: ``` "Hi, when do you want me to pick you up from practice?" ``` `SampleSMStext3.txt` の内容: ``` "Plz send bank account # to 2155550100 to claim prize!!" ``` 出力: ``` { "JobId": "e758dd56b824aa717ceab551fEXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:document-classification-job/e758dd56b824aa717ceab551fEXAMPLE", "JobStatus": "SUBMITTED" } ``` `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}]} ``` 詳細については、「Amazon Comprehend 開発者ガイド」の「[カスタム分類](https://docs.aws.amazon.com/comprehend/latest/dg/how-document-classification.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartDocumentClassificationJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-document-classification-job.html)」を参照してください。 ### `start-dominant-language-detection-job` 次のコード例は、`start-dominant-language-detection-job` を使用する方法を示しています。 **AWS CLI** **非同期言語検出ジョブを開始するには** 次の `start-dominant-language-detection-job` の例では、`--input-data-config` タグで指定されたアドレスにあるすべてのファイルに対して非同期言語検出ジョブを開始します。この例の S3 バケットには `Sampletext1.txt` が含まれています。ジョブが完了すると、`output` フォルダが `--output-data-config` タグで指定された場所に配置されます。フォルダには `output.txt` が含まれており、これには各テキストファイルの主要言語と、予測ごとの事前トレーニング済みモデルの信頼スコアが含まれています。 ``` 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 ``` 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." ``` 出力: ``` { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:dominant-language-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobStatus": "SUBMITTED" } ``` `output.txt` の内容: ``` {"File": "Sampletext1.txt", "Languages": [{"LanguageCode": "en", "Score": 0.9913753867149353}], "Line": 0} ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartDominantLanguageDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-dominant-language-detection-job.html)」を参照してください。 ### `start-entities-detection-job` 次のコード例は、`start-entities-detection-job` を使用する方法を示しています。 **AWS CLI** **例 1: 事前トレーニング済みモデルを使用して標準エンティティ検出ジョブを開始するには** 次の `start-entities-detection-job` の例では、`--input-data-config` タグで指定されたアドレスにあるすべてのファイルに対して非同期エンティティ検出ジョブを開始します。この例の S3 バケットには `Sampletext1.txt`、`Sampletext2.txt`、`Sampletext3.txt` が含まれています。ジョブが完了すると、`output` フォルダが `--output-data-config` タグで指定された場所に配置されます。フォルダには `output.txt` が含まれており、これには各テキストファイル内で検出されたすべての名前付きエンティティと、予測ごとの事前トレーニング済みモデルの信頼スコアが一覧表示されています。Json の出力は、入力ファイルごとに 1 行に出力されますが、ここでは読みやすい形式で表示されています。 ``` 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 ``` `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." ``` `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. " ``` `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." ``` 出力: ``` { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobStatus": "SUBMITTED" } ``` 読みやすいように行にインデントを加えた `output.txt` の内容: ``` { "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 } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 **例 2: カスタムエンティティ検出ジョブを開始するには** 次の `start-entities-detection-job` の例では、`--input-data-config` タグで指定されたアドレスにあるすべてのファイルに対して非同期カスタムエンティティ検出ジョブを開始します。この例では、S3 バケットに `SampleFeedback1.txt`、`SampleFeedback2.txt`、`SampleFeedback3.txt` が含まれています。エンティティレコグナイザーモデルは、デバイス名を認識するためにカスタマーサポートフィードバックでトレーニングされました。ジョブが完了すると、`output` フォルダが `--output-data-config` タグで指定された場所に配置されます。フォルダには `output.txt` が含まれており、これには各テキストファイル内で検出されたすべての名前付きエンティティと、予測ごとの事前トレーニング済みモデルの信頼スコアが一覧表示されています。Json の出力は、1 ファイルに 1 行で出力されますが、ここでは読みやすい形式で表示されています。 ``` 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" ``` `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!" ``` `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!" ``` `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!" ``` 出力: ``` { "JobId": "019ea9edac758806850fa8a79ff83021", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:entities-detection-job/019ea9edac758806850fa8a79ff83021", "JobStatus": "SUBMITTED" } ``` 読みやすいように行にインデントを加えた `output.txt` の内容: ``` { "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 } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Custom entity recognition](https://docs.aws.amazon.com/comprehend/latest/dg/custom-entity-recognition.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartEntitiesDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-entities-detection-job.html)」を参照してください。 ### `start-events-detection-job` 次のコード例は、`start-events-detection-job` を使用する方法を示しています。 **AWS CLI** **非同期イベント検出ジョブを開始するには** 次の `start-events-detection-job` の例では、`--input-data-config` タグで指定されたアドレスにあるすべてのファイルに対して非同期イベント検出ジョブを開始します。考えられるターゲットイベントタイプには、`BANKRUPCTY`、`EMPLOYMENT`、`CORPORATE_ACQUISITION`、`INVESTMENT_GENERAL`、`CORPORATE_MERGER`、`IPO`、`RIGHTS_ISSUE`、`SECONDARY_OFFERING`、`SHELF_OFFERING`、`TENDER_OFFERING`、`STOCK_SPLIT` があります。この例の S3 バケットには `SampleText1.txt`、`SampleText2.txt`、`SampleText3.txt` が含まれています。ジョブが完了すると、`output` フォルダが `--output-data-config` タグで指定された場所に配置されます。フォルダには `SampleText1.txt.out`、`SampleText2.txt.out`、`SampleText3.txt.out` が含まれています。Json の出力は、1 ファイルに 1 行で出力されますが、ここでは読みやすい形式で表示されています。 ``` 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" ``` `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." ``` `SampleText2.txt` の内容: ``` "In 2021, AnyCompany officially purchased AnyBusiness for 100 billion dollars, surprising and exciting the shareholders." ``` `SampleText3.txt` の内容: ``` "In 2022, AnyCompany stock crashed 50. Eventually later that year they filed for bankruptcy." ``` 出力: ``` { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:events-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobStatus": "SUBMITTED" } ``` 読みやすいように行にインデントを加えた `SampleText1.txt.out` の内容: ``` { "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 } ``` `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 } ``` `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 } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartEventsDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-events-detection-job.html)」を参照してください。 ### `start-flywheel-iteration` 次のコード例は、`start-flywheel-iteration` を使用する方法を示しています。 **AWS CLI** **フライホイールイテレーションを開始するには** 次の `start-flywheel-iteration` の例では、フライホイールイテレーションを開始しています。このオペレーションでは、フライホイール内の新しいデータセットを使用して、新しいモデルバージョンをトレーニングしています。 ``` aws comprehend start-flywheel-iteration \ --flywheel-arn arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel ``` 出力: ``` { "FlywheelArn": "arn:aws:comprehend:us-west-2:111122223333:flywheel/example-flywheel", "FlywheelIterationId": "12345123TEXAMPLE" } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Flywheel Overview](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartFlywheelIteration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-flywheel-iteration.html)」を参照してください。 ### `start-key-phrases-detection-job` 次のコード例は、`start-key-phrases-detection-job` を使用する方法を示しています。 **AWS CLI** **キーフレーズ検出ジョブを開始するには** 次の `start-key-phrases-detection-job` の例では、`--input-data-config` タグで指定されたアドレスにあるすべてのファイルに対して非同期キーフレーズ検出ジョブを開始しています。この例の S3 バケットには `Sampletext1.txt`、`Sampletext2.txt`、`Sampletext3.txt` が含まれています。ジョブが完了すると、`output` フォルダが `--output-data-config` タグで指定された場所に配置されます。フォルダには `output.txt` ファイルが含まれており、これには各テキストファイル内で検出されたすべてのキーフレーズと、予測ごとの事前トレーニング済みモデルの信頼スコアが含まれています。Json の出力は、1 ファイルに 1 行で出力されますが、ここでは読みやすい形式で表示されています。 ``` 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 ``` `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." ``` `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. " ``` `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." ``` 出力: ``` { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobStatus": "SUBMITTED" } ``` 読みやすいように行にインデントを加えた `output.txt` の内容: ``` { "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 } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartKeyPhrasesDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-key-phrases-detection-job.html)」を参照してください。 ### `start-pii-entities-detection-job` 次のコード例は、`start-pii-entities-detection-job` を使用する方法を示しています。 **AWS CLI** **非同期 PII 検出ジョブを開始するには** 次の `start-pii-entities-detection-job` の例では、`--input-data-config` タグで指定されたアドレスにあるすべてのファイルに対して非同期の個人を特定できる情報 (PII) エンティティ検出ジョブを開始します。この例の S3 バケットには `Sampletext1.txt`、`Sampletext2.txt`、`Sampletext3.txt` が含まれています。ジョブが完了すると、`output` フォルダが `--output-data-config` タグで指定された場所に配置されます。フォルダには、各テキストファイル内の名前付きエンティティを一覧表示している `SampleText1.txt.out`、`SampleText2.txt.out`、`SampleText3.txt.out` が含まれています。Json の出力は、1 ファイルに 1 行で出力されますが、ここでは読みやすい形式で表示されています。 ``` 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 ``` `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." ``` `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. " ``` `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." ``` 出力: ``` { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:pii-entities-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobStatus": "SUBMITTED" } ``` 読みやすいように行にインデントを加えた `SampleText1.txt.out` の内容: ``` { "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 } ``` 読みやすいように行にインデントを加えた `SampleText2.txt.out` の内容: ``` { "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 } ``` 読みやすいように行にインデントを加えた `SampleText3.txt.out` の内容: ``` { "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 } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartPiiEntitiesDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-pii-entities-detection-job.html)」を参照してください。 ### `start-sentiment-detection-job` 次のコード例は、`start-sentiment-detection-job` を使用する方法を示しています。 **AWS CLI** **非同期感情分析ジョブを開始するには** 次の `start-sentiment-detection-job` の例では、`--input-data-config` タグで指定されたアドレスにあるすべてのファイルに対して非同期感情分析検出ジョブを開始します。この例の S3 バケットフォルダには `SampleMovieReview1.txt`、`SampleMovieReview2.txt`、`SampleMovieReview3.txt` が含まれています。ジョブが完了すると、`output` フォルダが `--output-data-config` タグで指定された場所に配置されます。フォルダには `output.txt` ファイルが含まれており、これには各テキストファイルの一般的な感情と、予測ごとの事前トレーニング済みモデルの信頼スコアが含まれています。Json の出力は、1 ファイルに 1 行で出力されますが、ここでは読みやすい形式で表示されています。 ``` 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 ``` `SampleMovieReview1.txt` の内容: ``` "The film, AnyMovie2, is fairly predictable and just okay." ``` `SampleMovieReview2.txt` の内容: ``` "AnyMovie2 is the essential sci-fi film that I grew up watching when I was a kid. I highly recommend this movie." ``` `SampleMovieReview3.txt` の内容: ``` "Don't get fooled by the 'awards' for AnyMovie2. All parts of the film were poorly stolen from other modern directors." ``` 出力: ``` { "JobId": "0b5001e25f62ebb40631a9a1a7fde7b3", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:sentiment-detection-job/0b5001e25f62ebb40631a9a1a7fde7b3", "JobStatus": "SUBMITTED" } ``` 読みやすいように行にインデントを加えた `output.txt` の内容: ``` { "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 } } } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartSentimentDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-sentiment-detection-job.html)」を参照してください。 ### `start-targeted-sentiment-detection-job` 次のコード例は、`start-targeted-sentiment-detection-job` を使用する方法を示しています。 **AWS CLI** **非同期ターゲット感情分析ジョブを開始するには** 次の `start-targeted-sentiment-detection-job` の例では、`--input-data-config` タグで指定されたアドレスにあるすべてのファイルに対して非同期ターゲット感情分析検出ジョブを開始しています。この例の S3 バケットフォルダには `SampleMovieReview1.txt`、`SampleMovieReview2.txt`、`SampleMovieReview3.txt` が含まれています。ジョブが完了すると、`output.tar.gz` が `--output-data-config` タグで指定された場所に配置されます。`output.tar.gz` には、ファイル `SampleMovieReview1.txt.out`、`SampleMovieReview2.txt.out`、`SampleMovieReview3.txt.out` が含まれており、それぞれには 1 つの入力テキストファイルの名前付きエンティティと関連する感情がすべて含まれています。 ``` 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 ``` `SampleMovieReview1.txt` の内容: ``` "The film, AnyMovie, is fairly predictable and just okay." ``` `SampleMovieReview2.txt` の内容: ``` "AnyMovie is the essential sci-fi film that I grew up watching when I was a kid. I highly recommend this movie." ``` `SampleMovieReview3.txt` の内容: ``` "Don't get fooled by the 'awards' for AnyMovie. All parts of the film were poorly stolen from other modern directors." ``` 出力: ``` { "JobId": "0b5001e25f62ebb40631a9a1a7fde7b3", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/0b5001e25f62ebb40631a9a1a7fde7b3", "JobStatus": "SUBMITTED" } ``` 読みやすいように行にインデントを加えた `SampleMovieReview1.txt.out` の内容: ``` { "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 } ``` 読みやすいように行にインデントを加えた `SampleMovieReview2.txt.out` の内容: ``` { "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 } ``` 読みやすいように行にインデントを加えた `SampleMovieReview3.txt.out` の内容: ``` { "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 } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartTargetedSentimentDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-targeted-sentiment-detection-job.html)」を参照してください。 ### `start-topics-detection-job` 次のコード例は、`start-topics-detection-job` を使用する方法を示しています。 **AWS CLI** **トピック検出分析ジョブを開始するには** 次の `start-topics-detection-job` の例では、`--input-data-config` タグで指定されたアドレスにあるすべてのファイルの非同期トピック検出ジョブを開始します。ジョブが完了すると、フォルダ、`output` は `--ouput-data-config` タグで指定された場所に配置されます。`output` には topic-terms.csv と doc-topics.csv が含まれています。最初の出力ファイル topic-terms.csv は、コレクション内のトピックのリストです。デフォルトでは、リストには、各トピックの上位の言葉が重みに応じてトピック別に含まれています。2 つ目のファイル `doc-topics.csv` には、トピックに関連するドキュメントと、そのトピックに関係するドキュメントの割合が一覧表示されます。 ``` 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 ``` 出力: ``` { "JobId": "123456abcdeb0e11022f22a11EXAMPLE", "JobArn": "arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/123456abcdeb0e11022f22a11EXAMPLE", "JobStatus": "SUBMITTED" } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[トピックのモデリング](https://docs.aws.amazon.com/comprehend/latest/dg/topic-modeling.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartTopicsDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/start-topics-detection-job.html)」を参照してください。 ### `stop-dominant-language-detection-job` 次のコード例は、`stop-dominant-language-detection-job` を使用する方法を示しています。 **AWS CLI** **非同期主要言語検出ジョブを停止するには** 次の `stop-dominant-language-detection-job` の例では、進行中の非同期主要言語検出ジョブを停止しています。ジョブの現在の状態が `IN_PROGRESS` の場合、そのジョブは終了としてマークされ、状態が `STOP_REQUESTED` になります。ジョブを停止する前にジョブが完了した場合、そのジョブの状態は `COMPLETED` になります。 ``` aws comprehend stop-dominant-language-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` 出力: ``` { "JobId": "123456abcdeb0e11022f22a11EXAMPLE, "JobStatus": "STOP_REQUESTED" } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopDominantLanguageDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/stop-dominant-language-detection-job.html)」を参照してください。 ### `stop-entities-detection-job` 次のコード例は、`stop-entities-detection-job` を使用する方法を示しています。 **AWS CLI** **非同期エンティティ検出ジョブを停止するには** 次の `stop-entities-detection-job` の例では、進行中の非同期エンティティ検出ジョブを停止しています。ジョブの現在の状態が `IN_PROGRESS` の場合、そのジョブは終了としてマークされ、状態が `STOP_REQUESTED` になります。ジョブを停止する前にジョブが完了した場合、そのジョブの状態は `COMPLETED` になります。 ``` aws comprehend stop-entities-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` 出力: ``` { "JobId": "123456abcdeb0e11022f22a11EXAMPLE, "JobStatus": "STOP_REQUESTED" } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopEntitiesDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/stop-entities-detection-job.html)」を参照してください。 ### `stop-events-detection-job` 次のコード例は、`stop-events-detection-job` を使用する方法を示しています。 **AWS CLI** **非同期イベント検出ジョブを停止するには** 次の `stop-events-detection-job` の例では、進行中の非同期イベント検出ジョブを停止しています。ジョブの現在の状態が `IN_PROGRESS` の場合、そのジョブは終了としてマークされ、状態が `STOP_REQUESTED` になります。ジョブを停止する前にジョブが完了した場合、そのジョブの状態は `COMPLETED` になります。 ``` aws comprehend stop-events-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` 出力: ``` { "JobId": "123456abcdeb0e11022f22a11EXAMPLE, "JobStatus": "STOP_REQUESTED" } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopEventsDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/stop-events-detection-job.html)」を参照してください。 ### `stop-key-phrases-detection-job` 次のコード例は、`stop-key-phrases-detection-job` を使用する方法を示しています。 **AWS CLI** **非同期キーフレーズ検出ジョブを停止するには** 次の `stop-key-phrases-detection-job` の例では、進行中の非同期キーフレーズ検出ジョブを停止しています。ジョブの現在の状態が `IN_PROGRESS` の場合、そのジョブは終了としてマークされ、状態が `STOP_REQUESTED` になります。ジョブを停止する前にジョブが完了した場合、そのジョブの状態は `COMPLETED` になります。 ``` aws comprehend stop-key-phrases-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` 出力: ``` { "JobId": "123456abcdeb0e11022f22a11EXAMPLE, "JobStatus": "STOP_REQUESTED" } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopKeyPhrasesDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/stop-key-phrases-detection-job.html)」を参照してください。 ### `stop-pii-entities-detection-job` 次のコード例は、`stop-pii-entities-detection-job` を使用する方法を示しています。 **AWS CLI** **非同期 PII エンティティ検出ジョブを停止するには** 次の `stop-pii-entities-detection-job` の例では、進行中の非同期 PII エンティティ検出ジョブを停止しています。ジョブの現在の状態が `IN_PROGRESS` の場合、そのジョブは終了としてマークされ、状態が `STOP_REQUESTED` になります。ジョブを停止する前にジョブが完了した場合、そのジョブの状態は `COMPLETED` になります。 ``` aws comprehend stop-pii-entities-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` 出力: ``` { "JobId": "123456abcdeb0e11022f22a11EXAMPLE, "JobStatus": "STOP_REQUESTED" } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopPiiEntitiesDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/stop-pii-entities-detection-job.html)」を参照してください。 ### `stop-sentiment-detection-job` 次のコード例は、`stop-sentiment-detection-job` を使用する方法を示しています。 **AWS CLI** **非同期感情検出ジョブを停止するには** 次の `stop-sentiment-detection-job` の例では、進行中の非同期感情検出ジョブを停止しています。ジョブの現在の状態が `IN_PROGRESS` の場合、そのジョブは終了としてマークされ、状態が `STOP_REQUESTED` になります。ジョブを停止する前にジョブが完了した場合、そのジョブの状態は `COMPLETED` になります。 ``` aws comprehend stop-sentiment-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` 出力: ``` { "JobId": "123456abcdeb0e11022f22a11EXAMPLE, "JobStatus": "STOP_REQUESTED" } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopSentimentDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/stop-sentiment-detection-job.html)」を参照してください。 ### `stop-targeted-sentiment-detection-job` 次のコード例は、`stop-targeted-sentiment-detection-job` を使用する方法を示しています。 **AWS CLI** **非同期ターゲット感情検出ジョブを停止するには** 次の `stop-targeted-sentiment-detection-job` の例では、進行中の非同期ターゲット感情検出ジョブを停止しています。ジョブの現在の状態が `IN_PROGRESS` の場合、そのジョブは終了としてマークされ、状態が `STOP_REQUESTED` になります。ジョブを停止する前にジョブが完了した場合、そのジョブの状態は `COMPLETED` になります。 ``` aws comprehend stop-targeted-sentiment-detection-job \ --job-id 123456abcdeb0e11022f22a11EXAMPLE ``` 出力: ``` { "JobId": "123456abcdeb0e11022f22a11EXAMPLE, "JobStatus": "STOP_REQUESTED" } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のインサイトのための非同期分析](https://docs.aws.amazon.com/comprehend/latest/dg/api-async-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopTargetedSentimentDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/stop-targeted-sentiment-detection-job.html)」を参照してください。 ### `stop-training-document-classifier` 次のコード例は、`stop-training-document-classifier` を使用する方法を示しています。 **AWS CLI** **ドキュメント分類子モデルのトレーニングを停止するには** 次の `stop-training-document-classifier` の例では、進行中のドキュメント分類子モデルのトレーニングを停止しています。 ``` aws comprehend stop-training-document-classifier --document-classifier-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[カスタムモデルの作成と管理](https://docs.aws.amazon.com/comprehend/latest/dg/manage-models.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopTrainingDocumentClassifier](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/stop-training-document-classifier.html)」を参照してください。 ### `stop-training-entity-recognizer` 次のコード例は、`stop-training-entity-recognizer` を使用する方法を示しています。 **AWS CLI** **エンティティレコグナイザーモデルのトレーニングを停止するには** 次の `stop-training-entity-recognizer` の例では、進行中のエンティティレコグナイザーモデルのトレーニングを停止しています。 ``` aws comprehend stop-training-entity-recognizer --entity-recognizer-arn "arn:aws:comprehend:us-west-2:111122223333:entity-recognizer/examplerecognizer1" ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[カスタムモデルの作成と管理](https://docs.aws.amazon.com/comprehend/latest/dg/manage-models.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopTrainingEntityRecognizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/stop-training-entity-recognizer.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **例 1: リソースにタグを付けるには** 次の `tag-resource` の例では、Amazon Comprehend リソースにタグを 1 つ追加しています。 ``` aws comprehend tag-resource \ --resource-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1 \ --tags Key=Location,Value=Seattle ``` このコマンドには出力がありません。 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Tagging your resources](https://docs.aws.amazon.com/comprehend/latest/dg/tagging.html)」を参照してください。 **例 2: 複数のタグをリソースに追加する** 次の `tag-resource` の例では、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 ``` このコマンドには出力がありません。 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Tagging your resources](https://docs.aws.amazon.com/comprehend/latest/dg/tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **例 1: リソースから 1 つのタグを削除するには** 次の `untag-resource` の例では、Amazon Comprehend リソースからタグを 1 つ削除しています。 ``` aws comprehend untag-resource \ --resource-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier/example-classifier/version/1 --tag-keys Location ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Tagging your resources](https://docs.aws.amazon.com/comprehend/latest/dg/tagging.html)」を参照してください。 **例 2: リソースから複数のタグを削除するには** 次の `untag-resource` の例では、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 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Tagging your resources](https://docs.aws.amazon.com/comprehend/latest/dg/tagging.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/untag-resource.html)」を参照してください。 ### `update-endpoint` 次のコード例は、`update-endpoint` を使用する方法を示しています。 **AWS CLI** **例 1: エンドポイントの推論ユニットを更新するには** 次の `update-endpoint` の例では、エンドポイントに関する情報を更新しています。この例では、推論ユニットの数が増加します。 ``` aws comprehend update-endpoint \ --endpoint-arn arn:aws:comprehend:us-west-2:111122223333:document-classifier-endpoint/example-classifier-endpoint --desired-inference-units 2 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のエンドポイントの管理](https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html)」を参照してください。 **例 2: エンドポイントのアクティブモデルを更新するには** 次の `update-endpoint` の例では、エンドポイントに関する情報を更新しています。この例では、アクティブモデルが変更されます。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Amazon Comprehend のエンドポイントの管理](https://docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/update-endpoint.html)」を参照してください。 ### `update-flywheel` 次のコード例は、`update-flywheel` を使用する方法を示しています。 **AWS CLI** **フライホイールの設定を更新するには** 次の `update-flywheel` の例では、フライホイールの設定を更新しています。この例では、フライホイールのアクティブモデルが更新されます。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Comprehend デベロッパーガイド*」の「[Flywheel Overview](https://docs.aws.amazon.com/comprehend/latest/dg/flywheels-about.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateFlywheel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehend/update-flywheel.html)」を参照してください。 # AWS CLI を使用した Amazon Comprehend Medical の例 次のコード例は、Amazon Comprehend Medical で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `describe-entities-detection-v2-job` 次のコード例は、`describe-entities-detection-v2-job` を使用する方法を示しています。 **AWS CLI** **エンティティ検出ジョブを記述するには** 次の `describe-entities-detection-v2-job` の例では、非同期エンティティ検出ジョブに関連付けられたプロパティを表示しています。 ``` aws comprehendmedical describe-entities-detection-v2-job \ --job-id "ab9887877365fe70299089371c043b96" ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[Batch APIs](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-batchapi.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEntitiesDetectionV2Job](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/describe-entities-detection-v2-job.html)」を参照してください。 ### `describe-icd10-cm-inference-job` 次のコード例は、`describe-icd10-cm-inference-job` を使用する方法を示しています。 **AWS CLI** **ICD-10-CM 推論ジョブを記述するには** 次の `describe-icd10-cm-inference-job` の例では、指定された job-id を持つリクエストされた推論ジョブのプロパティを表示しています。 ``` aws comprehendmedical describe-icd10-cm-inference-job \ --job-id "5780034166536cdb52ffa3295a1b00a7" ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[Ontology linking batch analysis](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeIcd10CmInferenceJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/describe-icd10-cm-inference-job.html)」を参照してください。 ### `describe-phi-detection-job` 次のコード例は、`describe-phi-detection-job` を使用する方法を示しています。 **AWS CLI** **PHI 検出ジョブを記述するには** 次の `describe-phi-detection-job` の例では、非同期の保護対象の医療情報 (PHI) 検出ジョブに関連付けられたプロパティを表示しています。 ``` aws comprehendmedical describe-phi-detection-job \ --job-id "4750034166536cdb52ffa3295a1b00a3" ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[Batch APIs](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-batchapi.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribePhiDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/describe-phi-detection-job.html)」を参照してください。 ### `describe-rx-norm-inference-job` 次のコード例は、`describe-rx-norm-inference-job` を使用する方法を示しています。 **AWS CLI** **RxNorm 推論ジョブを記述するには** 次の `describe-rx-norm-inference-job` の例では、指定された job-id を持つリクエストされた推論ジョブのプロパティを表示しています。 ``` aws comprehendmedical describe-rx-norm-inference-job \ --job-id "eg8199877365fc70299089371c043b96" ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[Ontology linking batch analysis](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeRxNormInferenceJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/describe-rx-norm-inference-job.html)」を参照してください。 ### `describe-snomedct-inference-job` 次のコード例は、`describe-snomedct-inference-job` を使用する方法を示しています。 **AWS CLI** **SNOMED CT 推論ジョブを記述するには** 次の `describe-snomedct-inference-job` の例では、指定された job-id を持つリクエストされた推論ジョブのプロパティを表示しています。 ``` aws comprehendmedical describe-snomedct-inference-job \ --job-id "2630034166536cdb52ffa3295a1b00a7" ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[Ontology linking batch analysis](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeSnomedctInferenceJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/describe-snomedct-inference-job.html)」を参照してください。 ### `detect-entities-v2` 次のコード例は、`detect-entities-v2` を使用する方法を示しています。 **AWS CLI** **例 1: テキストから直接エンティティを検出するには** 次の `detect-entities-v2` の例では、検出されたエンティティを表示し、入力テキストから直接タイプに従ってラベル付けしています。 ``` aws comprehendmedical detect-entities-v2 \ --text "Sleeping trouble on present dosage of Clonidine. Severe rash on face and leg, slightly itchy." ``` 出力: ``` { "Id": 0, "BeginOffset": 38, "EndOffset": 47, "Score": 0.9942955374717712, "Text": "Clonidine", "Category": "MEDICATION", "Type": "GENERIC_NAME", "Traits": [] } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[Detect Entities Version 2](https://docs.aws.amazon.com/comprehend/latest/dg/extracted-med-info-V2.html)」を参照してください。 **例 2: ファイルパスからエンティティを検出するには** 次の `detect-entities-v2` の例では、検出されたエンティティを表示し、ファイルパスのタイプに従ってラベル付けしています。 ``` aws comprehendmedical detect-entities-v2 \ --text file://medical_entities.txt ``` `medical_entities.txt` の内容: ``` { "Sleeping trouble on present dosage of Clonidine. Severe rash on face and leg, slightly itchy." } ``` 出力: ``` { "Id": 0, "BeginOffset": 38, "EndOffset": 47, "Score": 0.9942955374717712, "Text": "Clonidine", "Category": "MEDICATION", "Type": "GENERIC_NAME", "Traits": [] } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[Detect Entities Version 2](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-entitiesv2.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DetectEntitiesV2](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/detect-entities-v2.html)」を参照してください。 ### `detect-phi` 次のコード例は、`detect-phi` を使用する方法を示しています。 **AWS CLI** **例 1: 保護対象の医療情報 (PHI) をテキストから直接検出するには** 次の `detect-phi` の例では、検出された保護対象の医療情報 (PHI) エンティティを入力テキストから直接表示しています。 ``` 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." ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[Detect PHI](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-phi.html)」を参照してください。 **例 2: ファイルパスから直接、保護対象の医療情報 (PHI) を検出するには** 次の `detect-phi` の例では、ファイルパスから検出された保護対象の医療情報 (PHI) エンティティを表示しています。 ``` aws comprehendmedical detect-phi \ --text file://phi.txt ``` `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." ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[Detect PHI](https://docs.aws.amazon.com/comprehend/latest/dg/how-medical-phi.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DetectPhi](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/detect-phi.html)」を参照してください。 ### `infer-icd10-cm` 次のコード例は、`infer-icd10-cm` を使用する方法を示しています。 **AWS CLI** **例 1: 病状エンティティを検出し、テキストから直接 ICD-10-CM オントロジーにリンクするには** 次の `infer-icd10-cm` の例では、検出された病状エンティティにラベルを付け、それらのエンティティを国際疾病分類の 2019 年改訂版 (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." ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[Infer ICD10-CM](https://docs.aws.amazon.com/comprehend/latest/dg/ontology-linking-icd10.html)」を参照してください。 **例 2: ファイルパスウェイから病状エンティティを検出し、ICD-10-CM オントロジーにリンクするには** 次の `infer-icd-10-cm` の例では、検出された病状エンティティにラベルを付け、それらのエンティティを国際疾病分類の 2019 年改訂版 (ICD-10-CM) のコードにリンクしています。 ``` aws comprehendmedical infer-icd10-cm \ --text file://icd10cm.txt ``` `icd10cm.txt` の内容: ``` { "The patient complains of abdominal pain, has a long-standing history of diabetes treated with Micronase daily." } ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[Infer-ICD10-CM](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontology-icd10.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[InferIcd10Cm](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/infer-icd10-cm.html)」を参照してください。 ### `infer-rx-norm` 次のコード例は、`infer-rx-norm` を使用する方法を示しています。 **AWS CLI** **例 1: 薬剤エンティティを検出し、テキストから直接 RxNorm にリンクするには** 次の `infer-rx-norm` の例では、検出された薬剤エンティティを表示してラベル付けし、それらのエンティティを米国国立医学図書館の RxNorm データベースの概念識別子 (RxCUI) にリンクしています。 ``` aws comprehendmedical infer-rx-norm \ --text "Patient reports taking Levothyroxine 125 micrograms p.o. once daily, but denies taking Synthroid." ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[Infer RxNorm](https://docs.aws.amazon.com/comprehend/latest/dg/ontology-linking-rxnorm.html)」を参照してください。 **例 2: 薬剤エンティティを検出し、ファイルパスから RxNorm にリンクするには。** 次の `infer-rx-norm` の例では、検出された薬剤エンティティを表示してラベル付けし、それらのエンティティを米国国立医学図書館の RxNorm データベースの概念識別子 (RxCUI) にリンクしています。 ``` aws comprehendmedical infer-rx-norm \ --text file://rxnorm.txt ``` `rxnorm.txt` の内容: ``` { "Patient reports taking Levothyroxine 125 micrograms p.o. once daily, but denies taking Synthroid." } ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[Infer RxNorm](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontology-RxNorm.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[InferRxNorm](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/infer-rx-norm.html)」を参照してください。 ### `infer-snomedct` 次のコード例は、`infer-snomedct` を使用する方法を示しています。 **AWS CLI** **例: エンティティを検出し、テキストから直接 SNOMED CT オントロジーにリンクする** 次の `infer-snomedct` の例では、薬剤エンティティを検出し、それらを 2021-03 バージョンの国際医療用語集 (Systematized Nomenclature of Medicine, Clinical Terms: SNOMED CT) の概念にリンクする方法を示しています。 ``` aws comprehendmedical infer-snomedct \ --text "The patient complains of abdominal pain, has a long-standing history of diabetes treated with Micronase daily." ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[InferSNOMEDCT](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontology-linking-snomed.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[InferSnomedct](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/infer-snomedct.html)」を参照してください。 ### `list-entities-detection-v2-jobs` 次のコード例は、`list-entities-detection-v2-jobs` を使用する方法を示しています。 **AWS CLI** **エンティティ検出ジョブを一覧表示するには** 次の `list-entities-detection-v2-jobs` の例では、現在の非同期検出ジョブを一覧表示しています。 ``` aws comprehendmedical list-entities-detection-v2-jobs ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[Batch APIs](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-batchapi.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListEntitiesDetectionV2Jobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/list-entities-detection-v2-jobs.html)」を参照してください。 ### `list-icd10-cm-inference-jobs` 次のコード例は、`list-icd10-cm-inference-jobs` を使用する方法を示しています。 **AWS CLI** **現在のすべての ICD-10-CM 推論ジョブを一覧表示するには** 次の例では、`list-icd10-cm-inference-jobs` オペレーションが現在の非同期 ICD-10-CM バッチ推論ジョブのリストを返す方法を示します。 ``` aws comprehendmedical list-icd10-cm-inference-jobs ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[Ontology linking batch analysis](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListIcd10CmInferenceJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/list-icd10-cm-inference-jobs.html)」を参照してください。 ### `list-phi-detection-jobs` 次のコード例は、`list-phi-detection-jobs` を使用する方法を示しています。 **AWS CLI** **保護対象の医療情報 (PHI) 検出ジョブを一覧表示するには** 次の `list-phi-detection-jobs` の例では、現在の保護対象の医療情報 (PHI) 検出ジョブを一覧表示しています。 ``` aws comprehendmedical list-phi-detection-jobs ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[Batch APIs](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-batchapi.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPhiDetectionJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/list-phi-detection-jobs.html)」を参照してください。 ### `list-rx-norm-inference-jobs` 次のコード例は、`list-rx-norm-inference-jobs` を使用する方法を示しています。 **AWS CLI** **現在のすべての Rx-Norm 推論ジョブを一覧表示するには** 次の例では、`list-rx-norm-inference-jobs` が現在の非同期 Rx-Norm バッチ推論ジョブのリストを返す方法を示します。 ``` aws comprehendmedical list-rx-norm-inference-jobs ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[Ontology linking batch analysis](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRxNormInferenceJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/list-rx-norm-inference-jobs.html)」を参照してください。 ### `list-snomedct-inference-jobs` 次のコード例は、`list-snomedct-inference-jobs` を使用する方法を示しています。 **AWS CLI** **すべての SNOMED CT 推論ジョブを一覧表示するには** 次の例では、`list-snomedct-inference-jobs` オペレーションが現在の非同期 SNOMED CT バッチ推論ジョブのリストを返す方法を示します。 ``` aws comprehendmedical list-snomedct-inference-jobs ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[Ontology linking batch analysis](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListSnomedctInferenceJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/list-snomedct-inference-jobs.html)」を参照してください。 ### `start-entities-detection-v2-job` 次のコード例は、`start-entities-detection-v2-job` を使用する方法を示しています。 **AWS CLI** **エンティティ検出ジョブを開始するには** 次の `start-entities-detection-v2-job` の例では、非同期エンティティ検出ジョブを開始しています。 ``` 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 ``` 出力: ``` { "JobId": "ab9887877365fe70299089371c043b96" } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[Batch APIs](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-batchapi.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartEntitiesDetectionV2Job](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/start-entities-detection-v2-job.html)」を参照してください。 ### `start-icd10-cm-inference-job` 次のコード例は、`start-icd10-cm-inference-job` を使用する方法を示しています。 **AWS CLI** **ICD-10-CM 推論ジョブを開始するには** 次の `start-icd10-cm-inference-job` の例では、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 ``` 出力: ``` { "JobId": "ef7289877365fc70299089371c043b96" } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[Ontology linking batch analysis](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartIcd10CmInferenceJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/start-icd10-cm-inference-job.html)」を参照してください。 ### `start-phi-detection-job` 次のコード例は、`start-phi-detection-job` を使用する方法を示しています。 **AWS CLI** **PHI 検出ジョブを開始するには** 次の `start-phi-detection-job` の例では、非同期 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 ``` 出力: ``` { "JobId": "ab9887877365fe70299089371c043b96" } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[Batch APIs](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-batchapi.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartPhiDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/start-phi-detection-job.html)」を参照してください。 ### `start-rx-norm-inference-job` 次のコード例は、`start-rx-norm-inference-job` を使用する方法を示しています。 **AWS CLI** **RxNorm 推論ジョブを開始するには** 次の `start-rx-norm-inference-job` の例では、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 ``` 出力: ``` { "JobId": "eg8199877365fc70299089371c043b96" } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[Ontology linking batch analysis](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartRxNormInferenceJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/start-rx-norm-inference-job.html)」を参照してください。 ### `start-snomedct-inference-job` 次のコード例は、`start-snomedct-inference-job` を使用する方法を示しています。 **AWS CLI** **SNOMED CT 推論ジョブを開始するには** 次の `start-snomedct-inference-job` の例では、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 ``` 出力: ``` { "JobId": "dg7289877365fc70299089371c043b96" } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[Ontology linking batch analysis](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartSnomedctInferenceJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/start-snomedct-inference-job.html)」を参照してください。 ### `stop-entities-detection-v2-job` 次のコード例は、`stop-entities-detection-v2-job` を使用する方法を示しています。 **AWS CLI** **エンティティ検出ジョブを停止するには** 次の `stop-entities-detection-v2-job` の例では、非同期エンティティ検出ジョブを停止しています。 ``` aws comprehendmedical stop-entities-detection-v2-job \ --job-id "ab9887877365fe70299089371c043b96" ``` 出力: ``` { "JobId": "ab9887877365fe70299089371c043b96" } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[Batch APIs](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-batchapi.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopEntitiesDetectionV2Job](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/stop-entities-detection-v2-job.html)」を参照してください。 ### `stop-icd10-cm-inference-job` 次のコード例は、`stop-icd10-cm-inference-job` を使用する方法を示しています。 **AWS CLI** **ICD-10-CM 推論ジョブを停止するには** 次の `stop-icd10-cm-inference-job` の例では、ICD-10-CM 推論バッチ分析ジョブを停止しています。 ``` aws comprehendmedical stop-icd10-cm-inference-job \ --job-id "4750034166536cdb52ffa3295a1b00a3" ``` 出力: ``` { "JobId": "ef7289877365fc70299089371c043b96", } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[Ontology linking batch analysis](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopIcd10CmInferenceJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/stop-icd10-cm-inference-job.html)」を参照してください。 ### `stop-phi-detection-job` 次のコード例は、`stop-phi-detection-job` を使用する方法を示しています。 **AWS CLI** **保護対象の医療情報 (PHI) 検出ジョブを停止するには** 次の `stop-phi-detection-job` の例では、非同期保護対象の医療情報 (PHI) 検出ジョブを停止しています。 ``` aws comprehendmedical stop-phi-detection-job \ --job-id "4750034166536cdb52ffa3295a1b00a3" ``` 出力: ``` { "JobId": "ab9887877365fe70299089371c043b96" } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[Batch APIs](https://docs.aws.amazon.com/comprehend-medical/latest/dev/textanalysis-batchapi.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopPhiDetectionJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/stop-phi-detection-job.html)」を参照してください。 ### `stop-rx-norm-inference-job` 次のコード例は、`stop-rx-norm-inference-job` を使用する方法を示しています。 **AWS CLI** **RxNorm 推論ジョブを停止するには** 次の `stop-rx-norm-inference-job` の例では、ICD-10-CM 推論バッチ分析ジョブを停止しています。 ``` aws comprehendmedical stop-rx-norm-inference-job \ --job-id "eg8199877365fc70299089371c043b96" ``` 出力: ``` { "JobId": "eg8199877365fc70299089371c043b96", } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[Ontology linking batch analysis](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopRxNormInferenceJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/stop-rx-norm-inference-job.html)」を参照してください。 ### `stop-snomedct-inference-job` 次のコード例は、`stop-snomedct-inference-job` を使用する方法を示しています。 **AWS CLI** **SNOMED CT 推論ジョブを停止するには** 次の `stop-snomedct-inference-job` の例では、SNOMED CT 推論バッチ分析ジョブを停止しています。 ``` aws comprehendmedical stop-snomedct-inference-job \ --job-id "8750034166436cdb52ffa3295a1b00a1" ``` 出力: ``` { "JobId": "8750034166436cdb52ffa3295a1b00a1", } ``` 詳細については、「*Amazon Comprehend Medical デベロッパーガイド*」の「[Ontology linking batch analysis](https://docs.aws.amazon.com/comprehend-medical/latest/dev/ontologies-batchapi.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopSnomedctInferenceJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/comprehendmedical/stop-snomedct-inference-job.html)」を参照してください。 # AWS Config examples using AWS CLI 次のコード例では、AWS Config で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `delete-config-rule` 次のコード例は、`delete-config-rule` を使用する方法を示しています。 **AWS CLI** **AWS Config ルールを削除するには** 次のコマンドは、`MyConfigRule` という名前の AWS Config ルールを削除します。 ``` aws configservice delete-config-rule --config-rule-name MyConfigRule ``` + API の詳細については、AWS CLI コマンドリファレンスの「[DeleteConfigRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/delete-config-rule.html)」を参照してください。** ### `delete-delivery-channel` 次のコード例は、`delete-delivery-channel` を使用する方法を示しています。 **AWS CLI** **配信チャネルを削除するには** 次のコマンドでは、デフォルトの配信チャネルを削除しています。 ``` aws configservice delete-delivery-channel --delivery-channel-name default ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDeliveryChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/delete-delivery-channel.html)」を参照してください。 ### `delete-evaluation-results` 次のコード例は、`delete-evaluation-results` を使用する方法を示しています。 **AWS CLI** **手動で評価結果を削除するには** 次のコマンドは、AWS のマネージドルール s3-bucket-versioning-enabled の現在の評価結果を削除します。 ``` aws configservice delete-evaluation-results --config-rule-name s3-bucket-versioning-enabled ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteEvaluationResults](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/delete-evaluation-results.html)」を参照してください。 ### `deliver-config-snapshot` 次のコード例は、`deliver-config-snapshot` を使用する方法を示しています。 **AWS CLI** **設定スナップショットを配信するには** 次のコマンドは、デフォルトの配信チャネルに属する Amazon S3 バケットに設定スナップショットを配信します。 ``` aws configservice deliver-config-snapshot --delivery-channel-name default ``` 出力: ``` { "configSnapshotId": "d0333b00-a683-44af-921e-examplefb794" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeliverConfigSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/deliver-config-snapshot.html)」を参照してください。 ### `describe-compliance-by-config-rule` 次のコード例は、`describe-compliance-by-config-rule` を使用する方法を示しています。 **AWS CLI** **AWS Config ルールのコンプライアンス情報を取得するには** 次のコマンドは、1 つ以上の AWS リソースによって違反された各 AWS Config ルールのコンプライアンス情報を返します。 ``` aws configservice describe-compliance-by-config-rule --compliance-types NON_COMPLIANT ``` 出力では、各 `CappedCount` 属性の値は、関連するルールに準拠していないリソースの数を示します。例えば、次の出力は、3 つのリソースが `InstanceTypesAreT2micro` という名前のルールに準拠していないことを示しています。 出力: ``` { "ComplianceByConfigRules": [ { "Compliance": { "ComplianceContributorCount": { "CappedCount": 3, "CapExceeded": false }, "ComplianceType": "NON_COMPLIANT" }, "ConfigRuleName": "InstanceTypesAreT2micro" }, { "Compliance": { "ComplianceContributorCount": { "CappedCount": 10, "CapExceeded": false }, "ComplianceType": "NON_COMPLIANT" }, "ConfigRuleName": "RequiredTagsForVolumes" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeComplianceByConfigRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-compliance-by-config-rule.html)」を参照してください。 ### `describe-compliance-by-resource` 次のコード例は、`describe-compliance-by-resource` を使用する方法を示しています。 **AWS CLI** **AWS リソースのコンプライアンス情報を取得するには** 次のコマンドは、AWS Config によって記録され、1 つ以上のルールに違反する各 EC2 インスタンスのコンプライアンス情報を返します。 ``` aws configservice describe-compliance-by-resource --resource-type AWS::EC2::Instance --compliance-types NON_COMPLIANT ``` 出力では、各 `CappedCount` 属性の値は、リソースが違反するルールの数を示します。例えば、次の出力は、インスタンス `i-1a2b3c4d` が 2 つのルールに違反していることを示しています。 出力: ``` { "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" } } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeComplianceByResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-compliance-by-resource.html)」を参照してください。 ### `describe-config-rule-evaluation-status` 次のコード例は、`describe-config-rule-evaluation-status` を使用する方法を示しています。 **AWS CLI** **AWS Config ルールのステータス情報を取得するには** 次のコマンドは、`MyConfigRule` という名前の AWS Config ルールのステータス情報を返します。 ``` aws configservice describe-config-rule-evaluation-status --config-rule-names MyConfigRule ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeConfigRuleEvaluationStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-config-rule-evaluation-status.html)」を参照してください。 ### `describe-config-rules` 次のコード例は、`describe-config-rules` を使用する方法を示しています。 **AWS CLI** **AWS Config ルールの詳細を取得するには** 次のコマンドは、`InstanceTypesAreT2micro` という名前の AWS Config ルールの詳細を返します。 ``` aws configservice describe-config-rules --config-rule-names InstanceTypesAreT2micro ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeConfigRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-config-rules.html)」を参照してください。 ### `describe-configuration-recorder-status` 次のコード例は、`describe-configuration-recorder-status` を使用する方法を示しています。 **AWS CLI** **設定レコーダーのステータス情報を取得するには** 次のコマンドは、デフォルトの設定レコーダーのステータスを返します。 ``` aws configservice describe-configuration-recorder-status ``` 出力: ``` { "ConfigurationRecordersStatus": [ { "name": "default", "lastStatus": "SUCCESS", "recording": true, "lastStatusChangeTime": 1452193834.344, "lastStartTime": 1441039997.819, "lastStopTime": 1441039992.835 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeConfigurationRecorderStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-configuration-recorder-status.html)」を参照してください。 ### `describe-configuration-recorders` 次のコード例は、`describe-configuration-recorders` を使用する方法を示しています。 **AWS CLI** **設定レコーダーの詳細を取得するには** 次のコマンドは、デフォルト設定レコーダーの詳細を返します。 ``` aws configservice describe-configuration-recorders ``` 出力: ``` { "ConfigurationRecorders": [ { "recordingGroup": { "allSupported": true, "resourceTypes": [], "includeGlobalResourceTypes": true }, "roleARN": "arn:aws:iam::123456789012:role/config-ConfigRole-A1B2C3D4E5F6", "name": "default" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeConfigurationRecorders](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-configuration-recorders.html)」を参照してください。 ### `describe-delivery-channel-status` 次のコード例は、`describe-delivery-channel-status` を使用する方法を示しています。 **AWS CLI** **配信チャネルのステータス情報を取得するには** 次のコマンドは、配信チャネルのステータスを返します。 ``` aws configservice describe-delivery-channel-status ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDeliveryChannelStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-delivery-channel-status.html)」を参照してください。 ### `describe-delivery-channels` 次のコード例は、`describe-delivery-channels` を使用する方法を示しています。 **AWS CLI** **配信チャネルの詳細を取得するには** 次のコマンドは、配信チャネルに関する詳細を返します。 ``` aws configservice describe-delivery-channels ``` 出力: ``` { "DeliveryChannels": [ { "snsTopicARN": "arn:aws:sns:us-east-1:123456789012:config-topic", "name": "default", "s3BucketName": "config-bucket-123456789012" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDeliveryChannels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/describe-delivery-channels.html)」を参照してください。 ### `get-compliance-details-by-config-rule` 次のコード例は、`get-compliance-details-by-config-rule` を使用する方法を示しています。 **AWS CLI** **AWS Config ルールの評価結果を取得するには** 次のコマンドは、`InstanceTypesAreT2micro` という名前の AWS Config ルールに準拠していないすべてのリソースの評価結果を返します。 ``` aws configservice get-compliance-details-by-config-rule --config-rule-name InstanceTypesAreT2micro --compliance-types NON_COMPLIANT ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetComplianceDetailsByConfigRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/get-compliance-details-by-config-rule.html)」を参照してください。 ### `get-compliance-details-by-resource` 次のコード例は、`get-compliance-details-by-resource` を使用する方法を示しています。 **AWS CLI** **AWS リソースの評価結果を取得するには** 次のコマンドは、EC2 インスタンス `i-1a2b3c4d` が準拠していない各ルールの評価結果を返します。 ``` aws configservice get-compliance-details-by-resource --resource-type AWS::EC2::Instance --resource-id i-1a2b3c4d --compliance-types NON_COMPLIANT ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetComplianceDetailsByResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/get-compliance-details-by-resource.html)」を参照してください。 ### `get-compliance-summary-by-config-rule` 次のコード例は、`get-compliance-summary-by-config-rule` を使用する方法を示しています。 **AWS CLI** **AWS Config ルールのコンプライアンス概要を取得するには** 次のコマンドは、準拠しているルールの数と準拠していないルールの数を返します。 ``` aws configservice get-compliance-summary-by-config-rule ``` 出力では、各 `CappedCount` 属性の値は、準拠または非準拠のルールの数を示します。 出力: ``` { "ComplianceSummary": { "NonCompliantResourceCount": { "CappedCount": 3, "CapExceeded": false }, "ComplianceSummaryTimestamp": 1452204131.493, "CompliantResourceCount": { "CappedCount": 2, "CapExceeded": false } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetComplianceSummaryByConfigRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/get-compliance-summary-by-config-rule.html)」を参照してください。 ### `get-compliance-summary-by-resource-type` 次のコード例は、`get-compliance-summary-by-resource-type` を使用する方法を示しています。 **AWS CLI** **すべてのリソースタイプのコンプライアンス概要を取得するには** 次のコマンドは、準拠している AWS リソースの数と準拠していないリソースの数を返します。 ``` aws configservice get-compliance-summary-by-resource-type ``` 出力では、各 `CappedCount` 属性の値は、準拠または非準拠のリソースの数を示します。 出力: ``` { "ComplianceSummariesByResourceType": [ { "ComplianceSummary": { "NonCompliantResourceCount": { "CappedCount": 16, "CapExceeded": false }, "ComplianceSummaryTimestamp": 1453237464.543, "CompliantResourceCount": { "CappedCount": 10, "CapExceeded": false } } } ] } ``` **特定のリソースタイプのコンプライアンス概要を取得するには** 次のコマンドは、準拠していない EC2 インスタンスの数と準拠しているインスタンスの数を返します。 ``` aws configservice get-compliance-summary-by-resource-type --resource-types AWS::EC2::Instance ``` 出力では、各 `CappedCount` 属性の値は、準拠または非準拠のリソースの数を示します。 出力: ``` { "ComplianceSummariesByResourceType": [ { "ResourceType": "AWS::EC2::Instance", "ComplianceSummary": { "NonCompliantResourceCount": { "CappedCount": 3, "CapExceeded": false }, "ComplianceSummaryTimestamp": 1452204923.518, "CompliantResourceCount": { "CappedCount": 7, "CapExceeded": false } } } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetComplianceSummaryByResourceType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/get-compliance-summary-by-resource-type.html)」を参照してください。 ### `get-resource-config-history` 次のコード例は、`get-resource-config-history` を使用する方法を示しています。 **AWS CLI** **AWS リソースの設定履歴を取得するには** 次のコマンドは、ID が `i-1a2b3c4d` の EC2 インスタンスの設定項目のリストを返します。 ``` aws configservice get-resource-config-history --resource-type AWS::EC2::Instance --resource-id i-1a2b3c4d ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetResourceConfigHistory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/get-resource-config-history.html)」を参照してください。 ### `get-status` 次のコード例は、`get-status` を使用する方法を示しています。 **AWS CLI** **AWS Config のステータスを取得するには** 次のコマンドは、配信チャネルと設定レコーダーのステータスを返します。 ``` aws configservice get-status ``` 出力: ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/get-status.html)」を参照してください。 ### `list-discovered-resources` 次のコード例は、`list-discovered-resources` を使用する方法を示しています。 **AWS CLI** **AWS Config が検出したリソースを一覧表示するには** 次のコマンドは、AWS Config が検出した EC2 インスタンスを一覧表示します。 ``` aws configservice list-discovered-resources --resource-type AWS::EC2::Instance ``` 出力: ``` { "resourceIdentifiers": [ { "resourceType": "AWS::EC2::Instance", "resourceId": "i-1a2b3c4d" }, { "resourceType": "AWS::EC2::Instance", "resourceId": "i-2a2b3c4d" }, { "resourceType": "AWS::EC2::Instance", "resourceId": "i-3a2b3c4d" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDiscoveredResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/list-discovered-resources.html)」を参照してください。 ### `put-config-rule` 次のコード例は、`put-config-rule` を使用する方法を示しています。 **AWS CLI** **AWS マネージド Config ルールを追加するには** 次のコマンドは、AWS マネージド Config ルールを追加するための JSON コードを提供します。 ``` aws configservice put-config-rule --config-rule file://RequiredTagsForEC2Instances.json ``` `RequiredTagsForEC2Instances.json` は、ルール設定を含む JSON ファイルです。 ``` { "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\"}" } ``` `ComplianceResourceTypes` 属性については、この JSON コードはスコープを `AWS::EC2::Instance` タイプのリソースに制限するため、AWS Config はルールに対して EC2 インスタンスのみを評価します。このルールはマネージドルールであるため、`Owner` 属性は `AWS` に設定され、`SourceIdentifier` 属性はルール識別子 `REQUIRED_TAGS` に設定されます。`InputParameters` 属性には、ルールに必要なタグキー、および `CostCenter` と `Owner` が指定されます。 コマンドが成功した場合、AWS Config は出力を返しません。ルール設定を確認するには、describe-config-rules コマンドを実行してルール名を指定します。 **カスタマーマネージド Config ルールを追加するには** 次のコマンドは、カスタマーマネージド Config ルールを追加するための JSON コードを提供します。 ``` aws configservice put-config-rule --config-rule file://InstanceTypesAreT2micro.json ``` `InstanceTypesAreT2micro.json` は、ルール設定を含む JSON ファイルです。 ``` { "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\"}" } ``` `ComplianceResourceTypes` 属性については、この JSON コードはスコープを `AWS::EC2::Instance` タイプのリソースに制限するため、AWS Config はルールに対して EC2 インスタンスのみを評価します。このルールはカスタマーマネージドルールであるため、`Owner` 属性は `CUSTOM_LAMBDA` に設定され、`SourceIdentifier` 属性は AWS Lambda 関数の ARN に設定されます。`SourceDetails` オブジェクトは必須です。`InputParameters` 属性に指定されたパラメータは、AWS Config がルールに対してリソースを評価するために呼び出す際に AWS Lambda 関数に渡されます。 コマンドが成功した場合、AWS Config は出力を返しません。ルール設定を確認するには、describe-config-rules コマンドを実行してルール名を指定します。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutConfigRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/put-config-rule.html)」を参照してください。 ### `put-configuration-recorder` 次のコード例は、`put-configuration-recorder` を使用する方法を示しています。 **AWS CLI** **例 1: サポートされているすべてのリソースを記録するには** 次のコマンドは、グローバルリソースタイプを含む、サポートされているすべてのリソースタイプに対する変更を追跡する設定レコーダーを作成します。 ``` aws configservice put-configuration-recorder \ --configuration-recorder name=default,roleARN=arn:aws:iam::123456789012:role/config-role \ --recording-group allSupported=true,includeGlobalResourceTypes=true ``` コマンドが成功した場合、AWS Config は出力を返しません。設定レコーダーの設定を確認するには、describe-configuration-recorders コマンドを実行します。 **例 2: 特定のタイプのリソースを記録するには** 次のコマンドは、JSON ファイルで --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 は、AWS Config が記録するリソースのタイプを指定する JSON ファイルです。 ``` { "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" ] } ``` resourceTypes キーのリソースタイプを指定する前に、allSupported オプションおよび includeGlobalResourceTypes オプションを false に設定するか、オプション自体を省略する必要があります。 コマンドが成功した場合、AWS Config は出力を返しません。設定レコーダーの設定を確認するには、describe-configuration-recorders コマンドを実行します。 **例 3: 特定のリソースタイプ以外の、すべてのサポートされているリソースを選択するには** 次のコマンドは、JSON ファイルで --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 は、AWS Config が記録するリソースのタイプを指定する JSON ファイルです。 ``` { "allSupported": false, "exclusionByResourceTypes": { "resourceTypes": [ "AWS::Redshift::ClusterSnapshot", "AWS::RDS::DBClusterSnapshot", "AWS::CloudFront::StreamingDistribution" ] }, "includeGlobalResourceTypes": false, "recordingStrategy": { "useOnly": "EXCLUSION_BY_RESOURCE_TYPES" }, } ``` 記録から除外するリソースタイプを指定する前に、1) allSupported オプションおよび includeGlobalResourceTypes オプションを false に設定するか、オプション自体を省略する必要があります。2) RecordingStrategy の useOnly フィールドを EXCLUSION\$1BY\$1RESOURCE\$1TYPES に設定する必要があります。 コマンドが成功した場合、AWS Config は出力を返しません。設定レコーダーの設定を確認するには、describe-configuration-recorders コマンドを実行します。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutConfigurationRecorder](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/put-configuration-recorder.html)」を参照してください。 ### `put-delivery-channel` 次のコード例は、`put-delivery-channel` を使用する方法を示しています。 **AWS CLI** **配信チャネルを作成するには** 次のコマンドは、配信チャネルの設定を JSON コードとして提供します。 ``` aws configservice put-delivery-channel --delivery-channel file://deliveryChannel.json ``` `deliveryChannel.json` ファイルは、配信チャネルの属性を指定します。 ``` { "name": "default", "s3BucketName": "config-bucket-123456789012", "snsTopicARN": "arn:aws:sns:us-east-1:123456789012:config-topic", "configSnapshotDeliveryProperties": { "deliveryFrequency": "Twelve_Hours" } } ``` この例では以下の属性を設定します。 `name` - 配信チャネルの名前です。デフォルトでは、AWS Config は新しい配信チャネルに名前 `default` を割り当てます。`put-delivery-channel` コマンドを使用して配信チャネル名を更新することはできません。名前を変更する手順については、「配信チャネルの名前変更」を参照してください。`s3BucketName`- AWS Config が設定スナップショットと設定履歴ファイルを配信する Amazon S3 バケットの名前。別の AWS アカウントに属するバケットを指定する場合、そのバケットには AWS Config へのアクセス許可を付与するポリシーが必要です。詳細については、Amazon S3 バケットのアクセス許可を参照してください。 `snsTopicARN` - AWS Config が設定変更に関する通知を送信する Amazon SNS トピックの Amazon リソースネーム (ARN)。別のアカウントからトピックを選択した場合、トピックには AWS Config へのアクセス許可を付与するポリシーが必要です。詳細については、「Permissions for the Amazon SNS Topic」を参照してください。 `configSnapshotDeliveryProperties` - AWS Config が設定スナップショットを配信する頻度と、定期的な Config ルールの評価を呼び出す頻度を設定する `deliveryFrequency` 属性が含まれます。 コマンドが成功した場合、AWS Config は出力を返しません。配信チャネルの設定を確認するには、describe-delivery-channels コマンドを実行します。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutDeliveryChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/put-delivery-channel.html)」を参照してください。 ### `start-config-rules-evaluation` 次のコード例は、`start-config-rules-evaluation` を使用する方法を示しています。 **AWS CLI** **AWS Config ルールのオンデマンド評価を実行するには** 次のコマンドは、2 つの AWS マネージドルールの評価を開始します。 ``` aws configservice start-config-rules-evaluation --config-rule-names s3-bucket-versioning-enabled cloudtrail-enabled ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartConfigRulesEvaluation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/start-config-rules-evaluation.html)」を参照してください。 ### `start-configuration-recorder` 次のコード例は、`start-configuration-recorder` を使用する方法を示しています。 **AWS CLI** **設定レコーダーを起動するには** 次のコマンドは、デフォルトの設定レコーダーを起動します。 ``` aws configservice start-configuration-recorder --configuration-recorder-name default ``` コマンドが成功した場合、AWS Config は出力を返しません。AWS Config がリソースを記録していることを確認するには、get-status コマンドを実行します。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartConfigurationRecorder](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/start-configuration-recorder.html)」を参照してください。 ### `stop-configuration-recorder` 次のコード例は、`stop-configuration-recorder` を使用する方法を示しています。 **AWS CLI** **設定レコーダーを停止するには** 次のコマンドは、デフォルトの設定レコーダーを停止します。 ``` aws configservice stop-configuration-recorder --configuration-recorder-name default ``` コマンドが成功した場合、AWS Config は出力を返しません。AWS Config がリソースを記録していないことを確認するには、get-status コマンドを実行します。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopConfigurationRecorder](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/stop-configuration-recorder.html)」を参照してください。 ### `subscribe` 次のコード例は、`subscribe` を使用する方法を示しています。 **AWS CLI** **AWS Config をサブスクライブするには** 次のコマンドは、デフォルトの配信チャネルと設定レコーダーを作成します。コマンドは、AWS Config が設定情報を配信する Amazon S3 バケットと Amazon SNS トピックも指定します。 ``` 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 ``` 出力: ``` 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" } ] ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[Subscribe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/configservice/subscribe.html)」を参照してください。 # AWS CLI を使用した Amazon Connect の例 次のコード例は、Amazon Connect で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-user` 次のコード例は、`create-user` を使用する方法を示しています。 **AWS CLI** **ユーザーを作成するには** 次の `create-user` の例では、指定された属性を持つユーザーを指定された 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 ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Connect 管理者ガイド*」の「[Add Users](https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/create-user.html)」を参照してください。 ### `delete-user` 次のコード例は、`delete-user` を使用する方法を示しています。 **AWS CLI** **ユーザーを削除するには** 次の `delete-user` の例では、指定された Amazon Connect インスタンスから指定されたユーザーを削除しています。 ``` aws connect delete-user \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ --user-id 87654321-2222-1234-1234-111234567891 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Connect 管理者ガイド*」の「[Manage Users](https://docs.aws.amazon.com/connect/latest/adminguide/manage-users.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/delete-user.html)」を参照してください。 ### `describe-user-hierarchy-group` 次のコード例は、`describe-user-hierarchy-group` を使用する方法を示しています。 **AWS CLI** **階層グループの詳細を表示するには** 次の `describe-user-hierarchy-group` の例では、指定された Amazon Connect 階層グループの詳細を表示しています。 ``` aws connect describe-user-hierarchy-group \ --hierarchy-group-id 12345678-1111-2222-800e-aaabbb555gg \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` 出力: ``` { "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" } } } } ``` 詳細については、「*Amazon Connect 管理者ガイド*」の「[Set Up Agent Hierarchies](https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeUserHierarchyGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/describe-user-hierarchy-group.html)」を参照してください。 ### `describe-user-hierarchy-structure` 次のコード例は、`describe-user-hierarchy-structure` を使用する方法を示しています。 **AWS CLI** **階層構造の詳細を表示するには** 次の `describe-user-hierarchy-structure` の例では、指定された Amazon Connect インスタンスの階層構造の詳細を表示しています。 ``` aws connect describe-user-hierarchy-group \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` 出力: ``` { "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" } } } ``` 詳細については、「*Amazon Connect 管理者ガイド*」の「[Set Up Agent Hierarchies](https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeUserHierarchyStructure](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/describe-user-hierarchy-structure.html)」を参照してください。 ### `describe-user` 次のコード例は、`describe-user` を使用する方法を示しています。 **AWS CLI** **ユーザーの詳細を表示するには** 次の `describe-user` の例では、指定された Amazon Connect ユーザーの詳細を表示しています。 ``` aws connect describe-user \ --user-id 0c245dc0-0cf5-4e37-800e-2a7481cc8a60 --instance-id 40c83b68-ea62-414c-97bb-d018e39e158e ``` 出力: ``` { "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": {} } } ``` 詳細については、「*Amazon Connect 管理者ガイド*」の「[Manage Users](https://docs.aws.amazon.com/connect/latest/adminguide/manage-users.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*の「[DescribeUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/describe-user.html)」を参照してください。 ### `get-contact-attributes` 次のコード例は、`get-contact-attributes` を使用する方法を示しています。 **AWS CLI** **連絡先の属性を取得するには** 次の `get-contact-attributes` の例では、指定された Amazon Connect の連絡先に設定された属性を取得しています。 ``` aws connect get-contact-attributes \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ --initial-contact-id 12345678-1111-2222-800e-a2b3c4d5f6g7 ``` 出力: ``` { "Attributes": { "greetingPlayed": "true" } } ``` 詳細については、「*Amazon Connect 管理者ガイド*」の「[Use Amazon Connect Contact Attributes](https://docs.aws.amazon.com/connect/latest/adminguide/connect-contact-attributes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetContactAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/get-contact-attributes.html)」を参照してください。 ### `list-contact-flows` 次のコード例は、`list-contact-flows` を使用する方法を示しています。 **AWS CLI** **インスタンスの問い合わせフローを一覧表示するには** 次の `list-contact-flows` の例では、指定された Amazon Connect インスタンスの問い合わせフローを一覧表示しています。 ``` aws connect list-contact-flows \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` 出力: ``` { "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" }, ] } ``` 詳細については、「*Amazon Connect 管理者ガイド*」の「[Create Amazon Connect Contact Flows](https://docs.aws.amazon.com/connect/latest/adminguide/connect-contact-flows.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListContactFlows](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/list-contact-flows.html)」を参照してください。 ### `list-hours-of-operations` 次のコード例は、`list-hours-of-operations` を使用する方法を示しています。 **AWS CLI** **インスタンスのオペレーション時間を一覧表示するには** 次の `list-hours-of-operations` の例では、指定された Amazon Connect インスタンスのオペレーション時間を一覧表示しています。 ``` aws connect list-hours-of-operations \ --instance-id 40c83b68-ea62-414c-97bb-d018e39e158e ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Connect 管理者ガイド*」の「[Set the Hours of Operation for a Queue](https://docs.aws.amazon.com/connect/latest/adminguide/set-hours-operation.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListHoursOfOperations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/list-hours-of-operations.html)」を参照してください。 ### `list-phone-numbers` 次のコード例は、`list-phone-numbers` を使用する方法を示しています。 **AWS CLI** **インスタンスの電話番号を一覧表示するには** 次の `list-phone-numbers` の例では、指定された Amazon Connect インスタンスの電話番号を一覧表示しています。 ``` aws connect list-phone-numbers \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Connect 管理者ガイド*」の「[Set Up Phone Numbers for Your Contact Center](https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPhoneNumbers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/list-phone-numbers.html)」を参照してください。 ### `list-queues` 次のコード例は、`list-queues` を使用する方法を示しています。 **AWS CLI** **インスタンス内のキューを一覧表示するには** 次の `list-queues` の例では、指定された Amazon Connect インスタンスのキューを一覧表示しています。 ``` aws connect list-queues \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` 出力: ``` { "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" }, ] } ``` 詳細については、「*Amazon Connect 管理者ガイド*」の「[Create a Queue](https://docs.aws.amazon.com/connect/latest/adminguide/create-queue.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[ListQueues](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/list-queues.html)」を参照してください。** ### `list-routing-profiles` 次のコード例は、`list-routing-profiles` を使用する方法を示しています。 **AWS CLI** **インスタンス内のルーティングプロファイルを一覧表示するには** 次の `list-routing-profiles` の例では、指定された Amazon Connect インスタンス内のルーティングプロファイルを一覧表示しています。 ``` aws connect list-routing-profiles \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` 出力: ``` { "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" }, ] } ``` 詳細については、「*Amazon Connect 管理者ガイド*」の「[Create a Routing Profile](https://docs.aws.amazon.com/connect/latest/adminguide/routing-profiles.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRoutingProfiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/list-routing-profiles.html)」を参照してください。 ### `list-security-profiles` 次のコード例は、`list-security-profiles` を使用する方法を示しています。 **AWS CLI** **インスタンス内のセキュリティプロファイルを一覧表示するには** 次の `list-security-profiles` の例では、指定された Amazon Connect インスタンス内のセキュリティプロファイルを一覧表示しています。 ``` aws connect list-security-profiles \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Connect 管理者ガイド*」の「[Assign Permissions: Security Profiles](https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListSecurityProfiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/list-security-profiles.html)」を参照してください。 ### `list-user-hierarchy-groups` 次のコード例は、`list-user-hierarchy-groups` を使用する方法を示しています。 **AWS CLI** **インスタンス内のユーザー階層グループを一覧表示するには** 次の `list-user-hierarchy-groups` の例では、指定された Amazon Connect インスタンス内のユーザー階層グループを一覧表示しています。 ``` aws connect list-user-hierarchy-groups \ --instance-id 40c83b68-ea62-414c-97bb-d018e39e158e ``` 出力: ``` { "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" }, ] } ``` 詳細については、「*Amazon Connect 管理者ガイド*」の「[Set Up Agent Hierarchies](https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListUserHierarchyGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/list-user-hierarchy-groups.html)」を参照してください。 ### `list-users` 次のコード例は、`list-users` を使用する方法を示しています。 **AWS CLI** **インスタンス内のユーザー階層グループを一覧表示するには** 次の `list-users` の例では、指定された Amazon Connect インスタンス内のユーザーを一覧表示しています。 ``` aws connect list-users \ --instance-id 40c83b68-ea62-414c-97bb-d018e39e158e ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Connect 管理者ガイド*」の「[Add Users](https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListUsers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/list-users.html)」を参照してください。 ### `update-contact-attributes` 次のコード例は、`update-contact-attributes` を使用する方法を示しています。 **AWS CLI** **連絡先の属性を更新するには** 次の `update-contact-attributes` の例では、指定された Amazon Connect ユーザーの `greetingPlayed` 属性を更新しています。 ``` aws connect update-contact-attributes \ --initial-contact-id 11111111-2222-3333-4444-12345678910 \ --instance-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ --attributes greetingPlayed=false ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Connect 管理者ガイド*」の「[Use Amazon Connect Contact Attributes](https://docs.aws.amazon.com/connect/latest/adminguide/connect-contact-attributes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateContactAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/update-contact-attributes.html)」を参照してください。 ### `update-user-hierarchy` 次のコード例は、`update-user-hierarchy` を使用する方法を示しています。 **AWS CLI** **ユーザーの階層を更新するには** 次の `update-user-hierarchy` の例では、指定された 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 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Connect 管理者ガイド*」の「[Configure Agent Settings](https://docs.aws.amazon.com/connect/latest/adminguide/configure-agents.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateUserHierarchy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/update-user-hierarchy.html)」を参照してください。 ### `update-user-identity-info` 次のコード例は、`update-user-identity-info` を使用する方法を示しています。 **AWS CLI** **ユーザーの ID 情報を更新するには** 次の `update-user-identity-info` の例では、指定された Amazon Connect ユーザーの ID 情報を更新しています。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Connect 管理者ガイド*」の「[Configure Agent Settings](https://docs.aws.amazon.com/connect/latest/adminguide/configure-agents.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateUserIdentityInfo](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/update-user-identity-info.html)」を参照してください。 ### `update-user-phone-config` 次のコード例は、`update-user-phone-config` を使用する方法を示しています。 **AWS CLI** **ユーザーの電話設定を更新するには** 次の `update-user-phone-config` の例では、指定されたユーザーの電話設定を更新しています。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Connect 管理者ガイド*」の「[Configure Agent Settings](https://docs.aws.amazon.com/connect/latest/adminguide/configure-agents.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateUserPhoneConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/update-user-phone-config.html)」を参照してください。 ### `update-user-routing-profile` 次のコード例は、`update-user-routing-profile` を使用する方法を示しています。 **AWS CLI** **ユーザーのルーティングプロファイルを更新するには** 次の `update-user-routing-profile` の例では、指定された 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 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Connect 管理者ガイド*」の「[Configure Agent Settings](https://docs.aws.amazon.com/connect/latest/adminguide/configure-agents.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateUserRoutingProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/update-user-routing-profile.html)」を参照してください。 ### `update-user-security-profiles` 次のコード例は、`update-user-security-profiles` を使用する方法を示しています。 **AWS CLI** **ユーザーのセキュリティプロファイルを更新するには** 次の `update-user-security-profiles` の例では、指定された 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 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Connect 管理者ガイド*」の「[Assign Permissions: Security Profiles](https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateUserSecurityProfiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/connect/update-user-security-profiles.html)」を参照してください。 # AWS Cost and Usage Report examples using AWS CLI 次のコード例では、AWS Cost and Usage Report で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `delete-report-definition` 次のコード例は、`delete-report-definition` を使用する方法を示しています。 **AWS CLI** **AWS のコストと使用状況レポートを削除するには** この例では、AWS コストと使用状況レポートを削除しています。 コマンド: ``` aws cur --region us-east-1 delete-report-definition --report-name "ExampleReport" ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteReportDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cur/delete-report-definition.html)」を参照してください。 ### `describe-report-definitions` 次のコード例は、`describe-report-definitions` を使用する方法を示しています。 **AWS CLI** **AWS コストと使用状況レポートのリストを取得するには** この例では、アカウントが所有する AWS コストと使用状況レポートのリストを記述します。 コマンド: ``` aws cur --region us-east-1 describe-report-definitions --max-items 5 ``` 出力: ``` { "ReportDefinitions": [ { "ReportName": "ExampleReport", "Compression": "ZIP", "S3Region": "us-east-1", "Format": "textORcsv", "S3Prefix": "exampleprefix", "S3Bucket": "example-s3-bucket", "TimeUnit": "DAILY", "AdditionalArtifacts": [ "REDSHIFT", "QUICKSIGHT" ], "AdditionalSchemaElements": [ "RESOURCES" ] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeReportDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cur/describe-report-definitions.html)」を参照してください。 ### `put-report-definition` 次のコード例は、`put-report-definition` を使用する方法を示しています。 **AWS CLI** **AWS のコストと使用状況レポートを作成するには** 次の `put-report-definition` の例では、Amazon Redshift または Amazon QuickSight にアップロードできる毎日更新の AWS コストと使用状況レポートを作成しています。 ``` aws cur put-report-definition --report-definition file://report-definition.json ``` `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" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutReportDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cur/put-report-definition.html)」を参照してください。 # AWS CLI を使用した Cost Explorer Service の例 次のコード例は、Cost Explorer Service で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `get-cost-and-usage` 次のコード例は、`get-cost-and-usage` を使用する方法を示しています。 **AWS CLI** **2017 年 9 月に関するアカウントの S3 の使用状況を取得するには** 次の `get-cost-and-usage` の例では、2017 年 9 月のアカウントの S3 の使用状況を取得しています。 ``` 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 ``` `filters.json` の内容: ``` { "Dimensions": { "Key": "SERVICE", "Values": [ "Amazon Simple Storage Service" ] } } ``` 出力: ``` { "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" } } } ] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetCostAndUsage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ce/get-cost-and-usage.html)」を参照してください。 ### `get-dimension-values` 次のコード例は、`get-dimension-values` を使用する方法を示しています。 **AWS CLI** **「Elastic」という値を使用してディメンション SERVICE のタグを取得するには** この例では、2017 年 1 月 1 日から 2017 年 5 月 18 日までの値「Elastic」を持つディメンション SERVICE のタグを取得しています。 コマンド: ``` aws ce get-dimension-values --search-string Elastic --time-period Start=2017-01-01,End=2017-05-18 --dimension SERVICE ``` 出力: ``` { "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 } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDimensionValues](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ce/get-dimension-values.html)」を参照してください。 ### `get-reservation-coverage` 次のコード例は、`get-reservation-coverage` を使用する方法を示しています。 **AWS CLI** **us-east-1 リージョンの EC2 t2.nano インスタンスの予約カバレッジを取得するには** この例では、2017 年 7 月から 9 月の us-east-1 リージョンの EC2 t2.nano インスタンスの予約カバレッジを取得しています。 コマンド: ``` 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" ] } } ] } ``` 出力: ``` { "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 } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetReservationCoverage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ce/get-reservation-coverage.html)」を参照してください。 ### `get-reservation-purchase-recommendation` 次のコード例は、`get-reservation-purchase-recommendation` を使用する方法を示しています。 **AWS CLI** **3 年契約の一部前払い EC2 RI の予約の推奨事項を取得するには** 次の `get-reservation-purchase-recommendation` の例では、過去 60 日間の EC2 の使用状況に基づいて、3 年契約の一部前払い 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 ``` 出力: ``` { "Recommendations": [], "Metadata": { "GenerationTimestamp": "2018-08-08T15:20:57Z", "RecommendationId": "00d59dde-a1ad-473f-8ff2-iexample3330b" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetReservationPurchaseRecommendation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ce/get-reservation-purchase-recommendation.html)」を参照してください。 ### `get-reservation-utilization` 次のコード例は、`get-reservation-utilization` を使用する方法を示しています。 **AWS CLI** **アカウントの予約率を取得するには** 次の `get-reservation-utilization` の例では、アカウントの 2018-03-01 から 2018-08-01 までのすべての t2.nano インスタンスタイプの RI 使用率を取得しています。 ``` aws ce get-reservation-utilization \ --time-period Start=2018-03-01,End=2018-08-01 \ --filter file://filters.json ``` `filters.json` の内容: ``` { "Dimensions": { "Key": "INSTANCE_TYPE", "Values": [ "t2.nano" ] } } ``` 出力: ``` { "Total": { "TotalAmortizedFee": "0", "UtilizationPercentage": "0", "PurchasedHours": "0", "NetRISavings": "0", "TotalActualHours": "0", "AmortizedRecurringFee": "0", "UnusedHours": "0", "TotalPotentialRISavings": "0", "OnDemandCostOfRIHoursUsed": "0", "AmortizedUpfrontFee": "0" }, "UtilizationsByTime": [] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetReservationUtilization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ce/get-reservation-utilization.html)」を参照してください。 ### `get-tags` 次のコード例は、`get-tags` を使用する方法を示しています。 **AWS CLI** **コスト配分タグのキーと値を取得するには** この例では、「プロジェクト」のキーと「secretProject」を含む値を持つすべてのコスト配分タグを取得しています。 コマンド: ``` aws ce get-tags --search-string secretProject --time-period Start=2017-01-01,End=2017-05-18 --tag-key Project ``` 出力: ``` { "ReturnSize": 2, "Tags": [ "secretProject1", "secretProject2" ], "TotalSize": 2 } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ce/get-tags.html)」を参照してください。 # AWS CLI を使用した Firehose の例 次のコード例は、Firehose で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `list-delivery-streams` 次のコード例は、`list-delivery-streams` を使用する方法を示しています。 **AWS CLI** **使用可能な配信ストリームを一覧表示するには** 次の `list-delivery-streams` の例では、AWS アカウントで使用可能な配信ストリームを一覧表示します。 ``` aws firehose list-delivery-streams ``` 出力: ``` { "DeliveryStreamNames": [ "my-stream" ], "HasMoreDeliveryStreams": false } ``` 詳細については、*Amazon Kinesis Data Firehose デベロッパーガイド*の「[Amazon Kinesis Data Firehose 配信ストリームの作成](https://docs.aws.amazon.com/firehose/latest/dev/basic-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDeliveryStreams](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/firehose/list-delivery-streams.html)」を参照してください。 ### `put-record-batch` 次のコード例は、`put-record-batch` を使用する方法を示しています。 **AWS CLI** **複数のレコードをストリームに書き込むには** この `put-record-batch` の例は、3 つのレコードをストリームに書き込みます。データは Base64 形式でエンコードされます。 ``` aws firehose put-record-batch \ --delivery-stream-name my-stream \ --records file://records.json ``` `myfile.json` の内容: ``` [ {"Data": "Rmlyc3QgdGhpbmc="}, {"Data": "U2Vjb25kIHRoaW5n"}, {"Data": "VGhpcmQgdGhpbmc="} ] ``` 出力: ``` { "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" } ] } ``` 詳細については、「Amazon Kinesis Data Firehose ディベロッパーガイド」の「[Amazon Kinesis Data Firehose 配信ストリームへのデータの送信](https://docs.aws.amazon.com/firehose/latest/dev/basic-write.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[PutRecordBatch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/firehose/put-record-batch.html)」を参照してください。** ### `put-record` 次のコード例は、`put-record` を使用する方法を示しています。 **AWS CLI** **ストリームにレコードを書き込むには** 次の `put-record` の例では、データをストリームに書き込みます。データは Base64 形式でエンコードされます。 ``` aws firehose put-record \ --delivery-stream-name my-stream \ --record '{"Data":"SGVsbG8gd29ybGQ="}' ``` 出力: ``` { "RecordId": "RjB5K/nnoGFHqwTsZlNd/TTqvjE8V5dsyXZTQn2JXrdpMTOwssyEb6nfC8fwf1whhwnItt4mvrn+gsqeK5jB7QjuLg283+Ps4Sz/j1Xujv31iDhnPdaLw4BOyM9Amv7PcCuB2079RuM0NhoakbyUymlwY8yt20G8X2420wu1jlFafhci4erAt7QhDEvpwuK8N1uOQ1EuaKZWxQHDzcG6tk1E49IPeD9k", "Encrypted": false } ``` 詳細については、「Amazon Kinesis Data Firehose ディベロッパーガイド」の「[Amazon Kinesis Data Firehose 配信ストリームへのデータの送信](https://docs.aws.amazon.com/firehose/latest/dev/basic-write.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[PutRecord](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/firehose/put-record.html)」を参照してください。** # AWS CLI を使用した Amazon Data Lifecycle Manager の例 次のコード例は、Amazon Data Lifecycle Manager で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-default-role` 次のコード例は、`create-default-role` を使用する方法を示しています。 **AWS CLI** **Amazon DLM 用にひつような IAM ロールを作成するには** 次の `dlm create-default-role` の例では、スナップショットを管理するための AWSDataLifecycleManagerDefaultRole デフォルトロールを作成します。 ``` aws dlm create-default-role \ --resource-type snapshot ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Elastic Compute Cloud ユーザーガイド*」の「[Default service roles for Amazon Data Lifecycle Manager](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/service-role.html#default-service-roles)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDefaultRole](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dlm/create-default-role.html)」を参照してください。 ### `create-lifecycle-policy` 次のコード例は、`create-lifecycle-policy` を使用する方法を示しています。 **AWS CLI** **ライフサイクルポリシーを作成するには** 次の `create-lifecycle-policy` の例では、指定した時間にボリュームのスナップショットを毎日作成するライフサイクルポリシーを作成します。指定されたタグはスナップショットに追加され、タグもボリュームからコピーされてスナップショットに追加されます。新しいスナップショットの作成が指定された最大数を超える場合は、最も古いスナップショットが削除されます。 ``` 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 ``` `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 } } ] } ``` 出力: ``` { "PolicyId": "policy-0123456789abcdef0" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateLifecyclePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dlm/create-lifecycle-policy.html)」を参照してください。 ### `delete-lifecycle-policy` 次のコード例は、`delete-lifecycle-policy` を使用する方法を示しています。 **AWS CLI** **ライフサイクルポリシーを削除するには** 次の例では、指定されたライフサイクルポリシーを削除します。 ``` aws dlm delete-lifecycle-policy --policy-id policy-0123456789abcdef0 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteLifecyclePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dlm/delete-lifecycle-policy.html)」を参照してください。 ### `get-lifecycle-policies` 次のコード例は、`get-lifecycle-policies` を使用する方法を示しています。 **AWS CLI** **ライフサイクルポリシーの概要を取得するには** 次の `get-lifecycle-policies` の例では、すべてのライフサイクルポリシーを一覧表示します。 ``` aws dlm get-lifecycle-policies ``` 出力: ``` { "Policies": [ { "PolicyId": "policy-0123456789abcdef0", "Description": "My first policy", "State": "ENABLED" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetLifecyclePolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dlm/get-lifecycle-policies.html)」を参照してください。 ### `get-lifecycle-policy` 次のコード例は、`get-lifecycle-policy` を使用する方法を示しています。 **AWS CLI** **ライフサイクルポリシーを記述するには** 次の `get-lifecycle-policy` の例では、指定されたライフサイクルポリシーの詳細を表示します。 ``` aws dlm get-lifecycle-policy \ --policy-id policy-0123456789abcdef0 ``` 出力: ``` { "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 } } ] } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetLifecyclePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dlm/get-lifecycle-policy.html)」を参照してください。 ### `update-lifecycle-policy` 次のコード例は、`update-lifecycle-policy` を使用する方法を示しています。 **AWS CLI** **例 1: ライフサイクルポリシーを有効にするには** 次の `update-lifecycle-policy` の例では、指定されたライフサイクルポリシーを有効にします。 ``` aws dlm update-lifecycle-policy \ --policy-id policy-0123456789abcdef0 \ --state ENABLED ``` **例 2: ライフサイクルポリシーを無効にするには** 次の `update-lifecycle-policy` の例では、指定されたライフサイクルポリシーを無効にします。 ``` aws dlm update-lifecycle-policy \ --policy-id policy-0123456789abcdef0 \ --state DISABLED ``` **例 3: ライフサイクルポリシーの詳細を更新するには** 次の `update-lifecycle-policy` の例では、指定されたライフサイクルポリシーのターゲットタグを更新します。 ``` aws dlm update-lifecycle-policy \ --policy-id policy-0123456789abcdef0 --policy-details file://policyDetails.json ``` `policyDetails.json` の内容。このファイルで参照されていないその他の詳細は、コマンドでは変更されません。 ``` { "TargetTags": [ { "Key": "costCenter", "Value": "120" }, { "Key": "project", "Value": "lima" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateLifecyclePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dlm/update-lifecycle-policy.html)」を参照してください。 # AWS Data Pipeline examples using AWS CLI 次のコード例では、AWS Data Pipeline で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `activate-pipeline` 次のコード例は、`activate-pipeline` を使用する方法を示しています。 **AWS CLI** **パイプラインをアクティブ化するには** この例では、指定されたパイプラインをアクティブ化しています。 ``` aws datapipeline activate-pipeline --pipeline-id df-00627471SOVYZEXAMPLE ``` 特定の日時でパイプラインをアクティブ化するには、次のコマンドを使用します。 ``` aws datapipeline activate-pipeline --pipeline-id df-00627471SOVYZEXAMPLE --start-timestamp 2015-04-07T00:00:00Z ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ActivatePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/activate-pipeline.html)」を参照してください。 ### `add-tags` 次のコード例は、`add-tags` を使用する方法を示しています。 **AWS CLI** **パイプラインにタグを追加するには** この例では、指定されたタグを指定されたパイプラインに追加しています。 ``` aws datapipeline add-tags --pipeline-id df-00627471SOVYZEXAMPLE --tags key=environment,value=production key=owner,value=sales ``` タグを表示するには、describe-pipelines コマンドを使用します。たとえば、サンプルコマンドで追加されたタグは、describe-pipelines の出力に次のように表示されます。 ``` { ... "tags": [ { "value": "production", "key": "environment" }, { "value": "sales", "key": "owner" } ] ... } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/add-tags.html)」を参照してください。 ### `create-pipeline` 次のコード例は、`create-pipeline` を使用する方法を示しています。 **AWS CLI** **パイプラインを作成するには** この例では、パイプラインを作成しています。 ``` aws datapipeline create-pipeline --name my-pipeline --unique-id my-pipeline-token ``` 出力例を次に示します。 ``` { "pipelineId": "df-00627471SOVYZEXAMPLE" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreatePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/create-pipeline.html)」を参照してください。 ### `deactivate-pipeline` 次のコード例は、`deactivate-pipeline` を使用する方法を示しています。 **AWS CLI** パイプラインを非アクティブ化するには この例では、指定されたパイプラインを非アクティブ化しています。 ``` aws datapipeline deactivate-pipeline --pipeline-id df-00627471SOVYZEXAMPLE ``` すべての実行中のアクティビティが終了した後にのみ、パイプラインを非アクティブ化するには、次のコマンドを使用します。 ``` aws datapipeline deactivate-pipeline --pipeline-id df-00627471SOVYZEXAMPLE --no-cancel-active ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeactivatePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/deactivate-pipeline.html)」を参照してください。 ### `delete-pipeline` 次のコード例は、`delete-pipeline` を使用する方法を示しています。 **AWS CLI** **パイプラインを削除するには** この例では、指定されたパイプラインを削除しています。 ``` aws datapipeline delete-pipeline --pipeline-id df-00627471SOVYZEXAMPLE ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeletePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/delete-pipeline.html)」を参照してください。 ### `describe-pipelines` 次のコード例は、`describe-pipelines` を使用する方法を示しています。 **AWS CLI** **パイプラインを記述するには** この例では、指定されたパイプラインを記述します。 ``` aws datapipeline describe-pipelines --pipeline-ids df-00627471SOVYZEXAMPLE ``` 出力例を次に示します。 ``` { "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": [] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribePipelines](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/describe-pipelines.html)」を参照してください。 ### `get-pipeline-definition` 次のコード例は、`get-pipeline-definition` を使用する方法を示しています。 **AWS CLI** **パイプライン定義を取得するには** 次の例では、指定したパイプラインのパイプライン定義を取得しています。 ``` aws datapipeline get-pipeline-definition --pipeline-id df-00627471SOVYZEXAMPLE ``` 出力例を次に示します。 ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPipelineDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/get-pipeline-definition.html)」を参照してください。 ### `list-pipelines` 次のコード例は、`list-pipelines` を使用する方法を示しています。 **AWS CLI** **パイプラインを一覧表示するには** この例では、パイプラインを一覧表示しています。 ``` aws datapipeline list-pipelines ``` 出力例を次に示します。 ``` { "pipelineIdList": [ { "id": "df-00627471SOVYZEXAMPLE", "name": "my-pipeline" }, { "id": "df-09028963KNVMREXAMPLE", "name": "ImportDDB" }, { "id": "df-0870198233ZYVEXAMPLE", "name": "CrossRegionDDB" }, { "id": "df-00189603TB4MZEXAMPLE", "name": "CopyRedshift" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPipelines](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/list-pipelines.html)」を参照してください。 ### `list-runs` 次のコード例は、`list-runs` を使用する方法を示しています。 **AWS CLI** **例 1: パイプラインの実行を一覧表示するには** 次の `list-runs` の例では、指定されたパイプラインの実行を一覧表示しています。 ``` aws datapipeline list-runs --pipeline-id df-00627471SOVYZEXAMPLE ``` 出力: ``` 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 ``` **例 2: 指定された日付の間のパイプライン実行を一覧表示するには** 次の `list-runs` の例では、`--start-interval` を使用して、出力に含める日付を指定しています。 ``` aws datapipeline list-runs --pipeline-id df-01434553B58A2SHZUKO5 --start-interval 2017-10-07T00:00:00,2017-10-08T00:00:00 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRuns](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/list-runs.html)」を参照してください。 ### `put-pipeline-definition` 次のコード例は、`put-pipeline-definition` を使用する方法を示しています。 **AWS CLI** **パイプライン定義をアップロードするには** この例では、指定されたパイプライン定義を指定されたパイプラインにアップロードしています。 ``` aws datapipeline put-pipeline-definition --pipeline-id df-00627471SOVYZEXAMPLE --pipeline-definition file://my-pipeline-definition.json ``` 出力例を次に示します。 ``` { "validationErrors": [], "errored": false, "validationWarnings": [] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutPipelineDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/put-pipeline-definition.html)」を参照してください。 ### `remove-tags` 次のコード例は、`remove-tags` を使用する方法を示しています。 **AWS CLI** **パイプラインからタグを削除するには** この例では、指定されたタグを指定されたパイプラインから削除しています。 ``` aws datapipeline remove-tags --pipeline-id df-00627471SOVYZEXAMPLE --tag-keys environment ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datapipeline/remove-tags.html)」を参照してください。 # AWS CLI を使用した DataSync の例 次のコード例は、DataSync で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `update-location-azure-blob` 次のコード例は、`update-location-azure-blob` を使用する方法を示しています。 **AWS CLI** **新しいエージェントを使用して転送場所を更新するには** 次の `update-location-object-storage` の例では、新しいエージェントを使用して Microsoft Azure Blob Storage の DataSync のロケーションを更新しています。 ``` 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" \ }' ``` このコマンドでは何も出力されません。 詳細については、「*AWS DataSync ユーザーガイド*」の「[Replacing your agent](https://docs.aws.amazon.com/datasync/latest/userguide/replacing-agent.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateLocationAzureBlob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datasync/update-location-azure-blob.html)」を参照してください。 ### `update-location-hdfs` 次のコード例は、`update-location-hdfs` を使用する方法を示しています。 **AWS CLI** **新しいエージェントを使用して転送場所を更新するには** 次の `update-location-hdfs` の例では、新しいエージェントを使用して DataSync HDFS のロケーションを更新しています。HDFS クラスターが Kerberos 認証を使用している場合にのみ、`--kerberos-keytab` オプションおよび `--kerberos-krb5-conf` オプションが必要です。 ``` 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 ``` `hdfs.keytab` の内容: ``` N/A. The content of this file is encrypted and not human readable. ``` `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 ``` このコマンドでは何も出力されません。 詳細については、「*AWS DataSync ユーザーガイド*」の「[Replacing your agent](https://docs.aws.amazon.com/datasync/latest/userguide/replacing-agent.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateLocationHdfs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datasync/update-location-hdfs.html)」を参照してください。 ### `update-location-nfs` 次のコード例は、`update-location-nfs` を使用する方法を示しています。 **AWS CLI** **新しいエージェントを使用して転送場所を更新するには** 次の `update-location-nfs` の例では、新しいエージェントを使用して DataSync NFS のロケーションを更新しています。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*AWS DataSync ユーザーガイド*」の「[Replacing your agent](https://docs.aws.amazon.com/datasync/latest/userguide/replacing-agent.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateLocationNfs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datasync/update-location-nfs.html)」を参照してください。 ### `update-location-object-storage` 次のコード例は、`update-location-object-storage` を使用する方法を示しています。 **AWS CLI** **新しいエージェントを使用して転送場所を更新するには** 次の `update-location-object-storage` の例では、新しいエージェントを使用して DataSync オブジェクトストレージのロケーションを更新しています。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*AWS DataSync ユーザーガイド*」の「[Replacing your agent](https://docs.aws.amazon.com/datasync/latest/userguide/replacing-agent.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateLocationObjectStorage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datasync/update-location-object-storage.html)」を参照してください。 ### `update-location-smb` 次のコード例は、`update-location-smb` を使用する方法を示しています。 **AWS CLI** **新しいエージェントを使用して転送場所を更新するには** 次の `update-location-smb` の例では、新しいエージェントを使用して DataSync SMB のロケーションを更新しています。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*AWS DataSync ユーザーガイド*」の「[Replacing your agent](https://docs.aws.amazon.com/datasync/latest/userguide/replacing-agent.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateLocationSmb](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/datasync/update-location-smb.html)」を参照してください。 # AWS CLI を使用した DAX の例 次のコード例は、DAX で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-cluster` 次のコード例は、`create-cluster` を使用する方法を示しています。 **AWS CLI** **DAX クラスターを作成するには** 次の `create-cluster` の例では、指定された設定で DAX クラスターを作成します。 ``` aws dax create-cluster \ --cluster-name daxcluster \ --node-type dax.r4.large \ --replication-factor 3 \ --iam-role-arn roleARN \ --sse-specification Enabled=true ``` 出力: ``` { "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" } } } ``` 詳細については、「Amazon DynamoDB デベロッパーガイド」の「[Step 3: Create a DAX Cluster](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.create-cluster.cli.create-cluster.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/create-cluster.html)」を参照してください。 ### `create-parameter-group` 次のコード例は、`create-parameter-group` を使用する方法を示しています。 **AWS CLI** **パラメータグループを作成するには** 次の「create-parameter-group」の例では、指定された設定でパラメータグループを作成します。 ``` aws dax create-parameter-group \ --parameter-group-name daxparametergroup \ --description "A new parameter group" ``` 出力: ``` { "ParameterGroup": { "ParameterGroupName": "daxparametergroup", "Description": "A new parameter group" } } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[DAX クラスターの管理](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.cluster-management.custom-settings.ttl)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/create-parameter-group.html)」を参照してください。 ### `create-subnet-group` 次のコード例は、`create-subnet-group` を使用する方法を示しています。 **AWS CLI** **DAX サブネットグループを作成するには** 次の `create-subnet-group` の例では、指定された設定でサブネットグループを作成します。 ``` aws dax create-subnet-group \ --subnet-group-name daxSubnetGroup \ --subnet-ids subnet-11111111 subnet-22222222 ``` 出力: ``` { "SubnetGroup": { "SubnetGroupName": "daxSubnetGroup", "VpcId": "vpc-05a1fa8e00c325226", "Subnets": [ { "SubnetIdentifier": "subnet-11111111", "SubnetAvailabilityZone": "us-west-2b" }, { "SubnetIdentifier": "subnet-22222222", "SubnetAvailabilityZone": "us-west-2c" } ] } } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[Step 2: Create a Subnet Group](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.create-cluster.cli.create-subnet-group.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/create-subnet-group.html)」を参照してください。 ### `decrease-replication-factor` 次のコード例は、`decrease-replication-factor` を使用する方法を示しています。 **AWS CLI** **クラスターから 1 つ以上のノードを削除するには** 次の `decrease-replication-factor` の例では、指定された ‭DAX クラスター‬内のノード数を 1 に減らします。‬‬‬‬‬ ``` aws dax decrease-replication-factor \ --cluster-name daxcluster \ --new-replication-factor 1 ``` 出力: ``` { "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" } } } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[DAX クラスターの管理](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.cluster-management.custom-settings)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DecreaseReplicationFactor](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/decrease-replication-factor.html)」を参照してください。 ### `delete-cluster` 次のコード例は、`delete-cluster` を使用する方法を示しています。 **AWS CLI** **DAX クラスターを削除するには** 次の `delete-cluster` の例では、指定された DAX クラスターを削除します。 ``` aws dax delete-cluster \ --cluster-name daxcluster ``` 出力: ``` { "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" } } } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[DAX クラスターの管理](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.cluster-management.deleting)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/delete-cluster.html)」を参照してください。 ### `delete-parameter-group` 次のコード例は、`delete-parameter-group` を使用する方法を示しています。 **AWS CLI** **パラメータグループを削除するには** 次の `delete-parameter-group` の例では、指定された DAX パラメータグループを削除します。 ``` aws dax delete-parameter-group \ --parameter-group-name daxparametergroup ``` 出力: ``` { "DeletionMessage": "Parameter group daxparametergroup has been deleted." } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[DAX クラスターの管理](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/delete-parameter-group.html)」を参照してください。 ### `delete-subnet-group` 次のコード例は、`delete-subnet-group` を使用する方法を示しています。 **AWS CLI** **サブネットグループを削除するには** 次の `delete-subnet-group` の例は、指定された DAX サブネットグループを削除します。 ``` aws dax delete-subnet-group \ --subnet-group-name daxSubnetGroup ``` 出力: ``` { "DeletionMessage": "Subnet group daxSubnetGroup has been deleted." } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[DAX クラスターの管理](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/delete-subnet-group.html)」を参照してください。 ### `describe-clusters` 次のコード例は、`describe-clusters` を使用する方法を示しています。 **AWS CLI** **プロビジョニングされた DAX クラスターに関する情報を返すには** 次の `describe-clusters` の例では、プロビジョニングされたすべての DAX クラスターに関する詳細を表示します。 ``` aws dax describe-clusters ``` 出力: ``` { "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" } } ] } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[DAX クラスターの管理](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/describe-clusters.html)」を参照してください。 ### `describe-default-parameters` 次のコード例は、`describe-default-parameters` を使用する方法を示しています。 **AWS CLI** **DAX のデフォルトのシステムパラメータ情報を返すには** 次の `describe-default-parameters` の例では、DAX のデフォルトのシステムパラメータ情報を表示します。 ``` aws dax describe-default-parameters ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[DAX クラスターの管理](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDefaultParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/describe-default-parameters.html)」を参照してください。 ### `describe-events` 次のコード例は、`describe-events` を使用する方法を示しています。 **AWS CLI** **DAX クラスターとパラメータグループに関連するイベントを返すには** 次の `describe-events` の例では、DAX クラスターとパラメータグループに関連するイベントの詳細を表示します。 ``` aws dax describe-events ``` 出力: ``` { "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 } ] } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[DAX クラスターの管理](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/describe-events.html)」を参照してください。 ### `describe-parameter-groups` 次のコード例は、`describe-parameter-groups` を使用する方法を示しています。 **AWS CLI** **DAX で定義されたパラメータグループを記述するには** 次の `describe-parameter-groups` の例では、DAX で定義されたパラメータグループに関する詳細を取得します。 ``` aws dax describe-parameter-groups ``` 出力: ``` { "ParameterGroups": [ { "ParameterGroupName": "default.dax1.0", "Description": "Default parameter group for dax1.0" } ] } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[DAX クラスターの管理](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeParameterGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/describe-parameter-groups.html)」を参照してください。 ### `describe-parameters` 次のコード例は、`describe-parameters` を使用する方法を示しています。 **AWS CLI** **DAX パラメータグループで定義されたパラメータを記述するには** 次の `describe-parameters` の例では、指定された DAX パラメータグループで定義されているパラメータの詳細を取得します。 ``` aws dax describe-parameters \ --parameter-group-name default.dax1.0 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[DAX クラスターの管理](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/describe-parameters.html)」を参照してください。 ### `describe-subnet-groups` 次のコード例は、`describe-subnet-groups` を使用する方法を示しています。 **AWS CLI** **DAX で定義されたサブネットグループを記述するには** 次の `describe-subnet-groups` の例では、DAX で定義されたサブネットグループの詳細を取得します。 ``` aws dax describe-subnet-groups ``` 出力: ``` { "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" } ] } ] } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[DAX クラスターの管理](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.concepts.cluster.html#DAX.concepts.cluster.security)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeSubnetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/describe-subnet-groups.html)」を参照してください。 ### `increase-replication-factor` 次のコード例は、`increase-replication-factor` を使用する方法を示しています。 **AWS CLI** **DAX クラスターのレプリケーション係数を増やすには** 次の `increase-replication-factor` の例では、指定された DAX クラスターのレプリケーション係数を 3 に増やします。 ``` aws dax increase-replication-factor \ --cluster-name daxcluster \ --new-replication-factor 3 ``` 出力: ``` { "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" } } } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[DAX クラスターの管理](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.cluster-management.custom-settings)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[IncreaseReplicationFactor](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/increase-replication-factor.html)」を参照してください。 ### `list-tags` 次のコード例は、`list-tags` を使用する方法を示しています。 **AWS CLI** **DAX リソースのタグを一覧表示するには** 次の `list-tags` の例では、指定された DAX クラスターにアタッチされているタグキーと値を一覧表示します。 ``` aws dax list-tags \ --resource-name arn:aws:dax:us-west-2:123456789012:cache/daxcluster ``` 出力: ``` { "Tags": [ { "Key": "ClusterUsage", "Value": "prod" } ] } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[DAX クラスターの管理](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.management.tagging)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/list-tags.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **DAX リソースにタグを付けるには** 次の `tag-resource` の例では、指定されたタグキー名と関連する値を、指定された DAX クラスターにアタッチして、クラスターの使用状況を記述します。 ``` aws dax tag-resource \ --resource-name arn:aws:dax:us-west-2:123456789012:cache/daxcluster \ --tags="Key=ClusterUsage,Value=prod" ``` 出力: ``` { "Tags": [ { "Key": "ClusterUsage", "Value": "prod" } ] } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[DAX クラスターの管理](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.management.tagging)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **DAX リソースからタグを削除するには** 次の `untag-resource` の例では、指定されたキー名を持つタグを DAX クラスターから削除します。 ``` aws dax untag-resource \ --resource-name arn:aws:dax:us-west-2:123456789012:cache/daxcluster \ --tag-keys="ClusterUsage" ``` 出力: ``` { "Tags": [] } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[DAX クラスターの管理](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.management.tagging)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dax/untag-resource.html)」を参照してください。 # AWS CLI を使用した Detective の例 次のコード例は、Detective で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `accept-invitation` 次のコード例は、`accept-invitation` を使用する方法を示しています。 **AWS CLI** **動作グラフのメンバーアカウントになるための招待を受け入れるには** 次の `accept-invitation` の例では、動作グラフ arn:aws:detective:us-east-1:111122223333:graph:123412341234 のメンバーアカウントになるための招待を受け入れます。 ``` aws detective accept-invitation \ --graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Detective Administration Guide*」の[「Responding to a behavior graph invitation](https://docs.aws.amazon.com/detective/latest/adminguide/member-invitation-response.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AcceptInvitation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/accept-invitation.html)」を参照してください。 ### `create-graph` 次のコード例は、`create-graph` を使用する方法を示しています。 **AWS CLI** **Amazon Detective を有効にして新しい動作グラフを作成するには** 次の `create-graph` の例では、コマンドが実行されているリージョンでコマンドを実行する AWS アカウントに対して Detective を有効にします。そのアカウントを管理者アカウントとする新しい動作グラフが作成されます。このコマンドは、部門タグに「財務」という値を割り当てます。 ``` aws detective create-graph \ --tags '{"Department": "Finance"}' ``` 出力: ``` { "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:027c7c4610ea4aacaf0b883093cab899" } ``` 詳細については、「*Amazon Detective Administration Guide*」の「[Enabling Amazon Detective](https://docs.aws.amazon.com/detective/latest/adminguide/detective-enabling.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateGraph](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/create-graph.html)」を参照してください。 ### `create-members` 次のコード例は、`create-members` を使用する方法を示しています。 **AWS CLI** **動作グラフにメンバーアカウントを招待するには** 次の `create-members` の例では、動作グラフ arn:aws:detective:us-east-1:111122223333:graph:123412341234 のメンバーアカウントになるよう 2 つの AWS アカウントを招待します。アカウントごとに、このリクエストで AWS アカウント ID とアカウントルートユーザーのメールアドレスが提供されます。リクエストには、招待メールに挿入するカスタムメッセージが含まれています。 ``` 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." ``` 出力: ``` { "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": [ ] } ``` 詳細については、「*Amazon Detective Administration Guide*」の「Inviting member accounts to a behavior graph」を参照してください。 **招待メールを送信せずにメンバーアカウントを招待するには** 次の `create-members` の例では、動作グラフ arn:aws:detective:us-east-1:111122223333:graph:123412341234 のメンバーアカウントになるよう 2 つの AWS アカウントを招待します。アカウントごとに、このリクエストで AWS アカウント ID とアカウントルートユーザーのメールアドレスが提供されます。メンバーアカウントには招待メールは届きません。 ``` 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 ``` 出力: ``` { "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": [ ] } ``` 詳細については、「*Amazon Detective Administration Guide*」の「Inviting member accounts to a behavior graph」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateMembers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/create-members.html)」を参照してください。 ### `delete-graph` 次のコード例は、`delete-graph` を使用する方法を示しています。 **AWS CLI** **Detective を無効にして動作グラフを削除するには** 次の `delete-graph` の例では、Detective を無効にし、指定された動作グラフを削除します。 ``` aws detective delete-graph \ --graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Detective Administration Guide*」の「[Disabling Amazon Detective](https://docs.aws.amazon.com/detective/latest/adminguide/detective-disabling.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteGraph](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/delete-graph.html)」を参照してください。 ### `delete-members` 次のコード例は、`delete-members` を使用する方法を示しています。 **AWS CLI** **動作グラフからメンバーアカウントを削除するには** 次の `delete-members` の例では、動作グラフ arn:aws:detective:us-east-1:111122223333:graph:123412341234 から 2 つのメンバーアカウントを削除します。アカウントを識別するには、リクエストで AWS アカウント ID を提供します。 ``` aws detective delete-members \ --account-ids 444455556666 123456789012 \ --graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 ``` 出力: ``` { "AccountIds": [ "444455556666", "123456789012" ], "UnprocessedAccounts": [ ] } ``` 詳細については、「*Amazon Detective Administration Guide*」の「Removing member accounts from a behavior graph」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteMembers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/delete-members.html)」を参照してください。 ### `disassociate-membership` 次のコード例は、`disassociate-membership` を使用する方法を示しています。 **AWS CLI** **動作グラフのメンバーシップを辞退するには** 次のメンバーシップの関連付け解除の例では、動作グラフ arn:aws:detective:us-east-1:111122223333:graph:123412341234 からコマンドを実行する AWS アカウントを削除します。 ``` aws detective disassociate-membership \ --graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 ``` 詳細については、「*Amazon Detective Administration Guide*」の「Removing your account from a behavior graph」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateMembership](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/disassociate-membership.html)」を参照してください。 ### `get-members` 次のコード例は、`get-members` を使用する方法を示しています。 **AWS CLI** **選択した動作グラフメンバーアカウントに関する情報を取得するには** 次の `get-members` の例では、動作グラフ arn:aws:detective:us-east-1:111122223333:graph:123412341234 の 2 つのメンバーアカウントに関する情報を取得します。2 つのアカウントに対し、リクエストで AWS アカウント ID が提供されます。 ``` aws detective get-members \ --account-ids 444455556666 123456789012 \ --graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 ``` 出力: ``` { "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": [ ] } ``` 詳細については、「*Amazon Detective Administration Guide*」の「Viewing the list of accounts in a behavior graph」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetMembers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/get-members.html)」を参照してください。 ### `list-graphs` 次のコード例は、`list-graphs` を使用する方法を示しています。 **AWS CLI** **自身のアカウントが管理者になっている動作グラフのリストを表示するには** 次の `list-graphs` の例は、呼び出し元アカウントが現在のリージョン内で管理者となっている動作グラフを取得します。 ``` aws detective list-graphs ``` 出力: ``` { "GraphList": [ { "Arn": "arn:aws:detective:us-east-1:111122223333:graph:123412341234", "CreatedTime": 1579736111000 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListGraphs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/list-graphs.html)」を参照してください。 ### `list-invitations` 次のコード例は、`list-invitations` を使用する方法を示しています。 **AWS CLI** **アカウントがメンバーであるか招待されている動作グラフのリストを表示するには** 次の `list-invitations` の例では、呼び出し元アカウントが招待されている動作グラフを取得しています。結果には、未対応の招待と承諾済みの招待のみが表示されます。拒否した招待や削除されたメンバーシップは含まれません。 ``` aws detective list-invitations ``` 出力: ``` { "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 } ] } ``` 詳細については、「*Amazon Detective Administration Guide*」の「Viewing your list of behavior graph invitations」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListInvitations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/list-invitations.html)」を参照してください。 ### `list-members` 次のコード例は、`list-members` を使用する方法を示しています。 **AWS CLI** **動作グラフのメンバーアカウントを一覧表示するには** 次の `list-members` の例では、動作グラフ `arn:aws:detective:us-east-1:111122223333:graph:123412341234` の招待された有効なメンバーアカウントを取得します。結果には、削除されたメンバーアカウントは含まれません。 ``` aws detective list-members \ --graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 ``` 出力: ``` { "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 } ] } ``` 詳細については、「*Amazon Detective Administration Guide*」の「[Viewing the list of accounts in a behavior graph](https://docs.aws.amazon.com/detective/latest/adminguide/graph-admin-view-accounts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListMembers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/list-members.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **動作グラフに割り当てられたタグを取得するには** 次の `list-tags-for-resource` の例では、指定された動作グラフに割り当てられたタグを返します。 ``` aws detective list-tags-for-resource \ --resource-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 ``` 出力: ``` { "Tags": { "Department" : "Finance" } } ``` 詳細については、「*Amazon Detective Administration Guide*」の「[Managing tags for a behavior graph](https://docs.aws.amazon.com/detective/latest/adminguide/graph-tags.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/list-tags-for-resource.html)」を参照してください。 ### `reject-invitation` 次のコード例は、`reject-invitation` を使用する方法を示しています。 **AWS CLI** **動作グラフのメンバーアカウントになるための招待を拒否するには** 次の `reject-invitation` の例では、動作グラフ arn:aws:detective:us-east-1:111122223333:graph:123412341234 のメンバーアカウントになるための招待を拒否します。 ``` aws detective reject-invitation \ --graph-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Detective Administration Guide*」の「Responding to a behavior graph invitation」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RejectInvitation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/reject-invitation.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **リソースにタグを割り当てるには** 次の `tag-resource` の例では、Department タグの値を指定された動作グラフに割り当てます。 ``` aws detective tag-resource \ --resource-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 \ --tags '{"Department":"Finance"}' ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Detective Administration Guide*」の「[Managing tags for a behavior graph](https://docs.aws.amazon.com/detective/latest/adminguide/graph-tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **リソースからタグ値を削除するには** 次の `untag-resource` の例では、指定された動作グラフから Department タグを削除します。 ``` aws detective untag-resource \ --resource-arn arn:aws:detective:us-east-1:111122223333:graph:123412341234 \ --tag-keys "Department" ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Detective Administration Guide*」の「[Managing tags for a behavior graph](https://docs.aws.amazon.com/detective/latest/adminguide/graph-tags.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/detective/untag-resource.html)」を参照してください。 # AWS CLI を使用した Device Farm の例 次のコード例は、Device Farm で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-device-pool` 次のコード例は、`create-device-pool` を使用する方法を示しています。 **AWS CLI** **デバイスプールを作成するには** 次のコマンドは、プロジェクトの Android デバイスプールを作成します。 ``` 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" ``` プロジェクト ARN は、`create-project` または `list-projects` の出力から取得できます。この `device-pool-rules.json` ファイルは、デバイスのプラットフォームを指定する現在のフォルダ内の JSON ドキュメントです。 ``` [ { "attribute": "PLATFORM", "operator": "EQUALS", "value": "\"ANDROID\"" } ] ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDevicePool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/devicefarm/create-device-pool.html)」を参照してください。 ### `create-project` 次のコード例は、`create-project` を使用する方法を示しています。 **AWS CLI** **プロジェクトを作成するには** 次のコマンドは、`my-project` という名前の新しいプロジェクトを作成します。 ``` aws devicefarm create-project --name my-project ``` 出力: ``` { "project": { "name": "myproject", "arn": "arn:aws:devicefarm:us-west-2:123456789012:project:070fc3ca-7ec1-4741-9c1f-d3e044efc506", "created": 1503612890.057 } } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[CreateProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/devicefarm/create-project.html)」を参照してください。** ### `create-upload` 次のコード例は、`create-upload` を使用する方法を示しています。 **AWS CLI** **アップロードを作成するには** 次のコマンドは、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 ``` プロジェクト ARN は、create-project または list-projects の出力から取得できます。 出力: ``` { "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" } } ``` 出力内の署名付き URL を使用して、ファイルを 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" ``` + API の詳細については、「*AWS CLI コマンドリファレンス*の「[CreateUpload](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/devicefarm/create-upload.html)」を参照してください。 ### `get-upload` 次のコード例は、`get-upload` を使用する方法を示しています。 **AWS CLI** **アップロードを表示するには** 次のコマンドは、アップロードに関する情報を取得します。 ``` aws devicefarm get-upload --arn "arn:aws:devicefarm:us-west-2:123456789012:upload:070fc3ca-7ec1-4741-9c1f-d3e044efc506/dd72723a-ae9e-4087-09e6-f4cea3599514" ``` アップロード ARN は、`create-upload` の出力から取得できます。 出力: ``` { "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\"}" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetUpload](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/devicefarm/get-upload.html)」を参照してください。 ### `list-projects` 次のコード例は、`list-projects` を使用する方法を示しています。 **AWS CLI** **プロジェクトを一覧表示するには** 次のコマンドは、プロジェクトのリストを取得します。 ``` aws devicefarm list-projects ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListProjects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/devicefarm/list-projects.html)」を参照してください。 # Direct Connect examples using AWS CLI 次のコード例では、Direct Connect で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `accept-direct-connect-gateway-association-proposal` 次のコード例は、`accept-direct-connect-gateway-association-proposal` を使用する方法を示しています。 **AWS CLI** **ゲートウェイの関連付けの提案を承諾するには** 以下の `accept-direct-connect-gateway-association-proposal` は指定された提案を承諾します。 ``` 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" } ] } } ``` 詳細については、「*AWS Direct Connect ユーザーガイド*」の「[Accepting or Rejecting a Transit Gateway Association Proposal](https://docs.aws.amazon.com/directconnect/latest/UserGuide/multi-account-associate-tgw.html#multi-account-tgw-accept-reject-proposal)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AcceptDirectConnectGatewayAssociationProposal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/accept-direct-connect-gateway-association-proposal.html)」を参照してください。 ### `allocate-connection-on-interconnect` 次のコード例は、`allocate-connection-on-interconnect` を使用する方法を示しています。 **AWS CLI** **相互接続上にホスト接続を作成するには** 次の `allocate-connection-on-interconnect` コマンドは、相互接続上にホスト接続を作成します。 ``` aws directconnect allocate-connection-on-interconnect --bandwidth 500Mbps --connection-name mydcinterconnect --owner-account 123456789012 --interconnect-id dxcon-fgktov66 --vlan 101 ``` 出力: ``` { "partnerName": "TIVIT", "vlan": 101, "ownerAccount": "123456789012", "connectionId": "dxcon-ffzc51m1", "connectionState": "ordering", "bandwidth": "500Mbps", "location": "TIVIT", "connectionName": "mydcinterconnect", "region": "sa-east-1" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AllocateConnectionOnInterconnect](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/allocate-connection-on-interconnect.html)」を参照してください。 ### `allocate-hosted-connection` 次のコード例は、`allocate-hosted-connection` を使用する方法を示しています。 **AWS CLI** **相互接続上にホスト接続を作成するには** 次の `allocate-hosted-connection` の例では、指定された相互接続上にホスト接続を作成します。 ``` aws directconnect allocate-hosted-connection \ --bandwidth 500Mbps \ --connection-name mydcinterconnect \ --owner-account 123456789012 -connection-id dxcon-fgktov66 -vlan 101 ``` 出力: ``` { "partnerName": "TIVIT", "vlan": 101, "ownerAccount": "123456789012", "connectionId": "dxcon-ffzc51m1", "connectionState": "ordering", "bandwidth": "500Mbps", "location": "TIVIT", "connectionName": "mydcinterconnect", "region": "sa-east-1" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AllocateHostedConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/allocate-hosted-connection.html)」を参照してください。 ### `allocate-private-virtual-interface` 次のコード例は、`allocate-private-virtual-interface` を使用する方法を示しています。 **AWS CLI** **プライベート仮想インターフェイスをプロビジョニングするには** 次の `allocate-private-virtual-interface` コマンドは、別の顧客が所有できるようにプライベート仮想インターフェイスをプロビジョニングします。 ``` 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 ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AllocatePrivateVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/allocate-private-virtual-interface.html)」を参照してください。 ### `allocate-public-virtual-interface` 次のコード例は、`allocate-public-virtual-interface` を使用する方法を示しています。 **AWS CLI** **パブリック仮想インターフェイスをプロビジョニングするには** 次の `allocate-public-virtual-interface` コマンドは、別の顧客が所有できるようにパブリック仮想インターフェイスをプロビジョニングします。 ``` 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}] ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AllocatePublicVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/allocate-public-virtual-interface.html)」を参照してください。 ### `allocate-transit-virtual-interface` 次のコード例は、`allocate-transit-virtual-interface` を使用する方法を示しています。 **AWS CLI** **指定された AWS アカウントが所有できるようにトランジット仮想インターフェイスをプロビジョニングするには** 次の `allocate-transit-virtual-interface` の例では、指定されたアカウントのトランジット仮想インターフェイスをプロビジョニングします。 ``` 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}]" ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*AWS Direct Connect ユーザーガイド*」の「[Creating a Hosted Transit Virtual Interface](https://docs.aws.amazon.com/directconnect/latest/UserGuide/createhostedvirtualinterface.html#create-hosted-transit-vif)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AllocateTransitVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/allocate-transit-virtual-interface.html)」を参照してください。 ### `associate-connection-with-lag` 次のコード例は、`associate-connection-with-lag` を使用する方法を示しています。 **AWS CLI** **接続を LAG と関連付けるには** 次の例では、指定した接続を指定した LAG と関連付けます。 コマンド: ``` aws directconnect associate-connection-with-lag --lag-id dxlag-fhccu14t --connection-id dxcon-fg9607vm ``` 出力: ``` { "ownerAccount": "123456789012", "connectionId": "dxcon-fg9607vm", "lagId": "dxlag-fhccu14t", "connectionState": "requested", "bandwidth": "1Gbps", "location": "EqDC2", "connectionName": "Con2ForLag", "region": "us-east-1" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateConnectionWithLag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/associate-connection-with-lag.html)」を参照してください。 ### `associate-hosted-connection` 次のコード例は、`associate-hosted-connection` を使用する方法を示しています。 **AWS CLI** **ホスト接続を LAG と関連付けるには** 次の例では、指定したホスト接続を指定した LAG と関連付けます。 コマンド: ``` aws directconnect associate-hosted-connection --parent-connection-id dxlag-fhccu14t --connection-id dxcon-fg9607vm ``` 出力: ``` { "partnerName": "TIVIT", "vlan": 101, "ownerAccount": "123456789012", "connectionId": "dxcon-fg9607vm", "lagId": "dxlag-fhccu14t", "connectionState": "ordering", "bandwidth": "500Mbps", "location": "TIVIT", "connectionName": "mydcinterconnect", "region": "sa-east-1" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateHostedConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/associate-hosted-connection.html)」を参照してください。 ### `associate-virtual-interface` 次のコード例は、`associate-virtual-interface` を使用する方法を示しています。 **AWS CLI** **仮想インターフェイスを接続と関連付けるには** 次の例では、指定した仮想インターフェイスを指定した LAG と関連付けます。または、仮想インターフェイスを接続と関連付けるには、`--connection-id` の AWS Direct Connect 接続の ID を指定します (例: `dxcon-ffnikghc`)。 コマンド: ``` aws directconnect associate-virtual-interface --connection-id dxlag-ffjhj9lx --virtual-interface-id dxvif-fgputw0j ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/associate-virtual-interface.html)」を参照してください。 ### `confirm-connection` 次のコード例は、`confirm-connection` を使用する方法を示しています。 **AWS CLI** **相互接続上にホスト接続が作成されていることを確認するには** 次の `confirm-connection` コマンドは、相互接続上にホスト接続が作成されていることを確認します。 ``` aws directconnect confirm-connection --connection-id dxcon-fg2wi7hy ``` 出力: ``` { "connectionState": "pending" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ConfirmConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/confirm-connection.html)」を参照してください。 ### `confirm-private-virtual-interface` 次のコード例は、`confirm-private-virtual-interface` を使用する方法を示しています。 **AWS CLI** **プライベート仮想インターフェイスの所有権を承諾するには** 次の `confirm-private-virtual-interface` コマンドは、別の顧客が作成したプライベート仮想インターフェイスの所有権を承諾します。 ``` aws directconnect confirm-private-virtual-interface --virtual-interface-id dxvif-fgy8orxu --virtual-gateway-id vgw-e4a47df9 ``` 出力: ``` { "virtualInterfaceState": "pending" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ConfirmPrivateVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/confirm-private-virtual-interface.html)」を参照してください。 ### `confirm-public-virtual-interface` 次のコード例は、`confirm-public-virtual-interface` を使用する方法を示しています。 **AWS CLI** **パブリック仮想インターフェイスの所有権を承諾するには** 次の `confirm-public-virtual-interface` コマンドは、別の顧客が作成したパブリック仮想インターフェイスの所有権を承諾します。 ``` aws directconnect confirm-public-virtual-interface --virtual-interface-id dxvif-fg9xo9vp ``` 出力: ``` { "virtualInterfaceState": "verifying" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ConfirmPublicVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/confirm-public-virtual-interface.html)」を参照してください。 ### `confirm-transit-virtual-interface` 次のコード例は、`confirm-transit-virtual-interface` を使用する方法を示しています。 **AWS CLI** **トランジット仮想インターフェイスの所有権を承諾するには** 次の `confirm-transit-virtual-interface` コマンドは、別の顧客が作成したトランジット仮想インターフェイスの所有権を承諾します。 ``` aws directconnect confirm-transit-virtual-interface \ --virtual-interface-id dxvif-fEXAMPLE \ --direct-connect-gateway-id 4112ccf9-25e9-4111-8237-b6c5dEXAMPLE ``` 出力: ``` { "virtualInterfaceState": "pending" } ``` 詳細については、「*AWS Direct Connect ユーザーガイド*」の「[Accepting a Hosted Virtual Interface](https://docs.aws.amazon.com/directconnect/latest/UserGuide/accepthostedvirtualinterface.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ConfirmTransitVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/confirm-transit-virtual-interface.html)」を参照してください。 ### `create-bgp-peer` 次のコード例は、`create-bgp-peer` を使用する方法を示しています。 **AWS CLI** **IPv6 BGP ピアリングセッションを作成するには** 次の例では、プライベート仮想インターフェイス `dxvif-fg1vuj3d` に IPv6 BGP ピアリングセッションを作成します。ピア IPv6 アドレスは Amazon によって自動的に割り当てられます。 コマンド: ``` aws directconnect create-bgp-peer --virtual-interface-id dxvif-fg1vuj3d --new-bgp-peer asn=64600,addressFamily=ipv6 ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateBgpPeer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-bgp-peer.html)」を参照してください。 ### `create-connection` 次のコード例は、`create-connection` を使用する方法を示しています。 **AWS CLI** **ネットワークから AWS Direct Connect ロケーションへの接続を作成するには** 次の `create-connection` コマンドは、ネットワークから AWS Direct Connect ロケーションへの接続を作成します。 ``` aws directconnect create-connection --location TIVIT --bandwidth 1Gbps --connection-name "Connection to AWS" ``` 出力: ``` { "ownerAccount": "123456789012", "connectionId": "dxcon-fg31dyv6", "connectionState": "requested", "bandwidth": "1Gbps", "location": "TIVIT", "connectionName": "Connection to AWS", "region": "sa-east-1" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-connection.html)」を参照してください。 ### `create-direct-connect-gateway-association-proposal` 次のコード例は、`create-direct-connect-gateway-association-proposal` を使用する方法を示しています。 **AWS CLI** **指定した Transit Gateway を、指定した Direct Connect ゲートウェイと関連付けるための提案を作成するには** 次の `create-direct-connect-gateway-association-proposal` では、指定した Transit Gateway を、指定した Direct Connect ゲートウェイと関連付けるための提案を作成します。 ``` 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 ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*AWS Direct Connect ユーザーガイド*」の「[Creating a Transit Gateway Association Proposal](https://docs.aws.amazon.com/directconnect/latest/UserGuide/multi-account-associate-tgw.html#multi-account-tgw-create-proposal)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDirectConnectGatewayAssociationProposal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-direct-connect-gateway-association-proposal.html)」を参照してください。 ### `create-direct-connect-gateway-association` 次のコード例は、`create-direct-connect-gateway-association` を使用する方法を示しています。 **AWS CLI** **仮想プライベートインターフェイスを Direct Connect ゲートウェイと関連付けるには** 次の例では、仮想プライベートゲートウェイ `vgw-6efe725e` を Direct Connect ゲートウェイ `5f294f92-bafb-4011-916d-9b0bexample` と関連付けます。仮想プライベートゲートウェイがあるリージョンで、コマンドを実行する必要があります。 コマンド: ``` aws directconnect create-direct-connect-gateway-association --direct-connect-gateway-id 5f294f92-bafb-4011-916d-9b0bexample --virtual-gateway-id vgw-6efe725e ``` 出力: ``` { "directConnectGatewayAssociation": { "associationState": "associating", "virtualGatewayOwnerAccount": "123456789012", "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample", "virtualGatewayId": "vgw-6efe725e", "virtualGatewayRegion": "us-east-2" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDirectConnectGatewayAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-direct-connect-gateway-association.html)」を参照してください。 ### `create-direct-connect-gateway` 次のコード例は、`create-direct-connect-gateway` を使用する方法を示しています。 **AWS CLI** **Direct Connect ゲートウェイを作成するには** 次の例では、`DxGateway1` という名前の Direct Connect ゲートウェイを作成します。 コマンド: ``` aws directconnect create-direct-connect-gateway --direct-connect-gateway-name "DxGateway1" ``` 出力: ``` { "directConnectGateway": { "amazonSideAsn": 64512, "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bdexample", "ownerAccount": "123456789012", "directConnectGatewayName": "DxGateway1", "directConnectGatewayState": "available" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDirectConnectGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-direct-connect-gateway.html)」を参照してください。 ### `create-interconnect` 次のコード例は、`create-interconnect` を使用する方法を示しています。 **AWS CLI** **パートナーのネットワークと AWS 間の相互接続を作成するには** 次の `create-interconnect` コマンドは、AWS Direct Connect パートナーのネットワークと特定の AWS Direct Connect ロケーションの間に相互接続を作成します。 ``` aws directconnect create-interconnect --interconnect-name "1G Interconnect to AWS" --bandwidth 1Gbps --location TIVIT ``` 出力: ``` { "region": "sa-east-1", "bandwidth": "1Gbps", "location": "TIVIT", "interconnectName": "1G Interconnect to AWS", "interconnectId": "dxcon-fgktov66", "interconnectState": "requested" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateInterconnect](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-interconnect.html)」を参照してください。 ### `create-lag` 次のコード例は、`create-lag` を使用する方法を示しています。 **AWS CLI** **新しい接続で LAG を作成するには** 次の例では、LAG を作成し、帯域幅が 1 Gbps の 2 つの新しい AWS Direct Connect 接続を LAG 用にリクエストします。 コマンド: ``` aws directconnect create-lag --location CSVA1 --number-of-connections 2 --connections-bandwidth 1Gbps --lag-name 1GBLag ``` 出力: ``` { "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" } ``` **既存の接続を使用して LAG を作成するには** 次の例では、アカウント内の既存の接続から LAG を作成し、既存の接続と同じ帯域幅とロケーションを持つ 2 番目の新しい接続を LAG 用にリクエストします。 コマンド: ``` aws directconnect create-lag --location EqDC2 --number-of-connections 2 --connections-bandwidth 1Gbps --lag-name 2ConnLAG --connection-id dxcon-fgk145dr ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateLag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-lag.html)」を参照してください。 ### `create-private-virtual-interface` 次のコード例は、`create-private-virtual-interface` を使用する方法を示しています。 **AWS CLI** **プライベート仮想インターフェイスを作成するには** 次の `create-private-virtual-interface` コマンドは、プライベート仮想インターフェイスを作成します。 ``` 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 ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreatePrivateVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-private-virtual-interface.html)」を参照してください。 ### `create-public-virtual-interface` 次のコード例は、`create-public-virtual-interface` を使用する方法を示しています。 **AWS CLI** **パブリック仮想インターフェイスを作成するには** 次の `create-public-virtual-interface` コマンドは、パブリック仮想インターフェイスを作成します。 ``` 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}] ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreatePublicVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-public-virtual-interface.html)」を参照してください。 ### `create-transit-virtual-interface` 次のコード例は、`create-transit-virtual-interface` を使用する方法を示しています。 **AWS CLI** **トランジット仮想インターフェイスを作成するには** 次の `create-transit-virtual-interface` の例では、指定した接続用にトランジット仮想インターフェイスを作成します。 ``` 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}]" ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*AWS Direct Connect ユーザーガイド*」の「[Creating a Transit Virtual Interface to the Direct Connect Gateway](https://docs.aws.amazon.com/directconnect/latest/UserGuide/create-vif.html#create-transit-vif)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateTransitVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/create-transit-virtual-interface.html)」を参照してください。 ### `delete-bgp-peer` 次のコード例は、`delete-bgp-peer` を使用する方法を示しています。 **AWS CLI** **仮想インターフェイスから BGP ピアを削除するには** 次の例では、仮想インターフェイス `dxvif-fg1vuj3d` から IPv6 BGP ピアを削除します。 コマンド: ``` aws directconnect delete-bgp-peer --virtual-interface-id dxvif-fg1vuj3d --asn 64600 --customer-address 2001:db8:1100:2f0:0:1:9cb4:4216/125 ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteBgpPeer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/delete-bgp-peer.html)」を参照してください。 ### `delete-connection` 次のコード例は、`delete-connection` を使用する方法を示しています。 **AWS CLI** **接続を削除するには** 次の `delete-connection` コマンドは、指定した接続を削除します。 ``` aws directconnect delete-connection --connection-id dxcon-fg31dyv6 ``` 出力: ``` { "ownerAccount": "123456789012", "connectionId": "dxcon-fg31dyv6", "connectionState": "deleted", "bandwidth": "1Gbps", "location": "TIVIT", "connectionName": "Connection to AWS", "region": "sa-east-1" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/delete-connection.html)」を参照してください。 ### `delete-direct-connect-gateway-association` 次のコード例は、`delete-direct-connect-gateway-association` を使用する方法を示しています。 **AWS CLI** **Direct Connect ゲートウェイの関連付けを削除するには** 次の `delete-direct-connect-gateway-association` の例では、指定された関連付け ID を持つ Transit Gateway との Direct Connect ゲートウェイの関連付けを削除します。 ``` aws directconnect delete-direct-connect-gateway-association --association-id be85116d-46eb-4b43-a27a-da0c2ad648de ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*AWS Direct Connect ユーザーガイド*」の「[Associating and Disassociating Transit Gateways](https://docs.aws.amazon.com/directconnect/latest/UserGuide/direct-connect-transit-gateways.html#associate-tgw-with-direct-connect-gateway)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDirectConnectGatewayAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/delete-direct-connect-gateway-association.html)」を参照してください。 ### `delete-direct-connect-gateway` 次のコード例は、`delete-direct-connect-gateway` を使用する方法を示しています。 **AWS CLI** **Direct Connect ゲートウェイを削除するには** 次の例では、Direct Connect ゲートウェイ `5f294f92-bafb-4011-916d-9b0bexample` を削除します。 コマンド: ``` aws directconnect delete-direct-connect-gateway --direct-connect-gateway-id 5f294f92-bafb-4011-916d-9b0bexample ``` 出力: ``` { "directConnectGateway": { "amazonSideAsn": 64512, "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample", "ownerAccount": "123456789012", "directConnectGatewayName": "DxGateway1", "directConnectGatewayState": "deleting" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDirectConnectGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/delete-direct-connect-gateway.html)」を参照してください。 ### `delete-interconnect` 次のコード例は、`delete-interconnect` を使用する方法を示しています。 **AWS CLI** **相互接続を削除するには** 次の `delete-interconnect` コマンドは、指定した相互接続を削除します。 ``` aws directconnect delete-interconnect --interconnect-id dxcon-fgktov66 ``` 出力: ``` { "interconnectState": "deleted" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteInterconnect](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/delete-interconnect.html)」を参照してください。 ### `delete-lag` 次のコード例は、`delete-lag` を使用する方法を示しています。 **AWS CLI** **LAG を削除するには** 次の例では、指定した LAG を削除します。 コマンド: ``` aws directconnect delete-lag --lag-id dxlag-ffrhowd9 ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteLag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/delete-lag.html)」を参照してください。 ### `delete-virtual-interface` 次のコード例は、`delete-virtual-interface` を使用する方法を示しています。 **AWS CLI** **仮想インターフェイスを削除するには** 次の `delete-virtual-interface` コマンドは、指定した仮想インターフェイスを削除します。 ``` aws directconnect delete-virtual-interface --virtual-interface-id dxvif-ffhhk74f ``` 出力: ``` { "virtualInterfaceState": "deleting" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteVirtualInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/delete-virtual-interface.html)」を参照してください。 ### `describe-connection-loa` 次のコード例は、`describe-connection-loa` を使用する方法を示しています。 **AWS CLI** **Linux または Mac OS X を使用して接続用の LOA-CFA を記述するには** 次の例では、接続 `dxcon-fh6ayh1d` 用の LOA-CFA を記述します。LOA-CFA の内容は base64 でエンコードされています。このコマンドは、`--output` パラメータおよび `--query` パラメータを使用して出力を制御し、`loaContent` 構造の内容を抽出します。コマンドの最後の部分で `base64` ユーティリティを使用してコンテンツをデコードし、出力を PDF ファイルに送信します。 ``` aws directconnect describe-connection-loa --connection-id dxcon-fh6ayh1d --output text --query loa.loaContent|base64 --decode > myLoaCfa.pdf ``` **Windows を使用して接続用の LOA-CFA を記述するには** 前の例では、`base64` ユーティリティを使用して出力をデコードする必要がありました。Windows コンピュータでは、代わりに `certutil` を使用できます。次の例では、最初のコマンドで接続 `dxcon-fh6ayh1d` 用の LOA-CFA を記述し、`--output` パラメータと `--query` パラメータを使用して出力を制御し、`loaContent` 構造の内容を `myLoaCfa.base64` というファイルに抽出します。2 番目のコマンドでは、`certutil` ユーティリティを使用してファイルをデコードし、PDF ファイルに出力を送信します。 ``` aws directconnect describe-connection-loa --connection-id dxcon-fh6ayh1d --output text --query loa.loaContent > myLoaCfa.base64 ``` ``` certutil -decode myLoaCfa.base64 myLoaCfa.pdf ``` AWS CLI 出力を制御する方法の詳細については、「*AWS コマンドラインインターフェイスユーザーガイド*」の「[Controlling Command Output from the AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/userguide/controlling-output.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeConnectionLoa](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-connection-loa.html)」を参照してください。 ### `describe-connections-on-interconnect` 次のコード例は、`describe-connections-on-interconnect` を使用する方法を示しています。 **AWS CLI** **相互接続上の接続を一覧表示するには** 次の `describe-connections-on-interconnect` コマンドは、指定された相互接続上にプロビジョニングされた接続を一覧表示します。 ``` aws directconnect describe-connections-on-interconnect --interconnect-id dxcon-fgktov66 ``` 出力: ``` { "connections": [ { "partnerName": "TIVIT", "vlan": 101, "ownerAccount": "123456789012", "connectionId": "dxcon-ffzc51m1", "connectionState": "ordering", "bandwidth": "500Mbps", "location": "TIVIT", "connectionName": "mydcinterconnect", "region": "sa-east-1" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeConnectionsOnInterconnect](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-connections-on-interconnect.html)」を参照してください。 ### `describe-connections` 次のコード例は、`describe-connections` を使用する方法を示しています。 **AWS CLI** **現在のリージョンのすべての接続を一覧表示するには** 次の `describe-connections` コマンドは、現在のリージョン内にあるすべての接続を一覧表示します。 ``` aws directconnect describe-connections ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-connections.html)」を参照してください。 ### `describe-direct-connect-gateway-association-proposals` 次のコード例は、`describe-direct-connect-gateway-association-proposals` を使用する方法を示しています。 **AWS CLI** **Direct Connect ゲートウェイの関連付けの提案を記述するには** 次の `describe-direct-connect-gateway-association-proposals` の例では、Direct Connect ゲートウェイの関連付けの提案に関する詳細を表示します。 ``` aws directconnect describe-direct-connect-gateway-association-proposals ``` 出力: ``` { "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" } ] } ] } ``` 詳細については、「*AWS Direct Connect ユーザーガイド*」の「[Associating and Disassociating Transit Gateways](https://docs.aws.amazon.com/directconnect/latest/UserGuide/direct-connect-transit-gateways.html#associate-tgw-with-direct-connect-gateway)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDirectConnectGatewayAssociationProposals](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-direct-connect-gateway-association-proposals.html)」を参照してください。 ### `describe-direct-connect-gateway-associations` 次のコード例は、`describe-direct-connect-gateway-associations` を使用する方法を示しています。 **AWS CLI** **Direct Connect ゲートウェイの関連付けを記述するには** 次の例では、Direct Connect ゲートウェイ `5f294f92-bafb-4011-916d-9b0bexample` とのすべての関連付けについて説明します。 コマンド: ``` aws directconnect describe-direct-connect-gateway-associations --direct-connect-gateway-id 5f294f92-bafb-4011-916d-9b0bexample ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDirectConnectGatewayAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-direct-connect-gateway-associations.html)」を参照してください。 ### `describe-direct-connect-gateway-attachments` 次のコード例は、`describe-direct-connect-gateway-attachments` を使用する方法を示しています。 **AWS CLI** **Direct Connect ゲートウェイのアタッチメントを記述するには** 次の例では、Direct Connect ゲートウェイ `5f294f92-bafb-4011-916d-9b0bexample` にアタッチされている仮想インターフェイスについて説明します。 コマンド: ``` aws directconnect describe-direct-connect-gateway-attachments --direct-connect-gateway-id 5f294f92-bafb-4011-916d-9b0bexample ``` 出力: ``` { "directConnectGatewayAttachments": [ { "virtualInterfaceOwnerAccount": "123456789012", "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample", "virtualInterfaceRegion": "us-east-2", "attachmentState": "attaching", "virtualInterfaceId": "dxvif-fg9zyabc" } ], "nextToken": "eyJ2IjoxLCJzIjoxLCJpIjoibEhXdlNpUXF5RzhoL1JyUW52SlV2QT09IiwiYyI6Im5wQjFHQ0RyQUdRS3puNnNXcUlINCtkTTA4dTk3KzBiU0xtb05JQmlaczZ6NXRIYmk3c3VESUxFTTd6a2FzVHM0VTFwaGJkZGNxTytqWmQ3QzMzOGRQaTVrTThrOG1zelRsV3gyMWV3VTNFPSJ9" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDirectConnectGatewayAttachments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-direct-connect-gateway-attachments.html)」を参照してください。 ### `describe-direct-connect-gateways` 次のコード例は、`describe-direct-connect-gateways` を使用する方法を示しています。 **AWS CLI** **Direct Connect ゲートウェイを記述するには** 次の例では、すべての Direct Connect ゲートウェイについて説明します。 コマンド: ``` aws directconnect describe-direct-connect-gateways ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDirectConnectGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-direct-connect-gateways.html)」を参照してください。 ### `describe-hosted-connections` 次のコード例は、`describe-hosted-connections` を使用する方法を示しています。 **AWS CLI** **相互接続上の接続を一覧表示するには** 次の例では、指定された相互接続上にプロビジョニングされている接続を一覧表示します。 コマンド: ``` aws directconnect describe-hosted-connections --connection-id dxcon-fgktov66 ``` 出力: ``` { "connections": [ { "partnerName": "TIVIT", "vlan": 101, "ownerAccount": "123456789012", "connectionId": "dxcon-ffzc51m1", "connectionState": "ordering", "bandwidth": "500Mbps", "location": "TIVIT", "connectionName": "mydcinterconnect", "region": "sa-east-1" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeHostedConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-hosted-connections.html)」を参照してください。 ### `describe-interconnect-loa` 次のコード例は、`describe-interconnect-loa` を使用する方法を示しています。 **AWS CLI** **Linux または Mac OS X を使用して相互接続用の LOA-CFA を記述するには** 次の例では、相互接続 `dxcon-fh6ayh1d` 用の LOA-CFA を記述します。LOA-CFA の内容は base64 でエンコードされています。このコマンドは、`--output` パラメータおよび `--query` パラメータを使用して出力を制御し、`loaContent` 構造の内容を抽出します。コマンドの最後の部分で `base64` ユーティリティを使用してコンテンツをデコードし、出力を PDF ファイルに送信します。 ``` aws directconnect describe-interconnect-loa --interconnect-id dxcon-fh6ayh1d --output text --query loa.loaContent|base64 --decode > myLoaCfa.pdf ``` **Windows を使用して相互接続用の LOA-CFA を記述するには** 前の例では、`base64` ユーティリティを使用して出力をデコードする必要がありました。Windows コンピュータでは、代わりに `certutil` を使用できます。次の例では、最初のコマンドで相互接続 `dxcon-fh6ayh1d` 用の LOA-CFA を記述し、`--output` パラメータと `--query` パラメータを使用して出力を制御し、`loaContent` 構造の内容を `myLoaCfa.base64` というファイルに抽出します。2 番目のコマンドでは、`certutil` ユーティリティを使用してファイルをデコードし、PDF ファイルに出力を送信します。 ``` aws directconnect describe-interconnect-loa --interconnect-id dxcon-fh6ayh1d --output text --query loa.loaContent > myLoaCfa.base64 ``` ``` certutil -decode myLoaCfa.base64 myLoaCfa.pdf ``` AWS CLI 出力を制御する方法の詳細については、「*AWS コマンドラインインターフェイスユーザーガイド*」の「[Controlling Command Output from the AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/userguide/controlling-output.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeInterconnectLoa](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-interconnect-loa.html)」を参照してください。 ### `describe-interconnects` 次のコード例は、`describe-interconnects` を使用する方法を示しています。 **AWS CLI** **相互接続を一覧表示するには** 次の `describe-interconnects` コマンドは、AWS アカウントが所有する相互接続を一覧表示します。 ``` aws directconnect describe-interconnects ``` 出力: ``` { "interconnects": [ { "region": "sa-east-1", "bandwidth": "1Gbps", "location": "TIVIT", "interconnectName": "1G Interconnect to AWS", "interconnectId": "dxcon-fgktov66", "interconnectState": "down" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeInterconnects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-interconnects.html)」を参照してください。 ### `describe-lags` 次のコード例は、`describe-lags` を使用する方法を示しています。 **AWS CLI** **LAG を記述するには** 次のコマンドは、現在のリージョンのすべての LAG について表示します。 コマンド: ``` aws directconnect describe-lags ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeLags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-lags.html)」を参照してください。 ### `describe-loa` 次のコード例は、`describe-loa` を使用する方法を示しています。 **AWS CLI** **Linux または Mac OS X を使用して接続用の LOA-CFA を記述するには** 次の例では、接続 `dxcon-fh6ayh1d` 用の LOA-CFA を記述します。LOA-CFA の内容は base64 でエンコードされています。このコマンドは、`--output` パラメータおよび `--query` パラメータを使用して出力を制御し、`loaContent` 構造の内容を抽出します。コマンドの最後の部分で `base64` ユーティリティを使用してコンテンツをデコードし、出力を PDF ファイルに送信します。 ``` aws directconnect describe-loa --connection-id dxcon-fh6ayh1d --output text --query loa.loaContent|base64 --decode > myLoaCfa.pdf ``` **Windows を使用して接続用の LOA-CFA を記述するには** 前の例では、`base64` ユーティリティを使用して出力をデコードする必要がありました。Windows コンピュータでは、代わりに `certutil` を使用できます。次の例では、最初のコマンドで接続 `dxcon-fh6ayh1d` 用の LOA-CFA を記述し、`--output` パラメータと `--query` パラメータを使用して出力を制御し、`loaContent` 構造の内容を `myLoaCfa.base64` というファイルに抽出します。2 番目のコマンドでは、`certutil` ユーティリティを使用してファイルをデコードし、PDF ファイルに出力を送信します。 ``` aws directconnect describe-loa --connection-id dxcon-fh6ayh1d --output text --query loa.loaContent > myLoaCfa.base64 ``` ``` certutil -decode myLoaCfa.base64 myLoaCfa.pdf ``` AWS CLI 出力を制御する方法の詳細については、「*AWS コマンドラインインターフェイスユーザーガイド*」の「[Controlling Command Output from the AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/userguide/controlling-output.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeLoa](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-loa.html)」を参照してください。 ### `describe-locations` 次のコード例は、`describe-locations` を使用する方法を示しています。 **AWS CLI** **AWS Direct Connect のパートナーとロケーションを一覧表示するには** 次の `describe-locations` コマンドは、現在のリージョン内にある AWS Direct Connect パートナーとロケーションを一覧表示します。 ``` aws directconnect describe-locations ``` 出力: ``` { "locations": [ { "locationName": "NAP do Brasil, Barueri, Sao Paulo", "locationCode": "TNDB" }, { "locationName": "Tivit - Site Transamerica (Sao Paulo)", "locationCode": "TIVIT" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeLocations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-locations.html)」を参照してください。 ### `describe-tags` 次のコード例は、`describe-tags` を使用する方法を示しています。 **AWS CLI** **AWS Direct Connect リソースのタグを記述するには** 次のコマンドは、接続 `dxcon-abcabc12` のタグについて表示します。 コマンド: ``` aws directconnect describe-tags --resource-arns arn:aws:directconnect:us-east-1:123456789012:dxcon/dxcon-abcabc12 ``` 出力: ``` { "resourceTags": [ { "resourceArn": "arn:aws:directconnect:us-east-1:123456789012:dxcon/dxcon-abcabc12", "tags": [ { "value": "VAConnection", "key": "Name" } ] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-tags.html)」を参照してください。 ### `describe-virtual-gateways` 次のコード例は、`describe-virtual-gateways` を使用する方法を示しています。 **AWS CLI** **仮想プライベートゲートウェイを一覧表示するには** 次の `describe-virtual-gateways` コマンドは、AWS アカウントが所有する仮想プライベートゲートウェイを一覧表示します。 ``` aws directconnect describe-virtual-gateways ``` 出力: ``` { "virtualGateways": [ { "virtualGatewayId": "vgw-aba37db6", "virtualGatewayState": "available" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeVirtualGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-virtual-gateways.html)」を参照してください。 ### `describe-virtual-interfaces` 次のコード例は、`describe-virtual-interfaces` を使用する方法を示しています。 **AWS CLI** **すべての仮想インターフェイスを一覧表示するには** 次の `describe-virtual-interfaces` コマンドは、AWS アカウントに関連付けられているすべての仮想インターフェイスに関する情報を一覧表示します。 ``` aws directconnect describe-virtual-interfaces --connection-id dxcon-ffjrkx17 ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeVirtualInterfaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/describe-virtual-interfaces.html)」を参照してください。 ### `disassociate-connection-from-lag` 次のコード例は、`disassociate-connection-from-lag` を使用する方法を示しています。 **AWS CLI** **LAG から接続の関連付けを解除するには** 次の例では、指定された接続の関連付けを指定された LAG から解除します。 コマンド: ``` aws directconnect disassociate-connection-from-lag --lag-id dxlag-fhccu14t --connection-id dxcon-fg9607vm ``` 出力: ``` { "ownerAccount": "123456789012", "connectionId": "dxcon-fg9607vm", "connectionState": "requested", "bandwidth": "1Gbps", "location": "EqDC2", "connectionName": "Con2ForLag", "region": "us-east-1" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateConnectionFromLag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/disassociate-connection-from-lag.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **AWS Direct Connect リソースにタグを追加するには** 次のコマンドは、キー `Name` と値 `VAConnection` を持つタグを接続 `dxcon-abcabc12` に追加します。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws directconnect tag-resource --resource-arn arn:aws:directconnect:us-east-1:123456789012:dxcon/dxcon-abcabc12 --tags "key=Name,value=VAConnection" ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **AWS Direct Connect リソースからタグを削除するには** 次のコマンドは、キー `Name` を持つタグを接続 `dxcon-abcabc12` から削除します。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws directconnect untag-resource --resource-arn arn:aws:directconnect:us-east-1:123456789012:dxcon/dxcon-abcabc12 --tag-keys Name ``` + API の詳細については、「AWS CLI コマンドリファレンス」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/untag-resource.html)」を参照してください。 ### `update-direct-connect-gateway-association` 次のコード例は、`update-direct-connect-gateway-association` を使用する方法を示しています。 **AWS CLI** **Direct Connect ゲートウェイの関連付けの指定された属性を更新するには** 次の `update-direct-connect-gateway-association` の例では、指定された CIDR ブロックを 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 ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*AWS Direct Connect ユーザーガイド*」の「[Working with Direct Connect Gateways](https://docs.aws.amazon.com/directconnect/latest/UserGuide/direct-connect-gateways.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateDirectConnectGatewayAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/update-direct-connect-gateway-association.html)」を参照してください。 ### `update-lag` 次のコード例は、`update-lag` を使用する方法を示しています。 **AWS CLI** **LAG を更新するには** 次の例では、指定された LAG の名前を変更します。 コマンド: ``` aws directconnect update-lag --lag-id dxlag-ffjhj9lx --lag-name 2ConnLag ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateLag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/update-lag.html)」を参照してください。 ### `update-virtual-interface-attributes` 次のコード例は、`update-virtual-interface-attributes` を使用する方法を示しています。 **AWS CLI** **仮想インターフェイスの MTU を更新するには** 次の `update-virtual-interface-attributes` の例では、指定された仮想インターフェイスの MTU を更新しています。 ``` aws directconnect update-virtual-interface-attributes \ --virtual-interface-id dxvif-fEXAMPLE \ --mtu 1500 ``` 出力: ``` { "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": [] } ``` 詳細については、「*AWS Direct Connect ユーザーガイド*」の「[Setting Network MTU for Private Virtual Interfaces or Transit Virtual Interfaces](https://docs.aws.amazon.com/directconnect/latest/UserGuide/set-jumbo-frames-vif.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateVirtualInterfaceAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directconnect/update-virtual-interface-attributes.html)」を参照してください。 # Directory Service examples using AWS CLI 次のコード例では、Directory Service で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `describe-directories` 次のコード例は、`describe-directories` を使用する方法を示しています。 **AWS CLI** **ディレクトリに関する詳細を取得するには** 次の `describe-directories` の例では、指定されたディレクトリに関する詳細情報を表示しています。 ``` aws ds describe-directories \ --directory-id d-a1b2c3d4e5 ``` 出力: ``` { "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" ] } } } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDirectories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ds/describe-directories.html)」を参照してください。 ### `describe-trusts` 次のコード例は、`describe-trusts` を使用する方法を示しています。 **AWS CLI** **信頼関係に関する詳細を取得するには** 次の `describe-trusts` の例では、指定されたディレクトリの信頼関係に関する詳細情報を表示しています。 ``` aws ds describe-trusts \ --directory-id d-a1b2c3d4e5 ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTrusts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ds/describe-trusts.html)」を参照してください。 # AWS CLI での Directory Service Data の使用例 次のコード例では、AWS Command Line Interface で Directory Service Data を使用してアクションを実行し、一般的なシナリオを実装する方法を示します。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `add-group-member` 次のコード例は、`add-group-member` を使用する方法を示しています。 **AWS CLI** **ディレクトリにグループメンバーを追加するには** 次の `add-group-member` の例では、指定したディレクトリ内の指定したグループに、指定したユーザーを追加します。 ``` aws ds-data add-group-member \ --directory-id d-1234567890 \ --group-name 'sales' \ --member-name 'john.doe' ``` このコマンドでは何も出力されません。 詳細については、「*AWS Directory Service 管理ガイド*」の「[AWS Managed Microsoft AD メンバーをグループに追加、およびグループから削除する](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_add_remove_user_group.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[AddGroupMember](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/add-group-member.html)」を参照してください。 ### `create-group` 次のコード例は、`create-group` を使用する方法を示しています。 **AWS CLI** **使用可能なウィジェットを一覧表示するには** 次の `create-group` の例では、指定したディレクトリにグループを作成します。 ``` aws ds-data create-group \ --directory-id d-1234567890 \ --sam-account-name "sales" ``` 出力: ``` { "DirectoryId": "d-1234567890", "SAMAccountName": "sales", "SID": "S-1-2-34-5567891234-5678912345-67891234567-8912" } ``` 詳細については、「*AWS Directory Service 管理ガイド*」の「[AWS Managed Microsoft AD グループの作成](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_create_group.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/create-group.html)」を参照してください。 ### `create-user` 次のコード例は、`create-user` を使用する方法を示しています。 **AWS CLI** **ユーザーを作成するには** 次の `create-user` の例では、指定したディレクトリにユーザーを作成します。 ``` aws ds-data create-user \ --directory-id d-1234567890 \ --sam-account-name 'john.doe' ``` 出力: ``` { "DirectoryId": "d-1234567890", "SAMAccountName": "john.doe", "SID": "S-1-2-34-5567891234-5678912345-67891234567-8912" } ``` 詳細については、「*AWS Directory Service 管理ガイド*」の「[AWS Managed Microsoft AD ユーザーの作成](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_create_user.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/create-user.html)」を参照してください。 ### `delete-group` 次のコード例は、`delete-group` を使用する方法を示しています。 **AWS CLI** **グループを削除するには** 次の `delete-group` の例では、指定したディレクトリから指定したグループを削除します。 ``` aws ds-data delete-group \ --directory-id d-1234567890 \ --sam-account-name 'sales' ``` このコマンドでは何も出力されません。 詳細については、「*AWS Directory Service 管理ガイド*」の「[AWS Managed Microsoft AD グループの削除](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_delete_group.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/delete-group.html)」を参照してください。 ### `delete-user` 次のコード例は、`delete-user` を使用する方法を示しています。 **AWS CLI** **ユーザーを削除するには** 次の `delete-user` の例では、指定したディレクトリから指定したユーザーを削除します。 ``` aws ds-data delete-user \ --directory-id d-1234567890 \ --sam-account-name 'john.doe' ``` このコマンドでは何も出力されません。 詳細については、「*AWS Directory Service 管理ガイド*」の「[AWS Managed Microsoft AD ユーザーの削除](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_delete_user.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/delete-user.html)」を参照してください。 ### `describe-group` 次のコード例は、`describe-group` を使用する方法を示しています。 **AWS CLI** **グループの詳細を一覧表示するには** 次の `describe-group` の例では、指定したディレクトリ内の指定したグループの情報を取得します。 ``` aws ds-data describe-group \ --directory-id d-1234567890 \ --sam-account-name 'sales' ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Directory Service 管理ガイド*」の「[AWS Managed Microsoft AD グループの詳細の表示と更新](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_group.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/describe-group.html)」を参照してください。 ### `describe-user` 次のコード例は、`describe-user` を使用する方法を示しています。 **AWS CLI** **ユーザーの情報を一覧表示するには** 次の `describe-user` の例では、指定したディレクトリ内の指定したユーザーの情報を取得します。 ``` aws ds-data describe-user command-name \ --directory-id d-1234567890 \ --sam-account-name 'john.doe' ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Directory Service 管理ガイド*」の「[AWS Managed Microsoft AD ユーザーの表示と更新](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_user.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*の「[DescribeUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/describe-user.html)」を参照してください。 ### `disable-directory-data-access` 次のコード例は、`disable-directory-data-access` を使用する方法を示しています。 **AWS CLI** **ディレクトリの Directory Service Data API を無効にするには** 次の `disable-directory-data-access` の例では、指定したディレクトリの Directory Service Data API を無効にします。 ``` aws ds disable-directory-data-access \ --directory-id d-1234567890 ``` このコマンドでは何も出力されません。 詳細については、「*AWS Directory Service 管理ガイド*」の「[ユーザーとグループの管理または AWS Directory Service Data の有効化または無効化](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_users_groups_mgmt_enable_disable.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DisableDirectoryDataAccess](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/disable-directory-data-access.html)」を参照してください。 ### `disable-user` 次のコード例は、`disable-user` を使用する方法を示しています。 **AWS CLI** **ユーザーを無効にするには** 次の `disable-user` の例では、指定したディレクトリ内の指定したユーザーを無効にします。 ``` aws ds-data disable-user \ --directory-id d-1234567890 \ --sam-account-name 'john.doe' ``` このコマンドでは何も出力されません。 詳細については、「*AWS Directory Service 管理ガイド*」の「[AWS Managed Microsoft AD ユーザーの無効化](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_disable_user.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DisableUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/disable-user.html)」を参照してください。 ### `enable-directory-data-access` 次のコード例は、`enable-directory-data-access` を使用する方法を示しています。 **AWS CLI** **ディレクトリの Directory Service Data API を有効にするには** 次の `enable-directory-data-access` の例では、指定されたディレクトリの Directory Service Data API を有効にします。 ``` aws ds enable-directory-data-access \ --directory-id d-1234567890 ``` このコマンドでは何も出力されません。 詳細については、「*AWS Directory Service 管理ガイド*」の「[ユーザーとグループの管理または AWS Directory Service Data の有効化または無効化](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_users_groups_mgmt_enable_disable.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[EnableDirectoryDataAccess](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/enable-directory-data-access.html)」を参照してください。 ### `list-group-members` 次のコード例は、`list-group-members` を使用する方法を示しています。 **AWS CLI** **ディレクトリのグループメンバーを一覧表示するには** 次の `list-group-members` の例では、指定したディレクトリ内の指定したグループのグループメンバーを一覧表示します。 ``` aws ds-data list-group-members \ --directory-id d-1234567890 \ --sam-account-name 'sales' ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Directory Service 管理ガイド*」の「[AWS Managed Microsoft AD グループの詳細の表示と更新](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_group.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListGroupMembers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/list-group-members.html)」を参照してください。 ### `list-groups-for-member` 次のコード例は、`list-groups-for-member` を使用する方法を示しています。 **AWS CLI** **ディレクトリのグループメンバーシップを一覧表示するには** 次の `list-groups-for-member` の例では、指定したディレクトリ内の指定したユーザーのグループメンバーシップを一覧表示します。 ``` aws ds-data list-groups-for-member \ --directory-id d-1234567890 \ --sam-account-name 'john.doe' ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Directory Service 管理ガイド*」の「[AWS Managed Microsoft AD ユーザーの表示と更新](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_user.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[ListGroupsForMember](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/list-groups-for-member.html)」を参照してください。 ### `list-groups` 次のコード例は、`list-groups` を使用する方法を示しています。 **AWS CLI** **ディレクトリのグループを一覧表示するには** 次の `list-groups` の例では、指定したディレクトリ内のグループを一覧表示します。 ``` aws ds-data list-groups \ --directory-id d-1234567890 ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Directory Service 管理ガイド*」の「[AWS Managed Microsoft AD グループの詳細の表示と更新](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_group.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/list-groups.html)」を参照してください。 ### `list-users` 次のコード例は、`list-users` を使用する方法を示しています。 **AWS CLI** **ディレクトリのユーザーを一覧表示するには** 次の `list-users` の例では、指定したディレクトリ内のユーザーを一覧表示します。 ``` aws ds-data list-users \ --directory-id d-1234567890 ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Directory Service 管理ガイド*」の「[AWS Managed Microsoft AD ユーザーの表示と更新](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_user.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListUsers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/list-users.html)」を参照してください。 ### `remove-group-member` 次のコード例は、`remove-group-member` を使用する方法を示しています。 **AWS CLI** **ディレクトリからグループメンバーを削除するには** 次の `remove-group-member` の例では、指定したディレクトリ内の指定したグループから、指定したグループメンバーを削除します。 ``` aws ds-data remove-group-member \ --directory-id d-1234567890 \ --group-name 'sales' \ --member-name 'john.doe' ``` このコマンドでは何も出力されません。 詳細については、「*AWS Directory Service 管理ガイド*」の「[AWS Managed Microsoft AD メンバーをグループに追加、およびグループから削除する](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_add_remove_user_group.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[RemoveGroupMember](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/remove-group-member.html)」を参照してください。 ### `reset-user-password` 次のコード例は、`reset-user-password` を使用する方法を示しています。 **AWS CLI** **ディレクトリ内のユーザーパスワードをリセットするには** 次の `reset-user-password` の例では、指定したディレクトリ内の指定したユーザーをリセットして有効にします。 ``` aws ds reset-user-password \ --directory-id d-1234567890 \ --user-name 'john.doe' \ --new-password 'password' ``` このコマンドでは何も出力されません。 詳細については、「*AWS Directory Service 管理ガイド*」の「[AWS Managed Microsoft AD ユーザーのパスワードのリセットと有効化](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_reset_user_pswd.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[ResetUserPassword](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/reset-user-password.html)」を参照してください。 ### `search-groups` 次のコード例は、`search-groups` を使用する方法を示しています。 **AWS CLI** **ディレクトリ内のグループを検索するには** 次の `search-groups` の例では、指定したディレクトリ内の指定したグループを検索します。 ``` aws ds-data search-groups \ --directory-id d-1234567890 \ --search-attributes 'SamAccountName' \ --search-string 'sales' ``` 出力: ``` { "Groups": [ { "GroupScope": "Global", "GroupType": "Distribution", "SAMAccountName": "sales", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4567" } ], "DirectoryId": "d-1234567890", "Realm": "corp.example.com" } ``` 詳細については、「*AWS Directory Service 管理ガイド*」の「[AWS Managed Microsoft AD グループの詳細の表示と更新](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_group.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[SearchGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/search-groups.html)」を参照してください。 ### `search-users` 次のコード例は、`search-users` を使用する方法を示しています。 **AWS CLI** **ディレクトリ内のユーザーを検索するには** 次の `search-users` の例では、指定したディレクトリ内の指定したユーザーを検索します。 ``` aws ds-data search-users \ --directory-id d-1234567890 \ --search-attributes 'SamAccountName' \ --Search-string 'john.doe' ``` 出力: ``` { "Users": [ { "Enabled": true, "SAMAccountName": "john.doe", "SID": "S-1-2-34-5678901234-5678901234-5678910123-4567" } ], "DirectoryId": "d-1234567890", "Realm": "corp.example.com" } ``` 詳細については、「*AWS Directory Service 管理ガイド*」の「[AWS Managed Microsoft AD ユーザーの表示と更新](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_user.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[SearchUsers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/search-users.html)」を参照してください。 ### `update-group` 次のコード例は、`update-group` を使用する方法を示しています。 **AWS CLI** **ディレクトリ内のグループの属性を更新するには** 次の `update-group` の例では、指定したディレクトリ内の指定したグループの指定した属性を更新します。 ``` aws ds-data update-group \ --directory-id d-1234567890 \ --sam-account-name 'sales' \ --update-type 'REPLACE' \ --group-type 'Distribution' ``` このコマンドでは何も出力されません。 詳細については、「*AWS Directory Service 管理ガイド*」の「[AWS Managed Microsoft AD グループの詳細の表示と更新](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_group.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/update-group.html)」を参照してください。 ### `update-user` 次のコード例は、`update-user` を使用する方法を示しています。 **AWS CLI** **ディレクトリ内のユーザーの属性を更新するには** 次の `update-user` の例では、指定したディレクトリ内の指定したユーザーの指定した属性を更新します。 ``` aws ds-data update-user \ --directory-id d-1234567890 \ --sam-account-name 'john.doe' \ --update-type 'ADD' \ --email-address 'example.corp.com' ``` このコマンドでは何も出力されません。 詳細については、「*AWS Directory Service 管理ガイド*」の「[AWS Managed Microsoft AD ユーザーの表示と更新](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_view_update_user.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/directory-service-data/update-user.html)」を参照してください。 # AWS DMS examples using AWS CLI 次のコード例では、AWS DMS で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `add-tags-to-resource` 次のコード例は、`add-tags-to-resource` を使用する方法を示しています。 **AWS CLI** **リソースにタグを追加するには** 次の `add-tags-to-resource` の例では、タグをレプリケーション インスタンスに追加しています。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Tagging Resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tagging.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[AddTagsToResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/add-tags-to-resource.html)」を参照してください。 ### `create-endpoint` 次のコード例は、`create-endpoint` を使用する方法を示しています。 **AWS CLI** **エンドポイントを作成するには** 次の `create-endpoint` の例では、Amazon S3 ソースのエンドポイントを作成しています。 ``` aws dms create-endpoint \ --endpoint-type source \ --engine-name s3 \ --endpoint-identifier src-endpoint \ --s3-settings file://s3-settings.json ``` `s3-settings.json` の内容: ``` { "BucketName":"my-corp-data", "BucketFolder":"sourcedata", "ServiceAccessRoleArn":"arn:aws:iam::123456789012:role/my-s3-access-role" } ``` 出力: ``` { "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 } } } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Working with AWS DMS Endpoints](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/create-endpoint.html)」を参照してください。 ### `create-event-subscription` 次のコード例は、`create-event-subscription` を使用する方法を示しています。 **AWS CLI** **イベントサブスクリプションを一覧表示するには** 次の `create-event-subscription` の例では、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 ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Working with Events and Notifications](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateEventSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/create-event-subscription.html)」を参照してください。 ### `create-replication-instance` 次のコード例は、`create-replication-instance` を使用する方法を示しています。 **AWS CLI** **レプリケーションインスタンスを作成するには** 次の `create-replication-instance` の例では、レプリケーションインスタンスを作成しています。 ``` aws dms create-replication-instance \ --replication-instance-identifier my-repl-instance \ --replication-instance-class dms.t2.micro \ --allocated-storage 5 ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Working with an AWS DMS Replication Instance](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateReplicationInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/create-replication-instance.html)」を参照してください。 ### `create-replication-subnet-group` 次のコード例は、`create-replication-subnet-group` を使用する方法を示しています。 **AWS CLI** **サブネットグループを作成するには** 次の `create-replication-subnet-group` の例では、3 つのサブネットで構成されるグループを作成しています。 ``` 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 ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Setting Up a Network for a Replication Instance](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.VPC.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateReplicationSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/create-replication-subnet-group.html)」を参照してください。 ### `create-replication-task` 次のコード例は、`create-replication-task` を使用する方法を示しています。 **AWS CLI** **レプリケーションタスクを作成するには** 次の `create-replication-task` の例では、レプリケーションタスクを作成しています。 ``` 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 ``` `table-mappings.json` の内容: ``` { "rules": [ { "rule-type": "selection", "rule-id": "1", "rule-name": "1", "object-locator": { "schema-name": "prodrep", "table-name": "%" }, "rule-action": "include", "filters": [] } ] } ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Working with AWS DMS Tasks](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateReplicationTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/create-replication-task.html)」を参照してください。 ### `delete-connection` 次のコード例は、`delete-connection` を使用する方法を示しています。 **AWS CLI** **接続を削除するには** 次の `delete-connection` の例では、レプリケーションインスタンスからエンドポイントの関連付けを解除しています。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の [https://docs.aws.amazon.com/dms/latest/userguide/CHAP\$1Endpoints.Creating.html](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.Creating.html) を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/delete-connection.html)」を参照してください。 ### `delete-endpoint` 次のコード例は、`delete-endpoint` を使用する方法を示しています。 **AWS CLI** **エンドポイントを削除するには** 次の `delete-endpoint` の例では、エンドポイントを削除しています。 ``` aws dms delete-endpoint \ --endpoint-arn arn:aws:dms:us-east-1:123456789012:endpoint:OUJJVXO4XZ4CYTSEG5XGMN2R3Y ``` 出力: ``` { "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 } } } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Working with AWS DMS Endpoints](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/delete-endpoint.html)」を参照してください。 ### `delete-event-subscription` 次のコード例は、`delete-event-subscription` を使用する方法を示しています。 **AWS CLI** **イベントサブスクリプションを削除するには** 次の `delete-event-subscription` の例では、Amazon SNS トピックへのサブスクリプションを削除しています。 ``` aws dms delete-event-subscription \ --subscription-name "my-dms-events" ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Working with Events and Notifications](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteEventSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/delete-event-subscription.html)」を参照してください。 ### `delete-replication-instance` 次のコード例は、`delete-replication-instance` を使用する方法を示しています。 **AWS CLI** **レプリケーションインスタンスを削除するには** 次の `delete-replication-instance` の例では、レプリケーション インスタンスを削除します。 ``` aws dms delete-replication-instance \ --replication-instance-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Working with an AWS DMS Replication Instance](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteReplicationInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/delete-replication-instance.html)」を参照してください。 ### `delete-replication-subnet-group` 次のコード例は、`delete-replication-subnet-group` を使用する方法を示しています。 **AWS CLI** **サブネットグループを削除するには** 次の `delete-replication-subnet-group` の例では、サブネットグループを削除しています。 ``` aws dms delete-replication-subnet-group \ --replication-subnet-group-identifier my-subnet-group ``` 出力: ``` (none) ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Setting Up a Network for a Replication Instance](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.VPC.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteReplicationSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/delete-replication-subnet-group.html)」を参照してください。 ### `delete-replication-task` 次のコード例は、`delete-replication-task` を使用する方法を示しています。 **AWS CLI** **レプリケーションタスクを削除するには** 次の `delete-replication-task` の例では、レプリケーションタスクを削除しています。 ``` aws dms delete-replication-task \ --replication-task-arn arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Working with AWS DMS Tasks](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteReplicationTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/delete-replication-task.html)」を参照してください。 ### `describe-account-attributes` 次のコード例は、`describe-account-attributes` を使用する方法を示しています。 **AWS CLI** **アカウントの属性を記述するには** 次の `describe-account-attributes` の例では、AWS アカウントの属性を一覧表示しています。 ``` aws dms describe-account-attributes ``` 出力: ``` { "AccountQuotas": [ { "AccountQuotaName": "ReplicationInstances", "Used": 1, "Max": 20 }, { "AccountQuotaName": "AllocatedStorage", "Used": 5, "Max": 10000 }, ...remaining output omitted... ], "UniqueAccountIdentifier": "cqahfbfy5xee" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAccountAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-account-attributes.html)」を参照してください。 ### `describe-certificates` 次のコード例は、`describe-certificates` を使用する方法を示しています。 **AWS CLI** **使用可能な証明書を一覧表示するには** 次の `describe-certificates` の例では、AWS アカウントで使用可能な証明書を一覧表示しています。 ``` aws dms describe-certificates ``` 出力: ``` { "Certificates": [ { "CertificateIdentifier": "my-cert", "CertificateCreationDate": 1543259542.506, "CertificatePem": "-----BEGIN CERTIFICATE-----\nMIID9DCCAtygAwIBAgIBQjANBgkqhkiG9w0BAQ ...U" ... remaining output omittted ... } ] } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Using SSL](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#CHAP_Security.SSL)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-certificates.html)」を参照してください。 ### `describe-connections` 次のコード例は、`describe-connections` を使用する方法を示しています。 **AWS CLI** **接続を記述するには** 次の `describe-connections` の例では、レプリケーションインスタンスとエンドポイント間でテストした接続を一覧表示しています。 ``` aws dms describe-connections ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Creating Source and Target Endpoints](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.Creating.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-connections.html)」を参照してください。 ### `describe-endpoint-types` 次のコード例は、`describe-endpoint-types` を使用する方法を示しています。 **AWS CLI** **使用可能なエンドポイントタイプを一覧表示するには** 次の `describe-endpoint-types` の例では、使用可能な MySQL エンドポイントタイプを一覧表示しています。 ``` aws dms describe-endpoint-types \ --filters "Name=engine-name,Values=mysql" ``` 出力: ``` { "SupportedEndpointTypes": [ { "EngineName": "mysql", "SupportsCDC": true, "EndpointType": "source", "EngineDisplayName": "MySQL" }, { "EngineName": "mysql", "SupportsCDC": true, "EndpointType": "target", "EngineDisplayName": "MySQL" } ] } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「Working with AWS DMS Endpoints `\$1\$1」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEndpointTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-endpoint-types.html)」を参照してください。 ### `describe-endpoints` 次のコード例は、`describe-endpoints` を使用する方法を示しています。 **AWS CLI** **エンドポイントを記述するには** 次の `describe-endpoints` の例では、AWS アカウント内のエンドポイントを一覧表示しています。 ``` aws dms describe-endpoints ``` 出力: ``` { "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 } ] } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Working with AWS DMS Endpoints](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-endpoints.html)」を参照してください。 ### `describe-event-categories` 次のコード例は、`describe-event-categories` を使用する方法を示しています。 **AWS CLI** **イベントカテゴリを記述するには** 次の `describe-event-categories` の例では、使用可能なイベントカテゴリを一覧表示しています。 ``` aws dms describe-event-categories ``` 出力: ``` { "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" ] } ] } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Working with Events and Notifications](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEventCategories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-event-categories.html)」を参照してください。 ### `describe-event-subscriptions` 次のコード例は、`describe-event-subscriptions` を使用する方法を示しています。 **AWS CLI** **イベントサブスクリプションを記述するには** 次の `describe-event-subscriptions` の例では、Amazon SNS トピックへのイベントサブスクリプションを一覧表示しています。 ``` aws dms describe-event-subscriptions ``` 出力: ``` { "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 } ] } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Working with Events and Notifications](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEventSubscriptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-event-subscriptions.html)」を参照してください。 ### `describe-events` 次のコード例は、`describe-events` を使用する方法を示しています。 **AWS CLI** **DMS イベントを一覧表示するには** 次の `describe-events` の例では、レプリケーションインスタンスから発生したイベントを一覧表示しています。 ``` aws dms describe-events \ --source-type "replication-instance" ``` 出力: ``` { "Events": [ { "SourceIdentifier": "my-repl-instance", "SourceType": "replication-instance", "Message": "Replication application shutdown", "EventCategories": [], "Date": 1590771645.776 } ] } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Working with Events and Notifications](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-events.html)」を参照してください。 ### `describe-orderable-replication-instances` 次のコード例は、`describe-orderable-replication-instances` を使用する方法を示しています。 **AWS CLI** **指示設定が可能なレプリケーションインスタンスを記述するには** 次の `describe-orderable-replication-instances` の例では、指示設定が可能なレプリケーションインスタンスタイプを一覧表示しています。 ``` aws dms describe-orderable-replication-instances ``` 出力: ``` { "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... } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Working with an AWS DMS Replication Instance](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeOrderableReplicationInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-orderable-replication-instances.html)」を参照してください。 ### `describe-refresh-schemas-status` 次のコード例は、`describe-refresh-schemas-status` を使用する方法を示しています。 **AWS CLI** **エンドポイントの更新ステータスを一覧表示するには** 次の `describe-refresh-schemas-status` の例では、以前の更新リクエストのステータスを返しています。 ``` aws dms describe-refresh-schemas-status \ --endpoint-arn arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeRefreshSchemasStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-refresh-schemas-status.html)」を参照してください。 ### `describe-replication-instances` 次のコード例は、`describe-replication-instances` を使用する方法を示しています。 **AWS CLI** **レプリケーションインスタンスを記述するには** 次の `describe-replication-instances` の例では、AWS アカウントのレプリケーションインスタンスを一覧表示しています。 ``` aws dms describe-replication-instances ``` 出力: ``` { "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 } ] } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Working with an AWS DMS Replication Instance](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeReplicationInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-replication-instances.html)」を参照してください。 ### `describe-replication-subnet-groups` 次のコード例は、`describe-replication-subnet-groups` を使用する方法を示しています。 **AWS CLI** **使用可能なサブネットグループを表示するには** 次の `describe-replication-subnet-groups` の例では、使用可能なサブネットグループを一覧表示しています。 ``` aws dms describe-replication-subnet-groups \ --filter "Name=replication-subnet-group-id,Values=my-subnet-group" ``` 出力: ``` { "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" } ] } ] } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Setting Up a Network for a Replication Instance](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.VPC.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeReplicationSubnetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-replication-subnet-groups.html)」を参照してください。 ### `describe-replication-task-assessment-results` 次のコード例は、`describe-replication-task-assessment-results` を使用する方法を示しています。 **AWS CLI** **レプリケーションタスク評価の結果を一覧表示するには** 次の `describe-replication-task-assessment-results` の例では、以前のタスク評価の結果を一覧表示しています。 ``` aws dms describe-replication-task-assessment-results ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Creating a Task Assessment Report](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.AssessmentReport.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeReplicationTaskAssessmentResults](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-replication-task-assessment-results.html)」を参照してください。 ### `describe-replication-tasks` 次のコード例は、`describe-replication-tasks` を使用する方法を示しています。 **AWS CLI** **レプリケーションタスクを記述するには** 次の `describe-replication-tasks` の例では、現在のレプリケーションタスクについて表示しています。 ``` aws dms describe-replication-tasks ``` 出力: ``` { "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 } } ] } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Working with AWS DMS Tasks](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeReplicationTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-replication-tasks.html)」を参照してください。 ### `describe-schemas` 次の例は、`describe-schemas` を使用する方法を説明しています。 **AWS CLI** **データベーススキーマについて表示するには** 次の `describe-schemas` の例では、エンドポイントで使用可能なテーブルを一覧表示しています。 ``` aws dms describe-schemas \ --endpoint-arn "arn:aws:dms:us-east-1:123456789012:endpoint:6GGI6YPWWGAYUVLKIB732KEVWA" ``` 出力: ``` { "Schemas": [ "prodrep" ] } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[This is the topic title](https://link.to.the/topic/page)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeSchemas](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/describe-schemas.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **リソースのタグを一覧表示するには** 次の `list-tags-for-resource` の例では、レプリケーションインスタンスのタグを一覧表示しています。 ``` aws dms list-tags-for-resource \ --resource-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE ``` 出力: ``` { "TagList": [ { "Key": "Project", "Value": "dbMigration" }, { "Key": "Environment", "Value": "PROD" } ] } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Tagging Resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tagging.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/list-tags-for-resource.html)」を参照してください。 ### `modify-endpoint` 次のコード例は、`modify-endpoint` を使用する方法を示しています。 **AWS CLI** **エンドポイントを変更するには** 次の `modify-endpoint` の例では、エンドポイントに追加の接続属性を設定しています。 ``` aws dms modify-endpoint \ --endpoint-arn "arn:aws:dms:us-east-1:123456789012:endpoint:GUVAFG34EECUOJ6QVZ56DAHT3U" \ --extra-connection-attributes "compressionType=GZIP" ``` 出力: ``` { "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 } } } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「Working with AWS DMS Endpoints `\$1\$1」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/modify-endpoint.html)」を参照してください。 ### `modify-event-subscription` 次のコード例は、`modify-event-subscription` を使用する方法を示しています。 **AWS CLI** **イベントサブスクリプションを変更するには** 次の `modify-event-subscription` の例では、イベントサブスクリプションのソースタイプを変更しています。 ``` aws dms modify-event-subscription \ --subscription-name "my-dms-events" \ --source-type replication-task ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Working with Events and Notifications](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyEventSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/modify-event-subscription.html)」を参照してください。 ### `modify-replication-instance` 次のコード例は、`modify-replication-instance` を使用する方法を示しています。 **AWS CLI** **レプリケーションインスタンスを変更するには** 次の `modify-replication-instance` の例では、マルチ AZ 配置を使用するようにレプリケーションインスタンスを変更しています。 ``` aws dms modify-replication-instance \ --replication-instance-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE \ --multi-az ``` 出力: ``` { "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... } } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Working with an AWS DMS Replication Instance](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyReplicationInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/modify-replication-instance.html)」を参照してください。 ### `modify-replication-subnet-group` 次のコード例は、`modify-replication-subnet-group` を使用する方法を示しています。 **AWS CLI** **サブネットグループを変更するには** 次の `modify-replication-subnet-group` の例では、サブネットグループに関連付けられているサブネットのリストを変更しています。 ``` aws dms modify-replication-subnet-group \ --replication-subnet-group-identifier my-subnet-group \ --subnet-id subnet-da327bf6 subnet-bac383e0 ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Setting Up a Network for a Replication Instance](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.VPC.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyReplicationSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/modify-replication-subnet-group.html)」を参照してください。 ### `modify-replication-task` 次のコード例は、`modify-replication-task` を使用する方法を示しています。 **AWS CLI** **レプリケーションタスクを変更するには** 次の `modify-replication-task` の例では、タスクのテーブルマッピングを変更します。 ``` aws dms modify-replication-task \ --replication-task-arn "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII" \ --table-mappings file://table-mappings.json ``` `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": [] } ] } ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Working with AWS DMS Tasks](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyReplicationTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/modify-replication-task.html)」を参照してください。 ### `reboot-replication-instance` 次のコード例は、`reboot-replication-instance` を使用する方法を示しています。 **AWS CLI** **レプリケーションインスタンスを再起動するには** 次の `reboot-replication-instance` の例では、レプリケーション インスタンスを再起動します。 ``` aws dms reboot-replication-instance \ --replication-instance-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE ``` 出力: ``` { "ReplicationInstance": { "ReplicationInstanceIdentifier": "my-repl-instance", "ReplicationInstanceClass": "dms.t2.micro", "ReplicationInstanceStatus": "rebooting", "AllocatedStorage": 5, "InstanceCreateTime": 1590011235.952, ... output omitted ... } } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Working with an AWS DMS Replication Instance](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RebootReplicationInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/reboot-replication-instance.html)」を参照してください。 ### `refresh-schemas` 次のコード例は、`refresh-schemas` を使用する方法を示しています。 **AWS CLI** **データベーススキーマを更新するには** 次の `refresh-schemas` の例では、AWS DMS がエンドポイントのスキーマのリストを更新するようにリクエストしています。 ``` 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" ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RefreshSchemas](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/refresh-schemas.html)」を参照してください。 ### `reload-tables` 次のコード例は、`reload-tables` を使用する方法を示しています。 **AWS CLI** **エンドポイントで使用可能なテーブルのリストを更新するには** 次の `reload-tables` の例では、エンドポイントで使用可能なテーブルのリストを再ロードしています。 ``` aws dms reload-tables \ --replication-task-arn "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII" \ --tables-to-reload "SchemaName=prodrep,TableName=ACCT_BAL" ``` 出力: ``` { "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ReloadTables](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/reload-tables.html)」を参照してください。 ### `remove-tags-from-resource` 次のコード例は、`remove-tags-from-resource` を使用する方法を示しています。 **AWS CLI** **レプリケーションインスタンスからタグを削除するには** 次の `remove-tags-from-resource` の例では、レプリケーションインスタンスからタグを削除しています。 ``` aws dms remove-tags-from-resource \ --resource-arn arn:aws:dms:us-east-1:123456789012:rep:T3OM7OUB5NM2LCVZF7JPGJRNUE \ --tag-keys Environment Project ``` このコマンドでは何も出力されません。 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Tagging Resources](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveTagsFromResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/remove-tags-from-resource.html)」を参照してください。 ### `start-replication-task-assessment` 次のコード例は、`start-replication-task-assessment` を使用する方法を示しています。 **AWS CLI** **タスク評価を開始するには** 次の `start-replication-task-assessment` の例では、レプリケーションタスクの評価を開始しています。 ``` aws dms start-replication-task-assessment \ --replication-task-arn arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Creating a Task Assessment Report](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.AssessmentReport.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartReplicationTaskAssessment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/start-replication-task-assessment.html)」を参照してください。 ### `start-replication-task` 次のコード例は、`start-replication-task` を使用する方法を示しています。 **AWS CLI** **レプリケーションタスクを開始するには** 次の `command-name` の例では、AWS アカウントで使用可能なウィジェットを一覧表示しています。 ``` aws dms start-replication-task \ --replication-task-arn arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII \ --start-replication-task-type reload-target ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Working with AWS DMS Tasks](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartReplicationTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/start-replication-task.html)」を参照してください。 ### `stop-replication-task` 次のコード例は、`stop-replication-task` を使用する方法を示しています。 **AWS CLI** **タスクを停止するには** 次の `stop-replication-task` の例ではタスクを停止しています。 ``` aws dms stop-replication-task \ --replication-task-arn arn:aws:dms:us-east-1:123456789012:task:K55IUCGBASJS5VHZJIINA45FII ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Working with AWS DMS Tasks](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopReplicationTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/stop-replication-task.html)」を参照してください。 ### `test-connection` 次のコード例は、`test-connection` を使用する方法を示しています。 **AWS CLI** **エンドポイントへの接続をテストするには** 次の `test-connection` の例では、レプリケーションインスタンスからエンドポイントにアクセスできるかどうかをテストしています。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Database Migration Service ユーザーガイド*」の「[Creating source and target endpoints](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Endpoints.Creating.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TestConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dms/test-connection.html)」を参照してください。 # AWS CLI を使用した Amazon DocumentDB の例 次のコード例は、Amazon DocumentDB で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `add-tags-to-resource` 次のコード例は、`add-tags-to-resource` を使用する方法を示しています。 **AWS CLI** **指定されたリソースに 1 つまたは複数のタグを追加するには** 次の `add-tags-to-resource` の例では、`sample-cluster` に 3 つのタグを追加します。1 つのタグ (`CropB`) にはキー名がありますが、値はありません。 ``` 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" ``` このコマンドでは何も出力されません。 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Tagging Amazon DocumentDB Resources](https://docs.aws.amazon.com/documentdb/latest/developerguide/tagging.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[AddTagsToResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/add-tags-to-resource.html)」を参照してください。 ### `apply-pending-maintenance-action` 次のコード例は、`apply-pending-maintenance-action` を使用する方法を示しています。 **AWS CLI** **次のメンテナンス期間に保留中のメンテナンスアクションを実行するには** 次の `apply-pending-maintenance-action` の例では、次のスケジュールされたメンテナンス期間中にすべてのシステム更新アクションが実行されます。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Applying Amazon DocumentDB Updates](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-maintain.html#db-instance-updates-apply)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ApplyPendingMaintenanceAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/apply-pending-maintenance-action.html)」を参照してください。 ### `copy-db-cluster-parameter-group` 次のコード例は、`copy-db-cluster-parameter-group` を使用する方法を示しています。 **AWS CLI** **既存の DB クラスターパラメータグループを複製するには** 次の `copy-db-cluster-parameter-group` の例では、パラメータグループ `custom-docdb3-6` のコピーを `custom-docdb3-6-copy` という名前で作成します。コピーを作成すると、新しいパラメータグループにタグが追加されます。 ``` 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" ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Copying an Amazon DocumentDB Cluster Parameter Group](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-copy.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CopyDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/copy-db-cluster-parameter-group.html)」を参照してください。 ### `copy-db-cluster-snapshot` 次のコード例は、`copy-db-cluster-snapshot` を使用する方法を示しています。 **AWS CLI** **スナップショットのコピーを作成するには** 次の `copy-db-cluster-snapshot` の例では、`sample-cluster-snapshot` という名前の `sample-cluster-snapshot-copy` のコピーを作成します。コピーには、元のすべてのタグに加えて、キー名 `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" ``` このコマンドでは何も出力されません。 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Copying a Cluster Snapshot](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.db-cluster-snapshot-copy.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CopyDbClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/copy-db-cluster-snapshot.html)」を参照してください。 ### `create-db-cluster-parameter-group` 次のコード例は、`create-db-cluster-parameter-group` を使用する方法を示しています。 **AWS CLI** **Amazon DocumentDB クラスターパラメータグループを作成するには** 次の `create-db-cluster-parameter-group` の例では、`docdb3.6` ファミリーを使用して DB クラスターパラメータグループ `sample-parameter-group` を作成します。 ``` 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" ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Creating an Amazon DocumentDB Cluster Parameter Group](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-cluster-parameter-group.html)」を参照してください。 ### `create-db-cluster-snapshot` 次のコード例は、`create-db-cluster-snapshot` を使用する方法を示しています。 **AWS CLI** **Amazon DocumentDB の手動クラスタースナップショットを作成するには** 次の `create-db-cluster-snapshot` の例では、sample-cluster-snapshot という名前の Amazon DB クラスタースナップショットを作成します。 ``` aws docdb create-db-cluster-snapshot \ --db-cluster-identifier sample-cluster \ --db-cluster-snapshot-identifier sample-cluster-snapshot ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Creating a Manual Cluster Snapshot](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.db-cluster-snapshot-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDbClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-cluster-snapshot.html)」を参照してください。 ### `create-db-cluster` 次のコード例は、`create-db-cluster` を使用する方法を示しています。 **AWS CLI** **Amazon DocumentDB クラスターを作成するには** 次の `create-db-cluster` の例では、日曜日の 20:30 から 11:00 までの優先メンテナンス期間で、`sample-cluster` という名前の Amazon DocumentDB クラスターを作成しています。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Creating an Amazon DocumentDB Cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-cluster.html)」を参照してください。 ### `create-db-instance` 次のコード例は、`create-db-instance` を使用する方法を示しています。 **AWS CLI** **Amazon DocumentDB クラスターインスタンスを作成するには** 次の `create-db-instance` のサンプルコードは、Amazon DocumentDB クラスター `sample-cluster` にインスタンス `sample-cluster-instance-2` を作成します。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Adding an Amazon DocumentDB Instance to a Cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-add.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-instance.html)」を参照してください。 ### `create-db-subnet-group` 次のコード例は、`create-db-subnet-group` を使用する方法を示しています。 **AWS CLI** **Amazon DocumentDB サブネットグループを作成するには** 次の `create-db-subnet-group` の例では、`sample-subnet-group` という名前の Amazon DocumentDB サブネットグループを作成します。 ``` 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" ``` 出力: ``` { "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" } } ] } } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Creating an Amazon DocumentDB Subnet Group](https://docs.aws.amazon.com/documentdb/latest/developerguide/document-db-subnet-groups.html#document-db-subnet-group-create)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDbSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/create-db-subnet-group.html)」を参照してください。 ### `delete-db-cluster-parameter-group` 次のコード例は、`delete-db-cluster-parameter-group` を使用する方法を示しています。 **AWS CLI** **Amazon DocumentDB クラスターパラメータグループを削除するには** 次の `delete-db-cluster-parameter-group` の例では、Amazon DocumentDB パラメータグループ `sample-parameter-group` を削除しています。 ``` aws docdb delete-db-cluster-parameter-group \ --db-cluster-parameter-group-name sample-parameter-group ``` このコマンドでは何も出力されません。 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Deleting an Amazon DocumentDB Cluster Parameter Group](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-cluster-parameter-group.html)」を参照してください。 ### `delete-db-cluster-snapshot` 次のコード例は、`delete-db-cluster-snapshot` を使用する方法を示しています。 **AWS CLI** **Amazon DocumentDB クラスタースナップショットを削除するには** 次の `delete-db-cluster-snapshot` の例では、Amazon DocumentDB クラスタースナップショット `sample-cluster-snapshot` を削除します。 ``` aws docdb delete-db-cluster-snapshot \ --db-cluster-snapshot-identifier sample-cluster-snapshot ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Deleting a Cluster Snapshot](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.db-cluster-snapshot-delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDbClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-cluster-snapshot.html)」を参照してください。 ### `delete-db-cluster` 次のコード例は、`delete-db-cluster` を使用する方法を示しています。 **AWS CLI** **Amazon DocumentDB クラスターを削除するには** 次の `delete-db-cluster` の例では、Amazon DocumentDB クラスター `sample-cluster` を削除します。削除する前にクラスターのバックアップは行われません。注: クラスターを削除する前に、クラスターに関連付けられているすべてのインスタンスを削除する必要があります。 ``` aws docdb delete-db-cluster \ --db-cluster-identifier sample-cluster \ --skip-final-snapshot ``` 出力: ``` { "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": [] } } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Deleting an Amazon DocumentDB Cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-cluster.html)」を参照してください。 ### `delete-db-instance` 次のコード例は、`delete-db-instance` を使用する方法を示しています。 **AWS CLI** **Amazon DocumentDB インスタンスを削除するには** 次の `delete-db-instance` の例では、Amazon DocumentDB インスタンス `sample-cluster-instance-2` を削除しています。 ``` aws docdb delete-db-instance \ --db-instance-identifier sample-cluster-instance-2 ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Deleting an Amazon DocumentDB Instance](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-instance.html)」を参照してください。 ### `delete-db-subnet-group` 次のコード例は、`delete-db-subnet-group` を使用する方法を示しています。 **AWS CLI** **Amazon DocumentDB サブネットグループを削除するには** 次の `delete-db-subnet-group` の例では、Amazon DocumentDB サブネットグループ `sample-subnet-group` を削除します。 ``` aws docdb delete-db-subnet-group \ --db-subnet-group-name sample-subnet-group ``` このコマンドでは何も出力されません。 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Deleting an Amazon DocumentDB Subnet Group](https://docs.aws.amazon.com/documentdb/latest/developerguide/document-db-subnet-groups.html#document-db-subnet-group-delete)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDbSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/delete-db-subnet-group.html)」を参照してください。 ### `describe-db-cluster-parameter-groups` 次のコード例は、`describe-db-cluster-parameter-groups` を使用する方法を示しています。 **AWS CLI** **1 つまたは複数の Amazon DocumentDB クラスターパラメータグループの詳細を表示するには** 次の `describe-db-cluster-parameter-groups` の例では、Amazon DocumentDB クラスターパラメータグループ `custom3-6-param-grp` の詳細を表示します。 ``` aws docdb describe-db-cluster-parameter-groups \ --db-cluster-parameter-group-name custom3-6-param-grp ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Viewing Amazon DocumentDB Cluster Parameter Groups](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-describe.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDbClusterParameterGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-cluster-parameter-groups.html)」を参照してください。 ### `describe-db-cluster-parameters` 次のコード例は、`describe-db-cluster-parameters` を使用する方法を示しています。 **AWS CLI** **Amazon DocumentDB クラスターパラメータグループの詳細なパラメータリストを表示するには。** 次の `describe-db-cluster-parameters` の例では、Amazon DocumentDB パラメータグループ custom3-6-param-grp のパラメータを一覧表示します。 ``` aws docdb describe-db-cluster-parameters \ --db-cluster-parameter-group-name custom3-6-param-grp ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Viewing Amazon DocumentDB Cluster Parameters](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameters-describe.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDbClusterParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-cluster-parameters.html)」を参照してください。 ### `describe-db-cluster-snapshot-attributes` 次のコード例は、`describe-db-cluster-snapshot-attributes` を使用する方法を示しています。 **AWS CLI** **Amazon DocumentDB スナップショットの属性名と値を一覧表示するには** 次の `describe-db-cluster-snapshot-attributes` の例では、Amazon DocumentDB スナップショット `sample-cluster-snapshot` の属性名と値を一覧表示します。 ``` aws docdb describe-db-cluster-snapshot-attributes \ --db-cluster-snapshot-identifier sample-cluster-snapshot ``` 出力: ``` { "DBClusterSnapshotAttributesResult": { "DBClusterSnapshotAttributes": [ { "AttributeName": "restore", "AttributeValues": [] } ], "DBClusterSnapshotIdentifier": "sample-cluster-snapshot" } } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[DescribeDBClusterSnapshotAttributes](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBClusterSnapshotAttributes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDbClusterSnapshotAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-cluster-snapshot-attributes.html)」を参照してください。 ### `describe-db-cluster-snapshots` 次のコード例は、`describe-db-cluster-snapshots` を使用する方法を示しています。 **AWS CLI** **Amazon DocumentDB スナップショットを記述するには** 次の `describe-db-cluster-snapshots` の例では、Amazon DocumentDB スナップショット `sample-cluster-snapshot` の詳細を表示します。 ``` aws docdb describe-db-cluster-snapshots \ --db-cluster-snapshot-identifier sample-cluster-snapshot ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[DescribeDBClusterSnapshots](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBClusterSnapshots.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDbClusterSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-cluster-snapshots.html)」を参照してください。 ### `describe-db-clusters` 次のコード例は、`describe-db-clusters` を使用する方法を示しています。 **AWS CLI** **1 つ以上の Amazon DocumentDB クラスターに関する詳細情報を取得するには。** 次の `describe-db-clusters` の例では、Amazon DocumentDB クラスター `sample-cluster` の詳細を表示します。`--db-cluster-identifier` パラメータを省略すると、最大 100 個のクラスターの情報を取得できます。 ``` aws docdb describe-db-clusters --db-cluster-identifier sample-cluster ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Describing Amazon DocumentDB Clusters](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-view-details.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDbClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-clusters.html)」を参照してください。 ### `describe-db-engine-versions` 次のコード例は、`describe-db-engine-versions` を使用する方法を示しています。 **AWS CLI** **使用可能な Amazon DocumentDB エンジンのバージョンを一覧表示するには** 次の `describe-db-engine-versions` の例では、使用可能な Amazon DocumentDB エンジンのバージョンをすべて一覧表示します。 ``` aws docdb describe-db-engine-versions \ --engine docdb ``` 出力: ``` { "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" ] } ] } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[DescribeDBEngineVersions](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeDBEngineVersions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDbEngineVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-engine-versions.html)」を参照してください。 ### `describe-db-instances` 次のコード例は、`describe-db-instances` を使用する方法を示しています。 **AWS CLI** **プロビジョニングされた Amazon DocumentDB インスタンスに関する情報を見つけるには** 次の `describe-db-instances` の例では、Amazon DocumentDB インスタンス `sample-cluster-instance` の詳細を表示します。`--db-instance-identifier` パラメータを省略すると、最大 100 個のインスタンスの情報を取得できます。 ``` aws docdb describe-db-instances \ --db-instance-identifier sample-cluster-instance ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Describing Amazon DocumentDB Instances](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-view-details.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDbInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-instances.html)」を参照してください。 ### `describe-db-subnet-groups` 次のコード例は、`describe-db-subnet-groups` を使用する方法を示しています。 **AWS CLI** **Amazon DocumentDB サブネットの説明のリストを取得するには** 次の `describe-db-subnet-groups` の例では、`default` という名前の Amazon DocumentDB サブネットの詳細を記述します。 ``` aws docdb describe-db-subnet-groups \ --db-subnet-group-name default ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Describing Subnet Groups](https://docs.aws.amazon.com/documentdb/latest/developerguide/document-db-subnet-groups.html#document-db-subnet-groups-describe)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDbSubnetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-db-subnet-groups.html)」を参照してください。 ### `describe-engine-default-cluster-parameters` 次のコード例は、`describe-engine-default-cluster-parameters` を使用する方法を示しています。 **AWS CLI** **Amazon DocumentDB のデフォルトのエンジンおよびシステムパラメータ情報を記述するには** 次の `describe-engine-default-cluster-parameters` の例では、Amazon DocumentDB パラメータグループ `docdb3.6` のデフォルトのエンジンの詳細およびシステムパラメータ情報を表示します。 ``` aws docdb describe-engine-default-cluster-parameters \ --db-parameter-group-family docdb3.6 ``` 出力: ``` { "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 } ] } } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[DescribeEngineDefaultClusterParameters](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DescribeEngineDefaultClusterParameters.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEngineDefaultClusterParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-engine-default-cluster-parameters.html)」を参照してください。 ### `describe-event-categories` 次のコード例は、`describe-event-categories` を使用する方法を示しています。 **AWS CLI** **Amazon DocumentDB イベントカテゴリをすべて記述するには** 次の `describe-event-categories` の例では、Amazon DocumentDB イベントソースタイプ `db-instance` のすべてのカテゴリを一覧表示します。 ``` aws docdb describe-event-categories \ --source-type db-cluster ``` 出力: ``` { "EventCategoriesMapList": [ { "SourceType": "db-cluster", "EventCategories": [ "failover", "maintenance", "notification", "failure" ] } ] } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Viewing Event Categories](https://docs.aws.amazon.com/documentdb/latest/developerguide/managing-events.html#viewing-event-categories)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEventCategories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-event-categories.html)」を参照してください。 ### `describe-events` 次のコード例は、`describe-events` を使用する方法を示しています。 **AWS CLI** **Amazon DocumentDB イベントを一覧表示するには** 次の `describe-events` の例では、過去 24 時間 (1,440 分) のすべての Amazon DocumentDB イベントを一覧表示します。 ``` aws docdb describe-events \ --duration 1440 ``` このコマンドでは何も出力されません。出力: ``` { "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" } ] } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Viewing Amazon DocumentDB Events](https://docs.aws.amazon.com/documentdb/latest/developerguide/managing-events.html#viewing-events)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-events.html)」を参照してください。 ### `describe-orderable-db-instance-options` 次のコード例は、`describe-orderable-db-instance-options` を使用する方法を示しています。 **AWS CLI** **注文できる Amazon DocumentDB インスタンスオプションを見つけるには** 次の `describe-orderable-db-instance-options` の例では、リージョンの Amazon DocumentDB 用インスタンスオプションをすべて一覧表示します。 ``` aws docdb describe-orderable-db-instance-options \ --engine docdb \ --region us-east-1 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Adding an Amazon DocumentDB Instance to a Cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-add.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeOrderableDbInstanceOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-orderable-db-instance-options.html)」を参照してください。 ### `describe-pending-maintenance-actions` 次のコード例は、`describe-pending-maintenance-actions` を使用する方法を示しています。 **AWS CLI** **保留中の Amazon DocumentDB メンテナンスアクションを一覧表示するには** 次の `describe-pending-maintenance-actions` の例では、保留中の Amazon DocumentDB メンテナンスアクションをすべて一覧表示します。 ``` aws docdb describe-pending-maintenance-actions ``` 出力: ``` { "PendingMaintenanceActions": [] } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Maintaining Amazon DocumentDB](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-maintain.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribePendingMaintenanceActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/describe-pending-maintenance-actions.html)」を参照してください。 ### `failover-db-cluster` 次のコード例は、`failover-db-cluster` を使用する方法を示しています。 **AWS CLI** **Amazon DocumentDB クラスターを強制的にレプリカにフェイルオーバーするには** 次の `failover-db-cluster` の例では、Amazon DocumentDB クラスターのサンプルクラスターのプライマリインスタンスをレプリカにフェイルオーバーします。 ``` aws docdb failover-db-cluster \ --db-cluster-identifier sample-cluster ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Amazon DocumentDB Failover](https://docs.aws.amazon.com/documentdb/latest/developerguide/failover.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[FailoverDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/failover-db-cluster.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **Amazon DocumentDB リソースのすべてのタグを一覧表示するには** 次の `list-tags-for-resource` の例では、Amazon DocumentDB クラスター `sample-cluster` のすべてのタグを一覧表示します。 ``` aws docdb list-tags-for-resource \ --resource-name arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster ``` 出力: ``` { "TagList": [ { "Key": "A", "Value": "ALPHA" }, { "Key": "B", "Value": "" }, { "Key": "C", "Value": "CHARLIE" } ] } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Listing Tags on an Amazon DocumentDB Resource](https://docs.aws.amazon.com/documentdb/latest/developerguide/tagging.html#tagging-list)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/list-tags-for-resource.html)」を参照してください。 ### `modify-db-cluster-parameter-group` 次のコード例は、`modify-db-cluster-parameter-group` を使用する方法を示しています。 **AWS CLI** **Amazon DocumentDB クラスターパラメータグループを変更するには** 次の `modify-db-cluster-parameter-group` の例では、2 つのパラメータ `audit_logs` と `ttl_monitor` を有効に設定して、Amazon DocumentDB クラスターパラメータグループ `custom3-6-param-grp` を変更します。変更は次回の再起動時に適用されます。 ``` 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 ``` 出力: ``` { "DBClusterParameterGroupName": "custom3-6-param-grp" } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Modifying an Amazon DocumentDB Cluster Parameter Group](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-modify.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-cluster-parameter-group.html)」を参照してください。 ### `modify-db-cluster-snapshot-attribute` 次のコード例は、`modify-db-cluster-snapshot-attribute` を使用する方法を示しています。 **AWS CLI** **例 1: Amazon DocumentDB スナップショットに属性を追加するには** 次の `modify-db-cluster-snapshot-attribute` の例では、Amazon DocumentDB クラスタースナップショットに 4 つの属性値を追加します。 ``` aws docdb modify-db-cluster-snapshot-attribute \ --db-cluster-snapshot-identifier sample-cluster-snapshot \ --attribute-name restore \ --values-to-add 123456789011 123456789012 123456789013 ``` 出力: ``` { "DBClusterSnapshotAttributesResult": { "DBClusterSnapshotAttributes": [ { "AttributeName": "restore", "AttributeValues": [ "123456789011", "123456789012", "123456789013" ] } ], "DBClusterSnapshotIdentifier": "sample-cluster-snapshot" } } ``` **例 2: Amazon DocumentDB スナップショットから属性を削除するには** 次の `modify-db-cluster-snapshot-attribute` の例では、Amazon DocumentDB クラスタースナップショットから 2 つの属性値を削除します。 ``` aws docdb modify-db-cluster-snapshot-attribute \ --db-cluster-snapshot-identifier sample-cluster-snapshot \ --attribute-name restore \ --values-to-remove 123456789012 ``` 出力: ``` { "DBClusterSnapshotAttributesResult": { "DBClusterSnapshotAttributes": [ { "AttributeName": "restore", "AttributeValues": [ "123456789011", "123456789013" ] } ], "DBClusterSnapshotIdentifier": "sample-cluster-snapshot" } } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[ModifyDBClusterSnapshotAttribute](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_ModifyDBClusterSnapshotAttribute.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyDbClusterSnapshotAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-cluster-snapshot-attribute.html)」を参照してください。 ### `modify-db-cluster` 次のコード例は、`modify-db-cluster` を使用する方法を示しています。 **AWS CLI** **Amazon DocumentDB クラスターを変更するには** 次の `modify-db-cluster` の例では、自動バックアップの保持期間を 7 日間に設定し、バックアップとメンテナンスの両方の優先期間を変更して、Amazon DocumentDB クラスター `sample-cluster` を変更します。変更はすべて、次のメンテナンス時に適用されます。 ``` 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 ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Modifying an Amazon DocumentDB Cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-modify.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-cluster.html)」を参照してください。 ### `modify-db-instance` 次のコード例は、`modify-db-instance` を使用する方法を示しています。 **AWS CLI** **Amazon DocumentDB インスタンスを変更するには** 次の `modify-db-instance` の例では、インスタンスクラスを `db.r4.4xlarge` に変更し、昇格階層を `5` に変更して、Amazon DocumentDB インスタンス `sample-cluster2` を変更します。変更はすぐに適用されますが、インスタンスステータスが使用可能になった後にのみ表示されます。 ``` aws docdb modify-db-instance \ --db-instance-identifier sample-cluster2 \ --apply-immediately \ --db-instance-class db.r4.4xlarge \ --promotion-tier 5 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Modifying an Amazon DocumentDB Instance](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-modify.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-instance.html)」を参照してください。 ### `modify-db-subnet-group` 次のコード例は、`modify-db-subnet-group` を使用する方法を示しています。 **AWS CLI** **Amazon DocumentDB サブネットグループを変更するには** 次の `modify-db-subnet-group` の例では、指定したサブネットと新しい説明を追加して、サブネットグループ `sample-subnet-group` を変更します。 ``` 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" ``` 出力: ``` { "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" } } ] } } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Modifying an Amazon DocumentDB Subnet Group](https://docs.aws.amazon.com/documentdb/latest/developerguide/document-db-subnet-groups.html#document-db-subnet-group-modify)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyDbSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/modify-db-subnet-group.html)」を参照してください。 ### `reboot-db-instance` 次のコード例は、`reboot-db-instance` を使用する方法を示しています。 **AWS CLI** **Amazon DocumentDB インスタンスを再起動するには** 次の `reboot-db-instance` の例では、Amazon DocumentDB インスタンス `sample-cluster2` を再起動します。 ``` aws docdb reboot-db-instance \ --db-instance-identifier sample-cluster2 ``` このコマンドでは何も出力されません。出力: ``` { "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" } } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Rebooting an Amazon DocumentDB ILnstance](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-reboot.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RebootDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/reboot-db-instance.html)」を参照してください。 ### `remove-tags-from-resource` 次のコード例は、`remove-tags-from-resource` を使用する方法を示しています。 **AWS CLI** **Amazon DocumentDB リソースからタグを削除するには** 次の `remove-tags-from-resource` の例では、Amazon DocumentDB クラスター `sample-cluster` から `B` という名前のキーを持つタグを削除します。 ``` aws docdb remove-tags-from-resource \ --resource-name arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster \ --tag-keys B ``` このコマンドでは何も出力されません。 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Removing Tags from an Amazon DocumentDBResource](https://docs.aws.amazon.com/documentdb/latest/developerguide/tagging.html#tagging-remove)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveTagsFromResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/remove-tags-from-resource.html)」を参照してください。 ### `reset-db-cluster-parameter-group` 次のコード例は、`reset-db-cluster-parameter-group` を使用する方法を示しています。 **AWS CLI** **指定したパラメータ値を Amazon DocumentDB パラメータグループのデフォルトにリセットするには** 次の `reset-db-cluster-parameter-group` の例では、Amazon DocumentDB パラメータグループ `custom3-6-param-grp` のパラメータ `ttl_monitor` をデフォルト値にリセットします。 ``` aws docdb reset-db-cluster-parameter-group \ --db-cluster-parameter-group-name custom3-6-param-grp \ --parameters ParameterName=ttl_monitor,ApplyMethod=immediate ``` 出力: ``` { "DBClusterParameterGroupName": "custom3-6-param-grp" } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」を参照してください。 **指定したパラメータ値またはすべてのパラメータ値を Amazon DocumentDB パラメータグループのデフォルトにリセットするには** 次の `reset-db-cluster-parameter-group` の例では、Amazon DocumentDB パラメータグループ `custom3-6-param-grp` のすべてのパラメータをデフォルト値にリセットします。 ``` aws docdb reset-db-cluster-parameter-group \ --db-cluster-parameter-group-name custom3-6-param-grp \ --reset-all-parameters ``` 出力: ``` { "DBClusterParameterGroupName": "custom3-6-param-grp" } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Resetting an Amazon DocumentDB Cluster Parameter Group](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-parameter-group-reset.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ResetDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/reset-db-cluster-parameter-group.html)」を参照してください。 ### `restore-db-cluster-from-snapshot` 次のコード例は、`restore-db-cluster-from-snapshot` を使用する方法を示しています。 **AWS CLI** **自動または手動スナップショットから Amazon DocumentDB クラスターを復元するには** 次の `restore-db-cluster-from-snapshot` の例では、スナップショット `rds:sample-cluster-2019-03-16-00-01` から `sample-cluster-2019-03-16-00-01-restored` という名前の新しい Amazon DocumentDB クラスターを作成します。 ``` 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 ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Restoring from a Cluster Snapshot](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.restore-from-snapshot.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RestoreDbClusterFromSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/restore-db-cluster-from-snapshot.html)」を参照してください。 ### `restore-db-cluster-to-point-in-time` 次のコード例は、`restore-db-cluster-to-point-in-time` を使用する方法を示しています。 **AWS CLI** **手動スナップショットから Amazon DocumentDB クラスターを特定時点に復元するには** 次の `restore-db-cluster-to-point-in-time` の例では、`sample-cluster-snapshot` を使用し、復元可能な最後の時刻を使用して新しい Amazon DocumentDB クラスター `sample-cluster-pit` を作成します。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Restoring a Snapshot to a Point in Time](https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.point-in-time-recovery.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RestoreDbClusterToPointInTime](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/restore-db-cluster-to-point-in-time.html)」を参照してください。 ### `start-db-cluster` 次のコード例は、`start-db-cluster` を使用する方法を示しています。 **AWS CLI** **停止した Amazon DocumentDB クラスターを開始するには** 次の `start-db-cluster` の例では、指定した Amazon DocumentDB クラスターを起動します。 ``` aws docdb start-db-cluster \ --db-cluster-identifier sample-cluster ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Stopping and Starting an Amazon DocumentDB Cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/start-db-cluster.html)」を参照してください。 ### `stop-db-cluster` 次のコード例は、`stop-db-cluster` を使用する方法を示しています。 **AWS CLI** **Amazon DocumentDB クラスターの実行を停止するには** 次の `stop-db-cluster` の例では、指定した Amazon DocumentDB クラスターを停止します。 ``` aws docdb stop-db-cluster \ --db-cluster-identifier sample-cluster ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*Amazon DocumentDB デベロッパーガイド*」の「[Stopping and Starting an Amazon DocumentDB Cluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-stop-start.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/docdb/stop-db-cluster.html)」を参照してください。 # AWS CLI を使用する DynamoDB の例 次のコード例は、DynamoDB で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `batch-get-item` 次のコード例は、`batch-get-item` を使用する方法を示しています。 **AWS CLI** **テーブルから複数の項目を取得するには** 次の `batch-get-items` の例では、3 つの `GetItem` リクエストのバッチを使用して `MusicCollection` テーブルから複数の項目を読み込み、この操作で使用された読み込み容量ユニットの数を取得します。このコマンドは `AlbumTitle` 属性のみを返します。 ``` aws dynamodb batch-get-item \ --request-items file://request-items.json \ --return-consumed-capacity TOTAL ``` `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" } } ``` 出力: ``` { "Responses": { "MusicCollection": [ { "AlbumTitle": { "S": "Somewhat Famous" } }, { "AlbumTitle": { "S": "Blue Sky Blues" } }, { "AlbumTitle": { "S": "Louder Than Ever" } } ] }, "UnprocessedKeys": {}, "ConsumedCapacity": [ { "TableName": "MusicCollection", "CapacityUnits": 1.5 } ] } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[バッチオペレーション](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.BatchOperations)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchGetItem](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/batch-get-item.html)」を参照してください。 ### `batch-write-item` 次のコード例は、`batch-write-item` を使用する方法を示しています。 **AWS CLI** **テーブルに複数の項目を追加するには** 次の `batch-write-item` の例は、3 つの `PutItem` リクエストのバッチを使用して、`MusicCollection` テーブルに 3 つの新しい項目を追加します。また、このオペレーションによって消費される書き込み容量ユニットの数、およびオペレーションによって変更されるアイテムコレクションに関する情報も要求します。 ``` aws dynamodb batch-write-item \ --request-items file://request-items.json \ --return-consumed-capacity INDEXES \ --return-item-collection-metrics SIZE ``` `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"} } } } ] } ``` 出力: ``` { "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 } } } ] } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[バッチオペレーション](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.BatchOperations)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchWriteItem](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/batch-write-item.html)」を参照してください。 ### `create-backup` 次のコード例は、`create-backup` を使用する方法を示しています。 **AWS CLI** **既存の DynamoDB テーブルのバックアップを作成するには** 次の `create-backup` の例では、`MusicCollection` テーブルのバックアップを作成します。 ``` aws dynamodb create-backup \ --table-name MusicCollection \ --backup-name MusicCollectionBackup ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[On-Demand Backup and Restore for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/BackupRestore.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateBackup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/create-backup.html)」を参照してください。 ### `create-global-table` 次のコード例は、`create-global-table` を使用する方法を示しています。 **AWS CLI** **グローバルテーブルを作成するには** 次の `create-global-table` の例では、指定した別々の AWS リージョンにある 2 つの同一テーブルからグローバルテーブルを作成します。 ``` aws dynamodb create-global-table \ --global-table-name MusicCollection \ --replication-group RegionName=us-east-2 RegionName=us-east-1 \ --region us-east-2 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[DynamoDB Global Tables](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateGlobalTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/create-global-table.html)」を参照してください。 ### `create-table` 次のコード例は、`create-table` を使用する方法を示しています。 **AWS CLI** **例 1: タグ付きのテーブルを作成するには** 次の `create-table` の例では、指定された属性とキースキーマを使用して、`MusicCollection` という名前のテーブルを作成します。このテーブルはプロビジョニングされたスループットを使用し、保存時にはデフォルトの AWS 所有の CMK を使用して暗号化されます。またこのコマンドは、`Owner` キーと `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 ``` 出力: ``` { "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" } } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[DynamoDB テーブルの基本的なオペレーション](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html)」を参照してください。** **例 2: オンデマンドモードでテーブルを作成するには** 次の例は、プロビジョニングされたスループットモードではなく、オンデマンドモードを使用して `MusicCollection` というテーブルを作成します。これは、ワークロードが予測できないテーブルに役立ちます。 ``` 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 ``` 出力: ``` { "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" } } } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[DynamoDB テーブルの基本的なオペレーション](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html)」を参照してください。** **例 3: テーブルを作成してカスタマーマネージド CMK で暗号化するには** 次の例では、`MusicCollection` という名前のテーブルを作成し、カスタマーマネージド CMK を使用して暗号化します。 ``` 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 ``` 出力: ``` { "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" } } } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[DynamoDB テーブルの基本的なオペレーション](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html)」を参照してください。** **例 4: ローカルセカンダリインデックスを持つテーブルを作成するには** 次の例では、指定された属性とキースキーマを使用して、`AlbumTitleIndex` という名前のローカルセカンダリインデックスを持つ `MusicCollection` という名前のテーブルを作成します。 ``` 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\"] } } ]" ``` 出力: ``` { "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" } ] } } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[DynamoDB テーブルの基本的なオペレーション](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html)」を参照してください。** **例 5: グローバルセカンダリインデックスを持つテーブルを作成するには** 次の例では、`GameTitleIndex` という名前のグローバルセカンダリインデックスを持つ `GameScores` という名前のテーブルを作成します。ベーステーブルには、パーティションキー `UserId` とソートキー `GameTitle` があり、特定のゲームの個々のユーザーのベストスコアを効率的に見つけることができます。一方、GSI にはパーティションキー `GameTitle` とソートキー `TopScore` があり、特定のゲームの全体的な最高スコアをすばやく見つけることができます。 ``` 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 } } ]" ``` 出力: ``` { "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" } ] } } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[DynamoDB テーブルの基本的なオペレーション](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html)」を参照してください。** **例 6: 複数のグローバルセカンダリインデックスを持つテーブルを一度に作成するには** 次の例では、2 つのグローバルセカンダリインデックスを持つ `GameScores` という名前のテーブルを作成します。GSI スキーマはコマンドラインではなくファイルを介して渡されます。 ``` 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 ``` `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 } } ] ``` 出力: ``` { "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" } ] } } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[DynamoDB テーブルの基本的なオペレーション](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html)」を参照してください。** **例 7: ストリームが有効なテーブルを作成するには** 次の例では、DynamoDB ストリームを有効にした状態の `GameScores` という名前のテーブルを作成します。各アイテムの新しいイメージと古いイメージの両方がストリームに書き込まれます。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[DynamoDB テーブルの基本的なオペレーション](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html)」を参照してください。** **例 8: Keys-Only ストリームが有効なテーブルを作成するには** 次の例では、DynamoDB ストリームを有効にした状態の `GameScores` という名前のテーブルを作成します。変更された項目のキー属性のみがストリームに書き込まれます。 ``` 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 ``` 出力: ``` { "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 } } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[DynamoDB Streams の変更データキャプチャ](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html)」を参照してください。** **例 9: Standard Infrequent Access クラスでテーブルを作成するには** 次の例は、`GameScores` という名前のテーブルを作成し、Standard-Infrequent Access (DynamoDB Standard-IA) テーブルクラスを割り当てます。このテーブルクラスは、ストレージが主なコストとなるように最適化されています。 ``` 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 ``` 出力: ``` { "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 } } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[テーブルクラス](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.TableClasses.html)」を参照してください。** **例 10: 削除保護を有効にしたテーブルを作成するには** 次の例では、`GameScores` というテーブルを作成し、削除保護を有効にします。 ``` 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 ``` 出力: ``` { "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 } } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[削除保護の使用](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.DeletionProtection)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/create-table.html)」を参照してください。 ### `delete-backup` 次のコード例は、`delete-backup` を使用する方法を示しています。 **AWS CLI** **既存の DynamoDB バックアップを削除するには** 次の `delete-backup` の例は、指定した既存のバックアップを削除します。 ``` aws dynamodb delete-backup \ --backup-arn arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01576616366715-b4e58d3a ``` 出力: ``` { "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": {} } } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[On-Demand Backup and Restore for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/BackupRestore.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteBackup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/delete-backup.html)」を参照してください。 ### `delete-item` 次のコード例は、`delete-item` を使用する方法を示しています。 **AWS CLI** **例 1: 項目を削除するには** 次の `delete-item` の例は、`MusicCollection` テーブルから項目を削除し、削除した項目とそのリクエストで使用された容量に関する詳細を取得します。 ``` aws dynamodb delete-item \ --table-name MusicCollection \ --key file://key.json \ --return-values ALL_OLD \ --return-consumed-capacity TOTAL \ --return-item-collection-metrics SIZE ``` `key.json` の内容: ``` { "Artist": {"S": "No One You Know"}, "SongTitle": {"S": "Scared of My Shadow"} } ``` 出力: ``` { "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 ] } } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[項目を書き込みます](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.WritingData)」を参照してください。** **例 2: 条件付きで項目を削除するには** 次の例では、`ProductCategory` が `Sporting Goods` または `Gardening Supplies` で、その価格が 500 および 600 の場合のみ、`ProductCatalog` テーブルから項目を削除します。削除された項目に関する詳細が返されます。 ``` 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 ``` `names.json` の内容: ``` { "#P": "Price" } ``` `values.json` の内容: ``` { ":cat1": {"S": "Sporting Goods"}, ":cat2": {"S": "Gardening Supplies"}, ":lo": {"N": "500"}, ":hi": {"N": "600"} } ``` 出力: ``` { "Attributes": { "Id": { "N": "456" }, "Price": { "N": "550" }, "ProductCategory": { "S": "Sporting Goods" } } } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[項目を書き込みます](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.WritingData)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteItem](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/delete-item.html)」を参照してください。 ### `delete-table` 次のコード例は、`delete-table` を使用する方法を示しています。 **AWS CLI** **テーブルを削除するには** 以下の `delete-table` の例は `MusicCollection` テーブルを削除します。 ``` aws dynamodb delete-table \ --table-name MusicCollection ``` 出力: ``` { "TableDescription": { "TableStatus": "DELETING", "TableSizeBytes": 0, "ItemCount": 0, "TableName": "MusicCollection", "ProvisionedThroughput": { "NumberOfDecreasesToday": 0, "WriteCapacityUnits": 5, "ReadCapacityUnits": 5 } } } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[テーブルの削除](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.DeleteTable)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/delete-table.html)」を参照してください。 ### `describe-backup` 次のコード例は、`describe-backup` を使用する方法を示しています。 **AWS CLI** **テーブルの既存のバックアップに関する情報を取得するには** 次の `describe-backup` の例では、指定し既存のバックアップの情報を表示します。 ``` aws dynamodb describe-backup \ --backup-arn arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01576616366715-b4e58d3a ``` 出力: ``` { "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": {} } } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[On-Demand Backup and Restore for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/BackupRestore.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeBackup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/describe-backup.html)」を参照してください。 ### `describe-continuous-backups` 次のコード例は、`describe-continuous-backups` を使用する方法を示しています。 **AWS CLI** **DynamoDB テーブルの継続的バックアップに関する情報を取得するには** 次の `describe-continuous-backups` の例では、`MusicCollection` テーブルの継続的バックアップ設定の詳細を表示します。 ``` aws dynamodb describe-continuous-backups \ --table-name MusicCollection ``` 出力: ``` { "ContinuousBackupsDescription": { "ContinuousBackupsStatus": "ENABLED", "PointInTimeRecoveryDescription": { "PointInTimeRecoveryStatus": "DISABLED" } } } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[Point-in-Time Recovery for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/PointInTimeRecovery.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeContinuousBackups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/describe-continuous-backups.html)」を参照してください。 ### `describe-contributor-insights` 次のコード例は、`describe-contributor-insights` を使用する方法を示しています。 **AWS CLI** **DynamoDB テーブルの Contributor Insights 設定を表示するには** 次の `describe-contributor-insights` の例では、`MusicCollection` テーブルと `AlbumTitle-index` グローバルセカンダリインデックスの Contributor Insights 設定を表示します。 ``` aws dynamodb describe-contributor-insights \ --table-name MusicCollection \ --index-name AlbumTitle-index ``` 出力: ``` { "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 } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[Analyzing Data Access Using CloudWatch Contributor Insights for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/contributorinsights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeContributorInsights](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/describe-contributor-insights.html)」を参照してください。 ### `describe-endpoints` 次のコード例は、`describe-endpoints` を使用する方法を示しています。 **AWS CLI** **リージョンエンドポイント情報を表示するには** 次の `describe-endpoints` の例では、現在の AWS リージョンのエンドポイントの詳細を表示します。 ``` aws dynamodb describe-endpoints ``` 出力: ``` { "Endpoints": [ { "Address": "dynamodb.us-west-2.amazonaws.com", "CachePeriodInMinutes": 1440 } ] } ``` 詳細については、「*AWS 全般リファレンス*」の「[Amazon DynamoDB Endpoints and Quotas](https://docs.aws.amazon.com/general/latest/gr/ddb.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/describe-endpoints.html)」を参照してください。 ### `describe-global-table-settings` 次のコード例は、`describe-global-table-settings` を使用する方法を示しています。 **AWS CLI** **DynamoDB グローバルテーブルの設定に関する情報を取得するには** 次の `describe-global-table-settings` の例では、`MusicCollection` グローバルテーブルの設定を表示します。 ``` aws dynamodb describe-global-table-settings \ --global-table-name MusicCollection ``` 出力: ``` { "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 } } ] } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[DynamoDB Global Tables](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeGlobalTableSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/describe-global-table-settings.html)」を参照してください。 ### `describe-global-table` 次のコード例は、`describe-global-table` を使用する方法を示しています。 **AWS CLI** **DynamoDB グローバルテーブルに関する情報を表示するには** 次の `describe-global-table` の例では、`MusicCollection` グローバルテーブルの詳細を表示します。 ``` aws dynamodb describe-global-table \ --global-table-name MusicCollection ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[DynamoDB Global Tables](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeGlobalTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/describe-global-table.html)」を参照してください。 ### `describe-limits` 次のコード例は、`describe-limits` を使用する方法を示しています。 **AWS CLI** **プロビジョニングされたキャパシティの制限を表示するには** 次の `describe-limits` の例では、現在の AWS リージョンのアカウントにプロビジョニングされたキャパシティ制限を表示します。 ``` aws dynamodb describe-limits ``` 出力: ``` { "AccountMaxReadCapacityUnits": 80000, "AccountMaxWriteCapacityUnits": 80000, "TableMaxReadCapacityUnits": 40000, "TableMaxWriteCapacityUnits": 40000 } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[Limits in DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeLimits](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/describe-limits.html)」を参照してください。 ### `describe-table-replica-auto-scaling` 次のコード例は、`describe-table-replica-auto-scaling` を使用する方法を示しています。 **AWS CLI** **グローバルテーブルのレプリカ間で自動スケーリング設定を表示するには** 次の `describe-table-replica-auto-scaling` の例では、`MusicCollection` グローバルテーブルのレプリカ間の自動スケーリング設定を表示します。 ``` aws dynamodb describe-table-replica-auto-scaling \ --table-name MusicCollection ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[DynamoDB Global Tables](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTableReplicaAutoScaling](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/describe-table-replica-auto-scaling.html)」を参照してください。 ### `describe-table` 次のコード例は、`describe-table` を使用する方法を示しています。 **AWS CLI** **テーブルを記述するには** 次の `describe-table` の例は、`MusicCollection` テーブルを記述します。 ``` aws dynamodb describe-table \ --table-name MusicCollection ``` 出力: ``` { "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 } } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[表の説明](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.DescribeTable)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/describe-table.html)」を参照してください。 ### `describe-time-to-live` 次のコード例は、`describe-time-to-live` を使用する方法を示しています。 **AWS CLI** **テーブルの Time to Live 設定を表示するには** 次の `describe-time-to-live` の例は、`MusicCollection` テーブルの Time to Live 設定を表示します。 ``` aws dynamodb describe-time-to-live \ --table-name MusicCollection ``` 出力: ``` { "TimeToLiveDescription": { "TimeToLiveStatus": "ENABLED", "AttributeName": "ttl" } } ``` 詳細については、「**Amazon DynamoDB デベロッパーガイド」の「[Time to Live (TTL)](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html)」を参照してください。 + API の詳細については、「**AWS CLI コマンドリファレンス」の「[DescribeTimeToLive](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/describe-time-to-live.html)」を参照してください。 ### `get-item` 次のコード例は、`get-item` を使用する方法を示しています。 **AWS CLI** **例 1: テーブル内の項目を読み込むには** 次の `get-item` の例は、`MusicCollection` テーブルから項目を取得します。テーブルにはハッシュおよび範囲プライマリキー (`Artist`および`SongTitle`) があるため、これらの属性の両方を指定する必要があります。このコマンドは、オペレーションによって消費される読み込み容量に関する情報も要求します。 ``` aws dynamodb get-item \ --table-name MusicCollection \ --key file://key.json \ --return-consumed-capacity TOTAL ``` `key.json` の内容: ``` { "Artist": {"S": "Acme Band"}, "SongTitle": {"S": "Happy Day"} } ``` 出力: ``` { "Item": { "AlbumTitle": { "S": "Songs About Life" }, "SongTitle": { "S": "Happy Day" }, "Artist": { "S": "Acme Band" } }, "ConsumedCapacity": { "TableName": "MusicCollection", "CapacityUnits": 0.5 } } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[項目の読み込み](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.ReadingData)」を参照してください。** **例 2: 整合性のある読み込みを使用して項目を読み込むには** 次の例では、強力な整合性のある読み込みを使用して `MusicCollection` テーブルから項目を読み込みます。 ``` aws dynamodb get-item \ --table-name MusicCollection \ --key file://key.json \ --consistent-read \ --return-consumed-capacity TOTAL ``` `key.json` の内容: ``` { "Artist": {"S": "Acme Band"}, "SongTitle": {"S": "Happy Day"} } ``` 出力: ``` { "Item": { "AlbumTitle": { "S": "Songs About Life" }, "SongTitle": { "S": "Happy Day" }, "Artist": { "S": "Acme Band" } }, "ConsumedCapacity": { "TableName": "MusicCollection", "CapacityUnits": 1.0 } } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[項目の読み込み](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.ReadingData)」を参照してください。** **例 3: 項目の特定の属性を取得するには** 次の例は、射影式を使用して目的のアイテムの 3 つの属性のみを取得します。 ``` aws dynamodb get-item \ --table-name ProductCatalog \ --key '{"Id": {"N": "102"}}' \ --projection-expression "#T, #C, #P" \ --expression-attribute-names file://names.json ``` `names.json` の内容: ``` { "#T": "Title", "#C": "ProductCategory", "#P": "Price" } ``` 出力: ``` { "Item": { "Price": { "N": "20" }, "Title": { "S": "Book 102 Title" }, "ProductCategory": { "S": "Book" } } } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[項目の読み込み](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.ReadingData)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetItem](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/get-item.html)」を参照してください。 ### `list-backups` 次のコード例は、`list-backups` を使用する方法を示しています。 **AWS CLI** **例 1: 既存の DynamoDB バックアップをすべて一覧表示するには** 次の `list-backups` の例では、既存のバックアップをすべて一覧表示します。 ``` aws dynamodb list-backups ``` 出力: ``` { "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 } ] } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[On-Demand Backup and Restore for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/BackupRestore.html)」を参照してください。 **例 2: 特定の時間範囲内にユーザーが作成したバックアップを一覧表示するには** 次の例では、作成日が 2020 年 1 月 1 日から 2020 年 3 月 1 日までの期間内にある、(DynamoDB によって自動的に作成されたバックアップではなく) ユーザーによって作成された `MusicCollection` テーブルのバックアップのみを一覧表示します。 ``` aws dynamodb list-backups \ --table-name MusicCollection \ --time-range-lower-bound 1577836800 \ --time-range-upper-bound 1583020800 \ --backup-type USER ``` 出力: ``` { "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 } ] } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[On-Demand Backup and Restore for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/BackupRestore.html)」を参照してください。 **例 3: ページサイズを制限するには** 次の例では、既存のすべてのバックアップのリストを返しますが、1 回の呼び出しで 1 つの項目のみを取得し、必要な場合は複数の呼び出しを実行してリスト全体を取得します。デフォルトのページサイズ (1000) を使用して大量のリソースに対してリストコマンドを実行する際に「タイムアウト」が発生する場合、ページサイズを制限してください。 ``` aws dynamodb list-backups \ --page-size 1 ``` 出力: ``` { "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 } ] } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[On-Demand Backup and Restore for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/BackupRestore.html)」を参照してください。 **例 4: 返される項目の数を制限するには** 次の例では、返される項目の数を 1 に制限します。レスポンスには、次の結果ページの取得に使用する `NextToken` 値が含まれます。 ``` aws dynamodb list-backups \ --max-items 1 ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[On-Demand Backup and Restore for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/BackupRestore.html)」を参照してください。 **例 5: 次の結果ページを取得するには** 次のコマンドは、`list-backups` コマンドへの前の呼び出しの `NextToken` 値を使用して、次の結果ページを取得します。この場合のレスポンスには `NextToken` 値が含まれていないため、結果の最後のページに達したことがわかります。 ``` 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 } ] } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[On-Demand Backup and Restore for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/BackupRestore.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListBackups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/list-backups.html)」を参照してください。 ### `list-contributor-insights` 次のコード例は、`list-contributor-insights` を使用する方法を示しています。 **AWS CLI** **例 1: Contributor Insights の概要のリストを表示するには** 次の `list-contributor-insights` の例では、Contributor Insights の概要のリストを示します。 ``` aws dynamodb list-contributor-insights ``` 出力: ``` { "ContributorInsightsSummaries": [ { "TableName": "MusicCollection", "IndexName": "AlbumTitle-index", "ContributorInsightsStatus": "ENABLED" }, { "TableName": "ProductCatalog", "ContributorInsightsStatus": "ENABLED" }, { "TableName": "Forum", "ContributorInsightsStatus": "ENABLED" }, { "TableName": "Reply", "ContributorInsightsStatus": "ENABLED" }, { "TableName": "Thread", "ContributorInsightsStatus": "ENABLED" } ] } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[Analyzing Data Access Using CloudWatch Contributor Insights for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/contributorinsights.html)」を参照してください。 **例 2: 返される項目の数を制限するには** 次の例では、返される項目の数を 4 に制限します。レスポンスには、次の結果ページの取得に使用する `NextToken` 値が含まれます。 ``` aws dynamodb list-contributor-insights \ --max-results 4 ``` 出力: ``` { "ContributorInsightsSummaries": [ { "TableName": "MusicCollection", "IndexName": "AlbumTitle-index", "ContributorInsightsStatus": "ENABLED" }, { "TableName": "ProductCatalog", "ContributorInsightsStatus": "ENABLED" }, { "TableName": "Forum", "ContributorInsightsStatus": "ENABLED" } ], "NextToken": "abCDeFGhiJKlmnOPqrSTuvwxYZ1aBCdEFghijK7LM51nOpqRSTuv3WxY3ZabC5dEFGhI2Jk3LmnoPQ6RST9" } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[Analyzing Data Access Using CloudWatch Contributor Insights for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/contributorinsights.html)」を参照してください。 **例 3: 次の結果ページを取得するには** 次のコマンドは、`list-contributor-insights` コマンドへの前の呼び出しの `NextToken` 値を使用して、次の結果ページを取得します。この場合のレスポンスには `NextToken` 値が含まれていないため、結果の最後のページに達したことがわかります。 ``` aws dynamodb list-contributor-insights \ --max-results 4 \ --next-token abCDeFGhiJKlmnOPqrSTuvwxYZ1aBCdEFghijK7LM51nOpqRSTuv3WxY3ZabC5dEFGhI2Jk3LmnoPQ6RST9 ``` 出力: ``` { "ContributorInsightsSummaries": [ { "TableName": "Reply", "ContributorInsightsStatus": "ENABLED" }, { "TableName": "Thread", "ContributorInsightsStatus": "ENABLED" } ] } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[Analyzing Data Access Using CloudWatch Contributor Insights for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/contributorinsights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListContributorInsights](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/list-contributor-insights.html)」を参照してください。 ### `list-global-tables` 次のコード例は、`list-global-tables` を使用する方法を示しています。 **AWS CLI** **既存の DynamoDB グローバルテーブルを一覧表示するには** 次の `list-global-tables` の例では、既存のグローバルテーブルをすべて一覧表示します。 ``` aws dynamodb list-global-tables ``` 出力: ``` { "GlobalTables": [ { "GlobalTableName": "MusicCollection", "ReplicationGroup": [ { "RegionName": "us-east-2" }, { "RegionName": "us-east-1" } ] } ] } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[DynamoDB Global Tables](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListGlobalTables](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/list-global-tables.html)」を参照してください。 ### `list-tables` 次のコード例は、`list-tables` を使用する方法を示しています。 **AWS CLI** **例 1: テーブルを一覧表示するには** 次の `list-tables` の例では、現在の AWS アカウントとリージョンに関連するすべてのテーブルを一覧表示します。 ``` aws dynamodb list-tables ``` 出力: ``` { "TableNames": [ "Forum", "ProductCatalog", "Reply", "Thread" ] } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[テーブル名のリスト化](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.ListTables)」を参照してください。** **例 2: ページサイズを制限するには** 次の例は、既存のすべてのテーブルのリストを返しますが、1 回の呼び出しで 1 つの項目のみを取得し、必要な場合は複数の呼び出しを実行してリスト全体を取得します。デフォルトのページサイズ (1000) を使用して大量のリソースに対してリストコマンドを実行する際に「タイムアウト」が発生する場合、ページサイズを制限してください。 ``` aws dynamodb list-tables \ --page-size 1 ``` 出力: ``` { "TableNames": [ "Forum", "ProductCatalog", "Reply", "Thread" ] } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[テーブル名のリスト化](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.ListTables)」を参照してください。** **例 3: 返される項目の数を制限するには** 次の例は、返される項目の数を 2 に制限します。レスポンスには、次の結果ページの取得に使用する `NextToken` 値が含まれます。 ``` aws dynamodb list-tables \ --max-items 2 ``` 出力: ``` { "TableNames": [ "Forum", "ProductCatalog" ], "NextToken": "abCDeFGhiJKlmnOPqrSTuvwxYZ1aBCdEFghijK7LM51nOpqRSTuv3WxY3ZabC5dEFGhI2Jk3LmnoPQ6RST9" } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[テーブル名のリスト化](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.ListTables)」を参照してください。** **例 4: 次の結果ページを取得するには** 次のコマンドは、`list-tables` コマンドへの前の呼び出しの `NextToken` 値を使用して、次の結果ページを取得します。この場合のレスポンスには `NextToken` 値が含まれていないため、結果の最後のページに達したことがわかります。 ``` aws dynamodb list-tables \ --starting-token abCDeFGhiJKlmnOPqrSTuvwxYZ1aBCdEFghijK7LM51nOpqRSTuv3WxY3ZabC5dEFGhI2Jk3LmnoPQ6RST9 ``` 出力: ``` { "TableNames": [ "Reply", "Thread" ] } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[テーブル名のリスト化](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.ListTables)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTables](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/list-tables.html)」を参照してください。 ### `list-tags-of-resource` 次のコード例は、`list-tags-of-resource` を使用する方法を示しています。 **AWS CLI** **例 1: DynamoDB リソースのタグを一覧表示するには** 次の `list-tags-of-resource` の例では、`MusicCollection` テーブルのタグを表示します。 ``` aws dynamodb list-tags-of-resource \ --resource-arn arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection ``` 出力: ``` { "Tags": [ { "Key": "Owner", "Value": "blueTeam" }, { "Key": "Environment", "Value": "Production" } ] } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[Tagging for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html)」を参照してください。 **例 2: 返されるタグの数を制限するには** 次の例では、返されるタグの数を 1 に制限します。レスポンスには、次の結果ページの取得に使用する `NextToken` 値が含まれます。 ``` aws dynamodb list-tags-of-resource \ --resource-arn arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection \ --max-items 1 ``` 出力: ``` { "Tags": [ { "Key": "Owner", "Value": "blueTeam" } ], "NextToken": "abCDeFGhiJKlmnOPqrSTuvwxYZ1aBCdEFghijK7LM51nOpqRSTuv3WxY3ZabC5dEFGhI2Jk3LmnoPQ6RST9" } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[Tagging for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html)」を参照してください。 **例 3: 次の結果ページを取得するには** 次のコマンドは、`list-tags-of-resource` コマンドへの前の呼び出しの `NextToken` 値を使用して、次の結果ページを取得します。この場合のレスポンスには `NextToken` 値が含まれていないため、結果の最後のページに達したことがわかります。 ``` aws dynamodb list-tags-of-resource \ --resource-arn arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection \ --starting-token abCDeFGhiJKlmnOPqrSTuvwxYZ1aBCdEFghijK7LM51nOpqRSTuv3WxY3ZabC5dEFGhI2Jk3LmnoPQ6RST9 ``` 出力: ``` { "Tags": [ { "Key": "Environment", "Value": "Production" } ] } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[Tagging for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsOfResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/list-tags-of-resource.html)」を参照してください。 ### `put-item` 次のコード例は、`put-item` を使用する方法を示しています。 **AWS CLI** **例 1: テーブルに項目を追加するには** 次の `put-item` の例は、*MusicCollection* テーブルに新しい項目を追加します。 ``` aws dynamodb put-item \ --table-name MusicCollection \ --item file://item.json \ --return-consumed-capacity TOTAL \ --return-item-collection-metrics SIZE ``` `item.json` の内容: ``` { "Artist": {"S": "No One You Know"}, "SongTitle": {"S": "Call Me Today"}, "AlbumTitle": {"S": "Greatest Hits"} } ``` 出力: ``` { "ConsumedCapacity": { "TableName": "MusicCollection", "CapacityUnits": 1.0 }, "ItemCollectionMetrics": { "ItemCollectionKey": { "Artist": { "S": "No One You Know" } }, "SizeEstimateRangeGB": [ 0.0, 1.0 ] } } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[項目を書き込みます](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.WritingData)」を参照してください。** **例 2: テーブル内の項目を条件付きで上書きするには** 次の `put-item` の例は、`MusicCollection` テーブル内の既存の項目に `Greatest Hits` の値を持つ `AlbumTitle` 属性がある場合にのみ、その項目を上書きします。このコマンドは、その項目の以前の値を返します。 ``` 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 ``` `item.json` の内容: ``` { "Artist": {"S": "No One You Know"}, "SongTitle": {"S": "Call Me Today"}, "AlbumTitle": {"S": "Somewhat Famous"} } ``` `names.json` の内容: ``` { "#A": "AlbumTitle" } ``` `values.json` の内容: ``` { ":A": {"S": "Greatest Hits"} } ``` 出力: ``` { "Attributes": { "AlbumTitle": { "S": "Greatest Hits" }, "Artist": { "S": "No One You Know" }, "SongTitle": { "S": "Call Me Today" } } } ``` キーが存在する場合は、次のような出力が表示されます。 ``` A client error (ConditionalCheckFailedException) occurred when calling the PutItem operation: The conditional request failed. ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[項目を書き込みます](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.WritingData)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutItem](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/put-item.html)」を参照してください。 ### `query` 次のコード例は、`query` を使用する方法を示しています。 **AWS CLI** **例 1: テーブルにクエリを実行するには** 次の `query` の例では、`MusicCollection` テーブルの項目にクエリを実行します。テーブルにはハッシュおよび範囲プライマリキー (`Artist`および`SongTitle`) がありますが、このクエリではハッシュキー値のみを指定します。「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 ``` `expression-attributes.json` の内容: ``` { ":v1": {"S": "No One You Know"} } ``` 出力: ``` { "Items": [ { "SongTitle": { "S": "Call Me Today" }, "SongTitle": { "S": "Scared of My Shadow" } } ], "Count": 2, "ScannedCount": 2, "ConsumedCapacity": { "TableName": "MusicCollection", "CapacityUnits": 0.5 } } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[DynamoDB のクエリオペレーション](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html)」を参照してください。** **例 2: 強力な整合性のある読み込みを使用してテーブルにクエリを実行し、インデックスを降順で走査するには** 次の例では、最初の例と同じクエリを実行しますが、結果は逆の順序で返され、強力な整合性のある読み込みが使用されます。 ``` 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 ``` `expression-attributes.json` の内容: ``` { ":v1": {"S": "No One You Know"} } ``` 出力: ``` { "Items": [ { "SongTitle": { "S": "Scared of My Shadow" } }, { "SongTitle": { "S": "Call Me Today" } } ], "Count": 2, "ScannedCount": 2, "ConsumedCapacity": { "TableName": "MusicCollection", "CapacityUnits": 1.0 } } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[DynamoDB のクエリオペレーション](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html)」を参照してください。** **例 3: 特定の結果を除外するには** 次の例は、`MusicCollection` をクエリしますが、`AlbumTitle` 属性に特定の値を含む結果を除外します。このフィルターは項目が読み込まれた後に適用されるため、`ScannedCount` または `ConsumedCapacity` には影響しないことに注意してください。 ``` 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 ``` `values.json` の内容: ``` { ":v1": {"S": "No One You Know"}, ":v2": {"S": "Blue Sky Blues"}, ":v3": {"S": "Greatest Hits"} } ``` `names.json` の内容: ``` { "#n1": "Artist", "#n2": "AlbumTitle" } ``` 出力: ``` { "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 } } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[DynamoDB のクエリオペレーション](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html)」を参照してください。** **例 4: 項目数だけを取得するには** 次の例は、クエリに一致する項目数を取得しますが、項目自体は取得しません。 ``` aws dynamodb query \ --table-name MusicCollection \ --select COUNT \ --key-condition-expression "Artist = :v1" \ --expression-attribute-values file://expression-attributes.json ``` `expression-attributes.json` の内容: ``` { ":v1": {"S": "No One You Know"} } ``` 出力: ``` { "Count": 2, "ScannedCount": 2, "ConsumedCapacity": null } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[DynamoDB のクエリオペレーション](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html)」を参照してください。** **例 5: インデックスをクエリするには** 次の例は、ローカルセカンダリインデックス `AlbumTitleIndex` をクエリします。クエリは、ローカルセカンダリインデックスに射影されたベーステーブルのすべての属性を返します。ローカルセカンダリインデックスまたはグローバルセカンダリインデックスをクエリする場合は、`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 ``` `expression-attributes.json` の内容: ``` { ":v1": {"S": "No One You Know"} } ``` 出力: ``` { "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 } } } } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[DynamoDB のクエリオペレーション](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[Query](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/query.html)」を参照してください。 ### `restore-table-from-backup` 次のコード例は、`restore-table-from-backup` を使用する方法を示しています。 **AWS CLI** **既存のバックアップから DynamoDB テーブルを復元するには** 次の `restore-table-from-backup` の例では、指定したテーブルを既存のバックアップから削除します。 ``` aws dynamodb restore-table-from-backup \ --target-table-name MusicCollection \ --backup-arnarn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection/backup/01576616366715-b4e58d3a ``` 出力: ``` { "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 } } } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[On-Demand Backup and Restore for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/BackupRestore.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RestoreTableFromBackup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/restore-table-from-backup.html)」を参照してください。 ### `restore-table-to-point-in-time` 次のコード例は、`restore-table-to-point-in-time` を使用する方法を示しています。 **AWS CLI** **DynamoDB テーブルを特定時点に復元するには** 次の `restore-table-to-point-in-time` の例では、`MusicCollection` テーブルを指定した時点に復元します。 ``` aws dynamodb restore-table-to-point-in-time \ --source-table-name MusicCollection \ --target-table-name MusicCollectionRestore \ --restore-date-time 1576622404.0 ``` 出力: ``` { "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 } } } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[Point-in-Time Recovery for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/PointInTimeRecovery.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RestoreTableToPointInTime](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/restore-table-to-point-in-time.html)」を参照してください。 ### `scan` 次のコード例は、`scan` を使用する方法を示しています。 **AWS CLI** **テーブルをスキャンするには** 次の `scan` の例は、`MusicCollection` テーブル全体をスキャンし、その結果をアーティスト「No One You Know」の曲に絞り込みます。各項目について、アルバムタイトルと曲タイトルのみが返されます。 ``` 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 ``` `expression-attribute-names.json` の内容: ``` { "#ST": "SongTitle", "#AT":"AlbumTitle" } ``` `expression-attribute-values.json` の内容: ``` { ":a": {"S": "No One You Know"} } ``` 出力: ``` { "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 } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[DynamoDB でのスキャンの使用](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[Scan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/scan.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **DynamoDB リソースにタグを追加するには** 次の `tag-resource` の例では、タグのキー/値ペアを `MusicCollection` に追加します。 ``` aws dynamodb tag-resource \ --resource-arn arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection \ --tags Key=Owner,Value=blueTeam ``` このコマンドでは何も出力されません。 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[Tagging for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/tag-resource.html)」を参照してください。 ### `transact-get-items` 次のコード例は、`transact-get-items` を使用する方法を示しています。 **AWS CLI** **1 つ以上のテーブルから複数の項目をアトミックに取得するには** 次の `transact-get-items` の例では、複数の項目をアトミックに取得します。 ``` aws dynamodb transact-get-items \ --transact-items file://transact-items.json \ --return-consumed-capacity TOTAL ``` `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" } } ] ``` 出力: ``` { "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" } } } ] } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[Managing Complex Workflows with DynamoDB Transactions](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/transactions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TransactGetItems](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/transact-get-items.html)」を参照してください。 ### `transact-write-items` 次のコード例は、`transact-write-items` を使用する方法を示しています。 **AWS CLI** **例 1: 1 つ以上のテーブルに項目をアトミックに書き込むには** 次の `transact-write-items` の例では、1 つの項目を更新し、別の項目を削除します。いずれかのオペレーションが失敗した場合、または、いずれかのアイテムに `Rating` 属性が含まれている場合、オペレーションは失敗します。 ``` aws dynamodb transact-write-items \ --transact-items file://transact-items.json \ --return-consumed-capacity TOTAL \ --return-item-collection-metrics SIZE ``` `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)" } } ] ``` 出力: ``` { "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 ] } ] } } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[Managing Complex Workflows with DynamoDB Transactions](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/transactions.html)」を参照してください。 **例 2: クライアントリクエストトークンを使用して項目をアトミックに書き込むには** 次のコマンドは、クライアントリクエストトークンを使用して `transact-write-items` 呼び出しをべき等なもの、つまり、複数回の呼び出しが 1 回の呼び出しと同じ効果を持つようにします。 ``` aws dynamodb transact-write-items \ --transact-items file://transact-items.json \ --client-request-token abc123 ``` `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)" } } ] ``` このコマンドでは何も出力されません。 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[Managing Complex Workflows with DynamoDB Transactions](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/transactions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TransactWriteItems](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/transact-write-items.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **DynamoDB リソースからタグを削除するには** 次の `untag-resource` の例では、キー `Owner` を持つタグを `MusicCollection` テーブルから削除します。 ``` aws dynamodb untag-resource \ --resource-arn arn:aws:dynamodb:us-west-2:123456789012:table/MusicCollection \ --tag-keys Owner ``` このコマンドでは何も出力されません。 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[Tagging for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/untag-resource.html)」を参照してください。 ### `update-continuous-backups` 次のコード例は、`update-continuous-backups` を使用する方法を示しています。 **AWS CLI** **DynamoDB テーブルの継続的バックアップ設定を更新するには** 次の `update-continuous-backups` の例では、`MusicCollection` テーブルのポイントインタイムリカバリを有効にします。 ``` aws dynamodb update-continuous-backups \ --table-name MusicCollection \ --point-in-time-recovery-specification PointInTimeRecoveryEnabled=true ``` 出力: ``` { "ContinuousBackupsDescription": { "ContinuousBackupsStatus": "ENABLED", "PointInTimeRecoveryDescription": { "PointInTimeRecoveryStatus": "ENABLED", "EarliestRestorableDateTime": 1576622404.0, "LatestRestorableDateTime": 1576622404.0 } } } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[Point-in-Time Recovery for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/PointInTimeRecovery.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateContinuousBackups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/update-continuous-backups.html)」を参照してください。 ### `update-contributor-insights` 次のコード例は、`update-contributor-insights` を使用する方法を示しています。 **AWS CLI** **テーブルで Contributor Insights を有効にするには** 次の `update-contributor-insights` の例では、`MusicCollection` テーブルと `AlbumTitle-index` グローバルセカンダリインデックスで Contributor Insights を有効にします。 ``` aws dynamodb update-contributor-insights \ --table-name MusicCollection \ --index-name AlbumTitle-index \ --contributor-insights-action ENABLE ``` 出力: ``` { "TableName": "MusicCollection", "IndexName": "AlbumTitle-index", "ContributorInsightsStatus": "ENABLING" } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[Analyzing Data Access Using CloudWatch Contributor Insights for DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/contributorinsights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateContributorInsights](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/update-contributor-insights.html)」を参照してください。 ### `update-global-table-settings` 次のコード例は、`update-global-table-settings` を使用する方法を示しています。 **AWS CLI** **DynamoDB グローバルテーブルのプロビジョニングされた書き込みキャパシティ設定を更新するには** 次の `update-global-table-settings` の例では、`MusicCollection` グローバルテーブルのプロビジョニングされた書き込みキャパシティを 15 に設定します。 ``` aws dynamodb update-global-table-settings \ --global-table-name MusicCollection \ --global-table-provisioned-write-capacity-units 15 ``` 出力: ``` { "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 } } ] } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[DynamoDB Global Tables](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateGlobalTableSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/update-global-table-settings.html)」を参照してください。 ### `update-global-table` 次のコード例は、`update-global-table` を使用する方法を示しています。 **AWS CLI** **DynamoDB グローバルテーブルを更新するには** 次の `update-global-table` の例では、指定したリージョンのレプリカを `MusicCollection` グローバルテーブルに追加します。 ``` aws dynamodb update-global-table \ --global-table-name MusicCollection \ --replica-updates Create={RegionName=eu-west-1} ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[DynamoDB Global Tables](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateGlobalTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/update-global-table.html)」を参照してください。 ### `update-item` 次のコード例は、`update-item` を使用する方法を示しています。 **AWS CLI** **例 1: テーブル内の項目を更新するには** 次の `update-item` の例では、`MusicCollection` テーブルの項目を更新します。新しい属性 (`Year`) を追加して、`AlbumTitle` 属性を更新します。更新後に表示される項目内の属性はすべて、レスポンスで返されます。 ``` 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 ``` `key.json` の内容: ``` { "Artist": {"S": "Acme Band"}, "SongTitle": {"S": "Happy Day"} } ``` `expression-attribute-names.json` の内容: ``` { "#Y":"Year", "#AT":"AlbumTitle" } ``` `expression-attribute-values.json` の内容: ``` { ":y":{"N": "2015"}, ":t":{"S": "Louder Than Ever"} } ``` 出力: ``` { "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 ] } } ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[項目を書き込みます](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.WritingData)」を参照してください。** **例 2: 項目を条件付きで更新するには** 次の例は、既存の項目に `Year` 属性がない場合にのみ、`MusicCollection` テーブル内の項目を更新します。 ``` 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)" ``` `key.json` の内容: ``` { "Artist": {"S": "Acme Band"}, "SongTitle": {"S": "Happy Day"} } ``` `expression-attribute-names.json` の内容: ``` { "#Y":"Year", "#AT":"AlbumTitle" } ``` `expression-attribute-values.json` の内容: ``` { ":y":{"N": "2015"}, ":t":{"S": "Louder Than Ever"} } ``` 項目にすでに `Year` 属性がある場合、DynamoDB は次の出力を返します。 ``` An error occurred (ConditionalCheckFailedException) when calling the UpdateItem operation: The conditional request failed ``` 詳細については、「Amazon DynamoDB ディベロッパーガイド」の「[項目を書き込みます](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html#WorkingWithItems.WritingData)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateItem](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/update-item.html)」を参照してください。 ### `update-table-replica-auto-scaling` 次のコード例は、`update-table-replica-auto-scaling` を使用する方法を示しています。 **AWS CLI** **グローバルテーブルのレプリカ間で自動スケーリング設定を更新するには** 次の `update-table-replica-auto-scaling` の例では、指定したグローバルテーブルのレプリカ間の書き込みキャパシティ自動スケーリング設定を更新します。 ``` aws dynamodb update-table-replica-auto-scaling \ --table-name MusicCollection \ --provisioned-write-capacity-auto-scaling-update file://auto-scaling-policy.json ``` `auto-scaling-policy.json` の内容: ``` { "MinimumUnits": 10, "MaximumUnits": 100, "AutoScalingDisabled": false, "ScalingPolicyUpdate": { "PolicyName": "DynamoDBWriteCapacityUtilization:table/MusicCollection", "TargetTrackingScalingPolicyConfiguration": { "TargetValue": 80 } } } ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[DynamoDB Global Tables](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateTableReplicaAutoScaling](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/update-table-replica-auto-scaling.html)」を参照してください。 ### `update-table` 次のコード例は、`update-table` を使用する方法を示しています。 **AWS CLI** **例 1: テーブルの請求モードを変更するには** 次の `update-table` 例は、`MusicCollection` テーブルにプロビジョニングされた読み取り/書き込みキャパシティを増やします。 ``` aws dynamodb update-table \ --table-name MusicCollection \ --billing-mode PROVISIONED \ --provisioned-throughput ReadCapacityUnits=15,WriteCapacityUnits=10 ``` 出力: ``` { "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" } } } ``` 詳細については、「Amazon DynamoDB デベロッパーガイド」の「[テーブルの更新](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.UpdateTable)」を参照してください。** **例 2: グローバルセカンダリインデックスを作成するには** 次の例は、`MusicCollection` テーブルにグローバルセカンダリインデックスを追加します。 ``` aws dynamodb update-table \ --table-name MusicCollection \ --attribute-definitions AttributeName=AlbumTitle,AttributeType=S \ --global-secondary-index-updates file://gsi-updates.json ``` `gsi-updates.json` の内容: ``` [ { "Create": { "IndexName": "AlbumTitle-index", "KeySchema": [ { "AttributeName": "AlbumTitle", "KeyType": "HASH" } ], "ProvisionedThroughput": { "ReadCapacityUnits": 10, "WriteCapacityUnits": 10 }, "Projection": { "ProjectionType": "ALL" } } } ] ``` 出力: ``` { "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" } ] } } ``` 詳細については、「Amazon DynamoDB デベロッパーガイド」の「[テーブルの更新](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.UpdateTable)」を参照してください。** **例 3: テーブルで DynamoDB Streams を有効化するには** 次のコマンドは、`MusicCollection` テーブルで DynamoDB Streams を有効化します。 ``` aws dynamodb update-table \ --table-name MusicCollection \ --stream-specification StreamEnabled=true,StreamViewType=NEW_IMAGE ``` 出力: ``` { "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" } } ``` 詳細については、「Amazon DynamoDB デベロッパーガイド」の「[テーブルの更新](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.UpdateTable)」を参照してください。** **例 4: サーバー側の暗号化を有効化するには** 次の例は、`MusicCollection` テーブルでサーバー側の暗号化を有効します。 ``` aws dynamodb update-table \ --table-name MusicCollection \ --sse-specification Enabled=true,SSEType=KMS ``` 出力: ``` { "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" } } } ``` 詳細については、「Amazon DynamoDB デベロッパーガイド」の「[テーブルの更新](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.UpdateTable)」を参照してください。** + API の詳細については、「AWS CLI コマンドリファレンス」の「[UpdateTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/update-table.html)」を参照してください。** ### `update-time-to-live` 次のコード例は、`update-time-to-live` を使用する方法を示しています。 **AWS CLI** **テーブルの Time to Live 設定を更新するには** 次の `update-time-to-live` 例は、指定したテーブルの Time to Live を有効にします。 ``` aws dynamodb update-time-to-live \ --table-name MusicCollection \ --time-to-live-specification Enabled=true,AttributeName=ttl ``` 出力: ``` { "TimeToLiveSpecification": { "Enabled": true, "AttributeName": "ttl" } } ``` 詳細については、「**Amazon DynamoDB デベロッパーガイド」の「[Time to Live (TTL)](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html)」を参照してください。 + API の詳細については、「**AWS CLI コマンドリファレンス」の「[UpdateTimeToLive](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodb/update-time-to-live.html)」を参照してください。 # AWS CLI を使用した DynamoDB の例 次のコード例は、DynamoDB Streams で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `describe-stream` 次のコード例は、`describe-stream` を使用する方法を示しています。 **AWS CLI** **DynamoDB ストリームに関する情報を取得するには** 次の `describe-stream` コマンドは、特定の DynamoDB ストリームに関する情報を表示します。 ``` aws dynamodbstreams describe-stream \ --stream-arn arn:aws:dynamodb:us-west-1:123456789012:table/Music/stream/2019-10-22T18:02:01.576 ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[Capturing Table Activity with DynamoDB Streams](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodbstreams/describe-stream.html)」を参照してください。** ### `get-records` 次のコード例は、`get-records` を使用する方法を示しています。 **AWS CLI** **Dynamodb ストリームからレコードを取得するには** 次の `get-records` コマンドは、指定した 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==" ``` 出力: ``` { "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==" } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[Capturing Table Activity with DynamoDB Streams](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRecords](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodbstreams/get-records.html)」を参照してください。 ### `get-shard-iterator` 次のコード例は、`get-shard-iterator` を使用する方法を示しています。 **AWS CLI** **シャードイテレーターを取得するには** 次の `get-shard-iterator` コマンドは、指定したシャードのシャードイテレーターを取得します。 ``` 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 ``` 出力: ``` { "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==" } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[Capturing Table Activity with DynamoDB Streams](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetShardIterator](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodbstreams/get-shard-iterator.html)」を参照してください。 ### `list-streams` 次のコード例は、`list-streams` を使用する方法を示しています。 **AWS CLI** **DynamoDB ストリームを一覧表示するには** 次の `list-streams` コマンドは、デフォルトの AWS リージョン内にある既存の Amazon DynamoDB Streams をすべて一覧表示します。 ``` aws dynamodbstreams list-streams ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon DynamoDB デベロッパーガイド*」の「[Capturing Table Activity with DynamoDB Streams](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[ListStreams](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/dynamodbstreams/list-streams.html)」を参照してください。** # AWS CLI を使用する Amazon EC2 の例 次のコード例は、Amazon EC2 で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `accept-address-transfer` 次のコード例は、`accept-address-transfer` を使用する方法を示しています。 **AWS CLI** **アカウントに移行された Elastic IP アドレスを承諾するには** 次の `accept-address-transfer` の例では、指定した Elastic IP アドレスのアカウントへの転送を承諾します。 ``` aws ec2 accept-address-transfer \ --address 100.21.184.216 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon VPC ユーザーガイド*」の「[Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/WorkWithEIPs.html#transfer-EIPs-intro)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AcceptAddressTransfer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/accept-address-transfer.html)」を参照してください。 ### `accept-reserved-instances-exchange-quote` 次のコード例は、`accept-reserved-instances-exchange-quote` を使用する方法を示しています。 **AWS CLI** **コンバーティブルリザーブドインスタンス交換を実行するには** この例では、指定されたコンバーティブルリザーブドインスタンスの交換を実行します。 コマンド: ``` aws ec2 accept-reserved-instances-exchange-quote --reserved-instance-ids 7b8750c3-397e-4da4-bbcb-a45ebexample --target-configurations OfferingId=b747b472-423c-48f3-8cee-679bcexample ``` 出力: ``` { "ExchangeId": "riex-e68ed3c1-8bc8-4c17-af77-811afexample" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AcceptReservedInstancesExchangeQuote](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/accept-reserved-instances-exchange-quote.html)」を参照してください。 ### `accept-transit-gateway-peering-attachment` 次のコード例は、`accept-transit-gateway-peering-attachment` を使用する方法を示しています。 **AWS CLI** **Transit Gateway ピアリングアタッチメントを承諾するには** 次の `accept-transit-gateway-peering-attachment` の例では、指定した Transit Gateway ピアリングアタッチメントを承諾します。`--region` パラメータは、アクセプタ Transit Gateway があるリージョンを指定します。 ``` aws ec2 accept-transit-gateway-peering-attachment \ --transit-gateway-attachment-id tgw-attach-4455667788aabbccd \ --region us-east-2 ``` 出力: ``` { "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" } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Transit Gateway Peering Attachments](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-peering.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AcceptTransitGatewayPeeringAttachment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/accept-transit-gateway-peering-attachment.html)」を参照してください。 ### `accept-transit-gateway-vpc-attachment` 次のコード例は、`accept-transit-gateway-vpc-attachment` を使用する方法を示しています。 **AWS CLI** **VPC を Transit Gateway にアタッチするためのリクエストを承諾するには。** 次の `accept-transit-gateway-vpc-attachment` の例では、リクエスト forte で指定した添付ファイルを承諾します。 ``` aws ec2 accept-transit-gateway-vpc-attachment \ --transit-gateway-attachment-id tgw-attach-0a34fe6b4fEXAMPLE ``` 出力: ``` { "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" } } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Transit Gateway Attachments to a VPC](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-vpc-attachments.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AcceptTransitGatewayVpcAttachment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/accept-transit-gateway-vpc-attachment.html)」を参照してください。 ### `accept-vpc-endpoint-connections` 次のコード例は、`accept-vpc-endpoint-connections` を使用する方法を示しています。 **AWS CLI** **インターフェイスエンドポイント接続リクエストを承諾するには** この例では、指定されたエンドポイントサービスに対して指定されたエンドポイント接続リクエストを承諾します。 コマンド: ``` aws ec2 accept-vpc-endpoint-connections --service-id vpce-svc-03d5ebb7d9579a2b3 --vpc-endpoint-ids vpce-0c1308d7312217abc ``` 出力: ``` { "Unsuccessful": [] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AcceptVpcEndpointConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/accept-vpc-endpoint-connections.html)」を参照してください。 ### `accept-vpc-peering-connection` 次のコード例は、`accept-vpc-peering-connection` を使用する方法を示しています。 **AWS CLI** **VPC ピアリング接続を承諾するには** この例では、指定された VPC ピアリング接続リクエストを承諾します。 コマンド: ``` aws ec2 accept-vpc-peering-connection --vpc-peering-connection-id pcx-1a2b3c4d ``` 出力: ``` { "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" } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AcceptVpcPeeringConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/accept-vpc-peering-connection.html)」を参照してください。 ### `advertise-byoip-cidr` 次のコード例は、`advertise-byoip-cidr` を使用する方法を示しています。 **AWS CLI** **アドレス範囲をアドバタイズするには** 次の `advertise-byoip-cidr` の例では、指定したパブリック IPv4 アドレス範囲をアドバタイズします。 ``` aws ec2 advertise-byoip-cidr \ --cidr 203.0.113.25/24 ``` 出力: ``` { "ByoipCidr": { "Cidr": "203.0.113.25/24", "StatusMessage": "ipv4pool-ec2-1234567890abcdef0", "State": "provisioned" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AdvertiseByoipCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/advertise-byoip-cidr.html)」を参照してください。 ### `allocate-address` 次のコード例は、`allocate-address` を使用する方法を示しています。 **AWS CLI** **例 1: Amazon のアドレスプールから Elastic IP アドレスを割り当てるには** 次の `allocate-address` の例では、Elastic IP アドレスを割り当てています。Amazon EC2 は、Amazon のアドレスプールからアドレスを選択します。 ``` aws ec2 allocate-address ``` 出力: ``` { "PublicIp": "70.224.234.241", "AllocationId": "eipalloc-01435ba59eEXAMPLE", "PublicIpv4Pool": "amazon", "NetworkBorderGroup": "us-west-2", "Domain": "vpc" } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[Elastic IP アドレス](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html)」を参照してください。 **例 2: Elastic IP アドレスを割り当て、インスタンスまたはネットワークボーダーグループと関連付けるには** 次の `allocate-address` の例では、Elastic IP アドレスを割り当て、指定されたネットワークボーダーグループに関連付けます。 ``` aws ec2 allocate-address \ --network-border-group us-west-2-lax-1 ``` 出力: ``` { "PublicIp": "70.224.234.241", "AllocationId": "eipalloc-e03dd489ceEXAMPLE", "PublicIpv4Pool": "amazon", "NetworkBorderGroup": "us-west-2-lax-1", "Domain": "vpc" } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[Elastic IP アドレス](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html)」を参照してください。 **例 3: 所有するアドレスプールから Elastic IP アドレスを割り当てるには** 次の `allocate-address` の例では、Amazon Web Services アカウントに入れたアドレスプールから Elastic IP アドレスを割り当てています。Amazon EC2 は、アドレスプールからアドレスを選択します。 ``` aws ec2 allocate-address \ --public-ipv4-pool ipv4pool-ec2-1234567890abcdef0 ``` 出力: ``` { "AllocationId": "eipalloc-02463d08ceEXAMPLE", "NetworkBorderGroup": "us-west-2", "CustomerOwnedIp": "18.218.95.81", "CustomerOwnedIpv4Pool": "ipv4pool-ec2-1234567890abcdef0", "Domain": "vpc" "NetworkBorderGroup": "us-west-2", } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[Elastic IP アドレス](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html)」を参照してください。 **例 4: IPAM プールから Elastic IP アドレスを割り当てるには** 次の `allocate-address` の例では、Amazon VPC IP Address Manager (IPAM) プールから特定の /32 Elastic IP アドレスを割り当てます。 ``` aws ec2 allocate-address \ --region us-east-1 \ --ipam-pool-id ipam-pool-1234567890abcdef0 \ --address 192.0.2.0 ``` 出力: ``` { "PublicIp": "192.0.2.0", "AllocationId": "eipalloc-abcdef01234567890", "PublicIpv4Pool": "ipam-pool-1234567890abcdef0", "NetworkBorderGroup": "us-east-1", "Domain": "vpc" } ``` 詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[IPAM プールからシーケンシャル Elastic IP アドレスを割り当てる](https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-eip-pool.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AllocateAddress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/allocate-address.html)」を参照してください。 ### `allocate-hosts` 次のコード例は、`allocate-hosts` を使用する方法を示しています。 **AWS CLI** **例 1: 専有ホストを割り当てるには** 次の `allocate-hosts` の例では、`eu-west-1a` アベイラビリティーゾーンに 1 つの専有ホストを割り当てます。このゾーンでは `m5.large` インスタンスを起動できます。デフォルトでは、専有ホストはターゲットインスタンスの起動のみを承諾し、ホストリカバリはサポートしていません。 ``` aws ec2 allocate-hosts \ --instance-type m5.large \ --availability-zone eu-west-1a \ --quantity 1 ``` 出力: ``` { "HostIds": [ "h-07879acf49EXAMPLE" ] } ``` **例 2: 自動配置とホストリカバリが有効になっている専有ホストを割り当てるには** 次の `allocate-hosts` の例では、自動配置とホストリカバリが有効になっている `eu-west-1a` アベイラビリティーゾーンに 1 つの専有ホストを割り当てます。 ``` aws ec2 allocate-hosts \ --instance-type m5.large \ --availability-zone eu-west-1a \ --auto-placement on \ --host-recovery on \ --quantity 1 ``` 出力: ``` { "HostIds": [ "h-07879acf49EXAMPLE" ] } ``` **例 3: タグのある専有ホストを割り当てるには** 次の `allocate-hosts` の例では、1 つの専有ホストを割り当てて、`purpose` という名前のキーと `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}' ``` 出力: ``` { "HostIds": [ "h-07879acf49EXAMPLE" ] } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[専有ホストを割り当てる](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-allocating.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AllocateHosts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/allocate-hosts.html)」を参照してください。 ### `allocate-ipam-pool-cidr` 次のコード例は、`allocate-ipam-pool-cidr` を使用する方法を示しています。 **AWS CLI** **IPAM プールから CIDR を割り当てるには** 次の `allocate-ipam-pool-cidr` の例では、IPAM プールから CIDR を割り当てます。 (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 ``` 出力: ``` { "IpamPoolAllocation": { "Cidr": "10.0.0.0/24", "IpamPoolAllocationId": "ipam-pool-alloc-018ecc28043b54ba38e2cd99943cebfbd", "ResourceType": "custom", "ResourceOwner": "123456789012" } } ``` 詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[Manually allocate a CIDR to a pool to reserve IP address space](https://docs.aws.amazon.com/vpc/latest/ipam/manually-allocate-ipam.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AllocateIpamPoolCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/allocate-ipam-pool-cidr.html)」を参照してください。 ### `apply-security-groups-to-client-vpn-target-network` 次のコード例は、`apply-security-groups-to-client-vpn-target-network` を使用する方法を示しています。 **AWS CLI** **クライアント VPN エンドポイントのターゲットネットワークにセキュリティグループを適用するには** 次の `apply-security-groups-to-client-vpn-target-network` の例では、セキュリティグループ `sg-01f6e627a89f4db32` を指定したターゲットネットワークとクライアント 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 ``` 出力: ``` { "SecurityGroupIds": [ "sg-01f6e627a89f4db32" ] } ``` 詳細については、「*AWS Client VPN 管理者ガイド*」の「[Target Networks](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-target.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ApplySecurityGroupsToClientVpnTargetNetwork](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/apply-security-groups-to-client-vpn-target-network.html)」を参照してください。 ### `assign-ipv6-addresses` 次のコード例は、`assign-ipv6-addresses` を使用する方法を示しています。 **AWS CLI** **特定の IPv6 アドレスをネットワークインターフェイスに割り当てるには** この例では、指定された IPv6 アドレスを指定されたネットワークインターフェイスに割り当てます。 コマンド: ``` 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 ``` 出力: ``` { "AssignedIpv6Addresses": [ "2001:db8:1234:1a00:3304:8879:34cf:4071", "2001:db8:1234:1a00:9691:9503:25ad:1761" ], "NetworkInterfaceId": "eni-38664473" } ``` **Amazon が選択した IPv6 アドレスをネットワークインターフェイスに割り当てるには** この例では、2 つの IPv6 アドレスを指定されたネットワークインターフェイスに割り当てます。Amazon は、サブネットの IPv6 CIDR ブロック範囲内で使用可能な IPv6 アドレスからこれらの IPv6 アドレスを自動的に割り当てます。 コマンド: ``` aws ec2 assign-ipv6-addresses --network-interface-id eni-38664473 --ipv6-address-count 2 ``` 出力: ``` { "AssignedIpv6Addresses": [ "2001:db8:1234:1a00:3304:8879:34cf:4071", "2001:db8:1234:1a00:9691:9503:25ad:1761" ], "NetworkInterfaceId": "eni-38664473" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssignIpv6Addresses](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/assign-ipv6-addresses.html)」を参照してください。 ### `assign-private-ip-addresses` 次のコード例は、`assign-private-ip-addresses` を使用する方法を示しています。 **AWS CLI** **セカンダリプライベート IP アドレスをネットワークインターフェイスに割り当てるには** この例では、指定されたセカンダリプライベート IP アドレスを指定されたネットワークインターフェイスに割り当てます。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 assign-private-ip-addresses --network-interface-id eni-e5aa89a3 --private-ip-addresses 10.0.0.82 ``` **Amazon EC2 が選択したセカンダリプライベート IP アドレスをネットワークインターフェイスに割り当てるには** この例では、2 つのセカンダリプライベート IP アドレスを指定されたネットワークインターフェイスに割り当てます。Amazon EC2 は、ネットワークインターフェイスが関連付けられているサブネットの CIDR ブロック範囲内にある使用可能な IP アドレスから、これらの IP アドレスを自動的に割り当てます。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 assign-private-ip-addresses --network-interface-id eni-e5aa89a3 --secondary-private-ip-address-count 2 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssignPrivateIpAddresses](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/assign-private-ip-addresses.html)」を参照してください。 ### `assign-private-nat-gateway-address` 次のコード例は、`assign-private-nat-gateway-address` を使用する方法を示しています。 **AWS CLI** **プライベート IP アドレスをプライベート NAT ゲートウェイに割り当てるには** 次の `assign-private-nat-gateway-address` の例では、指定したプライベート NAT ゲートウェイに 2 つのプライベート IP アドレスを割り当てます。 ``` aws ec2 assign-private-nat-gateway-address \ --nat-gateway-id nat-1234567890abcdef0 \ --private-ip-address-count 2 ``` 出力: ``` { "NatGatewayId": "nat-1234567890abcdef0", "NatGatewayAddresses": [ { "NetworkInterfaceId": "eni-0065a61b324d1897a", "IsPrimary": false, "Status": "assigning" }, { "NetworkInterfaceId": "eni-0065a61b324d1897a", "IsPrimary": false, "Status": "assigning" } ] } ``` 詳細については、「*Amazon VPC ユーザーガイド*」の「[NAT ゲートウェイ](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssignPrivateNatGatewayAddress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/assign-private-nat-gateway-address.html)」を参照してください。 ### `associate-address` 次のコード例は、`associate-address` を使用する方法を示しています。 **AWS CLI** **例 1: Elastic IP アドレスをインスタンスに関連付けるには** 次の `associate-address` の例では、Elastic IP アドレスを、指定した EC2 インスタンスに関連付けます。 ``` aws ec2 associate-address \ --instance-id i-0b263919b6498b123 \ --allocation-id eipalloc-64d5890a ``` 出力: ``` { "AssociationId": "eipassoc-2bebb745" } ``` **例 2: Elastic IP アドレスをネットワークインターフェイスに関連付けるには** 次の `associate-address` の例では、指定した Elastic IP アドレスを、指定したネットワークインターフェイスに関連付けます。 ``` aws ec2 associate-address --allocation-id eipalloc-64d5890a \ --network-interface-id eni-1a2b3c4d ``` 出力: ``` { "AssociationId": "eipassoc-2bebb745" } ``` **例 3: Elastic IP アドレスをプライベート IP アドレスに関連付けるには** 次の `associate-address` の例では、指定した Elastic IP アドレスを、指定したネットワークインターフェイス内の指定したプライベート IP アドレスに関連付けます。 ``` aws ec2 associate-address \ --allocation-id eipalloc-64d5890a \ --network-interface-id eni-1a2b3c4d \ --private-ip-address 10.0.0.85 ``` 出力: ``` { "AssociationId": "eipassoc-2bebb745" } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[Elastic IP アドレス](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateAddress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/associate-address.html)」を参照してください。 ### `associate-client-vpn-target-network` 次のコード例は、`associate-client-vpn-target-network` を使用する方法を示しています。 **AWS CLI** **ターゲットネットワークをクライアント VPN エンドポイントに関連付けるには** 次の `associate-client-vpn-target-network` の例では、指定したクライアント VPN エンドポイントにサブネットを関連付けます。 ``` aws ec2 associate-client-vpn-target-network \ --subnet-id subnet-0123456789abcabca \ --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde ``` 出力: ``` { "AssociationId": "cvpn-assoc-12312312312312312", "Status": { "Code": "associating" } } ``` 詳細については、「*AWS Client VPN 管理者ガイド*」の「[Target Networks](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-target.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateClientVpnTargetNetwork](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/associate-client-vpn-target-network.html)」を参照してください。 ### `associate-dhcp-options` 次のコード例は、`associate-dhcp-options` を使用する方法を示しています。 **AWS CLI** **DHCP オプションセットを VPC に関連付けるには** この例では、指定された DHCP オプションセットを指定された VPC に関連付けます。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 associate-dhcp-options --dhcp-options-id dopt-d9070ebb --vpc-id vpc-a01106c2 ``` **デフォルトの DHCP オプションセットを VPC に関連付けるには** この例では、デフォルトの DHCP オプションセットを指定された VPC に関連付けます。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 associate-dhcp-options --dhcp-options-id default --vpc-id vpc-a01106c2 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateDhcpOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/associate-dhcp-options.html)」を参照してください。 ### `associate-iam-instance-profile` 次のコード例は、`associate-iam-instance-profile` を使用する方法を示しています。 **AWS CLI** **IAM インスタンスプロファイルをインスタンスに関連付けるには** この例では、`admin-role` という名前の IAM インスタンスプロファイルをインスタンス `i-123456789abcde123` に関連付けます。 コマンド: ``` aws ec2 associate-iam-instance-profile --instance-id i-123456789abcde123 --iam-instance-profile Name=admin-role ``` 出力: ``` { "IamInstanceProfileAssociation": { "InstanceId": "i-123456789abcde123", "State": "associating", "AssociationId": "iip-assoc-0e7736511a163c209", "IamInstanceProfile": { "Id": "AIPAJBLK7RKJKWDXVHIEC", "Arn": "arn:aws:iam::123456789012:instance-profile/admin-role" } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateIamInstanceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/associate-iam-instance-profile.html)」を参照してください。 ### `associate-instance-event-window` 次のコード例は、`associate-instance-event-window` を使用する方法を示しています。 **AWS CLI** **例 1: イベントウィンドウに 1 つ以上のインスタンスを関連付けるには** 次の `associate-instance-event-window` の例では、1 つ以上のインスタンスをイベントウィンドウに関連付けます。 ``` aws ec2 associate-instance-event-window \ --region us-east-1 \ --instance-event-window-id iew-0abcdef1234567890 \ --association-target "InstanceIds=i-1234567890abcdef0,i-0598c7d356eba48d7" ``` 出力: ``` { "InstanceEventWindow": { "InstanceEventWindowId": "iew-0abcdef1234567890", "Name": "myEventWindowName", "CronExpression": "* 21-23 * * 2,3", "AssociationTarget": { "InstanceIds": [ "i-1234567890abcdef0", "i-0598c7d356eba48d7" ], "Tags": [], "DedicatedHostIds": [] }, "State": "creating" } } ``` イベントウィンドウの制約については、「*Amazon EC2 ユーザーガイド*」の予定されているイベントに関するセクションの「[考慮事項](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html#event-windows-considerations)」を参照してください。 **例 2: インスタンスタグをイベントウィンドウに関連付けるには** 次の `associate-instance-event-window` の例では、インスタンスタグをイベントウィンドウに関連付けます。`instance-event-window-id` パラメータを入力して、イベントウィンドウを指定します。インスタンスタグを関連付けるには、`association-target` パラメータを指定し、そのパラメータ値に 1 つ以上のタグを指定します。 ``` 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}]" ``` 出力: ``` { "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" } } ``` イベントウィンドウの制約については、「*Amazon EC2 ユーザーガイド*」の予定されているイベントに関するセクションの「[考慮事項](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html#event-windows-considerations)」を参照してください。 **例 3: 専有ホストをイベントウィンドウに関連付けるには** 次の `associate-instance-event-window` の例では、専有ホストをイベントウィンドウに関連付けます。`instance-event-window-id` パラメータを入力して、イベントウィンドウを指定します。専有ホストを関連付けるには、`--association-target` パラメータを指定し、そのパラメータ値に 1 つ以上の専有ホスト ID を指定します。 ``` aws ec2 associate-instance-event-window \ --region us-east-1 \ --instance-event-window-id iew-0abcdef1234567890 \ --association-target "DedicatedHostIds=h-029fa35a02b99801d" ``` 出力: ``` { "InstanceEventWindow": { "InstanceEventWindowId": "iew-0abcdef1234567890", "Name": "myEventWindowName", "CronExpression": "* 21-23 * * 2,3", "AssociationTarget": { "InstanceIds": [], "Tags": [], "DedicatedHostIds": [ "h-029fa35a02b99801d" ] }, "State": "creating" } } ``` イベントウィンドウの制約については、「*Amazon EC2 ユーザーガイド*」の予定されているイベントに関するセクションの「[考慮事項](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html#event-windows-considerations)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateInstanceEventWindow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/associate-instance-event-window.html)」を参照してください。 ### `associate-ipam-resource-discovery` 次のコード例は、`associate-ipam-resource-discovery` を使用する方法を示しています。 **AWS CLI** **リソース検出を IPAM に関連付けるには** この例では、あなたは IPAM の委任された管理者として、リソース検出が別の AWS アカウントで作成され共有されているため、IPAM を使用して他のアカウントが所有するリソース CIDR を管理およびモニタリングできます。 注記 このリクエストを完了するには、[describe-ipam-resource-discoveries](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-ipam-resource-discoveries.html) で取得できるリソース検出 ID と、[describe-ipams](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-ipams.html) で取得できる IPAM ID が必要です。関連付けるリソース検出は、まず AWS RAM を使用してアカウントと共有されている必要があります。入力する `--region` は、関連付ける IPAM のホームリージョンと一致する必要があります。 次の `associate-ipam-resource-discovery` の例では、リソース検出を 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 ``` 出力: ``` { { "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": [] } } } ``` リソース検出を関連付けると、他のアカウントで作成されたリソースの IP アドレスをモニタリングしたり管理したりできます。詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[Integrate IPAM with accounts outside of your organization](https://docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam-outside-org.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateIpamResourceDiscovery](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/associate-ipam-resource-discovery.html)」を参照してください。 ### `associate-nat-gateway-address` 次のコード例は、`associate-nat-gateway-address` を使用する方法を示しています。 **AWS CLI** **Elastic IP アドレスをパブリック NAT ゲートウェイに関連付けるには** 次の `associate-nat-gateway-address` の例では、指定した Elastic IP アドレスを指定したパブリック NAT ゲートウェイに関連付けます。AWS はセカンダリプライベート IPv4 アドレスを自動的に割り当てます。 ``` aws ec2 associate-nat-gateway-address \ --nat-gateway-id nat-1234567890abcdef0 \ --allocation-ids eipalloc-0be6ecac95EXAMPLE ``` 出力: ``` { "NatGatewayId": "nat-1234567890abcdef0", "NatGatewayAddresses": [ { "AllocationId": "eipalloc-0be6ecac95EXAMPLE", "NetworkInterfaceId": "eni-09cc4b2558794f7f9", "IsPrimary": false, "Status": "associating" } ] } ``` 詳細については、「*Amazon VPC ユーザーガイド*」の「[NAT ゲートウェイ](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateNatGatewayAddress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/associate-nat-gateway-address.html)」を参照してください。 ### `associate-route-table` 次のコード例は、`associate-route-table` を使用する方法を示しています。 **AWS CLI** **ルートテーブルをサブネットに関連付けるには** この例では、指定されたルートテーブルを指定されたサブネットに関連付けます。 コマンド: ``` aws ec2 associate-route-table --route-table-id rtb-22574640 --subnet-id subnet-9d4a7b6c ``` 出力: ``` { "AssociationId": "rtbassoc-781d0d1a" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateRouteTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/associate-route-table.html)」を参照してください。 ### `associate-security-group-vpc` 次のコード例は、`associate-security-group-vpc` を使用する方法を示しています。 **AWS CLI** **セキュリティグループを別の VPC と関連付けるには** 次の `associate-security-group-vpc` の例では、指定されたセキュリティグループを指定された VPC に関連付けます。 ``` aws ec2 associate-security-group-vpc \ --group-id sg-04dbb43907d3f8a78 \ --vpc-id vpc-0bf4c2739bc05a694 ``` 出力: ``` { "State": "associating" } ``` 詳細については、「*Amazon VPC ユーザーガイド*」の「[セキュリティグループを複数の VPC に関連付ける](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-assoc.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateSecurityGroupVpc](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/associate-security-group-vpc.html)」を参照してください。 ### `associate-subnet-cidr-block` 次のコード例は、`associate-subnet-cidr-block` を使用する方法を示しています。 **AWS CLI** **IPv6 CIDR ブロックをサブネットに関連付けるには** この例では、IPv6 CIDR ブロックを指定されたサブネットに関連付けます。 コマンド: ``` aws ec2 associate-subnet-cidr-block --subnet-id subnet-5f46ec3b --ipv6-cidr-block 2001:db8:1234:1a00::/64 ``` 出力: ``` { "SubnetId": "subnet-5f46ec3b", "Ipv6CidrBlockAssociation": { "Ipv6CidrBlock": "2001:db8:1234:1a00::/64", "AssociationId": "subnet-cidr-assoc-3aa54053", "Ipv6CidrBlockState": { "State": "associating" } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateSubnetCidrBlock](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/associate-subnet-cidr-block.html)」を参照してください。 ### `associate-transit-gateway-multicast-domain` 次のコード例は、`associate-transit-gateway-multicast-domain` を使用する方法を示しています。 **AWS CLI** **Transit Gateway をマルチキャストドメインに関連付けるには** 次の `associate-transit-gateway-multicast-domain` の例では、指定したサブネットとアタッチメントを指定したマルチキャストドメインに関連付けます。 ``` 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 ``` 出力: ``` { "Associations": { "TransitGatewayMulticastDomainId": "tgw-mcast-domain-0c4905cef79d6e597", "TransitGatewayAttachmentId": "tgw-attach-028c1dd0f8f5cbe8e", "ResourceId": "vpc-01128d2c240c09bd5", "ResourceType": "vpc", "Subnets": [ { "SubnetId": "subnet-000de86e3b49c932a", "State": "associating" } ] } } ``` 詳細については、*Transit Gateways ガイド*の「[マルチキャストドメイン](https://docs.aws.amazon.com/vpc/latest/tgw/multicast-domains-about.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateTransitGatewayMulticastDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/associate-transit-gateway-multicast-domain.html)」を参照してください。 ### `associate-transit-gateway-route-table` 次のコード例は、`associate-transit-gateway-route-table` を使用する方法を示しています。 **AWS CLI** **Transit Gateway ルートテーブルを Transit Gateway アタッチメントに関連付けるには** 次の例では、指定した Transit Gateway ルートテーブルを指定した VPC アタッチメントと関連付けます。 ``` aws ec2 associate-transit-gateway-route-table \ --transit-gateway-route-table-id tgw-rtb-002573ed1eEXAMPLE \ --transit-gateway-attachment-id tgw-attach-0b5968d3b6EXAMPLE ``` 出力: ``` { "Association": { "TransitGatewayRouteTableId": "tgw-rtb-002573ed1eEXAMPLE", "TransitGatewayAttachmentId": "tgw-attach-0b5968d3b6EXAMPLE", "ResourceId": "vpc-0065acced4EXAMPLE", "ResourceType": "vpc", "State": "associating" } } ``` 詳細については、「*AWSTransit Gateways ガイド*」の「[Associate a Transit Gateway Route Table](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html#associate-tgw-route-table)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateTransitGatewayRouteTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/associate-transit-gateway-route-table.html)」を参照してください。 ### `associate-vpc-cidr-block` 次のコード例は、`associate-vpc-cidr-block` を使用する方法を示しています。 **AWS CLI** **例 1: Amazon が提供する IPv6 CIDR ブロックを VPC に関連付けるには** 次の `associate-vpc-cidr-block` の例では、IPv6 CIDR ブロックを指定した VPC に関連付けます。 ``` 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 ``` 出力: ``` { "Ipv6CidrBlockAssociation": { "AssociationId": "vpc-cidr-assoc-0838ce7d9dEXAMPLE", "Ipv6CidrBlockState": { "State": "associating" }, "NetworkBorderGroup": "us-west-2-lax-1" }, "VpcId": "vpc-8EXAMPLE" } ``` **例 2: 追加の IPv4 CIDR ブロックを VPC に関連付けるには** 次の `associate-vpc-cidr-block` の例では、IPv4 CIDR ブロック `10.2.0.0/16` を指定した VPC に関連付けます。 ``` aws ec2 associate-vpc-cidr-block \ --vpc-id vpc-1EXAMPLE \ --cidr-block 10.2.0.0/16 ``` 出力: ``` { "CidrBlockAssociation": { "AssociationId": "vpc-cidr-assoc-2EXAMPLE", "CidrBlock": "10.2.0.0/16", "CidrBlockState": { "State": "associating" } }, "VpcId": "vpc-1EXAMPLE" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateVpcCidrBlock](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/associate-vpc-cidr-block.html)」を参照してください。 ### `attach-classic-link-vpc` 次のコード例は、`attach-classic-link-vpc` を使用する方法を示しています。 **AWS CLI** **EC2-Classic インスタンスを VPC にリンク (アタッチ) するには** この例では、VPC セキュリティグループ sg-12312312 を介してインスタンス i-1234567890abcdef0 を VPC vpc-88888888 にリンクします。 コマンド: ``` aws ec2 attach-classic-link-vpc --instance-id i-1234567890abcdef0 --vpc-id vpc-88888888 --groups sg-12312312 ``` 出力: ``` { "Return": true } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AttachClassicLinkVpc](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/attach-classic-link-vpc.html)」を参照してください。 ### `attach-internet-gateway` 次のコード例は、`attach-internet-gateway` を使用する方法を示しています。 **AWS CLI** **VPC にインターネットゲートウェイをアタッチするには** 次の `attach-internet-gateway` の例では、指定したインターネットゲートウェイを特定の VPC にアタッチします。 ``` aws ec2 attach-internet-gateway \ --internet-gateway-id igw-0d0fb496b3EXAMPLE \ --vpc-id vpc-0a60eb65b4EXAMPLE ``` このコマンドでは何も出力されません。 詳細については、*Amazon VPC ユーザーガイド*の「[インターネットゲートウェイ](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AttachInternetGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/attach-internet-gateway.html)」を参照してください。 ### `attach-network-interface` 次のコード例は、`attach-network-interface` を使用する方法を示しています。 **AWS CLI** **例 1: ネットワークインターフェイスをインスタンスにアタッチするには** 次の `attach-network-interface` の例では、指定したネットワークインターフェイスを指定したインスタンスにアタッチします。 ``` aws ec2 attach-network-interface \ --network-interface-id eni-0dc56a8d4640ad10a \ --instance-id i-1234567890abcdef0 \ --device-index 1 ``` 出力: ``` { "AttachmentId": "eni-attach-01a8fc87363f07cf9" } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[Elastic Network Interface](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html)」を参照してください。 **例 2: ネットワークインターフェイスを複数のネットワークを持つインスタンスにアタッチするには** 次の `attach-network-interface` の例では、指定したネットワークインターフェイスを指定したインスタンスとネットワークカードにアタッチします。 ``` aws ec2 attach-network-interface \ --network-interface-id eni-07483b1897541ad83 \ --instance-id i-01234567890abcdef \ --network-card-index 1 \ --device-index 1 ``` 出力: ``` { "AttachmentId": "eni-attach-0fbd7ee87a88cd06c" } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[Elastic Network Interface](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AttachNetworkInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/attach-network-interface.html)」を参照してください。 ### `attach-verified-access-trust-provider` 次のコード例は、`attach-verified-access-trust-provider` を使用する方法を示しています。 **AWS CLI** **信頼プロバイダーをインスタンスにアタッチするには** 次の `attach-verified-access-trust-provider` の例では、指定した Verified Access 信頼プロバイダーを指定した Verified Access インスタンスにアタッチします。 ``` aws ec2 attach-verified-access-trust-provider \ --verified-access-instance-id vai-0ce000c0b7643abea \ --verified-access-trust-provider-id vatp-0bb32de759a3e19e7 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWSVerified Access ユーザーガイド*」の「[Access インスタンス](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-instances.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AttachVerifiedAccessTrustProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/attach-verified-access-trust-provider.html)」を参照してください。 ### `attach-volume` 次のコード例は、`attach-volume` を使用する方法を示しています。 **AWS CLI** **ボリュームをインスタンスにアタッチするには** この例では、ボリューム (`vol-1234567890abcdef0`) を `/dev/sdf` としてインスタンス (`i-01474ef662b89480`) にアタッチします。 コマンド: ``` aws ec2 attach-volume --volume-id vol-1234567890abcdef0 --instance-id i-01474ef662b89480 --device /dev/sdf ``` 出力: ``` { "AttachTime": "YYYY-MM-DDTHH:MM:SS.000Z", "InstanceId": "i-01474ef662b89480", "VolumeId": "vol-1234567890abcdef0", "State": "attaching", "Device": "/dev/sdf" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AttachVolume](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/attach-volume.html)」を参照してください。 ### `attach-vpn-gateway` 次のコード例は、`attach-vpn-gateway` を使用する方法を示しています。 **AWS CLI** **仮想プライベートゲートウェイを VPC にアタッチするには** 次の `attach-vpn-gateway` の例では、指定した仮想ゲートウェイを指定した VPC にアタッチします。 ``` aws ec2 attach-vpn-gateway \ --vpn-gateway-id vgw-9a4cacf3 \ --vpc-id vpc-a01106c2 ``` 出力: ``` { "VpcAttachment": { "State": "attaching", "VpcId": "vpc-a01106c2" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AttachVpnGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/attach-vpn-gateway.html)」を参照してください。 ### `authorize-client-vpn-ingress` 次のコード例は、`authorize-client-vpn-ingress` を使用する方法を示しています。 **AWS CLI** **クライアント VPN エンドポイントに承認ルールを追加するには** 次の `authorize-client-vpn-ingress` の例では、すべてのユーザーにインターネット (`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 ``` 出力: ``` { "Status": { "Code": "authorizing" } } ``` 詳細については、「*AWS Client VPN 管理者ガイド*」の「[Authorization Rules](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-rules.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AuthorizeClientVpnIngress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/authorize-client-vpn-ingress.html)」を参照してください。 ### `authorize-security-group-egress` 次のコード例は、`authorize-security-group-egress` を使用する方法を示しています。 **AWS CLI** **例 1: 特定のアドレス範囲へのアウトバウンドトラフィックを許可するルールを追加するには** 次の `authorize-security-group-egress` の例では、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}]' ``` 出力: ``` { "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" } ] } ``` **例 2: 特定のセキュリティグループへのアウトバウンドトラフィックを許可するルールを追加するには** 次の `authorize-security-group-egress` の例では、TCP ポート 80 で、指定したセキュリティグループへのアクセスを許可するルールを追加します。 ``` aws ec2 authorize-security-group-egress \ --group-id sg-1234567890abcdef0 \ --ip-permissions 'IpProtocol=tcp,FromPort=80,ToPort=80,UserIdGroupPairs=[{GroupId=sg-0aad1c26bbeec5c22}]' ``` 出力: ``` { "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" } } ] } ``` 詳細については、*アマゾン VPC ユーザーガイド*の「[セキュリティグループのルール](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-security-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AuthorizeSecurityGroupEgress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/authorize-security-group-egress.html)」を参照してください。 ### `authorize-security-group-ingress` 次のコード例は、`authorize-security-group-ingress` を使用する方法を示しています。 **AWS CLI** **例 1: インバウンド SSH トラフィックを許可するルールを追加するには** 次の `authorize-security-group-ingress` の例では、TCP ポート 22 (SSH) にインバウンドトラフィックを許可するルールを追加します。 ``` aws ec2 authorize-security-group-ingress \ --group-id sg-1234567890abcdef0 \ --protocol tcp \ --port 22 \ --cidr 203.0.113.0/24 ``` 出力: ``` { "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" } ] } ``` **例 2: セキュリティグループからの HTTP トラフィックを許可するルールを追加するには** 次の `authorize-security-group-ingress` の例では、ソースセキュリティグループ `sg-1a2b3c4d` からの TCP ポート 80 へのインバウンドアクセスを許可するルールを追加します。ソースグループは、同じ VPC にあるか、ピア VPC (VPC ピアリング接続が必要) に存在している必要があります。着信トラフィックは、ソースセキュリティグループに関連付けられたインスタンスのプライベート IP アドレスに基づいて許可されます (パブリック IP アドレスまたは Elastic IP アドレスは考慮されません)。 ``` aws ec2 authorize-security-group-ingress \ --group-id sg-1234567890abcdef0 \ --protocol tcp \ --port 80 \ --source-group sg-1a2b3c4d ``` 出力: ``` { "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" } } ] } ``` **例 3: 同じ呼び出しに複数のルールを追加するには** 次の `authorize-security-group-ingress` の例では、`ip-permissions` パラメータを使用して 2 つのインバウンドルールを追加します。一方は TCP ポート 3389 (RDP) でのインバウンドアクセスを有効にするルールであり、もう一方は ping/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}]' ``` 出力: ``` { "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" } ] } ``` **例 4: ICMP トラフィックのルールを追加するには** 次の `authorize-security-group-ingress` の例では、`ip-permissions` パラメータを使用して、どこからでも ICMP メッセージ `Destination Unreachable: Fragmentation Needed and Don't Fragment was Set` (タイプ 3、コード 4) を許可するインバウンドルールを追加します。 ``` 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}]' ``` 出力: ``` { "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" } ] } ``` **例 5: IPv6 トラフィックのルールを追加するには** 次の `authorize-security-group-ingress` の例では、`ip-permissions` パラメータを使用して、IPv6 範囲 `2001:db8:1234:1a00::/64` からの SSH アクセス (ポート 22) を許可するインバウンドルールを追加します。 ``` 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}]' ``` 出力: ``` { "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" } ] } ``` **例 6: ICMPv6 トラフィックのルールを追加するには** 次の `authorize-security-group-ingress` の例では、`ip-permissions` パラメータを使用して、どこからでも ICMPv6 トラフィックを許可するインバウンドルールを追加します。 ``` aws ec2 authorize-security-group-ingress \ --group-id sg-1234567890abcdef0 \ --ip-permissions 'IpProtocol=icmpv6,Ipv6Ranges=[{CidrIpv6=::/0}]' ``` 出力: ``` { "Return": true, "SecurityGroupRules": [ { "SecurityGroupRuleId": "sgr-04b612d9363ab6327", "GroupId": "sg-1234567890abcdef0", "GroupOwnerId": "123456789012", "IsEgress": false, "IpProtocol": "icmpv6", "FromPort": -1, "ToPort": -1, "CidrIpv6": "::/0" } ] } ``` **例 7: 説明付きのルールを追加する** 次の `authorize-security-group-ingress` の例では、`ip-permissions` パラメータを使用して、指定した IPv4 アドレス範囲からの RDP トラフィックを許可するインバウンドルールを追加します。ルールには、後で特定できるように説明が含まれます。 ``` 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'}]' ``` 出力: ``` { "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" } ] } ``` **例 8: プレフィックスリストを使用するインバウンドルールを追加するには** 次の `authorize-security-group-ingress` の例では、`ip-permissions` パラメータを使用して、指定されたプレフィックスリスト内の CIDR 範囲のトラフィックすべてを許可するインバウンドルールを追加します。 ``` aws ec2 authorize-security-group-ingress \ --group-id sg-04a351bfe432d4e71 \ --ip-permissions 'IpProtocol=all,PrefixListIds=[{PrefixListId=pl-002dc3ec097de1514}]' ``` 出力: ``` { "Return": true, "SecurityGroupRules": [ { "SecurityGroupRuleId": "sgr-09c74b32f677c6c7c", "GroupId": "sg-1234567890abcdef0", "GroupOwnerId": "123456789012", "IsEgress": false, "IpProtocol": "-1", "FromPort": -1, "ToPort": -1, "PrefixListId": "pl-0721453c7ac4ec009" } ] } ``` 詳細については、*アマゾン VPC ユーザーガイド*の「[セキュリティグループのルール](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-security-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AuthorizeSecurityGroupIngress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/authorize-security-group-ingress.html)」を参照してください。 ### `bundle-instance` 次のコード例は、`bundle-instance` を使用する方法を示しています。 **AWS CLI** **インスタンスをバンドルするには** この例では、`bundletasks` という名前のバケットにインスタンス `i-1234567890abcdef0` をバンドルします。アクセスキー ID に値を指定する前に、AWS アクセスキーの管理に関するベストプラクティスを確認し、それに従います。 コマンド: ``` aws ec2 bundle-instance --instance-id i-1234567890abcdef0 --bucket bundletasks --prefix winami --owner-akid AK12AJEXAMPLE --owner-sak example123example ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BundleInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/bundle-instance.html)」を参照してください。 ### `cancel-bundle-task` 次のコード例は、`cancel-bundle-task` を使用する方法を示しています。 **AWS CLI** **バンドルタスクをキャンセルするには** この例では、バンドルタスク `bun-2a4e041c` をキャンセルします。 コマンド: ``` aws ec2 cancel-bundle-task --bundle-id bun-2a4e041c ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelBundleTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/cancel-bundle-task.html)」を参照してください。 ### `cancel-capacity-reservation-fleets` 次のコード例は、`cancel-capacity-reservation-fleets` を使用する方法を示しています。 **AWS CLI** **キャパシティ予約フリートをキャンセルするには** 次の `cancel-capacity-reservation-fleets` の例では、指定したキャパシティ予約フリートとそれが予約するキャパシティをキャンセルします。フリートをキャンセルすると、そのステータスが `cancelled` に変わり、キャパシティ予約を新たに作成することはできなくなります。さらに、フリート内の個々のキャパシティ予約はすべてキャンセルされます。また、以前にリザーブドキャパシティで実行されていたインスタンスは、共有キャパシティを使用して正常に実行が継続されます。 ``` aws ec2 cancel-capacity-reservation-fleets \ --capacity-reservation-fleet-ids crf-abcdef01234567890 ``` 出力: ``` { "SuccessfulFleetCancellations": [ { "CurrentFleetState": "cancelling", "PreviousFleetState": "active", "CapacityReservationFleetId": "crf-abcdef01234567890" } ], "FailedFleetCancellations": [] } ``` キャパシティ予約フリートの詳細については、「*Amazon EC2 ユーザーガイド*」の「[キャパシティ予約フリート](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-fleets.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelCapacityReservationFleets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/cancel-capacity-reservation-fleets.html)」を参照してください。 ### `cancel-capacity-reservation` 次のコード例は、`cancel-capacity-reservation` を使用する方法を示しています。 **AWS CLI** **キャパシティ予約をキャンセルするには** 次の `cancel-capacity-reservation` の例では、指定したキャパシティ予約をキャンセルします。 ``` aws ec2 cancel-capacity-reservation \ --capacity-reservation-id cr-1234abcd56EXAMPLE ``` 出力: ``` { "Return": true } ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[キャパシティ予約のキャンセル](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-release.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelCapacityReservation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/cancel-capacity-reservation.html)」を参照してください。 ### `cancel-conversion-task` 次のコード例は、`cancel-conversion-task` を使用する方法を示しています。 **AWS CLI** **インスタンスまたはボリュームのアクティブな変換をキャンセルするには** この例では、タスク ID import-i-fh95npoc に関連付けられたアップロードをキャンセルします。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 cancel-conversion-task --conversion-task-id import-i-fh95npoc ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelConversionTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/cancel-conversion-task.html)」を参照してください。 ### `cancel-export-task` 次のコード例は、`cancel-export-task` を使用する方法を示しています。 **AWS CLI** **アクティブなエクスポートタスクをキャンセルするには** この例では、タスク ID export-i-fgelt0i7 を使用してアクティブなエクスポートタスクをキャンセルします。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 cancel-export-task --export-task-id export-i-fgelt0i7 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelExportTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/cancel-export-task.html)」を参照してください。 ### `cancel-image-launch-permission` 次のコード例は、`cancel-image-launch-permission` を使用する方法を示しています。 **AWS CLI** **Amazon Web Services アカウントとの AMI の共有をキャンセルするには** 次の `cancel-image-launch-permission` の例では、指定した AMI 起動許可からアカウントが削除されます。 ``` aws ec2 cancel-image-launch-permission \ --image-id ami-0123456789example \ --region us-east-1 ``` 出力: ``` { "Return": true } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[Cancel having an AMI shared with your Amazon Web Services account](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cancel-sharing-an-AMI.html#cancel-image-launch-permission)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelImageLaunchPermission](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/cancel-image-launch-permission.html)」を参照してください。 ### `cancel-import-task` 次のコード例は、`cancel-import-task` を使用する方法を示しています。 **AWS CLI** **インポートタスクをキャンセルするには** 次の `cancel-import-task` の例では、指定したイメージのインポートタスクをキャンセルします。 ``` aws ec2 cancel-import-task \ --import-task-id import-ami-1234567890abcdef0 ``` 出力: ``` { "ImportTaskId": "import-ami-1234567890abcdef0", "PreviousState": "active", "State": "deleting" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelImportTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/cancel-import-task.html)」を参照してください。 ### `cancel-reserved-instances-listing` 次のコード例は、`cancel-reserved-instances-listing` を使用する方法を示しています。 **AWS CLI** **リザーブドインスタンスのリストをキャンセルするには** 次の `cancel-reserved-instances-listing` の例では、指定したリザーブドインスタンスのリストをキャンセルします。 ``` aws ec2 cancel-reserved-instances-listing \ --reserved-instances-listing-id 5ec28771-05ff-4b9b-aa31-9e57dexample ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelReservedInstancesListing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/cancel-reserved-instances-listing.html)」を参照してください。 ### `cancel-spot-fleet-requests` 次のコード例は、`cancel-spot-fleet-requests` を使用する方法を示しています。 **AWS CLI** **例 1: スポットフリートリクエストをキャンセルし、関連付けられたインスタンスを終了するには** 次の `cancel-spot-fleet-requests` の例では、スポットフリートリクエストをキャンセルし、関連付けられたオンデマンドインスタンスとスポットインスタンスを終了します。 ``` aws ec2 cancel-spot-fleet-requests \ --spot-fleet-request-ids sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE \ --terminate-instances ``` 出力: ``` { "SuccessfulFleetRequests": [ { "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", "CurrentSpotFleetRequestState": "cancelled_terminating", "PreviousSpotFleetRequestState": "active" } ], "UnsuccessfulFleetRequests": [] } ``` **例 2: 関連付けられたインスタンスを終了せずに、スポットフリートリクエストをキャンセルするには** 次の `cancel-spot-fleet-requests` の例では、関連付けられたオンデマンドインスタンスとスポットインスタンスを終了しないで、スポットフリートリクエストをキャンセルします。 ``` aws ec2 cancel-spot-fleet-requests \ --spot-fleet-request-ids sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE \ --no-terminate-instances ``` 出力: ``` { "SuccessfulFleetRequests": [ { "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", "CurrentSpotFleetRequestState": "cancelled_running", "PreviousSpotFleetRequestState": "active" } ], "UnsuccessfulFleetRequests": [] } ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[スポットフリートリクエストのキャンセル](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cancel-spot-fleet.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelSpotFleetRequests](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/cancel-spot-fleet-requests.html)」を参照してください。 ### `cancel-spot-instance-requests` 次のコード例は、`cancel-spot-instance-requests` を使用する方法を示しています。 **AWS CLI** **スポットインスタンスリクエストをキャンセルするには** このコマンド例では、スポットインスタンスリクエストをキャンセルします。 コマンド: ``` aws ec2 cancel-spot-instance-requests --spot-instance-request-ids sir-08b93456 ``` 出力: ``` { "CancelledSpotInstanceRequests": [ { "State": "cancelled", "SpotInstanceRequestId": "sir-08b93456" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelSpotInstanceRequests](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/cancel-spot-instance-requests.html)」を参照してください。 ### `confirm-product-instance` 次のコード例は、`confirm-product-instance` を使用する方法を示しています。 **AWS CLI** **製品インスタンスを確認するには** この例では、指定された製品コードが指定されたインスタンスに関連付けられているかどうかを判断します。 コマンド: ``` aws ec2 confirm-product-instance --product-code 774F4FF8 --instance-id i-1234567890abcdef0 ``` 出力: ``` { "OwnerId": "123456789012" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ConfirmProductInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/confirm-product-instance.html)」を参照してください。 ### `copy-fpga-image` 次のコード例は、`copy-fpga-image` を使用する方法を示しています。 **AWS CLI** **Amazon FPGA イメージをコピーするには** この例では、指定された AFI を `us-east-1` リージョンから現在のリージョン (`eu-west-1`) にコピーします。 コマンド: ``` aws ec2 copy-fpga-image --name copy-afi --source-fpga-image-id afi-0d123e123bfc85abc --source-region us-east-1 --region eu-west-1 ``` 出力: ``` { "FpgaImageId": "afi-06b12350a123fbabc" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CopyFpgaImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/copy-fpga-image.html)」を参照してください。 ### `copy-image` 次のコード例は、`copy-image` を使用する方法を示しています。 **AWS CLI** **例 1: AMI を別のリージョンにコピーするには** 次の `copy-image` の例では、指定した AMI を `us-west-2` リージョンから `us-east-1` リージョンにコピーし、簡単な説明を追加します。 ``` 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." ``` 出力: ``` { "ImageId": "ami-0123456789abcdefg" } ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[AMI のコピー](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html)」を参照してください。 **例 2: AMI を別のリージョンにコピーし、バッキングスナップショットを暗号化するには** 次の `copy-image` コマンドは、指定した AMI を `us-west-2` リージョンから現在のリージョンにコピーし、指定した KMS キーを使用してバックアップするスナップショットを暗号化します。 ``` 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 ``` 出力: ``` { "ImageId": "ami-0123456789abcdefg" } ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[AMI のコピー](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html)」を参照してください。 **例 3: AMI のコピー時にユーザー定義の AMI タグを含めるには** 次の `copy-image` コマンドは、`--copy-image-tags` パラメータを使用して、AMI のコピー時にユーザー定義の 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 ``` 出力: ``` { "ImageId": "ami-0123456789abcdefg" } ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[AMI のコピー](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CopyImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/copy-image.html)」を参照してください。 ### `copy-snapshot` 次のコード例は、`copy-snapshot` を使用する方法を示しています。 **AWS CLI** **例 1: スナップショットを別のリージョンにコピーするには** 次の `copy-snapshot` の例では、指定したスナップショットを `us-west-2` リージョンから `us-east-1` リージョンにコピーし、簡単な説明を追加します。 ``` aws ec2 copy-snapshot \ --region us-east-1 \ --source-region us-west-2 \ --source-snapshot-id snap-066877671789bd71b \ --description 'This is my copied snapshot.' ``` 出力: ``` { "SnapshotId": "snap-066877671789bd71b" } ``` **例 2: 暗号化されていないスナップショットをコピーし、新しいスナップショットを暗号化するには** 次の `copy-snapshot` コマンドは、指定した暗号化されていないスナップショットを `us-west-2` リージョンから現在のリージョンにコピーし、指定した KMS キーを使用してバックアップするスナップショットを暗号化します。 ``` aws ec2 copy-snapshot \ --source-region us-west-2 \ --source-snapshot-id snap-066877671789bd71b \ --encrypted \ --kms-key-id alias/my-kms-key ``` 出力: ``` { "SnapshotId": "snap-066877671789bd71b" } ``` 詳細については、*Amazon EBS ユーザーガイド*の「[Amazon EBS スナップショットのコピー](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-copy-snapshot.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CopySnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/copy-snapshot.html)」を参照してください。 ### `create-capacity-reservation-fleet` 次のコード例は、`create-capacity-reservation-fleet` を使用する方法を示しています。 **AWS CLI** **キャパシティ予約フリートを作成するには** 次の `create-capacity-reservation-fleet` の例では、リクエストで指定したインスタンスタイプのキャパシティ予約フリートを、指定した合計ターゲット容量を上限として作成します。キャパシティ予約フリートがキャパシティを予約するインスタンスの数は、リクエストで指定する合計ターゲット容量とインスタンスタイプの重みによって異なります。使用するインスタンスタイプと、指定された各インスタンスタイプの優先度を指定します。 ``` 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 ``` `instanceTypeSpecification.json` の内容: ``` [ { "InstanceType": "m5.xlarge", "InstancePlatform": "Linux/UNIX", "Weight": 3.0, "AvailabilityZone":"us-east-1a", "EbsOptimized": true, "Priority" : 1 } ] ``` 出力: ``` { "Status": "submitted", "TotalFulfilledCapacity": 0.0, "CapacityReservationFleetId": "crf-abcdef01234567890", "TotalTargetCapacity": 24 } ``` キャパシティ予約フリートの詳細については、「*Amazon EC2 ユーザーガイド*」の「[キャパシティ予約フリート](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-fleets.html)」を参照してください。 インスタンスタイプの重みと合計ターゲット容量の詳細については、「*Amazon EC2 ユーザーガイド*」の「[インスタンスタイプの重み](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#instance-weight)」と「[総ターゲット容量](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity)」を参照してください。 指定されたインスタンスタイプの優先順位の指定の詳細については、「*Amazon EC2 ユーザーガイド*」の「[配分戦略](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#allocation-strategy)」と「[インスタンスタイプ優先順位](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#instance-priority)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCapacityReservationFleet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-capacity-reservation-fleet.html)」を参照してください。 ### `create-capacity-reservation` 次のコード例は、`create-capacity-reservation` を使用する方法を示しています。 **AWS CLI** **例 1: キャパシティ予約を作成するには** 次の `create-capacity-reservation` の例では、`eu-west-1a` アベイラビリティーゾーンにキャパシティ予約を作成します。そこでは、Linux/Unix オペレーティングシステムを実行している 3 つの `t2.medium` インスタンスを起動できます。デフォルトでは、キャパシティ予約はオープンインスタンス一致基準で作成され、エフェメラルストレージはサポートされません。手動でキャンセルされるまでアクティブな状態を維持します。 ``` aws ec2 create-capacity-reservation \ --availability-zone eu-west-1a \ --instance-type t2.medium \ --instance-platform Linux/UNIX \ --instance-count 3 ``` 出力: ``` { "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" } } ``` **例 2: 指定した日付/時刻に自動的に終了するキャパシティ予約を作成するには** 次の `create-capacity-reservation` の例では、`eu-west-1a` アベイラビリティーゾーンにキャパシティ予約を作成します。そこでは、Linux/Unix オペレーティングシステムを実行している 3 つの `m5.large` インスタンスを起動できます。このキャパシティ予約は、2019/8/31 の 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 ``` 出力: ``` { "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" } } ``` **例 3: 対象インスタンスの起動のみを受け入れるキャパシティ予約を作成するには** 次の `create-capacity-reservation` の例では、対象インスタンスの起動のみを承諾するキャパシティ予約を作成します。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[ キャパシティ予約の作成](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-using.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCapacityReservation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-capacity-reservation.html)」を参照してください。 ### `create-carrier-gateway` 次のコード例は、`create-carrier-gateway` を使用する方法を示しています。 **AWS CLI** **キャリアゲートウェイを作成するには** 次の `create-carrier-gateway` の例では、指定した VPC のキャリアゲートウェイを作成します。 ``` aws ec2 create-carrier-gateway \ --vpc-id vpc-0c529aEXAMPLE1111 ``` 出力: ``` { "CarrierGateway": { "CarrierGatewayId": "cagw-0465cdEXAMPLE1111", "VpcId": "vpc-0c529aEXAMPLE1111", "State": "pending", "OwnerId": "123456789012" } } ``` 詳細については、「*AWS Wavelength ユーザーガイド*」の「[Carrier gateways](https://docs.aws.amazon.com/wavelength/latest/developerguide/carrier-gateways.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCarrierGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-carrier-gateway.html)」を参照してください。 ### `create-client-vpn-endpoint` 次のコード例は、`create-client-vpn-endpoint` を使用する方法を示しています。 **AWS CLI** **クライアント VPN エンドポイントを作成するには** 次の `create-client-vpn-endpoint` の例では、相互認証を使用するクライアント VPN エンドポイントを作成し、クライアント CIDR ブロックの値を指定します。 ``` 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 ``` 出力: ``` { "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde", "Status": { "Code": "pending-associate" }, "DnsName": "cvpn-endpoint-123456789123abcde.prod.clientvpn.ap-south-1.amazonaws.com" } ``` 詳細については、「*AWS Client VPN 管理者ガイド*」の「[Client VPN Endpoints](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-endpoints.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateClientVpnEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-client-vpn-endpoint.html)」を参照してください。 ### `create-client-vpn-route` 次のコード例は、`create-client-vpn-route` を使用する方法を示しています。 **AWS CLI** **クライアント VPN エンドポイントのルートを作成するには** 次の `create-client-vpn-route` の例では、クライアント VPN エンドポイントの指定されたサブネット用にインターネット (`0.0.0.0/0`) へのルートを追加します。 ``` 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 ``` 出力: ``` { "Status": { "Code": "creating" } } ``` 詳細については、「*AWS Client VPN 管理者ガイド*」の「[Routes](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-routes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateClientVpnRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-client-vpn-route.html)」を参照してください。 ### `create-coip-cidr` 次のコード例は、`create-coip-cidr` を使用する方法を示しています。 **AWS CLI** **顧客所有の IP (CoIP) アドレスの範囲を作成するには** 次の `create-coip-cidr` の例では、指定した CoIP プールに指定した CoIP アドレスの範囲を作成します。 ``` aws ec2 create-coip-cidr \ --cidr 15.0.0.0/24 \ --coip-pool-id ipv4pool-coip-1234567890abcdefg ``` 出力: ``` { "CoipCidr": { "Cidr": "15.0.0.0/24", "CoipPoolId": "ipv4pool-coip-1234567890abcdefg", "LocalGatewayRouteTableId": "lgw-rtb-abcdefg1234567890" } } ``` CoIP の詳細については、「*AWS Outposts ユーザーガイド*」の「[カスタマー所有の IP アドレス](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCoipCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-coip-cidr.html)」を参照してください。 ### `create-coip-pool` 次のコード例は、`create-coip-pool` を使用する方法を示しています。 **AWS CLI** **顧客所有の IP (CoIP) アドレスのプールを作成するには** 次の `create-coip-pool` の例では、指定したローカルゲートウェイのルートテーブルに CoIP アドレスの CoIP プールを作成します。 ``` aws ec2 create-coip-pool \ --local-gateway-route-table-id lgw-rtb-abcdefg1234567890 ``` 出力: ``` { "CoipPool": { "PoolId": "ipv4pool-coip-1234567890abcdefg", "LocalGatewayRouteTableId": "lgw-rtb-abcdefg1234567890", "PoolArn": "arn:aws:ec2:us-west-2:123456789012:coip-pool/ipv4pool-coip-1234567890abcdefg" } } ``` CoIP の詳細については、「*AWS Outposts ユーザーガイド*」の「[カスタマー所有の IP アドレス](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCoipPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-coip-pool.html)」を参照してください。 ### `create-customer-gateway` 次のコード例は、`create-customer-gateway` を使用する方法を示しています。 **AWS CLI** **カスタマーゲートウェイを作成するには** この例では、外部インターフェイスに指定された IP アドレスを持つカスタマーゲートウェイを作成します。 コマンド: ``` aws ec2 create-customer-gateway --type ipsec.1 --public-ip 12.1.2.3 --bgp-asn 65534 ``` 出力: ``` { "CustomerGateway": { "CustomerGatewayId": "cgw-0e11f167", "IpAddress": "12.1.2.3", "State": "available", "Type": "ipsec.1", "BgpAsn": "65534" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCustomerGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-customer-gateway.html)」を参照してください。 ### `create-default-subnet` 次のコード例は、`create-default-subnet` を使用する方法を示しています。 **AWS CLI** **デフォルトのサブネットを作成するには** この例では、アベイラビリティーゾーン `us-east-2a` にデフォルトのサブネットを作成します。 コマンド: ``` 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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDefaultSubnet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-default-subnet.html)」を参照してください。 ### `create-default-vpc` 次のコード例は、`create-default-vpc` を使用する方法を示しています。 **AWS CLI** **デフォルトの VPC を作成するには** この例では、デフォルトの VPC を作成します。 コマンド: ``` aws ec2 create-default-vpc ``` 出力: ``` { "Vpc": { "VpcId": "vpc-8eaae5ea", "InstanceTenancy": "default", "Tags": [], "Ipv6CidrBlockAssociationSet": [], "State": "pending", "DhcpOptionsId": "dopt-af0c32c6", "CidrBlock": "172.31.0.0/16", "IsDefault": true } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDefaultVpc](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-default-vpc.html)」を参照してください。 ### `create-dhcp-options` 次のコード例は、`create-dhcp-options` を使用する方法を示しています。 **AWS CLI** **DHCP オプションセットを作成するには** 次の `create-dhcp-options` の例では、ドメイン名、ドメインネームサーバー、NetBIOS ノードタイプを指定する DHCP オプションセットを作成します。 ``` 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" ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDhcpOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-dhcp-options.html)」を参照してください。 ### `create-egress-only-internet-gateway` 次のコード例は、`create-egress-only-internet-gateway` を使用する方法を示しています。 **AWS CLI** **Egress-Only インターネットゲートウェイを作成するには** この例では、指定した VPC の Egress-only インターネットゲートウェイを作成します。 コマンド: ``` aws ec2 create-egress-only-internet-gateway --vpc-id vpc-0c62a468 ``` 出力: ``` { "EgressOnlyInternetGateway": { "EgressOnlyInternetGatewayId": "eigw-015e0e244e24dfe8a", "Attachments": [ { "State": "attached", "VpcId": "vpc-0c62a468" } ] } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateEgressOnlyInternetGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-egress-only-internet-gateway.html)」を参照してください。 ### `create-fleet` 次のコード例は、`create-fleet` を使用する方法を示しています。 **AWS CLI** **例 1: スポットインスタンスをデフォルトの購入モデルとして起動する EC2 フリートを作成するには** 次の `create-fleet` の例では、フリートを起動するのに必要な最小限のパラメータ (起動テンプレート、ターゲット容量、デフォルト購入モデル) を使用して EC2 フリートを作成します。起動テンプレートは、起動テンプレート ID とバージョン番号によって識別されます。フリートのターゲット容量は 2 個のインスタンスであり、デフォルト購入モデルは `spot` です。この結果、フリートは 2 個のスポットインスタンスを起動します。 EC2 フリート を作成するときは、JSON ファイルを使用して起動するインスタンスについての情報を指定します。 ``` aws ec2 create-fleet \ --cli-input-json file://file_name.json ``` file\$1name.json の内容: ``` { "LaunchTemplateConfigs": [ { "LaunchTemplateSpecification": { "LaunchTemplateId": "lt-0e8c754449b27161c", "Version": "1" } } ], "TargetCapacitySpecification": { "TotalTargetCapacity": 2, "DefaultTargetCapacityType": "spot" } } ``` 出力: ``` { "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" } ``` **例 2: オンデマンドインスタンスをデフォルトの購入モデルとして起動する EC2 フリートを作成するには** 次の `create-fleet` の例では、フリートを起動するのに必要な最小限のパラメータ (起動テンプレート、ターゲット容量、デフォルト購入モデル) を使用して EC2 フリートを作成します。起動テンプレートは、起動テンプレート ID とバージョン番号によって識別されます。フリートのターゲット容量は 2 個のインスタンスであり、デフォルト購入モデルは `on-demand` です。この結果、フリートは 2 個のオンデマンドインスタンス を起動します。 EC2 フリート を作成するときは、JSON ファイルを使用して起動するインスタンスについての情報を指定します。 ``` aws ec2 create-fleet \ --cli-input-json file://file_name.json ``` file\$1name.json の内容: ``` { "LaunchTemplateConfigs": [ { "LaunchTemplateSpecification": { "LaunchTemplateId": "lt-0e8c754449b27161c", "Version": "1" } } ], "TargetCapacitySpecification": { "TotalTargetCapacity": 2, "DefaultTargetCapacityType": "on-demand" } } ``` 出力: ``` { "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" } ``` **例 3: オンデマンドインスタンスをプライマリキャパシティとして起動する EC2 フリートを作成するには** 次の `create-fleet` の例では、フリートの合計ターゲット容量を 2 つのインスタンス、ターゲット容量を 1 つのオンデマンドインスタンスとして指定する EC2 フリートを作成します。デフォルトの購入モデルは `spot` です。フリートは指定されたとおり 1 個のオンデマンドインスタンス を起動しますが、合計ターゲット容量を満たすために、さらに 1 個以上のインスタンスを起動する必要があります。差額の購入モデルは、`TotalTargetCapacity` - `OnDemandTargetCapacity` = `DefaultTargetCapacityType` で計算されます。この結果、フリートは 1 個のスポットインスタンスを起動します。 EC2 フリート を作成するときは、JSON ファイルを使用して起動するインスタンスについての情報を指定します。 ``` aws ec2 create-fleet \ --cli-input-json file://file_name.json ``` file\$1name.json の内容: ``` { "LaunchTemplateConfigs": [ { "LaunchTemplateSpecification": { "LaunchTemplateId": "lt-0e8c754449b27161c", "Version": "1" } } ], "TargetCapacitySpecification": { "TotalTargetCapacity": 2, "OnDemandTargetCapacity":1, "DefaultTargetCapacityType": "spot" } } ``` 出力: ``` { "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" } ``` **例 4: 最低料金割り当て戦略を使用してスポットインスタンスを起動する EC2 フリートを作成するには** スポットインスタンスの配分戦略を指定しない場合、デフォルト配分戦略である `lowest-price` が使用されます。次の `create-fleet` の例では、`lowest-price` 割り当て戦略を使用して EC2 フリートを作成します。起動テンプレートをオーバーライドする 3 つの起動条件は、インスタンスタイプが異なりますが、加重容量とサブネットは同じです。合計ターゲット容量は 2 個のインスタンスで、デフォルト購入モデルは `spot` です。EC2 フリートは、最低価格の起動条件のインスタンスタイプを使用して 2 つのスポットインスタンスを起動します。 EC2 フリート を作成するときは、JSON ファイルを使用して起動するインスタンスについての情報を指定します。 ``` 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" } } ``` 出力: ``` { "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateFleet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-fleet.html)」を参照してください。 ### `create-flow-logs` 次のコード例は、`create-flow-logs` を使用する方法を示しています。 **AWS CLI** **例 1: フローログを作成するには** 次の `create-flow-logs` の例では、指定したネットワークインターフェイスについて拒否されたすべてのトラフィックをキャプチャするフローログを作成します。フローログは、指定された IAM ロールのアクセス許可を使用して CloudWatch Logs のロググループに配信されます。 ``` 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 ``` 出力: ``` { "ClientToken": "so0eNA2uSHUNlHI0S2cJ305GuIX1CezaRdGtexample", "FlowLogIds": [ "fl-12345678901234567" ], "Unsuccessful": [] } ``` 詳細については、「*Amazon VPC ユーザーガイド*」の「[VPC フローログ](https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html)」を参照してください。 **例 2: カスタム形式でフローログを作成するには** 次の `create-flow-logs` の例では、指定した VPC のすべてのトラフィックをキャプチャするフローログを作成し、そのフローログを Amazon S3 バケットに配信します。`--log-format` パラメータにより、フローログレコードのカスタム形式が指定されます。Windows でこのコマンドを実行するには、一重引用符 (') を二重引用符 (") に変更します。 ``` 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}' ``` 詳細については、「*Amazon VPC ユーザーガイド*」の「[VPC フローログ](https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html)」を参照してください。 **例 3: 1 分間の最大集計間隔でフローログを作成するには** 次の `create-flow-logs` の例では、指定した VPC のすべてのトラフィックをキャプチャするフローログを作成し、そのフローログを Amazon S3 バケットに配信します。`--max-aggregation-interval` パラメータは、最大集約間隔を 60 秒 (1 分) に指定します。 ``` 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 ``` 詳細については、「*Amazon VPC ユーザーガイド*」の「[VPC フローログ](https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateFlowLogs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-flow-logs.html)」を参照してください。 ### `create-fpga-image` 次のコード例は、`create-fpga-image` を使用する方法を示しています。 **AWS CLI** **Amazon FPGA イメージを作成するには** この例では、指定したバケット内の指定した tarball から AFI を作成します。 コマンド: ``` 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 ``` 出力: ``` { "FpgaImageId": "afi-0d123e123bfc85abc", "FpgaImageGlobalId": "agfi-123cb27b5e84a0abc" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateFpgaImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-fpga-image.html)」を参照してください。 ### `create-image` 次のコード例は、`create-image` を使用する方法を示しています。 **AWS CLI** **例 1: Amazon EBS-backed インスタンスから AMI を作成するには** 次の `create-image` の例では、指定したインスタンスから AMI を作成します。 ``` aws ec2 create-image \ --instance-id i-1234567890abcdef0 \ --name "My server" \ --description "An AMI for my server" ``` 出力: ``` { "ImageId": "ami-abcdef01234567890" } ``` AMI のブロックデバイスマッピングの指定の詳細については、「*Amazon EC2 ユーザーガイド*」の「[Specifying a block device mapping for an AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html#create-ami-bdm)」を参照してください。 **例 2: 再起動せずに Amazon EBS-backed インスタンスから AMI を作成するには** 次の `create-image` の例では、AMI を作成し、--no-reboot パラメータを設定して、イメージの作成前にインスタンスが再起動されないようにします。 ``` aws ec2 create-image \ --instance-id i-1234567890abcdef0 \ --name "My server" \ --no-reboot ``` 出力: ``` { "ImageId": "ami-abcdef01234567890" } ``` AMI のブロックデバイスマッピングの指定の詳細については、「*Amazon EC2 ユーザーガイド*」の「[Specifying a block device mapping for an AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html#create-ami-bdm)」を参照してください。 **例 3: 作成時に AMI とスナップショットにタグを付けるには** 次の `create-image` の例では、AMI を作成し、AMI とスナップショットに同じタグ `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}]" ``` 出力: ``` { "ImageId": "ami-abcdef01234567890" } ``` 作成時のリソースのタグ付けの詳細については、「*Amazon EC2 ユーザーガイド*」の「[Add tags on resource creation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-on-create-examples)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-image.html)」を参照してください。 ### `create-instance-connect-endpoint` 次のコード例は、`create-instance-connect-endpoint` を使用する方法を示しています。 **AWS CLI** **EC2 Instance Connect Endpoint を作成するには** 次の `create-instance-connect-endpoint` の例では、指定したサブネットに EC2 Instance Connect エンドポイントを作成します。 ``` aws ec2 create-instance-connect-endpoint \ --region us-east-1 \ --subnet-id subnet-0123456789example ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[EC2 Instance Connect Endpoint の作成](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-ec2-instance-connect-endpoints.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateInstanceConnectEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-instance-connect-endpoint.html)」を参照してください。 ### `create-instance-event-window` 次のコード例は、`create-instance-event-window` を使用する方法を示しています。 **AWS CLI** **例 1: 時間範囲を設定したイベントウィンドウを作成するには** 次の `create-instance-event-window` の例では、時間範囲を持つイベントウィンドウを作成します。また、`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 ``` 出力: ``` { "InstanceEventWindow": { "InstanceEventWindowId": "iew-0abcdef1234567890", "TimeRanges": [ { "StartWeekDay": "monday", "StartHour": 2, "EndWeekDay": "wednesday", "EndHour": 8 } ], "Name": "myEventWindowName", "State": "creating", "Tags": [ { "Key": "K1", "Value": "V1" } ] } } ``` イベントウィンドウの制約については、「*Amazon EC2 ユーザーガイド*」の予定されているイベントに関するセクションの「[考慮事項](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html#event-windows-considerations)」を参照してください。 **例 2: cron 式を指定したイベントウィンドウを作成するには** 次の `create-instance-event-window` の例では、cron 式を持つイベントウィンドウを作成します。また、`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 ``` 出力: ``` { "InstanceEventWindow": { "InstanceEventWindowId": "iew-0abcdef1234567890", "Name": "myEventWindowName", "CronExpression": "* 21-23 * * 2,3", "State": "creating", "Tags": [ { "Key": "K1", "Value": "V1" } ] } } ``` イベントウィンドウの制約については、「*Amazon EC2 ユーザーガイド*」の予定されているイベントに関するセクションの「[考慮事項](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html#event-windows-considerations)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateInstanceEventWindow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-instance-event-window.html)」を参照してください。 ### `create-instance-export-task` 次のコード例は、`create-instance-export-task` を使用する方法を示しています。 **AWS CLI** **インスタンスをエクスポートするには** このコマンド例では、インスタンス i-1234567890abcdef0 を Amazon S3 バケット myexportbucket にエクスポートするタスクを作成します。 コマンド: ``` 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 ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateInstanceExportTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-instance-export-task.html)」を参照してください。 ### `create-internet-gateway` 次のコード例は、`create-internet-gateway` を使用する方法を示しています。 **AWS CLI** **インターネットゲートウェイを作成するには** 次の `create-internet-gateway` の例では、タグ `Name=my-igw` を持つインターネットゲートウェイを作成します。 ``` aws ec2 create-internet-gateway \ --tag-specifications ResourceType=internet-gateway,Tags=[{Key=Name,Value=my-igw}] ``` 出力: ``` { "InternetGateway": { "Attachments": [], "InternetGatewayId": "igw-0d0fb496b3994d755", "OwnerId": "123456789012", "Tags": [ { "Key": "Name", "Value": "my-igw" } ] } } ``` 詳細については、*Amazon VPC ユーザーガイド*の「[インターネットゲートウェイ](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateInternetGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-internet-gateway.html)」を参照してください。 ### `create-ipam-pool` 次のコード例は、`create-ipam-pool` を使用する方法を示しています。 **AWS CLI** **IPAM プールを作成するには** 次の `create-ipam-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"}] ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[Plan for IP address provisioning](https://docs.aws.amazon.com/vpc/latest/ipam/planning-ipam.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateIpamPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-ipam-pool.html)」を参照してください。 ### `create-ipam-resource-discovery` 次のコード例は、`create-ipam-resource-discovery` を使用する方法を示しています。 **AWS CLI** **リソース検出を作成するには** この例では、あなたは IPAM の委任された管理者として、別の AWS 組織の IPAM 管理者とリソース検出を作成して共有し、他の組織の管理者が組織内のリソースの IP アドレスを管理およびモニタリングできるようにしたいと考えています。 重要 リソース検出を IPAM と正常に統合するためには特定の方法で設定する必要があるため、この例には `--region` と `--operating-regions` の両方のオプションが含まれています。どちらもオプションです。\$1 `--operating-regions` は、IPAM で検出するリソースがある地域と一致する必要があります。(コンプライアンス上の理由などで) IPAM で IP アドレスを管理したくないリージョンがある場合は、そのリージョンを含めないでください。\$1 `--region` は、関連付ける IPAM のホームリージョンと一致する必要があります。IPAM が作成されたのと同じリージョンでリソース検出を作成する必要があります。例えば、関連付ける IPAM が us-east-1 で作成された場合は、リクエストに `--region us-east-1` を含めます。`--region` と `--operating-regions` オプションは両方とも、指定しない場合はコマンドを実行しているリージョンにデフォルト設定されます。 この例では、統合対象の IPAM の運用リージョンには、`us-west-1`、`us-west-2`、および `ap-south-1` が含まれます。リソース検出を作成する場合、IPAM では、`ap-south-1` ではなく、`us-west-2` と `us-west-1` にあるリソース IP アドレスを検出する必要があります。そのため、リクエストには `--operating-regions RegionName='us-west-1' RegionName='us-west-2'` のみを含めます。 次の `create-ipam-resource-discovery` の例では、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 ``` 出力: ``` { "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" } ] } ``` リソース検出を作成後、それを別の IPAM の委任された管理者と共有する必要が出てくる場合があります。[create-resource-share](https://docs.aws.amazon.com/cli/latest/reference/ram/create-resource-share.html) を使用すればそれに対応できます。詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[Integrate IPAM with accounts outside of your organization](https://docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam-outside-org.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateIpamResourceDiscovery](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-ipam-resource-discovery.html)」を参照してください。 ### `create-ipam-scope` 次のコード例は、`create-ipam-scope` を使用する方法を示しています。 **AWS CLI** **IPAM スコープを作成するには** 次の `create-ipam-scope` の例では、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"}] ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[Create additional scopes](https://docs.aws.amazon.com/vpc/latest/ipam/add-scope-ipam.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateIpamScope](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-ipam-scope.html)」を参照してください。 ### `create-ipam` 次のコード例は、`create-ipam` を使用する方法を示しています。 **AWS CLI** **IPAM を作成するには** 次の `create-ipam` の例では、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}] ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[Create an IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateIpam](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-ipam.html)」を参照してください。 ### `create-key-pair` 次のコード例は、`create-key-pair` を使用する方法を示しています。 **AWS CLI** **キーペアを作成するには** この例では、`MyKeyPair` という名前のキーペアが作成されます。 コマンド: ``` aws ec2 create-key-pair --key-name MyKeyPair ``` 出力は ASCII バージョンのプライベートキーとキーフィンガープリントです。キーはファイルに保存する必要があります。 詳細については、「*AWS コマンドラインインターフェイスユーザーガイド*」でキーペアの使用方法を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateKeyPair](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-key-pair.html)」を参照してください。 ### `create-launch-template-version` 次のコード例は、`create-launch-template-version` を使用する方法を示しています。 **AWS CLI** **起動テンプレートのバージョンを作成するには** この例では、起動テンプレートのバージョン 1 に基づいて新しいバージョンを作成し、異なる AMI ID を指定します。 コマンド: ``` aws ec2 create-launch-template-version --launch-template-id lt-0abcd290751193123 --version-description WebVersion2 --source-version 1 --launch-template-data '{"ImageId":"ami-c998b6b2"}' ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateLaunchTemplateVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-launch-template-version.html)」を参照してください。 ### `create-launch-template` 次のコード例は、`create-launch-template` を使用する方法を示しています。 **AWS CLI** **例 1: 起動テンプレートを作成するには** 次の `create-launch-template` の例では、インスタンスを起動し、インスタンスにパブリック IP アドレスと IPv6 アドレスを割り当て、インスタンスのタグを作成するサブネットを指定する起動テンプレートを作成しています。 ``` 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"}]}]}' ``` 出力: ``` { "LaunchTemplate": { "LatestVersionNumber": 1, "LaunchTemplateId": "lt-01238c059e3466abc", "LaunchTemplateName": "TemplateForWebServer", "DefaultVersionNumber": 1, "CreatedBy": "arn:aws:iam::123456789012:user/Bob", "CreateTime": "2019-01-27T09:13:24.000Z" } } ``` 詳細については、「*Amazon Elastic Compute Cloud ユーザーガイド*」の「起動テンプレートからのインスタンスの起動」を参照してください。JSON 形式のパラメータで引用する方法については、「*AWS コマンドラインインターフェイスユーザーガイド*」の「文字列の引用」を参照してください。 **例 2: Amazon EC2 Auto Scaling の起動テンプレートを作成するには** 次の `create-launch-template` の例では、複数のタグとブロックデバイスマッピングを使ってインスタンス起動時に追加の EBS ボリュームを指定する起動テンプレートを作成しています。Auto Scaling グループがインスタンスを起動する VPC のセキュリティグループに対応する `Groups` の値を指定します。Auto Scaling グループのプロパティとして VPC とサブネットを指定します。 ``` 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 ``` 出力: ``` { "LaunchTemplate": { "LatestVersionNumber": 1, "LaunchTemplateId": "lt-0123c79c33a54e0abc", "LaunchTemplateName": "TemplateForAutoScaling", "DefaultVersionNumber": 1, "CreatedBy": "arn:aws:iam::123456789012:user/Bob", "CreateTime": "2019-04-30T18:16:06.000Z" } } ``` 詳細については、「*Amazon EC2 Auto Scaling ユーザーガイド*」の「Auto Scaling グループの起動テンプレートを作成する」を参照してください。JSON 形式のパラメータで引用する方法については、「*AWS コマンドラインインターフェイスユーザーガイド*」の「文字列の引用」を参照してください。 **例 3: EBS ボリュームの暗号化を指定する起動テンプレートを作成するには** 次の `create-launch-template` の例では、暗号化されていないスナップショットから作成された暗号化された EBS ボリュームを含む起動テンプレートを作成しています。また、作成時にボリュームにタグ付けしています。暗号化がデフォルトで無効になっている場合、次の例のように `"Encrypted"` オプションを指定する必要があります。`"KmsKeyId"` オプションを使用してカスタマー管理の CMK を指定する場合は、デフォルトで暗号化が有効になっていても `"Encrypted"` オプションを指定する必要があります。 ``` aws ec2 create-launch-template \ --launch-template-name TemplateForEncryption \ --launch-template-data file://config.json ``` `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" } ] } ] } ``` 出力: ``` { "LaunchTemplate": { "LatestVersionNumber": 1, "LaunchTemplateId": "lt-0d5bd51bcf8530abc", "LaunchTemplateName": "TemplateForEncryption", "DefaultVersionNumber": 1, "CreatedBy": "arn:aws:iam::123456789012:user/Bob", "CreateTime": "2020-01-07T19:08:36.000Z" } } ``` 詳細については、「*Amazon Elastic Compute Cloud ユーザーガイド*」の「スナップショットからの Amazon EBS ボリュームの復元」と「デフォルトでの暗号化」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateLaunchTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-launch-template.html)」を参照してください。 ### `create-local-gateway-route-table-virtual-interface-group-association` 次のコード例は、`create-local-gateway-route-table-virtual-interface-group-association` を使用する方法を示しています。 **AWS CLI** **ローカルゲートウェイのルートテーブルを仮想インターフェイス (VIF) グループに関連付けるには** 次の `create-local-gateway-route-table-virtual-interface-group-association` の例では、指定したローカルゲートウェイのルートテーブルと 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 ``` 出力: ``` { "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": [] } } ``` 詳細については、「*AWS Outposts ユーザーガイド*」の「[VIF group associations](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#vif-group-associations)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-local-gateway-route-table-virtual-interface-group-association.html)」を参照してください。 ### `create-local-gateway-route-table-vpc-association` 次のコード例は、`create-local-gateway-route-table-vpc-association` を使用する方法を示しています。 **AWS CLI** **VPC をルートテーブルに関連付けるには** 次の `create-local-gateway-route-table-vpc-association` の例では、指定した VPC を指定したローカルゲートウェイのルートテーブルに関連付けます。 ``` aws ec2 create-local-gateway-route-table-vpc-association \ --local-gateway-route-table-id lgw-rtb-059615ef7dEXAMPLE \ --vpc-id vpc-07ef66ac71EXAMPLE ``` 出力: ``` { "LocalGatewayRouteTableVpcAssociation": { "LocalGatewayRouteTableVpcAssociationId": "lgw-vpc-assoc-0ee765bcc8EXAMPLE", "LocalGatewayRouteTableId": "lgw-rtb-059615ef7dEXAMPLE", "LocalGatewayId": "lgw-09b493aa7cEXAMPLE", "VpcId": "vpc-07ef66ac71EXAMPLE", "State": "associated" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateLocalGatewayRouteTableVpcAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-local-gateway-route-table-vpc-association.html)」を参照してください。 ### `create-local-gateway-route-table` 次のコード例は、`create-local-gateway-route-table` を使用する方法を示しています。 **AWS CLI** **ローカルゲートウェイのルートテーブルのルートを作成するには** 次の `create-local-gateway-route-table` の例では、直接 VPC ルーティングモードでローカルゲートウェイのルートテーブルを作成します。 ``` aws ec2 create-local-gateway-route-table \ --local-gateway-id lgw-1a2b3c4d5e6f7g8h9 \ --mode direct-vpc-routing ``` 出力: ``` { "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" } } ``` 詳細については、「AWS Outposts ユーザーガイド」の「[ローカルゲートウェイルートテーブル](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateLocalGatewayRouteTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-local-gateway-route-table.html)」を参照してください。 ### `create-local-gateway-route` 次のコード例は、`create-local-gateway-route` を使用する方法を示しています。 **AWS CLI** **ローカルゲートウェイのルートテーブルの静的ルートを作成するには** 次の `create-local-gateway-route` の例では、指定したローカルゲートウェイのルートテーブルに指定したルートを作成します。 ``` aws ec2 create-local-gateway-route \ --destination-cidr-block 0.0.0.0/0 \ --local-gateway-route-table-id lgw-rtb-059615ef7dEXAMPLE ``` 出力: ``` { "Route": { "DestinationCidrBlock": "0.0.0.0/0", "LocalGatewayVirtualInterfaceGroupId": "lgw-vif-grp-07145b276bEXAMPLE", "Type": "static", "State": "deleted", "LocalGatewayRouteTableId": "lgw-rtb-059615ef7dEXAMPLE" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateLocalGatewayRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-local-gateway-route.html)」を参照してください。 ### `create-managed-prefix-list` 次のコード例は、`create-managed-prefix-list` を使用する方法を示しています。 **AWS CLI** **プレフィックスリストを作成する** 次の `create-managed-prefix-list` の例では、最大エントリ数が 10 個の IPv4 プレフィックスリストを作成し、そのプレフィックスリストに 2 つのエントリを作成します。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon VPC ユーザーガイド*」の「[Managed prefix lists](https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateManagedPrefixList](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-managed-prefix-list.html)」を参照してください。 ### `create-nat-gateway` 次のコード例は、`create-nat-gateway` を使用する方法を示しています。 **AWS CLI** **例 1: パブリック NAT ゲートウェイを作成するには** 次の `create-nat-gateway` の例では、指定したサブネットにパブリック NAT ゲートウェイを作成し、Elastic IP アドレスを指定した割り当て ID に関連付けます。パブリック NAT ゲートウェイを作成する場合、Elastic IP アドレスを関連付ける必要があります。 ``` aws ec2 create-nat-gateway \ --subnet-id subnet-0250c25a1fEXAMPLE \ --allocation-id eipalloc-09ad461b0dEXAMPLE ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon VPC ユーザーガイド*」の「[NAT ゲートウェイ](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html)」を参照してください。 **例 2: プライベート NAT ゲートウェイを作成するには** 次の `create-nat-gateway` の例では、指定したサブネットにプライベート NAT ゲートウェイを作成します。プライベート NAT ゲートウェイには、関連付けられた Elastic IP アドレスがありません。 ``` aws ec2 create-nat-gateway \ --subnet-id subnet-0250c25a1fEXAMPLE \ --connectivity-type private ``` 出力: ``` { "NatGateway": { "CreateTime": "2021-12-01T22:26:00.000Z", "NatGatewayAddresses": [ {} ], "NatGatewayId": "nat-011b568379EXAMPLE", "State": "pending", "SubnetId": "subnet-0250c25a1fEXAMPLE", "VpcId": "vpc-0a60eb65b4EXAMPLE", "ConnectivityType": "private" } } ``` 詳細については、「*Amazon VPC ユーザーガイド*」の「[NAT ゲートウェイ](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateNatGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-nat-gateway.html)」を参照してください。 ### `create-network-acl-entry` 次のコード例は、`create-network-acl-entry` を使用する方法を示しています。 **AWS CLI** **ネットワーク ACL エントリを作成するには** この例では、指定したネットワーク ACL のエントリを作成します。このルールは、UDP ポート 53 (DNS) 上の任意の IPv4 アドレス (0.0.0.0/0) から任意の関連付けられたサブネットへの受信トラフィックを許可します。コマンドが成功した場合、出力は返りません。 コマンド: ``` 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 ``` この例では、TCP ポート 80 (HTTP) 上の任意の IPv6 アドレス (::/0) からの受信トラフィックを許可する、指定したネットワーク ACL のルールを作成します。 コマンド: ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateNetworkAclEntry](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-network-acl-entry.html)」を参照してください。 ### `create-network-acl` 次のコード例は、`create-network-acl` を使用する方法を示しています。 **AWS CLI** **ネットワーク ACL を作成するには** この例では、指定した VPC に対してネットワーク ACL を作成します。 コマンド: ``` aws ec2 create-network-acl --vpc-id vpc-a01106c2 ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateNetworkAcl](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-network-acl.html)」を参照してください。 ### `create-network-insights-access-scope` 次のコード例は、`create-network-insights-access-scope` を使用する方法を示しています。 **AWS CLI** **Network Access Scope を作成するには** 次の `create-network-insights-access-scope` の例では、Network Access Scope を作成します。 ``` aws ec2 create-network-insights-access-scope \ --cli-input-json file://access-scope-file.json ``` `access-scope-file.json` の内容: ``` { "MatchPaths": [ { "Source": { "ResourceStatement": { "Resources": [ "vpc-abcd12e3" ] } } } ], "ExcludePaths": [ { "Source": { "ResourceStatement": { "ResourceTypes": [ "AWS::EC2::InternetGateway" ] } } } ] } ``` 出力: ``` { "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" ] } } } ] } } ``` 詳細については、「*Network Access Analyzer ガイド*」の「[Getting started with Network Access Analyzer using the AWS CLI](https://docs.aws.amazon.com/vpc/latest/network-access-analyzer/getting-started-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateNetworkInsightsAccessScope](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-network-insights-access-scope.html)」を参照してください。 ### `create-network-insights-path` 次のコード例は、`create-network-insights-path` を使用する方法を示しています。 **AWS CLI** **パスを作成するには** 次の `create-network-insights-path` の例では、パスを作成します。送信元は指定されたインターネットゲートウェイで、送信先は指定された EC2 インスタンスです。指定されたプロトコルとポートを使用して送信先に到達できるかどうかを確認するには、`start-network-insights-analysis` コマンドを使用してパスを分析します。 ``` aws ec2 create-network-insights-path \ --source igw-0797cccdc9d73b0e5 \ --destination i-0495d385ad28331c7 \ --destination-port 22 \ --protocol TCP ``` 出力: ``` { "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" } } ``` 詳細については、「*Reachability Analyzer ガイド*」の「[Getting started using the AWS CLI](https://docs.aws.amazon.com/vpc/latest/reachability/getting-started-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateNetworkInsightsPath](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-network-insights-path.html)」を参照してください。 ### `create-network-interface-permission` 次のコード例は、`create-network-interface-permission` を使用する方法を示しています。 **AWS CLI** **ネットワークインターフェイス権限を作成するには** この例では、インスタンスにネットワークインターフェイス `eni-1a2b3c4d` をアタッチするためにアカウント `123456789012` へのアクセス許可を付与します。 コマンド: ``` aws ec2 create-network-interface-permission --network-interface-id eni-1a2b3c4d --aws-account-id 123456789012 --permission INSTANCE-ATTACH ``` 出力: ``` { "InterfacePermission": { "PermissionState": { "State": "GRANTED" }, "NetworkInterfacePermissionId": "eni-perm-06fd19020ede149ea", "NetworkInterfaceId": "eni-1a2b3c4d", "Permission": "INSTANCE-ATTACH", "AwsAccountId": "123456789012" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateNetworkInterfacePermission](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-network-interface-permission.html)」を参照してください。 ### `create-network-interface` 次のコード例は、`create-network-interface` を使用する方法を示しています。 **AWS CLI** **例 1: ネットワークインターフェイスの IPv4 アドレスを指定するには** 次の `create-network-interface` の例では、指定したプライマリ IPv4 アドレスを持つ指定したサブネット用にネットワークインターフェイスを作成します。 ``` aws ec2 create-network-interface \ --subnet-id subnet-00a24d0d67acf6333 \ --description "my network interface" \ --groups sg-09dfba7ed20cda78b \ --private-ip-address 10.0.8.17 ``` 出力: ``` { "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" } } ``` **例 2: IPv4 アドレスと IPv6 アドレスを持つネットワークインターフェイスを作成するには** 次の `create-network-interface` の例では、Amazon EC2 で選択されている IPv4 アドレスと IPv6 アドレスを使用して、指定したサブネット用にネットワークインターフェイスを作成します。 ``` aws ec2 create-network-interface \ --subnet-id subnet-00a24d0d67acf6333 \ --description "my dual stack network interface" \ --ipv6-address-count 1 \ --groups sg-09dfba7ed20cda78b ``` 出力: ``` { "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" } } ``` **例 3: 接続追跡設定オプションを使用してネットワークインターフェイスを作成するには** 次の `create-network-interface` の例では、ネットワークインターフェイスを作成し、アイドル接続追跡タイムアウトを設定します。 ``` aws ec2 create-network-interface \ --subnet-id subnet-00a24d0d67acf6333 \ --groups sg-02e57dbcfe0331c1b \ --connection-tracking-specification TcpEstablishedTimeout=86400,UdpTimeout=60 ``` 出力: ``` { "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" } } ``` **例 4: Elastic Fabric Adapter を作成するには** 次の `create-network-interface` の例では、EFA を作成します。 ``` aws ec2 create-network-interface \ --interface-type efa \ --subnet-id subnet-00a24d0d67acf6333 \ --description "my efa" \ --groups sg-02e57dbcfe0331c1b ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[Elastic Network Interface](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateNetworkInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-network-interface.html)」を参照してください。 ### `create-placement-group` 次のコード例は、`create-placement-group` を使用する方法を示しています。 **AWS CLI** **プレイスメントグループを作成するには** このコマンド例では、指定された名前のプレイスメントグループを作成します。 コマンド: ``` aws ec2 create-placement-group --group-name my-cluster --strategy cluster ``` **パーティションプレイスメントグループを作成するには** このコマンド例では、`HDFS-Group-A` という名前のパーティションプレイスメントグループと 5 つのパーティションを作成します。 コマンド: ``` aws ec2 create-placement-group --group-name HDFS-Group-A --strategy partition --partition-count 5 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreatePlacementGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-placement-group.html)」を参照してください。 ### `create-replace-root-volume-task` 次のコード例は、`create-replace-root-volume-task` を使用する方法を示しています。 **AWS CLI** **例 1: ルートボリュームを初期起動状態に復元するには** 次の `create-replace-root-volume-task` の例では、インスタンス i-0123456789abcdefa のルートボリュームを初期起動状態に復元します。 ``` aws ec2 create-replace-root-volume-task \ --instance-id i-0123456789abcdefa ``` 出力: ``` { "ReplaceRootVolumeTask": { "InstanceId": "i-0123456789abcdefa", "ReplaceRootVolumeTaskId": "replacevol-0111122223333abcd", "TaskState": "pending", "StartTime": "2022-03-14T15:06:38Z", "Tags": [] } } ``` **例 2: ルートボリュームを特定のスナップショットに復元するには** 次の `create-replace-root-volume-task` の例では、インスタンス i-0123456789abcdefa のルートボリュームをスナップショット snap-0abcdef1234567890 に復元します。 ``` aws ec2 create-replace-root-volume-task \ --instance-id i-0123456789abcdefa \ --snapshot-id snap-0abcdef1234567890 ``` 出力: ``` { "ReplaceRootVolumeTask": { "InstanceId": "i-0123456789abcdefa", "ReplaceRootVolumeTaskId": "replacevol-0555566667777abcd", "TaskState": "pending", "StartTime": "2022-03-14T15:16:28Z", "Tags": [] } } ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[ルートボリュームを置き換える](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/replace-root.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateReplaceRootVolumeTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-replace-root-volume-task.html)」を参照してください。 ### `create-reserved-instances-listing` 次のコード例は、`create-reserved-instances-listing` を使用する方法を示しています。 **AWS CLI** **リザーブドインスタンスマーケットプレイス内のリザーブドインスタンスを一覧表示するには** 次の `create-reserved-instances-listing` の例では、指定したリザーブドインスタンスのリストをリザーブドインスタンスマーケットプレイスに作成します。 ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateReservedInstancesListing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-reserved-instances-listing.html)」を参照してください。 ### `create-restore-image-task` 次のコード例は、`create-restore-image-task` を使用する方法を示しています。 **AWS CLI** **S3 バケットから AMI を復元するには** 次の `create-restore-image-task` の例では、S3 バケットから AMI を復元します。`describe-store-image-tasks` 出力からの `S3ObjectKey `` and ``Bucket` の値を使用し、AMI のオブジェクトキーと AMI のコピー先である S3 バケットの名前を指定して、復元された AMI の名前を指定します。このアカウントの名前は、リージョン内の AMI に対して一意である必要があります。復元された AMI は新しい AMI ID を受け取ります。 ``` aws ec2 create-restore-image-task \ --object-key ami-1234567890abcdef0.bin \ --bucket my-ami-bucket \ --name 'New AMI Name' ``` 出力: ``` { "ImageId": "ami-0eab20fe36f83e1a8" } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[S3 を使用して AMI を保存および復元する](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateRestoreImageTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-restore-image-task.html)」を参照してください。 ### `create-route-table` 次のコード例は、`create-route-table` を使用する方法を示しています。 **AWS CLI** **ルートテーブルを作成するには** この例では、指定された VPC に対してルートテーブルを作成しています。 コマンド: ``` aws ec2 create-route-table --vpc-id vpc-a01106c2 ``` 出力: ``` { "RouteTable": { "Associations": [], "RouteTableId": "rtb-22574640", "VpcId": "vpc-a01106c2", "PropagatingVgws": [], "Tags": [], "Routes": [ { "GatewayId": "local", "DestinationCidrBlock": "10.0.0.0/16", "State": "active" } ] } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateRouteTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-route-table.html)」を参照してください。 ### `create-route` 次のコード例は、`create-route` を使用する方法を示しています。 **AWS CLI** **ルートを作成するには** この例では、指定したルートテーブルに対してルートを作成します。ルートはすべての IPv4 トラフィック (`0.0.0.0/0`) と一致し、指定されたインターネットゲートウェイにルーティングされます。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 create-route --route-table-id rtb-22574640 --destination-cidr-block 0.0.0.0/0 --gateway-id igw-c0a643a9 ``` このコマンド例では、ルートテーブル rtb-g8ff4ea2 にルートを作成します。ルートは IPv4 CIDR ブロック 10.0.0.0/16 のトラフィックに一致し、VPC ピアリング接続 pcx-111aaa22 にルーティングされます。このルートにより、トラフィックを VPC ピアリング接続のピア VPC にルーティングできます。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 create-route --route-table-id rtb-g8ff4ea2 --destination-cidr-block 10.0.0.0/16 --vpc-peering-connection-id pcx-1a2b3c4d ``` この例では、すべての IPv6 トラフィック (`::/0`) に一致するルートを指定されたルートテーブルに作成し、指定された Egress 専用インターネットゲートウェイにルーティングします。 コマンド: ``` aws ec2 create-route --route-table-id rtb-dce620b8 --destination-ipv6-cidr-block ::/0 --egress-only-internet-gateway-id eigw-01eadbd45ecd7943f ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-route.html)」を参照してください。 ### `create-security-group` 次のコード例は、`create-security-group` を使用する方法を示しています。 **AWS CLI** **EC2-Classic 用セキュリティグループを作成するには** この例では、`MySecurityGroup` という名前のセキュリティグループが作成されます。 コマンド: ``` aws ec2 create-security-group --group-name MySecurityGroup --description "My security group" ``` 出力: ``` { "GroupId": "sg-903004f8" } ``` **EC2-VPC 用セキュリティグループを作成するには** この例では、指定された VPC 用に `MySecurityGroup` という名前のセキュリティグループが作成されます。 コマンド: ``` aws ec2 create-security-group --group-name MySecurityGroup --description "My security group" --vpc-id vpc-1a2b3c4d ``` 出力: ``` { "GroupId": "sg-903004f8" } ``` 詳細については、「*AWS コマンドラインインターフェイスユーザーガイド*」でセキュリティグループの使用方法を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateSecurityGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-security-group.html)」を参照してください。 ### `create-snapshot` 次のコード例は、`create-snapshot` を使用する方法を示しています。 **AWS CLI** **スナップショットを作成するには** このコマンド例では、`vol-1234567890abcdef0` というボリューム ID を持つスナップショットと、そのスナップショットを識別するための短い説明を作成します。 コマンド: ``` aws ec2 create-snapshot --volume-id vol-1234567890abcdef0 --description "This is my root volume snapshot" ``` 出力: ``` { "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" } ``` **タグ付きのスナップショットを作成するには** このコマンド例では、スナップショットを作成し、purpose=prod と costcenter=123 という 2 つのタグを適用します。 コマンド: ``` aws ec2 create-snapshot --volume-id vol-1234567890abcdef0 --description 'Prod backup' --tag-specifications 'ResourceType=snapshot,Tags=[{Key=purpose,Value=prod},{Key=costcenter,Value=123}]' ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-snapshot.html)」を参照してください。 ### `create-snapshots` 次のコード例は、`create-snapshots` を使用する方法を示しています。 **AWS CLI** **例 1: マルチボリュームスナップショットを作成するには** 次の `create-snapshots` の例では、指定したインスタンスにアタッチされたすべてのボリュームのスナップショットを作成します。 ``` aws ec2 create-snapshots \ --instance-specification InstanceId=i-1234567890abcdef0 \ --description "This is snapshot of a volume from my-instance" ``` 出力: ``` { "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" }, ... ] } ``` **例 2: ソースボリュームからタグ付きのマルチボリュームスナップショットを作成するには** 次の `create-snapshots` の例では、指定したインスタンスにアタッチされたすべてのボリュームのスナップショットを作成し、各ボリュームから対応するスナップショットにタグをコピーします。 ``` aws ec2 create-snapshots \ --instance-specification InstanceId=i-1234567890abcdef0 \ --copy-tags-from-source volume \ --description "This is snapshot of a volume from my-instance" ``` 出力: ``` { "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" } ... ] } ``` **例 3: ルートボリュームを含まないマルチボリュームスナップショットを作成するには** 次の `create-snapshots` の例では、指定したインスタンスにアタッチされたすべてのボリュームのスナップショットを作成します。ただし、ルートボリュームは除きます。 ``` aws ec2 create-snapshots \ --instance-specification InstanceId=i-1234567890abcdef0,ExcludeBootVolume=true ``` 出力例については、例 1 を参照してください。 **例 4: マルチボリュームスナップショットを作成してタグを追加するには** 次の `create-snapshots` の例では、指定したインスタンスにアタッチされたすべてのボリュームのスナップショットを作成し、各スナップショットに 2 つのタグを追加します。 ``` aws ec2 create-snapshots \ --instance-specification InstanceId=i-1234567890abcdef0 \ --tag-specifications 'ResourceType=snapshot,Tags=[{Key=Name,Value=backup},{Key=costcenter,Value=123}]' ``` 出力例については、例 1 を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-snapshots.html)」を参照してください。 ### `create-spot-datafeed-subscription` 次のコード例は、`create-spot-datafeed-subscription` を使用する方法を示しています。 **AWS CLI** **スポットインスタンスのデータフィードを作成するには** 次の `create-spot-datafeed-subscription` の例では、スポットインスタンスのデータフィードを作成します。 ``` aws ec2 create-spot-datafeed-subscription \ --bucket amzn-s3-demo-bucket \ --prefix spot-data-feed ``` 出力: ``` { "SpotDatafeedSubscription": { "Bucket": "amzn-s3-demo-bucket", "OwnerId": "123456789012", "Prefix": "spot-data-feed", "State": "Active" } } ``` データフィードは、指定した Amazon S3 バケットに保存されます。このデータフィードのファイル名の形式は次のとおりです。 ``` amzn-s3-demo-bucket.s3.amazonaws.com/spot-data-feed/123456789012.YYYY-MM-DD-HH.n.abcd1234.gz ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[ スポットインスタンスのデータフィード](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateSpotDatafeedSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-spot-datafeed-subscription.html)」を参照してください。 ### `create-store-image-task` 次のコード例は、`create-store-image-task` を使用する方法を示しています。 **AWS CLI** **S3 バケットに AMI を保存するには** 次の `create-store-image-task` の例では、S3 バケットに AMI を保存します。AMI の ID と、AMI を保存する S3 バケットの名前を指定します。 ``` aws ec2 create-store-image-task \ --image-id ami-1234567890abcdef0 \ --bucket my-ami-bucket ``` 出力: ``` { "ObjectKey": "ami-1234567890abcdef0.bin" } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[S3 を使用して AMI を保存および復元する](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateStoreImageTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-store-image-task.html)」を参照してください。 ### `create-subnet-cidr-reservation` 次のコード例は、`create-subnet-cidr-reservation` を使用する方法を示しています。 **AWS CLI** **サブネット CIDR 予約を作成するには** 次の `create-subnet-cidr-reservation` の例では、指定したサブネットと CIDR 範囲に対してサブネット CIDR 予約を作成します。 ``` aws ec2 create-subnet-cidr-reservation \ --subnet-id subnet-03c51e2eEXAMPLE \ --reservation-type prefix \ --cidr 10.1.0.20/26 ``` 出力: ``` { "SubnetCidrReservation": { "SubnetCidrReservationId": "scr-044f977c4eEXAMPLE", "SubnetId": "subnet-03c51e2e6cEXAMPLE", "Cidr": "10.1.0.16/28", "ReservationType": "prefix", "OwnerId": "123456789012" } } ``` 詳細については、*Amazon VPC ユーザーガイド*の[サブネット CIDR の予約](https://docs.aws.amazon.com/vpc/latest/userguide/subnet-cidr-reservation.html)を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateSubnetCidrReservation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-subnet-cidr-reservation.html)」を参照してください。 ### `create-subnet` 次のコード例は、`create-subnet` を使用する方法を示しています。 **AWS CLI** **例 1: IPv4 CIDR ブロックのみを使用してサブネットを作成するには** 次の `create-subnet` の例では、指定された IPv4 CIDR ブロックで指定された VPC にサブネットを作成しています。 ``` 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}] ``` 出力: ``` { "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" } } ``` **例 2: IPv4 と IPv6 CIDR ブロックの両方を使用してサブネットを作成するには** 次の `create-subnet` の例では、指定された IPv4 および IPv6 CIDR ブロックで指定された VPC にサブネットを作成しています。 ``` 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}] ``` 出力: ``` { "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" } } ``` **例 3: IPv6 CIDR ブロックのみを使用してサブネットを作成するには** 次の `create-subnet` の例では、指定された IPv6 CIDR ブロックで指定された VPC にサブネットを作成しています。 ``` 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}] ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon VPC ユーザーガイド*」の「[VPC とサブネット](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateSubnet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-subnet.html)」を参照してください。 ### `create-tags` 次のコード例は、`create-tags` を使用する方法を示しています。 **AWS CLI** **例 1: リソースにタグを追加するには** 次の `create-tags` の例では、タグ `Stack=production` を指定されたイメージに追加するか、タグキーが `Stack` の AMI 用に既存のタグを上書きします。 ``` aws ec2 create-tags \ --resources ami-1234567890abcdef0 \ --tags Key=Stack,Value=production ``` このコマンドでは何も出力されません。 **例 2: 複数のリソースにタグを追加するには** 次の `create-tags` の例では、2 つのタグを AMI とインスタンス用に追加 (または上書き) します。一方のタグでは、キー (`webserver`) はありますが値はありません (値は空文字列に設定されています)。もう一方のタグにはキー (`stack`) と値 (`Production`) があります。 ``` aws ec2 create-tags \ --resources ami-1a2b3c4d i-1234567890abcdef0 \ --tags Key=webserver,Value= Key=stack,Value=Production ``` このコマンドでは何も出力されません。 **例 3: 特殊文字を含むタグを追加するには** 次の `create-tags` の例では、インスタンスにタグ `[Group]=test` を追加します。角括弧 ([、]) は特殊文字であり、エスケープする必要があります。以下の例でも、各環境に適した行継続文字を使用しています。 Windows を使用している場合、特殊文字を含む要素を二重引用符 (") で囲み、各二重引用符の前にバックスラッシュ (\$1) を付けます。 ``` aws ec2 create-tags ^ --resources i-1234567890abcdef0 ^ --tags Key=\"[Group]\",Value=test ``` Windows PowerShell を使用している場合、次のように特殊文字を含む値を二重引用符 (") で囲み、各二重引用符の前にバックスラッシュ (\$1) を付けてから、キーと値の構造全体を一重引用符 (') で囲みます。 ``` aws ec2 create-tags ` --resources i-1234567890abcdef0 ` --tags 'Key=\"[Group]\",Value=test' ``` Linux または OS X を使用している場合は、次のように特殊文字を含む要素を二重引用符 (") で囲んだ後、キーと値の構造全体を一重引用符 (') で囲みます。 ``` aws ec2 create-tags \ --resources i-1234567890abcdef0 \ --tags 'Key="[Group]",Value=test' ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[Amazon EC2 リソースのタグ付け](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-tags.html)」を参照してください。 ### `create-traffic-mirror-filter-rule` 次のコード例は、`create-traffic-mirror-filter-rule` を使用する方法を示しています。 **AWS CLI** **受信 TCP トラフィックのフィルタールールを作成するには** 次の `create-traffic-mirror-filter-rule` の例では、すべての受信 TCP トラフィックをミラーリングするために使用できるルールを作成します。このコマンドを実行する前に、`create-traffic-mirror-filter` を使用してトラフィックミラーフィルタを作成します。 ``` 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 ``` 出力: ``` { "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" } ``` 詳細については、*トラフィックミラーリングガイド*の「[トラフィックミラーフィルタを作成する](https://docs.aws.amazon.com/vpc/latest/mirroring/create-traffic-mirroring-filter.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateTrafficMirrorFilterRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-traffic-mirror-filter-rule.html)」を参照してください。 ### `create-traffic-mirror-filter` 次のコード例は、`create-traffic-mirror-filter` を使用する方法を示しています。 **AWS CLI** **トラフィックミラーフィルタを作成するには** 次の `create-traffic-mirror-filter` の例では、トラフィックミラーフィルタを作成します。フィルタを作成したら、`create-traffic-mirror-filter-rule` を使用してルールを追加します。 ``` aws ec2 create-traffic-mirror-filter \ --description 'TCP Filter' ``` 出力: ``` { "ClientToken": "28908518-100b-4987-8233-8c744EXAMPLE", "TrafficMirrorFilter": { "TrafficMirrorFilterId": "tmf-04812ff784EXAMPLE", "Description": "TCP Filter", "EgressFilterRules": [], "IngressFilterRules": [], "Tags": [], "NetworkServices": [] } } ``` 詳細については、*トラフィックミラーリングガイド*の「[トラフィックミラーフィルタを作成する](https://docs.aws.amazon.com/vpc/latest/mirroring/create-traffic-mirroring-filter.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateTrafficMirrorFilter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-traffic-mirror-filter.html)」を参照してください。 ### `create-traffic-mirror-session` 次のコード例は、`create-traffic-mirror-session` を使用する方法を示しています。 **AWS CLI** **トラフィックミラーセッションを作成するには** 次の `create-traffic-mirror-session` コマンドは、指定したソースとターゲットのトラフィックミラーセッションを 25 バイトのパケットに対して作成します。 ``` 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 ``` 出力: ``` { "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" } ``` 詳細については、*トラフィックミラーリングガイド*の「[トラフィックミラーセッションを作成する](https://docs.aws.amazon.com/vpc/latest/mirroring/create-traffic-mirroring-session.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateTrafficMirrorSession](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-traffic-mirror-session.html)」を参照してください。 ### `create-traffic-mirror-target` 次のコード例は、`create-traffic-mirror-target` を使用する方法を示しています。 **AWS CLI** **Network Load Balancer トラフィックミラーターゲットを作成するには** 次の `create-traffic-mirror-target` の例では、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 ``` 出力: ``` { "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" } ``` **ネットワークのトラフィックミラーターゲットを作成するには** 次の `create-traffic-mirror-target` の例では、ネットワークインターフェイスのトラフィックミラーターゲットを作成します。 ``` aws ec2 create-traffic-mirror-target \ --description 'Network interface target' \ --network-interface-id eni-eni-01f6f631eEXAMPLE ``` 出力: ``` { "ClientToken": "5289a345-0358-4e62-93d5-47ef3061d65e", "TrafficMirrorTarget": { "Description": "Network interface target", "NetworkInterfaceId": "eni-01f6f631eEXAMPLE", "TrafficMirrorTargetId": "tmt-02dcdbe2abEXAMPLE", "OwnerId": "111122223333", "Type": "network-interface", "Tags": [] } } ``` 詳細については、*トラフィックミラーリングガイド*の「[トラフィックミラーターゲットを作成する](https://docs.aws.amazon.com/vpc/latest/mirroring/create-traffic-mirroring-target.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateTrafficMirrorTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-traffic-mirror-target.html)」を参照してください。 ### `create-transit-gateway-connect-peer` 次のコード例は、`create-transit-gateway-connect-peer` を使用する方法を示しています。 **AWS CLI** **Transit Gateway Connect ピアを作成するには** 次の `create-transit-gateway-connect-peer` の例では、Connect ピアを作成します。 ``` 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 ``` 出力: ``` { "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" } ] } } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Transit gateway Connect attachments and Transit Gateway Connect peers](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateTransitGatewayConnectPeer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-transit-gateway-connect-peer.html)」を参照してください。 ### `create-transit-gateway-connect` 次のコード例は、`create-transit-gateway-connect` を使用する方法を示しています。 **AWS CLI** **Transit Gateway Connect アタッチメントを作成するには** 次の `create-transit-gateway-connect` の例では、指定したアタッチメント用に、「gre」プロトコルを使用して、Connect アタッチメントを作成します。 ``` aws ec2 create-transit-gateway-connect \ --transport-transit-gateway-attachment-id tgw-attach-0a89069f57EXAMPLE \ --options "Protocol=gre" ``` 出力: ``` { "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" } } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Transit gateway Connect attachments and Transit Gateway Connect peers](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateTransitGatewayConnect](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-transit-gateway-connect.html)」を参照してください。 ### `create-transit-gateway-multicast-domain` 次のコード例は、`create-transit-gateway-multicast-domain` を使用する方法を示しています。 **AWS CLI** **例 1: IGMP マルチキャストドメインを作成するには** 次の `create-transit-gateway-multicast-domain` の例では、指定した Transit Gateway 用にマルチキャストドメインを作成します。静的ソースを無効にすると、マルチキャストドメインに関連付けられたサブネット内のすべてのインスタンスがマルチキャストトラフィックを送信できるようになります。メンバーの少なくとも 1 人が IGMP プロトコルを使用している場合は、IGMPv2 サポートを有効にする必要があります。 ``` aws ec2 create-transit-gateway-multicast-domain \ --transit-gateway-id tgw-0bf0bffefaEXAMPLE \ --options StaticSourcesSupport=disable,Igmpv2Support=enable ``` 出力: ``` { "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" } } ``` **例 2: 静的マルチキャストドメインを作成するには** 次の `create-transit-gateway-multicast-domain` の例では、指定した Transit Gateway 用にマルチキャストドメインを作成します。静的ソースが有効になっている場合は、ソースを静的に追加する必要があります。 ``` aws ec2 create-transit-gateway-multicast-domain \ --transit-gateway-id tgw-0bf0bffefaEXAMPLE \ --options StaticSourcesSupport=enable,Igmpv2Support=disable ``` 出力: ``` { "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" } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Managing multicast domains](https://docs.aws.amazon.com/vpc/latest/tgw/manage-domain.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateTransitGatewayMulticastDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-transit-gateway-multicast-domain.html)」を参照してください。 ### `create-transit-gateway-peering-attachment` 次のコード例は、`create-transit-gateway-peering-attachment` を使用する方法を示しています。 **AWS CLI** **Transit Gateway ピアリングアタッチメントを作成するには** 次の `create-transit-gateway-peering-attachment` の例では、指定した 2 つのゲートウェイ間のピアリングアタッチメントリクエストを作成します。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Transit Gateway Peering Attachments](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-peering.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateTransitGatewayPeeringAttachment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-transit-gateway-peering-attachment.html)」を参照してください。 ### `create-transit-gateway-policy-table` 次のコード例は、`create-transit-gateway-policy-table` を使用する方法を示しています。 **AWS CLI** **Transit Gateway ポリシーテーブルを作成するには** 次の `create-transit-gateway-policy-table` の例では、指定した Transit Gateway 用に Transit Gateway ポリシーテーブルを作成します。 ``` aws ec2 create-transit-gateway-policy-table \ --transit-gateway-id tgw-067f8505c18f0bd6e ``` 出力: ``` { "TransitGatewayPolicyTable": { "TransitGatewayPolicyTableId": "tgw-ptb-0a16f134b78668a81", "TransitGatewayId": "tgw-067f8505c18f0bd6e", "State": "pending", "CreationTime": "2023-11-28T16:36:43+00:00" } } ``` 詳細については、「*Transit Gateway ユーザーガイド*」の「[Transit gateway policy tables](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-policy-tables.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateTransitGatewayPolicyTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-transit-gateway-policy-table.html)」を参照してください。 ### `create-transit-gateway-prefix-list-reference` 次のコード例は、`create-transit-gateway-prefix-list-reference` を使用する方法を示しています。 **AWS CLI** **プレフィックスリストのリファレンスを作成するには** 次の `create-transit-gateway-prefix-list-reference` の例では、指定した Transit Gateway ルートテーブルに指定したプレフィックスリストへの参照を作成します。 ``` 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 ``` 出力: ``` { "TransitGatewayPrefixListReference": { "TransitGatewayRouteTableId": "tgw-rtb-0123456789abcd123", "PrefixListId": "pl-11111122222222333", "PrefixListOwnerId": "123456789012", "State": "pending", "Blackhole": false, "TransitGatewayAttachment": { "TransitGatewayAttachmentId": "tgw-attach-aaaaaabbbbbb11111", "ResourceType": "vpc", "ResourceId": "vpc-112233445566aabbc" } } } ``` 詳細については、*Transit Gateways ガイド*の「[プレフィックスリスト参照の作成](https://docs.aws.amazon.com/vpc/latest/tgw/create-prefix-list-reference.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateTransitGatewayPrefixListReference](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-transit-gateway-prefix-list-reference.html)」を参照してください。 ### `create-transit-gateway-route-table` 次のコード例は、`create-transit-gateway-route-table` を使用する方法を示しています。 **AWS CLI** **Transit Gateway ルートテーブルを作成するには** 次の `create-transit-gateway-route-table` の例では、指定した Transit Gateway 用にルートテーブルを作成します。 ``` aws ec2 create-transit-gateway-route-table \ --transit-gateway-id tgw-0262a0e521EXAMPLE ``` 出力: ``` { "TransitGatewayRouteTable": { "TransitGatewayRouteTableId": "tgw-rtb-0960981be7EXAMPLE", "TransitGatewayId": "tgw-0262a0e521EXAMPLE", "State": "pending", "DefaultAssociationRouteTable": false, "DefaultPropagationRouteTable": false, "CreationTime": "2019-07-10T19:01:46.000Z" } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Create a transit gateway route table](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html#create-tgw-route-table)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateTransitGatewayRouteTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-transit-gateway-route-table.html)」を参照してください。 ### `create-transit-gateway-route` 次のコード例は、`create-transit-gateway-route` を使用する方法を示しています。 **AWS CLI** **Transit Gateway ルートを作成するには** 次の `create-transit-gateway-route` の例では、指定したルートテーブル用に、指定した場所を使用して、ルートを作成します。 ``` 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 ``` 出力: ``` { "Route": { "DestinationCidrBlock": "10.0.2.0/24", "TransitGatewayAttachments": [ { "ResourceId": "vpc-0065acced4EXAMPLE", "TransitGatewayAttachmentId": "tgw-attach-0b5968d3b6EXAMPLE", "ResourceType": "vpc" } ], "Type": "static", "State": "active" } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Transit gateway route tables](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateTransitGatewayRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-transit-gateway-route.html)」を参照してください。 ### `create-transit-gateway-vpc-attachment` 次のコード例は、`create-transit-gateway-vpc-attachment` を使用する方法を示しています。 **AWS CLI** **例 1: Transit Gateway を VPC に関連付けるには** 次の `create-transit-gateway-vpc-attachment` の例では、指定した VPC への Transit Gateway アタッチメントを作成します。 ``` aws ec2 create-transit-gateway-vpc-attachment \ --transit-gateway-id tgw-0262a0e521EXAMPLE \ --vpc-id vpc-07e8ffd50f49335df \ --subnet-id subnet-0752213d59EXAMPLE ``` 出力: ``` { "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" } } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Create a transit gateway attachment to a VPC](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-vpc-attachments.html#create-vpc-attachment)」を参照してください。 **例 2: Transit Gateway を VPC 内の複数のサブネットに関連付けるには** 次の `create-transit-gateway-vpc-attachment` の例では、指定した VPC とサブネットへの Transit Gateway アタッチメントを作成します。 ``` aws ec2 create-transit-gateway-vpc-attachment \ --transit-gateway-id tgw-02f776b1a7EXAMPLE \ --vpc-id vpc-3EXAMPLE \ --subnet-ids "subnet-dEXAMPLE" "subnet-6EXAMPLE" ``` 出力: ``` { "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" } } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Create a transit gateway attachment to a VPC](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-vpc-attachments.html#create-vpc-attachment)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateTransitGatewayVpcAttachment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-transit-gateway-vpc-attachment.html)」を参照してください。 ### `create-transit-gateway` 次のコード例は、`create-transit-gateway` を使用する方法を示しています。 **AWS CLI** **Transit Gateway を作成するには** 次の `create-transit-gateway` の例では、Transit Gateway を作成します。 ``` aws ec2 create-transit-gateway \ --description MyTGW \ --options AmazonSideAsn=64516,AutoAcceptSharedAttachments=enable,DefaultRouteTableAssociation=enable,DefaultRouteTablePropagation=enable,VpnEcmpSupport=enable,DnsSupport=enable ``` 出力: ``` { "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" } } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Create a transit gateway](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-transit-gateways.html#create-tgw)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateTransitGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-transit-gateway.html)」を参照してください。 ### `create-verified-access-endpoint` 次のコード例は、`create-verified-access-endpoint` を使用する方法を示しています。 **AWS CLI** **Verified Access エンドポイントを作成するには** 次の `create-verified-access-endpoint` の例では、指定した Verified Access グループの Verified Access エンドポイントを作成します。指定されたネットワークインターフェイスとセキュリティグループは、同じ 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}] ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*AWSVerified Access ユーザーガイド*」の「[Verified Access endpoints](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-endpoints.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateVerifiedAccessEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-verified-access-endpoint.html)」を参照してください。 ### `create-verified-access-group` 次のコード例は、`create-verified-access-group` を使用する方法を示しています。 **AWS CLI** **Verified Access グループを作成するには** 次の `create-verified-access-group` の例では、指定した Verified Access インスタンスの Verified Access グループを作成します。 ``` 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}] ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*AWSVerified Access ユーザーガイド*」の「[Verified Access groups](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateVerifiedAccessGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-verified-access-group.html)」を参照してください。 ### `create-verified-access-instance` 次のコード例は、`create-verified-access-instance` を使用する方法を示しています。 **AWS CLI** **Verified Access インスタンスを作成するには** 次の `create-verified-access-instance` の例では、名前タグを使用して Verified Access インスタンスを作成します。 ``` aws ec2 create-verified-access-instance \ --tag-specifications ResourceType=verified-access-instance,Tags=[{Key=Name,Value=my-va-instance}] ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*AWSVerified Access ユーザーガイド*」の「[Access インスタンス](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-instances.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateVerifiedAccessInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-verified-access-instance.html)」を参照してください。 ### `create-verified-access-trust-provider` 次のコード例は、`create-verified-access-trust-provider` を使用する方法を示しています。 **AWS CLI** **Verified Access 信頼プロバイダーを作成するには** 次の `create-verified-access-trust-provider` の例では、AWS アイデンティティセンターを使用して Verified Access 信頼プロバイダーを設定します。 ``` 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}] ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*AWSVerified Access ユーザーガイド*」の「[Trust providers for Verified Access](https://docs.aws.amazon.com/verified-access/latest/ug/trust-providers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateVerifiedAccessTrustProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-verified-access-trust-provider.html)」を参照してください。 ### `create-volume` 次のコード例は、`create-volume` を使用する方法を示しています。 **AWS CLI** **空の汎用 SSD (gp2) ボリュームを作成するには** 次の `create-volume` の例では、指定したアベイラビリティーゾーンに 80 GiB 汎用 SSD (gp2) ボリュームを作成します。現在のリージョンは `us-east-1` である必要があります。または、`--region` パラメータを追加してコマンドのリージョンを指定できます。 ``` aws ec2 create-volume \ --volume-type gp2 \ --size 80 \ --availability-zone us-east-1a ``` 出力: ``` { "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 } ``` ボリュームタイプを指定しない場合、デフォルトのボリュームタイプは `gp2` です。 ``` aws ec2 create-volume \ --size 80 \ --availability-zone us-east-1a ``` **例 2: スナップショットからプロビジョンド IOPS SSD (io1) ボリュームを作成するには** 次の `create-volume` の例では、指定したスナップショットを使用して、指定したアベイラビリティーゾーンに 1,000 個のプロビジョニングされた IOPS を持つプロビジョンド IOPS SSD (io1) ボリュームを作成します。 ``` aws ec2 create-volume \ --volume-type io1 \ --iops 1000 \ --snapshot-id snap-066877671789bd71b \ --availability-zone us-east-1a ``` 出力: ``` { "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 } ``` **例 3: 暗号化されたボリュームを作成するには** 次の `create-volume` の例では、EBS 暗号化用のデフォルトの CMK を使用して暗号化されたボリュームを作成します。デフォルトで暗号化が無効になっている場合、次のように `--encrypted` パラメータを指定する必要があります。 ``` aws ec2 create-volume \ --size 80 \ --encrypted \ --availability-zone us-east-1a ``` 出力: ``` { "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 } ``` 暗号化がデフォルトで有効になっている場合、次の例のコマンドは、`--encrypted` パラメータがなくても暗号化されたボリュームを作成します。 ``` aws ec2 create-volume \ --size 80 \ --availability-zone us-east-1a ``` `--kms-key-id` パラメータを使用してカスタマー管理の CMK を指定する場合は、デフォルトで暗号化が有効になっていても `--encrypted` パラメータを指定する必要があります。 ``` aws ec2 create-volume \ --volume-type gp2 \ --size 80 \ --encrypted \ --kms-key-id 0ea3fef3-80a7-4778-9d8c-1c0c6EXAMPLE \ --availability-zone us-east-1a ``` **例 4: タグ付きのボリュームを作成するには** 次の `create-volume` の例では、ボリュームを作成して 2 つのタグを追加します。 ``` 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}]' ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateVolume](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-volume.html)」を参照してください。 ### `create-vpc-endpoint-connection-notification` 次のコード例は、`create-vpc-endpoint-connection-notification` を使用する方法を示しています。 **AWS CLI** **エンドポイントの接続通知を作成するには** この例では、インターフェイスエンドポイントがサービスに接続されているとき、およびエンドポイントがサービスに対して承諾されたときに警告する、特定のエンドポイントサービスの通知を作成します。 コマンド: ``` 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 ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateVpcEndpointConnectionNotification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-vpc-endpoint-connection-notification.html)」を参照してください。 ### `create-vpc-endpoint-service-configuration` 次のコード例は、`create-vpc-endpoint-service-configuration` を使用する方法を示しています。 **AWS CLI** **例 1: インターフェイスエンドポイントのエンドポイントサービス設定を作成するには** 次の `create-vpc-endpoint-service-configuration` の例では、Network Load Balancer `nlb-vpce` を使用して VPC エンドポイントサービス設定を作成します。この例では、インターフェイスエンドポイントを通じてサービスに接続するリクエストを承諾する必要があることも指定します。 ``` 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 ``` 出力: ``` { "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" ] } } ``` 詳細については、*AWS PrivateLink ユーザーガイド*の「[エンドポイントサービスの作成](https://docs.aws.amazon.com/vpc/latest/privatelink/create-endpoint-service.html)」を参照してください。 **例 2: Gateway Load Balancer エンドポイントのエンドポイントサービス設定を作成するには** 次の `create-vpc-endpoint-service-configuration` の例では、Gateway Load Balancer `GWLBService` を使用して VPC エンドポイントサービス設定を作成します。Gateway Load Balancer エンドポイントを介してサービスに接続するリクエストは自動的に承諾されます。 ``` 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 ``` 出力: ``` { "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" ] } } ``` 詳細については、*AWS PrivateLink ユーザーガイド*の「[Gateway Load Balancer エンドポイントサービスの作成](https://docs.aws.amazon.com/vpc/latest/privatelink/create-gateway-load-balancer-endpoint-service.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateVpcEndpointServiceConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-vpc-endpoint-service-configuration.html)」を参照してください。 ### `create-vpc-endpoint` 次のコード例は、`create-vpc-endpoint` を使用する方法を示しています。 **AWS CLI** **例 1: ゲートウェイエンドポイントを作成するには** 次の `create-vpc-endpoint` の例では、`us-east-1` リージョン内の VPC `vpc-1a2b3c4d` と Amazon S3 の間にゲートウェイ VPC エンドポイントを作成し、ルートテーブル `rtb-11aa22bb` をそのエンドポイントに関連付けます。 ``` aws ec2 create-vpc-endpoint \ --vpc-id vpc-1a2b3c4d \ --service-name com.amazonaws.us-east-1.s3 \ --route-table-ids rtb-11aa22bb ``` 出力: ``` { "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" } } ``` 詳細については、*AWS PrivateLink ユーザーガイド*の「[ゲートウェイエンドポイントを作成する](https://docs.aws.amazon.com/vpc/latest/privatelink/vpc-endpoints-s3.html#create-gateway-endpoint-s3)」を参照してください。 **例 2: インターフェイスエンドポイントを作成するには** 次の `create-vpc-endpoint` の例では、`us-east-1` リージョン内の VPC `vpc-1a2b3c4d` と Amazon S3 の間にインターフェイス VPC エンドポイントを作成します。コマンドにより、サブネット `subnet-1a2b3c4d` にエンドポイントが作成され、セキュリティグループ `sg-1a2b3c4d` に関連付けられ、「サービス」というキーと「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}] ``` 出力: ``` { "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" } } ``` 詳細については、*AWS PrivateLink ユーザーガイド*の「[インターフェイス VPC エンドポイントを作成する](https://docs.aws.amazon.com/vpc/latest/privatelink/create-interface-endpoint.html)」を参照してください。 **例 3: Gateway Load Balancer エンドポイントを作成するには** 次の `create-vpc-endpoint` の例では、VPC `vpc-111122223333aabbc` と、Gateway Load Balancer を使用して設定されたサービスの間に Gateway Load Balancer エンドポイントを作成します。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、*AWS PrivateLink ユーザーガイド*の「[Gateway Load Balancer エンドポイント](https://docs.aws.amazon.com/vpc/latest/privatelink/gateway-load-balancer-endpoints.html)」を参照してください。 **例 4: リソースエンドポイントを作成するには** 次の `create-vpc-endpoint` の例では、リソースエンドポイントを作成します。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS PrivateLink ユーザーガイド*」の「[Resource endpoints](https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-access-resources.html)」を参照してください。 **例 5: サービスネットワークエンドポイントを作成するには** 次の `create-vpc-endpoint` の例では、サービスネットワークエンドポイントを作成します。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS PrivateLink ユーザーガイド*」の「[Service network endpoints](https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-access-service-networks.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateVpcEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-vpc-endpoint.html)」を参照してください。 ### `create-vpc-peering-connection` 次のコード例は、`create-vpc-peering-connection` を使用する方法を示しています。 **AWS CLI** **VPC 間の VPC ピアリング接続を作成するには** この例では、vpc-1a2b3c4d と vpc-11122233 という VPC 間のピアリング接続をリクエストします。 コマンド: ``` aws ec2 create-vpc-peering-connection --vpc-id vpc-1a2b3c4d --peer-vpc-id vpc-11122233 ``` 出力: ``` { "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" } } } ``` **別のアカウントの VPC との VPC ピアリング接続を作成するには** この例では、VPC (vpc-1a2b3c4d) と、AWS アカウント 123456789012 に属する VPC (vpc-11122233) 間のピアリング接続をリクエストします。 コマンド: ``` aws ec2 create-vpc-peering-connection --vpc-id vpc-1a2b3c4d --peer-vpc-id vpc-11122233 --peer-owner-id 123456789012 ``` **異なるリージョンの VPC との VPC ピアリング接続を作成するには** この例では、現在のリージョンの VPC (vpc-1a2b3c4d) と、`us-west-2` リージョンのアカウント内にある VPC (vpc-11122233) 間のピアリング接続をリクエストします。 コマンド: ``` aws ec2 create-vpc-peering-connection --vpc-id vpc-1a2b3c4d --peer-vpc-id vpc-11122233 --peer-region us-west-2 ``` この例では、現在のリージョンの VPC (vpc-1a2b3c4d) と、`us-west-2` リージョン内の AWS アカウント 123456789012 に属する VPC (vpc-11122233) 間のピアリング接続をリクエストします。 コマンド: ``` aws ec2 create-vpc-peering-connection --vpc-id vpc-1a2b3c4d --peer-vpc-id vpc-11122233 --peer-owner-id 123456789012 --peer-region us-west-2 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateVpcPeeringConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-vpc-peering-connection.html)」を参照してください。 ### `create-vpc` 次のコード例は、`create-vpc` を使用する方法を示しています。 **AWS CLI** **例 1: VPC を作成するには** 次の `create-vpc` の例では、指定された IPv4 CIDR ブロックと Name タグを持つ VPC を作成しています。 ``` aws ec2 create-vpc \ --cidr-block 10.0.0.0/16 \ --tag-specifications ResourceType=vpc,Tags=[{Key=Name,Value=MyVpc}] ``` 出力: ``` { "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" } ] } } ``` **例 2: 専用テナンシーを持つ VPC を作成するには** 次の `create-vpc` の例では、指定された IPv4 CIDR ブロックと専用テナンシーを持つ VPC を作成しています。 ``` aws ec2 create-vpc \ --cidr-block 10.0.0.0/16 \ --instance-tenancy dedicated ``` 出力: ``` { "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 } } ``` **例 3: IPv6 CIDR ブロックで VPC を作成するには** 次の `create-vpc` の例では、Amazon が提供する IPv6 CIDR ブロックを使用して、VPC を作成しています。 ``` aws ec2 create-vpc \ --cidr-block 10.0.0.0/16 \ --amazon-provided-ipv6-cidr-block ``` 出力: ``` { "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 } } ``` **例 4: IPAM プールの CIDR を使って VPC を作成するには** 次の `create-vpc` の例では、Amazon VPC IP Address Manager (IPAM) プールの CIDR を使用して VPC を作成しています。 Linux および 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"}] ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[IPAM プール CIDR を使用する VPC を作成する](https://docs.aws.amazon.com/vpc/latest/ipam/create-vpc-ipam.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateVpc](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-vpc.html)」を参照してください。 ### `create-vpn-connection-route` 次のコード例は、`create-vpn-connection-route` を使用する方法を示しています。 **AWS CLI** **VPN 接続の静的ルートを作成するには** この例では、指定された VPN 接続に対して静的ルートを作成しています。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 create-vpn-connection-route --vpn-connection-id vpn-40f41529 --destination-cidr-block 11.12.0.0/16 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateVpnConnectionRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-vpn-connection-route.html)」を参照してください。 ### `create-vpn-connection` 次のコード例は、`create-vpn-connection` を使用する方法を示しています。 **AWS CLI** **例 1: 動的ルーティングを使用して VPN 接続を作成するには** 次の `create-vpn-connection` の例では、指定した仮想プライベートゲートウェイと指定したカスタマーゲートウェイの間に VPN 接続を作成し、VPN 接続にタグを適用します。出力には、カスタマーゲートウェイデバイスの設定情報が 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}]' ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*AWS Site-to-Site VPN ユーザーガイド*」の「[How AWS Site-to-Site VPN works](https://docs.aws.amazon.com/vpn/latest/s2svpn/how_it_works.html)」を参照してください。 **例 2: 静的ルーティングを使用して VPN 接続を作成するには** 次の `create-vpn-connection` の例では、指定した仮想プライベートゲートウェイと指定したカスタマーゲートウェイの間に VPN 接続を作成します。オプションで静的ルーティングを指定します。出力には、カスタマーゲートウェイデバイスの設定情報が XML 形式で含まれます。 ``` aws ec2 create-vpn-connection \ --type ipsec.1 \ --customer-gateway-id cgw-001122334455aabbc \ --vpn-gateway-id vgw-1a1a1a1a1a1a2b2b2 \ --options "{\"StaticRoutesOnly\":true}" ``` 出力: ``` { "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": [] } } ``` 詳細については、「*AWS Site-to-Site VPN ユーザーガイド*」の「[How AWS Site-to-Site VPN works](https://docs.aws.amazon.com/vpn/latest/s2svpn/how_it_works.html)」を参照してください。 **例 3: VPN 接続を作成し、CIDR 内で独自のキーと事前共有キーを指定するには** 次の `create-vpn-connection` の例では、VPN 接続を作成し、内部 IP アドレス CIDR ブロック、および各トンネルのカスタム事前共有キーを指定します。指定された値は `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}]' ``` 出力: ``` { "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": [] } } ``` 詳細については、「*AWS Site-to-Site VPN ユーザーガイド*」の「[How AWS Site-to-Site VPN works](https://docs.aws.amazon.com/vpn/latest/s2svpn/how_it_works.html)」を参照してください。 **例 4: IPv6 トラフィックをサポートする VPN 接続を作成するには** 次の `create-vpn-connection` の例では、指定した Transit Gateway と指定したカスタマーゲートウェイの間に IPv6 トラフィックをサポートする VPN 接続を作成します。両方のトンネルのトンネルオプションでは、AWS が 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}] ``` 出力: ``` { "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": [] } } ``` 詳細については、「*AWS Site-to-Site VPN ユーザーガイド*」の「[How AWS Site-to-Site VPN works](https://docs.aws.amazon.com/vpn/latest/s2svpn/how_it_works.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateVpnConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-vpn-connection.html)」を参照してください。 ### `create-vpn-gateway` 次のコード例は、`create-vpn-gateway` を使用する方法を示しています。 **AWS CLI** **仮想プライベートゲートウェイを作成するには** この例では、仮想プライベートゲートウェイを作成します。 コマンド: ``` aws ec2 create-vpn-gateway --type ipsec.1 ``` 出力: ``` { "VpnGateway": { "AmazonSideAsn": 64512, "State": "available", "Type": "ipsec.1", "VpnGatewayId": "vgw-9a4cacf3", "VpcAttachments": [] } } ``` **特定の Amazon 側の ASN を使用して仮想プライベートゲートウェイを作成するには** この例では、仮想プライベートゲートウェイを作成し、BGP セッションの Amazon 側に AS 番号 (ASN) を指定します。 コマンド: ``` aws ec2 create-vpn-gateway --type ipsec.1 --amazon-side-asn 65001 ``` 出力: ``` { "VpnGateway": { "AmazonSideAsn": 65001, "State": "available", "Type": "ipsec.1", "VpnGatewayId": "vgw-9a4cacf3", "VpcAttachments": [] } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateVpnGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/create-vpn-gateway.html)」を参照してください。 ### `delete-carrier-gateway` 次のコード例は、`delete-carrier-gateway` を使用する方法を示しています。 **AWS CLI** **キャリアゲートウェイを削除するには** 次の `delete-carrier-gateway` の例では、指定したキャリアゲートウェイを削除します。 ``` aws ec2 delete-carrier-gateway \ --carrier-gateway-id cagw-0465cdEXAMPLE1111 ``` 出力: ``` { "CarrierGateway": { "CarrierGatewayId": "cagw-0465cdEXAMPLE1111", "VpcId": "vpc-0c529aEXAMPLE1111", "State": "deleting", "OwnerId": "123456789012" } } ``` 詳細については、「*Amazon Virtual Private Cloud ユーザーガイド*」の「[Carrier gateways](https://docs.aws.amazon.com/vpc/latest/userguide/Carrier_Gateway.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCarrierGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-carrier-gateway.html)」を参照してください。 ### `delete-client-vpn-endpoint` 次のコード例は、`delete-client-vpn-endpoint` を使用する方法を示しています。 **AWS CLI** **クライアント VPN エンドポイントを削除するには** 次の `delete-client-vpn-endpoint` の例では、指定したクライアント VPN エンドポイントを削除します。 ``` aws ec2 delete-client-vpn-endpoint \ --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde ``` 出力: ``` { "Status": { "Code": "deleting" } } ``` 詳細については、「*AWS Client VPN 管理者ガイド*」の「[Client VPN Endpoints](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-endpoints.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteClientVpnEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-client-vpn-endpoint.html)」を参照してください。 ### `delete-client-vpn-route` 次のコード例は、`delete-client-vpn-route` を使用する方法を示しています。 **AWS CLI** **クライアント VPN エンドポイントのルートを削除するには** 次の `delete-client-vpn-route` の例では、クライアント VPN エンドポイントの指定されたサブネット用の `0.0.0.0/0` ルートを削除します。 ``` 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 ``` 出力: ``` { "Status": { "Code": "deleting" } } ``` 詳細については、「*AWS Client VPN 管理者ガイド*」の「[Routes](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-routes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteClientVpnRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-client-vpn-route.html)」を参照してください。 ### `delete-coip-cidr` 次のコード例は、`delete-coip-cidr` を使用する方法を示しています。 **AWS CLI** **顧客所有の IP (CoIP) アドレスの範囲を削除するには** 次の `delete-coip-cidr` の例では、指定した CoIP プールに指定した CoIP アドレスの範囲を削除します。 ``` aws ec2 delete-coip-cidr \ --cidr 14.0.0.0/24 \ --coip-pool-id ipv4pool-coip-1234567890abcdefg ``` 出力: ``` { "CoipCidr": { "Cidr": "14.0.0.0/24", "CoipPoolId": "ipv4pool-coip-1234567890abcdefg", "LocalGatewayRouteTableId": "lgw-rtb-abcdefg1234567890" } } ``` CoIP の詳細については、「*AWS Outposts ユーザーガイド*」の「[カスタマー所有の IP アドレス](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCoipCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-coip-cidr.html)」を参照してください。 ### `delete-coip-pool` 次のコード例は、`delete-coip-pool` を使用する方法を示しています。 **AWS CLI** **顧客所有の IP (CoIP) アドレスのプールを削除するには** 次の `delete-coip-pool` の例では、CoIP アドレスの CoIP プールを削除します。 ``` aws ec2 delete-coip-pool \ --coip-pool-id ipv4pool-coip-1234567890abcdefg ``` 出力: ``` { "CoipPool": { "PoolId": "ipv4pool-coip-1234567890abcdefg", "LocalGatewayRouteTableId": "lgw-rtb-abcdefg1234567890", "PoolArn": "arn:aws:ec2:us-west-2:123456789012:coip-pool/ipv4pool-coip-1234567890abcdefg" } } ``` CoIP の詳細については、「*AWS Outposts ユーザーガイド*」の「[カスタマー所有の IP アドレス](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCoipPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-coip-pool.html)」を参照してください。 ### `delete-customer-gateway` 次のコード例は、`delete-customer-gateway` を使用する方法を示しています。 **AWS CLI** **カスタマーゲートウェイを削除するには** この例では、指定されたカスタマーゲートウェイを削除します。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 delete-customer-gateway --customer-gateway-id cgw-0e11f167 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCustomerGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-customer-gateway.html)」を参照してください。 ### `delete-dhcp-options` 次のコード例は、`delete-dhcp-options` を使用する方法を示しています。 **AWS CLI** **DHCP オプションセットを削除するには** この例では、指定された DHCP オプションのセットを削除します。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 delete-dhcp-options --dhcp-options-id dopt-d9070ebb ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDhcpOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-dhcp-options.html)」を参照してください。 ### `delete-egress-only-internet-gateway` 次のコード例は、`delete-egress-only-internet-gateway` を使用する方法を示しています。 **AWS CLI** **Egress-Only インターネットゲートウェイを削除するには** この例では、指定された Egress-Only インターネットゲートウェイを削除します。 コマンド: ``` aws ec2 delete-egress-only-internet-gateway --egress-only-internet-gateway-id eigw-01eadbd45ecd7943f ``` 出力: ``` { "ReturnCode": true } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteEgressOnlyInternetGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-egress-only-internet-gateway.html)」を参照してください。 ### `delete-fleets` 次のコード例は、`delete-fleets` を使用する方法を示しています。 **AWS CLI** **例 1: EC2 フリートを削除し、関連付けられたインスタンスを終了するには** 次の `delete-fleets` の例では、EC2 フリートを削除し、関連付けられたオンデマンドインスタンスとスポットインスタンスを終了します。 ``` aws ec2 delete-fleets \ --fleet-ids fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE \ --terminate-instances ``` 出力: ``` { "SuccessfulFleetDeletions": [ { "CurrentFleetState": "deleted_terminating", "PreviousFleetState": "active", "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" } ], "UnsuccessfulFleetDeletions": [] } ``` 詳細については、「*Amazon Elastic Compute Cloud User Guide for Linux Instances*」の「[Delete an EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#delete-fleet)」を参照してください。 **例 2: 関連付けられたインスタンスを終了せずに EC2 フリートを削除するには** 次の `delete-fleets` の例では、関連付けられたオンデマンドインスタンスとスポットインスタンスを終了しないで、EC2 フリートを削除します。 ``` aws ec2 delete-fleets \ --fleet-ids fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE \ --no-terminate-instances ``` 出力: ``` { "SuccessfulFleetDeletions": [ { "CurrentFleetState": "deleted_running", "PreviousFleetState": "active", "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" } ], "UnsuccessfulFleetDeletions": [] } ``` 詳細については、「*Amazon Elastic Compute Cloud User Guide for Linux Instances*」の「[Delete an EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#delete-fleet)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteFleets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-fleets.html)」を参照してください。 ### `delete-flow-logs` 次のコード例は、`delete-flow-logs` を使用する方法を示しています。 **AWS CLI** **フローログを削除するには** 次の `delete-flow-logs` の例では、指定したフローログを削除します。 ``` aws ec2 delete-flow-logs --flow-log-id fl-11223344556677889 ``` 出力: ``` { "Unsuccessful": [] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteFlowLogs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-flow-logs.html)」を参照してください。 ### `delete-fpga-image` 次のコード例は、`delete-fpga-image` を使用する方法を示しています。 **AWS CLI** **Amazon FPGA イメージを削除するには** この例では、指定されたキューを削除します。 コマンド: ``` aws ec2 delete-fpga-image --fpga-image-id afi-06b12350a123fbabc ``` 出力: ``` { "Return": true } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteFpgaImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-fpga-image.html)」を参照してください。 ### `delete-instance-connect-endpoint` 次のコード例は、`delete-instance-connect-endpoint` を使用する方法を示しています。 **AWS CLI** **EC2 Instance Connect エンドポイントを削除するには** 次の `delete-instance-connect-endpoint` の例では、指定した EC2 Instance Connect エンドポイントを削除します。 ``` aws ec2 delete-instance-connect-endpoint \ --instance-connect-endpoint-id eice-03f5e49b83924bbc7 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[EC2 Instance Connect エンドポイントを削除する](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/delete-ec2-instance-connect-endpoint.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteInstanceConnectEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-instance-connect-endpoint.html)」を参照してください。 ### `delete-instance-event-window` 次のコード例は、`delete-instance-event-window` を使用する方法を示しています。 **AWS CLI** **例 1: イベントウィンドウを削除するには** 次の `delete-instance-event-window` の例では、イベントウィンドウを削除します。 ``` aws ec2 delete-instance-event-window \ --region us-east-1 \ --instance-event-window-id iew-0abcdef1234567890 ``` 出力: ``` { "InstanceEventWindowState": { "InstanceEventWindowId": "iew-0abcdef1234567890", "State": "deleting" } } ``` イベントウィンドウの制約については、「*Amazon EC2 ユーザーガイド*」の予定されているイベントに関するセクションの「[考慮事項](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html#event-windows-considerations)」を参照してください。 **例 2: イベントウィンドウを強制的に削除するには** 次の `delete-instance-event-window` の例では、イベントウィンドウが現在ターゲットに関連付けられている場合、イベントウィンドウを強制的に削除します。 ``` aws ec2 delete-instance-event-window \ --region us-east-1 \ --instance-event-window-id iew-0abcdef1234567890 \ --force-delete ``` 出力: ``` { "InstanceEventWindowState": { "InstanceEventWindowId": "iew-0abcdef1234567890", "State": "deleting" } } ``` イベントウィンドウの制約については、「*Amazon EC2 ユーザーガイド*」の予定されているイベントに関するセクションの「[考慮事項](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html#event-windows-considerations)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteInstanceEventWindow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-instance-event-window.html)」を参照してください。 ### `delete-internet-gateway` 次のコード例は、`delete-internet-gateway` を使用する方法を示しています。 **AWS CLI** **インターネットゲートウェイを削除するには** 次の `delete-internet-gateway` の例では、指定したインターネットゲートウェイを削除します。 ``` aws ec2 delete-internet-gateway \ --internet-gateway-id igw-0d0fb496b3EXAMPLE ``` このコマンドでは何も出力されません。 詳細については、*Amazon VPC ユーザーガイド*の「[インターネットゲートウェイ](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteInternetGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-internet-gateway.html)」を参照してください。 ### `delete-ipam-pool` 次のコード例は、`delete-ipam-pool` を使用する方法を示しています。 **AWS CLI** **IPAM プールを削除するには** この例では、あなたは IPAM の委任された管理者として、不要になった IPAM プールを削除したいと考えていますが、そのプールには CIDR がプロビジョニングされています。`--cascade` オプションを使用しない限り、CIDR がプロビジョニングされているプールを削除することはできないため、`--cascade` を使用します。 このリクエストを完了するには: [describe-ipam-pools](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-ipam-pools.html) で取得できる IPAM プール ID が必要です。`--region` は IPAM ホームリージョンである必要があります。 次の `delete-ipam-pool` の例では、AWS アカウントの IPAM プールを削除します。 ``` aws ec2 delete-ipam-pool \ --ipam-pool-id ipam-pool-050c886a3ca41cd5b \ --cascade \ --region us-east-1 ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[Delete a pool](https://docs.aws.amazon.com/vpc/latest/ipam/delete-pool-ipam.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteIpamPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-ipam-pool.html)」を参照してください。 ### `delete-ipam-resource-discovery` 次のコード例は、`delete-ipam-resource-discovery` を使用する方法を示しています。 **AWS CLI** **リソース検出を削除するには** この例では、あなたは IPAM の委任された管理者として、組織外のアカウントと IPAM を統合するプロセス中に別の IPAM 管理者と共有するために作成した、デフォルト以外のリソース検出を削除したいと考えています。 このリクエストを完了するには: `--region` は、リソース検出を作成したリージョンである必要があります。`"IsDefault": true` の場合、デフォルトのリソース検出を削除することはできません。デフォルトのリソース検出は、IPAM の作成時に自動的に作成されるリソース検出です。デフォルトのリソース検出を削除するには、IPAM を削除する必要があります。 次の `delete-ipam-resource-discovery` の例では、リソース検出を削除します。 ``` aws ec2 delete-ipam-resource-discovery \ --ipam-resource-discovery-id ipam-res-disco-0e39761475298ee0f \ --region us-east-1 ``` 出力: ``` { "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" } } ``` リソース検出の詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[Work with resource discoveries](https://docs.aws.amazon.com/vpc/latest/ipam/res-disc-work-with.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteIpamResourceDiscovery](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-ipam-resource-discovery.html)」を参照してください。 ### `delete-ipam-scope` 次のコード例は、`delete-ipam-scope` を使用する方法を示しています。 **AWS CLI** **IPAM スコープを削除するには** 次の `delete-ipam-scope` の例では、IPAM を削除します。 ``` aws ec2 delete-ipam-scope \ --ipam-scope-id ipam-scope-01c1ebab2b63bd7e4 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[Delete a scope](https://docs.aws.amazon.com/vpc/latest/ipam/delete-scope-ipam.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteIpamScope](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-ipam-scope.html)」を参照してください。 ### `delete-ipam` 次のコード例は、`delete-ipam` を使用する方法を示しています。 **AWS CLI** **IPAM を削除するには** 次の `delete-ipam` の例では、IPAM を削除します。 ``` aws ec2 delete-ipam \ --ipam-id ipam-036486dfa6af58ee0 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[Delete an IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/delete-ipam.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteIpam](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-ipam.html)」を参照してください。 ### `delete-key-pair` 次のコード例は、`delete-key-pair` を使用する方法を示しています。 **AWS CLI** **キーペアを削除するには** 次の `delete-key-pair` の例では、指定されたキーペアを削除します。 ``` aws ec2 delete-key-pair \ --key-name my-key-pair ``` 出力: ``` { "Return": true, "KeyPairId": "key-03c8d3aceb53b507" } ``` 詳細については、「*AWS コマンドラインインターフェイス*」の「[Create and delete key pairs](https://docs.aws.amazon.com/cli/latest/userguide/cli-ec2-keypairs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteKeyPair](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-key-pair.html)」を参照してください。 ### `delete-launch-template-versions` 次のコード例は、`delete-launch-template-versions` を使用する方法を示しています。 **AWS CLI** **起動テンプレートのバージョンを削除するには** この例では、指定した起動テンプレートを削除しています。 コマンド: ``` aws ec2 delete-launch-template-versions --launch-template-id lt-0abcd290751193123 --versions 1 ``` 出力: ``` { "UnsuccessfullyDeletedLaunchTemplateVersions": [], "SuccessfullyDeletedLaunchTemplateVersions": [ { "LaunchTemplateName": "TestVersion", "VersionNumber": 1, "LaunchTemplateId": "lt-0abcd290751193123" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteLaunchTemplateVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-launch-template-versions.html)」を参照してください。 ### `delete-launch-template` 次のコード例は、`delete-launch-template` を使用する方法を示しています。 **AWS CLI** **起動テンプレートを削除するには** 次の例では、指定した起動テンプレートを削除しています。 コマンド: ``` aws ec2 delete-launch-template --launch-template-id lt-0abcd290751193123 ``` 出力: ``` { "LaunchTemplate": { "LatestVersionNumber": 2, "LaunchTemplateId": "lt-0abcd290751193123", "LaunchTemplateName": "TestTemplate", "DefaultVersionNumber": 2, "CreatedBy": "arn:aws:iam::123456789012:root", "CreateTime": "2017-11-23T16:46:25.000Z" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteLaunchTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-launch-template.html)」を参照してください。 ### `delete-local-gateway-route-table-virtual-interface-group-association` 次のコード例は、`delete-local-gateway-route-table-virtual-interface-group-association` を使用する方法を示しています。 **AWS CLI** **仮想インターフェイス (VIF) グループからローカルゲートウェイのルートテーブルの関連付けを解除するには** 次の `delete-local-gateway-route-table-virtual-interface-group-association` の例では、指定したローカルゲートウェイのルートテーブルと 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 ``` 出力: ``` { "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": [] } } ``` 詳細については、「*AWS Outposts ユーザーガイド*」の「[VIF group associations](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#vif-group-associations)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-local-gateway-route-table-virtual-interface-group-association.html)」を参照してください。 ### `delete-local-gateway-route-table-vpc-association` 次のコード例は、`delete-local-gateway-route-table-vpc-association` を使用する方法を示しています。 **AWS CLI** **VPC からローカルゲートウェイのルートテーブルの関連付けを解除するには** 次の `delete-local-gateway-route-table-vpc-association` の例では、指定したローカルゲートウェイのルートテーブルと VPC 間の関連付けを削除します。 ``` aws ec2 delete-local-gateway-route-table-vpc-association \ --local-gateway-route-table-vpc-association-id vpc-example0123456789 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Outposts ユーザーガイド*」の「[VPC associations](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#vpc-associations)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteLocalGatewayRouteTableVpcAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-local-gateway-route-table-vpc-association.html)」を参照してください。 ### `delete-local-gateway-route-table` 次のコード例は、`delete-local-gateway-route-table` を使用する方法を示しています。 **AWS CLI** **ローカルゲートウェイのルートテーブルを作成するには** 次の `delete-local-gateway-route-table` の例では、直接 VPC ルーティングモードでローカルゲートウェイのルートテーブルを作成します。 ``` aws ec2 delete-local-gateway-route-table \ --local-gateway-route-table-id lgw-rtb-abcdefg1234567890 ``` 出力: ``` { "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" } } ``` 詳細については、「AWS Outposts ユーザーガイド」の「[ローカルゲートウェイルートテーブル](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteLocalGatewayRouteTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-local-gateway-route-table.html)」を参照してください。 ### `delete-local-gateway-route` 次のコード例は、`delete-local-gateway-route` を使用する方法を示しています。 **AWS CLI** **ローカルゲートウェイのルートテーブルからルートを削除するには** 次の `delete-local-gateway-route` の例では、指定したローカルゲートウェイのルートテーブルから指定したルートを削除します。 ``` aws ec2 delete-local-gateway-route \ --destination-cidr-block 0.0.0.0/0 \ --local-gateway-route-table-id lgw-rtb-059615ef7dEXAMPLE ``` 出力: ``` { "Route": { "DestinationCidrBlock": "0.0.0.0/0", "LocalGatewayVirtualInterfaceGroupId": "lgw-vif-grp-07145b276bEXAMPLE", "Type": "static", "State": "deleted", "LocalGatewayRouteTableId": "lgw-rtb-059615ef7EXAMPLE" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteLocalGatewayRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-local-gateway-route.html)」を参照してください。 ### `delete-managed-prefix-list` 次のコード例は、`delete-managed-prefix-list` を使用する方法を示しています。 **AWS CLI** **プレフィックスリストを削除するには** 次の `delete-managed-prefix-list` の例では、指定したプレフィックスリストを削除します。 ``` aws ec2 delete-managed-prefix-list \ --prefix-list-id pl-0123456abcabcabc1 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon VPC ユーザーガイド*」の「[Managed prefix lists](https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteManagedPrefixList](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-managed-prefix-list.html)」を参照してください。 ### `delete-nat-gateway` 次のコード例は、`delete-nat-gateway` を使用する方法を示しています。 **AWS CLI** **NAT ゲートウェイを削除するには** この例では、NAT ゲートウェイ `nat-04ae55e711cec5680` を削除します。 コマンド: ``` aws ec2 delete-nat-gateway --nat-gateway-id nat-04ae55e711cec5680 ``` 出力: ``` { "NatGatewayId": "nat-04ae55e711cec5680" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteNatGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-nat-gateway.html)」を参照してください。 ### `delete-network-acl-entry` 次のコード例は、`delete-network-acl-entry` を使用する方法を示しています。 **AWS CLI** **ネットワーク ACL エントリを削除するには** この例では、指定されたネットワーク ACL から受信ルール番号 100 を削除します。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 delete-network-acl-entry --network-acl-id acl-5fb85d36 --ingress --rule-number 100 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteNetworkAclEntry](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-network-acl-entry.html)」を参照してください。 ### `delete-network-acl` 次のコード例は、`delete-network-acl` を使用する方法を示しています。 **AWS CLI** **ネットワーク ACL を削除するには** この例では、指定されたネットワーク ACL を削除します。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 delete-network-acl --network-acl-id acl-5fb85d36 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteNetworkAcl](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-network-acl.html)」を参照してください。 ### `delete-network-insights-access-scope-analysis` 次のコード例は、`delete-network-insights-access-scope-analysis` を使用する方法を示しています。 **AWS CLI** **Network Access Scope の分析を削除するには** 次の `delete-network-insights-access-scope-analysis` の例では、指定した Network Access Scope の分析を削除します。 ``` aws ec2 delete-network-insights-access-scope-analysis \ --network-insights-access-scope-analysis-id nisa-01234567891abcdef ``` 出力: ``` { "NetworkInsightsAccessScopeAnalysisId": "nisa-01234567891abcdef } ``` 詳細については、「*Network Access Analyzer ガイド*」の「[Getting started with Network Access Analyzer using the AWS CLI](https://docs.aws.amazon.com/vpc/latest/network-access-analyzer/getting-started-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteNetworkInsightsAccessScopeAnalysis](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-network-insights-access-scope-analysis.html)」を参照してください。 ### `delete-network-insights-access-scope` 次のコード例は、`delete-network-insights-access-scope` を使用する方法を示しています。 **AWS CLI** **Network Access Scope を削除するには** 次の `delete-network-insights-access-scope` の例では、指定した Network Access Scope を削除します。 ``` aws ec2 delete-network-insights-access-scope \ --network-insights-access-scope-id nis-123456789abc01234 ``` 出力: ``` { "NetworkInsightsAccessScopeId": "nis-123456789abc01234" } ``` 詳細については、「*Network Access Analyzer ガイド*」の「[Getting started with Network Access Analyzer using the AWS CLI](https://docs.aws.amazon.com/vpc/latest/network-access-analyzer/getting-started-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteNetworkInsightsAccessScope](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-network-insights-access-scope.html)」を参照してください。 ### `delete-network-insights-analysis` 次のコード例は、`delete-network-insights-analysis` を使用する方法を示しています。 **AWS CLI** **パス分析を削除するには** 次の `delete-network-insights-analysis` の例では、指定した分析を削除します。 ``` aws ec2 delete-network-insights-analysis \ --network-insights-analysis-id nia-02207aa13eb480c7a ``` 出力: ``` { "NetworkInsightsAnalysisId": "nia-02207aa13eb480c7a" } ``` 詳細については、「*Reachability Analyzer ガイド*」の「[Getting started using the AWS CLI](https://docs.aws.amazon.com/vpc/latest/reachability/getting-started-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteNetworkInsightsAnalysis](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-network-insights-analysis.html)」を参照してください。 ### `delete-network-insights-path` 次のコード例は、`delete-network-insights-path` を使用する方法を示しています。 **AWS CLI** **パスを削除するには** 次の `delete-network-insights-path` の例では、指定したパスを削除します。パスを削除する前に、`delete-network-insights-analysis` コマンドを使用してすべての分析を削除する必要があります。 ``` aws ec2 delete-network-insights-path \ --network-insights-path-id nip-0b26f224f1d131fa8 ``` 出力: ``` { "NetworkInsightsPathId": "nip-0b26f224f1d131fa8" } ``` 詳細については、「*Reachability Analyzer ガイド*」の「[Getting started using the AWS CLI](https://docs.aws.amazon.com/vpc/latest/reachability/getting-started-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteNetworkInsightsPath](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-network-insights-path.html)」を参照してください。 ### `delete-network-interface-permission` 次のコード例は、`delete-network-interface-permission` を使用する方法を示しています。 **AWS CLI** **ネットワークインターフェイス権限を削除するには** この例では、指定されたネットワークインターフェイスのアクセス許可を削除します。 コマンド: ``` aws ec2 delete-network-interface-permission --network-interface-permission-id eni-perm-06fd19020ede149ea ``` 出力: ``` { "Return": true } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteNetworkInterfacePermission](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-network-interface-permission.html)」を参照してください。 ### `delete-network-interface` 次のコード例は、`delete-network-interface` を使用する方法を示しています。 **AWS CLI** **ネットワークインターフェイスを削除するには** この例では、指定されたネットワークインターフェイスを削除します。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 delete-network-interface --network-interface-id eni-e5aa89a3 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteNetworkInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-network-interface.html)」を参照してください。 ### `delete-placement-group` 次のコード例は、`delete-placement-group` を使用する方法を示しています。 **AWS CLI** **プレイスメントグループを削除するには** このコマンド例では、指定されたプレイスメントグループを削除します。 コマンド: ``` aws ec2 delete-placement-group --group-name my-cluster ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeletePlacementGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-placement-group.html)」を参照してください。 ### `delete-queued-reserved-instances` 次のコード例は、`delete-queued-reserved-instances` を使用する方法を示しています。 **AWS CLI** **キューに入っている購入をキャンセルするには** 次の `delete-queued-reserved-instances` の例では、指定したリザーブドインスタンス (購入のためにキューに入れられていたもの) を削除します。 ``` aws ec2 delete-queued-reserved-instances \ --reserved-instances-ids af9f760e-6f91-4559-85f7-4980eexample ``` 出力: ``` { "SuccessfulQueuedPurchaseDeletions": [ { "ReservedInstancesId": "af9f760e-6f91-4559-85f7-4980eexample" } ], "FailedQueuedPurchaseDeletions": [] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteQueuedReservedInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-queued-reserved-instances.html)」を参照してください。 ### `delete-route-table` 次のコード例は、`delete-route-table` を使用する方法を示しています。 **AWS CLI** **ルートテーブルを削除するには** この例では、指定されたルートテーブルを削除します。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 delete-route-table --route-table-id rtb-22574640 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRouteTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-route-table.html)」を参照してください。 ### `delete-route` 次のコード例は、`delete-route` を使用する方法を示しています。 **AWS CLI** **ルートを削除するには** この例では、指定したルートテーブルから指定したルートを削除します。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 delete-route --route-table-id rtb-22574640 --destination-cidr-block 0.0.0.0/0 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-route.html)」を参照してください。 ### `delete-security-group` 次のコード例は、`delete-security-group` を使用する方法を示しています。 **AWS CLI** **[EC2-Classic] セキュリティグループを削除するには** この例では、`MySecurityGroup` という名前のセキュリティグループを削除します。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 delete-security-group --group-name MySecurityGroup ``` **[EC2-VPC] セキュリティグループを削除するには** この例では、`sg-903004f8` という ID のセキュリティグループを削除します。EC2-VPC 用セキュリティグループは名前では参照できないことに注意してください。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 delete-security-group --group-id sg-903004f8 ``` 詳細については、「*AWS コマンドラインインターフェイスユーザーガイド*」でセキュリティグループの使用方法を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteSecurityGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-security-group.html)」を参照してください。 ### `delete-snapshot` 次のコード例は、`delete-snapshot` を使用する方法を示しています。 **AWS CLI** **スナップショットを削除するには** このコマンド例は、スナップショット ID が `snap-1234567890abcdef0` のスナップショットを削除します。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 delete-snapshot --snapshot-id snap-1234567890abcdef0 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-snapshot.html)」を参照してください。 ### `delete-spot-datafeed-subscription` 次のコード例は、`delete-spot-datafeed-subscription` を使用する方法を示しています。 **AWS CLI** **スポットインスタンスデータフィードサブスクリプションをキャンセルするには** このコマンド例では、アカウントのスポットデータフィードサブスクリプションを削除します。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 delete-spot-datafeed-subscription ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteSpotDatafeedSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-spot-datafeed-subscription.html)」を参照してください。 ### `delete-subnet-cidr-reservation` 次のコード例は、`delete-subnet-cidr-reservation` を使用する方法を示しています。 **AWS CLI** **サブネット CIDR 予約を削除するには** 次の `delete-subnet-cidr-reservation` の例では、指定したサブネット CIDR 予約を削除します。 ``` aws ec2 delete-subnet-cidr-reservation \ --subnet-cidr-reservation-id scr-044f977c4eEXAMPLE ``` 出力: ``` { "DeletedSubnetCidrReservation": { "SubnetCidrReservationId": "scr-044f977c4eEXAMPLE", "SubnetId": "subnet-03c51e2e6cEXAMPLE", "Cidr": "10.1.0.16/28", "ReservationType": "prefix", "OwnerId": "123456789012" } } ``` 詳細については、*Amazon VPC ユーザーガイド*の[サブネット CIDR の予約](https://docs.aws.amazon.com/vpc/latest/userguide/subnet-cidr-reservation.html)を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteSubnetCidrReservation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-subnet-cidr-reservation.html)」を参照してください。 ### `delete-subnet` 次のコード例は、`delete-subnet` を使用する方法を示しています。 **AWS CLI** **サブネットを削除するには** この例では、指定されたサブネットを削除します。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 delete-subnet --subnet-id subnet-9d4a7b6c ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteSubnet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-subnet.html)」を参照してください。 ### `delete-tags` 次のコード例は、`delete-tags` を使用する方法を示しています。 **AWS CLI** **例 1: リソースからタグを削除するには** 次の `delete-tags` の例では、指定したイメージからタグ `Stack=Test` を削除します。値とキー名の両方を指定すると、タグの値が指定された値と一致する場合にのみ、タグは削除されます。 ``` aws ec2 delete-tags \ --resources ami-1234567890abcdef0 \ --tags Key=Stack,Value=Test ``` タグの値を指定することはオプションです。次の `delete-tags` の例では、タグのタグ値に関係なく、指定したインスタンスからキー名 `purpose` を持つタグを削除します。 ``` aws ec2 delete-tags \ --resources i-1234567890abcdef0 \ --tags Key=purpose ``` 空の文字列をタグ値として指定すると、タグの値が空の文字列である場合にのみタグが削除されます。次の `delete-tags` の例では、空の文字列を、削除するタグのタグ値として指定します。 ``` aws ec2 delete-tags \ --resources i-1234567890abcdef0 \ --tags Key=Name,Value= ``` **例 2: 複数のリソースからタグを削除するには** 次の `delete-tags` の例では、インスタンスと AMI の両方からタグ「Purpose=Test」を削除します。前の例に示されているように、コマンドのタグ値を省略できます。 ``` aws ec2 delete-tags \ --resources i-1234567890abcdef0 ami-1234567890abcdef0 \ --tags Key=Purpose ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-tags.html)」を参照してください。 ### `delete-traffic-mirror-filter-rule` 次のコード例は、`delete-traffic-mirror-filter-rule` を使用する方法を示しています。 **AWS CLI** **トラフィックミラーフィルタールールを削除するには** 次の `delete-traffic-mirror-filter-rule` の例では、指定したトラフィックミラーフィルタールールを削除します。 ``` aws ec2 delete-traffic-mirror-filter-rule \ --traffic-mirror-filter-rule-id tmfr-081f71283bEXAMPLE ``` 出力: ``` { "TrafficMirrorFilterRuleId": "tmfr-081f71283bEXAMPLE" } ``` 詳細については、「*AWS トラフィックミラーリングガイド*」の「[Modify Your Traffic Mirror Filter Rules](https://docs.aws.amazon.com/vpc/latest/mirroring/traffic-mirroring-filter.html#modify-traffic-mirroring-filter-rules)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteTrafficMirrorFilterRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-traffic-mirror-filter-rule.html)」を参照してください。 ### `delete-traffic-mirror-filter` 次のコード例は、`delete-traffic-mirror-filter` を使用する方法を示しています。 **AWS CLI** **トラフィックミラーフィルターを削除するには** 次の `delete-traffic-mirror-filter` の例では、指定したトラフィックミラーフィルターを削除します。 ``` aws ec2 delete-traffic-mirror-filter \ --traffic-mirror-filter-id tmf-0be0b25fcdEXAMPLE ``` 出力: ``` { "TrafficMirrorFilterId": "tmf-0be0b25fcdEXAMPLE" } ``` 詳細については、「*AWS トラフィックミラーリングガイド*」の「[Delete a Traffic Mirror Filter](https://docs.aws.amazon.com/vpc/latest/mirroring/traffic-mirroring-filter.html#delete-traffic-mirroring-filter)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteTrafficMirrorFilter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-traffic-mirror-filter.html)」を参照してください。 ### `delete-traffic-mirror-session` 次のコード例は、`delete-traffic-mirror-session` を使用する方法を示しています。 **AWS CLI** **トラフィックミラーセッションを削除するには** 次の `delete-traffic-mirror-session` の例では、指定したトラフィックミラーセッションを削除します。 ``` aws ec2 delete-traffic-mirror-session \ --traffic-mirror-session-id tms-0af3141ce5EXAMPLE ``` 出力: ``` { "TrafficMirrorSessionId": "tms-0af3141ce5EXAMPLE" } ``` 詳細については、「*AWS トラフィックミラーリングガイド*」の「[Delete a Traffic Mirror Session](https://docs.aws.amazon.com/vpc/latest/mirroring/traffic-mirroring-session.html#delete-traffic-mirroring-session)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteTrafficMirrorSession](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-traffic-mirror-session.html)」を参照してください。 ### `delete-traffic-mirror-target` 次のコード例は、`delete-traffic-mirror-target` を使用する方法を示しています。 **AWS CLI** **トラフィックミラーターゲットを削除するには** 次の `delete-traffic-mirror-target` の例では、指定したトラフィックミラーターゲットを削除します。 ``` aws ec2 delete-traffic-mirror-target \ --traffic-mirror-target-id tmt-060f48ce9EXAMPLE ``` 出力: ``` { "TrafficMirrorTargetId": "tmt-060f48ce9EXAMPLE" } ``` 詳細については、「*AWS トラフィックミラーリングガイド*」の「[Delete a Traffic Mirror Target](https://docs.aws.amazon.com/vpc/latest/mirroring/traffic-mirroring-target.html#delete-traffic-mirroring-target)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteTrafficMirrorTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-traffic-mirror-target.html)」を参照してください。 ### `delete-transit-gateway-connect-peer` 次のコード例は、`delete-transit-gateway-connect-peer` を使用する方法を示しています。 **AWS CLI** **Transit Gateway Connect ピアを削除するには** 次の `delete-transit-gateway-connect-peer` の例では、指定した Connect ピアを削除します。 ``` aws ec2 delete-transit-gateway-connect-peer \ --transit-gateway-connect-peer-id tgw-connect-peer-0666adbac4EXAMPLE ``` 出力: ``` { "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" } ] } } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Transit gateway Connect attachments and Transit Gateway Connect peers](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteTransitGatewayConnectPeer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-transit-gateway-connect-peer.html)」を参照してください。 ### `delete-transit-gateway-connect` 次のコード例は、`delete-transit-gateway-connect` を使用する方法を示しています。 **AWS CLI** **Transit Gateway Connect アタッチメントを削除するには** 次の `delete-transit-gateway-connect` の例では、指定した Connect アタッチメントを削除します。 ``` aws ec2 delete-transit-gateway-connect \ --transit-gateway-attachment-id tgw-attach-037012e5dcEXAMPLE ``` 出力: ``` { "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" } } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Transit gateway Connect attachments and Transit Gateway Connect peers](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteTransitGatewayConnect](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-transit-gateway-connect.html)」を参照してください。 ### `delete-transit-gateway-multicast-domain` 次のコード例は、`delete-transit-gateway-multicast-domain` を使用する方法を示しています。 **AWS CLI** **Transit Gateway マルチキャストドメインを削除するには** 次の `delete-transit-gateway-multicast-domain` の例では、指定したマルチキャストドメインを削除します。 ``` aws ec2 delete-transit-gateway-multicast-domain \ --transit-gateway-multicast-domain-id tgw-mcast-domain-0c4905cef7EXAMPLE ``` 出力: ``` { "TransitGatewayMulticastDomain": { "TransitGatewayMulticastDomainId": "tgw-mcast-domain-02bb79002bEXAMPLE", "TransitGatewayId": "tgw-0d88d2d0d5EXAMPLE", "State": "deleting", "CreationTime": "2019-11-20T22:02:03.000Z" } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Managing multicast domains](https://docs.aws.amazon.com/vpc/latest/tgw/manage-domain.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteTransitGatewayMulticastDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-transit-gateway-multicast-domain.html)」を参照してください。 ### `delete-transit-gateway-peering-attachment` 次のコード例は、`delete-transit-gateway-peering-attachment` を使用する方法を示しています。 **AWS CLI** **Transit Gateway ピアリングアタッチメントを削除するには** 次の `delete-transit-gateway-peering-attachment` の例では、指定した Transit Gateway ピアリングアタッチメントを削除します。 ``` aws ec2 delete-transit-gateway-peering-attachment \ --transit-gateway-attachment-id tgw-attach-4455667788aabbccd ``` 出力: ``` { "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" } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Transit Gateway Peering Attachments](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-peering.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteTransitGatewayPeeringAttachment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-transit-gateway-peering-attachment.html)」を参照してください。 ### `delete-transit-gateway-policy-table` 次のコード例は、`delete-transit-gateway-policy-table` を使用する方法を示しています。 **AWS CLI** **Transit Gateway ポリシーテーブルを削除するには** 次の `delete-transit-gateway-policy-table` の例では、指定した Transit Gateway ポリシーテーブルを削除します。 ``` aws ec2 delete-transit-gateway-policy-table \ --transit-gateway-policy-table-id tgw-ptb-0a16f134b78668a81 ``` 出力: ``` { "TransitGatewayPolicyTables": [ { "TransitGatewayPolicyTableId": "tgw-ptb-0a16f134b78668a81", "TransitGatewayId": "tgw-067f8505c18f0bd6e", "State": "deleting", "CreationTime": "2023-11-28T16:36:43+00:00", "Tags": [] } ] } ``` 詳細については、「*Transit Gateway ユーザーガイド*」の「[Transit gateway policy tables](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-policy-tables.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteTransitGatewayPolicyTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-transit-gateway-policy-table.html)」を参照してください。 ### `delete-transit-gateway-prefix-list-reference` 次のコード例は、`delete-transit-gateway-prefix-list-reference` を使用する方法を示しています。 **AWS CLI** **プレフィックスリストのリファレンスを削除するには** 次の `delete-transit-gateway-prefix-list-reference` の例では、指定したプレフィックスリストのリファレンスを削除します。 ``` aws ec2 delete-transit-gateway-prefix-list-reference \ --transit-gateway-route-table-id tgw-rtb-0123456789abcd123 \ --prefix-list-id pl-11111122222222333 ``` 出力: ``` { "TransitGatewayPrefixListReference": { "TransitGatewayRouteTableId": "tgw-rtb-0123456789abcd123", "PrefixListId": "pl-11111122222222333", "PrefixListOwnerId": "123456789012", "State": "deleting", "Blackhole": false, "TransitGatewayAttachment": { "TransitGatewayAttachmentId": "tgw-attach-aabbccddaabbccaab", "ResourceType": "vpc", "ResourceId": "vpc-112233445566aabbc" } } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Prefix list references](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-prefix-lists.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteTransitGatewayPrefixListReference](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-transit-gateway-prefix-list-reference.html)」を参照してください。 ### `delete-transit-gateway-route-table` 次のコード例は、`delete-transit-gateway-route-table` を使用する方法を示しています。 **AWS CLI** **Transit Gateway ルートテーブルを削除するには** 次の `delete-transit-gateway-route-table` の例では、指定した Transit Gateway ルートテーブルを削除します。 ``` aws ec2 delete-transit-gateway-route-table \ --transit-gateway-route-table-id tgw-rtb-0b6f6aaa01EXAMPLE ``` 出力: ``` { "TransitGatewayRouteTable": { "TransitGatewayRouteTableId": "tgw-rtb-0b6f6aaa01EXAMPLE", "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", "State": "deleting", "DefaultAssociationRouteTable": false, "DefaultPropagationRouteTable": false, "CreationTime": "2019-07-17T20:27:26.000Z" } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Delete a transit gateway route table](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html#delete-tgw-route-table)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteTransitGatewayRouteTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-transit-gateway-route-table.html)」を参照してください。 ### `delete-transit-gateway-route` 次のコード例は、`delete-transit-gateway-route` を使用する方法を示しています。 **AWS CLI** **ルートテーブルから CIDR ブロックを削除するには** 次の `delete-transit-gateway-route` の例では、指定した Transit Gateway ルートテーブルから CIDR ブロックを削除します。 ``` aws ec2 delete-transit-gateway-route \ --transit-gateway-route-table-id tgw-rtb-0b6f6aaa01EXAMPLE \ --destination-cidr-block 10.0.2.0/24 ``` 出力: ``` { "Route": { "DestinationCidrBlock": "10.0.2.0/24", "TransitGatewayAttachments": [ { "ResourceId": "vpc-0065acced4EXAMPLE", "TransitGatewayAttachmentId": "tgw-attach-0b5968d3b6EXAMPLE", "ResourceType": "vpc" } ], "Type": "static", "State": "deleted" } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Delete a static route](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html#tgw-delete-static-route)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteTransitGatewayRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-transit-gateway-route.html)」を参照してください。 ### `delete-transit-gateway-vpc-attachment` 次のコード例は、`delete-transit-gateway-vpc-attachment` を使用する方法を示しています。 **AWS CLI** **Transit Gateway VPC アタッチメントを削除するには** 次の `delete-transit-gateway-vpc-attachment` の例では、指定した VPC アタッチメントを削除します。 ``` aws ec2 delete-transit-gateway-vpc-attachment \ --transit-gateway-attachment-id tgw-attach-0d2c54bdbEXAMPLE ``` 出力: ``` { "TransitGatewayVpcAttachment": { "TransitGatewayAttachmentId": "tgw-attach-0d2c54bdb3EXAMPLE", "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", "VpcId": "vpc-0065acced4f61c651", "VpcOwnerId": "111122223333", "State": "deleting", "CreationTime": "2019-07-17T16:04:27.000Z" } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Delete a VPC attachment](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-vpc-attachments.html#delete-vpc-attachment)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteTransitGatewayVpcAttachment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-transit-gateway-vpc-attachment.html)」を参照してください。 ### `delete-transit-gateway` 次のコード例は、`delete-transit-gateway` を使用する方法を示しています。 **AWS CLI** **Transit Gateway を削除するには** 次の `delete-transit-gateway` の例では、指定した Transit Gateway を削除します。 ``` aws ec2 delete-transit-gateway \ --transit-gateway-id tgw-01f04542b2EXAMPLE ``` 出力: ``` { "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" } } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Delete a transit gateway](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-transit-gateways.html#delete-tgw)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteTransitGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-transit-gateway.html)」を参照してください。 ### `delete-verified-access-endpoint` 次のコード例は、`delete-verified-access-endpoint` を使用する方法を示しています。 **AWS CLI** **Verified Access エンドポイントを削除するには** 次の `delete-verified-access-endpoint` の例では、指定した Verified Access エンドポイントを削除します。 ``` aws ec2 delete-verified-access-endpoint \ --verified-access-endpoint-id vae-066fac616d4d546f2 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWSVerified Access ユーザーガイド*」の「[Verified Access endpoints](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-endpoints.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteVerifiedAccessEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-verified-access-endpoint.html)」を参照してください。 ### `delete-verified-access-group` 次のコード例は、`delete-verified-access-group` を使用する方法を示しています。 **AWS CLI** **Verified Access グループを削除するには** 次の `delete-verified-access-group` の例では、指定した Verified Access グループを削除します。 ``` aws ec2 delete-verified-access-group \ --verified-access-group-id vagr-0dbe967baf14b7235 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWSVerified Access ユーザーガイド*」の「[Verified Access groups](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteVerifiedAccessGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-verified-access-group.html)」を参照してください。 ### `delete-verified-access-instance` 次のコード例は、`delete-verified-access-instance` を使用する方法を示しています。 **AWS CLI** **Verified Access インスタンスを削除するには** 次の `delete-verified-access-instance` の例では、指定した Verified Access インスタンスを削除します。 ``` aws ec2 delete-verified-access-instance \ --verified-access-instance-id vai-0ce000c0b7643abea ``` 出力: ``` { "VerifiedAccessInstance": { "VerifiedAccessInstanceId": "vai-0ce000c0b7643abea", "Description": "Testing Verified Access", "VerifiedAccessTrustProviders": [], "CreationTime": "2023-08-25T18:27:56", "LastUpdatedTime": "2023-08-26T01:00:18" } } ``` 詳細については、「*AWSVerified Access ユーザーガイド*」の「[Access インスタンス](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-instances.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteVerifiedAccessInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-verified-access-instance.html)」を参照してください。 ### `delete-verified-access-trust-provider` 次のコード例は、`delete-verified-access-trust-provider` を使用する方法を示しています。 **AWS CLI** **Verified Access デバイスの信頼プロバイダーを削除するには** 次の `delete-verified-access-trust-provider` の例では、指定した Verified Access 信頼プロバイダーを削除します。 ``` aws ec2 delete-verified-access-trust-provider \ --verified-access-trust-provider-id vatp-0bb32de759a3e19e7 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWSVerified Access ユーザーガイド*」の「[Trust providers for Verified Access](https://docs.aws.amazon.com/verified-access/latest/ug/trust-providers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteVerifiedAccessTrustProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-verified-access-trust-provider.html)」を参照してください。 ### `delete-volume` 次のコード例は、`delete-volume` を使用する方法を示しています。 **AWS CLI** **ボリュームを削除するには** このコマンド例では、`vol-049df61146c4d7901` というボリューム ID を持つ使用可能なボリュームを削除します。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 delete-volume --volume-id vol-049df61146c4d7901 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteVolume](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-volume.html)」を参照してください。 ### `delete-vpc-endpoint-connection-notifications` 次のコード例は、`delete-vpc-endpoint-connection-notifications` を使用する方法を示しています。 **AWS CLI** **エンドポイントの接続通知を削除するには** この例では、指定されたエンドポイント接続通知を削除します。 コマンド: ``` aws ec2 delete-vpc-endpoint-connection-notifications --connection-notification-ids vpce-nfn-008776de7e03f5abc ``` 出力: ``` { "Unsuccessful": [] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteVpcEndpointConnectionNotifications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-vpc-endpoint-connection-notifications.html)」を参照してください。 ### `delete-vpc-endpoint-service-configurations` 次のコード例は、`delete-vpc-endpoint-service-configurations` を使用する方法を示しています。 **AWS CLI** **エンドポイントサービス設定を削除するには** この例では、指定されたエンドポイントサービス設定を削除します。 コマンド: ``` aws ec2 delete-vpc-endpoint-service-configurations --service-ids vpce-svc-03d5ebb7d9579a2b3 ``` 出力: ``` { "Unsuccessful": [] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteVpcEndpointServiceConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-vpc-endpoint-service-configurations.html)」を参照してください。 ### `delete-vpc-endpoints` 次のコード例は、`delete-vpc-endpoints` を使用する方法を示しています。 **AWS CLI** **エンドポイントを削除するには** この例では、エンドポイント vpce-aa22bb33 と vpce-1a2b3c4d を削除します。コマンドが部分的に成功または失敗した場合は、失敗した項目のリストが返されます。コマンドが成功した場合、返されたリストは空になります。 コマンド: ``` aws ec2 delete-vpc-endpoints --vpc-endpoint-ids vpce-aa22bb33 vpce-1a2b3c4d ``` 出力: ``` { "Unsuccessful": [] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteVpcEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-vpc-endpoints.html)」を参照してください。 ### `delete-vpc-peering-connection` 次のコード例は、`delete-vpc-peering-connection` を使用する方法を示しています。 **AWS CLI** **VPC ピアリング接続を削除するには** この例では、指定された VPC ピアリング接続を削除します。 コマンド: ``` aws ec2 delete-vpc-peering-connection --vpc-peering-connection-id pcx-1a2b3c4d ``` 出力: ``` { "Return": true } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteVpcPeeringConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-vpc-peering-connection.html)」を参照してください。 ### `delete-vpc` 次のコード例は、`delete-vpc` を使用する方法を示しています。 **AWS CLI** **VPC を削除するには** この例では、指定された VPC を削除します。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 delete-vpc --vpc-id vpc-a01106c2 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteVpc](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-vpc.html)」を参照してください。 ### `delete-vpn-connection-route` 次のコード例は、`delete-vpn-connection-route` を使用する方法を示しています。 **AWS CLI** **VPN 接続から静的ルートを削除するには** この例では、指定された VPN 接続から指定された静的ルートを削除します。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 delete-vpn-connection-route --vpn-connection-id vpn-40f41529 --destination-cidr-block 11.12.0.0/16 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteVpnConnectionRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-vpn-connection-route.html)」を参照してください。 ### `delete-vpn-connection` 次のコード例は、`delete-vpn-connection` を使用する方法を示しています。 **AWS CLI** **VPN 接続を削除するには** この例では、指定された VPN 接続を削除します。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 delete-vpn-connection --vpn-connection-id vpn-40f41529 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteVpnConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-vpn-connection.html)」を参照してください。 ### `delete-vpn-gateway` 次のコード例は、`delete-vpn-gateway` を使用する方法を示しています。 **AWS CLI** **仮想プライベートゲートウェイを削除するには** この例では、指定された仮想プライベートゲートウェイを削除します。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 delete-vpn-gateway --vpn-gateway-id vgw-9a4cacf3 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteVpnGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/delete-vpn-gateway.html)」を参照してください。 ### `deprovision-byoip-cidr` 次のコード例は、`deprovision-byoip-cidr` を使用する方法を示しています。 **AWS CLI** **使用から IP アドレス範囲を削除するには** 次の例では、AWS での使用から、指定されたアドレス範囲を削除します。 ``` aws ec2 deprovision-byoip-cidr \ --cidr 203.0.113.25/24 ``` 出力: ``` { "ByoipCidr": { "Cidr": "203.0.113.25/24", "State": "pending-deprovision" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeprovisionByoipCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/deprovision-byoip-cidr.html)」を参照してください。 ### `deprovision-ipam-pool-cidr` 次のコード例は、`deprovision-ipam-pool-cidr` を使用する方法を示しています。 **AWS CLI** **IPAM プール CIDR のプロビジョニングを解除するには** 次の `deprovision-ipam-pool-cidr` の例では、IPAM プールにプロビジョニングされた CIDR のプロビジョニングを解除します。 (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 ``` 出力: ``` { "IpamPoolCidr": { "Cidr": "11.0.0.0/16", "State": "pending-deprovision" } } ``` 詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[Deprovision pool CIDRs](https://docs.aws.amazon.com/vpc/latest/ipam/depro-pool-cidr-ipam.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeprovisionIpamPoolCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/deprovision-ipam-pool-cidr.html)」を参照してください。 ### `deregister-image` 次のコード例は、`deregister-image` を使用する方法を示しています。 **AWS CLI** **AMI の登録を解除するには** この例では、指定された AMI の登録を解除します。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 deregister-image --image-id ami-4fa54026 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeregisterImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/deregister-image.html)」を参照してください。 ### `deregister-instance-event-notification-attributes` 次のコード例は、`deregister-instance-event-notification-attributes` を使用する方法を示しています。 **AWS CLI** **例 1: イベント通知からすべてのタグを削除するには** 次の `deregister-instance-event-notification-attributes` の例では、`IncludeAllTagsOfInstance=true` を削除します。これにより、`IncludeAllTagsOfInstance` は `false` に設定されます。 ``` aws ec2 deregister-instance-event-notification-attributes \ --instance-tag-attribute IncludeAllTagsOfInstance=true ``` 出力: ``` { "InstanceTagAttribute": { "InstanceTagKeys": [], "IncludeAllTagsOfInstance": true } } ``` 詳細については、「*Amazon Elastic Compute Cloud User Guide for Linux Instances*」の「[Scheduled events for your instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html)」を参照してください。 **例 2: イベント通知から特定のタグを削除するには** 次の `deregister-instance-event-notification-attributes` の例では、イベント通知に含まれるタグから指定したタグを削除します。イベント通知に含まれる残りのタグを記述するには、`describe-instance-event-notification-attributes` を使用します。 ``` aws ec2 deregister-instance-event-notification-attributes \ --instance-tag-attribute InstanceTagKeys="tag-key2" ``` 出力: ``` { "InstanceTagAttribute": { "InstanceTagKeys": [ "tag-key2" ], "IncludeAllTagsOfInstance": false } } ``` 詳細については、「*Amazon Elastic Compute Cloud User Guide for Linux Instances*」の「[Scheduled events for your instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeregisterInstanceEventNotificationAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/deregister-instance-event-notification-attributes.html)」を参照してください。 ### `deregister-transit-gateway-multicast-group-members` 次のコード例は、`deregister-transit-gateway-multicast-group-members` を使用する方法を示しています。 **AWS CLI** **マルチキャストグループからグループメンバーの登録を解除するには** この例では、Transit Gateway マルチキャストグループから指定されたネットワークインターフェイスグループメンバーの登録を解除します。 ``` 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 ``` 出力: ``` { "DeregisteredMulticastGroupMembers": { "TransitGatewayMulticastDomainId": "tgw-mcast-domain-0c4905cef7EXAMPLE", "RegisteredNetworkInterfaceIds": [ "eni-0e246d3269EXAMPLE" ], "GroupIpAddress": "224.0.1.0" } } ``` 詳細については、「*AWS Transit Gateway ユーザーガイド*」の「[Deregister Members from a Multicast Group](https://docs.aws.amazon.com/vpc/latest/tgw/working-with-multicast.html#remove-members-multicast-group)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeregisterTransitGatewayMulticastGroupMembers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/deregister-transit-gateway-multicast-group-members.html)」を参照してください。 ### `deregister-transit-gateway-multicast-group-source` 次のコード例は、`deregister-transit-gateway-multicast-group-source` を使用する方法を示しています。 **AWS CLI** **Transit Gateway マルチキャストグループからソースの登録を解除するには** この例では、マルチキャストグループから指定されたネットワークインターフェイスグループソースの登録を解除します。 ``` 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 ``` 出力: ``` { "DeregisteredMulticastGroupSources": { "TransitGatewayMulticastDomainId": "tgw-mcast-domain-0c4905cef79d6e597", "DeregisteredNetworkInterfaceIds": [ "eni-07f290fc3c090cbae" ], "GroupIpAddress": "224.0.1.0" } } ``` 詳細については、「*AWS Transit Gateway ユーザーガイド*」の「[Deregister Sources from a Multicast Group](https://docs.aws.amazon.com/vpc/latest/tgw/working-with-multicast.html#remove-source-multicast-group)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeregisterTransitGatewayMulticastGroupSource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/deregister-transit-gateway-multicast-group-source.html)」を参照してください。 ### `describe-account-attributes` 次のコード例は、`describe-account-attributes` を使用する方法を示しています。 **AWS CLI** **AWS アカウントのすべての属性を記述するには** この例では、AWS アカウントの属性を記述します。 コマンド: ``` aws ec2 describe-account-attributes ``` 出力: ``` { "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" } ] } ] } ``` **AWS アカウントの 1 つの属性を記述するには** この例では、AWS アカウントの `supported-platforms` 属性を記述します。 コマンド: ``` aws ec2 describe-account-attributes --attribute-names supported-platforms ``` 出力: ``` { "AccountAttributes": [ { "AttributeName": "supported-platforms", "AttributeValues": [ { "AttributeValue": "EC2" }, { "AttributeValue": "VPC" } ] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAccountAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-account-attributes.html)」を参照してください。 ### `describe-address-transfers` 次のコード例は、`describe-address-transfers` を使用する方法を示しています。 **AWS CLI** **Elastic IP アドレスの移管を記述するには** 次の `describe-address-transfers` の例では、指定した Elastic IP アドレスの Elastic IP アドレス転送を記述します。 ``` aws ec2 describe-address-transfers \ --allocation-ids eipalloc-09ad461b0d03f6aaf ``` 出力: ``` { "AddressTransfers": [ { "PublicIp": "100.21.184.216", "AllocationId": "eipalloc-09ad461b0d03f6aaf", "TransferAccountId": "123456789012", "TransferOfferExpirationTimestamp": "2023-02-22T22:51:01.000Z", "AddressTransferStatus": "pending" } ] } ``` 詳細については、「*Amazon VPC ユーザーガイド*」の「[Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAddressTransfers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-address-transfers.html)」を参照してください。 ### `describe-addresses-attribute` 次のコード例は、`describe-addresses-attribute` を使用する方法を示しています。 **AWS CLI** **Elastic IP アドレスに関連付けられたドメイン名の属性を表示するには** 次の `describe-addresses-attribute` の例では、Elastic IP アドレスに関連付けられたドメイン名の属性を返します。 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 ``` 出力: ``` { "Addresses": [ { "PublicIp": "192.0.2.0", "AllocationId": "eipalloc-abcdef01234567890", "PtrRecord": "example.com." } ] } ``` Elastic IP アドレスの属性を表示するには、まずドメイン名を Elastic IP アドレスに関連付ける必要があります。詳細については、「*Amazon EC2 ユーザーガイド*」の「[Use reverse DNS for email applications](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#Using_Elastic_Addressing_Reverse_DNS)」または「*AWS CLI コマンドリファレンス*」の「[modify-address-attribute](https://docs.aws.amazon.com/cli/latest/reference/ec2/modify-address-attribute.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAddressesAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-addresses-attribute.html)」を参照してください。 ### `describe-addresses` 次のコード例は、`describe-addresses` を使用する方法を示しています。 **AWS CLI** **例 1: すべての Elastic IP アドレスに関する詳細を取得するには** 次の `describe addresses` の例では、Elastic IP アドレスに関する詳細が表示されます。 ``` aws ec2 describe-addresses ``` 出力: ``` { "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" } ] } ``` **例 2: EC2-VPC の Elastic IP アドレスに関する詳細を取得するには** 次の `describe-addresses` の例では、VPC 内のインスタンスで使用する Elastic IP アドレスの詳細が表示されます。 ``` aws ec2 describe-addresses \ --filters "Name=domain,Values=vpc" ``` 出力: ``` { "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" } ] } ``` **例 3: 割り当て ID で指定された Elastic IP アドレスに関する詳細を取得するには** 次の `describe-addresses` の例では、EC2-VPC 内のインスタンスに関連付けられている、指定された割り当て ID を持つ Elastic IP アドレスの詳細を表示します。 ``` aws ec2 describe-addresses \ --allocation-ids eipalloc-282d9641 ``` 出力: ``` { "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" } ] } ``` **例 4: VPC プライベート IP アドレスで指定された Elastic IP アドレスに関する詳細を取得するには** 次の `describe-addresses` の例では、EC2-VPC の特定のプライベート IP アドレスに関連付けられている Elastic IP アドレスの詳細が表示されます。 ``` aws ec2 describe-addresses \ --filters "Name=private-ip-address,Values=10.251.50.12" ``` **例 5: EC2-Classic の Elastic IP アドレスに関する詳細を取得するには** 次の `describe-addresses` の例では、EC2-Classic で使用する Elastic IP アドレスを表示します。 ``` aws ec2 describe-addresses \ --filters "Name=domain,Values=standard" ``` 出力: ``` { "Addresses": [ { "InstanceId": "i-1234567890abcdef0", "PublicIp": "203.0.110.25", "PublicIpv4Pool": "amazon", "Domain": "standard" } ] } ``` **例 6: パブリック IP アドレスで指定された Elastic IP アドレスに関する詳細を取得するには** 次の `describe-addresses` の例では、EC2-Classic のインスタンスに関連付けられている、値 `203.0.110.25` を持つ Elastic IP アドレスの詳細を表示します。 ``` aws ec2 describe-addresses \ --public-ips 203.0.110.25 ``` 出力: ``` { "Addresses": [ { "InstanceId": "i-1234567890abcdef0", "PublicIp": "203.0.110.25", "PublicIpv4Pool": "amazon", "Domain": "standard" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAddresses](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-addresses.html)」を参照してください。 ### `describe-aggregate-id-format` 次のコード例は、`describe-aggregate-id-format` を使用する方法を示しています。 **AWS CLI** **任意のリージョンのすべてのリソースタイプに対する長い ID 形式の設定を記述するには** 次の `describe-aggregate-id-format` の例では、現在のリージョンに対する全体的な長い ID 形式ステータスを記述します。`Deadline` 値は、これらのリソースが短い ID 形式から長い ID 形式に完全に切り替わる期限が切れたことを示します。`UseLongIdsAggregated` 値は、すべての IAM ユーザーと IAM ロールが、すべてのリソースタイプに長い ID 形式を使用するように設定されていることを示します。 ``` aws ec2 describe-aggregate-id-format ``` 出力: ``` { "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 }, ... ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAggregateIdFormat](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-aggregate-id-format.html)」を参照してください。 ### `describe-availability-zones` 次のコード例は、`describe-availability-zones` を使用する方法を示しています。 **AWS CLI** **アベイラビリティーゾーンを説明するには** 次の `describe-availability-zones` の例では、利用可能なアベイラビリティーゾーンの詳細が表示されます。レスポンスには、現在のリージョンのアベイラビリティーゾーンのみが含まれます。この例では、デフォルトの `us-west-2` (オレゴン) リージョンのプロファイルを使用しています。 ``` aws ec2 describe-availability-zones ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAvailabilityZones](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-availability-zones.html)」を参照してください。 ### `describe-aws-network-performance-metric-subscription` 次のコード例は、`describe-aws-network-performance-metric-subscription` を使用する方法を示しています。 **AWS CLI** **メトリクスサブスクリプションを記述するには** 次の `describe-aws-network-performance-metric-subscriptions` の例では、メトリクスサブスクリプションを記述します。 ``` aws ec2 describe-aws-network-performance-metric-subscriptions ``` 出力: ``` { "Subscriptions": [ { "Source": "us-east-1", "Destination": "eu-west-1", "Metric": "aggregate-latency", "Statistic": "p50", "Period": "five-minutes" } ] } ``` 詳細については、「*インフラストラクチャのパフォーマンスのユーザーガイド*」の「[Manage subscriptions](https://docs.aws.amazon.com/network-manager/latest/infrastructure-performance/nmip-subscriptions-cw.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAwsNetworkPerformanceMetricSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-aws-network-performance-metric-subscription.html)」を参照してください。 ### `describe-aws-network-performance-metric-subscriptions` 次のコード例は、`describe-aws-network-performance-metric-subscriptions` を使用する方法を示しています。 **AWS CLI** **メトリクスサブスクリプションを記述するには** 次の `describe-aws-network-performance-metric-subscriptions` の例では、メトリクスサブスクリプションを記述します。 ``` aws ec2 describe-aws-network-performance-metric-subscriptions ``` 出力: ``` { "Subscriptions": [ { "Source": "us-east-1", "Destination": "eu-west-1", "Metric": "aggregate-latency", "Statistic": "p50", "Period": "five-minutes" } ] } ``` 詳細については、「*インフラストラクチャのパフォーマンスのユーザーガイド*」の「[Manage subscriptions](https://docs.aws.amazon.com/network-manager/latest/infrastructure-performance/nmip-subscriptions-cw.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAwsNetworkPerformanceMetricSubscriptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-aws-network-performance-metric-subscriptions.html)」を参照してください。 ### `describe-bundle-tasks` 次のコード例は、`describe-bundle-tasks` を使用する方法を示しています。 **AWS CLI** **バンドルタスクを記述するには** この例では、すべてのバンドルタスクを記述します。 コマンド: ``` aws ec2 describe-bundle-tasks ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeBundleTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-bundle-tasks.html)」を参照してください。 ### `describe-byoip-cidrs` 次のコード例は、`describe-byoip-cidrs` を使用する方法を示しています。 **AWS CLI** **プロビジョニングされたアドレス範囲を記述するには** 次の `describe-byoip-cidrs` の例では、AWS で使用するためにプロビジョニングしたパブリック IPv4 アドレス範囲の詳細を表示します。 ``` aws ec2 describe-byoip-cidrs ``` 出力: ``` { "ByoipCidrs": [ { "Cidr": "203.0.113.25/24", "StatusMessage": "ipv4pool-ec2-1234567890abcdef0", "State": "provisioned" } ] } ``` + API の詳細については、「**AWS CLI コマンドリファレンス」の「[DescribeByoipCidrs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-byoip-cidrs.html)」を参照してください。 ### `describe-capacity-reservation-fleets` 次のコード例は、`describe-capacity-reservation-fleets` を使用する方法を示しています。 **AWS CLI** **キャパシティ予約フリートを表示するには** 次の `describe-capacity-reservation-fleets` の例では、指定したキャパシティ予約フリートの設定とキャパシティ情報を一覧表示します。フリート内の個々のキャパシティ予約に関する詳細も一覧表示されます。 ``` aws ec2 describe-capacity-reservation-fleets \ --capacity-reservation-fleet-ids crf-abcdef01234567890 ``` 出力: ``` { "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" } ] } ``` キャパシティ予約フリートの詳細については、「*Amazon EC2 ユーザーガイド*」の「[キャパシティ予約フリート](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-fleets.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeCapacityReservationFleets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-capacity-reservation-fleets.html)」を参照してください。 ### `describe-capacity-reservations` 次のコード例は、`describe-capacity-reservations` を使用する方法を示しています。 **AWS CLI** **例 1: 1 つ以上のキャパシティ予約を記述するには** 次の `describe-capacity-reservations` の例では、現在の AWS リージョンのすべてのキャパシティ予約に関する詳細を表示します。 ``` aws ec2 describe-capacity-reservations ``` 出力: ``` { "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": [] } ] } ``` **例 2: 1 つ以上のキャパシティ予約を記述するには** 次の `describe-capacity-reservations` の例では、指定したキャパシティ予約の詳細を表示します。 ``` aws ec2 describe-capacity-reservations \ --capacity-reservation-ids cr-1234abcd56EXAMPLE ``` 出力: ``` { "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": [] } ] } ``` 詳細については、「*Amazon Elastic Compute Cloud User Guide for Linux Instances*」の「[Viewing a Capacity Reservation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-using.html#capacity-reservations-view)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeCapacityReservations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-capacity-reservations.html)」を参照してください。 ### `describe-carrier-gateways` 次のコード例は、`describe-carrier-gateways` を使用する方法を示しています。 **AWS CLI** **すべてのキャリアゲートウェイを記述するには** 次の `describe-carrier-gateways` の例では、すべてのキャリアゲートウェイを一覧表示します。 ``` aws ec2 describe-carrier-gateways ``` 出力: ``` { "CarrierGateways": [ { "CarrierGatewayId": "cagw-0465cdEXAMPLE1111", "VpcId": "vpc-0c529aEXAMPLE", "State": "available", "OwnerId": "123456789012", "Tags": [ { "Key": "example", "Value": "tag" } ] } ] } ``` 詳細については、「*Amazon Virtual Private Cloud ユーザーガイド*」の「Carrier gateways」 を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeCarrierGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-carrier-gateways.html)」を参照してください。 ### `describe-classic-link-instances` 次のコード例は、`describe-classic-link-instances` を使用する方法を示しています。 **AWS CLI** **リンクされた EC2-Classic インスタンスを記述するには** この例では、リンクされたすべての EC2-Classic インスタンスを一覧表示します。 コマンド: ``` aws ec2 describe-classic-link-instances ``` 出力: ``` { "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" } ] } ] } ``` この例では、リンクされたすべての EC2-Classic インスタンスを一覧表示し、VPC vpc-88888888 にリンクされているインスタンスのみを含むようにレスポンスをフィルタリングします。 コマンド: ``` aws ec2 describe-classic-link-instances --filter "Name=vpc-id,Values=vpc-88888888" ``` 出力: ``` { "Instances": [ { "InstanceId": "i-1234567890abcdef0", "VpcId": "vpc-88888888", "Groups": [ { "GroupId": "sg-11122233" } ], "Tags": [ { "Value": "ClassicInstance", "Key": "Name" } ] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeClassicLinkInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-classic-link-instances.html)」を参照してください。 ### `describe-client-vpn-authorization-rules` 次のコード例は、`describe-client-vpn-authorization-rules` を使用する方法を示しています。 **AWS CLI** **クライアント VPN エンドポイントの承認ルールを記述するには** 次の `describe-client-vpn-authorization-rules` の例では、指定したクライアント VPN エンドポイントの承認ルールに関する詳細を表示します。 ``` aws ec2 describe-client-vpn-authorization-rules \ --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde ``` 出力: ``` { "AuthorizationRules": [ { "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde", "GroupId": "", "AccessAll": true, "DestinationCidr": "0.0.0.0/0", "Status": { "Code": "active" } } ] } ``` 詳細については、「*AWS Client VPN 管理者ガイド*」の「[Authorization Rules](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-rules.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeClientVpnAuthorizationRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-client-vpn-authorization-rules.html)」を参照してください。 ### `describe-client-vpn-connections` 次のコード例は、`describe-client-vpn-connections` を使用する方法を示しています。 **AWS CLI** **クライアント VPN エンドポイントへの接続を記述するには** 次の `describe-client-vpn-connections` の例では、指定したクライアント VPN エンドポイントへクライアント接続の詳細を表示します。 ``` aws ec2 describe-client-vpn-connections \ --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde ``` 出力: ``` { "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": "-" } ] } ``` 詳細については、「*AWS Client VPN 管理者ガイド*」の「[Client Connections](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-connections.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeClientVpnConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-client-vpn-connections.html)」を参照してください。 ### `describe-client-vpn-endpoints` 次のコード例は、`describe-client-vpn-endpoints` を使用する方法を示しています。 **AWS CLI** **クライアント VPN エンドポイントを記述するには** 次の `describe-client-vpn-endpoints` の例では、すべてのクライアント VPN エンドポイントの詳細を表示します。 ``` aws ec2 describe-client-vpn-endpoints ``` 出力: ``` { "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 } } ] } ``` 詳細については、「*AWS Client VPN 管理者ガイド*」の「[Client VPN Endpoints](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-endpoints.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeClientVpnEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-client-vpn-endpoints.html)」を参照してください。 ### `describe-client-vpn-routes` 次のコード例は、`describe-client-vpn-routes` を使用する方法を示しています。 **AWS CLI** **クライアント VPN エンドポイントのルートを記述するには** 次の `describe-client-vpn-routes` の例では、指定したクライアント VPN エンドポイントのルートの詳細を表示します。 ``` aws ec2 describe-client-vpn-routes \ --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde ``` 出力: ``` { "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" } } ] } ``` 詳細については、「*AWS Client VPN 管理者ガイド*」の「[Routes](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-routes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeClientVpnRoutes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-client-vpn-routes.html)」を参照してください。 ### `describe-client-vpn-target-networks` 次のコード例は、`describe-client-vpn-target-networks` を使用する方法を示しています。 **AWS CLI** **クライアント VPN エンドポイントのターゲットネットワークを記述するには** 次の `describe-client-vpn-target-networks` の例では、指定したクライアント VPN エンドポイントのターゲットネットワークの詳細を表示します。 ``` aws ec2 describe-client-vpn-target-networks \ --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde ``` 出力: ``` { "ClientVpnTargetNetworks": [ { "AssociationId": "cvpn-assoc-012e837060753dc3d", "VpcId": "vpc-11111222222333333", "TargetNetworkId": "subnet-0123456789abcabca", "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde", "Status": { "Code": "associating" }, "SecurityGroups": [ "sg-012345678910abcab" ] } ] } ``` 詳細については、「*AWS Client VPN 管理者ガイド*」の「[Target Networks](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-target.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeClientVpnTargetNetworks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-client-vpn-target-networks.html)」を参照してください。 ### `describe-coip-pools` 次のコード例は、`describe-coip-pools` を使用する方法を示しています。 **AWS CLI** **顧客所有の IP アドレスプールを記述するには** 次の `describe-coip-pools` の例では、AWS アカウント内にあるカスタマー所有の IP アドレスプールを記述します。 ``` aws ec2 describe-coip-pools ``` 出力: ``` { "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" } ] } ``` CoIP の詳細については、「*AWS Outposts ユーザーガイド*」の「[カスタマー所有の IP アドレス](https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeCoipPools](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-coip-pools.html)」を参照してください。 ### `describe-conversion-tasks` 次のコード例は、`describe-conversion-tasks` を使用する方法を示しています。 **AWS CLI** **変換タスクのステータスを表示するには** この例では、ID import-i-ffvko9js を持つ変換タスクのステータスを返します。 コマンド: ``` aws ec2 describe-conversion-tasks --conversion-task-ids import-i-ffvko9js ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeConversionTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-conversion-tasks.html)」を参照してください。 ### `describe-customer-gateways` 次のコード例は、`describe-customer-gateways` を使用する方法を示しています。 **AWS CLI** **カスタマーゲートウェイを記述するには** この例では、カスタマーゲートウェイを記述します。 コマンド: ``` aws ec2 describe-customer-gateways ``` 出力: ``` { "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" } ] } ``` **特定のカスタマーゲートウェイを記述するには** この例では、指定されたカスタマーゲートウェイを記述します。 コマンド: ``` aws ec2 describe-customer-gateways --customer-gateway-ids cgw-0e11f167 ``` 出力: ``` { "CustomerGateways": [ { "CustomerGatewayId": "cgw-0e11f167", "IpAddress": "12.1.2.3", "State": "available", "Type": "ipsec.1", "BgpAsn": "65534" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeCustomerGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-customer-gateways.html)」を参照してください。 ### `describe-dhcp-options` 次のコード例は、`describe-dhcp-options` を使用する方法を示しています。 **AWS CLI** **例 1: DHCP オプションを記述するには** 次の `describe-dhcp-options` の例では、DHCP の詳細を取得します。 ``` aws ec2 describe-dhcp-options ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS VPC ユーザーガイド*」の「[Working with DHCP Option Sets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html#DHCPOptionSet)」を参照してください。 **例 2: DHCP オプションを記述し、出力をフィルタリングするには** 次の `describe-dhcp-options` の例では、DHCP オプションを記述し、フィルターを使用して、ドメインネームサーバーに `example.com` を持つ DHCP オプションのみを返します。この例では、`--query` パラメータを使用して、出力に設定情報と ID のみを表示します。 ``` aws ec2 describe-dhcp-options \ --filters Name=key,Values=domain-name-servers Name=value,Values=example.com \ --query "DhcpOptions[*].[DhcpConfigurations,DhcpOptionsId]" ``` 出力: ``` [ [ [ { "Key": "domain-name", "Values": [ { "Value": "example.com" } ] }, { "Key": "domain-name-servers", "Values": [ { "Value": "172.16.16.16" } ] } ], "dopt-001122334455667ab" ] ] ``` 詳細については、「*AWS VPC ユーザーガイド*」の「[Working with DHCP Option Sets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html#DHCPOptionSet)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDhcpOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-dhcp-options.html)」を参照してください。 ### `describe-egress-only-internet-gateways` 次のコード例は、`describe-egress-only-internet-gateways` を使用する方法を示しています。 **AWS CLI** **Egress-Only インターネットゲートウェイを記述するには** この例では、Egress-Only インターネットゲートウェイを記述します。 コマンド: ``` aws ec2 describe-egress-only-internet-gateways ``` 出力: ``` { "EgressOnlyInternetGateways": [ { "EgressOnlyInternetGatewayId": "eigw-015e0e244e24dfe8a", "Attachments": [ { "State": "attached", "VpcId": "vpc-0c62a468" } ] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEgressOnlyInternetGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-egress-only-internet-gateways.html)」を参照してください。 ### `describe-elastic-gpus` 次のコード例は、`describe-elastic-gpus` を使用する方法を示しています。 **AWS CLI** **Elastic GPU を記述するには** コマンド: ``` aws ec2 describe-elastic-gpus --elastic-gpu-ids egpu-12345678901234567890abcdefghijkl ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeElasticGpus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-elastic-gpus.html)」を参照してください。 ### `describe-export-image-tasks` 次のコード例は、`describe-export-image-tasks` を使用する方法を示しています。 **AWS CLI** **イメージのエクスポートタスクをモニタリングするには** 次の `describe-export-image-tasks` の例では、指定したイメージのエクスポートタスクのステータスをチェックします。Amazon S3 の結果のイメージファイルは `my-export-bucket/exports/export-ami-1234567890abcdef0.vmdk` です。 ``` aws ec2 describe-export-image-tasks \ --export-image-task-ids export-ami-1234567890abcdef0 ``` 進行中のイメージのエクスポートタスクの出力。 ``` { "ExportImageTasks": [ { "ExportImageTaskId": "export-ami-1234567890abcdef0" "Progress": "21", "S3ExportLocation": { "S3Bucket": "my-export-bucket", "S3Prefix": "exports/" }, "Status": "active", "StatusMessage": "updating" } ] } ``` 完了したイメージのエクスポートタスクの出力。 ``` { "ExportImageTasks": [ { "ExportImageTaskId": "export-ami-1234567890abcdef0" "S3ExportLocation": { "S3Bucket": "my-export-bucket", "S3Prefix": "exports/" }, "Status": "completed" } ] } ``` 詳細については、「*VM Import/Export ユーザーガイド*」の「[Export a VM from an AMI](https://docs.aws.amazon.com/vm-import/latest/userguide/vmexport_image.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeExportImageTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-export-image-tasks.html)」を参照してください。 ### `describe-export-tasks` 次のコード例は、`describe-export-tasks` を使用する方法を示しています。 **AWS CLI** **インスタンスエクスポートタスクの詳細を一覧表示するには** この例では、ID export-i-fh8sjjsq を使用したエクスポートタスクを記述します。 コマンド: ``` aws ec2 describe-export-tasks --export-task-ids export-i-fh8sjjsq ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeExportTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-export-tasks.html)」を参照してください。 ### `describe-fast-launch-images` 次のコード例は、`describe-fast-launch-images` を使用する方法を示しています。 **AWS CLI** **高速起動用に設定された Windows AMI の詳細を記述するには** 次の `describe-fast-launch-images` の例では、高速起動用に設定されたアカウント内にある各 AMI の詳細を説明しています。この詳細には、リソースタイプ、スナップショット設定、起動テンプレートの詳細、並列起動の最大数、AMI 所有者 ID、高速起動設定の状態、状態が変更された理由、および状態変更が発生した時間などがあります。 ``` aws ec2 describe-fast-launch-images ``` 出力: ``` { "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" } ] } ``` 起動を高速化するための Windows AMI の設定の詳細については、「*Amazon EC2 ユーザーガイド*」の「[Configure your AMI for faster launching](https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/windows-ami-version-history.html#win-ami-config-fast-launch)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeFastLaunchImages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-fast-launch-images.html)」を参照してください。 ### `describe-fast-snapshot-restores` 次のコード例は、`describe-fast-snapshot-restores` を使用する方法を示しています。 **AWS CLI** **高速スナップショットを記述するには** 次の `describe-fast-snapshot-restores` の例では、`disabled` の状態のすべての高速スナップショット復元に関する詳細を表示します。 ``` aws ec2 describe-fast-snapshot-restores \ --filters Name=state,Values=disabled ``` 出力: ``` { "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" } ] } ``` 次の `describe-fast-snapshot-restores` の例では、すべての高速スナップショット復元について説明します。 ``` aws ec2 describe-fast-snapshot-restores ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeFastSnapshotRestores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-fast-snapshot-restores.html)」を参照してください。 ### `describe-fleet-history` 次のコード例は、`describe-fleet-history` を使用する方法を示しています。 **AWS CLI** **EC2 フリートの履歴を記述するには** 次の `describe-fleet-history` の例では、指定した時刻から始まる、指定した EC2 フリートの履歴を返します。出力は、2 つの実行中のインスタンスを持つ EC2 フリート用です。 ``` aws ec2 describe-fleet-history \ --fleet-id fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE \ --start-time 2020-09-01T00:00:00Z ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Elastic Compute Cloud User Guide for Linux Instances*」の「[Managing an EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeFleetHistory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-fleet-history.html)」を参照してください。 ### `describe-fleet-instances` 次のコード例は、`describe-fleet-instances` を使用する方法を示しています。 **AWS CLI** **EC2 フリートの実行中のインスタンスを記述するには** 次の `describe-fleet-instances` の例では、指定した EC2 フリートの実行中のインスタンスについて説明します。 ``` aws ec2 describe-fleet-instances \ --fleet-id 12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Elastic Compute Cloud User Guide for Linux Instances*」の「[Managing an EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeFleetInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-fleet-instances.html)」を参照してください。 ### `describe-fleets` 次のコード例は、`describe-fleets` を使用する方法を示しています。 **AWS CLI** **EC2 フリートを記述するには** 次の `describe-fleets` の例では、指定した EC2 フリートについて説明します。 ``` aws ec2 describe-fleets \ --fleet-ids fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE ``` 出力: ``` { "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" } } ] } ``` 詳細については、「*Amazon Elastic Compute Cloud User Guide for Linux Instances*」の「[Managing an EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeFleets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-fleets.html)」を参照してください。 ### `describe-flow-logs` 次のコード例は、`describe-flow-logs` を使用する方法を示しています。 **AWS CLI** **例 1: すべてのフローログを記述するには** 次の `describe-flow-logs` の例では、すべてのフローログの詳細を表示します。 ``` aws ec2 describe-flow-logs ``` 出力: ``` { "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}" } ] } ``` **例 2: フローログのサブセットを記述するには** 次の `describe-flow-logs` の例では、フィルターを使用して、Amazon CloudWatch Logs の指定されたロググループに含まれるフローログの詳細のみを表示します。 ``` aws ec2 describe-flow-logs \ --filter "Name=log-group-name,Values=MyFlowLogs" ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeFlowLogs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-flow-logs.html)」を参照してください。 ### `describe-fpga-image-attribute` 次のコード例は、`describe-fpga-image-attribute` を使用する方法を示しています。 **AWS CLI** **Amazon FPGA イメージの属性を記述するには** この例では、指定された AFI のロードアクセス許可を記述します。 コマンド: ``` aws ec2 describe-fpga-image-attribute --fpga-image-id afi-0d123e123bfc85abc --attribute loadPermission ``` 出力: ``` { "FpgaImageAttribute": { "FpgaImageId": "afi-0d123e123bfc85abc", "LoadPermissions": [ { "UserId": "123456789012" } ] } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeFpgaImageAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-fpga-image-attribute.html)」を参照してください。 ### `describe-fpga-images` 次のコード例は、`describe-fpga-images` を使用する方法を示しています。 **AWS CLI** **Amazon FPGA イメージを記述するには** この例では、アカウント `123456789012` が所有する AFI を記述します。 コマンド: ``` aws ec2 describe-fpga-images --filters Name=owner-id,Values=123456789012 ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「**AWS CLI コマンドリファレンス」の「[DescribeFpgaImages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-fpga-images.html)」を参照してください。 ### `describe-host-reservation-offerings` 次のコード例は、`describe-host-reservation-offerings` を使用する方法を示しています。 **AWS CLI** **専有ホスト予約サービスを記述するには** この例では、購入可能な M4 インスタンスファミリー専有ホストの予約を記述します。 コマンド: ``` aws ec2 describe-host-reservation-offerings --filter Name=instance-family,Values=m4 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeHostReservationOfferings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-host-reservation-offerings.html)」を参照してください。 ### `describe-host-reservations` 次のコード例は、`describe-host-reservations` を使用する方法を示しています。 **AWS CLI** **アカウントの専有ホスト予約を記述するには** この例では、アカウントの専有ホストの予約を記述します。 コマンド: ``` aws ec2 describe-host-reservations ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeHostReservations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-host-reservations.html)」を参照してください。 ### `describe-hosts` 次のコード例は、`describe-hosts` を使用する方法を示しています。 **AWS CLI** **専有ホストの詳細を表示するには** 次の `describe-hosts` の例では、AWS アカウント内の `available` 専有ホストの詳細を表示します。 ``` aws ec2 describe-hosts --filter "Name=state,Values=available" ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Elastic Compute Cloud User Guide for Linux Instances*」の「[Viewing Dedicated Hosts](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-dedicated-hosts-work.html#dedicated-hosts-managing)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeHosts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-hosts.html)」を参照してください。 ### `describe-iam-instance-profile-associations` 次のコード例は、`describe-iam-instance-profile-associations` を使用する方法を示しています。 **AWS CLI** **IAM インスタンスプロファイルの関連付けについて説明するには** この例では、IAM インスタンスプロファイルのすべての関連付けについて説明しています。 コマンド: ``` aws ec2 describe-iam-instance-profile-associations ``` 出力: ``` { "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" } } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeIamInstanceProfileAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-iam-instance-profile-associations.html)」を参照してください。 ### `describe-id-format` 次のコード例は、`describe-id-format` を使用する方法を示しています。 **AWS CLI** **例 1: リソースの ID 形式を記述するには** 次の `describe-id-format` の例では、セキュリティグループの ID 形式について説明します。 ``` aws ec2 describe-id-format \ --resource security-group ``` 次の出力例では、`Deadline` 値は、このリソースタイプが短い ID 形式から長い ID 形式に完全に切り替わる期限が、2018 年 8 月 15 日の 00:00 UTC に終了したことを示します。 ``` { "Statuses": [ { "Deadline": "2018-08-15T00:00:00.000Z", "Resource": "security-group", "UseLongIds": true } ] } ``` **例 2: すべてのリソースの ID 形式を記述するには** 次の `describe-id-format` の例では、すべてのリソースタイプの ID 形式について説明します。短い ID 形式をサポートしたすべてのリソースタイプは、長い ID 形式を使用するように切り替えられました。 ``` aws ec2 describe-id-format ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeIdFormat](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-id-format.html)」を参照してください。 ### `describe-identity-id-format` 次のコード例は、`describe-identity-id-format` を使用する方法を示しています。 **AWS CLI** **IAM ロールの ID 形式を記述するには** 次の `describe-identity-id-format` の例では、AWS アカウントの IAM ロール `EC2Role` で作成されたインスタンスで受信される ID 形式について説明します。 ``` aws ec2 describe-identity-id-format \ --principal-arn arn:aws:iam::123456789012:role/my-iam-role \ --resource instance ``` 次の出力は、このロールによって作成されたインスタンスが長い ID 形式で ID を受け取ることを示します。 ``` { "Statuses": [ { "Deadline": "2016-12-15T00:00:00Z", "Resource": "instance", "UseLongIds": true } ] } ``` **IAM ユーザーの ID 形式を記述するには** 次の `describe-identity-id-format` の例では、AWS アカウントの IAM ユーザー `AdminUser` で作成されたスナップショットで受信される ID 形式について説明します。 ``` aws ec2 describe-identity-id-format \ --principal-arn arn:aws:iam::123456789012:user/AdminUser \ --resource snapshot ``` 出力は、このユーザーによって作成されたスナップショットが長い ID 形式で ID を受け取ることを示します。 ``` { "Statuses": [ { "Deadline": "2016-12-15T00:00:00Z", "Resource": "snapshot", "UseLongIds": true } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeIdentityIdFormat](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-identity-id-format.html)」を参照してください。 ### `describe-image-attribute` 次のコード例は、`describe-image-attribute` を使用する方法を示しています。 **AWS CLI** **AMI の起動許可を記述するには** この例では、指定された AMI の起動許可を記述します。 コマンド: ``` aws ec2 describe-image-attribute --image-id ami-5731123e --attribute launchPermission ``` 出力: ``` { "LaunchPermissions": [ { "UserId": "123456789012" } ], "ImageId": "ami-5731123e", } ``` **AMI の製品コードを記述するには** この例では、指定された AMI の製品コードを記述します。この AMI には製品コードはありません。 コマンド: ``` aws ec2 describe-image-attribute --image-id ami-5731123e --attribute productCodes ``` 出力: ``` { "ProductCodes": [], "ImageId": "ami-5731123e", } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeImageAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-image-attribute.html)」を参照してください。 ### `describe-images` 次のコード例は、`describe-images` を使用する方法を示しています。 **AWS CLI** **例 1: AMI を説明するには** 次の `describe-images` の例では、指定された AMI 内のインターフェイスについて説明します。 ``` aws ec2 describe-images \ --region us-east-1 \ --image-ids ami-1234567890EXAMPLE ``` 出力: ``` { "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" } ] } ``` 詳細については「*アマゾン EC2 ユーザーガイド*」の「[アマゾン マシンイメージ (AMI)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html)」を参照してください。 **例 2: フィルターに基づいて AMI を説明するには** 次の `describe-images` の例では、Amazon が提供する、Amazon EBS を基にした Windows AMI を説明しています。 ``` aws ec2 describe-images \ --owners amazon \ --filters "Name=platform,Values=windows" "Name=root-device-type,Values=ebs" ``` `describe-images` の出力例については、例 1 を参照してください。 フィルターを使用するその他の例については、「*Amazon EC2 ユーザーガイド*」の「[リソースの一覧表示とフィルタリングの方法](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Filtering.html#Filtering_Resources_CLI)」を参照してください。 **例 3: タグに基づいて AMI を説明するには** 次の `describe-images` の例では、タグ `Type=Custom` が付いたすべての AMI について説明しています。この例では、`--query` パラメータを使用して AMI ID のみを表示します。 ``` aws ec2 describe-images \ --filters "Name=tag:Type,Values=Custom" \ --query 'Images[*].[ImageId]' \ --output text ``` 出力: ``` ami-1234567890EXAMPLE ami-0abcdef1234567890 ``` タグフィルターを使用するその他の例については、「*Amazon EC2 ユーザーガイド*」の「[タグの使用方法](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#Using_Tags_CLI)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeImages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-images.html)」を参照してください。 ### `describe-import-image-tasks` 次のコード例は、`describe-import-image-tasks` を使用する方法を示しています。 **AWS CLI** **イメージのインポートタスクをモニタリングするには** 次の `describe-import-image-tasks` の例では、指定したイメージのインポートタスクをチェックします。 ``` aws ec2 describe-import-image-tasks \ --import-task-ids import-ami-1234567890abcdef0 ``` 進行中のイメージのインポートタスクの出力。 ``` { "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" } ] } ``` 完了したイメージのインポートタスクの出力。結果の AMI の ID は `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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeImportImageTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-import-image-tasks.html)」を参照してください。 ### `describe-import-snapshot-tasks` 次のコード例は、`describe-import-snapshot-tasks` を使用する方法を示しています。 **AWS CLI** **スナップショットのインポートタスクをモニタリングするには** 次の `describe-import-snapshot-tasks` の例では、指定したインポートスナップショットタスクをチェックします。 ``` aws ec2 describe-import-snapshot-tasks \ --import-task-ids import-snap-1234567890abcdef0 ``` 進行中のスナップショットのインポートタスクの出力: ``` { "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" } } } ] } ``` 完了したスナップショットのインポートタスクの出力。結果のスナップショットの ID は `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" } } } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeImportSnapshotTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-import-snapshot-tasks.html)」を参照してください。 ### `describe-instance-attribute` 次のコード例は、`describe-instance-attribute` を使用する方法を示しています。 **AWS CLI** **インスタンスタイプを記述するには** この例では、指定されたインスタンスのインスタンスタイプを記述します。 コマンド: ``` aws ec2 describe-instance-attribute --instance-id i-1234567890abcdef0 --attribute instanceType ``` 出力: ``` { "InstanceId": "i-1234567890abcdef0" "InstanceType": { "Value": "t1.micro" } } ``` **disableApiTermination 属性を記述するには** この例では、指定されたインスタンスの `disableApiTermination` 属性を記述します。 コマンド: ``` aws ec2 describe-instance-attribute --instance-id i-1234567890abcdef0 --attribute disableApiTermination ``` 出力: ``` { "InstanceId": "i-1234567890abcdef0" "DisableApiTermination": { "Value": "false" } } ``` **インスタンスのブロックデバイスマッピングを記述するには** この例では、指定されたインスタンスの `blockDeviceMapping` 属性を記述します。 コマンド: ``` aws ec2 describe-instance-attribute --instance-id i-1234567890abcdef0 --attribute blockDeviceMapping ``` 出力: ``` { "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" } } ], } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeInstanceAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-instance-attribute.html)」を参照してください。 ### `describe-instance-connect-endpoints` 次のコード例は、`describe-instance-connect-endpoints` を使用する方法を示しています。 **AWS CLI** **EC2 Instance Connect エンドポイントを記述するには** 次の `describe-instance-connect-endpoints` の例では、指定した EC2 Instance Connect エンドポイントについて説明します。 ``` aws ec2 describe-instance-connect-endpoints \ --region us-east-1 \ --instance-connect-endpoint-ids eice-0123456789example ``` 出力: ``` { "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": [] } ] } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[EC2 Instance Connect Endpoint の作成](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-ec2-instance-connect-endpoints.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeInstanceConnectEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-instance-connect-endpoints.html)」を参照してください。 ### `describe-instance-credit-specifications` 次のコード例は、`describe-instance-credit-specifications` を使用する方法を示しています。 **AWS CLI** **つ以上のインスタンスの CPU 使用率に関するクレジットオプションを記述するには** 次の `describe-instance-credit-specifications` の例では、指定したインスタンスの CPU クレジットについて説明します。 ``` aws ec2 describe-instance-credit-specifications \ --instance-ids i-1234567890abcdef0 ``` 出力: ``` { "InstanceCreditSpecifications": [ { "InstanceId": "i-1234567890abcdef0", "CpuCredits": "unlimited" } ] } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[バーストパフォーマンスインスタンスの使用](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-how-to.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeInstanceCreditSpecifications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-instance-credit-specifications.html)」を参照してください。 ### `describe-instance-event-notification-attributes` 次のコード例は、`describe-instance-event-notification-attributes` を使用する方法を示しています。 **AWS CLI** **スケジュールされたイベント通知のタグを記述するには** 次の `describe-instance-event-notification-attributes` の例では、スケジュールされたイベント通知に表示されるタグについて説明します。 ``` aws ec2 describe-instance-event-notification-attributes ``` 出力: ``` { "InstanceTagAttribute": { "InstanceTagKeys": [], "IncludeAllTagsOfInstance": true } } ``` 詳細については、「*Amazon Elastic Compute Cloud User Guide for Linux Instances*」の「[Scheduled events for your instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeInstanceEventNotificationAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-instance-event-notification-attributes.html)」を参照してください。 ### `describe-instance-event-windows` 次のコード例は、`describe-instance-event-windows` を使用する方法を示しています。 **AWS CLI** **例 1: すべてのイベントウィンドウを記述するには** 次の `describe-instance-event-windows` の例では、指定されたリージョン内のすべてのイベントウィンドウについて説明します。 ``` aws ec2 describe-instance-event-windows \ --region us-east-1 ``` 出力: ``` { "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" } ``` **例 2: 特定のイベントウィンドウを記述するには** 次の `describe-instance-event-windows` の例では、`instance-event-window` パラメータを使用して特定のイベントウィンドウを記述し、特定のイベントについて説明します。 ``` aws ec2 describe-instance-event-windows \ --region us-east-1 \ --instance-event-window-ids iew-0abcdef1234567890 ``` 出力: ``` { "InstanceEventWindows": [ { "InstanceEventWindowId": "iew-0abcdef1234567890", "Name": "myEventWindowName", "CronExpression": "* 21-23 * * 2,3", "AssociationTarget": { "InstanceIds": [ "i-1234567890abcdef0", "i-0598c7d356eba48d7" ], "Tags": [], "DedicatedHostIds": [] }, "State": "active", "Tags": [] } } ``` **例 3: 1 つ以上のフィルターに一致するイベントウィンドウを表示するには** 次の `describe-instance-event-windows` の例では、`filter` パラメータを使用して 1 つ以上のフィルターに一致するイベントウィンドウについて説明します。`instance-id` フィルターは、指定されたインスタンスに関連付けられているすべてのイベントウィンドウを記述するために使用されます。フィルタを使用すると、直接的な一致が評価されます。ただし、`instance-id` フィルターの場合は異なります。直接一致するインスタンス ID が見つからない場合は、インスタンスのタグや専有ホスト ID (インスタンスが専有ホストの場合) など、イベントウィンドウとの間接的な関連付けにフォールバックされます。 ``` aws ec2 describe-instance-event-windows \ --region us-east-1 \ --filters Name=instance-id,Values=i-1234567890abcdef0 \ --max-results 100 \ --next-token ``` 出力: ``` { "InstanceEventWindows": [ { "InstanceEventWindowId": "iew-0dbc0adb66f235982", "TimeRanges": [ { "StartWeekDay": "sunday", "StartHour": 2, "EndWeekDay": "sunday", "EndHour": 8 } ], "Name": "myEventWindowName", "AssociationTarget": { "InstanceIds": [], "Tags": [], "DedicatedHostIds": [ "h-0140d9a7ecbd102dd" ] }, "State": "active", "Tags": [] } ] } ``` 出力例では、インスタンスはイベントウィンドウに関連付けられた専有ホスト上にあります。 イベントウィンドウの制約については、「*Amazon EC2 ユーザーガイド*」の「[考慮事項](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html#event-windows-considerations)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeInstanceEventWindows](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-instance-event-windows.html)」を参照してください。 ### `describe-instance-image-metadata` 次のコード例は、`describe-instance-image-metadata` を使用する方法を示しています。 **AWS CLI** **例 1: すべてのインスタンスの AMI メタデータの詳細を取得するには** 次の `describe-instance-image-metadata` の例では、指定したリージョン内の AWS アカウントのすべてのインスタンスの AMI メタデータの詳細を取得します。 ``` aws ec2 describe-instance-image-metadata \ --region us-east-1 ``` 出力: ``` { "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..." } ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[Amazon EC2 の Amazon マシンイメージ](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html)」を参照してください。 **例 2: 指定したインスタンスの AMI メタデータの詳細を取得するには** 次の `describe-instance-image-metadata` の例では、指定したインスタンスの AMI メタデータの詳細を取得します。 ``` aws ec2 describe-instance-image-metadata \ --region us-east-1 \ --instance-ids i-1234567890EXAMPLE i-0987654321EXAMPLE ``` 出力: ``` { "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 } } ] } ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[Amazon EC2 の Amazon マシンイメージ](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html)」を参照してください。 **例 3: フィルタに基づいてインスタンスの AMI メタデータの詳細を取得するには** 次の `describe-instance-image-metadata` の例では、`us-east-1a` アベイラビリティーゾーン内の `t2.nano` および `t2.micro` インスタンスの AMI メタデータの詳細を取得します。 ``` 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 ``` 出力: ``` { "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..." } ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[Amazon EC2 の Amazon マシンイメージ](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DescribeInstanceImageMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-instance-image-metadata.html)」を参照してください。 ### `describe-instance-status` 次のコード例は、`describe-instance-status` を使用する方法を示しています。 **AWS CLI** **インスタンスのステータスを表示するには** 次の `describe-instance-status` の例では、指定したインスタンスの現在のステータスを示しています。 ``` aws ec2 describe-instance-status \ --instance-ids i-1234567890abcdef0 ``` 出力: ``` { "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" } ] } } ] } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[インスタンスのステータスのモニタリング](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeInstanceStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-instance-status.html)」を参照してください。 ### `describe-instance-topology` 次のコード例は、`describe-instance-topology` を使用する方法を示しています。 **AWS CLI** **すべてのインスタンスのインスタンストポロジーを記述するには** 次の `describe-instance-topology` の例では、このコマンドでサポートされているインスタンスタイプに一致するすべてのインスタンスのトポロジについて説明します。 ``` aws ec2 describe-instance-topology \ --region us-west-2 ``` 出力: ``` { "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" } ``` その他の例を含む詳細については、「*Amazon EC2 ユーザーガイド*」の「[Amazon EC2 インスタンストポロジー](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-topology.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeInstanceTopology](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-instance-topology.html)」を参照してください。 ### `describe-instance-type-offerings` 次のコード例は、`describe-instance-type-offerings` を使用する方法を示しています。 **AWS CLI** **例 1: リージョンで提供されるインスタンスタイプを一覧表示するには** 次の `describe-instance-type-offerings` の例では、AWS CLI のデフォルトのリージョンとして設定されたリージョンで提供されるインスタンスタイプを一覧表示します。 ``` aws ec2 describe-instance-type-offerings ``` 別のリージョンで提供されるインスタンスタイプを一覧表示するには、`--region` パラメータを使用してリージョンを指定します。 ``` aws ec2 describe-instance-type-offerings \ --region us-east-2 ``` 出力: ``` { "InstanceTypeOfferings": [ { "InstanceType": "m5.2xlarge", "LocationType": "region", "Location": "us-east-2" }, { "InstanceType": "t3.micro", "LocationType": "region", "Location": "us-east-2" }, ... ] } ``` **例 2: アベイラビリティーゾーンで提供されるインスタンスタイプを一覧表示するには** 次の `describe-instance-type-offerings` の例では、指定したアベイラビリティーゾーンで提供されるインスタンスタイプを一覧表示します。アベイラビリティーゾーンは、指定されたリージョンにある必要があります。 ``` aws ec2 describe-instance-type-offerings \ --location-type availability-zone \ --filters Name=location,Values=us-east-2a \ --region us-east-2 ``` **例 3: インスタンスタイプがサポートされているかどうかを確認するには** 次の `describe-instance-type-offerings` コマンドは、指定されたリージョンで `c5.xlarge` インスタンスタイプがサポートされているかどうかを示します。 ``` aws ec2 describe-instance-type-offerings \ --filters Name=instance-type,Values=c5.xlarge \ --region us-east-2 ``` 次の `describe-instance-type-offerings` の例では、指定したリージョン内でサポートされている C5 インスタンスタイプをすべて一覧表示します。 ``` aws ec2 describe-instance-type-offerings \ --filters Name=instance-type,Values=c5* \ --query "InstanceTypeOfferings[].InstanceType" \ --region us-east-2 ``` 出力: ``` [ "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" ] ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeInstanceTypeOfferings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-instance-type-offerings.html)」を参照してください。 ### `describe-instance-types` 次のコード例は、`describe-instance-types` を使用する方法を示しています。 **AWS CLI** **例 1: インスタンスタイプを説明するには** 次の `describe-instance-types` の例では、指定されたインスタンスタイプの詳細を表示します。 ``` aws ec2 describe-instance-types \ --instance-types t2.micro ``` 出力: ``` { "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 } ] } ``` 詳細については、「*Amazon Elastic Compute Cloud User Guide for Linux Instances*」の「[Instance Types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html)」を参照してください。 **例 2: 使用可能なインスタンスタイプをフィルタリングするには** フィルターを指定して、特定の特性を持つインスタンスタイプに結果を絞り込めます。次の `describe-instance-types` の例では、休止状態をサポートするインスタンスタイプを一覧表示しています。 ``` aws ec2 describe-instance-types \ --filters Name=hibernation-supported,Values=true --query 'InstanceTypes[*].InstanceType' ``` 出力: ``` [ "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" ] ``` 詳細については、「*Amazon Elastic Compute Cloud User Guide for Linux Instances*」の「[Instance Types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeInstanceTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-instance-types.html)」を参照してください。 ### `describe-instances` 次のコード例は、`describe-instances` を使用する方法を示しています。 **AWS CLI** **例 1: インスタンスを説明するには** 次の `describe-instances` の例では、指定したインスタンスを示しています。 ``` aws ec2 describe-instances \ --instance-ids i-1234567890abcdef0 ``` 出力: ``` { "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" } ] } ``` **例 2: 指定したタイプのインスタンスをフィルタリングするには** 次の `describe-instances` の例では、フィルターを使用して、指定されたタイプのインスタンスに結果の範囲を限定しています。 ``` aws ec2 describe-instances \ --filters Name=instance-type,Values=m5.large ``` 出力例については、例 1 を参照してください。 詳細については、「*Amazon EC2 ユーザーガイド*」の「[CLI を使用した一覧表示およびフィルタリング](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Filtering.html#Filtering_Resources_CLI)」を参照してください。 **例 3: 指定したタイプとアベイラビリティーゾーンでインスタンスをフィルタリングするには** 次の `describe-instances` の例では、複数のフィルターを使用して、指定されたアベイラビリティーゾーンにある、指定されたタイプのインスタンスに結果を絞り込みます。 ``` aws ec2 describe-instances \ --filters Name=instance-type,Values=t2.micro,t3.micro Name=availability-zone,Values=us-east-2c ``` 出力例については、例 1 を参照してください。 **例 4: JSON ファイルを使用して、指定したタイプとアベイラビリティーゾーンでインスタンスをフィルタリングするには** 次の `describe-instances` の例では、JSON 入力ファイルを使用して、前の例と同じフィルタリングを実行します。フィルターが複雑になるほど、JSON ファイル内での指定が簡単になります。 ``` aws ec2 describe-instances \ --filters file://filters.json ``` `filters.json` の内容: ``` [ { "Name": "instance-type", "Values": ["t2.micro", "t3.micro"] }, { "Name": "availability-zone", "Values": ["us-east-2c"] } ] ``` 出力例については、例 1 を参照してください。 **例 5: 指定した Owner タグを持つインスタンスをフィルタリングするには** 次の `describe-instances` の例では、タグフィルターを使用して、タグ値に関係なく、指定されたタグキー (Owner) のタグを持つインスタンスに結果を絞り込みます。 ``` aws ec2 describe-instances \ --filters "Name=tag-key,Values=Owner" ``` 出力例については、例 1 を参照してください。 **例 6: 指定した my-team タグ値を持つインスタンスをフィルタリングするには** 次の `describe-instances` の例では、タグフィルターを使用して、タグキーに関係なく、指定されたタグ値 (my-team) のタグを持つインスタンスに結果を絞り込みます。 ``` aws ec2 describe-instances \ --filters "Name=tag-value,Values=my-team" ``` 出力例については、例 1 を参照してください。 **例 7: 指定した Owner タグと my-team 値を持つインスタンスをフィルタリングするには** 次の `describe-instances` の例では、タグフィルターを使用して、指定したタグ (Owner=my-team) を持つインスタンスに結果を絞り込みます。 ``` aws ec2 describe-instances \ --filters "Name=tag:Owner,Values=my-team" ``` 出力例については、例 1 を参照してください。 **例 8: すべてのインスタンスのインスタンス ID とサブネット ID のみを表示するには** 次の `describe-instances` の例では、`--query` パラメータを使用して、すべてのインスタンスのインスタンス ID とサブネット ID のみを JSON 形式で表示します。 Linux および 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 ``` 出力: ``` [ { "Instance": "i-057750d42936e468a", "Subnet": "subnet-069beee9b12030077" }, { "Instance": "i-001efd250faaa6ffa", "Subnet": "subnet-0b715c6b7db68927a" }, { "Instance": "i-027552a73f021f3bd", "Subnet": "subnet-0250c25a1f4e15235" } ... ] ``` **例 9: 指定したタイプのインスタンスをフィルタリングし、そのインスタンス ID のみを表示するには** 次の `describe-instances` の例では、フィルターを使用して、指定されたタイプのインスタンスに結果を絞り込み、`--query` パラメータを使用してインスタンス ID のみを表示します。 ``` aws ec2 describe-instances \ --filters "Name=instance-type,Values=t2.micro" \ --query "Reservations[*].Instances[*].[InstanceId]" \ --output text ``` 出力: ``` i-031c0dc19de2fb70c i-00d8bff789a736b75 i-0b715c6b7db68927a i-0626d4edd54f1286d i-00b8ae04f9f99908e i-0fc71c25d2374130c ``` **例 10: 指定したタイプのインスタンスをフィルタリングし、インスタンス ID、アベイラビリティーゾーン、指定したタグ値のみを表示するには** 次の `describe-instances` の例では、`tag-key` という名前のタグを持つインスタンスのインスタンス ID、アベイラビリティーゾーン、および `Name` タグの値を表形式で表示します。 Linux および 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 ``` 出力: ``` ------------------------------------------------------------- | 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 | +--------------+-----------------------+--------------------+ ``` **例 11: パーティションプレイスメントグループ内のインスタンスを説明するには** 次の `describe-instances` の例では、指定したインスタンスを示しています。出力にはインスタンスのプレイスメント情報が含まれています。この情報にはインスタンスのプレイスメントグループ名とパーティション番号が含まれます。 ``` aws ec2 describe-instances \ --instance-ids i-0123a456700123456 \ --query "Reservations[*].Instances[*].Placement" ``` 出力: ``` [ [ { "AvailabilityZone": "us-east-1c", "GroupName": "HDFS-Group-A", "PartitionNumber": 3, "Tenancy": "default" } ] ] ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[プレイスメントグループのインスタンスの説明](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html#describe-instance-placement)」を参照してください。 **例 12: 指定したプレイスメントグループとパーティション番号を持つインスタンスでフィルタリングするには** 次の `describe-instances` の例では、指定したプレイスメントグループとパーティション番号のインスタンスのみに結果をフィルタリングします。 ``` aws ec2 describe-instances \ --filters "Name=placement-group-name,Values=HDFS-Group-A" "Name=placement-partition-number,Values=7" ``` 次の例では、出力の関連情報のみが表示されます。 ``` "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" } ], ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[プレイスメントグループのインスタンスの説明](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html#describe-instance-placement)」を参照してください。 **例 13: インスタンスメタデータのタグへのアクセスを許可するように設定されているインスタンスに絞り込むには** 次の `describe-instances` の例では、インスタンスメタデータからインスタンスタグへのアクセスを許可するように設定されているインスタンスのみに結果をフィルタリングします。 ``` aws ec2 describe-instances \ --filters "Name=metadata-options.instance-metadata-tags,Values=enabled" \ --query "Reservations[*].Instances[*].InstanceId" \ --output text ``` 次のような出力が予想されます。 ``` i-1234567890abcdefg i-abcdefg1234567890 i-11111111aaaaaaaaa i-aaaaaaaa111111111 ``` 詳細については、「*Amazon EC2 ユーザーガイド*」で[インスタンスメタデータ内のインスタンスタグの使用方法](https://docs.aws.amazon.com/en_us/AWSEC2/latest/UserGuide/Using_Tags.html#view-access-to-tags-in-IMDS)を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-instances.html)」を参照してください。 ### `describe-internet-gateways` 次のコード例は、`describe-internet-gateways` を使用する方法を示しています。 **AWS CLI** **インターネットゲートウェイを記述するには** 次の `describe-internet-gateways` の例では、指定したインターネットゲートウェイについて説明します。 ``` aws ec2 describe-internet-gateways \ --internet-gateway-ids igw-0d0fb496b3EXAMPLE ``` 出力: ``` { "InternetGateways": [ { "Attachments": [ { "State": "available", "VpcId": "vpc-0a60eb65b4EXAMPLE" } ], "InternetGatewayId": "igw-0d0fb496b3EXAMPLE", "OwnerId": "123456789012", "Tags": [ { "Key": "Name", "Value": "my-igw" } ] } ] } ``` 詳細については、*Amazon VPC ユーザーガイド*の「[インターネットゲートウェイ](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeInternetGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-internet-gateways.html)」を参照してください。 ### `describe-ipam-pools` 次のコード例は、`describe-ipam-pools` を使用する方法を示しています。 **AWS CLI** **IPAM プールの詳細を表示するには** 次の `describe-ipam-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 ``` 出力: ``` { "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" } ] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeIpamPools](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-ipam-pools.html)」を参照してください。 ### `describe-ipam-resource-discoveries` 次のコード例は、`describe-ipam-resource-discoveries` を使用する方法を示しています。 **AWS CLI** **例 1: リソース検出の詳細を表示する** この例では、あなたは IPAM の委任された管理者として、別の AWS 組織の IPAM 管理者とリソース検出を作成して共有し、管理者が組織内のリソースの IP アドレスを管理およびモニタリングできるようにしたいと考えています。 この例は、次の場合に便利です。 リソース検出を作成しようとしましたが、上限の 1 に達したというエラーが表示されました。リソース検出を既に作成している可能性があることに気づき、アカウントで確認したいと考えます。IPAM で検出されていないリージョン内にリソースがあります。リソースに対して定義されている `--operating-regions` を表示し、そこにあるリソースを検出できるように、適切なリージョンを運用リージョンとして追加したことを確認します。 次の `describe-ipam-resource-discoveries` の例では、AWS アカウントのリソース検出の詳細を一覧表示します。AWS リージョンごとに 1 つのリソース検出を行うことができます。 ``` aws ec2 describe-ipam-resource-discoveries \ --region us-east-1 ``` 出力: ``` { "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": [] } ] } ``` 詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[Integrate IPAM with accounts outside of your organization](https://docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam-outside-org.html)」を参照してください。 **例 2: リソース検出 ID のみを表示する** 次の `describe-ipam-resource-discoveries` の例では、AWS アカウントのリソース検出の ID を一覧表示します。AWS リージョンごとに 1 つのリソース検出を行うことができます。 ``` aws ec2 describe-ipam-resource-discoveries \ --query "IpamResourceDiscoveries[*].IpamResourceDiscoveryId" \ --output text ``` 出力: ``` ipam-res-disco-0481e39b242860333 ``` 詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[Integrate IPAM with accounts outside of your organization](https://docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam-outside-org.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeIpamResourceDiscoveries](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-ipam-resource-discoveries.html)」を参照してください。 ### `describe-ipam-resource-discovery-associations` 次のコード例は、`describe-ipam-resource-discovery-associations` を使用する方法を示しています。 **AWS CLI** **IPAM とのすべてのリソース検出の関連付けを表示するには** この例では、あなたは IPAM の委任された管理者として、他のアカウントを自身の IPAM と統合するためにリソース検出を自身の IPAM に関連付けています。IPAM がリソース検出の運用リージョン内にあるリソースを期待どおりに検出していないことに気付きました。リソース検出のステータスと状態をチェックして、それを作成したアカウントがまだアクティブであり、リソース検出がまだ共有されていることを確認します。 `--region` は IPAM のホームリージョンである必要があります。 次の `describe-ipam-resource-discovery-associations` の例では、AWS アカウントのリソース検出の関連付けを一覧表示します。 ``` aws ec2 describe-ipam-resource-discovery-associations \ --region us-east-1 ``` 出力: ``` { "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": [] } ] } ``` この例では、このコマンドを実行した後、あなたはデフォルト以外のリソース検出が 1 つあることに気づきます (`"IsDefault": false ``) that is ``"ResourceDiscoveryStatus": "not-found"` と`"State": "create-complete"`。リソース検出の所有者のアカウントは解約されています。別のケースで、`"ResourceDiscoveryStatus": "not-found"` および `"State": "associate-complete"` であることに気付いた場合は、これは次のいずれかが発生したことを示します。 リソース検出がリソース検出の所有者によって削除された。リソース検出の所有者がリソース検出の共有を解除した。 詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[Integrate IPAM with accounts outside of your organization](https://docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam-outside-org.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeIpamResourceDiscoveryAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-ipam-resource-discovery-associations.html)」を参照してください。 ### `describe-ipam-scopes` 次のコード例は、`describe-ipam-scopes` を使用する方法を示しています。 **AWS CLI** **IPAM スコープの詳細を表示するには** 次の `describe-ipam-scopes` の例では、スコープの詳細を表示します。 ``` aws ec2 describe-ipam-scopes \ --filters Name=owner-id,Values=123456789012 Name=ipam-id,Values=ipam-08440e7a3acde3908 ``` 出力: ``` { "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" } ] } ] } ``` + API の詳細については、「**AWS CLI コマンドリファレンス」の「[DescribeIpamScopes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-ipam-scopes.html)」を参照してください。 ### `describe-ipams` 次のコード例は、`describe-ipams` を使用する方法を示しています。 **AWS CLI** **IPAM の詳細を表示するには** 次の `describe-ipams` の例では、IPAM の詳細を表示します。 ``` aws ec2 describe-ipams \ --filters Name=owner-id,Values=123456789012 ``` 出力: ``` { "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" } ] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeIpams](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-ipams.html)」を参照してください。 ### `describe-ipv6-pools` 次のコード例は、`describe-ipv6-pools` を使用する方法を示しています。 **AWS CLI** **IPv6 アドレスプールを記述するには** 次の `describe-ipv6-pools` の例では、すべての IPv6 アドレスプールの詳細を表示します。 ``` aws ec2 describe-ipv6-pools ``` 出力: ``` { "Ipv6Pools": [ { "PoolId": "ipv6pool-ec2-012345abc12345abc", "PoolCidrBlocks": [ { "Cidr": "2001:db8:123::/48" } ], "Tags": [ { "Key": "pool-1", "Value": "public" } ] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeIpv6Pools](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-ipv6-pools.html)」を参照してください。 ### `describe-key-pairs` 次のコード例は、`describe-key-pairs` を使用する方法を示しています。 **AWS CLI** **キーペアを表示するには** 次の `describe-key-pairs` の例では、指定されたキーペアの情報が表示されます。 ``` aws ec2 describe-key-pairs \ --key-names my-key-pair ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[パブリックキーの説明](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/describe-keys.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeKeyPairs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-key-pairs.html)」を参照してください。 ### `describe-launch-template-versions` 次のコード例は、`describe-launch-template-versions` を使用する方法を示しています。 **AWS CLI** **起動テンプレートのバージョンを記述するには** この例では、指定された起動テンプレートのバージョンを記述します。 コマンド: ``` aws ec2 describe-launch-template-versions --launch-template-id lt-068f72b72934aff71 ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeLaunchTemplateVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-launch-template-versions.html)」を参照してください。 ### `describe-launch-templates` 次のコード例は、`describe-launch-templates` を使用する方法を示しています。 **AWS CLI** **起動テンプレートを記述するには** この例では、起動テンプレートを記述します。 コマンド: ``` aws ec2 describe-launch-templates ``` 出力: ``` { "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" }, ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeLaunchTemplates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-launch-templates.html)」を参照してください。 ### `describe-local-gateway-route-table-virtual-interface-group-associations` 次のコード例は、`describe-local-gateway-route-table-virtual-interface-group-associations` を使用する方法を示しています。 **AWS CLI** **仮想インターフェイスグループとローカルゲートウェイのルートテーブル間の関連付けを記述するには** 次の `describe-local-gateway-route-table-virtual-interface-group-associations` の例では、AWS アカウント内の仮想インターフェイスグループとローカルゲートウェイのルートテーブル間の関連付けについて説明します。 ``` aws ec2 describe-local-gateway-route-table-virtual-interface-group-associations ``` 出力: ``` { "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": [] } ] } ``` 詳細については、「*AWS Outposts ユーザーガイド*」の「[Working with local gateways](https://docs.aws.amazon.com/outposts/latest/userguide/outposts-local-gateways.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-local-gateway-route-table-virtual-interface-group-associations.html)」を参照してください。 ### `describe-local-gateway-route-table-vpc-associations` 次のコード例は、`describe-local-gateway-route-table-vpc-associations` を使用する方法を示しています。 **AWS CLI** **VPC とローカルゲートウェイのルートテーブル間の関連付けを記述するには** 次の `describe-local-gateway-route-table-vpc-associations` の例では、VPC とローカルゲートウェイのルートテーブル間の指定した関連付けの情報を表示します。 ``` aws ec2 describe-local-gateway-route-table-vpc-associations \ --local-gateway-route-table-vpc-association-ids lgw-vpc-assoc-0e0f27af15EXAMPLE ``` 出力: ``` { "LocalGatewayRouteTableVpcAssociation": { "LocalGatewayRouteTableVpcAssociationId": "lgw-vpc-assoc-0e0f27af1EXAMPLE", "LocalGatewayRouteTableId": "lgw-rtb-059615ef7dEXAMPLE", "LocalGatewayId": "lgw-09b493aa7cEXAMPLE", "VpcId": "vpc-0efe9bde08EXAMPLE", "State": "associated" } } ``` 詳細については、「* Outposts ユーザーガイド*」の「[ローカルゲートウェイルートテーブル](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeLocalGatewayRouteTableVpcAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-local-gateway-route-table-vpc-associations.html)」を参照してください。 ### `describe-local-gateway-route-tables` 次のコード例は、`describe-local-gateway-route-tables` を使用する方法を示しています。 **AWS CLI** **ローカルゲートウェイのルートテーブルを記述するには** 次の `describe-local-gateway-route-tables` の例では、ローカルゲートウェイのルートテーブルの詳細を表示します。 ``` aws ec2 describe-local-gateway-route-tables ``` 出力: ``` { "LocalGatewayRouteTables": [ { "LocalGatewayRouteTableId": "lgw-rtb-059615ef7deEXAMPLE", "LocalGatewayId": "lgw-09b493aa7cEXAMPLE", "OutpostArn": "arn:aws:outposts:us-west-2:111122223333:outpost/op-0dc11b66edEXAMPLE", "State": "available" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeLocalGatewayRouteTables](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-local-gateway-route-tables.html)」を参照してください。 ### `describe-local-gateway-virtual-interface-groups` 次のコード例は、`describe-local-gateway-virtual-interface-groups` を使用する方法を示しています。 **AWS CLI** **ローカルゲートウェイ仮想インターフェイスグループを記述するには** 次の `describe-local-gateway-virtual-interface-groups` の例では、AWS アカウント内のローカルゲートウェイの仮想インターフェイスグループについて説明します。 ``` aws ec2 describe-local-gateway-virtual-interface-groups ``` 出力: ``` { "LocalGatewayVirtualInterfaceGroups": [ { "LocalGatewayVirtualInterfaceGroupId": "lgw-vif-grp-07145b276bEXAMPLE", "LocalGatewayVirtualInterfaceIds": [ "lgw-vif-01a23bc4d5EXAMPLE", "lgw-vif-543ab21012EXAMPLE" ], "LocalGatewayId": "lgw-0ab1c23d4eEXAMPLE", "OwnerId": "123456789012", "Tags": [] } ] } ``` 詳細については、「*AWS Outposts ユーザーガイド*」の「[Working with local gateways](https://docs.aws.amazon.com/outposts/latest/userguide/outposts-local-gateways.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeLocalGatewayVirtualInterfaceGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-local-gateway-virtual-interface-groups.html)」を参照してください。 ### `describe-local-gateway-virtual-interfaces` 次のコード例は、`describe-local-gateway-virtual-interfaces` を使用する方法を示しています。 **AWS CLI** **ローカルゲートウェイ仮想インターフェイスを記述するには** 次の `describe-local-gateway-virtual-interfaces` の例では、AWS アカウント内のローカルゲートウェイの仮想インターフェイスについて説明します。 ``` aws ec2 describe-local-gateway-virtual-interfaces ``` 出力: ``` { "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": [] } ] } ``` 詳細については、「*AWS Outposts ユーザーガイド*」の「[Working with local gateways](https://docs.aws.amazon.com/outposts/latest/userguide/outposts-local-gateways.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeLocalGatewayVirtualInterfaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-local-gateway-virtual-interfaces.html)」を参照してください。 ### `describe-local-gateways` 次のコード例は、`describe-local-gateways` を使用する方法を示しています。 **AWS CLI** **ローカルゲートウェイを記述するには** 次の `describe-local-gateways` の例では、使用可能なローカルゲートウェイの詳細を表示します。 ``` aws ec2 describe-local-gateways ``` 出力: ``` { "LocalGateways": [ { "LocalGatewayId": "lgw-09b493aa7cEXAMPLE", "OutpostArn": "arn:aws:outposts:us-west-2:123456789012:outpost/op-0dc11b66ed59f995a", "OwnerId": "123456789012", "State": "available" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeLocalGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-local-gateways.html)」を参照してください。 ### `describe-locked-snapshots` 次のコード例は、`describe-locked-snapshots` を使用する方法を示しています。 **AWS CLI** **スナップショットのロックのステータスを記述するには** 次の `describe-locked-snapshots` の例では、指定したスナップショットのロックのステータスについて説明します。 ``` aws ec2 describe-locked-snapshots \ --snapshot-ids snap-0b5e733b4a8df6e0d ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon EBS ユーザーガイド*」の「[Snapshot lock](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-snapshot-lock.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeLockedSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-locked-snapshots.html)」を参照してください。 ### `describe-managed-prefix-lists` 次のコード例は、`describe-managed-prefix-lists` を使用する方法を示しています。 **AWS CLI** **マネージドプレフィックスリストを記述するには** 次の `describe-managed-prefix-lists` の例では、AWS アカウント `123456789012` が所有するプレフィックスリストについて説明します。 ``` aws ec2 describe-managed-prefix-lists \ --filters Name=owner-id,Values=123456789012 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon VPC ユーザーガイド*」の「[Managed prefix lists](https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeManagedPrefixLists](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-managed-prefix-lists.html)」を参照してください。 ### `describe-moving-addresses` 次のコード例は、`describe-moving-addresses` を使用する方法を示しています。 **AWS CLI** **移動アドレスを記述するには** この例では、移動するすべての Elastic IP アドレスを記述します。 コマンド: ``` aws ec2 describe-moving-addresses ``` 出力: ``` { "MovingAddressStatuses": [ { "PublicIp": "198.51.100.0", "MoveStatus": "MovingToVpc" } ] } ``` この例では、EC2-VPC プラットフォームに移動するすべてのアドレスを記述します。 コマンド: ``` aws ec2 describe-moving-addresses --filters Name=moving-status,Values=MovingToVpc ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeMovingAddresses](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-moving-addresses.html)」を参照してください。 ### `describe-nat-gateways` 次のコード例は、`describe-nat-gateways` を使用する方法を示しています。 **AWS CLI** **例 1: パブリック NAT ゲートウェイを記述するには** 次の `describe-nat-gateways` の例では、指定したパブリック NAT ゲートウェイについて説明します。 ``` aws ec2 describe-nat-gateways \ --nat-gateway-id nat-01234567890abcdef ``` 出力: ``` { "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" } ] } ``` **例 2: プライベート NAT ゲートウェイを記述するには** 次の `describe-nat-gateways` の例では、指定したプライベート NAT ゲートウェイについて説明します。 ``` aws ec2 describe-nat-gateways \ --nat-gateway-id nat-1234567890abcdef0 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon VPC ユーザーガイド*」の「[NAT ゲートウェイ](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeNatGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-nat-gateways.html)」を参照してください。 ### `describe-network-acls` 次のコード例は、`describe-network-acls` を使用する方法を示しています。 **AWS CLI** **ネットワーク ACL を記述するには** 次の `describe-network-acls` の例では、ネットワーク ACL の詳細を取得します。 ``` aws ec2 describe-network-acls ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS VPC ユーザーガイド*」の「[Network ACLs](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-network-acls.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeNetworkAcls](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-network-acls.html)」を参照してください。 ### `describe-network-insights-access-scope-analyses` 次のコード例は、`describe-network-insights-access-scope-analyses` を使用する方法を示しています。 **AWS CLI** **Network Insights アクセススコープ分析を記述するには** 次の `describe-network-insights-access-scope-analyses` の例では、AWS アカウントのアクセス範囲の分析について説明します。 ``` aws ec2 describe-network-insights-access-scope-analyses \ --region us-east-1 ``` 出力: ``` { "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": [] } ] } ``` 詳細については、「*Network Access Analyzer ガイド*」の「[Getting started with Network Access Analyzer using the AWS CLI](https://docs.aws.amazon.com/vpc/latest/network-access-analyzer/getting-started-cli-naa.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeNetworkInsightsAccessScopeAnalyses](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-network-insights-access-scope-analyses.html)」を参照してください。 ### `describe-network-insights-access-scopes` 次のコード例は、`describe-network-insights-access-scopes` を使用する方法を示しています。 **AWS CLI** **Network Insights アクセススコープを記述するには** 次の `describe-network-insights-access-scopes` の例では、AWS アカウントのアクセス範囲の分析について説明します。 ``` aws ec2 describe-network-insights-access-scopes \ --region us-east-1 ``` 出力: ``` { "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": [] } ] } ``` 詳細については、「*Network Access Analyzer ガイド*」の「[Getting started with Network Access Analyzer using the AWS CLI](https://docs.aws.amazon.com/vpc/latest/network-access-analyzer/getting-started-cli-naa.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeNetworkInsightsAccessScopes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-network-insights-access-scopes.html)」を参照してください。 ### `describe-network-insights-analyses` 次のコード例は、`describe-network-insights-analyses` を使用する方法を示しています。 **AWS CLI** **パス分析の結果を表示するには** 次の `describe-network-insights-analyses` の例では、指定した分析について説明します。この例では、送信元はインターネットゲートウェイ、送信先は EC2 インスタンス、プロトコルは TCP です。分析は成功し (`Status` は `succeeded`)、パスに到達できません (`NetworkPathFound` は `false`)。説明コード `ENI_SG_RULES_MISMATCH` は、インスタンスのセキュリティグループに、送信先ポートでトラフィックを許可するルールが含まれていないことを示します。 ``` aws ec2 describe-network-insights-analyses \ --network-insights-analysis-ids nia-02207aa13eb480c7a ``` 出力: ``` { "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": [] } ] } ``` 詳細については、「*Reachability Analyzer ガイド*」の「[Getting started using the AWS CLI](https://docs.aws.amazon.com/vpc/latest/reachability/getting-started-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeNetworkInsightsAnalyses](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-network-insights-analyses.html)」を参照してください。 ### `describe-network-insights-paths` 次のコード例は、`describe-network-insights-paths` を使用する方法を示しています。 **AWS CLI** **パスを記述するには** 次の `describe-network-insights-paths` の例では、指定したパスについて説明します。 ``` aws ec2 describe-network-insights-paths \ --network-insights-path-ids nip-0b26f224f1d131fa8 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Reachability Analyzer ガイド*」の「[Getting started using the AWS CLI](https://docs.aws.amazon.com/vpc/latest/reachability/getting-started-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeNetworkInsightsPaths](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-network-insights-paths.html)」を参照してください。 ### `describe-network-interface-attribute` 次のコード例は、`describe-network-interface-attribute` を使用する方法を示しています。 **AWS CLI** **ネットワークインターフェイスのアタッチメント属性を記述するには** このコマンド例では、指定されたネットワークインターフェイスの `attachment` 属性を記述します。 コマンド: ``` aws ec2 describe-network-interface-attribute --network-interface-id eni-686ea200 --attribute attachment ``` 出力: ``` { "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" } } ``` **ネットワークインターフェイスの説明属性を記述するには** このコマンド例では、指定されたネットワークインターフェイスの `description` 属性を記述します。 コマンド: ``` aws ec2 describe-network-interface-attribute --network-interface-id eni-686ea200 --attribute description ``` 出力: ``` { "NetworkInterfaceId": "eni-686ea200", "Description": { "Value": "My description" } } ``` **ネットワークインターフェイスの groupSet 属性を記述するには** このコマンド例では、指定されたネットワークインターフェイスの `groupSet` 属性を記述します。 コマンド: ``` aws ec2 describe-network-interface-attribute --network-interface-id eni-686ea200 --attribute groupSet ``` 出力: ``` { "NetworkInterfaceId": "eni-686ea200", "Groups": [ { "GroupName": "my-security-group", "GroupId": "sg-903004f8" } ] } ``` **ネットワークインターフェイスの sourceDestCheck 属性を記述するには** このコマンド例では、指定されたネットワークインターフェイスの `sourceDestCheck` 属性を記述します。 コマンド: ``` aws ec2 describe-network-interface-attribute --network-interface-id eni-686ea200 --attribute sourceDestCheck ``` 出力: ``` { "NetworkInterfaceId": "eni-686ea200", "SourceDestCheck": { "Value": true } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeNetworkInterfaceAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-network-interface-attribute.html)」を参照してください。 ### `describe-network-interface-permissions` 次のコード例は、`describe-network-interface-permissions` を使用する方法を示しています。 **AWS CLI** **ネットワークインターフェイス権限を記述するには** この例では、すべてのネットワークインターフェイスのアクセス許可を記述します。 コマンド: ``` aws ec2 describe-network-interface-permissions ``` 出力: ``` { "NetworkInterfacePermissions": [ { "PermissionState": { "State": "GRANTED" }, "NetworkInterfacePermissionId": "eni-perm-06fd19020ede149ea", "NetworkInterfaceId": "eni-b909511a", "Permission": "INSTANCE-ATTACH", "AwsAccountId": "123456789012" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeNetworkInterfacePermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-network-interface-permissions.html)」を参照してください。 ### `describe-network-interfaces` 次のコード例は、`describe-network-interfaces` を使用する方法を示しています。 **AWS CLI** **ネットワークインターフェイスを記述するには** この例では、すべてのネットワークインターフェイスを記述します。 コマンド: ``` aws ec2 describe-network-interfaces ``` 出力: ``` { "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" } ] } ``` この例では、キー `Purpose` と値 `Prod` を含むタグを持つネットワークインターフェイスを記述します。 コマンド: ``` aws ec2 describe-network-interfaces --filters Name=tag:Purpose,Values=Prod ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeNetworkInterfaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-network-interfaces.html)」を参照してください。 ### `describe-placement-groups` 次のコード例は、`describe-placement-groups` を使用する方法を示しています。 **AWS CLI** **プレイスメントグループを記述するには** このコマンド例では、すべてのプレイスメントグループを記述します。 コマンド: ``` aws ec2 describe-placement-groups ``` 出力: ``` { "PlacementGroups": [ { "GroupName": "my-cluster", "State": "available", "Strategy": "cluster" }, ... ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribePlacementGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-placement-groups.html)」を参照してください。 ### `describe-prefix-lists` 次のコード例は、`describe-prefix-lists` を使用する方法を示しています。 **AWS CLI** **プレフィックスリストを記述するには** この例では、リージョンで使用可能なすべてのプレフィックスリストを一覧表示します。 コマンド: ``` aws ec2 describe-prefix-lists ``` 出力: ``` { "PrefixLists": [ { "PrefixListName": "com.amazonaws.us-east-1.s3", "Cidrs": [ "54.231.0.0/17" ], "PrefixListId": "pl-63a5400a" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribePrefixLists](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-prefix-lists.html)」を参照してください。 ### `describe-principal-id-format` 次のコード例は、`describe-principal-id-format` を使用する方法を示しています。 **AWS CLI** **長い ID 形式が有効になっている IAM ユーザーとロールの ID 形式を記述するには** 次の `describe-principal-id-format` の例では、ルートユーザーの ID 形式、すべての IAM ロール、および長い ID 形式が有効になっているすべての IAM ユーザーについて説明します。 ``` aws ec2 describe-principal-id-format \ --resource instance ``` 出力: ``` { "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 }, ] }, ... ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribePrincipalIdFormat](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-principal-id-format.html)」を参照してください。 ### `describe-public-ipv4-pools` 次のコード例は、`describe-public-ipv4-pools` を使用する方法を示しています。 **AWS CLI** **パブリック IPv4 アドレスプールを記述するには** 次の `describe-public-ipv4-pools` の例では、BYOIP (Bring Your Own IP Addresses) を使用してパブリック IPv4 アドレス範囲をプロビジョニングしたときに作成されたアドレスプールの詳細を表示します。 ``` aws ec2 describe-public-ipv4-pools ``` 出力: ``` { "PublicIpv4Pools": [ { "PoolId": "ipv4pool-ec2-1234567890abcdef0", "PoolAddressRanges": [ { "FirstAddress": "203.0.113.0", "LastAddress": "203.0.113.255", "AddressCount": 256, "AvailableAddressCount": 256 } ], "TotalAddressCount": 256, "TotalAvailableAddressCount": 256 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribePublicIpv4Pools](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-public-ipv4-pools.html)」を参照してください。 ### `describe-regions` 次のコード例は、`describe-regions` を使用する方法を示しています。 **AWS CLI** **例 1: 有効になっているすべてのリージョンを説明するには** 次の `describe-regions` の例は、アカウントで有効なすべてのリージョンを説明しています。 ``` aws ec2 describe-regions ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[リージョンとゾーン](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html)」を参照してください。 **例 2: エンドポイント名に特定の文字列が含まれる有効なリージョンを説明するには** 次の `describe-regions` の例では、エンドポイントに「us」という文字列が含まれる、有効にしたすべてのリージョンを説明しています。 ``` aws ec2 describe-regions \ --filters "Name=endpoint,Values=*us*" ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[リージョンとゾーン](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html)」を参照してください。 **例 3: すべてのリージョンを説明するには** 次の `describe-regions` の例では、無効になっているリージョンを含め、使用可能なすべてのリージョンについて説明しています。 ``` aws ec2 describe-regions \ --all-regions ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[リージョンとゾーン](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html)」を参照してください。 **例 4: リージョン名だけを一覧表示するには** 次の `describe-regions` の例では、`--query` パラメータを使用して出力をフィルタリングし、リージョンの名前のみをテキストとして返します。 ``` aws ec2 describe-regions \ --all-regions \ --query "Regions[].{Name:RegionName}" \ --output text ``` 出力: ``` 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 ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[リージョンとゾーン](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeRegions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-regions.html)」を参照してください。 ### `describe-replace-root-volume-tasks` 次のコード例は、`describe-replace-root-volume-tasks` を使用する方法を示しています。 **AWS CLI** **例 1: 特定のルートボリューム置き換えタスクに関する情報を表示するには** 次の `describe-replace-root-volume-tasks` の例では、ルートボリュームの置き換えタスク replacevol-0111122223333abcd について説明します。 ``` aws ec2 describe-replace-root-volume-tasks \ --replace-root-volume-task-ids replacevol-0111122223333abcd ``` 出力: ``` { "ReplaceRootVolumeTasks": [ { "ReplaceRootVolumeTaskId": "replacevol-0111122223333abcd", "Tags": [], "InstanceId": "i-0123456789abcdefa", "TaskState": "succeeded", "StartTime": "2022-03-14T15:16:28Z", "CompleteTime": "2022-03-14T15:16:52Z" } ] } ``` 詳細については、「*Amazon Elastic Compute Cloud ユーザーガイド*」の「[Replace a root volume](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-restoring-volume.html#replace-root)」を参照してください。 **例 2: 特定のインスタンスのすべてのルートボリューム置き換えタスクに関する情報を表示するには** 次の `describe-replace-root-volume-tasks` の例では、インスタンス i-0123456789abcdefa のすべてのルートボリュームの置き換えタスクについて説明します。 ``` aws ec2 describe-replace-root-volume-tasks \ --filters Name=instance-id,Values=i-0123456789abcdefa ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Elastic Compute Cloud ユーザーガイド*」の「[Replace a root volume](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-restoring-volume.html#replace-root)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeReplaceRootVolumeTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-replace-root-volume-tasks.html)」を参照してください。 ### `describe-reserved-instances-listings` 次のコード例は、`describe-reserved-instances-listings` を使用する方法を示しています。 **AWS CLI** **リザーブドインスタンスのリストを記述するには** 次の `describe-reserved-instances-listings` の例では、指定したリザーブドインスタンスのリスト関する情報を取得します。 ``` aws ec2 describe-reserved-instances-listings \ --reserved-instances-listing-id 5ec28771-05ff-4b9b-aa31-9e57dexample ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeReservedInstancesListings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-reserved-instances-listings.html)」を参照してください。 ### `describe-reserved-instances-modifications` 次のコード例は、`describe-reserved-instances-modifications` を使用する方法を示しています。 **AWS CLI** **リザーブドインスタンスの変更を記述するには** このコマンド例では、 アカウントに対して送信されたすべてのリザーブドインスタンスの変更リクエストを記述します。 コマンド: ``` aws ec2 describe-reserved-instances-modifications ``` 出力: ``` { "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" } ] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeReservedInstancesModifications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-reserved-instances-modifications.html)」を参照してください。 ### `describe-reserved-instances-offerings` 次のコード例は、`describe-reserved-instances-offerings` を使用する方法を示しています。 **AWS CLI** **リザーブドインスタンスサービスを記述するには** このコマンド例では、リージョンで購入できるすべてのリザーブドインスタンスを記述します。 コマンド: ``` aws ec2 describe-reserved-instances-offerings ``` 出力: ``` { "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" }, ... } ``` **オプションを使用してリザーブドインスタンスサービスを記述するには** この例では、t1.micro インスタンスタイプ、Windows (Amazon VPC) 製品、Heavy Utilization 製品など、AWS が提供するリザーブドインスタンスを一覧表示します。 コマンド: ``` aws ec2 describe-reserved-instances-offerings --no-include-marketplace --instance-type "t1.micro" --product-description "Windows (Amazon VPC)" --offering-type "no upfront" ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeReservedInstancesOfferings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-reserved-instances-offerings.html)」を参照してください。 ### `describe-reserved-instances` 次のコード例は、`describe-reserved-instances` を使用する方法を示しています。 **AWS CLI** **リザーブドインスタンスを記述するには** このコマンド例では、所有しているリザーブドインスタンスを記述します。 コマンド: ``` aws ec2 describe-reserved-instances ``` 出力: ``` { "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 }, ... ] } ``` **フィルターを使用してリザーブドインスタンスを記述するには** この例では、us-west-1c に 3 年間の t2.micro Linux/UNIX リザーブドインスタンスのみを含めるようにレスポンスをフィルタリングします。 コマンド: ``` 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 ``` 出力: ``` { "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 } ] } ``` 詳細については、「*AWS コマンドラインインターフェイスユーザーガイド*」で Amazon EC2 インスタンスの使用方法を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeReservedInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-reserved-instances.html)」を参照してください。 ### `describe-route-tables` 次のコード例は、`describe-route-tables` を使用する方法を示しています。 **AWS CLI** **ルートテーブルを記述するには** 次の `describe-route-tables` の例では、ルートテーブルの詳細を取得します。 ``` aws ec2 describe-route-tables ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS VPC ユーザーガイド*」の「[Working with Route Tables](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html#WorkWithRouteTables)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeRouteTables](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-route-tables.html)」を参照してください。 ### `describe-scheduled-instance-availability` 次のコード例は、`describe-scheduled-instance-availability` を使用する方法を示しています。 **AWS CLI** **使用可能なスケジュールを記述するには** この例では、指定した日付から毎週日曜日に発生するスケジュールを記述します。 コマンド: ``` 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 ``` 出力: ``` { "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" }, ... ] } ``` 結果を絞り込むために、オペレーティングシステム、ネットワーク、インスタンスタイプを指定するフィルターを追加できます。 コマンド: --filters Name=platform,Values=Linux/UNIX Name=network-platform,Values=EC2-VPC Name=instance-type,Values=c4.large + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeScheduledInstanceAvailability](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-scheduled-instance-availability.html)」を参照してください。 ### `describe-scheduled-instances` 次のコード例は、`describe-scheduled-instances` を使用する方法を示しています。 **AWS CLI** **スケジュールされたインスタンスを記述するには** この例では、指定のスケジュールされたインスタンスを記述します。 コマンド: ``` aws ec2 describe-scheduled-instances --scheduled-instance-ids sci-1234-1234-1234-1234-123456789012 ``` 出力: ``` { "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" } ] } ``` この例では、すべてのスケジュールされたインスタンスを記述します。 コマンド: ``` aws ec2 describe-scheduled-instances ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeScheduledInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-scheduled-instances.html)」を参照してください。 ### `describe-security-group-references` 次のコード例は、`describe-security-group-references` を使用する方法を示しています。 **AWS CLI** **セキュリティグループの参照を記述するには** この例では、`sg-bbbb2222` のセキュリティグループの参照を記述します。応答は、セキュリティグループ `sg-bbbb2222` が VPC `vpc-aaaaaaaa` のセキュリティグループで参照されていることを示します。 コマンド: ``` aws ec2 describe-security-group-references --group-id sg-bbbbb22222 ``` 出力: ``` { "SecurityGroupsReferenceSet": [ { "ReferencingVpcId": "vpc-aaaaaaaa ", "GroupId": "sg-bbbbb22222", "VpcPeeringConnectionId": "pcx-b04deed9" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeSecurityGroupReferences](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-security-group-references.html)」を参照してください。 ### `describe-security-group-rules` 次のコード例は、`describe-security-group-rules` を使用する方法を示しています。 **AWS CLI** **例 1: セキュリティグループのセキュリティグループルールを記述するには** 次の `describe-security-group-rules` の例では、指定したセキュリティグループのセキュリティグループルールについて説明します。`filters` オプションを使用して、結果を特定のセキュリティグループにスコープします。 ``` aws ec2 describe-security-group-rules \ --filters Name="group-id",Values="sg-1234567890abcdef0" ``` 出力: ``` { "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": [] } ] } ``` **例 2: セキュリティグループルールを記述するには** 次の `describe-security-group-rules` の例では、指定したセキュリティグループルールについて説明します。 ``` aws ec2 describe-security-group-rules \ --security-group-rule-ids sgr-cdef01234567890ab ``` 出力: ``` { "SecurityGroupRules": [ { "SecurityGroupRuleId": "sgr-cdef01234567890ab", "GroupId": "sg-1234567890abcdef0", "GroupOwnerId": "111122223333", "IsEgress": true, "IpProtocol": "-1", "FromPort": -1, "ToPort": -1, "CidrIpv4": "0.0.0.0/0", "Tags": [] } ] } ``` 詳細については、「*Amazon VPC ユーザーガイド*」の「[セキュリティグループルール](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeSecurityGroupRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-security-group-rules.html)」を参照してください。 ### `describe-security-group-vpc-associations` 次のコード例は、`describe-security-group-vpc-associations` を使用する方法を示しています。 **AWS CLI** **VPC の関連付けを記述するには** 次の `describe-security-group-vpc-associations` の例では、指定したセキュリティグループの VPC 関連付けを記述します。 ``` aws ec2 describe-security-group-vpc-associations \ --filters Name=group-id,Values=sg-04dbb43907d3f8a78 ``` 出力: ``` { "SecurityGroupVpcAssociations": [ { "GroupId": "sg-04dbb43907d3f8a78", "VpcId": "vpc-0bf4c2739bc05a694", "VpcOwnerId": "123456789012", "State": "associated" } ] } ``` 詳細については、「*Amazon VPC ユーザーガイド*」の「[セキュリティグループを複数の VPC に関連付ける](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-assoc.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeSecurityGroupVpcAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-security-group-vpc-associations.html)」を参照してください。 ### `describe-security-groups` 次のコード例は、`describe-security-groups` を使用する方法を示しています。 **AWS CLI** **例 1: セキュリティグループを説明するには** 次の `describe-security-groups` の例では、指定したセキュリティグループを示しています。 ``` aws ec2 describe-security-groups \ --group-ids sg-903004f8 ``` 出力: ``` { "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", } ] } ``` **例 2: 特定のルールを持つセキュリティグループを説明するには** 次の `describe-security-groups` の例では、フィルターを使用して、SSH トラフィック (ポート 22) を許可するルールと、すべてのアドレス (`0.0.0.0/0`) からのトラフィックを許可するルールを持つセキュリティグループに結果の範囲を絞り込みます。例では、`--query` パラメータを使用してセキュリティグループの名前のみを表示しています。セキュリティグループが結果で返されるようにするには、すべてのフィルターに一致する必要があります。ただし、1 つのルールがすべてのフィルターに一致する必要はありません。例えば、出力は、特定の IP アドレスからの SSH トラフィックを許可するルールと、すべてのアドレスからの HTTP トラフィックを許可する別のルールを含むセキュリティグループを返します。 ``` 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 ``` 出力: ``` default my-security-group web-servers launch-wizard-1 ``` **例 3: タグに基づいてセキュリティグループを説明するには** 次の `describe-security-groups` の例では、フィルターを使用して、セキュリティグループ名に `test` が含まれ、タグ `Test=To-delete` が付けられているセキュリティグループに結果を絞り込みます。例では、`--query` パラメータを使用してセキュリティグループの名前と ID のみを表示しています。 ``` aws ec2 describe-security-groups \ --filters Name=group-name,Values=*test* Name=tag:Test,Values=To-delete \ --query "SecurityGroups[*].{Name:GroupName,ID:GroupId}" ``` 出力: ``` [ { "Name": "testfornewinstance", "ID": "sg-33bb22aa" }, { "Name": "newgrouptest", "ID": "sg-1a2b3c4d" } ] ``` タグフィルターを使用するその他の例については、「*Amazon EC2 ユーザーガイド*」の「[タグの使用方法](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#Using_Tags_CLI)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeSecurityGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-security-groups.html)」を参照してください。 ### `describe-snapshot-attribute` 次のコード例は、`describe-snapshot-attribute` を使用する方法を示しています。 **AWS CLI** **スナップショットのスナップショット属性を記述するには** 次の `describe-snapshot-attribute` の例では、スナップショットを共有するアカウントを一覧表示します。 ``` aws ec2 describe-snapshot-attribute \ --snapshot-id snap-01234567890abcedf \ --attribute createVolumePermission ``` 出力: ``` { "SnapshotId": "snap-01234567890abcedf", "CreateVolumePermissions": [ { "UserId": "123456789012" } ] } ``` 詳細については、「*Amazon Elastic Compute Cloud ユーザーガイド*」の「[Share an Amazon EBS snapshot](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-modifying-snapshot-permissions.html#share-unencrypted-snapshot)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeSnapshotAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-snapshot-attribute.html)」を参照してください。 ### `describe-snapshot-tier-status` 次のコード例は、`describe-snapshot-tier-status` を使用する方法を示しています。 **AWS CLI** **アーカイブされたスナップショットに関するアーカイブ情報を表示するには** 次の `describe-snapshot-tier-status` の例では、アーカイブされたスナップショットに関するアーカイブ情報を提供します。 ``` aws ec2 describe-snapshot-tier-status \ --filters "Name=snapshot-id, Values=snap-01234567890abcedf" ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Elastic Compute Cloud ユーザーガイド*」の「[アーカイブされたスナップショットを表示する](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/working-with-snapshot-archiving.html#view-archived-snapshot)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeSnapshotTierStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-snapshot-tier-status.html)」を参照してください。 ### `describe-snapshots` 次のコード例は、`describe-snapshots` を使用する方法を示しています。 **AWS CLI** **例 1: スナップショットを説明するには** 次の `describe-snapshots` の例では、指定したスナップショットを示しています。 ``` aws ec2 describe-snapshots \ --snapshot-ids snap-1234567890abcdef0 ``` 出力: ``` { "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" } ] } ] } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[Amazon EBS スナップショット](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html)」を参照してください。 **例 2: フィルターに基づいてスナップショットを説明するには** 次の `describe-snapshots` の例では、フィルターを使用して、`pending` 状態にある AWS アカウントが所有するスナップショットに結果の範囲を絞り込んでいます。この例では、`--query` パラメータを使用して、スナップショット ID とスナップショットが開始された時間のみを表示します。 ``` aws ec2 describe-snapshots \ --owner-ids self \ --filters Name=status,Values=pending \ --query "Snapshots[*].{ID:SnapshotId,Time:StartTime}" ``` 出力: ``` [ { "ID": "snap-1234567890abcdef0", "Time": "2019-08-04T12:48:18.000Z" }, { "ID": "snap-066877671789bd71b", "Time": "2019-08-04T02:45:16.000Z }, ... ] ``` 次の `describe-snapshots` の例では、フィルターを使用して、指定したボリュームから作成されたスナップショットに結果を絞っています。この例では、`--query` パラメータを使用してスナップショット ID のみを表示します。 ``` aws ec2 describe-snapshots \ --filters Name=volume-id,Values=049df61146c4d7901 \ --query "Snapshots[*].[SnapshotId]" \ --output text ``` 出力: ``` snap-1234567890abcdef0 snap-08637175a712c3fb9 ... ``` フィルターを使用するその他の例については、「*Amazon EC2 ユーザーガイド*」の「[リソースの一覧表示とフィルタリングの方法](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Filtering.html#Filtering_Resources_CLI)」を参照してください。 **例 3: タグに基づいてスナップショットを説明するには** 次の `describe-snapshots` の例では、タグフィルターを使用して、結果の範囲をタグ `Stack=Prod` を含むスナップショットに限定しています。 ``` aws ec2 describe-snapshots \ --filters Name=tag:Stack,Values=prod ``` `describe-snapshots` の出力例については、例 1 を参照してください。 タグフィルターを使用するその他の例については、「*Amazon EC2 ユーザーガイド*」の「[タグの使用方法](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#Using_Tags_CLI)」を参照してください。 **例 4: 日付に基づいてスナップショットを説明するには** 次の `describe-snapshots` の例では、JMESPath 式を使用して、指定した日付より前に AWS アカウントによって作成されたすべてのスナップショットを説明します。スナップショット ID のみが表示されます。 ``` aws ec2 describe-snapshots \ --owner-ids 012345678910 \ --query "Snapshots[?(StartTime<='2020-03-31')].[SnapshotId]" ``` フィルターを使用するその他の例については、「*Amazon EC2 ユーザーガイド*」の「[リソースの一覧表示とフィルタリングの方法](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Filtering.html#Filtering_Resources_CLI)」を参照してください。 **例 5: アーカイブされたスナップショットのみを表示するには** 次の `describe-snapshots` の例では、アーカイブ階層に保存されたスナップショットのみを説明しています。 ``` aws ec2 describe-snapshots \ --filters "Name=storage-tier,Values=archive" ``` 出力: ``` { "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": [] }, ] } ``` 詳細については、「*Amazon Elastic Compute Cloud ユーザーガイド*」の「[アーカイブされたスナップショットを表示する](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/working-with-snapshot-archiving.html#view-archived-snapshot)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-snapshots.html)」を参照してください。 ### `describe-spot-datafeed-subscription` 次のコード例は、`describe-spot-datafeed-subscription` を使用する方法を示しています。 **AWS CLI** **アカウントのスポットインスタンスデータフィードサブスクリプションを記述するには** このコマンド例では、アカウントのデータフィードを記述します。 コマンド: ``` aws ec2 describe-spot-datafeed-subscription ``` 出力: ``` { "SpotDatafeedSubscription": { "OwnerId": "123456789012", "Prefix": "spotdata", "Bucket": "amzn-s3-demo-bucket", "State": "Active" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeSpotDatafeedSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-spot-datafeed-subscription.html)」を参照してください。 ### `describe-spot-fleet-instances` 次のコード例は、`describe-spot-fleet-instances` を使用する方法を示しています。 **AWS CLI** **スポットフリートに関連付けられたスポットインスタンスを記述するには** このコマンド例では、指定されたスポットフリートに関連付けられたスポットインスタンスを一覧表示します。 コマンド: ``` aws ec2 describe-spot-fleet-instances --spot-fleet-request-id sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE ``` 出力: ``` { "ActiveInstances": [ { "InstanceId": "i-1234567890abcdef0", "InstanceType": "m3.medium", "SpotInstanceRequestId": "sir-08b93456" }, ... ], "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeSpotFleetInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-spot-fleet-instances.html)」を参照してください。 ### `describe-spot-fleet-request-history` 次のコード例は、`describe-spot-fleet-request-history` を使用する方法を示しています。 **AWS CLI** **スポットフリートの履歴を記述するには** このコマンド例では、指定された時刻から始まる、指定されたスポットフリートの履歴を返します。 コマンド: ``` aws ec2 describe-spot-fleet-request-history --spot-fleet-request-id sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE --start-time 2015-05-26T00:00:00Z ``` 次の出力例は、スポットフリートの 2 つのスポットインスタンスの正常な起動を示しています。 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeSpotFleetRequestHistory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-spot-fleet-request-history.html)」を参照してください。 ### `describe-spot-fleet-requests` 次のコード例は、`describe-spot-fleet-requests` を使用する方法を示しています。 **AWS CLI** **スポットフリートリクエストを記述するには** この例では、すべてのスポットフリートリクエストを記述します。 コマンド: ``` aws ec2 describe-spot-fleet-requests ``` 出力: ``` { "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" } ] } ``` **スポットフリートリクエストを記述するには** この例では、指定されたスポットフリートリクエストを記述します。 コマンド: ``` aws ec2 describe-spot-fleet-requests --spot-fleet-request-ids sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeSpotFleetRequests](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-spot-fleet-requests.html)」を参照してください。 ### `describe-spot-instance-requests` 次のコード例は、`describe-spot-instance-requests` を使用する方法を示しています。 **AWS CLI** **例 1: スポットインスタンスリクエストを記述するには** 次の `describe-spot-instance-requests` の例では、指定したスポットインスタンスについて説明します。 ``` aws ec2 describe-spot-instance-requests \ --spot-instance-request-ids sir-08b93456 ``` 出力: ``` { "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" } ] } ``` **例 2: フィルターに基づいてスポットインスタンスリクエストを記述するには** 次の `describe-spot-instance-requests` の例では、フィルターを使用して、指定したアベイラビリティーゾーンにある指定したインスタントタイプを持つスポットインスタンスリクエストに結果の範囲を絞り込みます。この例では、`--query` パラメータを使用してインスタンス ID のみを表示します。 ``` 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 ``` 出力: ``` i-057750d42936e468a i-001efd250faaa6ffa i-027552a73f021f3bd ... ``` フィルターの使用の詳細については、「*Amazon Elastic Compute Cloud ユーザーガイド*」の「[Listing and filtering your resources](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Filtering.html#Filtering_Resources_CLI)」を参照してください。 **例 3: タグに基づいてスポットインスタンスリクエストを記述するには** 次の `describe-spot-instance-requests` の例では、タグフィルターを使用して、タグ `cost-center=cc123` を含むスポットインスタンスリクエストに結果の範囲を絞り込みます。 ``` aws ec2 describe-spot-instance-requests \ --filters Name=tag:cost-center,Values=cc123 ``` `describe-spot-instance-requests` の出力例については、例 1 を参照してください。 タグフィルターを使用するその他の例については、「*Amazon EC2 ユーザーガイド*」の「[タグの使用方法](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#Using_Tags_CLI)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeSpotInstanceRequests](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-spot-instance-requests.html)」を参照してください。 ### `describe-spot-price-history` 次のコード例は、`describe-spot-price-history` を使用する方法を示しています。 **AWS CLI** **スポット料金履歴を記述するには** このコマンド例では、1 月の特定の日について m1.xlarge インスタンスのスポット料金履歴を返します。 コマンド: ``` aws ec2 describe-spot-price-history --instance-types m1.xlarge --start-time 2014-01-06T07:08:09 --end-time 2014-01-06T08:09:10 ``` 出力: ``` { "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" }, ... } ``` **Linux/UNIX Amazon VPC のスポット料金履歴を記述するには** このコマンド例では、1 月の特定の日について m1.xlarge Linux/UNIX Amazon VPC インスタンスのスポット料金履歴を返します。 コマンド: ``` 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 ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeSpotPriceHistory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-spot-price-history.html)」を参照してください。 ### `describe-stale-security-groups` 次のコード例は、`describe-stale-security-groups` を使用する方法を示しています。 **AWS CLI** **古いセキュリティグループを記述するには** この例では、`vpc-11223344` の古いセキュリティグループのルールを記述します。応答は、アカウントの sg-5fa68d3a にピア VPC の `sg-279ab042` を参照する古い入力 SSH ルールがあること、ならびにアカウントの `sg-fe6fba9a` にピア VPC の `sg-ef6fba8b` を参照する古い出力 SSH ルールがあることを示します。 コマンド: ``` aws ec2 describe-stale-security-groups --vpc-id vpc-11223344 ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeStaleSecurityGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-stale-security-groups.html)」を参照してください。 ### `describe-store-image-tasks` 次のコード例は、`describe-store-image-tasks` を使用する方法を示しています。 **AWS CLI** **AMI 保存タスクの進行状況を記述するには** 次の `describe-store-image-tasks` の例では、AMI ストアタスクの進行状況について説明します。 ``` aws ec2 describe-store-image-tasks ``` 出力: ``` { "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" } ] } ``` S3 を使用した AMI の保存と復元の詳細については、「*Amazon EC2 ユーザーガイド*」の「S3 を使用して AMI を保存および復元する 」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeStoreImageTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-store-image-tasks.html)」を参照してください。 ### `describe-subnets` 次のコード例は、`describe-subnets` を使用する方法を示しています。 **AWS CLI** **例 1: すべてのサブネットを説明するには** 次の `describe-subnets` の例では、サブネットの詳細を示します。 ``` aws ec2 describe-subnets ``` 出力: ``` { "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 } } ] } ``` 詳細については、「*AWS VPC ユーザーガイド*」で [VPC とサブネットの使用方法](https://docs.aws.amazon.com/vpc/latest/userguide/working-with-vpcs.html)を参照してください。 **例 2: 特定の VPC のサブネットを説明するには** 次の `describe-subnets` 例では、フィルターを使用して、指定した VPC のサブネットに関する詳細を取得します。 ``` aws ec2 describe-subnets \ --filters "Name=vpc-id,Values=vpc-3EXAMPLE" ``` 出力: ``` { "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 } } ] } ``` 詳細については、「*AWS VPC ユーザーガイド*」で [VPC とサブネットの使用方法](https://docs.aws.amazon.com/vpc/latest/userguide/working-with-vpcs.html)を参照してください。 **例 3: 特定のタグを持つサブネットを説明するには** 次の `describe-subnets` の例では、フィルターを使用してタグ `CostCenter=123` 付きのサブネットの詳細を取得し、`--query` パラメータを使用してこのタグが付いたサブネットのサブネット ID を表示します。 ``` aws ec2 describe-subnets \ --filters "Name=tag:CostCenter,Values=123" \ --query "Subnets[*].SubnetId" \ --output text ``` 出力: ``` subnet-0987a87c8b37348ef subnet-02a95061c45f372ee subnet-03f720e7de2788d73 ``` 詳細については、「*Amazon VPC ユーザーガイド*」で [VPC とサブネットの使用方法](https://docs.aws.amazon.com/vpc/latest/userguide/working-with-vpcs.html)を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeSubnets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-subnets.html)」を参照してください。 ### `describe-tags` 次のコード例は、`describe-tags` を使用する方法を示しています。 **AWS CLI** **例 1: 1 つのリソースのタグをすべて記述するには** 次の `describe-tags` の例では、指定したインスタンスのタグについて説明します。 ``` aws ec2 describe-tags \ --filters "Name=resource-id,Values=i-1234567890abcdef8" ``` 出力: ``` { "Tags": [ { "ResourceType": "instance", "ResourceId": "i-1234567890abcdef8", "Value": "Test", "Key": "Stack" }, { "ResourceType": "instance", "ResourceId": "i-1234567890abcdef8", "Value": "Beta Server", "Key": "Name" } ] } ``` **例 2: リソースタイプのタグをすべて記述するには** 次の `describe-tags` の例では、ボリュームのタグについて説明します。 ``` aws ec2 describe-tags \ --filters "Name=resource-type,Values=volume" ``` 出力: ``` { "Tags": [ { "ResourceType": "volume", "ResourceId": "vol-1234567890abcdef0", "Value": "Project1", "Key": "Purpose" }, { "ResourceType": "volume", "ResourceId": "vol-049df61146c4d7901", "Value": "Logs", "Key": "Purpose" } ] } ``` **例 3: タグをすべて記述するには** 次の `describe-tags` の例では、リソースのタグについて説明します。 ``` aws ec2 describe-tags ``` **例 4: タグキーに基づいてリソースのタグを記述するには** 次の `describe-tags` の例では、キー `Stack` を持つタグのあるリソースのタグについて説明します。 ``` aws ec2 describe-tags \ --filters Name=key,Values=Stack ``` 出力: ``` { "Tags": [ { "ResourceType": "volume", "ResourceId": "vol-027552a73f021f3b", "Value": "Production", "Key": "Stack" }, { "ResourceType": "instance", "ResourceId": "i-1234567890abcdef8", "Value": "Test", "Key": "Stack" } ] } ``` **例 5: タグキーとタグ値に基づいてリソースのタグを記述するには** 次の `describe-tags` の例では、タグ `Stack=Test` のあるリソースのタグについて説明します。 ``` aws ec2 describe-tags \ --filters Name=key,Values=Stack Name=value,Values=Test ``` 出力: ``` { "Tags": [ { "ResourceType": "image", "ResourceId": "ami-3ac336533f021f3bd", "Value": "Test", "Key": "Stack" }, { "ResourceType": "instance", "ResourceId": "i-1234567890abcdef8", "Value": "Test", "Key": "Stack" } ] } ``` 次の `describe-tags` の例では、代替構文を使用して、タグ `Stack=Test` を持つリソースについて説明します。 ``` aws ec2 describe-tags \ --filters "Name=tag:Stack,Values=Test" ``` 次の `describe-tags` の例では、キー `Purpose` を持つものの値を持っていないタグのある、すべてのインスタンスのタグについて説明します。 ``` aws ec2 describe-tags \ --filters "Name=resource-type,Values=instance" "Name=key,Values=Purpose" "Name=value,Values=" ``` 出力: ``` { "Tags": [ { "ResourceType": "instance", "ResourceId": "i-1234567890abcdef5", "Value": null, "Key": "Purpose" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-tags.html)」を参照してください。 ### `describe-traffic-mirror-filters` 次のコード例は、`describe-traffic-mirror-filters` を使用する方法を示しています。 **AWS CLI** **トラフィックミラーフィルターを表示するには** 次の `describe-traffic-mirror-filters` の例では、すべてのトラフィックミラーフィルターについて説明します。 ``` aws ec2 describe-traffic-mirror-filters ``` 出力: ``` { "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": [] } ] } ``` 詳細については、「* トラフィックミラーリングガイド*」の「[View your traffic mirror filters](https://docs.aws.amazon.com/vpc/latest/mirroring/traffic-mirroring-filter.html#view-traffic-mirroring-filter)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTrafficMirrorFilters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-traffic-mirror-filters.html)」を参照してください。 ### `describe-traffic-mirror-sessions` 次のコード例は、`describe-traffic-mirror-sessions` を使用する方法を示しています。 **AWS CLI** **トラフィックミラーセッションを記述するには** 次の `describe-traffic-mirror-sessions` の例では、トラフィックミラーセッションの詳細について説明します。 ``` aws ec2 describe-traffic-mirror-sessions ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS トラフィックミラーリングガイド*」の「[View Traffic Mirror Session Details](https://docs.aws.amazon.com/vpc/latest/mirroring/traffic-mirroring-session.html#view-traffic-mirroring-session)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTrafficMirrorSessions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-traffic-mirror-sessions.html)」を参照してください。 ### `describe-traffic-mirror-targets` 次のコード例は、`describe-traffic-mirror-targets` を使用する方法を示しています。 **AWS CLI** **トラフィックミラーターゲットを記述するには** 次の `describe-traffic-mirror-targets` の例では、指定したトラフィックミラーターゲットの情報を表示します。 ``` aws ec2 describe-traffic-mirror-targets \ --traffic-mirror-target-ids tmt-0dabe9b0a6EXAMPLE ``` 出力: ``` { "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": [] } ] } ``` 詳細については、「*Amazon VPC トラフィックミラーリングガイド*」の「[Traffic mirror targets](https://docs.aws.amazon.com/vpc/latest/mirroring/traffic-mirroring-target.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTrafficMirrorTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-traffic-mirror-targets.html)」を参照してください。 ### `describe-transit-gateway-attachments` 次のコード例は、`describe-transit-gateway-attachments` を使用する方法を示しています。 **AWS CLI** **Transit Gateway アタッチメントを表示するには** 次の `describe-transit-gateway-attachments` の例では、Transit Gateway アタッチメントの詳細を表示します。 ``` aws ec2 describe-transit-gateway-attachments ``` 出力: ``` { "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": [] } ] } ``` 詳細については、「*Transit Gateways ガイド*」の「[Work with transit gateways](https://docs.aws.amazon.com/vpc/latest/tgw/working-with-transit-gateways.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTransitGatewayAttachments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-transit-gateway-attachments.html)」を参照してください。 ### `describe-transit-gateway-connect-peers` 次のコード例は、`describe-transit-gateway-connect-peers` を使用する方法を示しています。 **AWS CLI** **Transit Gateway Connect ピアを記述するには** 次の `describe-transit-gateway-connect-peers` の例では、指定した Connect ピアについて説明します。 ``` aws ec2 describe-transit-gateway-connect-peers \ --transit-gateway-connect-peer-ids tgw-connect-peer-0666adbac4EXAMPLE ``` 出力: ``` { "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": [] } ] } ``` 詳細については、「*Transit Gateways ガイド*」の「[Transit gateway Connect attachments and Transit Gateway Connect peers](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTransitGatewayConnectPeers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-transit-gateway-connect-peers.html)」を参照してください。 ### `describe-transit-gateway-connects` 次のコード例は、`describe-transit-gateway-connects` を使用する方法を示しています。 **AWS CLI** **Transit Gateway Connect アタッチメントを記述するには** 次の `describe-transit-gateway-connects` の例では、指定した Connect アタッチメントについて説明します。 ``` aws ec2 describe-transit-gateway-connects \ --transit-gateway-attachment-ids tgw-attach-037012e5dcEXAMPLE ``` 出力: ``` { "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": [] } ] } ``` 詳細については、「*Transit Gateways ガイド*」の「[Transit gateway Connect attachments and Transit Gateway Connect peers](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTransitGatewayConnects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-transit-gateway-connects.html)」を参照してください。 ### `describe-transit-gateway-multicast-domains` 次のコード例は、`describe-transit-gateway-multicast-domains` を使用する方法を示しています。 **AWS CLI** **Transit Gateway マルチキャストドメインを記述するには** 次の `describe-transit-gateway-multicast-domains` の例では、すべての Transit Gateway マルチキャストドメインの詳細を表示します。 ``` aws ec2 describe-transit-gateway-multicast-domains ``` 出力: ``` { "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" } ] } ] } ``` 詳細については、「*Transit Gateways ガイド*」の「[Managing multicast domains](https://docs.aws.amazon.com/vpc/latest/tgw/manage-domain.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTransitGatewayMulticastDomains](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-transit-gateway-multicast-domains.html)」を参照してください。 ### `describe-transit-gateway-peering-attachments` 次のコード例は、`describe-transit-gateway-peering-attachments` を使用する方法を示しています。 **AWS CLI** **Transit Gateway ピアリングアタッチメントを記述するには** 次の `describe-transit-gateway-peering-attachments` の例では、すべての Transit Gateway ピアリングアタッチメントの詳細を表示します。 ``` aws ec2 describe-transit-gateway-peering-attachments ``` 出力: ``` { "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": [] } ] } ``` 詳細については、「*Transit Gateways ガイド*」の「[Transit Gateway Peering Attachments](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-peering.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTransitGatewayPeeringAttachments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-transit-gateway-peering-attachments.html)」を参照してください。 ### `describe-transit-gateway-policy-tables` 次のコード例は、`describe-transit-gateway-policy-tables` を使用する方法を示しています。 **AWS CLI** **Transit Gateway ポリシーテーブルを記述するには** 次の `describe-transit-gateway-policy-tables` の例では、指定した Transit Gateway ポリシーテーブルについて説明します。 ``` aws ec2 describe-transit-gateway-policy-tables \ --transit-gateway-policy-table-ids tgw-ptb-0a16f134b78668a81 ``` 出力: ``` { "TransitGatewayPolicyTables": [ { "TransitGatewayPolicyTableId": "tgw-ptb-0a16f134b78668a81", "TransitGatewayId": "tgw-067f8505c18f0bd6e", "State": "available", "CreationTime": "2023-11-28T16:36:43+00:00", "Tags": [] } ] } ``` 詳細については、「*Transit Gateway ユーザーガイド*」の「[Transit gateway policy tables](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-policy-tables.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTransitGatewayPolicyTables](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-transit-gateway-policy-tables.html)」を参照してください。 ### `describe-transit-gateway-route-tables` 次のコード例は、`describe-transit-gateway-route-tables` を使用する方法を示しています。 **AWS CLI** **Transit Gateway ルートテーブルを記述するには** 次の `describe-transit-gateway-route-tables` の例では、Transit Gateway ルートテーブルの詳細を表示します。 ``` aws ec2 describe-transit-gateway-route-tables ``` 出力: ``` { "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": [] } ] } ``` 詳細については、「*Transit Gateways ガイド*」の「[View transit gateway route tables](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html#view-tgw-route-tables)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTransitGatewayRouteTables](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-transit-gateway-route-tables.html)」を参照してください。 ### `describe-transit-gateway-vpc-attachments` 次のコード例は、`describe-transit-gateway-vpc-attachments` を使用する方法を示しています。 **AWS CLI** **Transit Gateway VPC アタッチメントを記述するには** 次の `describe-transit-gateway-vpc-attachments` の例では、Transit Gateway VPC アタッチメントの詳細を表示します。 ``` aws ec2 describe-transit-gateway-vpc-attachments ``` 出力: ``` { "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" } ] } ] } ``` 詳細については、「*Transit Gateways ガイド*」の「[View your VPC attachments](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-vpc-attachments.html#view-vpc-attachment)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTransitGatewayVpcAttachments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-transit-gateway-vpc-attachments.html)」を参照してください。 ### `describe-transit-gateways` 次のコード例は、`describe-transit-gateways` を使用する方法を示しています。 **AWS CLI** **Transit Gateway を記述するには** 次の `describe-transit-gateways` の例では、Transit Gateway の詳細を取得します。 ``` aws ec2 describe-transit-gateways ``` 出力: ``` { "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" } ] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTransitGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-transit-gateways.html)」を参照してください。 ### `describe-verified-access-endpoints` 次のコード例は、`describe-verified-access-endpoints` を使用する方法を示しています。 **AWS CLI** **Verified Access エンドポイントを記述するには** 次の `describe-verified-access-endpoints` の例では、指定した Verified Access エンドポイントについて説明します。 ``` aws ec2 describe-verified-access-endpoints \ --verified-access-endpoint-ids vae-066fac616d4d546f2 ``` 出力: ``` { "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" } ] } ] } ``` 詳細については、「*AWSVerified Access ユーザーガイド*」の「[Verified Access endpoints](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-endpoints.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeVerifiedAccessEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-verified-access-endpoints.html)」を参照してください。 ### `describe-verified-access-groups` 次のコード例は、`describe-verified-access-groups` を使用する方法を示しています。 **AWS CLI** **Verified Access グループを記述するには** 次の `describe-verified-access-groups` の例では、指定した Verified Access グループについて説明します。 ``` aws ec2 describe-verified-access-groups \ --verified-access-group-ids vagr-0dbe967baf14b7235 ``` 出力: ``` { "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" } ] } ] } ``` 詳細については、「*AWSVerified Access ユーザーガイド*」の「[Verified Access groups](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeVerifiedAccessGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-verified-access-groups.html)」を参照してください。 ### `describe-verified-access-instance-logging-configurations` 次のコード例は、`describe-verified-access-instance-logging-configurations` を使用する方法を示しています。 **AWS CLI** **Verified Access インスタンスに関するログ設定を記述するには** 次の `describe-verified-access-instance-logging-configurations` の例では、指定した Verified Access インスタンスのログ記録設定について説明します。 ``` aws ec2 describe-verified-access-instance-logging-configurations \ --verified-access-instance-ids vai-0ce000c0b7643abea ``` 出力: ``` { "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 } } ] } ``` 詳細については、「*AWSVerified Access ユーザーガイド*」の「[Verified Access logs](https://docs.aws.amazon.com/verified-access/latest/ug/access-logs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeVerifiedAccessInstanceLoggingConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-verified-access-instance-logging-configurations.html)」を参照してください。 ### `describe-verified-access-instances` 次のコード例は、`describe-verified-access-instances` を使用する方法を示しています。 **AWS CLI** **Verified Access インスタンスを記述するには** 次の `describe-verified-access-instances` の例では、指定した Verified Access インスタンスについて説明します。 ``` aws ec2 describe-verified-access-instances \ --verified-access-instance-ids vai-0ce000c0b7643abea ``` 出力: ``` { "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" } ] } ] } ``` 詳細については、「*AWSVerified Access ユーザーガイド*」の「[Access インスタンス](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-instances.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeVerifiedAccessInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-verified-access-instances.html)」を参照してください。 ### `describe-verified-access-trust-providers` 次のコード例は、`describe-verified-access-trust-providers` を使用する方法を示しています。 **AWS CLI** **Verified Access 信頼プロバイダーを記述するには** 次の `describe-verified-access-trust-providers` の例では、指定した Verified Access 信頼プロバイダーについて説明します。 ``` aws ec2 describe-verified-access-trust-providers \ --verified-access-trust-provider-ids vatp-0bb32de759a3e19e7 ``` 出力: ``` { "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" } ] } ] } ``` 詳細については、「*AWSVerified Access ユーザーガイド*」の「[Trust providers for Verified Access](https://docs.aws.amazon.com/verified-access/latest/ug/trust-providers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeVerifiedAccessTrustProviders](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-verified-access-trust-providers.html)」を参照してください。 ### `describe-volume-attribute` 次のコード例は、`describe-volume-attribute` を使用する方法を示しています。 **AWS CLI** **ボリューム属性を記述するには** このコマンド例では、ID `vol-049df61146c4d7901` を持つボリュームの `autoEnableIo` 属性を記述します。 コマンド: ``` aws ec2 describe-volume-attribute --volume-id vol-049df61146c4d7901 --attribute autoEnableIO ``` 出力: ``` { "AutoEnableIO": { "Value": false }, "VolumeId": "vol-049df61146c4d7901" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeVolumeAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-volume-attribute.html)」を参照してください。 ### `describe-volume-status` 次のコード例は、`describe-volume-status` を使用する方法を示しています。 **AWS CLI** **単一ボリュームのステータスを記述するには** このコマンド例では、ボリューム `vol-1234567890abcdef0` のステータスを記述します。 コマンド: ``` aws ec2 describe-volume-status --volume-ids vol-1234567890abcdef0 ``` 出力: ``` { "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": [] } ] } ``` **障害のあるボリュームのステータスを記述するには** このコマンド例では、障害のあるすべてのボリュームのステータスを記述します。この例では、障害のあるボリュームはありません。 コマンド: ``` aws ec2 describe-volume-status --filters Name=volume-status.status,Values=impaired ``` 出力: ``` { "VolumeStatuses": [] } ``` ステータスチェックに失敗したボリュームがある場合 (ステータスに障害がある場合)、「*Amazon EC2 ユーザーガイド*」の「Working with an Impaired Volume」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeVolumeStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-volume-status.html)」を参照してください。 ### `describe-volumes-modifications` 次のコード例は、`describe-volumes-modifications` を使用する方法を示しています。 **AWS CLI** **ボリュームの変更ステータスを記述するには** 次の `describe-volumes-modifications` の例では、指定したボリュームのボリューム変更ステータスについて説明します。 ``` aws ec2 describe-volumes-modifications \ --volume-ids vol-1234567890abcdef0 ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeVolumesModifications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-volumes-modifications.html)」を参照してください。 ### `describe-volumes` 次のコード例は、`describe-volumes` を使用する方法を示しています。 **AWS CLI** **例 1: ボリュームを記述するには** 次の `describe-volumes` の例では、現在のリージョンで指定したボリュームについて説明します。 ``` aws ec2 describe-volumes \ --volume-ids vol-049df61146c4d7901 vol-1234567890abcdef0 ``` 出力: ``` { "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 } ] } ``` **例 2: 特定のインスタンスにアタッチされているボリュームを記述するには** 次の `describe-volumes` の例では、指定したインスタンスにアタッチされているものと、インスタンスの終了時に削除するように設定されているものの両方に該当するすべてのボリュームについて説明します。 ``` aws ec2 describe-volumes \ --region us-east-1 \ --filters Name=attachment.instance-id,Values=i-1234567890abcdef0 Name=attachment.delete-on-termination,Values=true ``` `describe-volumes` の出力例については、例 1 を参照してください。 **例 3: 特定のアベイラビリティーゾーンで使用可能なボリュームを記述するには** 次の `describe-volumes` の例では、ステータスが `available` であり、指定したアベイラビリティーゾーンにあるすべてのボリュームについて説明します。 ``` aws ec2 describe-volumes \ --filters Name=status,Values=available Name=availability-zone,Values=us-east-1a ``` `describe-volumes` の出力例については、例 1 を参照してください。 **例 4: タグに基づいてボリュームを記述するには** 次の `describe-volumes` の例では、タグキー `Name` を持ち、`Test` で始まる値を持つすべてのボリュームについて説明します。その後、出力は、ボリュームのタグと ID のみを表示するクエリでフィルタリングされます。 ``` aws ec2 describe-volumes \ --filters Name=tag:Name,Values=Test* \ --query "Volumes[*].{ID:VolumeId,Tag:Tags}" ``` 出力: ``` [ { "Tag": [ { "Value": "Test2", "Key": "Name" } ], "ID": "vol-1234567890abcdef0" }, { "Tag": [ { "Value": "Test1", "Key": "Name" } ], "ID": "vol-049df61146c4d7901" } ] ``` タグフィルターを使用するその他の例については、「*Amazon EC2 ユーザーガイド*」の「[タグの使用方法](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#Using_Tags_CLI)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeVolumes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-volumes.html)」を参照してください。 ### `describe-vpc-attribute` 次のコード例は、`describe-vpc-attribute` を使用する方法を示しています。 **AWS CLI** **enableDnsSupport 属性を記述するには** この例では、`enableDnsSupport` 属性を記述します。この属性は、VPC に対して DNS 解決が有効になっているかどうかを示します。この属性が `true` の場合、Amazon DNS サーバーはインスタンスの DNS ホスト名を対応する IP アドレスに解決します。それ以外の場合は解決しません。 コマンド: ``` aws ec2 describe-vpc-attribute --vpc-id vpc-a01106c2 --attribute enableDnsSupport ``` 出力: ``` { "VpcId": "vpc-a01106c2", "EnableDnsSupport": { "Value": true } } ``` **enableDnsHostnames 属性を記述するには** この例では、`enableDnsHostnames` 属性を記述します。この属性は、VPC 内に起動されるインスタンスが DNS ホスト名を取得するかどうかを示します。この属性が `true` の場合、VPC 内のインスタンスは DNS ホスト名を取得します。それ以外の場合は取得しません。 コマンド: ``` aws ec2 describe-vpc-attribute --vpc-id vpc-a01106c2 --attribute enableDnsHostnames ``` 出力: ``` { "VpcId": "vpc-a01106c2", "EnableDnsHostnames": { "Value": true } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeVpcAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpc-attribute.html)」を参照してください。 ### `describe-vpc-classic-link-dns-support` 次のコード例は、`describe-vpc-classic-link-dns-support` を使用する方法を示しています。 **AWS CLI** **VPC の ClassicLink DNS サポートを記述するには** この例では、すべての VPC の ClassicLink DNS サポートステータスを記述します。 コマンド: ``` aws ec2 describe-vpc-classic-link-dns-support ``` 出力: ``` { "Vpcs": [ { "VpcId": "vpc-88888888", "ClassicLinkDnsSupported": true }, { "VpcId": "vpc-1a2b3c4d", "ClassicLinkDnsSupported": false } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeVpcClassicLinkDnsSupport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpc-classic-link-dns-support.html)」を参照してください。 ### `describe-vpc-classic-link` 次のコード例は、`describe-vpc-classic-link` を使用する方法を示しています。 **AWS CLI** **VPC の ClassicLink ステータスを記述するには** この例では、vpc-88888888 の ClassicLink ステータスを一覧表示します。 コマンド: ``` aws ec2 describe-vpc-classic-link --vpc-id vpc-88888888 ``` 出力: ``` { "Vpcs": [ { "ClassicLinkEnabled": true, "VpcId": "vpc-88888888", "Tags": [ { "Value": "classiclinkvpc", "Key": "Name" } ] } ] } ``` この例では、Classiclink で有効になっている VPCs のみを一覧表示します (`is-classic-link-enabled` のフィルター値は `true` に設定されています)。 コマンド: ``` aws ec2 describe-vpc-classic-link --filter "Name=is-classic-link-enabled,Values=true" ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeVpcClassicLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpc-classic-link.html)」を参照してください。 ### `describe-vpc-endpoint-associations` 次のコード例は、`describe-vpc-endpoint-associations` を使用する方法を示しています。 **AWS CLI** **VPC エンドポイントの関連付けを記述するには** 次の `describe-vpc-endpoint-associations` の例では、VPC エンドポイントの関連付けを記述します。 ``` aws ec2 describe-vpc-endpoint-associations ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS PrivateLink ユーザーガイド*」の「[VPC エンドポイントの関連付けを管理する](https://docs.aws.amazon.com/vpc/latest/privatelink/resource-configuration-associations.html#resource-config-manage-ep-association)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeVpcEndpointAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpc-endpoint-associations.html)」を参照してください。 ### `describe-vpc-endpoint-connection-notifications` 次のコード例は、`describe-vpc-endpoint-connection-notifications` を使用する方法を示しています。 **AWS CLI** **エンドポイント接続通知を記述するには** 次の `describe-vpc-endpoint-connection-notifications` の例では、すべてのエンドポイント接続通知について説明します。 ``` aws ec2 describe-vpc-endpoint-connection-notifications ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeVpcEndpointConnectionNotifications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpc-endpoint-connection-notifications.html)」を参照してください。 ### `describe-vpc-endpoint-connections` 次のコード例は、`describe-vpc-endpoint-connections` を使用する方法を示しています。 **AWS CLI** **VPC エンドポイント接続を記述するには** この例では、エンドポイントサービスへのインターフェイスエンドポイント接続を記述し、結果をフィルタリングして `PendingAcceptance` であるエンドポイントを表示します。 コマンド: ``` aws ec2 describe-vpc-endpoint-connections --filters Name=vpc-endpoint-state,Values=pendingAcceptance ``` 出力: ``` { "VpcEndpointConnections": [ { "VpcEndpointId": "vpce-0abed31004e618123", "ServiceId": "vpce-svc-0abced088d20def56", "CreationTimestamp": "2017-11-30T10:00:24.350Z", "VpcEndpointState": "pendingAcceptance", "VpcEndpointOwner": "123456789012" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeVpcEndpointConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpc-endpoint-connections.html)」を参照してください。 ### `describe-vpc-endpoint-service-configurations` 次のコード例は、`describe-vpc-endpoint-service-configurations` を使用する方法を示しています。 **AWS CLI** **エンドポイントサービス設定を記述するには** 次の `describe-vpc-endpoint-service-configurations` の例では、エンドポイントサービスの設定について説明します。 ``` aws ec2 describe-vpc-endpoint-service-configurations ``` 出力: ``` { "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": [] } ] } ``` 詳細については、*AWS PrivateLink ユーザーガイド*の「[概念](https://docs.aws.amazon.com/vpc/latest/privatelink/concepts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeVpcEndpointServiceConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpc-endpoint-service-configurations.html)」を参照してください。 ### `describe-vpc-endpoint-service-permissions` 次のコード例は、`describe-vpc-endpoint-service-permissions` を使用する方法を示しています。 **AWS CLI** **エンドポイントサービスのアクセス許可を記述するには** この例では、指定されたエンドポイントサービスのアクセス許可を記述します。 コマンド: ``` aws ec2 describe-vpc-endpoint-service-permissions --service-id vpce-svc-03d5ebb7d9579a2b3 ``` 出力: ``` { "AllowedPrincipals": [ { "PrincipalType": "Account", "Principal": "arn:aws:iam::123456789012:root" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeVpcEndpointServicePermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpc-endpoint-service-permissions.html)」を参照してください。 ### `describe-vpc-endpoint-services` 次のコード例は、`describe-vpc-endpoint-services` を使用する方法を示しています。 **AWS CLI** **例 1: すべての VPC エンドポイントサービスを記述するには** 次の `describe-vpc-endpoint-services` の例では、AWS リージョンのすべての VPC エンドポイントサービスを一覧表示します。 ``` aws ec2 describe-vpc-endpoint-services ``` 出力: ``` { "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" ] } ``` **例 2: エンドポイントサービスの詳細を記述するには** 次の `describe-vpc-endpoint-services` の例では、Amazon S3 インターフェイスエンドポイントサービスの詳細を一覧表示します。 ``` aws ec2 describe-vpc-endpoint-services \ --filter 'Name=service-type,Values=Interface' Name=service-name,Values=com.amazonaws.us-east-1.s3 ``` 出力: ``` { "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" ] } ``` 詳細については、*AWS PrivateLink ユーザーガイド*の「[利用可能な AWS サービス名を表示する](https://docs.aws.amazon.com/vpc/latest/privatelink/aws-services-privatelink-support.html#vpce-view-available-services)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeVpcEndpointServices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpc-endpoint-services.html)」を参照してください。 ### `describe-vpc-endpoints` 次のコード例は、`describe-vpc-endpoints` を使用する方法を示しています。 **AWS CLI** **VPC エンドポイントを記述するには** 次の `describe-vpc-endpoints` の例では、すべての VPC エンドポイントの詳細を表示します。 ``` aws ec2 describe-vpc-endpoints ``` 出力: ``` { "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" } ] } ``` 詳細については、*AWS PrivateLink ユーザーガイド*の「[概念](https://docs.aws.amazon.com/vpc/latest/privatelink/concepts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeVpcEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpc-endpoints.html)」を参照してください。 ### `describe-vpc-peering-connections` 次のコード例は、`describe-vpc-peering-connections` を使用する方法を示しています。 **AWS CLI** **VPC ピアリング接続を記述するには** この例では、すべての VPC ピアリング接続を記述します。 コマンド: ``` aws ec2 describe-vpc-peering-connections ``` 出力: ``` { "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" } } ] } ``` **特定の VPC ピアリング接続を記述するには** この例では、保留中の承諾の状態にあるすべての VPC ピアリング接続を記述します。 コマンド: ``` aws ec2 describe-vpc-peering-connections --filters Name=status-code,Values=pending-acceptance ``` この例では、「Owner=Finance」というタグを持つすべての VPC ピアリング接続を記述します。 コマンド: ``` aws ec2 describe-vpc-peering-connections --filters Name=tag:Owner,Values=Finance ``` この例では、指定された VPC、vpc-1a2b3c4d に対してリクエストしたすべての VPC ピアリング接続を記述します。 コマンド: ``` aws ec2 describe-vpc-peering-connections --filters Name=requester-vpc-info.vpc-id,Values=vpc-1a2b3c4d ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeVpcPeeringConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpc-peering-connections.html)」を参照してください。 ### `describe-vpcs` 次のコード例は、`describe-vpcs` を使用する方法を示しています。 **AWS CLI** **例 1: すべての VPC を説明するには** 次の `describe-vpcs` の例では、VPC に関する詳細を取得します。 ``` aws ec2 describe-vpcs ``` 出力: ``` { "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" } ] } ] } ``` **例 2: 指定した VPC を説明するには** 次の `describe-vpcs` 例では、指定した VPC に関する詳細を取得します。 ``` aws ec2 describe-vpcs \ --vpc-ids vpc-06e4ab6c6cEXAMPLE ``` 出力: ``` { "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" } ] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeVpcs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpcs.html)」を参照してください。 ### `describe-vpn-connections` 次のコード例は、`describe-vpn-connections` を使用する方法を示しています。 **AWS CLI** **例 1: VPN 接続を記述するには** 次の `describe-vpn-connections` の例では、すべての Site-to-Site VPN 接続について説明します。 ``` aws ec2 describe-vpn-connections ``` 出力: ``` { "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": "" } ] } ] } ``` 詳細については、「*AWS Site-to-Site VPN ユーザーガイド*」の「[How AWS Site-to-Site VPN works](https://docs.aws.amazon.com/vpn/latest/s2svpn/how_it_works.html)」を参照してください。 **例 2: 使用可能な VPN 接続を記述するには** 次の `describe-vpn-connections` の例では、状態が `available` である Site-to-Site VPN 接続について説明します。 ``` aws ec2 describe-vpn-connections \ --filters "Name=state,Values=available" ``` 詳細については、「*AWS Site-to-Site VPN ユーザーガイド*」の「[How AWS Site-to-Site VPN works](https://docs.aws.amazon.com/vpn/latest/s2svpn/how_it_works.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeVpnConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpn-connections.html)」を参照してください。 ### `describe-vpn-gateways` 次のコード例は、`describe-vpn-gateways` を使用する方法を示しています。 **AWS CLI** **仮想プライベートゲートウェイを記述するには** この例では、仮想プライベートゲートウェイを記述します。 コマンド: ``` aws ec2 describe-vpn-gateways ``` 出力: ``` { "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" } ] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeVpnGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-vpn-gateways.html)」を参照してください。 ### `detach-classic-link-vpc` 次のコード例は、`detach-classic-link-vpc` を使用する方法を示しています。 **AWS CLI** **VPC から EC2-Classic インスタンスのリンクを解除 (デタッチ) するには** この例では、VPC vpc-88888888 からインスタンス i-0598c7d356eba48d7 のリンクを解除します。 コマンド: ``` aws ec2 detach-classic-link-vpc --instance-id i-0598c7d356eba48d7 --vpc-id vpc-88888888 ``` 出力: ``` { "Return": true } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DetachClassicLinkVpc](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/detach-classic-link-vpc.html)」を参照してください。 ### `detach-internet-gateway` 次のコード例は、`detach-internet-gateway` を使用する方法を示しています。 **AWS CLI** **VPC からインターネットゲートウェイをデタッチするには** 次の `detach-internet-gateway` の例では、特定の VPC から指定したインターネットゲートウェイをデタッチします。 ``` aws ec2 detach-internet-gateway \ --internet-gateway-id igw-0d0fb496b3EXAMPLE \ --vpc-id vpc-0a60eb65b4EXAMPLE ``` このコマンドでは何も出力されません。 詳細については、*Amazon VPC ユーザーガイド*の「[インターネットゲートウェイ](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DetachInternetGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/detach-internet-gateway.html)」を参照してください。 ### `detach-network-interface` 次のコード例は、`detach-network-interface` を使用する方法を示しています。 **AWS CLI** **インスタンスからネットワークインターフェイスをデタッチするには** この例では、指定されたインスタンスから指定されたネットワークインターフェイスをデタッチします。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 detach-network-interface --attachment-id eni-attach-66c4350a ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DetachNetworkInterface](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/detach-network-interface.html)」を参照してください。 ### `detach-verified-access-trust-provider` 次のコード例は、`detach-verified-access-trust-provider` を使用する方法を示しています。 **AWS CLI** **インスタンスから信頼プロバイダーをデタッチするには** 次の `detach-verified-access-trust-provider` の例では、指定した Verified Access 信頼プロバイダーを指定した Verified Access インスタンスからデタッチします。 ``` aws ec2 detach-verified-access-trust-provider \ --verified-access-instance-id vai-0ce000c0b7643abea \ --verified-access-trust-provider-id vatp-0bb32de759a3e19e7 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWSVerified Access ユーザーガイド*」の「[Access インスタンス](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-instances.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DetachVerifiedAccessTrustProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/detach-verified-access-trust-provider.html)」を参照してください。 ### `detach-volume` 次のコード例は、`detach-volume` を使用する方法を示しています。 **AWS CLI** **インスタンスからボリュームをデタッチするには** このコマンド例では、ボリューム (`vol-049df61146c4d7901`) をアタッチされているインスタンスからデタッチします。 コマンド: ``` aws ec2 detach-volume --volume-id vol-1234567890abcdef0 ``` 出力: ``` { "AttachTime": "2014-02-27T19:23:06.000Z", "InstanceId": "i-1234567890abcdef0", "VolumeId": "vol-049df61146c4d7901", "State": "detaching", "Device": "/dev/sdb" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DetachVolume](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/detach-volume.html)」を参照してください。 ### `detach-vpn-gateway` 次のコード例は、`detach-vpn-gateway` を使用する方法を示しています。 **AWS CLI** **VPC から仮想プライベートゲートウェイをデタッチするには** この例では、指定された VPC から指定された仮想プライベートゲートウェイをデタッチします。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 detach-vpn-gateway --vpn-gateway-id vgw-9a4cacf3 --vpc-id vpc-a01106c2 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DetachVpnGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/detach-vpn-gateway.html)」を参照してください。 ### `disable-address-transfer` 次のコード例は、`disable-address-transfer` を使用する方法を示しています。 **AWS CLI** **Elastic IP アドレスの移行を無効にするには** 次の `disable-address-transfer` の例では、指定した Elastic IP アドレスの Elastic IP アドレス転送を無効にします。 ``` aws ec2 disable-address-transfer \ --allocation-id eipalloc-09ad461b0d03f6aaf ``` 出力: ``` { "AddressTransfer": { "PublicIp": "100.21.184.216", "AllocationId": "eipalloc-09ad461b0d03f6aaf", "AddressTransferStatus": "disabled" } } ``` 詳細については、「*Amazon VPC ユーザーガイド*」の「[Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/WorkWithEIPs.html#transfer-EIPs-intro)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisableAddressTransfer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-address-transfer.html)」を参照してください。 ### `disable-aws-network-performance-metric-subscription` 次のコード例は、`disable-aws-network-performance-metric-subscription` を使用する方法を示しています。 **AWS CLI** **メトリクスサブスクリプションを無効にするには** 次の `disable-aws-network-performance-metric-subscription` の例では、指定した転送元リージョンと転送先リージョン間のネットワークレイテンシーの集計のモニタリングを無効にします。 ``` aws ec2 disable-aws-network-performance-metric-subscription \ --source us-east-1 \ --destination eu-west-1 \ --metric aggregate-latency \ --statistic p50 ``` 出力: ``` { "Output": true } ``` 詳細については、*インフラストラクチャパフォーマンスユーザーガイド*の「[CLI を使用して CloudWatch サブスクリプションを管理する](https://docs.aws.amazon.com/network-manager/latest/infrastructure-performance/getting-started-nmip-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisableAwsNetworkPerformanceMetricSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-aws-network-performance-metric-subscription.html)」を参照してください。 ### `disable-ebs-encryption-by-default` 次のコード例は、`disable-ebs-encryption-by-default` を使用する方法を示しています。 **AWS CLI** **デフォルトで EBS 暗号化を無効にするには** 次の `disable-ebs-encryption-by-default` の例では、現在のリージョンの AWS アカウントに対して EBS 暗号化をデフォルトで無効にします。 ``` aws ec2 disable-ebs-encryption-by-default ``` 出力: ``` { "EbsEncryptionByDefault": false } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisableEbsEncryptionByDefault](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-ebs-encryption-by-default.html)」を参照してください。 ### `disable-fast-launch` 次のコード例は、`disable-fast-launch` を使用する方法を示しています。 **AWS CLI** **イメージの高速起動を中止するには** 次の `disable-fast-launch` の例では、指定した AMI での高速起動を中止し、事前プロビジョニングされたスナップショットをクリーンアップします。 ``` aws ec2 disable-fast-launch \ --image-id ami-01234567890abcedf ``` 出力: ``` { "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" } ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[Windows AMI に EC2 Fast Launch 設定を構成する](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/win-fast-launch-configure.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisableFastLaunch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-fast-launch.html)」を参照してください。 ### `disable-fast-snapshot-restores` 次のコード例は、`disable-fast-snapshot-restores` を使用する方法を示しています。 **AWS CLI** **高速スナップショット復元を無効にするには** 次の `disable-fast-snapshot-restores` の例では、指定したアベイラビリティーゾーン内の指定したスナップショットの高速スナップショット復元を無効にします。 ``` aws ec2 disable-fast-snapshot-restores \ --availability-zones us-east-2a \ --source-snapshot-ids snap-1234567890abcdef0 ``` 出力: ``` { "Successful": [ { "SnapshotId": "snap-1234567890abcdef0" "AvailabilityZone": "us-east-2a", "State": "disabling", "StateTransitionReason": "Client.UserInitiated", "OwnerId": "123456789012", "EnablingTime": "2020-01-25T23:57:49.602Z" } ], "Unsuccessful": [] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisableFastSnapshotRestores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-fast-snapshot-restores.html)」を参照してください。 ### `disable-image-block-public-access` 次のコード例は、`disable-image-block-public-access` を使用する方法を示しています。 **AWS CLI** **指定したリージョンで AMI のパブリックアクセスのブロックを無効にするには** 次の `disable-image-block-public-access` の例では、指定したリージョンからアカウントレベルの AMI のブロックパブリックアクセスを無効にします。 ``` aws ec2 disable-image-block-public-access \ --region us-east-1 ``` 出力: ``` { "ImageBlockPublicAccessState": "unblocked" } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[Block public access to your AMIs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-public-access-to-amis.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisableImageBlockPublicAccess](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-image-block-public-access.html)」を参照してください。 ### `disable-image-deprecation` 次のコード例は、`disable-image-deprecation` を使用する方法を示しています。 **AWS CLI** **AMI の非推奨をキャンセルするには** 次の `disable-image-deprecation` の例では、AMI の非推奨化をキャンセルします。これにより、`describe-images` 出力から `DeprecationTime` フィールドが削除されます。この手順を実行するには、AMI の所有者である必要があります。 ``` aws ec2 disable-image-deprecation \ --image-id ami-1234567890abcdef0 ``` 出力: ``` { "RequestID": "11aabb229-4eac-35bd-99ed-be587EXAMPLE", "Return": "true" } ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[AMI を非推奨にする](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-deprecate.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisableImageDeprecation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-image-deprecation.html)」を参照してください。 ### `disable-image-deregistration-protection` 次のコード例は、`disable-image-deregistration-protection` を使用する方法を示しています。 **AWS CLI** **登録解除保護を無効にするには** 次の `disable-image-deregistration-protection` の例では、指定されたイメージの登録解除保護を無効にします。 ``` aws ec2 disable-image-deregistration-protection \ --image-id ami-0b1a928a144a74ec9 ``` 出力: ``` { "Return": "disabled" } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[Amazon EC2 AMI を登録解除から保護する](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-deregistration-protection.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisableImageDeregistrationProtection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-image-deregistration-protection.html)」を参照してください。 ### `disable-image` 次のコード例は、`disable-image` を使用する方法を示しています。 **AWS CLI** **AMI を無効化するには** 次の `disable-image` の例では、指定した AMI を無効にします。 ``` aws ec2 disable-image \ --image-id ami-1234567890abcdef0 ``` 出力: ``` { "Return": "true" } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[AMI を無効にする](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/disable-an-ami.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisableImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-image.html)」を参照してください。 ### `disable-ipam-organization-admin-account` 次のコード例は、`disable-ipam-organization-admin-account` を使用する方法を示しています。 **AWS CLI** **委任された IPAM 管理者を無効にするには** 特定のシナリオでは、IPAM を AWS Organizations と統合します。これを行うと、AWS Organizations 管理アカウントは AWS Organizations メンバーアカウントを IPAM 管理者として委任します。 この例では、あなたは IPAM 管理者アカウントを委任した AWS Organizations 管理アカウントであり、そのアカウントを IPAM 管理者として無効にしたいと考えています。 このリクエストを行うときは、`--region` に任意の AWS リージョンを使用できます。最初に管理者を委任したリージョン、IPAM が作成されたリージョン、または IPAM 運用リージョンを使用する必要はありません。委任された管理者アカウントを無効にすると、いつでも再び有効にしたり、新しいアカウントを IPAM 管理者として委任したりすることができます。 次の `disable-ipam-organization-admin-account` の例では、AWS アカウントの委任された IPAM 管理者を無効にします。 ``` aws ec2 disable-ipam-organization-admin-account \ --delegated-admin-account-id 320805250157 \ --region ap-south-1 ``` 出力: ``` { "Success": true } ``` 詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[Integrate IPAM with accounts in an AWS Organization](https://docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisableIpamOrganizationAdminAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-ipam-organization-admin-account.html)」を参照してください。 ### `disable-serial-console-access` 次のコード例は、`disable-serial-console-access` を使用する方法を示しています。 **AWS CLI** **アカウントの EC2 シリアルコンソールへのアクセスを無効にするには** 次の `disable-serial-console-access` の例では、シリアルコンソールへのアカウントアクセスを無効にします。 ``` aws ec2 disable-serial-console-access ``` 出力: ``` { "SerialConsoleAccessEnabled": false } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[EC2 Serial Console](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-serial-console.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisableSerialConsoleAccess](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-serial-console-access.html)」を参照してください。 ### `disable-snapshot-block-public-access` 次のコード例は、`disable-snapshot-block-public-access` を使用する方法を示しています。 **AWS CLI** **スナップショットのブロックパブリックアクセスを無効にするには** 次の `disable-snapshot-block-public-access` の例では、スナップショットのブロックパブリックアクセスを無効にして、スナップショットのパブリック共有を許可します。 ``` aws ec2 disable-snapshot-block-public-access ``` 出力: ``` { "State": "unblocked" } ``` 詳細については、「*Amazon EBS ユーザーガイド*」の「[Block public access for snapshots](https://docs.aws.amazon.com/ebs/latest/userguide/block-public-access-snapshots.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisableSnapshotBlockPublicAccess](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-snapshot-block-public-access.html)」を参照してください。 ### `disable-transit-gateway-route-table-propagation` 次のコード例は、`disable-transit-gateway-route-table-propagation` を使用する方法を示しています。 **AWS CLI** **Transit Gateway アタッチメントを無効にして、指定された伝播ルートテーブルにルートを伝播するには** 次の `disable-transit-gateway-route-table-propagation` の例では、指定したアタッチメントが、指定した伝播ルートテーブルにルートを伝播することを無効にします。 ``` aws ec2 disable-transit-gateway-route-table-propagation \ --transit-gateway-route-table-id tgw-rtb-0a823edbdeEXAMPLE \ --transit-gateway-attachment-id tgw-attach-09b52ccdb5EXAMPLE ``` 出力: ``` { "Propagation": { "TransitGatewayAttachmentId": "tgw-attach-09b52ccdb5EXAMPLE", "ResourceId": "vpc-4d7de228", "ResourceType": "vpc", "TransitGatewayRouteTableId": "tgw-rtb-0a823edbdeEXAMPLE", "State": "disabled" } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Transit gateway route tables](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisableTransitGatewayRouteTablePropagation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-transit-gateway-route-table-propagation.html)」を参照してください。 ### `disable-vgw-route-propagation` 次のコード例は、`disable-vgw-route-propagation` を使用する方法を示しています。 **AWS CLI** **ルート伝播を無効にするには** この例では、指定された仮想プライベートゲートウェイが指定されたルートテーブルに静的ルートを伝播しないようにします。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 disable-vgw-route-propagation --route-table-id rtb-22574640 --gateway-id vgw-9a4cacf3 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisableVgwRoutePropagation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-vgw-route-propagation.html)」を参照してください。 ### `disable-vpc-classic-link-dns-support` 次のコード例は、`disable-vpc-classic-link-dns-support` を使用する方法を示しています。 **AWS CLI** **VPC の ClassicLink DNS サポートを無効にするには** `vpc-88888888` の ClassicLink DNS サポートを無効にします。 コマンド: ``` aws ec2 disable-vpc-classic-link-dns-support --vpc-id vpc-88888888 ``` 出力: ``` { "Return": true } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisableVpcClassicLinkDnsSupport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-vpc-classic-link-dns-support.html)」を参照してください。 ### `disable-vpc-classic-link` 次のコード例は、`disable-vpc-classic-link` を使用する方法を示しています。 **AWS CLI** **VPC の ClassicLink を無効にするには** この例では、vpc-8888888 の ClassicLink を無効にします。 コマンド: ``` aws ec2 disable-vpc-classic-link --vpc-id vpc-88888888 ``` 出力: ``` { "Return": true } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisableVpcClassicLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disable-vpc-classic-link.html)」を参照してください。 ### `disassociate-address` 次のコード例は、`disassociate-address` を使用する方法を示しています。 **AWS CLI** **EC2-Classic で Elastic IP アドレスの関連付けを解除するには** この例では、EC2-Classic のインスタンスから Elastic IP アドレスの関連付けを解除します。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 disassociate-address --public-ip 198.51.100.0 ``` **EC2-VPC で Elastic IP アドレスの関連付けを解除するには** この例では、VPC のインスタンスから Elastic IP アドレスの関連付けを解除します。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 disassociate-address --association-id eipassoc-2bebb745 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateAddress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disassociate-address.html)」を参照してください。 ### `disassociate-client-vpn-target-network` 次のコード例は、`disassociate-client-vpn-target-network` を使用する方法を示しています。 **AWS CLI** **クライアント VPN エンドポイントからネットワークの関連付けを解除するには** 次の `disassociate-client-vpn-target-network` の例では、指定したクライアント VPN エンドポイントの `cvpn-assoc-12312312312312312` 関連付け ID に関連付けられているターゲットネットワークの関連付けを解除します。 ``` aws ec2 disassociate-client-vpn-target-network \ --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ --association-id cvpn-assoc-12312312312312312 ``` 出力: ``` { "AssociationId": "cvpn-assoc-12312312312312312", "Status": { "Code": "disassociating" } } ``` 詳細については、「*AWS Client VPN 管理者ガイド*」の「[Target Networks](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-target.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateClientVpnTargetNetwork](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disassociate-client-vpn-target-network.html)」を参照してください。 ### `disassociate-iam-instance-profile` 次のコード例は、`disassociate-iam-instance-profile` を使用する方法を示しています。 **AWS CLI** **IAM インスタンスプロファイルの関連付けを解除するには** この例では、IAM インスタンスプロファイルと関連付け ID `iip-assoc-05020b59952902f5f` の関連付けを解除します。 コマンド: ``` aws ec2 disassociate-iam-instance-profile --association-id iip-assoc-05020b59952902f5f ``` 出力: ``` { "IamInstanceProfileAssociation": { "InstanceId": "i-123456789abcde123", "State": "disassociating", "AssociationId": "iip-assoc-05020b59952902f5f", "IamInstanceProfile": { "Id": "AIPAI5IVIHMFFYY2DKV5Y", "Arn": "arn:aws:iam::123456789012:instance-profile/admin-role" } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateIamInstanceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disassociate-iam-instance-profile.html)」を参照してください。 ### `disassociate-instance-event-window` 次のコード例は、`disassociate-instance-event-window` を使用する方法を示しています。 **AWS CLI** **例 1: イベントウィンドウから 1 つ以上のインスタンスの関連付けを解除するには** 次の `disassociate-instance-event-window` の例では、1 つ以上のインスタンスの関連付けをイベントウィンドウから解除します。`instance-event-window-id` パラメータを指定して、イベントウィンドウを指定します。インスタンスの関連付けを解除するには、`association-target` パラメータを使用し、その値に 1 つまたは複数のインスタンス ID を指定します。 ``` aws ec2 disassociate-instance-event-window \ --region us-east-1 \ --instance-event-window-id iew-0abcdef1234567890 \ --association-target "InstanceIds=i-1234567890abcdef0,i-0598c7d356eba48d7" ``` 出力: ``` { "InstanceEventWindow": { "InstanceEventWindowId": "iew-0abcdef1234567890", "Name": "myEventWindowName", "CronExpression": "* 21-23 * * 2,3", "AssociationTarget": { "InstanceIds": [], "Tags": [], "DedicatedHostIds": [] }, "State": "creating" } } ``` イベントウィンドウの制約については、「*Amazon EC2 ユーザーガイド*」の予定されているイベントに関するセクションの「[考慮事項](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html#event-windows-considerations)」を参照してください。 **例 2: イベントウィンドウからインスタンスタグの関連付けを解除するには** 次の `disassociate-instance-event-window` の例では、インスタンスタグの関連付けをイベントウィンドウから解除します。`instance-event-window-id` パラメータを指定して、イベントウィンドウを指定します。インスタンスタグの関連付けを解除するには`association-target` パラメータを使用し、その値に 1 つ以上のタグを指定します。 ``` 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}]" ``` 出力: ``` { "InstanceEventWindow": { "InstanceEventWindowId": "iew-0abcdef1234567890", "Name": "myEventWindowName", "CronExpression": "* 21-23 * * 2,3", "AssociationTarget": { "InstanceIds": [], "Tags": [], "DedicatedHostIds": [] }, "State": "creating" } } ``` イベントウィンドウの制約については、「*Amazon EC2 ユーザーガイド*」の予定されているイベントに関するセクションの「[考慮事項](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html#event-windows-considerations)」を参照してください。 **例 3: イベントウィンドウから専有ホストの関連付けを解除するには** 次の `disassociate-instance-event-window` の例では、専有ホストの関連付けをイベントウィンドウから解除します。`instance-event-window-id` パラメータを指定して、イベントウィンドウを指定します。Dedicated Host の関連付けを解除するには`association-target` パラメータを使用し、その値に 1 つ以上の Dedicated Host ID を指定します。 ``` aws ec2 disassociate-instance-event-window \ --region us-east-1 \ --instance-event-window-id iew-0abcdef1234567890 \ --association-target DedicatedHostIds=h-029fa35a02b99801d ``` 出力: ``` { "InstanceEventWindow": { "InstanceEventWindowId": "iew-0abcdef1234567890", "Name": "myEventWindowName", "CronExpression": "* 21-23 * * 2,3", "AssociationTarget": { "InstanceIds": [], "Tags": [], "DedicatedHostIds": [] }, "State": "creating" } } ``` イベントウィンドウの制約については、「*Amazon EC2 ユーザーガイド*」の予定されているイベントに関するセクションの「[考慮事項](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html#event-windows-considerations)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateInstanceEventWindow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disassociate-instance-event-window.html)」を参照してください。 ### `disassociate-ipam-resource-discovery` 次のコード例は、`disassociate-ipam-resource-discovery` を使用する方法を示しています。 **AWS CLI** **IPAM からリソース検出の関連付けを解除するには** この例では、あなたは IPAM の委任された管理者アカウントとして、IPAM から IPAM リソース検出の関連付けを解除したいと考えています。あなたは describe コマンドを実行し、`"ResourceDiscoveryStatus": "not-found"` に気付いたため、自身の IPAM からその関連付けを解除して、他の関連付けのためのスペースを確保したいと考えています。 次の `disassociate-ipam-resource-discovery` の例では、AWS アカウントの IPAM リソース検出の関連付けを解除します。 ``` aws ec2 disassociate-ipam-resource-discovery \ --ipam-resource-discovery-association-id ipam-res-disco-assoc-04382a6346357cf82 \ --region us-east-1 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[Integrate IPAM with accounts outside of your organization](https://docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam-outside-org.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateIpamResourceDiscovery](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disassociate-ipam-resource-discovery.html)」を参照してください。 ### `disassociate-nat-gateway-address` 次のコード例は、`disassociate-nat-gateway-address` を使用する方法を示しています。 **AWS CLI** **パブリック NAT ゲートウェイから Elastic IP アドレスの関連付けを解除するには** 次の `disassociate-nat-gateway-address` の例では、指定した Elastic IP アドレスの関連付けを指定したパブリック NAT ゲートウェイから解除します。 ``` aws ec2 disassociate-nat-gateway-address \ --nat-gateway-id nat-1234567890abcdef0 \ --association-ids eipassoc-0f96bdca17EXAMPLE ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon VPC ユーザーガイド*」の「[NAT ゲートウェイ](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateNatGatewayAddress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disassociate-nat-gateway-address.html)」を参照してください。 ### `disassociate-route-table` 次のコード例は、`disassociate-route-table` を使用する方法を示しています。 **AWS CLI** **ルートテーブルの関連付けを解除するには** この例では、指定されたサブネットから指定されたルートテーブルの関連付けを解除します。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 disassociate-route-table --association-id rtbassoc-781d0d1a ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateRouteTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disassociate-route-table.html)」を参照してください。 ### `disassociate-security-group-vpc` 次のコード例は、`disassociate-security-group-vpc` を使用する方法を示しています。 **AWS CLI** **VPC からセキュリティグループの関連付けを解除するには** 次の `disassociate-security-group-vpc` の例では、指定されたセキュリティグループの関連付けを指定された VPC から解除します。 ``` aws ec2 disassociate-security-group-vpc \ --group-id sg-04dbb43907d3f8a78 \ --vpc-id vpc-0bf4c2739bc05a694 ``` 出力: ``` { "State": "disassociating" } ``` 詳細については、「*Amazon VPC ユーザーガイド*」の「[セキュリティグループを複数の VPC に関連付ける](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-assoc.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateSecurityGroupVpc](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disassociate-security-group-vpc.html)」を参照してください。 ### `disassociate-subnet-cidr-block` 次のコード例は、`disassociate-subnet-cidr-block` を使用する方法を示しています。 **AWS CLI** **サブネットから IPv6 CIDR ブロックの関連付けを解除するには** この例では、CIDR ブロックの関連付け ID を使用して、サブネットから IPv6 CIDR ブロックの関連付けを解除します。 コマンド: ``` aws ec2 disassociate-subnet-cidr-block --association-id subnet-cidr-assoc-3aa54053 ``` 出力: ``` { "SubnetId": "subnet-5f46ec3b", "Ipv6CidrBlockAssociation": { "Ipv6CidrBlock": "2001:db8:1234:1a00::/64", "AssociationId": "subnet-cidr-assoc-3aa54053", "Ipv6CidrBlockState": { "State": "disassociating" } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateSubnetCidrBlock](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disassociate-subnet-cidr-block.html)」を参照してください。 ### `disassociate-transit-gateway-multicast-domain` 次のコード例は、`disassociate-transit-gateway-multicast-domain` を使用する方法を示しています。 **AWS CLI** **マルチキャストドメインからサブネットの関連付けを解除するには** 次の `disassociate-transit-gateway-multicast-domain` の例では、指定したマルチキャストドメインからサブネットの関連付けを解除します。 ``` 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 ``` 出力: ``` { "Associations": { "TransitGatewayMulticastDomainId": "tgw-mcast-domain-0c4905cef7EXAMPLE", "TransitGatewayAttachmentId": "tgw-attach-070e571cd1EXAMPLE", "ResourceId": "vpc-7EXAMPLE", "ResourceType": "vpc", "Subnets": [ { "SubnetId": "subnet-000de86e3bEXAMPLE", "State": "disassociating" } ] } } ``` 詳細については、*Transit Gateways ガイド*の「[マルチキャストドメイン](https://docs.aws.amazon.com/vpc/latest/tgw/multicast-domains-about.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateTransitGatewayMulticastDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disassociate-transit-gateway-multicast-domain.html)」を参照してください。 ### `disassociate-transit-gateway-route-table` 次のコード例は、`disassociate-transit-gateway-route-table` を使用する方法を示しています。 **AWS CLI** **リソースアタッチメントから Transit Gateway ルートテーブルの関連付けを解除するには** 次の `disassociate-transit-gateway-route-table` の例では、指定したアタッチメントの関連付けを Transit Gateway ルートテーブルから解除します。 ``` aws ec2 disassociate-transit-gateway-route-table \ --transit-gateway-route-table-id tgw-rtb-002573ed1eEXAMPLE \ --transit-gateway-attachment-id tgw-attach-08e0bc912cEXAMPLE ``` 出力: ``` { "Association": { "TransitGatewayRouteTableId": "tgw-rtb-002573ed1eEXAMPLE", "TransitGatewayAttachmentId": "tgw-attach-08e0bc912cEXAMPLE", "ResourceId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE", "ResourceType": "direct-connect-gateway", "State": "disassociating" } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Transit gateway route tables](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateTransitGatewayRouteTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disassociate-transit-gateway-route-table.html)」を参照してください。 ### `disassociate-vpc-cidr-block` 次のコード例は、`disassociate-vpc-cidr-block` を使用する方法を示しています。 **AWS CLI** **VPC から IPv6 CIDR ブロックの関連付けを解除するには** この例では、CIDR ブロックの関連付け ID を使用して、VPC から IPv6 CIDR ブロックの関連付けを解除します。 コマンド: ``` aws ec2 disassociate-vpc-cidr-block --association-id vpc-cidr-assoc-eca54085 ``` 出力: ``` { "Ipv6CidrBlockAssociation": { "Ipv6CidrBlock": "2001:db8:1234:1a00::/56", "AssociationId": "vpc-cidr-assoc-eca54085", "Ipv6CidrBlockState": { "State": "disassociating" } }, "VpcId": "vpc-a034d6c4" } ``` **VPC から IPv4 CIDR ブロックの関連付けを解除するには** この例では、VPC から IPv4 CIDR ブロックの関連付けを解除します。 コマンド: ``` aws ec2 disassociate-vpc-cidr-block --association-id vpc-cidr-assoc-0287ac6b ``` 出力: ``` { "CidrBlockAssociation": { "AssociationId": "vpc-cidr-assoc-0287ac6b", "CidrBlock": "172.18.0.0/16", "CidrBlockState": { "State": "disassociating" } }, "VpcId": "vpc-27621243" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateVpcCidrBlock](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/disassociate-vpc-cidr-block.html)」を参照してください。 ### `enable-address-transfer` 次のコード例は、`enable-address-transfer` を使用する方法を示しています。 **AWS CLI** **Elastic IP アドレスの転送を有効にするには** 次の `enable-address-transfer` の例では、指定した Elastic IP アドレスの Elastic IP アドレス転送を指定したアカウントに対して有効にします。 ``` aws ec2 enable-address-transfer \ --allocation-id eipalloc-09ad461b0d03f6aaf \ --transfer-account-id 123456789012 ``` 出力: ``` { "AddressTransfer": { "PublicIp": "100.21.184.216", "AllocationId": "eipalloc-09ad461b0d03f6aaf", "TransferAccountId": "123456789012", "TransferOfferExpirationTimestamp": "2023-02-22T20:51:01.000Z", "AddressTransferStatus": "pending" } } ``` 詳細については、「*Amazon VPC ユーザーガイド*」の「[Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/WorkWithEIPs.html#transfer-EIPs-intro)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EnableAddressTransfer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-address-transfer.html)」を参照してください。 ### `enable-aws-network-performance-metric-subscription` 次のコード例は、`enable-aws-network-performance-metric-subscription` を使用する方法を示しています。 **AWS CLI** **メトリクスサブスクリプションを有効にするには** 次の `enable-aws-network-performance-metric-subscription` の例では、指定した転送元リージョンと転送先リージョン間のネットワークレイテンシーの集計のモニタリングを有効にします。 ``` aws ec2 enable-aws-network-performance-metric-subscription \ --source us-east-1 \ --destination eu-west-1 \ --metric aggregate-latency \ --statistic p50 ``` 出力: ``` { "Output": true } ``` 詳細については、「*インフラストラクチャのパフォーマンスのユーザーガイド*」の「[Manage subscriptions](https://docs.aws.amazon.com/network-manager/latest/infrastructure-performance/nmip-subscriptions-cw.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EnableAwsNetworkPerformanceMetricSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-aws-network-performance-metric-subscription.html)」を参照してください。 ### `enable-ebs-encryption-by-default` 次のコード例は、`enable-ebs-encryption-by-default` を使用する方法を示しています。 **AWS CLI** **デフォルトで EBS 暗号化を有効にするには** 次の `enable-ebs-encryption-by-default` の例では、現在のリージョンの AWS アカウントに対して EBS 暗号化をデフォルトで有効にします。 ``` aws ec2 enable-ebs-encryption-by-default ``` 出力: ``` { "EbsEncryptionByDefault": true } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EnableEbsEncryptionByDefault](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-ebs-encryption-by-default.html)」を参照してください。 ### `enable-fast-launch` 次のコード例は、`enable-fast-launch` を使用する方法を示しています。 **AWS CLI** **イメージの高速起動を開始するには** 次の `enable-fast-launch` の例では、指定した AMI を高速起動用に設定し、起動する並列インスタンスの最大数を 6 に設定します。AMI の事前プロビジョニングに使用するリソースのタイプは `snapshot` に設定され、これはデフォルト値でもあります。 ``` aws ec2 enable-fast-launch \ --image-id ami-01234567890abcedf \ --max-parallel-launches 6 \ --resource-type snapshot ``` 出力: ``` { "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" } ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[Windows AMI に EC2 Fast Launch 設定を構成する](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/win-fast-launch-configure.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EnableFastLaunch](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-fast-launch.html)」を参照してください。 ### `enable-fast-snapshot-restores` 次のコード例は、`enable-fast-snapshot-restores` を使用する方法を示しています。 **AWS CLI** **高速スナップショット復元を有効にするには** 次の `enable-fast-snapshot-restores` の例では、指定したアベイラビリティーゾーン内の指定したスナップショットの高速スナップショット復元を有効にします。 ``` aws ec2 enable-fast-snapshot-restores \ --availability-zones us-east-2a us-east-2b \ --source-snapshot-ids snap-1234567890abcdef0 ``` 出力: ``` { "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": [] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EnableFastSnapshotRestores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-fast-snapshot-restores.html)」を参照してください。 ### `enable-image-block-public-access` 次のコード例は、`enable-image-block-public-access` を使用する方法を示しています。 **AWS CLI** **指定したリージョンで AMI のパブリックアクセスのブロックを有効にするには** 次の `enable-image-block-public-access` の例では、指定したリージョンからアカウントレベルの AMI のブロックパブリックアクセスを有効にします。 ``` aws ec2 enable-image-block-public-access \ --region us-east-1 \ --image-block-public-access-state block-new-sharing ``` 出力: ``` { "ImageBlockPublicAccessState": "block-new-sharing" } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[Block public access to your AMIs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sharingamis-intro.html#block-public-access-to-amis)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EnableImageBlockPublicAccess](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-image-block-public-access.html)」を参照してください。 ### `enable-image-deprecation` 次のコード例は、`enable-image-deprecation` を使用する方法を示しています。 **AWS CLI** **AMI を非推奨にするには** 次の `enable-image-deprecation` の例では、特定の日時の AMI を非推奨化します。秒の値を指定した場合は、Amazon EC2 により最も近い分に丸められます。この手順を実行するには、AMI の所有者である必要があります。 ``` aws ec2 enable-image-deprecation \ --image-id ami-1234567890abcdef0 \ --deprecate-at '2022-10-15T13:17:12.000Z' ``` 出力: ``` { "RequestID": "59dbff89-35bd-4eac-99ed-be587EXAMPLE", "Return": "true" } ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[AMI を非推奨にする](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-deprecate.html#deprecate-ami)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EnableImageDeprecation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-image-deprecation.html)」を参照してください。 ### `enable-image-deregistration-protection` 次のコード例は、`enable-image-deregistration-protection` を使用する方法を示しています。 **AWS CLI** **登録解除保護を有効にするには** 次の `enable-image-deregistration-protection` の例では、指定されたイメージの登録解除保護を有効にします。 ``` aws ec2 enable-image-deregistration-protection \ --image-id ami-0b1a928a144a74ec9 ``` 出力: ``` { "Return": "enabled-without-cooldown" } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[Amazon EC2 AMI を登録解除から保護する](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-deregistration-protection.html)」を参照してください。 + API の詳細については、「*AWS CLI Command Reference*」の「[EnableImageDeregistrationProtection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-image-deregistration-protection.html)」を参照してください。 ### `enable-image` 次のコード例は、`enable-image` を使用する方法を示しています。 **AWS CLI** **AMI を有効にするには** 次の `enable-image` の例では、指定した AMI を有効にします。 ``` aws ec2 enable-image \ --image-id ami-1234567890abcdef0 ``` 出力: ``` { "Return": "true" } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[AMI を無効にする](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/disable-an-ami.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EnableImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-image.html)」を参照してください。 ### `enable-ipam-organization-admin-account` 次のコード例は、`enable-ipam-organization-admin-account` を使用する方法を示しています。 **AWS CLI** **AWS Organizations と統合し、メンバーアカウントを IPAM アカウントとして委任するには** 次の `enable-ipam-organization-admin-account` の例では、IPAM を AWS Organizations と統合し、メンバーアカウントを IPAM アカウントとして委任します。 ``` aws ec2 enable-ipam-organization-admin-account \ --delegated-admin-account-id 320805250157 ``` 出力: ``` { "Success": true } ``` 詳細については*Amazon VPC IP アドレス管理ユーザーガイド*の[AWS Organizations と IPAM を統合する](https://docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam.html)を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EnableIpamOrganizationAdminAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-ipam-organization-admin-account.html)」を参照してください。 ### `enable-reachability-analyzer-organization-sharing` 次のコード例は、`enable-reachability-analyzer-organization-sharing` を使用する方法を示しています。 **AWS CLI** **Reachability Analyzer で信頼されたアクセスを有効にするには** 次の `enable-reachability-analyzer-organization-sharing` の例では、Reachability Analyzer の信頼されたアクセスを有効にします。 ``` aws ec2 enable-reachability-analyzer-organization-sharing ``` このコマンドでは何も出力されません。 詳細については、「*Reachability Analyzer ユーザーガイド*」の「[Cross-account analyses](https://docs.aws.amazon.com/vpc/latest/reachability/multi-account.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EnableReachabilityAnalyzerOrganizationSharing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-reachability-analyzer-organization-sharing.html)」を参照してください。 ### `enable-serial-console-access` 次のコード例は、`enable-serial-console-access` を使用する方法を示しています。 **AWS CLI** **アカウントのシリアルコンソールへのアクセスを有効にするには** 次の `enable-serial-console-access` の例では、シリアルコンソールへのアカウントアクセスを有効にします。 ``` aws ec2 enable-serial-console-access ``` 出力: ``` { "SerialConsoleAccessEnabled": true } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[EC2 Serial Console](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-serial-console.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EnableSerialConsoleAccess](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-serial-console-access.html)」を参照してください。 ### `enable-snapshot-block-public-access` 次のコード例は、`enable-snapshot-block-public-access` を使用する方法を示しています。 **AWS CLI** **スナップショットのパブリックアクセスのブロックを有効にするには** 次の `enable-snapshot-block-public-access` の例では、スナップショットのすべてのパブリック共有をブロックします。 ``` aws ec2 enable-snapshot-block-public-access \ --state block-all-sharing ``` 出力: ``` { "State": "block-all-sharing" } ``` 詳細については、「*Amazon EBS ユーザーガイド*」の「[Block public access for snapshots](https://docs.aws.amazon.com/ebs/latest/userguide/block-public-access-snapshots.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EnableSnapshotBlockPublicAccess](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-snapshot-block-public-access.html)」を参照してください。 ### `enable-transit-gateway-route-table-propagation` 次のコード例は、`enable-transit-gateway-route-table-propagation` を使用する方法を示しています。 **AWS CLI** **Transit Gateway アタッチメントを有効にして、指定した伝播ルートテーブルにルートを伝播するには** 次の `enable-transit-gateway-route-table-propagation` の例では、指定したアタッチメントが、指定した伝播ルートテーブルにルートを伝播することを有効にします。 ``` aws ec2 enable-transit-gateway-route-table-propagation \ --transit-gateway-route-table-id tgw-rtb-0a823edbdeEXAMPLE \ --transit-gateway-attachment-id tgw-attach-09b52ccdb5EXAMPLE ``` 出力: ``` { "Propagation": { "TransitGatewayAttachmentId": "tgw-attach-09b52ccdb5EXAMPLE", "ResourceId": "vpc-4d7de228", "ResourceType": "vpc", "TransitGatewayRouteTableId": "tgw-rtb-0a823edbdeEXAMPLE", "State": "disabled" } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Transit gateway route tables](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EnableTransitGatewayRouteTablePropagation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-transit-gateway-route-table-propagation.html)」を参照してください。 ### `enable-vgw-route-propagation` 次のコード例は、`enable-vgw-route-propagation` を使用する方法を示しています。 **AWS CLI** **ルート伝播を有効にするには** この例では、指定された仮想プライベートゲートウェイが指定されたルートテーブルに静的ルートを伝播できるようにします。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 enable-vgw-route-propagation --route-table-id rtb-22574640 --gateway-id vgw-9a4cacf3 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EnableVgwRoutePropagation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-vgw-route-propagation.html)」を参照してください。 ### `enable-volume-io` 次のコード例は、`enable-volume-io` を使用する方法を示しています。 **AWS CLI** **ボリュームの I/O を有効にするには** この例では、ボリューム `vol-1234567890abcdef0` の I/O を有効にします。 コマンド: ``` aws ec2 enable-volume-io --volume-id vol-1234567890abcdef0 ``` 出力: ``` { "Return": true } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EnableVolumeIo](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-volume-io.html)」を参照してください。 ### `enable-vpc-classic-link-dns-support` 次のコード例は、`enable-vpc-classic-link-dns-support` を使用する方法を示しています。 **AWS CLI** **VPC の ClassicLink DNS サポートを有効にするには** この例では、`vpc-88888888` の ClassicLink DNS サポートを有効にします。 コマンド: ``` aws ec2 enable-vpc-classic-link-dns-support --vpc-id vpc-88888888 ``` 出力: ``` { "Return": true } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EnableVpcClassicLinkDnsSupport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-vpc-classic-link-dns-support.html)」を参照してください。 ### `enable-vpc-classic-link` 次のコード例は、`enable-vpc-classic-link` を使用する方法を示しています。 **AWS CLI** **ClassicLink 用に VPC を有効にするには** この例では、ClassicLink の vpc-8888888 を有効にします。 コマンド: ``` aws ec2 enable-vpc-classic-link --vpc-id vpc-88888888 ``` 出力: ``` { "Return": true } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EnableVpcClassicLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/enable-vpc-classic-link.html)」を参照してください。 ### `export-client-vpn-client-certificate-revocation-list` 次のコード例は、`export-client-vpn-client-certificate-revocation-list` を使用する方法を示しています。 **AWS CLI** **クライアント証明書失効リストをエクスポートするには** 次の `export-client-vpn-client-certificate-revocation-list` の例では、指定したクライアント VPN エンドポイントのクライアント証明書失効リストをエクスポートします。この例では、読みやすくするために出力はテキスト形式で返されます。 ``` aws ec2 export-client-vpn-client-certificate-revocation-list \ --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ --output text ``` 出力: ``` -----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 ``` 詳細については、「*AWS Client VPN 管理者ガイド*」の「[Client Certificate Revocation Lists](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-certificates.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ExportClientVpnClientCertificateRevocationList](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/export-client-vpn-client-certificate-revocation-list.html)」を参照してください。 ### `export-client-vpn-client-configuration` 次のコード例は、`export-client-vpn-client-configuration` を使用する方法を示しています。 **AWS CLI** **クライアント設定をエクスポートするには** 次の `export-client-vpn-client-configuration` の例では、指定したクライアント VPN エンドポイントのクライアント設定をエクスポートします。この例では、読みやすくするために出力はテキスト形式で返されます。 ``` aws ec2 export-client-vpn-client-configuration \ --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ --output text ``` 出力: ``` 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 ``` 詳細については、*AWS Client VPN 管理者ガイド*の「[クライアント VPN エンドポイント設定ファイルのエクスポート](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-endpoint-export.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ExportClientVpnClientConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/export-client-vpn-client-configuration.html)」を参照してください。 ### `export-image` 次のコード例は、`export-image` を使用する方法を示しています。 **AWS CLI** **AMI から VM をエクスポートするには** 次の `export-image` の例では、指定した AMI を指定した形式で指定したバケットにエクスポートします。 ``` aws ec2 export-image \ --image-id ami-1234567890abcdef0 \ --disk-image-format VMDK \ --s3-export-location S3Bucket=my-export-bucket,S3Prefix=exports/ ``` 出力: ``` { "DiskImageFormat": "vmdk", "ExportImageTaskId": "export-ami-1234567890abcdef0" "ImageId": "ami-1234567890abcdef0", "RoleName": "vmimport", "Progress": "0", "S3ExportLocation": { "S3Bucket": "my-export-bucket", "S3Prefix": "exports/" }, "Status": "active", "StatusMessage": "validating" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ExportImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/export-image.html)」を参照してください。 ### `get-associated-ipv6-pool-cidrs` 次のコード例は、`get-associated-ipv6-pool-cidrs` を使用する方法を示しています。 **AWS CLI** **IPv6 アドレスプールの関連付けを取得するには** 次の `get-associated-ipv6-pool-cidrs` の例では、指定した IPv6 アドレスプールの関連付けを取得します。 ``` aws ec2 get-associated-ipv6-pool-cidrs \ --pool-id ipv6pool-ec2-012345abc12345abc ``` 出力: ``` { "Ipv6CidrAssociations": [ { "Ipv6Cidr": "2001:db8:1234:1a00::/56", "AssociatedResource": "vpc-111111222222333ab" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAssociatedIpv6PoolCidrs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-associated-ipv6-pool-cidrs.html)」を参照してください。 ### `get-aws-network-performance-data` 次のコード例は、`get-aws-network-performance-data` を使用する方法を示しています。 **AWS CLI** **ネットワークパフォーマンスデータを取得するには** 次の `get-aws-network-performance-data` の例では、指定した期間内の指定したリージョン間のネットワークパフォーマンスに関するデータを取得します。 ``` 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 ``` 出力: ``` { "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" } ] } ] } ``` 詳細については、「*インフラストラクチャのパフォーマンスのユーザーガイド*」の「[Monitor network performance](https://docs.aws.amazon.com/network-manager/latest/infrastructure-performance/nmip-performance-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAwsNetworkPerformanceData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-aws-network-performance-data.html)」を参照してください。 ### `get-capacity-reservation-usage` 次のコード例は、`get-capacity-reservation-usage` を使用する方法を示しています。 **AWS CLI** **AWS アカウント間でキャパシティ予約の使用状況を表示するには** 次の `get-capacity-reservation-usage` の例では、指定したキャパシティ予約の使用情報を表示します。 ``` aws ec2 get-capacity-reservation-usage \ --capacity-reservation-id cr-1234abcd56EXAMPLE ``` 出力: ``` { "CapacityReservationId": "cr-1234abcd56EXAMPLE ", "InstanceUsages": [ { "UsedInstanceCount": 1, "AccountId": "123456789012" } ], "AvailableInstanceCount": 4, "TotalInstanceCount": 5, "State": "active", "InstanceType": "t2.medium" } ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[共有キャパシティ予約](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservation-sharing.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetCapacityReservationUsage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-capacity-reservation-usage.html)」を参照してください。 ### `get-coip-pool-usage` 次のコード例は、`get-coip-pool-usage` を使用する方法を示しています。 **AWS CLI** **顧客所有の IP アドレスプールの使用状況を取得するには** 次の `get-coip-pool-usage` の例では、指定したカスタマー所有 IP アドレスプールの使用状況の詳細を取得します。 ``` aws ec2 get-coip-pool-usage \ --pool-id ipv4pool-coip-123a45678bEXAMPLE ``` 出力: ``` { "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" } ``` 詳細については、*AWS Outposts ラックユーザーガイド*の「[カスタマー所有の IP アドレス](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetCoipPoolUsage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-coip-pool-usage.html)」を参照してください。 ### `get-console-output` 次のコード例は、`get-console-output` を使用する方法を示しています。 **AWS CLI** **例 1: コンソール出力を取得するには** 次の `get-console-output` の例では、指定した Linux インスタンスのコンソール出力を取得します。 ``` aws ec2 get-console-output \ --instance-id i-1234567890abcdef0 ``` 出力: ``` { "InstanceId": "i-1234567890abcdef0", "Timestamp": "2013-07-25T21:23:53.000Z", "Output": "..." } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[インスタンスコンソール出力](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-console.html#instance-console-console-output)」を参照してください。 **例 2: 最新のコンソール出力を取得するには** 次の `get-console-output` の例では、指定した Linux インスタンスの最新のコンソール出力を取得します。 ``` aws ec2 get-console-output \ --instance-id i-1234567890abcdef0 \ --latest \ --output text ``` 出力: ``` 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 ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[インスタンスコンソール出力](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-console.html#instance-console-console-output)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetConsoleOutput](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-console-output.html)」を参照してください。 ### `get-console-screenshot` 次のコード例は、`get-console-screenshot` を使用する方法を示しています。 **AWS CLI** **実行中のインスタンスのスクリーンショットを取得するには** 次の `get-console-screenshot` の例では、指定したインスタンスのスクリーンショットを取得します。スクリーンショットは Base64 エンコード文字列として返されます。 ``` aws ec2 get-console-screenshot \ --instance-id i-1234567890abcdef0 ``` 出力: ``` { "ImageData": "997987/8kgj49ikjhewkwwe0008084EXAMPLE", "InstanceId": "i-1234567890abcdef0" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetConsoleScreenshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-console-screenshot.html)」を参照してください。 ### `get-default-credit-specification` 次のコード例は、`get-default-credit-specification` を使用する方法を示しています。 **AWS CLI** **デフォルトのクレジットオプションを記述するには** 次の `get-default-credit-specification` の例では、T2 インスタンスのデフォルトのクレジットオプションについて説明します。 ``` aws ec2 get-default-credit-specification \ --instance-family t2 ``` 出力: ``` { "InstanceFamilyCreditSpecification": { "InstanceFamily": "t2", "CpuCredits": "standard" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDefaultCreditSpecification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-default-credit-specification.html)」を参照してください。 ### `get-ebs-default-kms-key-id` 次のコード例は、`get-ebs-default-kms-key-id` を使用する方法を示しています。 **AWS CLI** **EBS 暗号化用のデフォルトの CMK を記述するには** 次の `get-ebs-default-kms-key-id` の例では、AWS アカウントの EBS 暗号化のデフォルトの CMK について説明します。 ``` aws ec2 get-ebs-default-kms-key-id ``` 出力は、EBS 暗号化用のデフォルトの CMK を示します。これは、エイリアス `alias/aws/ebs` を持つ AWS マネージド CMK です。 ``` { "KmsKeyId": "alias/aws/ebs" } ``` 次の出力は、EBS 暗号化用のカスタム CMK を示します。 ``` { "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/0ea3fef3-80a7-4778-9d8c-1c0c6EXAMPLE" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetEbsDefaultKmsKeyId](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-ebs-default-kms-key-id.html)」を参照してください。 ### `get-ebs-encryption-by-default` 次のコード例は、`get-ebs-encryption-by-default` を使用する方法を示しています。 **AWS CLI** **EBS 暗号化がデフォルトで有効になっているかどうかを記述するには** 次の `get-ebs-encryption-by-default` の例では、現在のリージョン内の AWS アカウントに対して EBS 暗号化がデフォルトで有効になっているかどうかを示します。 ``` aws ec2 get-ebs-encryption-by-default ``` 次の出力は、EBS 暗号化がデフォルトで無効になっていることを示します。 ``` { "EbsEncryptionByDefault": false } ``` 次の出力は、EBS 暗号化がデフォルトで有効になっていることを示します。 ``` { "EbsEncryptionByDefault": true } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetEbsEncryptionByDefault](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-ebs-encryption-by-default.html)」を参照してください。 ### `get-flow-logs-integration-template` 次のコード例は、`get-flow-logs-integration-template` を使用する方法を示しています。 **AWS CLI** **VPC フローログと Amazon Athena の統合を自動化する CloudFormation テンプレートを作成するには** 次の `get-flow-logs-integration-template` の例では、VPC フローログと Amazon Athena の統合を自動化する CloudFormation テンプレートを作成します。 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}] ``` 出力: ``` { "Result": "https://amzn-s3-demo-bucket.s3.us-east-2.amazonaws.com/VPCFlowLogsIntegrationTemplate_fl-1234567890abcdef0_Wed%20Jul%2021%2000%3A57%3A56%20UTC%202021.yml" } ``` CloudFormation テンプレートの使用に関する詳細については、「*AWS CloudFormation ユーザーガイド*」の「[AWS CloudFormation テンプレートの使用](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-guide.html)」を参照してください。 Amazon Athena とフローログの使用に関する詳細については、「*Amazon Virtual Private Cloud ユーザーガイド*」の「[Amazon Athena を使用したフローログのクエリ](https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs-athena.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetFlowLogsIntegrationTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-flow-logs-integration-template.html)」を参照してください。 ### `get-groups-for-capacity-reservation` 次のコード例は、`get-groups-for-capacity-reservation` を使用する方法を示しています。 **AWS CLI** **キャパシティ予約のあるリソースグループを一覧表示するには** 次の `get-groups-for-capacity-reservation` の例では、指定したキャパシティ予約が追加されたリソースグループを一覧表示します。 ``` aws ec2 get-groups-for-capacity-reservation \ --capacity-reservation-id cr-1234abcd56EXAMPLE ``` 出力: ``` { "CapacityReservationsGroup": [ { "GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/my-resource-group", "OwnerId": "123456789012" } ] } ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[キャパシティ予約グループ](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-cr-group.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetGroupsForCapacityReservation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-groups-for-capacity-reservation.html)」を参照してください。 ### `get-host-reservation-purchase-preview` 次のコード例は、`get-host-reservation-purchase-preview` を使用する方法を示しています。 **AWS CLI** **専有ホストの予約の購入プレビューを取得するには** この例では、アカウント内の指定された専有ホストに対して指定された専有ホスト予約のコストをプレビューします。 コマンド: ``` aws ec2 get-host-reservation-purchase-preview --offering-id hro-03f707bf363b6b324 --host-id-set h-013abcd2a00cbd123 ``` 出力: ``` { "TotalHourlyPrice": "1.499", "Purchase": [ { "HourlyPrice": "1.499", "InstanceFamily": "m4", "PaymentOption": "NoUpfront", "HostIdSet": [ "h-013abcd2a00cbd123" ], "UpfrontPrice": "0.000", "Duration": 31536000 } ], "TotalUpfrontPrice": "0.000" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetHostReservationPurchasePreview](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-host-reservation-purchase-preview.html)」を参照してください。 ### `get-image-block-public-access-state` 次のコード例は、`get-image-block-public-access-state` を使用する方法を示しています。 **AWS CLI** **指定したリージョンで AMI のパブリックアクセスのブロック状態を取得するには** 次の `get-image-block-public-access-state` の例では、指定したリージョン内のアカウントレベルの AMI についてブロックパブリックアクセスを取得します。 ``` aws ec2 get-image-block-public-access-state \ --region us-east-1 ``` 出力: ``` { "ImageBlockPublicAccessState": "block-new-sharing" } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[Block public access to your AMIs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sharingamis-intro.html#block-public-access-to-amis)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetImageBlockPublicAccessState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-image-block-public-access-state.html)」を参照してください。 ### `get-instance-types-from-instance-requirements` 次のコード例は、`get-instance-types-from-instance-requirements` を使用する方法を示しています。 **AWS CLI** **指定された属性に一致するインスタンスタイプをプレビューするには** 次の `get-instance-types-from-instance-requirements` の例では、`--generate-cli-skeleton` パラメータを使用して指定できるすべての属性のリストを先に生成してから、そのリストを JSON ファイルに保存します。次に、JSON ファイルを使用して、一致するインスタンスタイプをプレビューする属性をカスタマイズします。 指定できる属性をすべて生成し、出力を JSON ファイルに直接保存するには、次のコマンドを使用します。 ``` aws ec2 get-instance-types-from-instance-requirements \ --region us-east-1 \ --generate-cli-skeleton input > attributes.json ``` 出力: ``` { "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": "" } ``` JSON ファイルを設定します。`ArchitectureTypes`、`VirtualizationTypes`、`VCpuCount`、および `MemoryMiB` の値を指定する必要があります。他の属性は省略できます。省略すると、デフォルト値が使用されます。各属性とそのデフォルト値の説明については、「get-instance-types-from-instance-requirements 」を参照してください。 `attributes.json` で指定された属性を持つインスタンスタイプをプレビューします。`--cli-input-json` パラメータを使用して、JSON ファイルの名前とパスを指定します。次のリクエストでは、出力はテーブル形式で提供されます。 ``` aws ec2 get-instance-types-from-instance-requirements \ --cli-input-json file://attributes.json \ --output table ``` `attributes.json` ファイルの内容。 ``` { "ArchitectureTypes": [ "x86_64" ], "VirtualizationTypes": [ "hvm" ], "InstanceRequirements": { "VCpuCount": { "Min": 4, "Max": 6 }, "MemoryMiB": { "Min": 2048 }, "InstanceGenerations": [ "current" ] } } ``` 出力: ``` ------------------------------------------ |GetInstanceTypesFromInstanceRequirements| +----------------------------------------+ || InstanceTypes || |+--------------------------------------+| || InstanceType || |+--------------------------------------+| || c4.xlarge || || c5.xlarge || || c5a.xlarge || || c5ad.xlarge || || c5d.xlarge || || c5n.xlarge || || d2.xlarge || ... ``` 属性ベースのインスタンスタイプの選択の詳細については、「*Amazon EC2 ユーザーガイド*」の「[属性ベースのインスタンスタイプ選択の仕組み](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abs-how-it-works)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetInstanceTypesFromInstanceRequirements](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-instance-types-from-instance-requirements.html)」を参照してください。 ### `get-instance-uefi-data` 次のコード例は、`get-instance-uefi-data` を使用する方法を示しています。 **AWS CLI** **インスタンスから UEFI データを取得するには** 次の `get-instance-uefi-data` の例では、インスタンスから UEFI データを取得します。出力が空の場合、インスタンスには UEFI データが含まれません。 ``` aws ec2 get-instance-uefi-data \ --instance-id i-0123456789example ``` 出力: ``` { "InstanceId": "i-0123456789example", "UefiData": "QU1aTlVFRkkf+uLXAAAAAHj5a7fZ9+3dBzxXb/. AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD4L/J/AODshho=" } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[Amazon EC2 インスタンスの UEFI Secure Boot](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/uefi-secure-boot.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetInstanceUefiData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-instance-uefi-data.html)」を参照してください。 ### `get-ipam-address-history` 次のコード例は、`get-ipam-address-history` を使用する方法を示しています。 **AWS CLI** **CIDR の履歴を取得するには** 次の `get-ipam-address-history` の例では、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 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[View the history of IP addresses](https://docs.aws.amazon.com/vpc/latest/ipam/view-history-cidr-ipam.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetIpamAddressHistory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-ipam-address-history.html)」を参照してください。 ### `get-ipam-discovered-accounts` 次のコード例は、`get-ipam-discovered-accounts` を使用する方法を示しています。 **AWS CLI** **IPAM によって検出されたアカウントを表示するには** このシナリオでは、あなたは IPAM の委任された管理者として、IPAM が検出するリソースを所有する AWS アカウントを表示したいと考えています。 `--discovery-region` は、モニタリング対象のアカウントステータスを表示する IPAM 運用リージョンです。例えば、3 つの IPAM 運用リージョンがある場合、このリクエストを 3 回実行して、それらの各リージョンで検出に固有のタイムスタンプを表示することができます。 次の `get-ipam-discovered-accounts` の例では、IPAM が検出するリソースを所有する AWS アカウントを一覧表示します。 ``` aws ec2 get-ipam-discovered-accounts \ --ipam-resource-discovery-id ipam-res-disco-0365d2977fc1672fe \ --discovery-region us-east-1 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[Integrate IPAM with accounts outside of your organization](https://docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam-outside-org.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetIpamDiscoveredAccounts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-ipam-discovered-accounts.html)」を参照してください。 ### `get-ipam-discovered-public-addresses` 次のコード例は、`get-ipam-discovered-public-addresses` を使用する方法を示しています。 **AWS CLI** **検出されたパブリック IP アドレスを表示するには** この例では、あなたは IPAM の委任された管理者として、IPAM が検出したリソースの IP アドレスを表示したいと考えています。[describe-ipam-resource-discoveries](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-ipam-resource-discoveries.html) を使用してリソース検出 ID を取得できます。 次の `get-ipam-discovered-public-addresses` の例では、リソース検出で検出されたパブリック IP アドレスを表示します。 ``` aws ec2 get-ipam-discovered-public-addresses \ --ipam-resource-discovery-id ipam-res-disco-0f4ef577a9f37a162 \ --address-region us-east-1 \ --region us-east-1 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[View public IP insights](https://docs.aws.amazon.com/vpc/latest/ipam/view-public-ip-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetIpamDiscoveredPublicAddresses](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-ipam-discovered-public-addresses.html)」を参照してください。 ### `get-ipam-discovered-resource-cidrs` 次のコード例は、`get-ipam-discovered-resource-cidrs` を使用する方法を示しています。 **AWS CLI** **IPAM によって検出された IP アドレス CIDR を表示するには** この例では、あなたは IPAM の委任された管理者として、IPAM が検出するリソースの IP アドレス CIDR に関連する詳細を表示したいと考えています。 このリクエストを完了するには: 選択したリソース検出は IPAM に関連付ける必要があります。`--resource-region` はリソースが作成された AWS リージョンです。 次の `get-ipam-discovered-resource-cidrs` の例では、IPAM が検出するリソースの IP アドレスを一覧表示します。 ``` aws ec2 get-ipam-discovered-resource-cidrs \ --ipam-resource-discovery-id ipam-res-disco-0365d2977fc1672fe \ --resource-region us-east-1 ``` 出力: ``` { { "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" } } } ``` 詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[Monitor CIDR usage by resource](https://docs.aws.amazon.com/vpc/latest/ipam/monitor-cidr-compliance-ipam.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetIpamDiscoveredResourceCidrs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-ipam-discovered-resource-cidrs.html)」を参照してください。 ### `get-ipam-pool-allocations` 次のコード例は、`get-ipam-pool-allocations` を使用する方法を示しています。 **AWS CLI** **IPAM プールから割り当てられた CIDR を取得するには** 次の `get-ipam-pool-allocations` の例では、IPAM プールから割り当てられた CIDR を一覧表示します。 (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 ``` 出力: ``` { "IpamPoolAllocations": [ { "Cidr": "10.0.0.0/16", "IpamPoolAllocationId": "ipam-pool-alloc-0e6186d73999e47389266a5d6991e6220", "ResourceType": "custom", "ResourceOwner": "123456789012" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetIpamPoolAllocations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-ipam-pool-allocations.html)」を参照してください。 ### `get-ipam-pool-cidrs` 次のコード例は、`get-ipam-pool-cidrs` を使用する方法を示しています。 **AWS CLI** **IPAM プールにプロビジョニングされた CIDR を取得するには** 次の `get-ipam-pool-cidrs` の例では、IPAM プールにプロビジョニングされた CIDR を取得します。 (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.* ``` 出力: ``` { "IpamPoolCidr": { "Cidr": "10.0.0.0/24", "State": "provisioned" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetIpamPoolCidrs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-ipam-pool-cidrs.html)」を参照してください。 ### `get-ipam-resource-cidrs` 次のコード例は、`get-ipam-resource-cidrs` を使用する方法を示しています。 **AWS CLI** **リソースに割り当てられた CIDR を取得するには** 次の `get-ipam-resource-cidrs` の例では、リソースに割り当てられた CIDR を取得します。 (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 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[Monitor CIDR usage by resource](https://docs.aws.amazon.com/vpc/latest/ipam/monitor-cidr-compliance-ipam.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetIpamResourceCidrs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-ipam-resource-cidrs.html)」を参照してください。 ### `get-launch-template-data` 次のコード例は、`get-launch-template-data` を使用する方法を示しています。 **AWS CLI** **起動テンプレートのインスタンスデータを取得するには** この例では、指定されたインスタンスに関するデータを取得し、`--query` オプションを使用して `LaunchTemplateData` 内の内容を返します。出力をベースとして使用して、新しい起動テンプレートや起動テンプレートのバージョンを作成できます。 コマンド: ``` aws ec2 get-launch-template-data --instance-id i-0123d646e8048babc --query 'LaunchTemplateData' ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetLaunchTemplateData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-launch-template-data.html)」を参照してください。 ### `get-managed-prefix-list-associations` 次のコード例は、`get-managed-prefix-list-associations` を使用する方法を示しています。 **AWS CLI** **プレフィックスリストの関連付けを取得するには** 次の `get-managed-prefix-list-associations` の例では、指定したプレフィックスリストに関連付けられたリソースを取得します。 ``` aws ec2 get-managed-prefix-list-associations \ --prefix-list-id pl-0123456abcabcabc1 ``` 出力: ``` { "PrefixListAssociations": [ { "ResourceId": "sg-0abc123456abc12345", "ResourceOwner": "123456789012" } ] } ``` 詳細については、「*Amazon VPC ユーザーガイド*」の「[Managed prefix lists](https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetManagedPrefixListAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-managed-prefix-list-associations.html)」を参照してください。 ### `get-managed-prefix-list-entries` 次のコード例は、`get-managed-prefix-list-entries` を使用する方法を示しています。 **AWS CLI** **プレフィックスリストのエントリを取得するには** 次の `get-managed-prefix-list-entries` では、指定されたプレフィックスリストのエントリを取得します。 ``` aws ec2 get-managed-prefix-list-entries \ --prefix-list-id pl-0123456abcabcabc1 ``` 出力: ``` { "Entries": [ { "Cidr": "10.0.0.0/16", "Description": "vpc-a" }, { "Cidr": "10.2.0.0/16", "Description": "vpc-b" } ] } ``` 詳細については、「*Amazon VPC ユーザーガイド*」の「[Managed prefix lists](https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetManagedPrefixListEntries](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-managed-prefix-list-entries.html)」を参照してください。 ### `get-network-insights-access-scope-analysis-findings` 次のコード例は、`get-network-insights-access-scope-analysis-findings` を使用する方法を示しています。 **AWS CLI** **ネットワークインサイトのアクセス範囲析の結果を取得するには** 次の `get-network-insights-access-scope-analysis-findings` の例では、AWS アカウントで選択した範囲分析の結果を取得します。 ``` aws ec2 get-network-insights-access-scope-analysis-findings \ --region us-east-1 \ --network-insights-access-scope-analysis-id nis \ --nis-123456789111 ``` 出力: ``` { "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] ] } } ] } ``` 詳細については、「*Network Access Analyzer ガイド*」の「[Getting started with Network Access Analyzer using the AWS CLI](https://docs.aws.amazon.com/vpc/latest/network-access-analyzer/getting-started-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetNetworkInsightsAccessScopeAnalysisFindings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-network-insights-access-scope-analysis-findings.html)」を参照してください。 ### `get-network-insights-access-scope-content` 次のコード例は、`get-network-insights-access-scope-content` を使用する方法を示しています。 **AWS CLI** **ネットワークインサイトのアクセス範囲の内容を取得するには** 次の `get-network-insights-access-scope-content` の例では、AWS アカウントで選択した範囲分析の内容を取得します。 ``` aws ec2 get-network-insights-access-scope-content \ --region us-east-1 \ --network-insights-access-scope-id nis-123456789222 ``` 出力: ``` { "NetworkInsightsAccessScopeContent": { "NetworkInsightsAccessScopeId": "nis-123456789222", "MatchPaths": [ { "Source": { "ResourceStatement": { "ResourceTypes": [ "AWS::EC2::NetworkInterface" ] } }, "Destination": { "ResourceStatement": { "ResourceTypes": [ "AWS::EC2::InternetGateway" ] } } } ] } } ``` 詳細については、「*Network Access Analyzer ガイド*」の「[Getting started with Network Access Analyzer using the AWS CLI](https://docs.aws.amazon.com/vpc/latest/network-access-analyzer/getting-started-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetNetworkInsightsAccessScopeContent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-network-insights-access-scope-content.html)」を参照してください。 ### `get-password-data` 次のコード例は、`get-password-data` を使用する方法を示しています。 **AWS CLI** **暗号化されたパスワードを取得するには** この例では、暗号化されたパスワードを取得します。 コマンド: ``` aws ec2 get-password-data --instance-id i-1234567890abcdef0 ``` 出力: ``` { "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==" } ``` **復号されたパスワードを取得するには** この例では、復号されたパスワードを取得します。 コマンド: ``` aws ec2 get-password-data --instance-id i-1234567890abcdef0 --priv-launch-key C:\Keys\MyKeyPair.pem ``` 出力: ``` { "InstanceId": "i-1234567890abcdef0", "Timestamp": "2013-08-30T23:18:05.000Z", "PasswordData": "&ViJ652e*u" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPasswordData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-password-data.html)」を参照してください。 ### `get-reserved-instances-exchange-quote` 次のコード例は、`get-reserved-instances-exchange-quote` を使用する方法を示しています。 **AWS CLI** **コンバーティブルリザーブドインスタンスの交換の見積りを取得するには** この例では、指定されたコンバーティブルリザーブドインスタンスの交換情報を取得します。 コマンド: ``` aws ec2 get-reserved-instances-exchange-quote --reserved-instance-ids 7b8750c3-397e-4da4-bbcb-a45ebexample --target-configurations OfferingId=6fea5434-b379-434c-b07b-a7abexample ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetReservedInstancesExchangeQuote](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-reserved-instances-exchange-quote.html)」を参照してください。 ### `get-security-groups-for-vpc` 次のコード例は、`get-security-groups-for-vpc` を使用する方法を示しています。 **AWS CLI** **指定した VPC のネットワークインターフェイスに関連付けることができるセキュリティグループを表示するには。** 次の `get-security-groups-for-vpc` の例では、VPC 内のネットワークインターフェイスに関連付けることができるセキュリティグループを表示します。 ``` aws ec2 get-security-groups-for-vpc \ --vpc-id vpc-6c31a611 \ --region us-east-1 ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetSecurityGroupsForVpc](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-security-groups-for-vpc.html)」を参照してください。 ### `get-serial-console-access-status` 次のコード例は、`get-serial-console-access-status` を使用する方法を示しています。 **AWS CLI** **シリアルコンソールへのアカウントアクセスのステータスを表示するには** 次の `get-serial-console-access-status` の例では、アカウントでシリアルコンソールアクセスが有効になっているかどうかを判断します。 ``` aws ec2 get-serial-console-access-status ``` 出力: ``` { "SerialConsoleAccessEnabled": true } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[EC2 Serial Console](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-serial-console.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetSerialConsoleAccessStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-serial-console-access-status.html)」を参照してください。 ### `get-snapshot-block-public-access-state` 次のコード例は、`get-snapshot-block-public-access-state` を使用する方法を示しています。 **AWS CLI** **スナップショットのパブリックアクセスブロックの現在の状態を取得するには** 次の `get-snapshot-block-public-access-state` の例では、スナップショットのパブリックアクセスブロックの現在の状態を取得します。 ``` aws ec2 get-snapshot-block-public-access-state ``` 出力: ``` { "State": "block-all-sharing" } ``` 詳細については、「*Amazon EBS ユーザーガイド*」の「[Block public access for snapshots](https://docs.aws.amazon.com/ebs/latest/userguide/block-public-access-snapshots.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetSnapshotBlockPublicAccessState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-snapshot-block-public-access-state.html)」を参照してください。 ### `get-spot-placement-scores` 次のコード例は、`get-spot-placement-scores` を使用する方法を示しています。 **AWS CLI** **指定された要件のスポットプレイスメントスコアを計算するには** 次の `get-spot-placement-scores` の例では、`--generate-cli-skeleton` パラメータを使用してスポットプレイスメントスコア設定に指定できるすべてのパラメータのリストを先に生成してから、そのリストを JSON ファイルに保存します。次に、JSON ファイルを使用して、スポットプレイスメントスコアの計算に使用する要件を設定します。 スポットプレイスメントスコア設定に指定できるすべてのパラメータを生成し、出力を JSON ファイルに直接保存します。 ``` aws ec2 get-spot-placement-scores \ --region us-east-1 \ --generate-cli-skeleton input > attributes.json ``` 出力: ``` { "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": "" } ``` JSON ファイルを設定します。`TargetCapacity` の値を指定する必要があります。各パラメータとそのデフォルト値の説明については、「スポットプレイスメントスコアを計算する (AWS CLI) 」を参照してください。 `attributes.json` で指定された要件のスポットプレイスメントスコアを計算します。`--cli-input-json` パラメータを使用して、JSON ファイルの名前とパスを指定します。 ``` aws ec2 get-spot-placement-scores \ --region us-east-1 \ --cli-input-json file://attributes.json ``` `SingleAvailabilityZone` が `false` に設定されているか、省略されている場合は出力します (省略されている場合、デフォルトで `false` になります)。リージョンのスコアリストが返されます。 ``` "Recommendation": [ { "Region": "us-east-1", "Score": 7 }, { "Region": "us-west-1", "Score": 5 }, ... ``` `SingleAvailabilityZone` が `true` に設定されている場合は出力します。SingleAvailability Zones のスコアリストが返されます。 ``` "Recommendation": [ { "Region": "us-east-1", "AvailabilityZoneId": "use1-az1" "Score": 8 }, { "Region": "us-east-1", "AvailabilityZoneId": "usw2-az3" "Score": 6 }, ... ``` スポットプレイスメントスコアの計算の詳細について、および設定例については、「*Amazon EC2 ユーザーガイド*」の「[Calculate a Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html#work-with-spot-placement-score)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetSpotPlacementScores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-spot-placement-scores.html)」を参照してください。 ### `get-subnet-cidr-reservations` 次のコード例は、`get-subnet-cidr-reservations` を使用する方法を示しています。 **AWS CLI** **サブネット CIDR 予約に関する情報を取得するには** 次の `get-subnet-cidr-reservations` の例では、指定したサブネット CIDR 予約の情報を表示します。 ``` aws ec2 get-subnet-cidr-reservations \ --subnet-id subnet-03c51e2e6cEXAMPLE ``` 出力: ``` { "SubnetIpv4CidrReservations": [ { "SubnetCidrReservationId": "scr-044f977c4eEXAMPLE", "SubnetId": "subnet-03c51e2e6cEXAMPLE", "Cidr": "10.1.0.16/28", "ReservationType": "prefix", "OwnerId": "123456789012" } ], "SubnetIpv6CidrReservations": [] } ``` 詳細については、*Amazon VPC ユーザーガイド*の[サブネット CIDR の予約](https://docs.aws.amazon.com/vpc/latest/userguide/subnet-cidr-reservation.html)を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetSubnetCidrReservations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-subnet-cidr-reservations.html)」を参照してください。 ### `get-transit-gateway-attachment-propagations` 次のコード例は、`get-transit-gateway-attachment-propagations` を使用する方法を示しています。 **AWS CLI** **指定したリソースアタッチメントがルートを伝播する対象ルートテーブルを一覧表示します** 次の `get-transit-gateway-attachment-propagations` の例では、指定したリソースアタッチメントがルートを伝播するルートテーブルを一覧表示します。 ``` aws ec2 get-transit-gateway-attachment-propagations \ --transit-gateway-attachment-id tgw-attach-09fbd47ddfEXAMPLE ``` 出力: ``` { "TransitGatewayAttachmentPropagations": [ { "TransitGatewayRouteTableId": "tgw-rtb-0882c61b97EXAMPLE", "State": "enabled" } ] } ``` 詳細については、「*Transit Gateways ガイド*」の「[Transit gateway route tables](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetTransitGatewayAttachmentPropagations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-transit-gateway-attachment-propagations.html)」を参照してください。 ### `get-transit-gateway-multicast-domain-associations` 次のコード例は、`get-transit-gateway-multicast-domain-associations` を使用する方法を示しています。 **AWS CLI** **Transit Gateway マルチキャストドメインの関連付けに関する情報を表示するには** 次の `get-transit-gateway-multicast-domain-associations` の例では、指定したマルチキャストドメインの関連付けを返します。 ``` aws ec2 get-transit-gateway-multicast-domain-associations \ --transit-gateway-multicast-domain-id tgw-mcast-domain-0c4905cef7EXAMPLE ``` 出力: ``` { "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" } } ] } ``` 詳細については、*Transit Gateways ガイド*の「[マルチキャストドメイン](https://docs.aws.amazon.com/vpc/latest/tgw/multicast-domains-about.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetTransitGatewayMulticastDomainAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-transit-gateway-multicast-domain-associations.html)」を参照してください。 ### `get-transit-gateway-prefix-list-references` 次のコード例は、`get-transit-gateway-prefix-list-references` を使用する方法を示しています。 **AWS CLI** **Transit Gateway ルートテーブルでプレフィックスリストのリファレンスを取得するには** 次の `get-transit-gateway-prefix-list-references` の例では、指定した Transit Gateway ルートテーブルのプレフィックスリストのリファレンスを取得し、特定のプレフィックスリストの ID でフィルタリングします。 ``` aws ec2 get-transit-gateway-prefix-list-references \ --transit-gateway-route-table-id tgw-rtb-0123456789abcd123 \ --filters Name=prefix-list-id,Values=pl-11111122222222333 ``` 出力: ``` { "TransitGatewayPrefixListReferences": [ { "TransitGatewayRouteTableId": "tgw-rtb-0123456789abcd123", "PrefixListId": "pl-11111122222222333", "PrefixListOwnerId": "123456789012", "State": "available", "Blackhole": false, "TransitGatewayAttachment": { "TransitGatewayAttachmentId": "tgw-attach-aabbccddaabbccaab", "ResourceType": "vpc", "ResourceId": "vpc-112233445566aabbc" } } ] } ``` 詳細については、「*Transit Gateways ガイド*」の「[Prefix list references](https://docs.aws.amazon.com/vpc/latest/tgw/create-prefix-list-reference.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetTransitGatewayPrefixListReferences](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-transit-gateway-prefix-list-references.html)」を参照してください。 ### `get-transit-gateway-route-table-associations` 次のコード例は、`get-transit-gateway-route-table-associations` を使用する方法を示しています。 **AWS CLI** **指定した Transit Gateway ルートテーブルの関連付けに関する情報を取得するには** 次の `get-transit-gateway-route-table-associations` の例では、指定した Transit Gateway ルートテーブルの関連付けに関する情報を表示します。 ``` aws ec2 get-transit-gateway-route-table-associations \ --transit-gateway-route-table-id tgw-rtb-0a823edbdeEXAMPLE ``` 出力: ``` { "Associations": [ { "TransitGatewayAttachmentId": "tgw-attach-09b52ccdb5EXAMPLE", "ResourceId": "vpc-4d7de228", "ResourceType": "vpc", "State": "associating" } ] } ``` 詳細については、「*Transit Gateways ガイド*」の「[Transit gateway route tables](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html#associate-tgw-route-table)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetTransitGatewayRouteTableAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-transit-gateway-route-table-associations.html)」を参照してください。 ### `get-transit-gateway-route-table-propagations` 次のコード例は、`get-transit-gateway-route-table-propagations` を使用する方法を示しています。 **AWS CLI** **指定した Transit Gateway ルートテーブルのルートテーブル伝播に関する情報を取得するには** 次の `get-transit-gateway-route-table-propagations` の例では、指定したルートテーブルのルートテーブル伝播を返します。 ``` aws ec2 get-transit-gateway-route-table-propagations \ --transit-gateway-route-table-id tgw-rtb-002573ed1eEXAMPLE ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Transit Gateways ガイド*」の「[Transit gateway route tables](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetTransitGatewayRouteTablePropagations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-transit-gateway-route-table-propagations.html)」を参照してください。 ### `get-verified-access-endpoint-policy` 次のコード例は、`get-verified-access-endpoint-policy` を使用する方法を示しています。 **AWS CLI** **エンドポイントの Verified Access ポリシーを取得するには** 次の `get-verified-access-endpoint-policy` の例では、指定したエンドポイントの Verified Access ポリシーを取得します。 ``` aws ec2 get-verified-access-endpoint-policy \ --verified-access-endpoint-id vae-066fac616d4d546f2 ``` 出力: ``` { "PolicyEnabled": true, "PolicyDocument": "permit(principal,action,resource)\nwhen {\n context.identity.groups.contains(\"finance\") &&\n context.identity.email_verified == true\n};" } ``` 詳細については、「*AWSVerified Access ユーザーガイド*」の「[Verified Access policies](https://docs.aws.amazon.com/verified-access/latest/ug/auth-policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetVerifiedAccessEndpointPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-verified-access-endpoint-policy.html)」を参照してください。 ### `get-verified-access-group-policy` 次のコード例は、`get-verified-access-group-policy` を使用する方法を示しています。 **AWS CLI** **グループの Verified Access ポリシーを取得するには** 次の `get-verified-access-group-policy` の例では、指定したグループの Verified Access ポリシーを取得します。 ``` aws ec2 get-verified-access-group-policy \ --verified-access-group-id vagr-0dbe967baf14b7235 ``` 出力: ``` { "PolicyEnabled": true, "PolicyDocument": "permit(principal,action,resource)\nwhen {\n context.identity.groups.contains(\"finance\") &&\n context.identity.email_verified == true\n};" } ``` 詳細については、「*AWSVerified Access ユーザーガイド*」の「[Verified Access groups](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetVerifiedAccessGroupPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-verified-access-group-policy.html)」を参照してください。 ### `get-vpn-connection-device-sample-configuration` 次のコード例は、`get-vpn-connection-device-sample-configuration` を使用する方法を示しています。 **AWS CLI** **サンプル設定ファイルをダウンロードするには** 次の `get-vpn-connection-device-sample-configuration` の例では、指定したサンプル設定ファイルをダウンロードします。サンプル設定ファイルを使用してゲートウェイデバイスを一覧表示するには、`get-vpn-connection-device-types` コマンドを呼び出します。 ``` aws ec2 get-vpn-connection-device-sample-configuration \ --vpn-connection-id vpn-123456789abc01234 \ --vpn-connection-device-type-id 5fb390ba ``` 出力: ``` { "VpnConnectionDeviceSampleConfiguration": "contents-of-the-sample-configuration-file" } ``` 詳細については、「*AWS Site-to-Site VPN ユーザーガイド*」の「[Download the configuration file](https://docs.aws.amazon.com/vpn/latest/s2svpn/SetUpVPNConnections.html#vpn-download-config)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetVpnConnectionDeviceSampleConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-vpn-connection-device-sample-configuration.html)」を参照してください。 ### `get-vpn-connection-device-types` 次のコード例は、`get-vpn-connection-device-types` を使用する方法を示しています。 **AWS CLI** **サンプル設定ファイルを使用してゲートウェイデバイスを一覧表示するには** 次の `get-vpn-connection-device-types` の例では、サンプル設定ファイルを持つ Palo Alto Networks からのゲートウェイデバイスを一覧表示します。 ``` aws ec2 get-vpn-connection-device-types \ --query "VpnConnectionDeviceTypes[?Vendor==`Palo Alto Networks`]" ``` 出力: ``` [ { "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+" } ] ``` 詳細については、「*AWS Site-to-Site VPN ユーザーガイド*」の「[Download the configuration file](https://docs.aws.amazon.com/vpn/latest/s2svpn/SetUpVPNConnections.html#vpn-download-config)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetVpnConnectionDeviceTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/get-vpn-connection-device-types.html)」を参照してください。 ### `import-client-vpn-client-certificate-revocation-list` 次のコード例は、`import-client-vpn-client-certificate-revocation-list` を使用する方法を示しています。 **AWS CLI** **クライアント証明書失効リストをインポートするには** 次の `import-client-vpn-client-certificate-revocation-list` の例では、ローカルコンピュータ上のファイルの場所を指定して、クライアント証明書失効リストをクライアント VPN エンドポイントにインポートします。 ``` aws ec2 import-client-vpn-client-certificate-revocation-list \ --certificate-revocation-list file:///path/to/crl.pem \ --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde ``` 出力: ``` { "Return": true } ``` 詳細については、「*AWS Client VPN 管理者ガイド*」の「[Client Certificate Revocation Lists](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-certificates.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ImportClientVpnClientCertificateRevocationList](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/import-client-vpn-client-certificate-revocation-list.html)」を参照してください。 ### `import-image` 次のコード例は、`import-image` を使用する方法を示しています。 **AWS CLI** **VM イメージファイルを AMI としてインポートするには** 次の `import-image` の例では、指定した OVA をインポートします。 ``` aws ec2 import-image \ --disk-containers Format=ova,UserBucket="{S3Bucket=my-import-bucket,S3Key=vms/my-server-vm.ova}" ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ImportImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/import-image.html)」を参照してください。 ### `import-key-pair` 次のコード例は、`import-key-pair` を使用する方法を示しています。 **AWS CLI** **パブリックキーをインポートするには** 最初に、選択したツールを使用してキーペアを生成します。例えば、次の ssh-keygen コマンドを使用します。 コマンド: ``` ssh-keygen -t rsa -C "my-key" -f ~/.ssh/my-key ``` 出力: ``` 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. ... ``` このコマンド例では、指定されたパブリックキーをインポートします。 コマンド: ``` aws ec2 import-key-pair --key-name "my-key" --public-key-material fileb://~/.ssh/my-key.pub ``` 出力: ``` { "KeyName": "my-key", "KeyFingerprint": "1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ImportKeyPair](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/import-key-pair.html)」を参照してください。 ### `import-snapshot` 次のコード例は、`import-snapshot` を使用する方法を示しています。 **AWS CLI** **スナップショットをインポートするには** 次の `import-snapshot` の例では、指定したディスクをスナップショットとしてインポートします。 ``` aws ec2 import-snapshot \ --description "My server VMDK" \ --disk-container Format=VMDK,UserBucket={'S3Bucket=my-import-bucket,S3Key=vms/my-server-vm.vmdk'} ``` 出力: ``` { "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" } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ImportSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/import-snapshot.html)」を参照してください。 ### `list-images-in-recycle-bin` 次のコード例は、`list-images-in-recycle-bin` を使用する方法を示しています。 **AWS CLI** **ごみ箱内のイメージを一覧表示するには** 次の `list-images-in-recycle-bin` の例では、ごみ箱に現在保持されているすべてのイメージを一覧表示します。 ``` aws ec2 list-images-in-recycle-bin ``` 出力: ``` { "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" } ] } ``` 詳細については、*Amazon EBS ユーザーガイド*の「[削除された AMI をごみ箱から復元する](https://docs.aws.amazon.com/ebs/latest/userguide/recycle-bin-working-with-amis.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListImagesInRecycleBin](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/list-images-in-recycle-bin.html)」を参照してください。 ### `list-snapshots-in-recycle-bin` 次のコード例は、`list-snapshots-in-recycle-bin` を使用する方法を示しています。 **AWS CLI** **ごみ箱のスナップショットを表示するには** 次の `list-snapshots-in-recycle-bin` の例では、ごみ箱にあるスナップショットの情報を一覧表示します。この詳細には、スナップショット ID、スナップショットの説明、スナップショットが作成されたボリュームの ID、スナップショットが削除されてごみ箱に入った日時、保持期間が終了する日時などがあります。 ``` aws ec2 list-snapshots-in-recycle-bin \ --snapshot-id snap-01234567890abcdef ``` 出力: ``` { "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" } ] } ``` ごみ箱の詳細については、*Amazon EBS ユーザーガイド*の「[削除されたスナップショットをごみ箱から復元する](https://docs.aws.amazon.com/ebs/latest/userguide/recycle-bin-working-with-snaps.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListSnapshotsInRecycleBin](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/list-snapshots-in-recycle-bin.html)」を参照してください。 ### `lock-snapshot` 次のコード例は、`lock-snapshot` を使用する方法を示しています。 **AWS CLI** **例 1: ガバナンスモードでスナップショットをロックするには** 次の `lock-snapshot` の例では、指定したスナップショットをガバナンスモードでロックします。 ``` aws ec2 lock-snapshot \ --snapshot-id snap-0b5e733b4a8df6e0d \ --lock-mode governance \ --lock-duration 365 ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon EBS ユーザーガイド*」の「[Snapshot lock](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-snapshot-lock.html)」を参照してください。 **例 2: スナップショットをコンプライアンスモードでロックするには** 次の `lock-snapshot` の例では、指定したスナップショットをコンプライアンスモードでロックします。 ``` aws ec2 lock-snapshot \ --snapshot-id snap-0163a8524c5b9901f \ --lock-mode compliance \ --cool-off-period 24 \ --lock-duration 365 ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon EBS ユーザーガイド*」の「[Snapshot lock](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-snapshot-lock.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[LockSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/lock-snapshot.html)」を参照してください。 ### `modify-address-attribute` 次のコード例は、`modify-address-attribute` を使用する方法を示しています。 **AWS CLI** **Elastic IP アドレスに関連付けられたドメイン名属性を変更するには** 次の `modify-address-attribute` の例では、Elastic IP アドレスのドメイン名の属性を変更します。 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 ``` 出力: ``` { "Addresses": [ { "PublicIp": "192.0.2.0", "AllocationId": "eipalloc-abcdef01234567890", "PtrRecord": "example.net." "PtrRecordUpdate": { "Value": "example.com.", "Status": "PENDING" } ] } ``` 保留中の変更をモニタリングし、Elastic IP アドレスの変更された属性を表示するには、「*AWS CLI コマンドリファレンス*」の「[describe-addresses-attribute](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-addresses-attribute.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyAddressAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-address-attribute.html)」を参照してください。 ### `modify-availability-zone-group` 次のコード例は、`modify-availability-zone-group` を使用する方法を示しています。 **AWS CLI** **ゾーングループを有効にするには** 次の `modify-availability-zone-group` の例では、指定したゾーングループを有効にします。 ``` aws ec2 modify-availability-zone-group \ --group-name us-west-2-lax-1 \ --opt-in-status opted-in ``` 出力: ``` { "Return": true } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[リージョンとゾーン](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyAvailabilityZoneGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-availability-zone-group.html)」を参照してください。 ### `modify-capacity-reservation-fleet` 次のコード例は、`modify-capacity-reservation-fleet` を使用する方法を示しています。 **AWS CLI** **例 1: キャパシティ予約フリートの合計ターゲット容量を変更するには** 次の `modify-capacity-reservation-fleet` の例では、指定したキャパシティ予約フリートの合計ターゲット容量を変更します。キャパシティ予約フリートの総ターゲット容量を変更すると、フリートは、新しい総ターゲット容量を満たすように、自動的に新しいキャパシティ予約を作成したり、フリート内の既存のキャパシティ予約を変更またはキャンセルしたりします。フリートのステータスが `modifying` の間は、他の変更を試みることはできません。 ``` aws ec2 modify-capacity-reservation-fleet \ --capacity-reservation-fleet-id crf-01234567890abcedf \ --total-target-capacity 160 ``` 出力: ``` { "Return": true } ``` **例 2: キャパシティ予約フリートの終了日を変更するには** 次の `modify-capacity-reservation-fleet` の例では、指定したキャパシティ予約フリートの終了日を変更します。フリートの終了日を変更すると、個々のキャパシティ予約の終了日もそれに応じて更新されます。フリートのステータスが `modifying` の間は、他の変更を試みることはできません。 ``` aws ec2 modify-capacity-reservation-fleet \ --capacity-reservation-fleet-id crf-01234567890abcedf \ --end-date 2022-07-04T23:59:59.000Z ``` 出力: ``` { "Return": true } ``` キャパシティ予約フリートの詳細については、「*Amazon EC2 ユーザーガイド*」の「[キャパシティ予約フリート](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-fleets.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyCapacityReservationFleet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-capacity-reservation-fleet.html)」を参照してください。 ### `modify-capacity-reservation` 次のコード例は、`modify-capacity-reservation` を使用する方法を示しています。 **AWS CLI** **例 1: 既存のキャパシティ予約で予約されたインスタンスの数を変更するには** 次の `modify-capacity-reservation` の例では、キャパシティ予約でキャパシティを予約するインスタンスの合計数を変更します。 ``` aws ec2 modify-capacity-reservation \ --capacity-reservation-id cr-1234abcd56EXAMPLE \ --instance-count 5 ``` 出力: ``` { "Return": true } ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[キャパシティ予約の変更](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-modify.html)」を参照してください。 **例 2: 既存のキャパシティ予約の終了日時を変更するには** 次の `modify-capacity-reservation` の例では、指定した日時に既存のキャパシティ予約が終了するように変更します。 ``` aws ec2 modify-capacity-reservation \ --capacity-reservation-id cr-1234abcd56EXAMPLE \ --end-date-type limited \ --end-date 2019-08-31T23:59:59Z ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[キャパシティ予約の変更](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-modify.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyCapacityReservation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-capacity-reservation.html)」を参照してください。 ### `modify-client-vpn-endpoint` 次のコード例は、`modify-client-vpn-endpoint` を使用する方法を示しています。 **AWS CLI** **クライアント VPN エンドポイントを変更するには** 次の `modify-client-vpn-endpoint` の例では、指定したクライアント VPN エンドポイントのクライアント接続を有効にします。 ``` aws ec2 modify-client-vpn-endpoint \ --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ --connection-log-options Enabled=true,CloudwatchLogGroup=ClientVPNLogs ``` 出力: ``` { "Return": true } ``` 詳細については、「*AWS Client VPN 管理者ガイド*」の「[Client VPN Endpoints](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-endpoints.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyClientVpnEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-client-vpn-endpoint.html)」を参照してください。 ### `modify-default-credit-specification` 次のコード例は、`modify-default-credit-specification` を使用する方法を示しています。 **AWS CLI** **デフォルトのクレジットオプションを変更するには** 次の `modify-default-credit-specification` の例では、T2 インスタンスのデフォルトのクレジットオプションを変更します。 ``` aws ec2 modify-default-credit-specification \ --instance-family t2 \ --cpu-credits unlimited ``` 出力: ``` { "InstanceFamilyCreditSpecification": { "InstanceFamily": "t2", "CpuCredits": "unlimited" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyDefaultCreditSpecification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-default-credit-specification.html)」を参照してください。 ### `modify-ebs-default-kms-key-id` 次のコード例は、`modify-ebs-default-kms-key-id` を使用する方法を示しています。 **AWS CLI** **EBS 暗号化用のデフォルトの CMK を設定するには** 次の `modify-ebs-default-kms-key-id` の例では、現在のリージョン内にある AWS アカウントの EBS 暗号化に対するデフォルトの CMK として、指定した CMK を設定します。 ``` aws ec2 modify-ebs-default-kms-key-id \ --kms-key-id alias/my-cmk ``` 出力: ``` { "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/0ea3fef3-80a7-4778-9d8c-1c0c6EXAMPLE" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyEbsDefaultKmsKeyId](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-ebs-default-kms-key-id.html)」を参照してください。 ### `modify-fleet` 次のコード例は、`modify-fleet` を使用する方法を示しています。 **AWS CLI** **EC2 フリートをスケールするには** 次の `modify-fleet` の例では、指定した EC2 フリートのターゲット容量を変更します。指定された値が現在の容量より大きい場合、EC2 フリートは追加のインスタンスを起動します。指定された値が現在の容量よりも小さい場合、EC2 フリートは未完了のリクエストをキャンセルし、終了ポリシーが `terminate` の場合、EC2 フリートは新しいターゲット容量を超えるインスタンスをすべて終了します。 ``` aws ec2 modify-fleet \ --fleet-ids fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE \ --target-capacity-specification TotalTargetCapacity=5 ``` 出力: ``` { "Return": true } ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[EC2 フリートの管理](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyFleet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-fleet.html)」を参照してください。 ### `modify-fpga-image-attribute` 次のコード例は、`modify-fpga-image-attribute` を使用する方法を示しています。 **AWS CLI** **Amazon FPGA イメージの属性を変更するには** この例では、指定された AFI のアカウント ID `123456789012` にロード許可を追加します。 コマンド: ``` aws ec2 modify-fpga-image-attribute --attribute loadPermission --fpga-image-id afi-0d123e123bfc85abc --load-permission Add=[{UserId=123456789012}] ``` 出力: ``` { "FpgaImageAttribute": { "FpgaImageId": "afi-0d123e123bfc85abc", "LoadPermissions": [ { "UserId": "123456789012" } ] } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyFpgaImageAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-fpga-image-attribute.html)」を参照してください。 ### `modify-hosts` 次のコード例は、`modify-hosts` を使用する方法を示しています。 **AWS CLI** **例 1: 専有ホストの自動配置を有効にするには** 次の `modify-hosts` の例では、インスタンスタイプ設定が一致するすべてのターゲット未指定のインスタンス起動を受け入れるため、専有ホストの自動配置を有効にします。 ``` aws ec2 modify-hosts \ --host-id h-06c2f189b4EXAMPLE \ --auto-placement on ``` 出力: ``` { "Successful": [ "h-06c2f189b4EXAMPLE" ], "Unsuccessful": [] } ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[専有ホストの自動配置設定の変更](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/modify-host-auto-placement.html)」を参照してください。 **例 2: 専有ホストのホストリカバリを有効にするには** 次の `modify-hosts` の例では、指定した専有ホストのホストの復旧を有効にします。 ``` aws ec2 modify-hosts \ --host-id h-06c2f189b4EXAMPLE \ --host-recovery on ``` 出力: ``` { "Successful": [ "h-06c2f189b4EXAMPLE" ], "Unsuccessful": [] } ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[専有ホストの自動配置設定の変更](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/modify-host-auto-placement.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyHosts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-hosts.html)」を参照してください。 ### `modify-id-format` 次のコード例は、`modify-id-format` を使用する方法を示しています。 **AWS CLI** **リソースの長い ID 形式を有効にするには** 次の `modify-id-format` の例では、`instance` リソースタイプの長い ID 形式を有効にします。 ``` aws ec2 modify-id-format \ --resource instance \ --use-long-ids ``` **リソースの長い ID 形式を無効にするには** 次の `modify-id-format` の例では、`instance` リソースタイプの長い ID 形式を無効にします。 ``` aws ec2 modify-id-format \ --resource instance \ --no-use-long-ids ``` 次の `modify-id-format` の例では、オプトイン期間内にあるすべてのサポート対象リソースタイプの長い ID 形式を有効にします。 ``` aws ec2 modify-id-format \ --resource all-current \ --use-long-ids ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyIdFormat](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-id-format.html)」を参照してください。 ### `modify-identity-id-format` 次のコード例は、`modify-identity-id-format` を使用する方法を示しています。 **AWS CLI** **IAM ロールを有効にして、リソースの長い ID を使用するには** 次の `modify-identity-id-format` の例では、AWS アカウントの IAM ロール `EC2Role` が `instance` リソースタイプの長い ID 形式を使用できるようにします。 ``` aws ec2 modify-identity-id-format \ --principal-arn arn:aws:iam::123456789012:role/EC2Role \ --resource instance \ --use-long-ids ``` **IAM ユーザーを有効にして、リソースの長い ID を使用するには** 次の `modify-identity-id-format` の例では、AWS アカウントの IAM ユーザー `AdminUser` が `volume` リソースタイプの長い ID 形式を使用できるようにします。 ``` aws ec2 modify-identity-id-format \ --principal-arn arn:aws:iam::123456789012:user/AdminUser \ --resource volume \ --use-long-ids ``` 次の `modify-identity-id-format` の例では、AWS アカウントの IAM ユーザー `AdminUser` が、オプトイン期間内にあるすべてのサポート対象リソースタイプの長い ID 形式を使用できるようにします。 ``` aws ec2 modify-identity-id-format \ --principal-arn arn:aws:iam::123456789012:user/AdminUser \ --resource all-current \ --use-long-ids ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyIdentityIdFormat](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-identity-id-format.html)」を参照してください。 ### `modify-image-attribute` 次のコード例は、`modify-image-attribute` を使用する方法を示しています。 **AWS CLI** **例 1: AMI をパブリックにするには** 次の `modify-instance-attribute` の例では、指定した AMI を公開します。 ``` aws ec2 modify-image-attribute \ --image-id ami-5731123e \ --launch-permission "Add=[{Group=all}]" ``` このコマンドでは何も出力されません。 **例 2: AMI をプライベートにするには** 次の `modify-instance-attribute` の例では、指定した AMI を非公開にします。 ``` aws ec2 modify-image-attribute \ --image-id ami-5731123e \ --launch-permission "Remove=[{Group=all}]" ``` このコマンドでは何も出力されません。 **例 3: AWS アカウントに起動許可を付与するには** 次の `modify-instance-attribute` の例では、指定した AWS アカウントに起動許可を付与します。 ``` aws ec2 modify-image-attribute \ --image-id ami-5731123e \ --launch-permission "Add=[{UserId=123456789012}]" ``` このコマンドでは何も出力されません。 **例 4: AWS アカウントから起動許可を削除するには** 次の `modify-instance-attribute` の例では、指定した AWS アカウントから起動許可を削除します。 ``` aws ec2 modify-image-attribute \ --image-id ami-5731123e \ --launch-permission "Remove=[{UserId=123456789012}]" ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyImageAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-image-attribute.html)」を参照してください。 ### `modify-instance-attribute` 次のコード例は、`modify-instance-attribute` を使用する方法を示しています。 **AWS CLI** **例 1: インスタンスタイプを変更するには** 次の `modify-instance-attribute` の例では、指定したインスタンスのインスタンスタイプを変更します。インスタンスは `stopped` の状態である必要があります。 ``` aws ec2 modify-instance-attribute \ --instance-id i-1234567890abcdef0 \ --instance-type "{\"Value\": \"m1.small\"}" ``` このコマンドでは何も出力されません。 **例 2: インスタンスで拡張ネットワーキングを有効にするには** 次の `modify-instance-attribute` の例では、指定されたインスタンスの拡張ネットワーキングを有効にします。インスタンスは `stopped` の状態である必要があります。 ``` aws ec2 modify-instance-attribute \ --instance-id i-1234567890abcdef0 \ --sriov-net-support simple ``` このコマンドでは何も出力されません。 **例 3: sourceDestCheck 属性を変更するには** 次の `modify-instance-attribute` の例では、指定したインスタンスの `sourceDestCheck` 属性を `true` に設定します。インスタンスは VPC にある必要があります。 ``` aws ec2 modify-instance-attribute --instance-id i-1234567890abcdef0 --source-dest-check "{\"Value\": true}" ``` このコマンドでは何も出力されません。 **例 4: ルートボリュームの deleteOnTermination 属性を変更するには** 次の `modify-instance-attribute` の例では、指定した Amazon EBS-backed インスタンスのルートボリュームに対する `deleteOnTermination` 属性を `false` に設定します。デフォルトでは、この属性はルートボリュームに対して `true` です。 コマンド: ``` aws ec2 modify-instance-attribute \ --instance-id i-1234567890abcdef0 \ --block-device-mappings "[{\"DeviceName\": \"/dev/sda1\",\"Ebs\":{\"DeleteOnTermination\":false}}]" ``` このコマンドでは何も出力されません。 **例 5: インスタンスにアタッチされたユーザーデータを変更するには** 次の `modify-instance-attribute` の例では、指定したインスタンスの UserData としてファイル `UserData.txt` の内容を追加します。 元のファイル `UserData.txt` の内容: ``` #!/bin/bash yum update -y service httpd start chkconfig httpd on ``` ファイルの内容は、base64 でエンコードされている必要があります。最初のコマンドはテキストファイルを base64 に変換し、新しいファイルとして保存します。 コマンドの Linux/macOS バージョン: ``` base64 UserData.txt > UserData.base64.txt ``` このコマンドでは何も出力されません。 コマンドの Windows バージョン: ``` certutil -encode UserData.txt tmp.b64 && findstr /v /c:- tmp.b64 > UserData.base64.txt ``` 出力: ``` Input Length = 67 Output Length = 152 CertUtil: -encode command completed successfully. ``` これで、次の CLI コマンドでそのファイルを参照できるようになりました。 ``` aws ec2 modify-instance-attribute \ --instance-id=i-09b5a14dbca622e76 \ --attribute userData --value file://UserData.base64.txt ``` このコマンドでは何も出力されません。 詳細については、「*EC2 ユーザーガイド*」の「[ユーザーデータと AWS CLI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html#user-data-api-cli)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyInstanceAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-instance-attribute.html)」を参照してください。 ### `modify-instance-capacity-reservation-attributes` 次のコード例は、`modify-instance-capacity-reservation-attributes` を使用する方法を示しています。 **AWS CLI** **例 1: インスタンスのキャパシティ予約のターゲット設定を変更するには** 次の `modify-instance-capacity-reservation-attributes` の例では、特定のキャパシティ予約をターゲットにするようにインスタンスを変更します。 ``` aws ec2 modify-instance-capacity-reservation-attributes \ --instance-id i-EXAMPLE8765abcd4e \ --capacity-reservation-specification 'CapacityReservationTarget={CapacityReservationId= cr-1234abcd56EXAMPLE }' ``` 出力: ``` { "Return": true } ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[インスタンスのキャパシティ予約設定を変更する](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-modify-instance.html)」を参照してください。 **例 2: インスタンスのキャパシティ予約のターゲット設定を変更するには** 次の `modify-instance-capacity-reservation-attributes` の例では、指定したキャパシティ予約をターゲットとする停止されたインスタンスを変更して、一致する属性 (インスタンスタイプ、プラットフォーム、アベイラビリティーゾーン) を持つキャパシティ予約、およびオープンインスタンスの一致基準を持つキャパシティ予約で起動するようにします。 ``` aws ec2 modify-instance-capacity-reservation-attributes \ --instance-id i-EXAMPLE8765abcd4e \ --capacity-reservation-specification 'CapacityReservationPreference=open' ``` 出力: ``` { "Return": true } ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[インスタンスのキャパシティ予約設定を変更する](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-modify-instance.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyInstanceCapacityReservationAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-instance-capacity-reservation-attributes.html)」を参照してください。 ### `modify-instance-credit-specification` 次のコード例は、`modify-instance-credit-specification` を使用する方法を示しています。 **AWS CLI** **インスタンスの CPU 使用率に対するクレジットオプションを変更するには** この例では、指定されたリージョン内にある指定されたインスタンスの CPU 使用率のクレジットオプションを「無制限」に変更します。有効なクレジットオプションは、「標準」と「無制限」です。 コマンド: ``` aws ec2 modify-instance-credit-specification --instance-credit-specification "InstanceId=i-1234567890abcdef0,CpuCredits=unlimited" ``` 出力: ``` { "SuccessfulInstanceCreditSpecifications": [ { "InstanceId": "i-1234567890abcdef0" } ], "UnsuccessfulInstanceCreditSpecifications": [] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyInstanceCreditSpecification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-instance-credit-specification.html)」を参照してください。 ### `modify-instance-event-start-time` 次のコード例は、`modify-instance-event-start-time` を使用する方法を示しています。 **AWS CLI** **インスタンスのイベント開始時刻を変更するには** 次の `modify-instance-event-start-time` コマンドは、指定したインスタンスのイベント開始時刻を変更する方法を示します。`--instance-event-id` パラメータを使用してイベント ID を指定します。`--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 ``` 出力: ``` "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" } ``` 詳細については、「*Amazon Elastic Compute Cloud ユーザーガイド*」の「Working with Instances Scheduled for Reboot」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyInstanceEventStartTime](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-instance-event-start-time.html)」を参照してください。 ### `modify-instance-event-window` 次のコード例は、`modify-instance-event-window` を使用する方法を示しています。 **AWS CLI** **例 1: イベントウィンドウの時間範囲を変更するには** 次の `modify-instance-event-window` の例では、イベントウィンドウの時間範囲を変更します。`time-range` パラメータにより時間範囲を変更します。また、`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 ``` 出力: ``` { "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" } ] } } ``` イベントウィンドウの制約については、「*Amazon EC2 ユーザーガイド*」の予定されているイベントに関するセクションの「[考慮事項](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html#event-windows-considerations)」を参照してください。 **例 2: イベントウィンドウの時間範囲セットを変更するには** 次の `modify-instance-event-window` の例では、イベントウィンドウの時間範囲を変更します。`time-range` パラメータにより時間範囲を変更します。また、`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}]' ``` 出力: ``` { "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" } ] } } ``` イベントウィンドウの制約については、「*Amazon EC2 ユーザーガイド*」の予定されているイベントに関するセクションの「[考慮事項](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html#event-windows-considerations)」を参照してください。 **例 3: イベントウィンドウの cron 式を変更するには** 次の `modify-instance-event-window` の例では、イベントウィンドウの cron 式を変更します。`cron-expression` パラメータにより cron 式を変更します。また、`time-range` パラメータを指定することはできません。 ``` aws ec2 modify-instance-event-window \ --region us-east-1 \ --instance-event-window-id iew-0abcdef1234567890 \ --cron-expression "* 21-23 * * 2,3" ``` 出力: ``` { "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" } ] } } ``` イベントウィンドウの制約については、「*Amazon EC2 ユーザーガイド*」の予定されているイベントに関するセクションの「[考慮事項](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html#event-windows-considerations)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyInstanceEventWindow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-instance-event-window.html)」を参照してください。 ### `modify-instance-maintenance-options` 次のコード例は、`modify-instance-maintenance-options` を使用する方法を示しています。 **AWS CLI** **例 1: インスタンスの復旧動作を無効にするには** 次の `modify-instance-maintenance-options` の例では、実行中または停止中のインスタンスの簡素化された自動復旧を無効にします。 ``` aws ec2 modify-instance-maintenance-options \ --instance-id i-0abcdef1234567890 \ --auto-recovery disabled ``` 出力: ``` { "InstanceId": "i-0abcdef1234567890", "AutoRecovery": "disabled" } ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[簡易自動復旧を設定する](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-configuration-recovery.html)」を参照してください。 **例 2: インスタンスの復旧動作をデフォルトに設定するには** 次の `modify-instance-maintenance-options` の例では、自動復旧動作をデフォルトに設定し、サポートされているインスタンスタイプの簡素化された自動復旧を有効にします。 ``` aws ec2 modify-instance-maintenance-options \ --instance-id i-0abcdef1234567890 \ --auto-recovery default ``` 出力: ``` { "InstanceId": "i-0abcdef1234567890", "AutoRecovery": "default" } ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[簡易自動復旧を設定する](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-configuration-recovery.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyInstanceMaintenanceOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-instance-maintenance-options.html)」を参照してください。 ### `modify-instance-metadata-options` 次のコード例は、`modify-instance-metadata-options` を使用する方法を示しています。 **AWS CLI** **例 1: IMDSv2 を有効にするには** 次の `modify-instance-metadata-options` の例では、指定したインスタンスでの IMDSv2 の使用を設定します。 ``` aws ec2 modify-instance-metadata-options \ --instance-id i-1234567898abcdef0 \ --http-tokens required \ --http-endpoint enabled ``` 出力: ``` { "InstanceId": "i-1234567898abcdef0", "InstanceMetadataOptions": { "State": "pending", "HttpTokens": "required", "HttpPutResponseHopLimit": 1, "HttpEndpoint": "enabled" } } ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[インスタンスメタデータ](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html)」を参照してください。 **例 2: インスタンスメタデータを無効にするには** 次の `modify-instance-metadata-options` の例では、指定したインスタンスですべてのバージョンのインスタンスメタデータの使用を無効にします。 ``` aws ec2 modify-instance-metadata-options \ --instance-id i-1234567898abcdef0 \ --http-endpoint disabled ``` 出力: ``` { "InstanceId": "i-1234567898abcdef0", "InstanceMetadataOptions": { "State": "pending", "HttpTokens": "required", "HttpPutResponseHopLimit": 1, "HttpEndpoint": "disabled" } } ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[インスタンスメタデータ](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html)」を参照してください。 **例 3: インスタンスのインスタンスメタデータ IPv6 エンドポイントを有効にするには** 次の `modify-instance-metadata-options` の例では、インスタンスメタデータサービスの IPv6 エンドポイントを有効にする方法を示します。デフォルトでは、IPv6 エンドポイントは無効です。これは、インスタンスを IPv6 専用サブネットで起動した場合にも当てはまります。IMDS の IPv6 エンドポイントは、Nitro System 上に構築されたインスタンスでのみアクセス可能です。 ``` aws ec2 modify-instance-metadata-options \ --instance-id i-1234567898abcdef0 \ --http-protocol-ipv6 enabled \ --http-endpoint enabled ``` 出力: ``` { "InstanceId": "i-1234567898abcdef0", "InstanceMetadataOptions": { "State": "pending", "HttpTokens": "required", "HttpPutResponseHopLimit": 1, "HttpEndpoint": "enabled", HttpProtocolIpv6": "enabled" } } ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[インスタンスメタデータ](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyInstanceMetadataOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-instance-metadata-options.html)」を参照してください。 ### `modify-instance-placement` 次のコード例は、`modify-instance-placement` を使用する方法を示しています。 **AWS CLI** **例 1: 専有ホストとのインスタンスのアフィニティを削除するには** 次の `modify-instance-placement` の例では、専有ホストとのインスタンスのアフィニティを削除し、そのインスタンスタイプをサポートするアカウントで使用可能な専有ホストで起動できるようにします。 ``` aws ec2 modify-instance-placement \ --instance-id i-0e6ddf6187EXAMPLE \ --affinity default ``` 出力: ``` { "Return": true } ``` **例 2: インスタンスと指定された専有ホスト間のアフィニティを確立するには** 次の `modify-instance-placement` の例では、インスタンスと専有ホストの間に起動関係を確立します。インスタンスは、指定された専有ホストでのみ実行できます。 ``` aws ec2 modify-instance-placement \ --instance-id i-0e6ddf6187EXAMPLE \ --affinity host \ --host-id i-0e6ddf6187EXAMPLE ``` 出力: ``` { "Return": true } ``` **例 3: プレイスメントグループにインスタンスを移動するには** 次の `modify-instance-placement` の例では、インスタンスをプレイスメントグループに移動してインスタンスを停止し、インスタンスの配置を変更してからインスタンスを再起動します。 ``` 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 ``` **例 4: プレイスメントグループからインスタンスを削除するには** 次の `modify-instance-placement` の例では、インスタンスを停止し、インスタンスの配置を変更してからインスタンスを再起動して、インスタンスをプレイスメントグループから削除します。次の例では、プレイスメントグループ名に空の文字列 ("") を指定すると、インスタンスがプレイスメントグループに配置されないことを示しています。 インスタンスを停止する ``` aws ec2 stop-instances \ --instance-ids i-0123a456700123456 ``` 配置を変更する (Windows コマンドプロンプト): ``` aws ec2 modify-instance-placement \ --instance-id i-0123a456700123456 \ --group-name "" ``` 配置を変更する (Windows PowerShell、Linux、macOS): ``` aws ec2 modify-instance-placement ` --instance-id i-0123a456700123456 ` --group-name '' ``` インスタンスを再起動します: ``` aws ec2 start-instances \ --instance-ids i-0123a456700123456 ``` 出力: ``` { "Return": true } ``` 詳細については、*Amazon EC2 ユーザーガイド*の「[専有ホストのテナンシーとアフィニティを変更する](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/moving-instances-dedicated-hosts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyInstancePlacement](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-instance-placement.html)」を参照してください。 ### `modify-ipam-pool` 次のコード例は、`modify-ipam-pool` を使用する方法を示しています。 **AWS CLI** **IPAM プールを変更するには** 次の `modify-ipam-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 ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[Edit a pool](https://docs.aws.amazon.com/vpc/latest/ipam/mod-pool-ipam.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyIpamPool](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-ipam-pool.html)」を参照してください。 ### `modify-ipam-resource-cidr` 次のコード例は、`modify-ipam-resource-cidr` を使用する方法を示しています。 **AWS CLI** **リソースに割り当てられた CIDR を変更するには** 次の `modify-ipam-resource-cidr` の例では、リソース CIDR を変更します。 (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 ``` 出力: ``` { "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" } } ``` リソースの移動の詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[Move resource CIDRs between scopes](https://docs.aws.amazon.com/vpc/latest/ipam/move-resource-ipam.html)」を参照してください。 モニタリング状態の変更の詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[Change the monitoring state of resource CIDRs](https://docs.aws.amazon.com/vpc/latest/ipam/change-monitoring-state-ipam.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyIpamResourceCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-ipam-resource-cidr.html)」を参照してください。 ### `modify-ipam-resource-discovery` 次のコード例は、`modify-ipam-resource-discovery` を使用する方法を示しています。 **AWS CLI** **リソース検出の運用リージョンを変更するには** この例では、あなたは IPAM の委任された管理者として、リソース検出の運用リージョンを変更したいと考えています。 このリクエストを完了するには: デフォルトのリソース検出を変更することはできません。また、リソース検出の所有者である必要があります。[describe-ipam-resource-discoveries](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-ipam-resource-discoveries.html) で取得できるリソース検出 ID が必要です。 次の `modify-ipam-resource-discovery` の例では、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 ``` 出力: ``` { "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" } } ``` 詳細については、「**Amazon VPC IPAM ユーザーズガイド」の「[リソース検出を使用する](https://docs.aws.amazon.com/vpc/latest/ipam/res-disc-work-with.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyIpamResourceDiscovery](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-ipam-resource-discovery.html)」を参照してください。 ### `modify-ipam-scope` 次のコード例は、`modify-ipam-scope` を使用する方法を示しています。 **AWS CLI** **範囲の説明を変更するには** このシナリオでは、あなたは IPAM の委任された管理者として、IPAM スコープの説明を変更したいと考えています。 このリクエストを完了するには、[describe-ipam-scopes](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-ipam-scopes.html) で取得できるスコープ ID が必要です。 次の `modify-ipam-scope` の例では、範囲の説明を更新します。 ``` aws ec2 modify-ipam-scope \ --ipam-scope-id ipam-scope-0d3539a30b57dcdd1 \ --description example \ --region us-east-1 ``` 出力: ``` { "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" } } ``` スコープの詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[How IPAM works](https://docs.aws.amazon.com/vpc/latest/ipam/how-it-works-ipam.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyIpamScope](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-ipam-scope.html)」を参照してください。 ### `modify-ipam` 次のコード例は、`modify-ipam` を使用する方法を示しています。 **AWS CLI** **IPAM を変更するには** 次の `modify-ipam` の例では、運用リージョンを追加して IPAM を変更します。 (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 ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyIpam](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-ipam.html)」を参照してください。 ### `modify-launch-template` 次のコード例は、`modify-launch-template` を使用する方法を示しています。 **AWS CLI** **デフォルトの起動テンプレートのバージョンを変更するには** この例では、指定された起動テンプレートのバージョン 2 をデフォルトバージョンとして指定します。 コマンド: ``` aws ec2 modify-launch-template --launch-template-id lt-0abcd290751193123 --default-version 2 ``` 出力: ``` { "LaunchTemplate": { "LatestVersionNumber": 2, "LaunchTemplateId": "lt-0abcd290751193123", "LaunchTemplateName": "WebServers", "DefaultVersionNumber": 2, "CreatedBy": "arn:aws:iam::123456789012:root", "CreateTime": "2017-12-01T13:35:46.000Z" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyLaunchTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-launch-template.html)」を参照してください。 ### `modify-managed-prefix-list` 次のコード例は、`modify-managed-prefix-list` を使用する方法を示しています。 **AWS CLI** **プレフィックスリストを変更するには** 次の `modify-managed-prefix-list` の例では、指定したプレフィックスリストにエントリを追加します。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon VPC ユーザーガイド*」の「[Managed prefix lists](https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyManagedPrefixList](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-managed-prefix-list.html)」を参照してください。 ### `modify-network-interface-attribute` 次のコード例は、`modify-network-interface-attribute` を使用する方法を示しています。 **AWS CLI** **ネットワークインターフェイスのアタッチメント属性を変更するには** このコマンド例では、指定されたネットワークインターフェイスの `attachment` 属性を変更します。 コマンド: ``` aws ec2 modify-network-interface-attribute --network-interface-id eni-686ea200 --attachment AttachmentId=eni-attach-43348162,DeleteOnTermination=false ``` **ネットワークインターフェイスの説明属性を変更するには** このコマンド例では、指定されたネットワークインターフェイスの `description` 属性を変更します。 コマンド: ``` aws ec2 modify-network-interface-attribute --network-interface-id eni-686ea200 --description "My description" ``` **ネットワークインターフェイスの groupSet 属性を変更するには** このコマンド例では、指定されたネットワークインターフェイスの `groupSet` 属性を変更します。 コマンド: ``` aws ec2 modify-network-interface-attribute --network-interface-id eni-686ea200 --groups sg-903004f8 sg-1a2b3c4d ``` **ネットワークインターフェイスの sourceDestCheck 属性を変更するには** このコマンド例では、指定されたネットワークインターフェイスの `sourceDestCheck` 属性を変更します。 コマンド: ``` aws ec2 modify-network-interface-attribute --network-interface-id eni-686ea200 --no-source-dest-check ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyNetworkInterfaceAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-network-interface-attribute.html)」を参照してください。 ### `modify-private-dns-name-options` 次のコード例は、`modify-private-dns-name-options` を使用する方法を示しています。 **AWS CLI** **インスタンスホスト名に対するオプションを変更するには** 次の `modify-private-dns-name-options` の例では、DNS A レコードを持つインスタンスホスト名の DNS クエリに応答するオプションを無効にします。 ``` aws ec2 modify-private-dns-name-options \ --instance-id i-1234567890abcdef0 \ --no-enable-resource-name-dns-a-record ``` 出力: ``` { "Return": true } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[Amazon EC2 インスタンスホスト名のタイプ](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyPrivateDnsNameOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-private-dns-name-options.html)」を参照してください。 ### `modify-reserved-instances` 次のコード例は、`modify-reserved-instances` を使用する方法を示しています。 **AWS CLI** **リザーブドインスタンスを変更するには** このコマンド例では、リザーブドインスタンスを同じリージョンにある別のアベイラビリティーゾーンに移動します。 コマンド: ``` aws ec2 modify-reserved-instances --reserved-instances-ids b847fa93-e282-4f55-b59a-1342f5bd7c02 --target-configurations AvailabilityZone=us-west-1c,Platform=EC2-Classic,InstanceCount=10 ``` 出力: ``` { "ReservedInstancesModificationId": "rimod-d3ed4335-b1d3-4de6-ab31-0f13aaf46687" } ``` **リザーブドインスタンスのネットワークプラットフォームを変更するには** このコマンド例では、EC2-Classic リザーブドインスタンスを EC2-VPC に変換します。 コマンド: ``` aws ec2 modify-reserved-instances --reserved-instances-ids f127bd27-edb7-44c9-a0eb-0d7e09259af0 --target-configurations AvailabilityZone=us-west-1c,Platform=EC2-VPC,InstanceCount=5 ``` 出力: ``` { "ReservedInstancesModificationId": "rimod-82fa9020-668f-4fb6-945d-61537009d291" } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「リザーブドインスタンス の変更」を参照してください。 **リザーブドインスタンスのインスタンスサイズを変更するには** このコマンド例では、us-west-1c に 10 個の m1.small Linux/UNIX インスタンスを持つリザーブドインスタンスを変更して、8 個の m1.small インスタンスを 2 個の m1.large インスタンスにし、残りの 2 個の m1.small を同じアベイラビリティーゾーンの 1 個の m1.medium インスタンスにします。コマンド: ``` 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 ``` 出力: ``` { "ReservedInstancesModificationId": "rimod-acc5f240-080d-4717-b3e3-1c6b11fa00b6" } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「Modifying the Instance Size of Your Reservations」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyReservedInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-reserved-instances.html)」を参照してください。 ### `modify-security-group-rules` 次のコード例は、`modify-security-group-rules` を使用する方法を示しています。 **AWS CLI** **セキュリティグループルールを変更して、ルールの説明、IP プロトコル、および CidrIpv4 アドレス範囲を更新するには** 次の `modify-security-group-rules` の例では、指定したセキュリティグループルールの説明、IP プロトコル、IPV4 CIDR 範囲を更新します。`security-group-rules` パラメータを使用して、指定されたセキュリティグループルールの更新を入力します。`-1` はすべてのプロトコルを指定します。 ``` 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}' ``` 出力: ``` { "Return": true } ``` セキュリティグループのルールの詳細については、「*Amazon EC2 ユーザーガイド*」の「[セキュリティグループのルール](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifySecurityGroupRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-security-group-rules.html)」を参照してください。 ### `modify-snapshot-attribute` 次のコード例は、`modify-snapshot-attribute` を使用する方法を示しています。 **AWS CLI** **例 1: スナップショット属性を変更するには** 次の `modify-snapshot-attribute` の例では、指定したスナップショットの `createVolumePermission` 属性を更新し、指定したユーザーのボリュームアクセス許可を削除します。 ``` aws ec2 modify-snapshot-attribute \ --snapshot-id snap-1234567890abcdef0 \ --attribute createVolumePermission \ --operation-type remove \ --user-ids 123456789012 ``` **例 2: スナップショットをパブリックにするには** 次の `modify-snapshot-attribute` の例では、指定したスナップショットを公開します。 ``` aws ec2 modify-snapshot-attribute \ --snapshot-id snap-1234567890abcdef0 \ --attribute createVolumePermission \ --operation-type add \ --group-names all ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifySnapshotAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-snapshot-attribute.html)」を参照してください。 ### `modify-snapshot-tier` 次のコード例は、`modify-snapshot-tier` を使用する方法を示しています。 **AWS CLI** **スナップショットをアーカイブするには** 次の `modify-snapshot-tier` の例では、指定したスナップショットをアーカイブします。`TieringStartTime` レスポンスパラメータは、アーカイブプロセスが開始された日付と時刻を、UTC 時間形式 (YYYY-MM-DDTHH:MM:SSZ) で示します。 ``` aws ec2 modify-snapshot-tier \ --snapshot-id snap-01234567890abcedf \ --storage-tier archive ``` 出力: ``` { "SnapshotId": "snap-01234567890abcedf", "TieringStartTime": "2021-09-15T16:44:37.574Z" } ``` スナップショットのアーカイブの詳細については、*Amazon EBS ユーザーガイド*の「[Amazon EBS スナップショットのアーカイブ](https://docs.aws.amazon.com/ebs/latest/userguide/snapshot-archive.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifySnapshotTier](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-snapshot-tier.html)」を参照してください。 ### `modify-spot-fleet-request` 次のコード例は、`modify-spot-fleet-request` を使用する方法を示しています。 **AWS CLI** **スポットフリートリクエストを変更するには** このコマンド例では、指定されたスポットフリートリクエストのターゲット容量を更新します。 コマンド: ``` aws ec2 modify-spot-fleet-request --target-capacity 20 --spot-fleet-request-id sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE ``` 出力: ``` { "Return": true } ``` このコマンド例では、結果的にいずれのスポットインスタンスも終了せずに、指定したスポットフリートのターゲット容量を減らします。 コマンド: ``` aws ec2 modify-spot-fleet-request --target-capacity 10 --excess-capacity-termination-policy NoTermination --spot-fleet-request-ids sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE ``` 出力: ``` { "Return": true } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifySpotFleetRequest](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-spot-fleet-request.html)」を参照してください。 ### `modify-subnet-attribute` 次のコード例は、`modify-subnet-attribute` を使用する方法を示しています。 **AWS CLI** **サブネットのパブリック IPv4 アドレス指定の動作を変更するには** この例では、subnet-1a2b3c4d を変更して、このサブネットで起動されたすべてのインスタンスにパブリック IPv4 アドレスが割り当てられるように指定します。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 modify-subnet-attribute --subnet-id subnet-1a2b3c4d --map-public-ip-on-launch ``` **サブネットの IPv6 アドレス指定の動作を変更するには** この例では、subnet-1a2b3c4d を変更して、このサブネットで起動されたすべてのインスタンスに、そのサブネットの範囲から IPv6 アドレスが割り当てられるように指定します。 コマンド: ``` aws ec2 modify-subnet-attribute --subnet-id subnet-1a2b3c4d --assign-ipv6-address-on-creation ``` 詳細については、「*AWS Virtual Private Cloud ユーザーガイド*」の「VPC とサブネットの IP アドレス指定」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifySubnetAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-subnet-attribute.html)」を参照してください。 ### `modify-traffic-mirror-filter-network-services` 次のコード例は、`modify-traffic-mirror-filter-network-services` を使用する方法を示しています。 **AWS CLI** **トラフィックミラーフィルターにネットワークサービスを追加するには** 次の `modify-traffic-mirror-filter-network-services` の例では、Amazon DNS ネットワークサービスを指定されたフィルターに追加します。 ``` aws ec2 modify-traffic-mirror-filter-network-services \ --traffic-mirror-filter-id tmf-04812ff784EXAMPLE \ --add-network-service amazon-dns ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*AWS トラフィックミラーリングガイド*」の「[Modify Traffic Mirror Filter Network Services](https://docs.aws.amazon.com/vpc/latest/mirroring/traffic-mirroring-filter.html#modify-traffic-mirroring-filter-network-services)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyTrafficMirrorFilterNetworkServices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-traffic-mirror-filter-network-services.html)」を参照してください。 ### `modify-traffic-mirror-filter-rule` 次のコード例は、`modify-traffic-mirror-filter-rule` を使用する方法を示しています。 **AWS CLI** **トラフィックミラーフィルタールールを変更するには** 次の `modify-traffic-mirror-filter-rule` の例では、指定したトラフィックミラーフィルタールールを変更します。 ``` aws ec2 modify-traffic-mirror-filter-rule \ --traffic-mirror-filter-rule-id tmfr-0ca76e0e08EXAMPLE \ --description "TCP Rule" ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS トラフィックミラーリングガイド*」の「[Modify Your Traffic Mirror Filter Rules](https://docs.aws.amazon.com/vpc/latest/mirroring/traffic-mirroring-filter.html#modify-traffic-mirroring-filter-rules)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyTrafficMirrorFilterRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-traffic-mirror-filter-rule.html)」を参照してください。 ### `modify-traffic-mirror-session` 次のコード例は、`modify-traffic-mirror-session` を使用する方法を示しています。 **AWS CLI** **トラフィックミラーセッションを変更するには** 次の `modify-traffic-mirror-session` の例では、トラフィックミラーセッションの説明とミラーリングするパケットの数を変更します。 ``` aws ec2 modify-traffic-mirror-session \ --description "Change packet length" \ --traffic-mirror-session-id tms-08a33b1214EXAMPLE \ --remove-fields "packet-length" ``` 出力: ``` { "TrafficMirrorSession": { "TrafficMirrorSessionId": "tms-08a33b1214EXAMPLE", "TrafficMirrorTargetId": "tmt-07f75d8feeEXAMPLE", "TrafficMirrorFilterId": "tmf-04812ff784EXAMPLE", "NetworkInterfaceId": "eni-070203f901EXAMPLE", "OwnerId": "111122223333", "SessionNumber": 1, "VirtualNetworkId": 7159709, "Description": "Change packet length", "Tags": [] } } ``` 詳細については、「* トラフィックミラーリングガイド*」の「[Modify your traffic mirror session](https://docs.aws.amazon.com/vpc/latest/mirroring/traffic-mirroring-session.html#modify-traffic-mirroring-session)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyTrafficMirrorSession](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-traffic-mirror-session.html)」を参照してください。 ### `modify-transit-gateway-prefix-list-reference` 次のコード例は、`modify-transit-gateway-prefix-list-reference` を使用する方法を示しています。 **AWS CLI** **プレフィックスリストのリファレンスを変更するには** 次の `modify-transit-gateway-prefix-list-reference` の例では、トラフィックがルーティングされるアタッチメントを変更して、指定されたルートテーブルのプレフィックスリストのリファレンスを変更します。 ``` 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 ``` 出力: ``` { "TransitGatewayPrefixListReference": { "TransitGatewayRouteTableId": "tgw-rtb-0123456789abcd123", "PrefixListId": "pl-11111122222222333", "PrefixListOwnerId": "123456789012", "State": "modifying", "Blackhole": false, "TransitGatewayAttachment": { "TransitGatewayAttachmentId": "tgw-attach-aabbccddaabbccaab", "ResourceType": "vpc", "ResourceId": "vpc-112233445566aabbc" } } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Prefix list references](https://docs.aws.amazon.com/vpc/latest/tgw/create-prefix-list-reference.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyTransitGatewayPrefixListReference](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-transit-gateway-prefix-list-reference.html)」を参照してください。 ### `modify-transit-gateway-vpc-attachment` 次のコード例は、`modify-transit-gateway-vpc-attachment` を使用する方法を示しています。 **AWS CLI** **Transit Gateway VPC アタッチメントを変更するには** 次の `modify-transit-gateway-vpc-attachment` の例では、指定された Transit Gateway VPC アタッチメントにサブネットを追加します。 ``` aws ec2 modify-transit-gateway-vpc-attachment \ --transit-gateway-attachment-id tgw-attach-09fbd47ddfEXAMPLE \ --add-subnet-ids subnet-0e51f45802EXAMPLE ``` 出力: ``` { "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" } } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Transit gateway attachments to a VPC](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-vpc-attachments.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyTransitGatewayVpcAttachment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-transit-gateway-vpc-attachment.html)」を参照してください。 ### `modify-transit-gateway` 次のコード例は、`modify-transit-gateway` を使用する方法を示しています。 **AWS CLI** **Transit Gateway を変更するには** 次の `modify-transit-gateway` の例では、VPN アタッチメントの ECMP サポートを有効にして、指定された Transit Gateway を変更します。 ``` aws ec2 modify-transit-gateway \ --transit-gateway-id tgw-111111222222aaaaa \ --options VpnEcmpSupport=enable ``` 出力: ``` { "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" } } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Transit gateways](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-transit-gateways.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyTransitGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-transit-gateway.html)」を参照してください。 ### `modify-verified-access-endpoint-policy` 次のコード例は、`modify-verified-access-endpoint-policy` を使用する方法を示しています。 **AWS CLI** **エンドポイントの Verified Access ポリシーを設定するには** 次の `modify-verified-access-endpoint-policy` の例では、指定した Verified Access ポリシーを指定した Verified Access エンドポイントに追加します。 ``` aws ec2 modify-verified-access-endpoint-policy \ --verified-access-endpoint-id vae-066fac616d4d546f2 \ --policy-enabled \ --policy-document file://policy.txt ``` `policy.txt` の内容: ``` permit(principal,action,resource) when { context.identity.groups.contains("finance") && context.identity.email.verified == true }; ``` 出力: ``` { "PolicyEnabled": true, "PolicyDocument": "permit(principal,action,resource)\nwhen {\n context.identity.groups.contains(\"finance\") &&\n context.identity.email_verified == true\n};" } ``` 詳細については、「*AWSVerified Access ユーザーガイド*」の「[Verified Access policies](https://docs.aws.amazon.com/verified-access/latest/ug/auth-policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyVerifiedAccessEndpointPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-verified-access-endpoint-policy.html)」を参照してください。 ### `modify-verified-access-endpoint` 次のコード例は、`modify-verified-access-endpoint` を使用する方法を示しています。 **AWS CLI** **Verified Access エンドポイントの設定を変更するには** 次の `modify-verified-access-endpoint` の例では、指定した説明を指定した Verified Access エンドポイントに追加します。 ``` aws ec2 modify-verified-access-endpoint \ --verified-access-endpoint-id vae-066fac616d4d546f2 \ --description 'Testing Verified Access' ``` 出力: ``` { "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" } } ``` 詳細については、「*AWSVerified Access ユーザーガイド*」の「[Verified Access endpoints](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-endpoints.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyVerifiedAccessEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-verified-access-endpoint.html)」を参照してください。 ### `modify-verified-access-group-policy` 次のコード例は、`modify-verified-access-group-policy` を使用する方法を示しています。 **AWS CLI** **グループに Verified Access ポリシーを設定するには** 次の `modify-verified-access-group-policy` の例では、指定した Verified Access ポリシーを指定した Verified Access グループに追加します。 ``` aws ec2 modify-verified-access-group-policy \ --verified-access-group-id vagr-0dbe967baf14b7235 \ --policy-enabled \ --policy-document file://policy.txt ``` `policy.txt` の内容: ``` permit(principal,action,resource) when { context.identity.groups.contains("finance") && context.identity.email.verified == true }; ``` 出力: ``` { "PolicyEnabled": true, "PolicyDocument": "permit(principal,action,resource)\nwhen {\n context.identity.groups.contains(\"finance\") &&\n context.identity.email_verified == true\n};" } ``` 詳細については、「*AWSVerified Access ユーザーガイド*」の「[Verified Access groups](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyVerifiedAccessGroupPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-verified-access-group-policy.html)」を参照してください。 ### `modify-verified-access-group` 次のコード例は、`modify-verified-access-group` を使用する方法を示しています。 **AWS CLI** **Verified Access グループの設定を変更するには** 次の `modify-verified-access-group` の例では、指定した説明を指定した Verified Access グループに追加します。 ``` aws ec2 modify-verified-access-group \ --verified-access-group-id vagr-0dbe967baf14b7235 \ --description "Testing Verified Access" ``` 出力: ``` { "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" } } ``` 詳細については、「*AWSVerified Access ユーザーガイド*」の「[Verified Access groups](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyVerifiedAccessGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-verified-access-group.html)」を参照してください。 ### `modify-verified-access-instance-logging-configuration` 次のコード例は、`modify-verified-access-instance-logging-configuration` を使用する方法を示しています。 **AWS CLI** **Verified Access インスタンスのログ記録を有効にするには** 次の `modify-verified-access-instance-logging-configuration` の例では、指定した Verified Access インスタンスのアクセスロギングを有効にします。ログは、指定された CloudWatch Logs ロググループに配信されます。 ``` aws ec2 modify-verified-access-instance-logging-configuration \ --verified-access-instance-id vai-0ce000c0b7643abea \ --access-logs CloudWatchLogs={Enabled=true,LogGroup=my-log-group} ``` 出力: ``` { "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 } } } ``` 詳細については、「*AWSVerified Access ユーザーガイド*」の「[Verified Access logs](https://docs.aws.amazon.com/verified-access/latest/ug/access-logs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyVerifiedAccessInstanceLoggingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-verified-access-instance-logging-configuration.html)」を参照してください。 ### `modify-verified-access-instance` 次のコード例は、`modify-verified-access-instance` を使用する方法を示しています。 **AWS CLI** **Verified Access インスタンスの設定を変更するには** 次の `modify-verified-access-instance` の例では、指定した説明を指定した Verified Access インスタンスに追加します。 ``` aws ec2 modify-verified-access-instance \ --verified-access-instance-id vai-0ce000c0b7643abea \ --description "Testing Verified Access" ``` 出力: ``` { "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" } } ``` 詳細については、「*AWSVerified Access ユーザーガイド*」の「[Access インスタンス](https://docs.aws.amazon.com/verified-access/latest/ug/verified-access-instances.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyVerifiedAccessInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-verified-access-instance.html)」を参照してください。 ### `modify-verified-access-trust-provider` 次のコード例は、`modify-verified-access-trust-provider` を使用する方法を示しています。 **AWS CLI** **Verified Access 信頼プロバイダーの設定を変更するには** 次の `modify-verified-access-trust-provider` の例では、指定した説明を指定した Verified Access 信頼プロバイダーに追加します。 ``` aws ec2 modify-verified-access-trust-provider \ --verified-access-trust-provider-id vatp-0bb32de759a3e19e7 \ --description "Testing Verified Access" ``` 出力: ``` { "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" } } ``` 詳細については、「*AWSVerified Access ユーザーガイド*」の「[Trust providers for Verified Access](https://docs.aws.amazon.com/verified-access/latest/ug/trust-providers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyVerifiedAccessTrustProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-verified-access-trust-provider.html)」を参照してください。 ### `modify-volume-attribute` 次のコード例は、`modify-volume-attribute` を使用する方法を示しています。 **AWS CLI** **ボリューム属性を変更するには** この例では、ID `vol-1234567890abcdef0` を持つボリュームの `autoEnableIo` 属性を `true` に設定します。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 modify-volume-attribute --volume-id vol-1234567890abcdef0 --auto-enable-io ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyVolumeAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-volume-attribute.html)」を参照してください。 ### `modify-volume` 次のコード例は、`modify-volume` を使用する方法を示しています。 **AWS CLI** **例 1: ボリュームのサイズを変更してボリュームを変更するには** 次の `modify-volume` の例では、指定されたボリュームのサイズを 150 GB に変更します。 コマンド: ``` aws ec2 modify-volume --size 150 --volume-id vol-1234567890abcdef0 ``` 出力: ``` { "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 } } ``` **例 2: ボリュームのタイプ、サイズ、IOPS 値を変更してボリュームを変更するには** 次の `modify-volume` の例では、ボリュームタイプをプロビジョンド IOPS SSD に変更して、ターゲット IOPS レートを 10,000 に設定し、ボリュームサイズを 350 GB に設定します。 ``` aws ec2 modify-volume \ --volume-type io1 \ --iops 10000 \ --size 350 \ --volume-id vol-1234567890abcdef0 ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyVolume](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-volume.html)」を参照してください。 ### `modify-vpc-attribute` 次のコード例は、`modify-vpc-attribute` を使用する方法を示しています。 **AWS CLI** **enableDnsSupport 属性を変更するには** この例では、`enableDnsSupport` 属性を変更します。この属性は、VPC に対して DNS 解決が有効になっているかどうかを示します。この属性が `true` の場合、Amazon DNS サーバーはインスタンスの DNS ホスト名を対応する IP アドレスに解決します。それ以外の場合は解決しません。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 modify-vpc-attribute --vpc-id vpc-a01106c2 --enable-dns-support "{\"Value\":false}" ``` **enableDnsHostnames 属性を変更するには** この例では、`enableDnsHostnames` 属性を変更します。この属性は、VPC 内に起動されるインスタンスが DNS ホスト名を取得するかどうかを示します。この属性が `true` の場合、VPC 内のインスタンスは DNS ホスト名を取得します。それ以外の場合は取得しません。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 modify-vpc-attribute --vpc-id vpc-a01106c2 --enable-dns-hostnames "{\"Value\":false}" ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyVpcAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-vpc-attribute.html)」を参照してください。 ### `modify-vpc-endpoint-connection-notification` 次のコード例は、`modify-vpc-endpoint-connection-notification` を使用する方法を示しています。 **AWS CLI** **エンドポイント接続通知を変更するには** この例では、指定されたエンドポイント接続通知の SNS トピックを変更します。 コマンド: ``` 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 ``` 出力: ``` { "ReturnValue": true } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyVpcEndpointConnectionNotification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-vpc-endpoint-connection-notification.html)」を参照してください。 ### `modify-vpc-endpoint-service-configuration` 次のコード例は、`modify-vpc-endpoint-service-configuration` を使用する方法を示しています。 **AWS CLI** **エンドポイントサービス設定を削除するには** この例では、指定されたエンドポイントサービスの承諾要件を変更します。 コマンド: ``` aws ec2 modify-vpc-endpoint-service-configuration --service-id vpce-svc-09222513e6e77dc86 --no-acceptance-required ``` 出力: ``` { "ReturnValue": true } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyVpcEndpointServiceConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-vpc-endpoint-service-configuration.html)」を参照してください。 ### `modify-vpc-endpoint-service-payer-responsibility` 次のコード例は、`modify-vpc-endpoint-service-payer-responsibility` を使用する方法を示しています。 **AWS CLI** **支払者の責任を変更するには** 次の `modify-vpc-endpoint-service-payer-responsibility` の例では、指定されたエンドポイントサービスの支払者の責任を変更します。 ``` aws ec2 modify-vpc-endpoint-service-payer-responsibility \ --service-id vpce-svc-071afff70666e61e0 \ --payer-responsibility ServiceOwner ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyVpcEndpointServicePayerResponsibility](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-vpc-endpoint-service-payer-responsibility.html)」を参照してください。 ### `modify-vpc-endpoint-service-permissions` 次のコード例は、`modify-vpc-endpoint-service-permissions` を使用する方法を示しています。 **AWS CLI** **エンドポイントサービスのアクセス許可を変更するには** この例では、AWS アカウントが指定されたエンドポイントサービスに接続するためのアクセス許可を追加します。 コマンド: ``` aws ec2 modify-vpc-endpoint-service-permissions --service-id vpce-svc-03d5ebb7d9579a2b3 --add-allowed-principals '["arn:aws:iam::123456789012:root"]' ``` 出力: ``` { "ReturnValue": true } ``` この例では、特定の IAM ユーザー (`admin`) が指定されたエンドポイントサービスに接続するためのアクセス許可を追加します。 コマンド: ``` aws ec2 modify-vpc-endpoint-service-permissions --service-id vpce-svc-03d5ebb7d9579a2b3 --add-allowed-principals '["arn:aws:iam::123456789012:user/admin"]' ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyVpcEndpointServicePermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-vpc-endpoint-service-permissions.html)」を参照してください。 ### `modify-vpc-endpoint` 次のコード例は、`modify-vpc-endpoint` を使用する方法を示しています。 **AWS CLI** **ゲートウェイエンドポイントを変更するには** この例では、ルートテーブル `rtb-aaa222bb` をエンドポイントに関連付け、ポリシードキュメントをリセットすることで、ゲートウェイエンドポイント `vpce-1a2b3c4d` を変更します。 コマンド: ``` aws ec2 modify-vpc-endpoint --vpc-endpoint-id vpce-1a2b3c4d --add-route-table-ids rtb-aaa222bb --reset-policy ``` 出力: ``` { "Return": true } ``` **インターフェイスエンドポイントを変更するには** この例では、エンドポイントにサブネット `subnet-d6fcaa8d` を追加してインターフェイスエンドポイント `vpce-0fe5b17a0707d6fa5` を変更します。 コマンド: ``` aws ec2 modify-vpc-endpoint --vpc-endpoint-id vpce-0fe5b17a0707d6fa5 --add-subnet-id subnet-d6fcaa8d ``` 出力: ``` { "Return": true } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyVpcEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-vpc-endpoint.html)」を参照してください。 ### `modify-vpc-peering-connection-options` 次のコード例は、`modify-vpc-peering-connection-options` を使用する方法を示しています。 **AWS CLI** **ローカル ClassicLink 接続から VPC ピアリング接続を介した通信を有効にするには** この例では、ピアリング接続 `pcx-aaaabbb` の場合、リクエスタ VPC の所有者は VPC ピアリング接続オプションを変更して、ローカル ClassicLink 接続がピア VPC と通信できるようにします。 コマンド: ``` aws ec2 modify-vpc-peering-connection-options --vpc-peering-connection-id pcx-aaaabbbb --requester-peering-connection-options AllowEgressFromLocalClassicLinkToRemoteVpc=true ``` 出力: ``` { "RequesterPeeringConnectionOptions": { "AllowEgressFromLocalClassicLinkToRemoteVpc": true } } ``` **ローカル VPC からリモート ClassicLink 接続への VPC ピアリング接続を介した通信を有効にするには** この例では、アクセプタ VPC の所有者は VPC ピアリング接続オプションを変更して、ローカル VPC がピア VPC の ClassicLink 接続と通信できるようにします。 コマンド: ``` aws ec2 modify-vpc-peering-connection-options --vpc-peering-connection-id pcx-aaaabbbb --accepter-peering-connection-options AllowEgressFromLocalVpcToRemoteClassicLink=true ``` 出力: ``` { "AccepterPeeringConnectionOptions": { "AllowEgressFromLocalVpcToRemoteClassicLink": true } } ``` **VPC ピアリング接続の DNS 解決サポートを有効にするには** この例では、リクエスタ VPC の所有者は、`pcx-aaaabbbb` の VPC ピアリング接続オプションを変更して、ピア VPC のインスタンスからクエリされたときに、ローカル VPC がパブリック DNS ホスト名をプライベート IP アドレスに解決できるようにします。 コマンド: ``` aws ec2 modify-vpc-peering-connection-options --vpc-peering-connection-id pcx-aaaabbbb --requester-peering-connection-options AllowDnsResolutionFromRemoteVpc=true ``` 出力: ``` { "RequesterPeeringConnectionOptions": { "AllowDnsResolutionFromRemoteVpc": true } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyVpcPeeringConnectionOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-vpc-peering-connection-options.html)」を参照してください。 ### `modify-vpc-tenancy` 次のコード例は、`modify-vpc-tenancy` を使用する方法を示しています。 **AWS CLI** **VPC のテナンシーを変更するには** この例では、VPC `default` のテナンシーを `vpc-1a2b3c4d` に変更します。 コマンド: ``` aws ec2 modify-vpc-tenancy --vpc-id vpc-1a2b3c4d --instance-tenancy default ``` 出力: ``` { "Return": true } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyVpcTenancy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-vpc-tenancy.html)」を参照してください。 ### `modify-vpn-connection-options` 次のコード例は、`modify-vpn-connection-options` を使用する方法を示しています。 **AWS CLI** **VPN 接続オプションを変更する** 次の `modify-vpn-connection-options` の例では、指定された VPN 接続のカスタマーゲートウェイ側のローカル IPv4 CIDR を変更します。 ``` aws ec2 modify-vpn-connection-options \ --vpn-connection-id vpn-1122334455aabbccd \ --local-ipv4-network-cidr 10.0.0.0/16 ``` 出力: ``` { "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": "" } ] } ] } ``` 詳細については、「*AWS Site-to-Site VPN ユーザーガイド*」の「[Modifying Site-to-Site VPN connection options](https://docs.aws.amazon.com/vpn/latest/s2svpn/modify-vpn-connection-options.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyVpnConnectionOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-vpn-connection-options.html)」を参照してください。 ### `modify-vpn-connection` 次のコード例は、`modify-vpn-connection` を使用する方法を示しています。 **AWS CLI** **VPN 接続を変更するには** 次の `modify-vpn-connection` の例では、VPN 接続 `vpn-12345678901234567` のターゲットゲートウェイを仮想プライベートゲートウェイ `vgw-11223344556677889` に変更します。 ``` aws ec2 modify-vpn-connection \ --vpn-connection-id vpn-12345678901234567 \ --vpn-gateway-id vgw-11223344556677889 ``` 出力: ``` { "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" } ] } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyVpnConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-vpn-connection.html)」を参照してください。 ### `modify-vpn-tunnel-certificate` 次のコード例は、`modify-vpn-tunnel-certificate` を使用する方法を示しています。 **AWS CLI** **VPN トンネル証明書をローテーションするには** 次の `modify-vpn-tunnel-certificate` の例では、VPN 接続の指定されたトンネルの証明書をローテーションします。 ``` aws ec2 modify-vpn-tunnel-certificate \ --vpn-tunnel-outside-ip-address 203.0.113.17 \ --vpn-connection-id vpn-12345678901234567 ``` 出力: ``` { "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" } ] } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyVpnTunnelCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-vpn-tunnel-certificate.html)」を参照してください。 ### `modify-vpn-tunnel-options` 次のコード例は、`modify-vpn-tunnel-options` を使用する方法を示しています。 **AWS CLI** **VPN 接続のトンネルオプションを変更するには** 次の `modify-vpn-tunnel-options` の例では、指定されたトンネルと VPN 接続で許可されている Diffie-Hellman グループを更新します。 ``` 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}] ``` 出力: ``` { "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" } ] } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyVpnTunnelOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-vpn-tunnel-options.html)」を参照してください。 ### `monitor-instances` 次のコード例は、`monitor-instances` を使用する方法を示しています。 **AWS CLI** **インスタンスの詳細モニタリングを有効にするには** このコマンド例は、指定されたインスタンスの詳細モニタリングを有効にします。 コマンド: ``` aws ec2 monitor-instances --instance-ids i-1234567890abcdef0 ``` 出力: ``` { "InstanceMonitorings": [ { "InstanceId": "i-1234567890abcdef0", "Monitoring": { "State": "pending" } } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[MonitorInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/monitor-instances.html)」を参照してください。 ### `move-address-to-vpc` 次のコード例は、`move-address-to-vpc` を使用する方法を示しています。 **AWS CLI** **アドレスを EC2-VPC に移動するには** この例では、Elastic IP アドレス 54.123.4.56 を EC2-VPC プラットフォームに移動します。 コマンド: ``` aws ec2 move-address-to-vpc --public-ip 54.123.4.56 ``` 出力: ``` { "Status": "MoveInProgress" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[MoveAddressToVpc](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/move-address-to-vpc.html)」を参照してください。 ### `move-byoip-cidr-to-ipam` 次のコード例は、`move-byoip-cidr-to-ipam` を使用する方法を示しています。 **AWS CLI** **BYOIP CIDR を IPAM に転送するには** 次の `move-byoip-cidr-to-ipam` の例では、BYOIP CIDR を 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 ``` 出力: ``` { "ByoipCidr": { "Cidr": "130.137.249.0/24", "State": "pending-transfer" } } ``` 詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[Tutorial: Transfer an existing BYOIP IPv4 CIDR to IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoip-ipam-transfer-ipv4.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[MoveByoipCidrToIpam](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/move-byoip-cidr-to-ipam.html)」を参照してください。 ### `network-insights-access-scope` 次のコード例は、`network-insights-access-scope` を使用する方法を示しています。 **AWS CLI** **Network Insights アクセススコープを作成するには** 次の `create-network-insights-access-scope` の例では、AWS アカウントにネットワークインサイトアクセス範囲を作成します。 ``` aws ec2 create-network-insights-access-scope \ --cli-input-json file://access-scope-file.json ``` `access-scope-file.json` の内容: ``` { { "MatchPaths": [ { "Source": { "ResourceStatement": { "Resources": [ "vpc-abcd12e3" ] } } } ], "ExcludePaths": [ { "Source": { "ResourceStatement": { "ResourceTypes": [ "AWS::EC2::InternetGateway" ] } } } ] } } ``` 出力: ``` { "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" ] } } } ] } } ``` 詳細については、「*Network Access Analyzer ガイド*」の「[Getting started with Network Access Analyzer using the AWS CLI](https://docs.aws.amazon.com/vpc/latest/network-access-analyzer/getting-started-cli-naa.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[NetworkInsightsAccessScope](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/network-insights-access-scope.html)」を参照してください。 ### `provision-byoip-cidr` 次のコード例は、`provision-byoip-cidr` を使用する方法を示しています。 **AWS CLI** **アドレス範囲をプロビジョニングするには** 次の `provision-byoip-cidr` の例では、AWS で使用するパブリック IP アドレス範囲をプロビジョニングします。 ``` aws ec2 provision-byoip-cidr \ --cidr 203.0.113.25/24 \ --cidr-authorization-context Message="$text_message",Signature="$signed_message" ``` 出力: ``` { "ByoipCidr": { "Cidr": "203.0.113.25/24", "State": "pending-provision" } } ``` 認証コンテキストのメッセージ文字列の作成の詳細については、「*Amazon EC2 ユーザーガイド*」の「[Bring Your Own IP Addresses](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ProvisionByoipCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/provision-byoip-cidr.html)」を参照してください。 ### `provision-ipam-pool-cidr` 次のコード例は、`provision-ipam-pool-cidr` を使用する方法を示しています。 **AWS CLI** **CIDR を IPAM プールにプロビジョニングするには** 次の `provision-ipam-pool-cidr` の例では、IPAM プールに CIDR をプロビジョニングします。 (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 ``` 出力: ``` { "IpamPoolCidr": { "Cidr": "10.0.0.0/24", "State": "pending-provision" } } ``` 詳細については、「*Amazon VPC IPAM ユーザーガイド*」の「[Provision CIDRs to a pool](https://docs.aws.amazon.com/vpc/latest/ipam/prov-cidr-ipam.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ProvisionIpamPoolCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/provision-ipam-pool-cidr.html)」を参照してください。 ### `purchase-host-reservation` 次のコード例は、`purchase-host-reservation` を使用する方法を示しています。 **AWS CLI** **専有ホストの予約を購入するには** この例では、アカウント内の指定された専有ホストに対して指定された専有ホスト予約サービスを購入します。 コマンド: ``` aws ec2 purchase-host-reservation --offering-id hro-03f707bf363b6b324 --host-id-set h-013abcd2a00cbd123 ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PurchaseHostReservation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/purchase-host-reservation.html)」を参照してください。 ### `purchase-reserved-instances-offering` 次のコード例は、`purchase-reserved-instances-offering` を使用する方法を示しています。 **AWS CLI** **リザーブドインスタンスサービスを購入するには** このコマンド例では、オファリング ID とインスタンス数を指定して、リザーブドインスタンス提供の購入を示します。 コマンド: ``` aws ec2 purchase-reserved-instances-offering --reserved-instances-offering-id ec06327e-dd07-46ee-9398-75b5fexample --instance-count 3 ``` 出力: ``` { "ReservedInstancesId": "af9f760e-6f91-4559-85f7-4980eexample" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PurchaseReservedInstancesOffering](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/purchase-reserved-instances-offering.html)」を参照してください。 ### `purchase-scheduled-instances` 次のコード例は、`purchase-scheduled-instances` を使用する方法を示しています。 **AWS CLI** **スケジュールされたインスタンスを購入するには** この例では、スケジュールされたインスタンスを購入します。 コマンド: ``` aws ec2 purchase-scheduled-instances --purchase-requests file://purchase-request.json ``` Purchase-request.json: ``` [ { "PurchaseToken": "eyJ2IjoiMSIsInMiOjEsImMiOi...", "InstanceCount": 1 } ] ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PurchaseScheduledInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/purchase-scheduled-instances.html)」を参照してください。 ### `reboot-instances` 次のコード例は、`reboot-instances` を使用する方法を示しています。 **AWS CLI** **Amazon EC2 インスタンスを再起動するには** この例では、指定のインスタンスを再起動します。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 reboot-instances --instance-ids i-1234567890abcdef5 ``` 詳細については、「*Amazon Elastic Compute Cloud ユーザーガイド*」の「インスタンスの再起動方法」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RebootInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/reboot-instances.html)」を参照してください。 ### `register-image` 次のコード例は、`register-image` を使用する方法を示しています。 **AWS CLI** **例 1: マニフェストファイルを使用して AMI を登録するには** 次の `register-image` の例では、Amazon S3 で指定されたマニフェストファイルを使用して AMI を登録します。 ``` aws ec2 register-image \ --name my-image \ --image-location amzn-s3-demo-bucket/myimage/image.manifest.xml ``` 出力: ``` { "ImageId": "ami-1234567890EXAMPLE" } ``` 詳細については「*アマゾン EC2 ユーザーガイド*」の「[アマゾン マシンイメージ (AMI)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html)」を参照してください。 **例 2: ルートデバイスのスナップショットを使用して AMI を登録するには** 次の `register-image` の例では、EBS ルートボリュームの指定されたスナップショットをデバイス `/dev/xvda` として使用して、AMI を登録します。ブロックデバイスマッピングには、デバイス `/dev/xvdf` として空の 100 GiB EBS ボリュームも含まれます。 ``` 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} ``` 出力: ``` { "ImageId": "ami-1a2b3c4d5eEXAMPLE" } ``` 詳細については「*アマゾン EC2 ユーザーガイド*」の「[アマゾン マシンイメージ (AMI)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegisterImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/register-image.html)」を参照してください。 ### `register-instance-event-notification-attributes` 次のコード例は、`register-instance-event-notification-attributes` を使用する方法を示しています。 **AWS CLI** **例 1: イベント通知にすべてのタグを含めるには** 次の `register-instance-event-notification-attributes` の例では、イベント通知にすべてのタグを含めます。 ``` aws ec2 register-instance-event-notification-attributes \ --instance-tag-attribute IncludeAllTagsOfInstance=true ``` 出力: ``` { "InstanceTagAttribute": { "InstanceTagKeys": [], "IncludeAllTagsOfInstance": true } } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[インスタンスの予定されているイベント](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html)」を参照してください。 **例 2: イベント通知に特定のタグを含めるには** 次の `register-instance-event-notification-attributes` の例では、イベント通知に指定したタグを含めます。`IncludeAllTagsOfInstance` が `true` の場合、タグは指定できません。 ``` aws ec2 register-instance-event-notification-attributes \ --instance-tag-attribute InstanceTagKeys="tag-key1","tag-key2" ``` 出力: ``` { "InstanceTagAttribute": { "InstanceTagKeys": [ "tag-key1", "tag-key2" ], "IncludeAllTagsOfInstance": false } } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[インスタンスの予定されているイベント](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegisterInstanceEventNotificationAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/register-instance-event-notification-attributes.html)」を参照してください。 ### `register-transit-gateway-multicase-group-sources` 次のコード例は、`register-transit-gateway-multicase-group-sources` を使用する方法を示しています。 **AWS CLI** **Transit Gateway マルチキャストグループにソースを登録するには。** 次の `register-transit-gateway-multicast-group-sources` の例では、指定されたネットワークインターフェイスグループソースをマルチキャストグループに登録します。 ``` 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 ``` 出力: ``` { "RegisteredMulticastGroupSources": { "TransitGatewayMulticastDomainId": "tgw-mcast-domain-0c4905cef79d6e597", "RegisteredNetworkInterfaceIds": [ "eni-07f290fc3c090cbae" ], "GroupIpAddress": "224.0.1.0" } } ``` 詳細については、「*AWS Transit Gateway ユーザーガイド*」の「[Register Sources with a Multicast Group](https://docs.aws.amazon.com/vpc/latest/tgw/working-with-multicast.html#add-source-multicast-group)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegisterTransitGatewayMulticaseGroupSources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/register-transit-gateway-multicase-group-sources.html)」を参照してください。 ### `register-transit-gateway-multicast-group-members` 次のコード例は、`register-transit-gateway-multicast-group-members` を使用する方法を示しています。 **AWS CLI** **Transit Gateway マルチキャストドメインの関連付けに関する情報を表示するには** 次の `register-transit-gateway-multicast-group-members` の例では、指定したマルチキャストドメインの関連付けを返します。 ``` 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 ``` 出力: ``` { "RegisteredMulticastGroupMembers": { "TransitGatewayMulticastDomainId": "tgw-mcast-domain-0c4905cef79d6e597", "RegisteredNetworkInterfaceIds": [ "eni-0e246d32695012e81" ], "GroupIpAddress": "224.0.1.0" } } ``` 詳細については、*Transit Gateways ユーザーガイド*の「[マルチキャストドメイン](https://docs.aws.amazon.com/vpc/latest/tgw/multicast-domains-about.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegisterTransitGatewayMulticastGroupMembers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/register-transit-gateway-multicast-group-members.html)」を参照してください。 ### `register-transit-gateway-multicast-group-sources` 次のコード例は、`register-transit-gateway-multicast-group-sources` を使用する方法を示しています。 **AWS CLI** **Transit Gateway マルチキャストグループにソースを登録するには。** 次の `register-transit-gateway-multicast-group-sources` の例では、指定されたネットワークインターフェイスグループソースをマルチキャストグループに登録します。 ``` 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 ``` 出力: ``` { "RegisteredMulticastGroupSources": { "TransitGatewayMulticastDomainId": "tgw-mcast-domain-0c4905cef79d6e597", "RegisteredNetworkInterfaceIds": [ "eni-07f290fc3c090cbae" ], "GroupIpAddress": "224.0.1.0" } } ``` 詳細については、*Transit Gateways ガイド*の「[マルチキャストドメイン](https://docs.aws.amazon.com/vpc/latest/tgw/multicast-domains-about.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegisterTransitGatewayMulticastGroupSources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/register-transit-gateway-multicast-group-sources.html)」を参照してください。 ### `reject-transit-gateway-peering-attachment` 次のコード例は、`reject-transit-gateway-peering-attachment` を使用する方法を示しています。 **AWS CLI** **Transit Gateway ピアリングアタッチメントを拒否するには** 次の `reject-transit-gateway-peering-attachment` の例では、指定した Transit Gateway ピアリングアタッチメントリクエストを拒否します。`--region` パラメータは、アクセプタ Transit Gateway があるリージョンを指定します。 ``` aws ec2 reject-transit-gateway-peering-attachment \ --transit-gateway-attachment-id tgw-attach-4455667788aabbccd \ --region us-east-2 ``` 出力: ``` { "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" } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Transit Gateway Peering Attachments](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-peering.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RejectTransitGatewayPeeringAttachment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/reject-transit-gateway-peering-attachment.html)」を参照してください。 ### `reject-transit-gateway-vpc-attachment` 次のコード例は、`reject-transit-gateway-vpc-attachment` を使用する方法を示しています。 **AWS CLI** **Transit Gateway VPC アタッチメントを拒否するには** 次の `reject-transit-gateway-vpc-attachment` の例では、指定した Transit Gateway VPC アタッチメントを拒否します。 ``` aws ec2 reject-transit-gateway-vpc-attachment \ --transit-gateway-attachment-id tgw-attach-0a34fe6b4fEXAMPLE ``` 出力: ``` { "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" } } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Transit gateway attachments to a VPC](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-vpc-attachments.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RejectTransitGatewayVpcAttachment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/reject-transit-gateway-vpc-attachment.html)」を参照してください。 ### `reject-transit-gateway-vpc-attachments` 次のコード例は、`reject-transit-gateway-vpc-attachments` を使用する方法を示しています。 **AWS CLI** **Transit Gateway VPC アタッチメントを拒否するには** 次の `reject-transit-gateway-vpc-attachment` の例では、指定した Transit Gateway VPC アタッチメントを拒否します。 ``` aws ec2 reject-transit-gateway-vpc-attachment \ --transit-gateway-attachment-id tgw-attach-0a34fe6b4fEXAMPLE ``` 出力: ``` { "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" } } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Transit gateway attachments to a VPC](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-vpc-attachments.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RejectTransitGatewayVpcAttachments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/reject-transit-gateway-vpc-attachments.html)」を参照してください。 ### `reject-vpc-endpoint-connections` 次のコード例は、`reject-vpc-endpoint-connections` を使用する方法を示しています。 **AWS CLI** **インターフェイスエンドポイント接続リクエストを拒否するには** この例では、指定されたエンドポイントサービスに対して指定されたエンドポイント接続リクエストを拒否します。 コマンド: ``` aws ec2 reject-vpc-endpoint-connections --service-id vpce-svc-03d5ebb7d9579a2b3 --vpc-endpoint-ids vpce-0c1308d7312217abc ``` 出力: ``` { "Unsuccessful": [] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RejectVpcEndpointConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/reject-vpc-endpoint-connections.html)」を参照してください。 ### `reject-vpc-peering-connection` 次のコード例は、`reject-vpc-peering-connection` を使用する方法を示しています。 **AWS CLI** **VPC ピアリング接続を拒否するには** この例では、指定された VPC ピアリング接続リクエストを拒否します。 コマンド: ``` aws ec2 reject-vpc-peering-connection --vpc-peering-connection-id pcx-1a2b3c4d ``` 出力: ``` { "Return": true } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RejectVpcPeeringConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/reject-vpc-peering-connection.html)」を参照してください。 ### `release-address` 次のコード例は、`release-address` を使用する方法を示しています。 **AWS CLI** **EC2-Classic 用 Elastic IP アドレスをリリースするには** この例では、EC2-Classic のインスタンスに使用する Elastic IP アドレスをリリースしています。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 release-address --public-ip 198.51.100.0 ``` **EC2-VPC 用 Elastic IP アドレスをリリースするには** この例では、VPC のインスタンスに使用する Elastic IP アドレスをリリースしています。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 release-address --allocation-id eipalloc-64d5890a ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ReleaseAddress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/release-address.html)」を参照してください。 ### `release-hosts` 次のコード例は、`release-hosts` を使用する方法を示しています。 **AWS CLI** **アカウントから専有ホストを解除するには** アカウントから専有ホストを解除するには。ホストを解除する前に、ホスト上にあるインスタンスを停止または終了する必要があります。 コマンド: ``` aws ec2 release-hosts --host-id=h-0029d6e3cacf1b3da ``` 出力: ``` { "Successful": [ "h-0029d6e3cacf1b3da" ], "Unsuccessful": [] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ReleaseHosts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/release-hosts.html)」を参照してください。 ### `release-ipam-pool-allocation` 次のコード例は、`release-ipam-pool-allocation` を使用する方法を示しています。 **AWS CLI** **IPAM プールの割り当てを解除するには** この例では、あなたは IPAM の委任された管理者として IPAM プールを削除しようとしましたが、プールに割り当てがある間はプールを削除できないというエラーを受け取りました。このコマンドを使用して、プール割り当てを解除します。 次の点に注意してください。 このコマンドは、カスタム割り当てにのみ使用できます。リソースを削除せずにリソースの割り当てを削除するには、[modify-ipam-resource-cidr](https://docs.aws.amazon.com/cli/latest/reference/ec2/modify-ipam-resource-cidr.html) を使用してモニタリング状態を false に設定します。このリクエストを完了するには、[describe-ipam-pools](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-ipam-pools.html) で取得できる IPAM プール ID が必要です。また、[get-ipam-pool-allocations](https://docs.aws.amazon.com/cli/latest/reference/ec2/get-ipam-pool-allocations.html) で取得できる割り当て ID も必要です。割り当てを 1 つずつ削除したくない場合は、IPAM プールを削除するときに `--cascade option` を使用して、削除する前にプール内の割り当てをすべて自動的に解除できます。このコマンドを実行する前に、いくつかの前提条件があります。詳細については「*Amazon VPC IPAM ユーザーガイド*」の「[Release an allocation](https://docs.aws.amazon.com/vpc/latest/ipam/release-alloc-ipam.html)」を参照してください。このコマンドを実行する `--region` は、割り当てのある IPAM プールのロケールである必要があります。 次の `release-ipam-pool-allocation` の例では、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 ``` 出力: ``` { "Success": true } ``` 割り当てをリリースしたら、[delete-ipam-pool](https://docs.aws.amazon.com/cli/latest/reference/ec2/delete-ipam-pool.html) を実行することができます。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ReleaseIpamPoolAllocation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/release-ipam-pool-allocation.html)」を参照してください。 ### `replace-iam-instance-profile-association` 次のコード例は、`replace-iam-instance-profile-association` を使用する方法を示しています。 **AWS CLI** **インスタンスの IAM インスタンスプロファイルを置き換えるには** この例では、関連付け `iip-assoc-060bae234aac2e7fa` によって表される IAM インスタンスプロファイルを、`AdminRole` という名前の IAM インスタンスプロファイルに置き換えています。 ``` aws ec2 replace-iam-instance-profile-association \ --iam-instance-profile Name=AdminRole \ --association-id iip-assoc-060bae234aac2e7fa ``` 出力: ``` { "IamInstanceProfileAssociation": { "InstanceId": "i-087711ddaf98f9489", "State": "associating", "AssociationId": "iip-assoc-0b215292fab192820", "IamInstanceProfile": { "Id": "AIPAJLNLDX3AMYZNWYYAY", "Arn": "arn:aws:iam::123456789012:instance-profile/AdminRole" } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ReplaceIamInstanceProfileAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/replace-iam-instance-profile-association.html)」を参照してください。 ### `replace-network-acl-association` 次のコード例は、`replace-network-acl-association` を使用する方法を示しています。 **AWS CLI** **ネットワーク ACL をサブネットと置き換えるには** この例では、指定されたネットワーク ACL を、指定されたネットワーク ACL 関連付けのサブネットに関連付けます。 コマンド: ``` aws ec2 replace-network-acl-association --association-id aclassoc-e5b95c8c --network-acl-id acl-5fb85d36 ``` 出力: ``` { "NewAssociationId": "aclassoc-3999875b" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ReplaceNetworkAclAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/replace-network-acl-association.html)」を参照してください。 ### `replace-network-acl-entry` 次のコード例は、`replace-network-acl-entry` を使用する方法を示しています。 **AWS CLI** **ネットワーク ACL エントリを置き換えるには** この例では、指定されたネットワーク ACL のエントリを置き換えます。新しいルール 100 は、UDP ポート 53 (DNS) の 203.0.113.12/24 から任意の関連付けられたサブネットへの入力トラフィックを許可します。 コマンド: ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ReplaceNetworkAclEntry](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/replace-network-acl-entry.html)」を参照してください。 ### `replace-route-table-association` 次のコード例は、`replace-route-table-association` を使用する方法を示しています。 **AWS CLI** **サブネットに関連付けられたルートテーブルを置き換えるには** この例では、指定されたルートテーブルを、指定されたルートテーブルの関連付け用のサブネットに関連付けます。 コマンド: ``` aws ec2 replace-route-table-association --association-id rtbassoc-781d0d1a --route-table-id rtb-22574640 ``` 出力: ``` { "NewAssociationId": "rtbassoc-3a1f0f58" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ReplaceRouteTableAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/replace-route-table-association.html)」を参照してください。 ### `replace-route` 次のコード例は、`replace-route` を使用する方法を示しています。 **AWS CLI** **ルートを置き換えるには** この例では、指定したルートテーブルの指定したルートを置き換えます。新しいルートは、指定された CIDR に一致し、トラフィックを指定された仮想プライベートゲートウェイに送信します。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 replace-route --route-table-id rtb-22574640 --destination-cidr-block 10.0.0.0/16 --gateway-id vgw-9a4cacf3 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ReplaceRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/replace-route.html)」を参照してください。 ### `replace-transit-gateway-route` 次のコード例は、`replace-transit-gateway-route` を使用する方法を示しています。 **AWS CLI** **指定された Transit Gateway ルートテーブルの指定されたルートを置き換えるには** 次の `replace-transit-gateway-route` の例では、指定した Transit Gateway ルートテーブルのルートを置き換えます。 ``` 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 ``` 出力: ``` { "Route": { "DestinationCidrBlock": "10.0.2.0/24", "TransitGatewayAttachments": [ { "ResourceId": "vpc-4EXAMPLE", "TransitGatewayAttachmentId": "tgw-attach-09b52ccdb5EXAMPLE", "ResourceType": "vpc" } ], "Type": "static", "State": "active" } } ``` 詳細については、「*Transit Gateways ガイド*」の「[Transit gateway route tables](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ReplaceTransitGatewayRoute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/replace-transit-gateway-route.html)」を参照してください。 ### `report-instance-status` 次のコード例は、`report-instance-status` を使用する方法を示しています。 **AWS CLI** **インスタンスのステータスフィードバックを報告するには** このコマンド例では、指定されたインスタンスのステータスフィードバックを報告します。 コマンド: ``` aws ec2 report-instance-status --instances i-1234567890abcdef0 --status impaired --reason-codes unresponsive ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ReportInstanceStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/report-instance-status.html)」を参照してください。 ### `request-spot-fleet` 次のコード例は、`request-spot-fleet` を使用する方法を示しています。 **AWS CLI** **最低料金でサブネット内のスポットフリートをリクエストするには** このコマンド例では、サブネットによってのみ異なる 2 つの起動仕様を持つスポットフリートリクエストを作成します。スポットフリートは、指定された最低料金のサブネットでインスタンスを起動します。インスタンスがデフォルトの VPC で起動される場合は、デフォルトでパブリック IP アドレスが割り当てられます。インスタンスがデフォルト以外の VPC で起動される場合は、デフォルトでパブリック IP アドレスは割り当てられません。 スポットフリートリクエストで、同じアベイラビリティーゾーンから異なるサブネットを指定することはできません。 コマンド: ``` 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" } } ] } ``` 出力: ``` { "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" } ``` **最低料金でアベイラビリティーゾーンのスポットフリートをリクエストするには** このコマンド例では、アベイラビリティーゾーンによってのみ異なる 2 つの起動仕様を持つスポットフリートリクエストを作成します。スポットフリートは、指定された最低料金のアベイラビリティーゾーンでインスタンスを起動します。アカウントが EC2-VPC のみをサポートしている場合、Amazon EC2 はアベイラビリティーゾーンのデフォルトサブネットでスポットインスタンスを起動します。アカウントが EC2-Classic をサポートしている場合、Amazon EC2 はアベイラビリティーゾーンの EC2-Classic でインスタンスを起動します。 コマンド: ``` 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" } } ] } ``` **サブネットでスポットインスタンスを起動し、パブリック IP アドレスを割り当てるには** このコマンド例では、デフォルト以外の VPC で起動されたインスタンスにパブリックアドレスを割り当てます。ネットワークインターフェイスを指定する際、ネットワークインターフェイスを使用してサブネット ID とセキュリティグループ ID を含める必要があります。 コマンド: ``` 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" } } ] } ``` **分散配分戦略を使用してスポットフリートをリクエストするには** このコマンド例では、分散配分戦略を使用して 30 個のインスタンスを起動するスポットフリートリクエストを作成します。起動仕様はインスタンスタイプによって異なります。スポットフリートは、各タイプのインスタンスが 10 個になるように、起動仕様全体にインスタンスを分散します。 コマンド: ``` 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" } ] } ``` 詳細については、「*Amazon Elastic Compute Cloud ユーザーガイド*」の「Spot Fleet Requests」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RequestSpotFleet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/request-spot-fleet.html)」を参照してください。 ### `request-spot-instances` 次のコード例は、`request-spot-instances` を使用する方法を示しています。 **AWS CLI** **スポットインスタンスをリクエストするには** このコマンド例では、指定されたアベイラビリティーゾーン内の 5 個のインスタンスに対して 1 回限りのスポットインスタンスリクエストを作成します。アカウントが EC2-VPC のみをサポートしている場合、Amazon EC2 は指定されたアベイラビリティーゾーンのデフォルトサブネットでインスタンスを起動します。アカウントが EC2-Classic をサポートしている場合、Amazon EC2 は指定されたアベイラビリティーゾーンの EC2-Classic でインスタンスを起動します。 コマンド: ``` 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" } } ``` 出力: ``` { "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" }, ... ] } ``` このコマンド例では、指定されたサブネット内の 5 個のインスタンスに対して 1 回限りのスポットインスタンスリクエストを作成します。Amazon EC2 は指定されたサブネットでインスタンスを起動します。VPC がデフォルト以外の VPC である場合、インスタンスにはデフォルトでパブリック IP アドレスが割り当てられません。 コマンド: ``` 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" } } ``` 出力: ``` { "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" }, ... ] } ``` この例では、デフォルト以外の VPC で起動するスポットインスタンスにパブリック IP アドレスを割り当てます。ネットワークインターフェイスを指定する際、ネットワークインターフェイスを使用してサブネット ID とセキュリティグループ ID を含める必要があります。 コマンド: ``` 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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RequestSpotInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/request-spot-instances.html)」を参照してください。 ### `reset-address-attribute` 次のコード例は、`reset-address-attribute` を使用する方法を示しています。 **AWS CLI** **Elastic IP アドレスに関連付けられたドメイン名属性をリセットするには** 次の `reset-address-attribute` の例では、Elastic IP アドレスのドメイン名の属性をリセットします。 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 ``` 出力: ``` { "Addresses": [ { "PublicIp": "192.0.2.0", "AllocationId": "eipalloc-abcdef01234567890", "PtrRecord": "example.com." "PtrRecordUpdate": { "Value": "example.net.", "Status": "PENDING" } ] } ``` 保留中の変更をモニタリングするには、「*AWS CLI コマンドリファレンス*」の「[describe-addresses-attribute](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-addresses-attribute.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ResetAddressAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/reset-address-attribute.html)」を参照してください。 ### `reset-ebs-default-kms-key-id` 次のコード例は、`reset-ebs-default-kms-key-id` を使用する方法を示しています。 **AWS CLI** **EBS 暗号化用のデフォルトの CMK をリセットするには** 次の `reset-ebs-default-kms-key-id` の例では、現在のリージョンの AWS アカウントについて EBS 暗号化のデフォルトの CMK をリセットします。 ``` aws ec2 reset-ebs-default-kms-key-id ``` 出力: ``` { "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/8c5b2c63-b9bc-45a3-a87a-5513eEXAMPLE" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ResetEbsDefaultKmsKeyId](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/reset-ebs-default-kms-key-id.html)」を参照してください。 ### `reset-fpga-image-attribute` 次のコード例は、`reset-fpga-image-attribute` を使用する方法を示しています。 **AWS CLI** **Amazon FPGA イメージの属性をリセットするには** この例では、指定された AFI のロードアクセス許可をリセットします。 コマンド: ``` aws ec2 reset-fpga-image-attribute --fpga-image-id afi-0d123e123bfc85abc --attribute loadPermission ``` 出力: ``` { "Return": true } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ResetFpgaImageAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/reset-fpga-image-attribute.html)」を参照してください。 ### `reset-image-attribute` 次のコード例は、`reset-image-attribute` を使用する方法を示しています。 **AWS CLI** **launchPermission 属性をリセットするには** この例では、指定された AMI の `launchPermission` 属性をデフォルト値にリセットします。デフォルトでは、AMI はプライベートです。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 reset-image-attribute --image-id ami-5731123e --attribute launchPermission ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ResetImageAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/reset-image-attribute.html)」を参照してください。 ### `reset-instance-attribute` 次のコード例は、`reset-instance-attribute` を使用する方法を示しています。 **AWS CLI** **sourceDestCheck 属性をリセットするには** この例では、指定されたインスタンスの `sourceDestCheck` 属性をリセットします。インスタンスは VPC にある必要があります。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 reset-instance-attribute --instance-id i-1234567890abcdef0 --attribute sourceDestCheck ``` **カーネル属性をリセットするには** この例では、指定されたインスタンスの `kernel` 属性をリセットします。インスタンスは `stopped` の状態である必要があります。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 reset-instance-attribute --instance-id i-1234567890abcdef0 --attribute kernel ``` **ramdisk 属性をリセットするには** この例では、指定されたインスタンスの `ramdisk` 属性をリセットします。インスタンスは `stopped` の状態である必要があります。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 reset-instance-attribute --instance-id i-1234567890abcdef0 --attribute ramdisk ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ResetInstanceAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/reset-instance-attribute.html)」を参照してください。 ### `reset-network-interface-attribute` 次のコード例は、`reset-network-interface-attribute` を使用する方法を示しています。 **AWS CLI** **ネットワークインターフェイス属性をリセットするには** 次の `reset-network-interface-attribute` の例では、送信元/送信先チェック属性の値を `true` にリセットします。 ``` aws ec2 reset-network-interface-attribute \ --network-interface-id eni-686ea200 \ --source-dest-check ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ResetNetworkInterfaceAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/reset-network-interface-attribute.html)」を参照してください。 ### `reset-snapshot-attribute` 次のコード例は、`reset-snapshot-attribute` を使用する方法を示しています。 **AWS CLI** **スナップショット属性をリセットするには** この例では、スナップショット `snap-1234567890abcdef0` のボリューム作成のアクセス許可をリセットします。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 reset-snapshot-attribute --snapshot-id snap-1234567890abcdef0 --attribute createVolumePermission ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ResetSnapshotAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/reset-snapshot-attribute.html)」を参照してください。 ### `restore-address-to-classic` 次のコード例は、`restore-address-to-classic` を使用する方法を示しています。 **AWS CLI** **アドレスを EC2-Classic に復元するには** この例では、Elastic IP アドレス 198.51.100.0 を EC2-Classic プラットフォームに復元します。 コマンド: ``` aws ec2 restore-address-to-classic --public-ip 198.51.100.0 ``` 出力: ``` { "Status": "MoveInProgress", "PublicIp": "198.51.100.0" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RestoreAddressToClassic](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/restore-address-to-classic.html)」を参照してください。 ### `restore-image-from-recycle-bin` 次のコード例は、`restore-image-from-recycle-bin` を使用する方法を示しています。 **AWS CLI** **ごみ箱からイメージを復元するには** 次の `restore-image-from-recycle-bin` の例では、AMI ami-0111222333444abcd をごみ箱から復元します。 ``` aws ec2 restore-image-from-recycle-bin \ --image-id ami-0111222333444abcd ``` 出力: ``` { "Return": true } ``` 詳細については、*Amazon EBS ユーザーガイド*の「[削除された AMI をごみ箱から復元する](https://docs.aws.amazon.com/ebs/latest/userguide/recycle-bin-working-with-amis.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RestoreImageFromRecycleBin](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/restore-image-from-recycle-bin.html)」を参照してください。 ### `restore-managed-prefix-list-version` 次のコード例は、`restore-managed-prefix-list-version` を使用する方法を示しています。 **AWS CLI** us-west-2\$1\$1プレフィックスリストバージョンを復元するには\$1\$1 次の `restore-managed-prefix-list-version` では、指定されたプレフィックスリストのバージョン 1 からのエントリを復元します。 ``` aws ec2 restore-managed-prefix-list-version \ --prefix-list-id pl-0123456abcabcabc1 \ --current-version 2 \ --previous-version 1 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon VPC ユーザーガイド*」の「[Managed prefix lists](https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RestoreManagedPrefixListVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/restore-managed-prefix-list-version.html)」を参照してください。 ### `restore-snapshot-from-recycle-bin` 次のコード例は、`restore-snapshot-from-recycle-bin` を使用する方法を示しています。 **AWS CLI** **ごみ箱からスナップショットを復元するには** 次の `restore-snapshot-from-recycle-bin` の例では、スナップショットをごみ箱から復元します。ごみ箱からスナップショットを復元すると、そのスナップショットはすぐに使用でき、ごみ箱から削除されます。復元されたスナップショットは、アカウント内の他のスナップショットと同じ方法で使用できます。 ``` aws ec2 restore-snapshot-from-recycle-bin \ --snapshot-id snap-01234567890abcdef ``` このコマンドでは何も出力されません。 ごみ箱の詳細については、*Amazon EBS ユーザーガイド*の「[削除されたスナップショットをごみ箱から復元する](https://docs.aws.amazon.com/ebs/latest/userguide/recycle-bin-working-with-snaps.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RestoreSnapshotFromRecycleBin](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/restore-snapshot-from-recycle-bin.html)」を参照してください。 ### `restore-snapshot-tier` 次のコード例は、`restore-snapshot-tier` を使用する方法を示しています。 **AWS CLI** **例 1: アーカイブされたスナップショットを永続的に復元するには** 次の `restore-snapshot-tier` の例では、指定したスナップショットを完全に復元します。`--snapshot-id` を指定し、`permanent-restore` オプションを含めます。 ``` aws ec2 restore-snapshot-tier \ --snapshot-id snap-01234567890abcedf \ --permanent-restore ``` 出力: ``` { "SnapshotId": "snap-01234567890abcedf", "IsPermanentRestore": true } ``` スナップショットのアーカイブの詳細については、*Amazon EBS ユーザーガイド*の「[Amazon EBS スナップショットのアーカイブ](https://docs.aws.amazon.com/ebs/latest/userguide/snapshot-archive.html)」を参照してください。 **例 2: アーカイブされたスナップショットを一時的に復元するには** 次の `restore-snapshot-tier` の例では、指定したスナップショットを一時的に復元します。`--permanent-restore` オプションを省略します。`--snapshot-id` を指定し、`temporary-restore-days` にスナップショットを復元する日数を指定します。`temporary-restore-days` は日数で指定する必要があります。許容範囲は `1`～`180` です。値を指定しないと、デフォルトで `1` に設定されます。 ``` aws ec2 restore-snapshot-tier \ --snapshot-id snap-01234567890abcedf \ --temporary-restore-days 5 ``` 出力: ``` { "SnapshotId": "snap-01234567890abcedf", "RestoreDuration": 5, "IsPermanentRestore": false } ``` スナップショットのアーカイブの詳細については、*Amazon EBS ユーザーガイド*の「[Amazon EBS スナップショットのアーカイブ](https://docs.aws.amazon.com/ebs/latest/userguide/snapshot-archive.html)」を参照してください。 **例 3: 復元期間を変更するには** 次の `restore-snapshot-tier` の例では、指定したスナップショットの復元期間を `10` 日間に変更します。 ``` aws ec2 restore-snapshot-tier \ --snapshot-id snap-01234567890abcedf --temporary-restore-days 10 ``` 出力: ``` { "SnapshotId": "snap-01234567890abcedf", "RestoreDuration": 10, "IsPermanentRestore": false } ``` スナップショットのアーカイブの詳細については、*Amazon EBS ユーザーガイド*の「[Amazon EBS スナップショットのアーカイブ](https://docs.aws.amazon.com/ebs/latest/userguide/snapshot-archive.html)」を参照してください。 **例 4: 復元タイプを変更するには** 次の `restore-snapshot-tier` の例では、指定したスナップショットの復元タイプを一時的から完全に変更します。 ``` aws ec2 restore-snapshot-tier \ --snapshot-id snap-01234567890abcedf --permanent-restore ``` 出力: ``` { "SnapshotId": "snap-01234567890abcedf", "IsPermanentRestore": true } ``` スナップショットのアーカイブの詳細については、*Amazon EBS ユーザーガイド*の「[Amazon EBS スナップショットのアーカイブ](https://docs.aws.amazon.com/ebs/latest/userguide/snapshot-archive.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RestoreSnapshotTier](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/restore-snapshot-tier.html)」を参照してください。 ### `revoke-client-vpn-ingress` 次のコード例は、`revoke-client-vpn-ingress` を使用する方法を示しています。 **AWS CLI** **クライアント VPN エンドポイントの承認ルールを取り消すには** 次の `revoke-client-vpn-ingress` の例では、すべてのグループのインターネットアクセス (`0.0.0.0/0`) のルールを取り消します。 ``` aws ec2 revoke-client-vpn-ingress \ --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ --target-network-cidr 0.0.0.0/0 --revoke-all-groups ``` 出力: ``` { "Status": { "Code": "revoking" } } ``` 詳細については、「*AWS Client VPN 管理者ガイド*」の「[Authorization Rules](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-rules.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RevokeClientVpnIngress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/revoke-client-vpn-ingress.html)」を参照してください。 ### `revoke-security-group-egress` 次のコード例は、`revoke-security-group-egress` を使用する方法を示しています。 **AWS CLI** **例 1: 特定のアドレス範囲へのアウトバウンドトラフィックを許可するルールを削除するには** 次の `revoke-security-group-egress` の例では、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}] ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 ユーザーガイド*」の「[Security groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-security-groups.html)」を参照してください。 **例 2: 特定のセキュリティグループへのアウトバウンドトラフィックを許可するルールを削除するには** 次の `revoke-security-group-egress` の例では、TCP ポート 80 で指定されたセキュリティグループへのアクセスを付与するルールを削除します。 ``` aws ec2 revoke-security-group-egress \ --group-id sg-026c12253ce15eff7 \ --ip-permissions '[{"IpProtocol": "tcp", "FromPort": 443, "ToPort": 443,"UserIdGroupPairs": [{"GroupId": "sg-06df23a01ff2df86d"}]}]' ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EC2 ユーザーガイド*」の「[Security groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-security-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RevokeSecurityGroupEgress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/revoke-security-group-egress.html)」を参照してください。 ### `revoke-security-group-ingress` 次のコード例は、`revoke-security-group-ingress` を使用する方法を示しています。 **AWS CLI** **例 1: セキュリティグループからルールを削除するには** 次の `revoke-security-group-ingress` の例では、デフォルトの VPC に指定されたセキュリティグループから、`203.0.113.0/24` アドレス範囲の TCP ポート 22 アクセスを削除します。 ``` aws ec2 revoke-security-group-ingress \ --group-name mySecurityGroup --protocol tcp \ --port 22 \ --cidr 203.0.113.0/24 ``` このコマンドが成功した場合、出力は生成されません。 詳細については、「*Amazon EC2 ユーザーガイド*」の「[Security groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-security-groups.html)」を参照してください。 **例 2: IP アクセス許可セットを使用してルールを削除するには** 次の `revoke-security-group-ingress` の例では、`ip-permissions` パラメータを使用して、ICMP メッセージ `Destination Unreachable: Fragmentation Needed and Don't Fragment was Set` (タイプ 3、コード 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}] ``` このコマンドが成功した場合、出力は生成されません。 詳細については、「*Amazon EC2 ユーザーガイド*」の「[Security groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-security-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RevokeSecurityGroupIngress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/revoke-security-group-ingress.html)」を参照してください。 ### `run-instances` 次のコード例は、`run-instances` を使用する方法を示しています。 **AWS CLI** **例 1: インスタンスをデフォルトサブネット内で起動するには** 次の `run-instances` の例では、現在のリージョンのデフォルトサブネットにタイプ `t2.micro` の単一のインスタンスを起動し、それをリージョンのデフォルト VPC のデフォルトサブネットに関連付けます。SSH (Linux) または RDP (Windows) を使用してインスタンスに接続する予定がない場合、キーペアはオプションです。 ``` aws ec2 run-instances \ --image-id ami-0abcdef1234567890 \ --instance-type t2.micro \ --key-name MyKeyPair ``` 出力: ``` { "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" } ``` **例 2: デフォルトではないサブネットでインスタンスを起動し、パブリック IP アドレスを追加するには** 次の `run-instances` の例では、デフォルト以外のサブネットで起動するインスタンスのパブリック IP アドレスをリクエストします。インスタンスは指定されたセキュリティグループに関連付けられます。 ``` 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 ``` `run-instances` の出力例については、例 1 を参照してください。 **例 3: ボリュームを追加してインスタンスを起動するには** 次の `run-instances` の例では、mapping.json で指定されたブロックデバイスマッピングを使用して、起動時に追加のボリュームをアタッチします。ブロックデバイスマッピングは、EBS ボリューム、インスタンスストアボリューム、あるいは EBS ボリュームとインスタンスストアボリュームの両方を指定できます。 ``` 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 ``` `mapping.json` の内容。この例では、サイズが 100 GiB である空の EBS ボリュームの `/dev/sdh` を追加します。 ``` [ { "DeviceName": "/dev/sdh", "Ebs": { "VolumeSize": 100 } } ] ``` `mapping.json` の内容。この例は、`ephemeral1` をインスタンスストアボリュームとして追加しています。 ``` [ { "DeviceName": "/dev/sdc", "VirtualName": "ephemeral1" } ] ``` `run-instances` の出力例については、例 1 を参照してください。 ブロックデバイスマッピングの詳細については、「*Amazon EC2 ユーザーガイド*」の「[ブロックデバイスマッピング](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html)」を参照してください。 **例 4: インスタンスを起動し、作成時にタグを追加するには** 次の `run-instances` の例では、キー `webserver` と値 `production` のタグをインスタンスに追加しています。さらに、`cost-center` キーと `cc123` の値を持つタグを、作成された EBS ボリューム (この場合はルートボリューム) に適用します。 ``` 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}]' ``` `run-instances` の出力例については、例 1 を参照してください。 **例 5: ユーザーデータを使用してインスタンスを起動するには** 次の `run-instances` の例では、インスタンスの設定スクリプトを含む `my_script.txt` というファイルにユーザーデータを渡します。このスクリプトは起動時に実行されます。 ``` 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 ``` `run-instances` の出力例については、例 1 を参照してください。 インスタンスユーザーデータの詳細については、「*Amazon EC2 ユーザーガイド*」の「[インスタンスユーザーデータの使用](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instancedata-add-user-data.html)」を参照してください。 **例 6: バーストパフォーマンスインスタンスを起動するには** 次の `run-instances` の例では、`unlimited` クレジットオプションを使用して t2.micro インスタンスを起動しています。T2 インスタンスを起動する際に `--credit-specification` を指定しない場合、デフォルトは `standard` クレジットオプションです。T3 インスタンスを起動する際、デフォルトは `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 ``` `run-instances` の出力例については、例 1 を参照してください。 バーストパフォーマンスインスタンスの詳細については、「*Amazon EC2 ユーザーガイド*」の「[バーストパフォーマンスインスタンス](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RunInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/run-instances.html)」を参照してください。 ### `run-scheduled-instances` 次のコード例は、`run-scheduled-instances` を使用する方法を示しています。 **AWS CLI** **スケジュールされたインスタンスを起動するには** この例では、VPC で指定されたスケジュールされたインスタンスを起動します。 コマンド: ``` 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" } } ``` 出力: ``` { "InstanceIdSet": [ "i-1234567890abcdef0" ] } ``` この例では、EC2-Classic で指定されたスケジュールされたインスタンスを起動します。 コマンド: ``` 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" } } ``` 出力: ``` { "InstanceIdSet": [ "i-1234567890abcdef0" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RunScheduledInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/run-scheduled-instances.html)」を参照してください。 ### `search-local-gateway-routes` 次のコード例は、`search-local-gateway-routes` を使用する方法を示しています。 **AWS CLI** **ローカルゲートウェイのルートテーブル内のルートを検索するには** 次の `search-local-gateway-routes` の例では、指定されたローカルゲートウェイのルートテーブルで静的ルートを検索します。 ``` aws ec2 search-local-gateway-routes \ --local-gateway-route-table-id lgw-rtb-059615ef7dEXAMPLE \ --filters "Name=type,Values=static" ``` 出力: ``` { "Route": { "DestinationCidrBlock": "0.0.0.0/0", "LocalGatewayVirtualInterfaceGroupId": "lgw-vif-grp-07145b276bEXAMPLE", "Type": "static", "State": "deleted", "LocalGatewayRouteTableId": "lgw-rtb-059615ef7EXAMPLE" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SearchLocalGatewayRoutes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/search-local-gateway-routes.html)」を参照してください。 ### `search-transit-gateway-multicast-groups` 次のコード例は、`search-transit-gateway-multicast-groups` を使用する方法を示しています。 **AWS CLI** **つまたは複数の Transit Gateway マルチキャストグループを検索し、グループメンバーシップ情報を返すには** 次の `search-transit-gateway-multicast-groups` の例では、指定されたマルチキャストグループのグループメンバーシップを返します。 ``` aws ec2 search-transit-gateway-multicast-groups \ --transit-gateway-multicast-domain-id tgw-mcast-domain-000fb24d04EXAMPLE ``` 出力: ``` { "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" } ] } ``` 詳細については、*Transit Gateways ガイド*の「[Transit Gateways でのマルチキャスト](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-multicast-overview.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SearchTransitGatewayMulticastGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/search-transit-gateway-multicast-groups.html)」を参照してください。 ### `search-transit-gateway-routes` 次のコード例は、`search-transit-gateway-routes` を使用する方法を示しています。 **AWS CLI** **指定された Transit Gateway のルートテーブルでルートを検索するには** 次の `search-transit-gateway-routes` の例では、指定されたルートテーブルでタイプ `static` であるすべてのルートを返します。 ``` aws ec2 search-transit-gateway-routes \ --transit-gateway-route-table-id tgw-rtb-0a823edbdeEXAMPLE \ --filters "Name=type,Values=static" ``` 出力: ``` { "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 } ``` 詳細については、「*Transit Gateways ガイド*」の「[Transit gateway route tables](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SearchTransitGatewayRoutes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/search-transit-gateway-routes.html)」を参照してください。 ### `send-diagnostic-interrupt` 次のコード例は、`send-diagnostic-interrupt` を使用する方法を示しています。 **AWS CLI** **診断割り込みを送信送信するには** 次の `send-diagnostic-interrupt` の例では、指定されたインスタンスに診断割り込みを送信します。 ``` aws ec2 send-diagnostic-interrupt \ --instance-id i-1234567890abcdef0 ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SendDiagnosticInterrupt](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/send-diagnostic-interrupt.html)」を参照してください。 ### `start-instances` 次のコード例は、`start-instances` を使用する方法を示しています。 **AWS CLI** **Amazon EC2 インスタンスを開始するには** この例では、指定された Amazon EBS-backed インスタンスを開始します。 コマンド: ``` aws ec2 start-instances --instance-ids i-1234567890abcdef0 ``` 出力: ``` { "StartingInstances": [ { "InstanceId": "i-1234567890abcdef0", "CurrentState": { "Code": 0, "Name": "pending" }, "PreviousState": { "Code": 80, "Name": "stopped" } } ] } ``` 詳細については、「*Amazon Elastic Compute Cloud ユーザーガイド*」の「インスタンスの停止と起動」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/start-instances.html)」を参照してください。 ### `start-network-insights-access-scope-analysis` 次のコード例は、`start-network-insights-access-scope-analysis` を使用する方法を示しています。 **AWS CLI** **ネットワークインサイトのアクセス範囲分析を開始するには** 次の `start-network-insights-access-scope-analysis` の例では、AWS アカウントで選択した範囲分析の結果を取得します。 ``` aws ec2 start-network-insights-access-scope-analysis \ --region us-east-1 \ --network-insights-access-scope-id nis-123456789111 ``` 出力: ``` { "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" } } ``` 詳細については、「*Network Access Analyzer ガイド*」の「[Getting started with Network Access Analyzer using the AWS CLI](https://docs.aws.amazon.com/vpc/latest/network-access-analyzer/getting-started-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartNetworkInsightsAccessScopeAnalysis](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/start-network-insights-access-scope-analysis.html)」を参照してください。 ### `start-network-insights-analysis` 次のコード例は、`start-network-insights-analysis` を使用する方法を示しています。 **AWS CLI** **パスを分析するには** 次の `start-network-insights-analysis` の例では、送信元と送信先の間のパスを分析します。パス分析の結果を表示するには、`describe-network-insights-analyses` コマンドを使用します。 ``` aws ec2 start-network-insights-analysis \ --network-insights-path-id nip-0b26f224f1d131fa8 ``` 出力: ``` { "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" } } ``` 詳細については、「*Reachability Analyzer ガイド*」の「[Getting started using the AWS CLI](https://docs.aws.amazon.com/vpc/latest/reachability/getting-started-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartNetworkInsightsAnalysis](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/start-network-insights-analysis.html)」を参照してください。 ### `start-vpc-endpoint-service-private-dns-verification` 次のコード例は、`start-vpc-endpoint-service-private-dns-verification` を使用する方法を示しています。 **AWS CLI** **DNS 検証プロセスを開始するには** 次の `start-vpc-endpoint-service-private-dns-verification` 例では、指定されたエンドポイントサービスの DNS 検証プロセスを開始します。 ``` aws ec2 start-vpc-endpoint-service-private-dns-verification \ --service-id vpce-svc-071afff70666e61e0 ``` このコマンドでは何も出力されません。 詳細については、「*AWS PrivateLink ユーザーガイド*」の「[Manage DNS names](https://docs.aws.amazon.com/vpc/latest/privatelink/manage-dns-names.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartVpcEndpointServicePrivateDnsVerification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/start-vpc-endpoint-service-private-dns-verification.html)」を参照してください。 ### `stop-instances` 次のコード例は、`stop-instances` を使用する方法を示しています。 **AWS CLI** **例 1: Amazon EC2 インスタンスを停止するには** 次の `stop-instances` の例では、Amazon EBS-backed インスタンスを停止します。 ``` aws ec2 stop-instances \ --instance-ids i-1234567890abcdef0 ``` 出力: ``` { "StoppingInstances": [ { "InstanceId": "i-1234567890abcdef0", "CurrentState": { "Code": 64, "Name": "stopping" }, "PreviousState": { "Code": 16, "Name": "running" } } ] } ``` 詳細については、「*Amazon Elastic Compute Cloud ユーザーガイド*」の「[インスタンスの停止と起動](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html)」を参照してください。 **例 2: Amazon EC2 インスタンスを休止するには** 次の `stop-instances` の例では、休止が有効で、休止の前提条件を満たしている場合に Amazon EBS-backed インスタンスを休止します。インスタンスが休止状態になると、インスタンスは停止されます。 ``` aws ec2 stop-instances \ --instance-ids i-1234567890abcdef0 \ --hibernate ``` 出力: ``` { "StoppingInstances": [ { "CurrentState": { "Code": 64, "Name": "stopping" }, "InstanceId": "i-1234567890abcdef0", "PreviousState": { "Code": 16, "Name": "running" } } ] } ``` 詳細については、「*Amazon Elastic Compute Cloud ユーザーガイド*」の「[オンデマンド Linux インスタンスの休止方法](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/stop-instances.html)」を参照してください。 ### `terminate-client-vpn-connections` 次のコード例は、`terminate-client-vpn-connections` を使用する方法を示しています。 **AWS CLI** **クライアント VPN エンドポイントへの接続を終了するには** 次の `terminate-client-vpn-connections` の例では、クライアント VPN エンドポイントへの指定された接続を終了します。 ``` aws ec2 terminate-client-vpn-connections \ --client-vpn-endpoint-id vpn-endpoint-123456789123abcde \ --connection-id cvpn-connection-04edd76f5201e0cb8 ``` 出力: ``` { "ClientVpnEndpointId": "vpn-endpoint-123456789123abcde", "ConnectionStatuses": [ { "ConnectionId": "cvpn-connection-04edd76f5201e0cb8", "PreviousStatus": { "Code": "active" }, "CurrentStatus": { "Code": "terminating" } } ] } ``` 詳細については、「*AWS Client VPN 管理者ガイド*」の「[Client Connections](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-connections.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TerminateClientVpnConnections](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/terminate-client-vpn-connections.html)」を参照してください。 ### `terminate-instances` 次のコード例は、`terminate-instances` を使用する方法を示しています。 **AWS CLI** **Amazon EC2 インスタンスを終了するには** この例では、指定されたインスタンスを終了します。 コマンド: ``` aws ec2 terminate-instances --instance-ids i-1234567890abcdef0 ``` 出力: ``` { "TerminatingInstances": [ { "InstanceId": "i-1234567890abcdef0", "CurrentState": { "Code": 32, "Name": "shutting-down" }, "PreviousState": { "Code": 16, "Name": "running" } } ] } ``` 詳細については、「*AWS コマンドラインインターフェイスユーザーガイド*」で Amazon EC2 インスタンスの使用方法を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TerminateInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/terminate-instances.html)」を参照してください。 ### `unassign-ipv6-addresses` 次のコード例は、`unassign-ipv6-addresses` を使用する方法を示しています。 **AWS CLI** **ネットワークインターフェイスから IPv6 アドレスを割り当て解除するには** この例では、指定されたネットワークインターフェイスから指定された IPv6 アドレスの割り当てを解除します。 コマンド: ``` aws ec2 unassign-ipv6-addresses --ipv6-addresses 2001:db8:1234:1a00:3304:8879:34cf:4071 --network-interface-id eni-23c49b68 ``` 出力: ``` { "NetworkInterfaceId": "eni-23c49b68", "UnassignedIpv6Addresses": [ "2001:db8:1234:1a00:3304:8879:34cf:4071" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UnassignIpv6Addresses](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/unassign-ipv6-addresses.html)」を参照してください。 ### `unassign-private-ip-addresses` 次のコード例は、`unassign-private-ip-addresses` を使用する方法を示しています。 **AWS CLI** **ネットワークインターフェイスからセカンダリプライベート IP アドレスの割り当てを解除するには** この例では、指定されたネットワークインターフェイスから指定されたプライベート IP アドレスの割り当てを解除します。コマンドが成功した場合、出力は返りません。 コマンド: ``` aws ec2 unassign-private-ip-addresses --network-interface-id eni-e5aa89a3 --private-ip-addresses 10.0.0.82 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UnassignPrivateIpAddresses](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/unassign-private-ip-addresses.html)」を参照してください。 ### `unassign-private-nat-gateway-address` 次のコード例は、`unassign-private-nat-gateway-address` を使用する方法を示しています。 **AWS CLI** **プライベート NAT ゲートウェイからプライベート IP アドレスの割り当てを解除するには** 次の `unassign-private-nat-gateway-address` の例では、指定されたプライベート NAT ゲートウェイから指定された IP アドレスの割り当てを解除します。 ``` aws ec2 unassign-private-nat-gateway-address \ --nat-gateway-id nat-1234567890abcdef0 \ --private-ip-addresses 10.0.20.197 ``` 出力: ``` { "NatGatewayId": "nat-0ee3edd182361f662", "NatGatewayAddresses": [ { "NetworkInterfaceId": "eni-0065a61b324d1897a", "PrivateIp": "10.0.20.197", "IsPrimary": false, "Status": "unassigning" } ] } ``` 詳細については、「*Amazon VPC ユーザーガイド*」の「[NAT ゲートウェイ](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UnassignPrivateNatGatewayAddress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/unassign-private-nat-gateway-address.html)」を参照してください。 ### `unlock-snapshot` 次のコード例は、`unlock-snapshot` を使用する方法を示しています。 **AWS CLI** **スナップショットをロック解除するには** 次の `unlock-snapshot` の例では、指定したスナップショットのロックを解除します。 ``` aws ec2 unlock-snapshot \ --snapshot-id snap-0b5e733b4a8df6e0d ``` 出力: ``` { "SnapshotId": "snap-0b5e733b4a8df6e0d" } ``` 詳細については、「*Amazon EBS ユーザーガイド*」の「[Snapshot lock](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-snapshot-lock.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UnlockSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/unlock-snapshot.html)」を参照してください。 ### `unmonitor-instances` 次のコード例は、`unmonitor-instances` を使用する方法を示しています。 **AWS CLI** **インスタンスの詳細モニタリングを無効にするには** このコマンド例は、指定されたインスタンスの詳細モニタリングを無効にします。 コマンド: ``` aws ec2 unmonitor-instances --instance-ids i-1234567890abcdef0 ``` 出力: ``` { "InstanceMonitorings": [ { "InstanceId": "i-1234567890abcdef0", "Monitoring": { "State": "disabling" } } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UnmonitorInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/unmonitor-instances.html)」を参照してください。 ### `update-security-group-rule-descriptions-egress` 次のコード例は、`update-security-group-rule-descriptions-egress` を使用する方法を示しています。 **AWS CLI** **アウトバウンドセキュリティグループのルールの説明を更新するには** 次の `update-security-group-rule-descriptions-egress` の例では、指定したポートと IPv4 アドレス範囲のセキュリティグループルールの説明を更新します。説明 '`Outbound HTTP access to server 2`' は、ルールの既存の説明を置き換えます。 ``` 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"}] ``` 出力: ``` { "Return": true } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[セキュリティグループのルール](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-security-groups.html#security-group-rules)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateSecurityGroupRuleDescriptionsEgress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/update-security-group-rule-descriptions-egress.html)」を参照してください。 ### `update-security-group-rule-descriptions-ingress` 次のコード例は、`update-security-group-rule-descriptions-ingress` を使用する方法を示しています。 **AWS CLI** **例 1: CIDR ソースを使用してインバウンドセキュリティグループのルールの説明を更新するには** 次の `update-security-group-rule-descriptions-ingress` の例では、指定したポートと IPv4 アドレス範囲のセキュリティグループルールの説明を更新します。説明 '`SSH access from ABC office`' は、ルールの既存の説明を置き換えます。 ``` 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"}]' ``` 出力: ``` { "Return": true } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[セキュリティグループのルール](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-security-groups.html#security-group-rules)」を参照してください。 **例 2: プレフィックスリストソースを使用してインバウンドセキュリティグループのルールの説明を更新するには** 次の `update-security-group-rule-descriptions-ingress` の例では、指定したポートとプレフィックスリストのセキュリティグループルールの説明を更新します。説明 '`SSH access from ABC office`' は、ルールの既存の説明を置き換えます。 ``` 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"}]' ``` 出力: ``` { "Return": true } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[セキュリティグループのルール](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-security-groups.html#security-group-rules)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateSecurityGroupRuleDescriptionsIngress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/update-security-group-rule-descriptions-ingress.html)」を参照してください。 ### `withdraw-byoip-cidr` 次のコード例は、`withdraw-byoip-cidr` を使用する方法を示しています。 **AWS CLI** **アドレス範囲のアドバタイズを停止するには** 次の `withdraw-byoip-cidr` の例では、指定したアドレス範囲のアドバタイズを中止します。 ``` aws ec2 withdraw-byoip-cidr --cidr 203.0.113.25/24 ``` 出力: ``` { "ByoipCidr": { "Cidr": "203.0.113.25/24", "StatusMessage": "ipv4pool-ec2-1234567890abcdef0", "State": "advertised" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[WithdrawByoipCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/withdraw-byoip-cidr.html)」を参照してください。 # AWS CLI を使用した Amazon EC2 Instance Connect の例 次のコード例は、Amazon EC2 Instance Connect で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `send-ssh-public-key` 次のコード例は、`send-ssh-public-key` を使用する方法を示しています。 **AWS CLI** **SSH パブリックキーをインスタンスに送信するには** 次の `send-ssh-public-key` 例では、指定された SSH パブリックキーを指定されたインスタンスに送信します。このキーは、指定されたユーザーを認証するために使用されます。 ``` 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 ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SendSshPublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2-instance-connect/send-ssh-public-key.html)」を参照してください。 # AWS CLI を使用した Amazon ECR の例 次のコード例は、Amazon ECR で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `batch-check-layer-availability` 次のコード例は、`batch-check-layer-availability` を使用する方法を示しています。 **AWS CLI** **レイヤーの可用性を確認するには** 次の `batch-check-layer-availability` の例では、`cluster-autoscaler` リポジトリ内のダイジェスト `sha256:6171c7451a50945f8ddd72f7732cc04d7a0d1f48138a426b2e64387fdeb834ed` を持つレイヤーの可用性をチェックします。 ``` aws ecr batch-check-layer-availability \ --repository-name cluster-autoscaler \ --layer-digests sha256:6171c7451a50945f8ddd72f7732cc04d7a0d1f48138a426b2e64387fdeb834ed ``` 出力: ``` { "layers": [ { "layerDigest": "sha256:6171c7451a50945f8ddd72f7732cc04d7a0d1f48138a426b2e64387fdeb834ed", "layerAvailability": "AVAILABLE", "layerSize": 2777, "mediaType": "application/vnd.docker.container.image.v1+json" } ], "failures": [] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchCheckLayerAvailability](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/batch-check-layer-availability.html)」を参照してください。 ### `batch-delete-image` 次のコード例は、`batch-delete-image` を使用する方法を示しています。 **AWS CLI** **例 1: イメージを削除するには** 次の `batch-delete-image` の例では、アカウントのデフォルトレジストリの指定されたリポジトリに `precise` タグが付いたイメージを削除します。 ``` aws ecr batch-delete-image \ --repository-name ubuntu \ --image-ids imageTag=precise ``` 出力: ``` { "failures": [], "imageIds": [ { "imageTag": "precise", "imageDigest": "sha256:19665f1e6d1e504117a1743c0a3d3753086354a38375961f2e665416ef4b1b2f" } ] } ``` **例 2: 複数のイメージを削除するには** 次の `batch-delete-image` の例では、指定されたリポジトリ内の `prod` と `team1` でタグ付けされたすべてのイメージを削除します。 ``` aws ecr batch-delete-image \ --repository-name MyRepository \ --image-ids imageTag=prod imageTag=team1 ``` 出力: ``` { "imageIds": [ { "imageDigest": "sha256:123456789012", "imageTag": "prod" }, { "imageDigest": "sha256:567890121234", "imageTag": "team1" } ], "failures": [] } ``` 詳細については、「*Amazon ECR ユーザーガイド*」の「[イメージの削除](https://docs.aws.amazon.com/AmazonECR/latest/userguide/delete_image.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchDeleteImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/batch-delete-image.html)」を参照してください。 ### `batch-get-image` 次のコード例は、`batch-get-image` を使用する方法を示しています。 **AWS CLI** **例 1: イメージを取得するには** 次の `batch-get-image` の例では、アカウントのデフォルトレジストリで `cluster-autoscaler` と呼ばれるリポジトリ内の `v1.13.6` タグを持つイメージを取得します。 ``` aws ecr batch-get-image \ --repository-name cluster-autoscaler \ --image-ids imageTag=v1.13.6 ``` 出力: ``` { "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": [] } ``` **例 2: 複数のイメージを取得するには** 次の `batch-get-image` の例では、指定されたリポジトリ内の `prod` と `team1` でタグ付けされたすべてのイメージの詳細を表示します。 ``` aws ecr batch-get-image \ --repository-name MyRepository \ --image-ids imageTag=prod imageTag=team1 ``` 出力: ``` { "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": [] } ``` 詳細については、「*Amazon ECR ユーザーガイド*」の「[イメージ](https://docs.aws.amazon.com/AmazonECR/latest/userguide/images.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchGetImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/batch-get-image.html)」を参照してください。 ### `complete-layer-upload` 次のコード例は、`complete-layer-upload` を使用する方法を示しています。 **AWS CLI** **イメージレイヤーのアップロードを完了するには** 次の `complete-layer-upload` の例では、`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 ``` 出力: ``` { "uploadId": "6cb64b8a-9378-0e33-2ab1-b780fab8a9e9", "layerDigest": "sha256:9a77f85878aa1906f2020a0ecdf7a7e962d57e882250acd773383224b3fe9a02", "repositoryName": "layer-test", "registryId": "130757420319" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CompleteLayerUpload](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/complete-layer-upload.html)」を参照してください。 ### `create-repository` 次のコード例は、`create-repository` を使用する方法を示しています。 **AWS CLI** **例 1: リポジトリを作成するには** 次の `create-repository` の例では、アカウントのデフォルトレジストリ内の指定された名前空間にリポジトリを作成します。 ``` aws ecr create-repository \ --repository-name project-a/sample-repo ``` 出力: ``` { "repository": { "registryId": "123456789012", "repositoryName": "project-a/sample-repo", "repositoryArn": "arn:aws:ecr:us-west-2:123456789012:repository/project-a/sample-repo" } } ``` 詳細については、「*Amazon ECR ユーザーガイド*」の「[リポジトリの作成](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-create.html)」を参照してください。 **例 2: イメージタグのイミュータビリティが設定されたリポジトリを作成する場合** 次の `create-repository` の例では、アカウントのデフォルトレジストリ内にタグのイミュータビリティが設定されたリポジトリを作成します。 ``` aws ecr create-repository \ --repository-name project-a/sample-repo \ --image-tag-mutability IMMUTABLE ``` 出力: ``` { "repository": { "registryId": "123456789012", "repositoryName": "project-a/sample-repo", "repositoryArn": "arn:aws:ecr:us-west-2:123456789012:repository/project-a/sample-repo", "imageTagMutability": "IMMUTABLE" } } ``` 詳細については、「*Amazon ECR ユーザーガイド*」の「[イメージタグの変更可能性](https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-tag-mutability.html)」を参照してください。 **例 3: スキャン設定が設定されたリポジトリを作成する場合** 次の `create-repository` の例では、アカウントのデフォルトレジストリ内でイメージプッシュに対して脆弱性スキャンを実行するように設定されたリポジトリを作成します。 ``` aws ecr create-repository \ --repository-name project-a/sample-repo \ --image-scanning-configuration scanOnPush=true ``` 出力: ``` { "repository": { "registryId": "123456789012", "repositoryName": "project-a/sample-repo", "repositoryArn": "arn:aws:ecr:us-west-2:123456789012:repository/project-a/sample-repo", "imageScanningConfiguration": { "scanOnPush": true } } } ``` 詳細については、「*Amazon ECR ユーザーガイド*」の「[イメージスキャン](https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/create-repository.html)」を参照してください。 ### `delete-lifecycle-policy` 次のコード例は、`delete-lifecycle-policy` を使用する方法を示しています。 **AWS CLI** **リポジトリのライフサイクルポリシーを削除するには** 次の `delete-lifecycle-policy` の例では、`hello-world` リポジトリのライフサイクルポリシーを削除します。 ``` aws ecr delete-lifecycle-policy \ --repository-name hello-world ``` 出力: ``` { "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 } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteLifecyclePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/delete-lifecycle-policy.html)」を参照してください。 ### `delete-repository-policy` 次のコード例は、`delete-repository-policy` を使用する方法を示しています。 **AWS CLI** **リポジトリのリポジトリポリシーを削除するには** 次の `delete-repository-policy` の例では、`cluster-autoscaler` リポジトリのリポジトリポリシーを削除します。 ``` aws ecr delete-repository-policy \ --repository-name cluster-autoscaler ``` 出力: ``` { "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}" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRepositoryPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/delete-repository-policy.html)」を参照してください。 ### `delete-repository` 次のコード例は、`delete-repository` を使用する方法を示しています。 **AWS CLI** **リポジトリを削除するには** () 次のコマンドフォース `delete-repository` の例では、アカウントのデフォルトレジストリ内の指定されたリポジトリを削除します。リポジトリにイメージが含まれている場合は、`--force` フラグが必要です。 ``` aws ecr delete-repository \ --repository-name ubuntu \ --force ``` 出力: ``` { "repository": { "registryId": "123456789012", "repositoryName": "ubuntu", "repositoryArn": "arn:aws:ecr:us-west-2:123456789012:repository/ubuntu" } } ``` 詳細については、「*Amazon ECR ユーザーガイド*」の「[リポジトリの削除](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/delete-repository.html)」を参照してください。 ### `describe-image-scan-findings` 次のコード例は、`describe-image-scan-findings` を使用する方法を示しています。 **AWS CLI** **イメージのスキャンの検出結果を記述するには** 次の `describe-image-scan-findings` の例では、アカウントのデフォルトレジストリの指定されたリポジトリでイメージダイジェストを使用して、イメージのイメージスキャン結果を返します。 ``` aws ecr describe-image-scan-findings \ --repository-name sample-repo \ --image-id imageDigest=sha256:74b2c688c700ec95a93e478cdb959737c148df3fbf5ea706abe0318726e885e6 ``` 出力: ``` { "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." } } ``` 詳細については、「*Amazon ECR ユーザーガイド*」の「[イメージスキャン](https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeImageScanFindings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/describe-image-scan-findings.html)」を参照してください。 ### `describe-images` 次のコード例は、`describe-images` を使用する方法を示しています。 **AWS CLI** **リポジトリ内のイメージを記述する場合** 次の `describe-images` の例では、`cluster-autoscaler` リポジトリ内でタグ `v1.13.6` が付いているイメージに関する詳細を表示します。 ``` aws ecr describe-images \ --repository-name cluster-autoscaler \ --image-ids imageTag=v1.13.6 ``` 出力: ``` { "imageDetails": [ { "registryId": "012345678910", "repositoryName": "cluster-autoscaler", "imageDigest": "sha256:4a1c6567c38904384ebc64e35b7eeddd8451110c299e3368d2210066487d97e5", "imageTags": [ "v1.13.6" ], "imageSizeInBytes": 48318255, "imagePushedAt": 1565128275.0 } ] } ``` + API の詳細については、「AWS CLI コマンドリファレンス」の「[DescribeImages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/describe-images.html)」を参照してください。 ### `describe-repositories` 次のコード例は、`describe-repositories` を使用する方法を示しています。 **AWS CLI** **レジストリ内のリポジトリを記述するには** この例は、アカウントのデフォルトレジストリ内のリポジトリを記述します。 コマンド: ``` aws ecr describe-repositories ``` 出力: ``` { "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" } ] } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeRepositories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/describe-repositories.html)」を参照してください。** ### `get-authorization-token` 次のコード例は、`get-authorization-token` を使用する方法を示しています。 **AWS CLI** **デフォルトレジストリ用の認可トークンを取得する場合** 次のコマンド `get-authorization-token` の例では、デフォルトレジストリ用の認可トークンを取得します。 ``` aws ecr get-authorization-token ``` 出力: ``` { "authorizationData": [ { "authorizationToken": "QVdTOkN...", "expiresAt": 1448875853.241, "proxyEndpoint": "https://123456789012.dkr.ecr.us-west-2.amazonaws.com" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAuthorizationToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/get-authorization-token.html)」を参照してください。 ### `get-download-url-for-layer` 次のコード例は、`get-download-url-for-layer` を使用する方法を示しています。 **AWS CLI** **レイヤーのダウンロード URL を取得するには** 次の `get-download-url-for-layer` の例は、`cluster-autoscaler` リポジトリ内のダイジェスト `sha256:6171c7451a50945f8ddd72f7732cc04d7a0d1f48138a426b2e64387fdeb834ed` を含むレイヤーのダウンロード URL を示しています。 ``` aws ecr get-download-url-for-layer \ --repository-name cluster-autoscaler \ --layer-digest sha256:6171c7451a50945f8ddd72f7732cc04d7a0d1f48138a426b2e64387fdeb834ed ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDownloadUrlForLayer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/get-download-url-for-layer.html)」を参照してください。 ### `get-lifecycle-policy-preview` 次のコード例は、`get-lifecycle-policy-preview` を使用する方法を示しています。 **AWS CLI** **ライフサイクルポリシープレビューの詳細を取得するには** 次の `get-lifecycle-policy-preview` 例では、アカウントのデフォルトレジストリで指定されたリポジトリのライフサイクルポリシープレビューの結果を取得します。 コマンド: ``` aws ecr get-lifecycle-policy-preview \ --repository-name "project-a/amazon-ecs-sample" ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon ECR ユーザーガイド*」の「[ライフサイクルポリシー](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetLifecyclePolicyPreview](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/get-lifecycle-policy-preview.html)」を参照してください。 ### `get-lifecycle-policy` 次のコード例は、`get-lifecycle-policy` を使用する方法を示しています。 **AWS CLI** **ライフサイクルポリシーを取得するには** 次の `get-lifecycle-policy` 例では、アカウントのデフォルトレジストリで、指定されたリポジトリのライフサイクルポリシーの詳細を表示します。 ``` aws ecr get-lifecycle-policy \ --repository-name "project-a/amazon-ecs-sample" ``` 出力: ``` { "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 } ``` 詳細については、「*Amazon ECR ユーザーガイド*」の「[ライフサイクルポリシー](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetLifecyclePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/get-lifecycle-policy.html)」を参照してください。 ### `get-login-password` 次のコード例は、`get-login-password` を使用する方法を示しています。 **AWS CLI** **レジストリに認証するパスワードを取得するには** 次の `get-login-password` は、IAM プリンシパルがアクセスできる Amazon ECR レジストリに対して認証するために、選択したコンテナクライアントで使用できるパスワードを示しています。 ``` aws ecr get-login-password ``` 出力: ``` ``` Docker CLI で使用するには、`get-login-password` コマンドの出力を `docker login` コマンドにパイプします。パスワードを取得するときは、Amazon ECR レジストリが存在するのと同じリージョンを指定する必要があります。 ``` aws ecr get-login-password \ --region \ | docker login \ --username AWS \ --password-stdin .dkr.ecr..amazonaws.com ``` 詳細については、「[Amazon ECR ユーザーガイド](https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries#registry_auth)」の「*レジストリの認証*」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetLoginPassword](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/get-login-password.html)」を参照してください。 ### `get-login` 次のコード例は、`get-login` を使用する方法を示しています。 **AWS CLI** **デフォルトのレジストリに Docker ログインコマンドを取得するには** この例では、デフォルトの Amazon ECR レジストリにログインするために使用できるコマンドをプリントします。 コマンド: ``` aws ecr get-login ``` 出力: ``` docker login -u AWS -p -e none https://.dkr.ecr..amazonaws.com ``` **別のアカウントのレジストリにログインするには** この例では、他のアカウントに関連付けられた Amazon ECR レジストリにログインするために使用できる 1 つ以上のコマンドをプリントします。 コマンド: ``` aws ecr get-login --registry-ids 012345678910 023456789012 ``` 出力: ``` docker login -u -p -e none docker login -u -p -e none ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetLogin](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/get-login.html)」を参照してください。 ### `get-repository-policy` 次のコード例は、`get-repository-policy` を使用する方法を示しています。 **AWS CLI** **リポジトリのリポジトリポリシーを取得するには** 次の `get-repository-policy` の例では、`cluster-autoscaler` リポジトリのリポジトリポリシーの詳細を表示します。 ``` aws ecr get-repository-policy \ --repository-name cluster-autoscaler ``` 出力: ``` { "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}" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRepositoryPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/get-repository-policy.html)」を参照してください。 ### `initiate-layer-upload` 次のコード例は、`initiate-layer-upload` を使用する方法を示しています。 **AWS CLI** **イメージレイヤーのアップロードを開始するには** 次の `initiate-layer-upload` 例では、`layer-test` リポジトリへのイメージレイヤーのアップロードを開始します。 ``` aws ecr initiate-layer-upload \ --repository-name layer-test ``` 出力: ``` { "partSize": 10485760, "uploadId": "6cb64b8a-9378-0e33-2ab1-b780fab8a9e9" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[InitiateLayerUpload](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/initiate-layer-upload.html)」を参照してください。 ### `list-images` 次のコード例は、`list-images` を使用する方法を示しています。 **AWS CLI** **リポジトリ内のイメージを一覧表示するには** 次の `list-images` の例は、`cluster-autoscaler` リポジトリ内のイメージのリストを表示します。 ``` aws ecr list-images \ --repository-name cluster-autoscaler ``` 出力: ``` { "imageIds": [ { "imageDigest": "sha256:99c6fb4377e9a420a1eb3b410a951c9f464eff3b7dbc76c65e434e39b94b6570", "imageTag": "v1.13.8" }, { "imageDigest": "sha256:99c6fb4377e9a420a1eb3b410a951c9f464eff3b7dbc76c65e434e39b94b6570", "imageTag": "v1.13.7" }, { "imageDigest": "sha256:4a1c6567c38904384ebc64e35b7eeddd8451110c299e3368d2210066487d97e5", "imageTag": "v1.13.6" } ] } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[ListImages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/list-images.html)」を参照してください。** ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **リポジトリのタグを一覧表示するには** 次の `list-tags-for-resource` の例は、`hello-world` リポジトリに関連するタグのリストを表示します。 ``` aws ecr list-tags-for-resource \ --resource-arn arn:aws:ecr:us-west-2:012345678910:repository/hello-world ``` 出力: ``` { "tags": [ { "Key": "Stage", "Value": "Integ" } ] } ``` + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/list-tags-for-resource.html)」を参照してください。 ### `put-image-scanning-configuration` 次のコード例は、`put-image-scanning-configuration` を使用する方法を示しています。 **AWS CLI** **リポジトリのイメージスキャン設定を更新するには** 次の `put-image-scanning-configuration` 例では、指定されたリポジトリのイメージスキャン設定を更新します。 ``` aws ecr put-image-scanning-configuration \ --repository-name sample-repo \ --image-scanning-configuration scanOnPush=true ``` 出力: ``` { "registryId": "012345678910", "repositoryName": "sample-repo", "imageScanningConfiguration": { "scanOnPush": true } } ``` 詳細については、「*Amazon ECR ユーザーガイド*」の「[イメージスキャン](https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutImageScanningConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/put-image-scanning-configuration.html)」を参照してください。 ### `put-image-tag-mutability` 次のコード例は、`put-image-tag-mutability` を使用する方法を示しています。 **AWS CLI** **リポジトリのイメージタグの変更可能性の設定を更新するには** 次の `put-image-tag-mutability` の例では、タグのイミュータビリティを確保するため指定されたリポジトリを設定します。これにより、リポジトリ内のすべてのイメージタグが上書きされるのを防ぎます。 ``` aws ecr put-image-tag-mutability \ --repository-name hello-repository \ --image-tag-mutability IMMUTABLE ``` 出力: ``` { "registryId": "012345678910", "repositoryName": "sample-repo", "imageTagMutability": "IMMUTABLE" } ``` 詳細については、「*Amazon ECR ユーザーガイド*」の「[イメージタグの変更可能性](https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-tag-mutability.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutImageTagMutability](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/put-image-tag-mutability.html)」を参照してください。 ### `put-image` 次のコード例は、`put-image` を使用する方法を示しています。 **AWS CLI** **マニフェストを使用してイメージにタグを付け直すには** 次の `put-image` 例では、既存のイメージマニフェストを使用して `hello-world` リポジトリに新しいタグを作成します。 ``` aws ecr put-image \ --repository-name hello-world \ --image-tag 2019.08 \ --image-manifest file://hello-world.manifest.json ``` `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" } ] } ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/put-image.html)」を参照してください。 ### `put-lifecycle-policy` 次のコード例は、`put-lifecycle-policy` を使用する方法を示しています。 **AWS CLI** **ライフサイクルポリシーを作成するには** 次の `put-lifecycle-policy` 例では、アカウントのデフォルトレジストリに指定されたリポジトリのライフサイクルポリシーを作成します。 ``` aws ecr put-lifecycle-policy \ --repository-name "project-a/amazon-ecs-sample" \ --lifecycle-policy-text "file://policy.json" ``` `policy.json` の内容: ``` { "rules": [ { "rulePriority": 1, "description": "Expire images older than 14 days", "selection": { "tagStatus": "untagged", "countType": "sinceImagePushed", "countUnit": "days", "countNumber": 14 }, "action": { "type": "expire" } } ] } ``` 出力: ``` { "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\"}}]}" } ``` 詳細については、「*Amazon ECR ユーザーガイド*」の「[ライフサイクルポリシー](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[PutLifeCyclePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/put-life-cycle-policy.html)」を参照してください。 ### `set-repository-policy` 次のコード例は、`set-repository-policy` を使用する方法を示しています。 **AWS CLI** **リポジトリのリポジトリポリシーを設定するには** 次の `set-repository-policy` の例では、ファイルに含まれるリポジトリポリシーを `cluster-autoscaler` リポジトリにアタッチします。 ``` aws ecr set-repository-policy \ --repository-name cluster-autoscaler \ --policy-text file://my-policy.json ``` `my-policy.json` の内容: ``` { "Version":"2012-10-17", "Statement" : [ { "Sid" : "allow public pull", "Effect" : "Allow", "Principal" : "*", "Action" : [ "ecr:BatchCheckLayerAvailability", "ecr:BatchGetImage", "ecr:GetDownloadUrlForLayer" ] } ] } ``` 出力: ``` { "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}" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetRepositoryPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/set-repository-policy.html)」を参照してください。 ### `start-image-scan` 次のコード例は、`start-image-scan` を使用する方法を示しています。 **AWS CLI** **イメージ脆弱性スキャンを開始するには** 次の `start-image-scan` 例では、イメージスキャンを開始し、指定されたリポジトリのイメージダイジェストで指定します。 ``` aws ecr start-image-scan \ --repository-name sample-repo \ --image-id imageDigest=sha256:74b2c688c700ec95a93e478cdb959737c148df3fbf5ea706abe0318726e885e6 ``` 出力: ``` { "registryId": "012345678910", "repositoryName": "sample-repo", "imageId": { "imageDigest": "sha256:74b2c688c700ec95a93e478cdb959737c148df3fbf5ea706abe0318726e885e6" }, "imageScanStatus": { "status": "IN_PROGRESS" } } ``` 詳細については、「*Amazon ECR ユーザーガイド*」の「[イメージスキャン](https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartImageScan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/start-image-scan.html)」を参照してください。 ### `start-lifecycle-policy-preview` 次のコード例は、`start-lifecycle-policy-preview` を使用する方法を示しています。 **AWS CLI** **ライフサイクルポリシーのプレビューを作成するには** 次の `start-lifecycle-policy-preview` の例では、指定されたリポジトリに対して JSON ファイルで定義されたライフサイクルポリシーのプレビューを作成します。 ``` aws ecr start-lifecycle-policy-preview \ --repository-name "project-a/amazon-ecs-sample" \ --lifecycle-policy-text "file://policy.json" ``` `policy.json` の内容: ``` { "rules": [ { "rulePriority": 1, "description": "Expire images older than 14 days", "selection": { "tagStatus": "untagged", "countType": "sinceImagePushed", "countUnit": "days", "countNumber": 14 }, "action": { "type": "expire" } } ] } ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartLifecyclePolicyPreview](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/start-lifecycle-policy-preview.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **リポジトリにタグを付けるには** 次の `tag-resource` の例では、`hello-world` レポジトリのキー `Stage` と値 `Integ` でタグを設定します。 ``` aws ecr tag-resource \ --resource-arn arn:aws:ecr:us-west-2:012345678910:repository/hello-world \ --tags Key=Stage,Value=Integ ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **リポジトリのタグを解除するには** 次の `untag-resource` の例では、`Stage` というキーのタグを `hello-world` リポジトリから削除します。 ``` aws ecr untag-resource \ --resource-arn arn:aws:ecr:us-west-2:012345678910:repository/hello-world \ --tag-keys Stage ``` このコマンドでは何も出力されません。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/untag-resource.html)」を参照してください。 ### `upload-layer-part` 次のコード例は、`upload-layer-part` を使用する方法を示しています。 **AWS CLI** **レイヤーパートをアップロードするには** 以下の `upload-layer-part` は、イメージレイヤーパートを `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 ``` 出力: ``` { "uploadId": "6cb64b8a-9378-0e33-2ab1-b780fab8a9e9", "registryId": "012345678910", "lastByteReceived": 8323314, "repositoryName": "layer-test" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UploadLayerPart](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/upload-layer-part.html)」を参照してください。 # AWS CLI を使用した Amazon ECR パブリックの例 次のコード例は、Amazon ECR Public で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `batch-delete-image` 次のコード例は、`batch-delete-image` を使用する方法を示しています。 **AWS CLI** **例 1: イメージダイジェスト ID を使用してイメージを削除するために、パブリックレジストリ内のリポジトリからイメージとそのすべてのタグが削除される** 次の `batch-delete-image` の例では、イメージダイジェストを指定してイメージを削除します。 ``` aws ecr-public batch-delete-image \ --repository-name project-a/nginx-web-app \ --image-ids imageDigest=sha256:b1f9deb5fe3711a3278379ebbcaefbc5d70a2263135db86bd27a0dae150546c2 ``` 出力: ``` { "imageIds": [ { "imageDigest": "sha256:b1f9deb5fe3711a3278379ebbcaefbc5d70a2263135db86bd27a0dae150546c2", "imageTag": "latest" } ], "failures": [] } ``` 詳細については、*Amazon ECR Public ユーザーガイド*の「[パブリックリポジトリからのイメージの削除](https://docs.aws.amazon.com/AmazonECR/latest/public/public-image-delete.html)」を参照してください。 **例 2: リポジトリから削除するイメージに関連付けられているタグを指定してイメージを削除するには** 次の `batch-delete-image` の例では、パブリックレジストリ内の `project-a/nginx-web-app` という名前のイメージリポジトリに関連付けられているタグを指定してイメージを削除します。タグが 1 つしかない場合、このコマンドを実行すると、イメージが削除されます。同じイメージに複数のタグがある場合は、1 つのタグを指定すると、そのタグのみがリポジトリから削除され、イメージ自体は削除されません。 ``` aws ecr-public batch-delete-image \ --repository-name project-a/nginx-web-app \ --image-ids imageTag=_temp ``` 出力: ``` { "imageIds": [ { "imageDigest": "sha256:f7a86a0760e2f8d7eff07e515fc87bf4bac45c35376c06f9a280f15ecad6d7e0", "imageTag": "_temp" } ], "failures": [] } ``` 詳細については、*Amazon ECR Public ユーザーガイド*の「[パブリックリポジトリからのイメージの削除](https://docs.aws.amazon.com/AmazonECR/latest/public/public-image-delete.html)」を参照してください。 **例 3: パブリックレジストリ内のリポジトリに対するリクエストで複数のイメージタグまたはイメージダイジェストを指定して、複数のイメージを削除するには** 次の `batch-delete-image` の例では、リクエストで複数のイメージタグまたはイメージダイジェストを指定することで、project-a/nginx-web-app という名前のリポジトリから複数のイメージを削除します。 ``` aws ecr-public batch-delete-image \ --repository-name project-a/nginx-web-app \ --image-ids imageTag=temp2.0 imageDigest=sha256:47ba980bc055353d9c0af89b1894f68faa43ca93856917b8406316be86f01278 ``` 出力: ``` { "imageIds": [ { "imageDigest": "sha256:47ba980bc055353d9c0af89b1894f68faa43ca93856917b8406316be86f01278" }, { "imageDigest": "sha256:f7a86a0760e2f8d7eff07e515fc87bf4bac45c35376c06f9a280f15ecad6d7e0", "imageTag": "temp2.0" } ], "failures": [] } ``` 詳細については、*Amazon ECR Public ユーザーガイド*の「[パブリックリポジトリからのイメージの削除](https://docs.aws.amazon.com/AmazonECR/latest/public/public-image-delete.html)」を参照してください。 **例 4: レジストリ ID とイメージダイジェスト ID を使用してクロス AWS アカウントのイメージを削除するために、パブリックレジストリ内のリポジトリからイメージとそのすべてのタグが削除される** 次の `batch-delete-image` の例では、クロス 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 ``` 出力: ``` { "imageIds": [ { "imageDigest": "sha256:b1f9deb5fe3711a3278379ebbcaefbc5d70a2263135db86bd27a0dae150546c2", "imageTag": "temp2.0" } ], "failures": [] } ``` 詳細については、*Amazon ECR Public ユーザーガイド*の「[パブリックリポジトリからのイメージの削除](https://docs.aws.amazon.com/AmazonECR/latest/public/public-image-delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchDeleteImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/batch-delete-image.html)」を参照してください。 ### `create-repository` 次のコード例は、`create-repository` を使用する方法を示しています。 **AWS CLI** **例 1: パブリックレジストリにリポジトリを作成するには** 次の `create-repository` の例では、パブリックレジストリに project-a/nginx-web-app という名前のリポジトリを作成します。 ``` aws ecr-public create-repository \ --repository-name project-a/nginx-web-app ``` 出力: ``` { "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": {} } ``` 詳細については、*Amazon ECR Public ユーザーガイド*の「[パブリックリポジトリの作成](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-create.html)」を参照してください。 **例 2: リポジトリ内のイメージと互換性があるリポジトリ、システム、およびオペレーションアーキテクチャの内容を簡単に記述して、パブリックレジストリにリポジトリを作成するには** 次の `create-repository` の例では、パブリックレジストリに project-a/nginx-web-app という名前のリポジトリを作成し、そのリポジトリの内容について、さらに、そのリポジトリ内のイメージと互換性のあるシステムとオペレーティングアーキテクチャについて、簡単な説明を追加します。 ``` 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' ``` 出力: ``` { "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" ] } } ``` 詳細については、*Amazon ECR Public ユーザーガイド*の「[パブリックリポジトリの作成](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-create.html)」を参照してください。 **例 3: logoImageBlob、aboutText、usageText、タグ情報と一緒にパブリックレジストリにリポジトリを作成するには** 次の `create-repository` の例では、project-a/nginx-web-app という名前のリポジトリを、logoImageBlob、aboutText、usageText、タグ情報と一緒にパブリックレジストリに作成します。 ``` aws ecr-public create-repository \ --cli-input-json file://myfile.json ``` `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" } ] } ``` 出力: ``` { "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." } } ``` 詳細については、「*Amazon ECR Public ユーザーガイド*」の「[パブリックリポジトリの作成](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-create.html)」および「*Amazon ECR Public ユーザーガイド*」の「[リポジトリカタログデータ](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-catalog-data.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/create-repository.html)」を参照してください。 ### `delete-repository-policy` 次のコード例は、`delete-repository-policy` を使用する方法を示しています。 **AWS CLI** **パブリックレジストリのリポジトリに関するポリシーを削除するには** 次の `delete-repository-policy` の例では、AWS アカウントの ECR Public リポジトリに関するポリシーを削除します。 ``` aws ecr-public delete-repository-policy \ --repository-name project-a/nginx-web-app \ --region us-east-1 ``` 出力: ``` { "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}" } ``` 詳細については、*Amazon ECR Public ユーザーガイド*の「[パブリックリポジトリのポリシーステートメントの削除](https://docs.aws.amazon.com/AmazonECR/latest/public/delete-public-repository-policy.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRepositoryPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/delete-repository-policy.html)」を参照してください。 ### `delete-repository` 次のコード例は、`delete-repository` を使用する方法を示しています。 **AWS CLI** **パブリックレジストリのリポジトリを削除するには** 次の `delete-repository` の例では、パブリックレジストリから `project-a/nginx-web-app` という名前のリポジトリを削除します。 ``` aws ecr-public delete-repository \ --repository-name project-a/nginx-web-app ``` 出力: ``` { "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" } } ``` 詳細については、[Amazon ECR Public](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-delete.html) の「*パブリックリポジトリの削除*」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/delete-repository.html)」を参照してください。 ### `describe-image-tags` 次のコード例は、`describe-image-tags` を使用する方法を示しています。 **AWS CLI** **例 1: パブリックリポジトリのイメージタグの詳細を取得するには** 次の `describe-image-tags` の例では、`project-a/nginx-web-app` サンプルリポジトリ内のイメージタグについて説明します。 ``` aws ecr-public describe-image-tags \ --repository-name project-a/nginx-web-app \ --region us-east-1 ``` 出力: ``` { "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" } } ] } ``` + API の詳細については、*AWS CLI コマンドリファレンス*の「[DescribeImageTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/describe-image-tags.html)」を参照してください。 ### `describe-images` 次のコード例は、`describe-images` を使用する方法を示しています。 **AWS CLI** **例 1: パブリックレジストリリポジトリ内のイメージの詳細を取得するには** 次の `describe-images` の例では、パブリックレジストリ内の `project-a/nginx-web-app` という名前のリポジトリ内の imagesDetails の詳細を取得します。 ``` aws ecr-public describe-images \ --repository-name project-a/nginx-web-app \ --region us-east-1 ``` 出力: ``` { "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" } ] } ``` 詳細については、*Amazon ECR Public* の「[パブリックリポジトリのイメージの詳細を取得する](https://docs.aws.amazon.com/AmazonECR/latest/public/docker-push-multi-architecture-image.html)」を参照してください。 **例 2: リポジトリからイメージを imageTags と imagePushedAt でソートして詳細を取得するには** 次の `describe-images` の例では、パブリックレジストリ内の project-a/nginx-web-app という名前のリポジトリ内のイメージの詳細を取得します。 ``` aws ecr-public describe-images \ --repository-name project-a/nginx-web-app \ --query 'sort_by(imageDetails,& imagePushedAt)[*].imageTags[*]' \ --output text ``` 出力: ``` temp3.0 latest temp1.0 temp2.0 ``` **例 3: リポジトリにプッシュされた最後の 2 つのイメージタグを生成するためにリポジトリからイメージの詳細を取得するには** 次の `describe-images` の例では、パブリックレジストリ内の `project-a/nginx-web-app` という名前のリポジトリからイメージタグの詳細を取得し、結果に対してクエリを実行して最初の 2 つのレコードのみを表示します。 ``` aws ecr-public describe-images \ --repository-name project-a/nginx-web-app \ --query 'sort_by(imageDetails,& imagePushedAt)[*].imageTags[*] | [0:2]' \ --output text ``` 出力: ``` temp3.0 latest temp1.0 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeImages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/describe-images.html)」を参照してください。 ### `describe-registries` 次のコード例は、`describe-registries` を使用する方法を示しています。 **AWS CLI** **パブリックレジストリ内のすべてのレジストリの詳細を取得するには** 次の `describe-registries` の例では、アカウントのすべてのレジストリの詳細を取得します。 ``` aws ecr-public describe-registries ``` 出力: ``` { "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 } ] } ] } ``` + API の詳細については、*AWS CLI コマンドリファレンス*の「[DescribeRegistries](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/describe-registries.html)」を参照してください。 ### `describe-repository` 次のコード例は、`describe-repository` を使用する方法を示しています。 **AWS CLI** **例 1: パブリックレジストリ内のリポジトリの詳細を取得するには** 次の `describe-repositories` の例では、パブリックレジストリ内の `project-a/nginx-web-app` という名前のリポジトリの詳細を取得します。 ``` aws ecr-public describe-repositories \ --repository-name project-a/nginx-web-app ``` 出力: ``` { "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" } ] } ``` **例 2: パブリックレジストリ内のすべてのリポジトリの詳細を表形式で表示するには** 次の `describe-repositories` の例では、パブリックレジストリ内のすべてのリポジトリの詳細を取得し、リポジトリ名を表形式で出力します。 ``` aws ecr-public describe-repositories \ --region us-east-1 \ --output table \ --query "repositories[*].repositoryName" ``` 出力: ``` ----------------------------- | DescribeRepositories | +---------------------------+ | project-a/nginx-web-app | | nginx | | myfirstrepo1 | | helm-test-chart | | test-ecr-public | | nginx-web-app | | sample-repo | +---------------------------+ ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeRepository](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/describe-repository.html)」を参照してください。 ### `get-authorization-token` 次のコード例は、`get-authorization-token` を使用する方法を示しています。 **AWS CLI** **例 1: IAM プリンシパルがアクセスできる Amazon ECR パブリックレジストリの認可トークンを取得するには** 次の `get-authorization-token` の例では、AWS CLI を使用して認可トークンを取得し、環境変数に設定します。 ``` aws ecr-public get-authorization-token \ --region us-east-1 ``` 出力: ``` { "authorizationData": { "authorizationToken": "QVdTOmV5SndZWGxzYjJKJFHDSFKJHERWUY65IOU36TRYEGFNSDLRIUOTUYTHJKLDFGOcmFUQk9OSFV2UVV4a0x6Sm1ZV0Z6TDFndlZtUjJSVmgxVEVObU9IZEdTWEZxU210c1JUQm5RWGxOUVV4NlNFUnROWG92ZWtGbWJFUjRkbWMyV0U5amFpczRNWGxTVkM5Tk5qWkVUM2RDYm05TVJqSkxjV3BsUVZvMmFYSm5iV1ZvVFdGSVRqVlFMMHN4VnpsTGVXbDFRWGRoTmpsbWFuQllhbVl6TkdGaGMwUjJha2xsYUhscWRscHZTRUpFVkVnNVQwNUdOVFpPY2xZclVFNVFVWGRSVFZvd04xUkhjVGxZZFVkQ1ZFZHBPRUptUzBVclYxQldMMjVMVkRsd2VFVlNSa1EzTWpWSlIxRkVWakJGZFZOVWEzaFBSVk5FWWpSc1lWZHZWMHBSYmxaMlJYWmhZekpaWVVOeFppdFlUa2xKU1RCdFUwdElVbXRJYlhGRk1WaFhNVTVRTkdwc1FYRlVNVWxZZUhkV05Xa3ZXWGd3ZUVZMWIyeE5VRU5QZEdSaWRHOU9lakZOZVdwTVZEUkNRVzlvYzNKSlpsRXhhR2cwWjJwRVJFVjNWalEzYjNCUmRIcEZUR1pYU1Rsc1kxSlNNbU5hUW5wRE1tOUpRMHR5Y1hkeGNXNDVMMmx4Um5GUlVGQnhjMVpQZG5WYUswOW9SQ3RPY0hwSlRsUk5lVXQyY0c1b1FsQjVZVEprVmtSdmJsQklOM05RU3pkNmQydERhMkZ5VmxSRmFVUndWVlE1ZGtsVWFXUkJWMFZEWVhoSFdXTk5VMXBTYTFreVRHZEVlVVZ0ZFRWRk4xTTVjRXBDUjBRMlYyTkdPVWhGWkVweVVGcEVaRFJxZUVablkwNXFaamh5YkVKWmJGSTNOVzFXSzFjdllXSTVTMWx2YUZacksxSnJWSFJ0Wml0T1NFSnpWVFZvV204eVFYbzFWRU5SYjNaR01Va3hPR3h2TWxkNVJsSmpUbTVSTjNjemJsUkdVRlZKVDBjeE9VeHlXVEpGVFRSS2NWbFdkVEJrV0VreFVsSktXbkpCVGtsMFdVZEJOMjltWjFFNGVHRktNbGRuWlVoUlNXNXdZV3A0VjI5M2FYZGljbE5tZGpkQ1ZYTmhOVFUyTDBzeVpteDBka0pUTVdkNGJ6TkxkSEJDYml0cE0waGhTbVpEZEZkQ00yOU1TM1pXTDNSVFlWaFpWelZXVWxjNFRXNXdhR3BhUmpoU1FuWnFkRlJMVW5abGRYRlNjVVJKZDBaSFpXUTRabEZUTUdOTVQwcFFkVXAyYjA5Tk9UaFlZMjEwVnpFMlpXdE9hMnBWV0hST1owUkpVV3R1VFU1dGJXWjNNVGc0VTAxUlNHZE9TbXRMY2tWYWJVeFljVVk0ZWpsTFdWWlRNbEZMVDJkMk1FaFBTMDl5YzJSM1NqTlplRGhUWVVOQlJGWnRlbkU1WTBKVFdqTktSR05WTkd0RGNEVjZNalJHVXpkVk9HTnVSa2xLUVd4SVJDODJXbGcyYldGemJVczJPRVp6TDBoNFMwWkRUMmdyYldGa1QwWjVhMlZQTm5SQ1l6QkpNbFpyVUhSaGVIbFVOR296VjFGVlQyMHpNeTlPWVVoSk1FdDBWalZFU2pneU5rcHNLemQxZDNwcVp6RlNja3AwVm10VU0yRnRWWGMzZDJnMFduSnFjVXczWTBjclNXeHFUVlUyVkZwWGNWY3ZSV0V6WW1oT2JIRklZVlJHU1RrMGEyOVJiMHBPVUhORk9FdERjbFJZY0daS2VVdHRZa2x5YjFORE4zSkJaWEJPZUU5eGR6WnhZMlY1WXprM1JtSkZhVFZFYkVFck5EUk9ZMWRyVEVNd1dqa2lMQ0prWVhSaGEyVjVJam9pWlhsS1VWSkdaMmxQYVVwV1ZXeENhVk5YVm14WFdFWk5VMjFrV21SRE9YaGFhWFF4VkhwS1MyTkljSHBVUms0MFlWaHNTbUpIYUhsWFZHdDZZVWhqZDFKRmFETldNbFYyWTJ0cmVVMUlTbHBWUjJONFRURlJNMDlHYUd4U01uaHVWRVJzUWxaV1pGZFJibkJLV1RCYU5HTXpUakpXTUhoWFRrWndhRTVyTVVwVFZFSkdWV3RzTUZaVVpEQlRSVGxyVkVkb2FGUlVVWHBaTVhCSFQxWmFOVlJxU20xaVZXUnVTM3BaTlZaV2NIcFdWMlJGVkcwMVRHSXdSakpXUnpoNlVsUm5kbUpzUmpGT2FUazFWVzFTY0dWR1FtOVdiVEZoVmpKc1NWRllhRmRTUkZwc1V6SkdSbUpWYkhCVlNFbDJWVzB4Ym1OVk1IWmFhelZ3WkZoa1FtVnFUa3BpTTJoTVRWVk9jMVo2V2t4aWJFWnJWRVUxVW1ONlp6QldWVFZPWW14c01sZFlZekprUjFwVFkxaE9kRnBXWkhaVFZWcGhWa2MxU2xWRlVtdFRiWE16WWpOVmVrNXFSa2RVTTJSd1QwaGtXbVJIVVhsbGJYQkRaRlp2ZGxvd1ZqWmlNbEl4Vkc1T2FtSldjRU5VU0ZVd1kwZDRjbU14WkhaVVYwNTRaRzV2TWxSVlVsQmpiSEJPVkc1VmVsZEZPVzVYYkVwWlUyNWtVbGRZWkZWaVdFWlNUVzF3VFZSSVFraE9XRnBwWVZoak0xUnJXak5OYm04eFpEQk9XbEZzYkhSTmEyaHpaRmRTUTJORVFUQlpWMk01VUZOSmMwbHJiRUpTUTBrMlNXNUZlbHA2U1RGVVZXeFVZekIwYVU5RWFEVmtiRVpzVVZWc2QxbHJWbmxOYW13MVZWaG9UazVzVWpWbFJHaDZZMjFHVkZVeFFubFZXRTVLVGpCMGFXSlZNWGhpUjBwTVlUSTVNRTVVYXpCTE0wVnlWakF4VG1WSE5VcGtSa0pRVld4V1UwOVdVWGhqTVc4eVZraFdlVnA2VGsxV01tUnhVV3Q0ZEdGcVRsUk5hMnN5V2tSV2FtUkdVakZqVm5CUFVrUlNjR0pHUm1GbGFscDRXV2x6Y2xFd1VYcGhSRnBZVmtaU2FVNXVSVFZYYlVaVFpXdHdkVmRZVGpaVGEyaDBWMnhDVlU0elZrWlRSRUpIVlVWa2MwNVlhRFZsUkVwelQwWkNSbE5WY0ZGWFNFWXhaVmMxVEZsVE9VeFdhMGt4V1ROS1Rrd3pXazFpYkhCdFVrUldWRlJHVlhaTmJVazBZbFZzUkV3d2N6UldSV2MxVDBWa05tSXpiM2hXVms1V1ZtMDFiRkZUT1hoUFJVcHpUMGRzU2xaSVJrTkxNVTVFWWtaa05WWnViRmRYVjJRd1RXcG5kMVJWUmpCa1JYQkdZVlYwZFZNeU1VVlpWVTVQV25wa1ExZHFVbE5sUjBaRVlWVTFXbVZwY3pSTE1HTTFVbFZGTlZwRll6UlRSMVoxVFcxb05XTnJkRUpWZWxsM1RETmplbUV4WkdGU1JsWm9ZVVpzZEdWR2JFTlVNblJYVkRCNE5HUXlkRXhaTWxKTlYxZDBWRTB5YUZwaFJsazFVMGR3Y0ZGVk9YaGxhekV6VVZRd09VbHVNRDBpTENKMlpYSnphVzl1SWpvaU15SXNJblI1Y0dVaU9pSkVRVlJCWDB0RldTSXNJbVY0Y0dseVlYUnBiMjRpT2pFM01qRTVOVGMzTmpKOQ==", "expiresAt": "2024-07-25T21:37:26.301000-04:00" } } ``` 詳細については、*Amazon ECR Public* の「[Amazon ECR パブリックレジストリ](https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#registry_auth_http)」を参照してください。 **例 2: IAM プリンシパルがアクセスできる Amazon ECR パブリックレジストリの認可トークンを取得するには** 次の `get-authorization-token` の例では、AWS CLI を使用して認可トークンを取得し、環境変数に設定します。 ``` aws ecr-public get-authorization-token \ --region us-east-1 \ --output=text \ --query 'authorizationData.authorizationToken' ``` 出力: ``` QVdTOmV5SndZWGxzYjJKJFHDSFKJHERWUY65IOU36TRYEGFNSDLRIUOTUYTHJKLDFGOcmFUQk9OSFV2UVV4a0x6Sm1ZV0Z6TDFndlZtUjJSVmgxVEVObU9IZEdTWEZxU210c1JUQm5RWGxOUVV4NlNFUnROWG92ZWtGbWJFUjRkbWMyV0U5amFpczRNWGxTVkM5Tk5qWkVUM2RDYm05TVJqSkxjV3BsUVZvMmFYSm5iV1ZvVFdGSVRqVlFMMHN4VnpsTGVXbDFRWGRoTmpsbWFuQllhbVl6TkdGaGMwUjJha2xsYUhscWRscHZTRUpFVkVnNVQwNUdOVFpPY2xZclVFNVFVWGRSVFZvd04xUkhjVGxZZFVkQ1ZFZHBPRUptUzBVclYxQldMMjVMVkRsd2VFVlNSa1EzTWpWSlIxRkVWakJGZFZOVWEzaFBSVk5FWWpSc1lWZHZWMHBSYmxaMlJYWmhZekpaWVVOeFppdFlUa2xKU1RCdFUwdElVbXRJYlhGRk1WaFhNVTVRTkdwc1FYRlVNVWxZZUhkV05Xa3ZXWGd3ZUVZMWIyeE5VRU5QZEdSaWRHOU9lakZOZVdwTVZEUkNRVzlvYzNKSlpsRXhhR2cwWjJwRVJFVjNWalEzYjNCUmRIcEZUR1pYU1Rsc1kxSlNNbU5hUW5wRE1tOUpRMHR5Y1hkeGNXNDVMMmx4Um5GUlVGQnhjMVpQZG5WYUswOW9SQ3RPY0hwSlRsUk5lVXQyY0c1b1FsQjVZVEprVmtSdmJsQklOM05RU3pkNmQydERhMkZ5VmxSRmFVUndWVlE1ZGtsVWFXUkJWMFZEWVhoSFdXTk5VMXBTYTFreVRHZEVlVVZ0ZFRWRk4xTTVjRXBDUjBRMlYyTkdPVWhGWkVweVVGcEVaRFJxZUVablkwNXFaamh5YkVKWmJGSTNOVzFXSzFjdllXSTVTMWx2YUZacksxSnJWSFJ0Wml0T1NFSnpWVFZvV204eVFYbzFWRU5SYjNaR01Va3hPR3h2TWxkNVJsSmpUbTVSTjNjemJsUkdVRlZKVDBjeE9VeHlXVEpGVFRSS2NWbFdkVEJrV0VreFVsSktXbkpCVGtsMFdVZEJOMjltWjFFNGVHRktNbGRuWlVoUlNXNXdZV3A0VjI5M2FYZGljbE5tZGpkQ1ZYTmhOVFUyTDBzeVpteDBka0pUTVdkNGJ6TkxkSEJDYml0cE0waGhTbVpEZEZkQ00yOU1TM1pXTDNSVFlWaFpWelZXVWxjNFRXNXdhR3BhUmpoU1FuWnFkRlJMVW5abGRYRlNjVVJKZDBaSFpXUTRabEZUTUdOTVQwcFFkVXAyYjA5Tk9UaFlZMjEwVnpFMlpXdE9hMnBWV0hST1owUkpVV3R1VFU1dGJXWjNNVGc0VTAxUlNHZE9TbXRMY2tWYWJVeFljVVk0ZWpsTFdWWlRNbEZMVDJkMk1FaFBTMDl5YzJSM1NqTlplRGhUWVVOQlJGWnRlbkU1WTBKVFdqTktSR05WTkd0RGNEVjZNalJHVXpkVk9HTnVSa2xLUVd4SVJDODJXbGcyYldGemJVczJPRVp6TDBoNFMwWkRUMmdyYldGa1QwWjVhMlZQTm5SQ1l6QkpNbFpyVUhSaGVIbFVOR296VjFGVlQyMHpNeTlPWVVoSk1FdDBWalZFU2pneU5rcHNLemQxZDNwcVp6RlNja3AwVm10VU0yRnRWWGMzZDJnMFduSnFjVXczWTBjclNXeHFUVlUyVkZwWGNWY3ZSV0V6WW1oT2JIRklZVlJHU1RrMGEyOVJiMHBPVUhORk9FdERjbFJZY0daS2VVdHRZa2x5YjFORE4zSkJaWEJPZUU5eGR6WnhZMlY1WXprM1JtSkZhVFZFYkVFck5EUk9ZMWRyVEVNd1dqa2lMQ0prWVhSaGEyVjVJam9pWlhsS1VWSkdaMmxQYVVwV1ZXeENhVk5YVm14WFdFWk5VMjFrV21SRE9YaGFhWFF4VkhwS1MyTkljSHBVUms0MFlWaHNTbUpIYUhsWFZHdDZZVWhqZDFKRmFETldNbFYyWTJ0cmVVMUlTbHBWUjJONFRURlJNMDlHYUd4U01uaHVWRVJzUWxaV1pGZFJibkJLV1RCYU5HTXpUakpXTUhoWFRrWndhRTVyTVVwVFZFSkdWV3RzTUZaVVpEQlRSVGxyVkVkb2FGUlVVWHBaTVhCSFQxWmFOVlJxU20xaVZXUnVTM3BaTlZaV2NIcFdWMlJGVkcwMVRHSXdSakpXUnpoNlVsUm5kbUpzUmpGT2FUazFWVzFTY0dWR1FtOVdiVEZoVmpKc1NWRllhRmRTUkZwc1V6SkdSbUpWYkhCVlNFbDJWVzB4Ym1OVk1IWmFhelZ3WkZoa1FtVnFUa3BpTTJoTVRWVk9jMVo2V2t4aWJFWnJWRVUxVW1ONlp6QldWVFZPWW14c01sZFlZekprUjFwVFkxaE9kRnBXWkhaVFZWcGhWa2MxU2xWRlVtdFRiWE16WWpOVmVrNXFSa2RVTTJSd1QwaGtXbVJIVVhsbGJYQkRaRlp2ZGxvd1ZqWmlNbEl4Vkc1T2FtSldjRU5VU0ZVd1kwZDRjbU14WkhaVVYwNTRaRzV2TWxSVlVsQmpiSEJPVkc1VmVsZEZPVzVYYkVwWlUyNWtVbGRZWkZWaVdFWlNUVzF3VFZSSVFraE9XRnBwWVZoak0xUnJXak5OYm04eFpEQk9XbEZzYkhSTmEyaHpaRmRTUTJORVFUQlpWMk01VUZOSmMwbHJiRUpTUTBrMlNXNUZlbHA2U1RGVVZXeFVZekIwYVU5RWFEVmtiRVpzVVZWc2QxbHJWbmxOYW13MVZWaG9UazVzVWpWbFJHaDZZMjFHVkZVeFFubFZXRTVLVGpCMGFXSlZNWGhpUjBwTVlUSTVNRTVVYXpCTE0wVnlWakF4VG1WSE5VcGtSa0pRVld4V1UwOVdVWGhqTVc4eVZraFdlVnA2VGsxV01tUnhVV3Q0ZEdGcVRsUk5hMnN5V2tSV2FtUkdVakZqVm5CUFVrUlNjR0pHUm1GbGFscDRXV2x6Y2xFd1VYcGhSRnBZVmtaU2FVNXVSVFZYYlVaVFpXdHdkVmRZVGpaVGEyaDBWMnhDVlU0elZrWlRSRUpIVlVWa2MwNVlhRFZsUkVwelQwWkNSbE5WY0ZGWFNFWXhaVmMxVEZsVE9VeFdhMGt4V1ROS1Rrd3pXazFpYkhCdFVrUldWRlJHVlhaTmJVazBZbFZzUkV3d2N6UldSV2MxVDBWa05tSXpiM2hXVms1V1ZtMDFiRkZUT1hoUFJVcHpUMGRzU2xaSVJrTkxNVTVFWWtaa05WWnViRmRYVjJRd1RXcG5kMVJWUmpCa1JYQkdZVlYwZFZNeU1VVlpWVTVQV25wa1ExZHFVbE5sUjBaRVlWVTFXbVZwY3pSTE1HTTFVbFZGTlZwRll6UlRSMVoxVFcxb05XTnJkRUpWZWxsM1RETmplbUV4WkdGU1JsWm9ZVVpzZEdWR2JFTlVNblJYVkRCNE5HUXlkRXhaTWxKTlYxZDBWRTB5YUZwaFJsazFVMGR3Y0ZGVk9YaGxhekV6VVZRd09VbHVNRDBpTENKMlpYSnphVzl1SWpvaU15SXNJblI1Y0dVaU9pSkVRVlJCWDB0RldTSXNJbVY0Y0dseVlYUnBiMjRpT2pFM01qRTVOVGMzTmpKOQ ``` 詳細については、*Amazon ECR Public* の「[Amazon ECR パブリックレジストリ](https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#registry_auth_http)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAuthorizationToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/get-authorization-token.html)」を参照してください。 ### `get-login-password` 次のコード例は、`get-login-password` を使用する方法を示しています。 **AWS CLI** **例 1: Amazon ECR パブリックレジストリに docker を認証するには** 次の `get-login-password` の例では、GetAuthorizationToken API を使用して認証トークンを取得して表示します。このトークンを使用して、Amazon ECR パブリックレジストリに認証できます。 ``` aws ecr-public get-login-password \ --region us-east-1 | docker login \ --username AWS \ --password-stdin public.ecr.aws ``` このコマンドはターミナルに出力を表示せず、代わりに Docker に出力をパイプします。 詳細については、*Amazon ECR Public* の「[パブリックレジストリへの認証](https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth)」を参照してください。 **例 2: 独自のカスタム AmazonECR パブリックレジストリに docker を認証するには** 次の `get-login-password` の例では、GetAuthorizationToken API を使用して認証トークンを取得して表示します。このトークンを使用して、独自のカスタム Amazon ECR パブリックレジストリに認証できます。 ``` aws ecr-public get-login-password \ --region us-east-1 \ | docker login \ --username AWS \ --password-stdin public.ecr.aws/ ``` このコマンドはターミナルに出力を表示せず、代わりに Docker に出力をパイプします。 詳細については、*Amazon ECR Public* の「[独自の Amazon ECR Public への認証](https://docs.aws.amazon.com/AmazonECR/latest/public/public-registries.html#public-registry-auth)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetLoginPassword](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/get-login-password.html)」を参照してください。 ### `get-registry-catalog-data` 次のコード例は、`get-registry-catalog-data` を使用する方法を示しています。 **AWS CLI** **パブリック ECR レジストリのカタログメタデータを取得するには** 次の `get-registry-catalog-data` は、ECR パブリックレジストリのカタログメタデータを取得します。 ``` aws ecr-public get-registry-catalog-data \ --region us-east-1 ``` 出力: ``` { "registryCatalogData": { "displayName": "YourCustomPublicRepositoryalias" } } ``` + API の詳細については、*AWS CLI コマンドリファレンス*の「[GetRegistryCatalogData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/get-registry-catalog-data.html)」を参照してください。 ### `get-repository-catalog-data` 次のコード例は、`get-repository-catalog-data` を使用する方法を示しています。 **AWS CLI** **パブリックレジストリ内のリポジトリのカタログメタデータを取得するには** 次の `get-repository-catalog-data` の例では、パブリックレジストリ内のリポジトリ `project-a/nginx-web-app` のカタログメタデータを一覧表示します。 ``` aws ecr-public get-repository-catalog-data \ --repository-name project-a/nginx-web-app \ --region us-east-1 ``` 出力: ``` { "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## " } } ``` 詳細については、*Amazon ECR Public* の「[リポジトリカタログデータ](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-catalog-data.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[GetRepositoryCatalogData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/get-repository-catalog-data.html)」を参照してください。 ### `get-repository-policy` 次のコード例は、`get-repository-policy` を使用する方法を示しています。 **AWS CLI** **リポジトリに関連付けられているポリシーを取得するには** 次の `get-repository-policy` の例では、リポジトリに関連付けられているポリシーを取得します。 ``` aws ecr-public get-repository-policy \ --repository-name project-a/nginx-web-app \ --region us-east-1 ``` 出力: ``` { "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}" } ``` 詳細については、*Amazon ECR Public ユーザーガイド*の「[AWS SDK または CLI で GetRepositoryPolicy を使用する](https://docs.aws.amazon.com/AmazonECR/latest/userguide/example_ecr_GetRepositoryPolicy_section.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRepositoryPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/get-repository-policy.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **パブリックレジストリ内のパブリックリポジトリのタグを一覧表示するには** 次の `list-tags-for-resource` の例では、パブリックレジストリ内の `project-a/nginx-web-app` という名前のリソースのタグを一覧表示します。 ``` aws ecr-public list-tags-for-resource \ --resource-arn arn:aws:ecr-public::123456789012:repository/project-a/nginx-web-app \ --region us-east-1 ``` 出力: ``` { "tags": [ { "Key": "Environment", "Value": "Prod" }, { "Key": "stack", "Value": "dev1" }, { "Key": "Name", "Value": "project-a/nginx-web-app" } ] } ``` 詳細については、*Amazon ECR Public* の「[パブリックリポジトリのタグを一覧表示する](https://docs.aws.amazon.com/AmazonECR/latest/public/ecr-public-using-tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/list-tags-for-resource.html)」を参照してください。 ### `put-registry-catalog-data` 次のコード例は、`put-registry-catalog-data` を使用する方法を示しています。 **AWS CLI** **パブリック ECR レジストリのカタログメタデータを作成または更新するには** 次の `put-registry-catalog-data` は、ECR パブリックレジストリのカタログメタデータを作成または更新します。検証済みアカウントバッジを取得したアカウントのみがレジストリ表示名を設定できます。 ``` aws ecr-public put-registry-catalog-data \ --region us-east-1 \ --display-name ``` 出力: ``` { "registryCatalogData": { "displayName": "YourCustomPublicRepositoryalias" } } ``` + API の詳細については、*AWS CLI コマンドリファレンス*の「[PutRegistryCatalogData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/put-registry-catalog-data.html)」を参照してください。 ### `put-repository-catalog-data` 次のコード例は、`put-repository-catalog-data` を使用する方法を示しています。 **AWS CLI** **パブリックレジストリ内のリポジトリのカタログデータを作成または更新するには** 次の `put-repository-catalog-data` の例では、パブリックレジストリ内の project-a/nginx-web-app という名前のリポジトリのカタログデータを作成または更新し、logoImageBlob、aboutText、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 ``` `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." } } ``` 出力: ``` { "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." } } ``` 詳細については、*Amazon ECR Public* の「[リポジトリカタログデータ](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-catalog-data.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[PutRepositoryCatalogData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/put-repository-catalog-data.html)」を参照してください。 ### `set-repository-policy` 次のコード例は、`set-repository-policy` を使用する方法を示しています。 **AWS CLI** **例 1: リポジトリへのプルを許可するリポジトリポリシーを設定するには** 次の `set-repository-policy` の例では、指定したリポジトリに ECR パブリックリポジトリポリシーを適用して、アクセス許可を制御します。 ``` aws ecr-public set-repository-policy \ --repository-name project-a/nginx-web-app \ --policy-text file://my-repository-policy.json ``` `my-repository-policy.json` の内容: ``` { "Version":"2012-10-17", "Statement" : [ { "Sid" : "allow public pull", "Effect" : "Allow", "Principal" : "*", "Action" : [ "ecr:BatchCheckLayerAvailability", "ecr:BatchGetImage", "ecr:GetDownloadUrlForLayer" ] } ] } ``` 出力: ``` { "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}" } ``` 詳細については、*Amazon ECR Public ユーザーガイド*の「[リポジトリポリシーステートメントの設定](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-policy-examples.html)」を参照してください。 **例 2: アカウント内の IAM ユーザーがイメージをプッシュできるようにリポジトリポリシーを設定するには** 次の `set-repository-policy` の例では、お客様のアカウントの IAM ユーザーに、`file://my-repository-policy.json` という名前の入力ファイルをポリシーテキストとして使用して、AWS アカウントの ECR リポジトリにイメージをプッシュすることを許可します。 ``` aws ecr-public set-repository-policy \ --repository-name project-a/nginx-web-app \ --policy-text file://my-repository-policy.json ``` `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" ] } ] } ``` 出力: ``` { "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}" } ``` 詳細については、*Amazon ECR Public ユーザーガイド*の「[リポジトリポリシーステートメントの設定](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-policy-examples.html)」を参照してください。 **例 3: 異なるアカウントの IAM ユーザーにイメージのプッシュを許可するリポジトリポリシーを設定するには** 次の `set-repository-policy` の例では、CLI 入力ファイル file://my-repository-policy.json を使用して、指定したアカウントに、お客様の AWS アカウントのリポジトリにイメージをプッシュすることを許可します。 ``` aws ecr-public set-repository-policy \ --repository-name project-a/nginx-web-app \ --policy-text file://my-repository-policy.json ``` `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" ] } ] } ``` 出力: ``` { "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}" } ``` 詳細については、*Amazon ECR Public ユーザーガイド*の「[パブリックリポジトリポリシーの例](https://docs.aws.amazon.com/AmazonECR/latest/public/public-repository-policy-examples.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetRepositoryPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/set-repository-policy.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **例 1: パブリックレジストリ内の既存のパブリックリポジトリにタグを付けるには** 次の `tag-resource` の例では、パブリックレジストリ内の `project-a/nginx-web-app` という名前のリポジトリにタグを付けます。 ``` 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 ``` 詳細については、*Amazon ECR Public* の「[パブリックリポジトリのタグの使用](https://docs.aws.amazon.com/AmazonECR/latest/public/ecr-public-using-tags.html)」を参照してください。 **例 2: パブリックレジストリ内の既存のパブリックリポジトリに複数のタグを付けるには** 次の `tag-resource` の例では、既存のリポジトリに複数のタグを付けます。 ``` 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 ``` 詳細については、*Amazon ECR Public* の「[パブリックリポジトリのタグの使用](https://docs.aws.amazon.com/AmazonECR/latest/public/ecr-public-using-tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **例 1: パブリックレジストリ内の既存のパブリックリポジトリのタグを削除するには** 次の `untag-resource` の例では、パブリックレジストリ内の `project-a/nginx-web-app` という名前のリポジトリにタグを付けます。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、*Amazon ECR Public* の「[パブリックリポジトリのタグの使用](https://docs.aws.amazon.com/AmazonECR/latest/public/ecr-public-using-tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr-public/untag-resource.html)」を参照してください。 # AWS CLI を使用する Amazon ECS の例 次のコード例は、Amazon ECS で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `capacity-provider-update` 次のコード例は、`capacity-provider-update` を使用する方法を示しています。 **AWS CLI** **ECS クラスターのキャパシティプロバイダーを更新する** 次の `update-capacity-provider` の例では、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" ``` 出力: ``` { "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": [] } } ``` キャパシティプロバイダーの詳細については、*Amazon ECS デベロッパーガイド*の「[EC2 起動タイプ用の Amazon ECS キャパシティプロバイダー](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/asg-capacity-providers.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[CapacityProviderUpdate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/capacity-provider-update.html)」を参照してください。 ### `create-capacity-provider` 次のコード例は、`create-capacity-provider` を使用する方法を示しています。 **AWS CLI** **キャパシティープロバイダーを作成するには** 次の create-capacity-provider の例では、MyASG という名前の Auto Scaling グループを使用し、マネージドスケーリングおよびマネージド終了保護を有効にしたキャパシティープロバイダーを作成します。この構成は、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" ``` 出力: ``` { "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": [] } ``` 詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon ECS クラスター自動スケーリング](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-auto-scaling.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCapacityProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/create-capacity-provider.html)」を参照してください。 ### `create-cluster` 次のコード例は、`create-cluster` を使用する方法を示しています。 **AWS CLI** **例 1: 新しいクラスターを作成するには** 次の `create-cluster`の例では、`MyCluster` という名前のクラスターを作成し、オブザーバビリティが強化された CloudWatch Container Insights を有効にします。 ``` aws ecs create-cluster \ --cluster-name MyCluster \ --settings name=containerInsights,value=enhanced ``` 出力: ``` { "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": [] } } ``` 詳細については、「Amazon ECS ディベロッパーガイド」の「[従来のコンソールを使用したクラスターの作成](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create_cluster.html)」を参照してください。** **例 2: キャパシティプロバイダーを使用して新しいクラスターを作成するには** 次の `create-cluster` の例は、クラスターを作成し、2 つの既存のキャパシティプロバイダーをそのクラスターに関連付けます。キャパシティープロバイダーを作成するには、`create-capacity-provider` コマンドを使用します。デフォルトのキャパシティープロバイダー戦略を指定することは任意ですが、指定することをお勧めします。この例では、`MyCluster` という名前のクラスターを作成し、`MyCapacityProvider1` と `MyCapacityProvider2` をキャパシティプロバイダーに関連付けます。デフォルトのキャパシティープロバイダー戦略は、タスクを両方のキャパシティープロバイダーに均等に分散するように指定されています。 ``` aws ecs create-cluster \ --cluster-name MyCluster \ --capacity-providers MyCapacityProvider1 MyCapacityProvider2 \ --default-capacity-provider-strategy capacityProvider=MyCapacityProvider1,weight=1 capacityProvider=MyCapacityProvider2,weight=1 ``` 出力: ``` { "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" } } ``` 詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS キャパシティープロバイダー](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html)」を参照してください。** **例 3: 複数のタグを含む新しいクラスターを作成するには** 次の `create-cluster` の例は、複数のタグを含むクラスターを作成します。短縮構文を使用したタグの追加方法の詳細については、「AWS CLI ユーザーガイド」の「[AWS CLI で短縮構文を使用する](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-shorthand.html)」を参照してください。** ``` aws ecs create-cluster \ --cluster-name MyCluster \ --tags key=key1,value=value1 key=key2,value=value2 ``` 出力: ``` { "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" } ] } } ``` 詳細については、「Amazon ECS ディベロッパーガイド」の「[従来のコンソールを使用したクラスターの作成](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create_cluster.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/create-cluster.html)」を参照してください。 ### `create-service` 次のコード例は、`create-service` を使用する方法を示しています。 **AWS CLI** **例 1: Fargate タスクを使用してサービスを作成するには** 次の `create-service` の例は、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 ``` 出力: ``` { "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" } } ``` 詳細については、「Amazon ECS ディベロッパーガイド」の「[クラシックコンソール内の Amazon ECS サービスの作成](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create-service-console-v2.html)」を参照してください。** **例 2: EC2 起動タイプを使用してサービスを作成するには** 次の `create-service` の例は、EC2 起動タイプを使用して、`ecs-simple-service` と呼ばれるサービスを作成する方法を示しています。このサービスは `sleep360` タスク定義を使用し、タスクのインスタンスを 1 つ保持します。 ``` aws ecs create-service \ --cluster MyCluster \ --service-name ecs-simple-service \ --task-definition sleep360:2 \ --desired-count 1 ``` 出力: ``` { "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" } } ``` 詳細については、「Amazon ECS ディベロッパーガイド」の「[クラシックコンソール内の Amazon ECS サービスの作成](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create-service-console-v2.html)」を参照してください。** **例 3: 外部のデプロイコントローラーを使用するサービスを作成するには** 次の `create-service` の例は、外部のデプロイコントローラーを使用するサービスを作成します。 ``` aws ecs create-service \ --cluster MyCluster \ --service-name MyService \ --deployment-controller type=EXTERNAL \ --desired-count 1 ``` 出力: ``` { "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" } } ``` 詳細については、「Amazon ECS ディベロッパーガイド」の「[クラシックコンソール内の Amazon ECS サービスの作成](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create-service-console-v2.html)」を参照してください。** **例 4: ロードバランサーの背後に新しいサービスを作成するには** 次の `create-service` の例は、ロードバランサーの背後にサービスを作成する方法を示しています。コンテナインスタンスと同じリージョンに、ロードバランサーを設定する必要があります。この例では、`--cli-input-json` オプションと、以下の内容を含む JSON 入力ファイル (`ecs-simple-service-elb.json`) を使用します。 ``` aws ecs create-service \ --cluster MyCluster \ --service-name ecs-simple-service-elb \ --cli-input-json file://ecs-simple-service-elb.json ``` `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" } ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon ECS デベロッパーガイド*」の「[ロードバランサーを使用して Amazon ECS サービストラフィックを分散する](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html)」を参照してください。 **例 5: サービスの作成時に Amazon EBS ボリュームを設定するには** 次の `create-service` の例では、サービスで管理するタスクごとに Amazon EBS ボリュームを設定する方法を示します。`AmazonECSInfrastructureRolePolicyForVolumes` マネージドポリシーがアタッチされた Amazon ECS インフラストラクチャロールを設定する必要があります。`create-service` リクエストと同じボリューム名でタスク定義を指定する必要があります。この例では、`--cli-input-json` オプションと、以下の内容を含む JSON 入力ファイル (`ecs-simple-service-ebs.json`) を使用します。 ``` aws ecs create-service \ --cli-input-json file://ecs-simple-service-ebs.json ``` `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" } } ] } ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon ECS での Amazon EBS ボリュームの使用](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[CreateService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/create-service.html)」を参照してください。** ### `create-task-set` 次のコード例は、`create-task-set` を使用する方法を示しています。 **AWS CLI** **タスクセットを作成するには** 次の `create-task-set` の例は、外部のデプロイコントローラーを使用するサービスのタスクセットを作成します。 ``` aws ecs create-task-set \ --cluster MyCluster \ --service MyService \ --task-definition MyTaskDefinition:2 \ --network-configuration "awsvpcConfiguration={subnets=[subnet-12344321],securityGroups=[sg-12344321]}" ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateTaskSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/create-task-set.html)」を参照してください。 ### `delete-account-setting` 次のコード例は、`delete-account-setting` を使用する方法を示しています。 **AWS CLI** **特定の IAM ユーザーまたは IAM ロールのアカウント設定を削除するには** 次の例では、`delete-account-setting` により、特定の IAM ユーザーまたは IAM ロールのアカウント設定が削除されます。 ``` aws ecs delete-account-setting \ --name serviceLongArnFormat \ --principal-arn arn:aws:iam::123456789012:user/MyUser ``` 出力: ``` { "setting": { "name": "serviceLongArnFormat", "value": "enabled", "principalArn": "arn:aws:iam::123456789012:user/MyUser" } } ``` 詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon リソースネーム (ARN) と ID](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-resource-ids.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAccountSetting](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/delete-account-setting.html)」を参照してください。 ### `delete-attributes` 次のコード例は、`delete-attributes` を使用する方法を示しています。 **AWS CLI** **Amazon ECS リソースから 1 つ以上のカスタム属性を削除するには** 次の `delete-attributes` では、コンテナインスタンスから `stack` という名前の属性を削除します。 ``` aws ecs delete-attributes \ --attributes name=stack,targetId=arn:aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34 ``` 出力: ``` { "attributes": [ { "name": "stack", "targetId": "arn:aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34", "value": "production" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/delete-attributes.html)」を参照してください。 ### `delete-capacity-provider` 次のコード例は、`delete-capacity-provider` を使用する方法を示しています。 **AWS CLI** **例 1: Amazon リソースネーム (ARN) を使用してキャパシティプロバイダーを削除するには** 次の `delete-capacity-provider` の例では、キャパシティープロバイダーの Amazon リソースネーム (ARN) を指定して、キャパシティープロバイダーを削除します。ARN とキャパシティープロバイダーの削除のステータスは、`describe-capacity-providers` コマンドを使用して取得できます。 ``` aws ecs delete-capacity-provider \ --capacity-provider arn:aws:ecs:us-west-2:123456789012:capacity-provider/ExampleCapacityProvider ``` 出力: ``` { "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": [] } } ``` 詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS キャパシティープロバイダー](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html)」を参照してください。** **例 2: 名前を使用してキャパシティープロバイダーを削除するには** 次の `delete-capacity-provider` の例では、キャパシティープロバイダーの短縮名を指定して、キャパシティープロバイダーを削除します。短縮名とキャパシティープロバイダーの削除のステータスは、`describe-capacity-providers` コマンドを使用して取得できます。 ``` aws ecs delete-capacity-provider \ --capacity-provider ExampleCapacityProvider ``` 出力: ``` { "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": [] } } ``` 詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS キャパシティープロバイダー](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCapacityProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/delete-capacity-provider.html)」を参照してください。 ### `delete-cluster` 次のコード例は、`delete-cluster` を使用する方法を示しています。 **AWS CLI** **空のクラスターを削除するには** 次の `delete-cluster` の例は、指定された空のクラスターを削除します。 ``` aws ecs delete-cluster --cluster MyCluster ``` 出力: ``` { "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": [] } } ``` 詳細については、「Amazon ECS ディベロッパーガイド」の「[クラシックコンソールを使用してクラスターを削除するには](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/delete_cluster.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/delete-cluster.html)」を参照してください。 ### `delete-service` 次のコード例は、`delete-service` を使用する方法を示しています。 **AWS CLI** **サービスを削除する方法** 次の `ecs delete-service` の例は、指定されたサービスをクラスターから削除します。`--force` パラメータを含めると、タスクがゼロになっていない場合でも、サービスを削除することができます。 ``` aws ecs delete-service --cluster MyCluster --service MyService1 --force ``` 詳細については、「Amazon ECS ディベロッパーガイド」の「[クラシックコンソールを使用してサービスを削除するには](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/delete-service.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/delete-service.html)」を参照してください。 ### `delete-task-definitions` 次のコード例は、`delete-task-definitions` を使用する方法を示しています。 **AWS CLI** **タスク定義を削除するには** 次の `delete-task-definitions` の例では、INACTIVE タスク定義を削除します。 ``` aws ecs delete-task-definitions \ --task-definition curltest:1 ``` 出力: ``` { "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": [] } ``` 詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS のタスク定義](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteTaskDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/delete-task-definitions.html)」を参照してください。 ### `delete-task-set` 次のコード例は、`delete-task-set` を使用する方法を示しています。 **AWS CLI** **タスクセットを削除するには** 次の `delete-task-set` の例で、タスクセットを削除する方法について説明します。`--force` パラメータを含めると、タスクセットがゼロになっていない場合でも、タスクセットを削除することができます。 ``` 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 ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteTaskSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/delete-task-set.html)」を参照してください。 ### `deregister-container-instance` 次のコード例は、`deregister-container-instance` を使用する方法を示しています。 **AWS CLI** **クラスターからコンテナインスタンスの登録を解除するには** 次の `deregister-container-instance` の例では、指定されたクラスターからコンテナインスタンスを登録解除します。コンテナインスタンスでまだ実行中のタスクがある場合は、登録解除する前にそれらのタスクを停止するか、`--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 ``` 出力: ``` { "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" } } ``` 詳細については、「*ECS デベロッパーガイド*」の[「コンテナインスタンスの登録解除](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deregister_container_instance.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeregisterContainerInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/deregister-container-instance.html)」を参照してください。 ### `deregister-task-definition` 次のコード例は、`deregister-task-definition` を使用する方法を示しています。 **AWS CLI** **タスク定義の登録を解除するには** 次の `deregister-task-definition` の例では、デフォルトのリージョンで `curler` タスク定義の最初のリビジョンを登録解除します。 ``` aws ecs deregister-task-definition --task-definition curler:1 ``` 結果の出力では、タスク定義ステータスに `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 } } ``` 詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS のタスク定義](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeregisterTaskDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/deregister-task-definition.html)」を参照してください。 ### `describe-capacity-providers` 次のコード例は、`describe-capacity-providers` を使用する方法を示しています。 **AWS CLI** **例 1: すべてのキャパシティプロバイダーを記述するには** 次の `describe-capacity-providers` の例では、すべてのキャパシティプロバイダーの詳細を取得します。 ``` aws ecs describe-capacity-providers ``` 出力: ``` { "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": [] } ] } ``` 詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS キャパシティープロバイダー](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html)」を参照してください。** **例 2: 特定のキャパシティプロバイダーを記述するには** 次の `describe-capacity-providers` の例では、特定のキャパシティープロバイダーの詳細を取得します。`--include TAGS` パラメータを使用すると、キャパシティープロバイダーに関連付けられたタグが出力に追加されます。 ``` aws ecs describe-capacity-providers \ --capacity-providers MyCapacityProvider \ --include TAGS ``` 出力: ``` { "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" } ] } ] } ``` 詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS キャパシティープロバイダー](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeCapacityProviders](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/describe-capacity-providers.html)」を参照してください。 ### `describe-clusters` 次のコード例は、`describe-clusters` を使用する方法を示しています。 **AWS CLI** **例 1: クラスターを記述するには** 次の `describe-clusters` の例は、指定されたクラスターの詳細情報を取得します。 ``` aws ecs describe-clusters \ --cluster default ``` 出力: ``` { "clusters": [ { "status": "ACTIVE", "clusterName": "default", "registeredContainerInstancesCount": 0, "pendingTasksCount": 0, "runningTasksCount": 0, "activeServicesCount": 1, "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/default" } ], "failures": [] } ``` 詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS Clusters](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_clusters.html)」を参照してください。** **例 2: 添付ファイルオプションを使用してクラスターを記述するには** 次の `describe-clusters` の例は、添付ファイルオプションを指定します。指定されたクラスターの詳細情報と、クラスターにアタッチされているリソースのリストを添付ファイルの形式で取得します。キャパシティプロバイダーをクラスターで使用する場合、AutoScaling プランまたはスケーリングポリシーのリソースは asp または as\$1policy ATTACHMENTS として表示されます。 ``` aws ecs describe-clusters \ --include ATTACHMENTS \ --clusters sampleCluster ``` 出力: ``` { "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": [] } ``` 詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS Clusters](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_clusters.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/describe-clusters.html)」を参照してください。 ### `describe-container-instances` 次のコード例は、`describe-container-instances` を使用する方法を示しています。 **AWS CLI** **コンテナインスタンスを記述するには** 次の `describe-container-instances` の例では、コンテナインスタンス UUID を識別子として使用して、`update` クラスター内のコンテナインスタンスの詳細を取得します。 ``` aws ecs describe-container-instances \ --cluster update \ --container-instances a1b2c3d4-5678-90ab-cdef-11111EXAMPLE ``` 出力: ``` { "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" } } ] } ``` 詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon ECS コンテナインスタンス](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_instances.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeContainerInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/describe-container-instances.html)」を参照してください。 ### `describe-service-deployments` 次のコード例は、`describe-service-deployments` を使用する方法を示しています。 **AWS CLI** **サービスデプロイの詳細を取得するには** 次の `describe-service-deployments` の例では、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 ``` 出力: ``` { "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": [] } ``` 詳細については、*Amazon ECS デベロッパーガイド*の「[Amazon ECS サービスデプロイを使用してサービス履歴を表示する](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-deployment.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DescribeServiceDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/describe-service-deployments.html)」を参照してください。 ### `describe-service-revisions` 次のコード例は、`describe-service-revisions` を使用する方法を示しています。 **AWS CLI** **サービスリビジョンの詳細を取得するには** 次の `describe-service-revisions` の例では、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 ``` 出力: ``` { "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": [] } ``` 詳細については、*Amazon ECS デベロッパーガイド*の「[Amazon ECS サービスリビジョン](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-revision.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DescribeServiceRevisions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/describe-service-revisions.html)」を参照してください。 ### `describe-services` 次のコード例は、`describe-services` を使用する方法を示しています。 **AWS CLI** **サービスを記述するには** 次の `describe-services` の例では、デフォルトのクラスター内の `my-http-service` サービスの詳細を取得します。 ``` aws ecs describe-services --services my-http-service ``` 出力: ``` { "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": [] } ``` 詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS サービス](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeServices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/describe-services.html)」を参照してください。 ### `describe-task-definition` 次のコード例は、`describe-task-definition` を使用する方法を示しています。 **AWS CLI** **タスク定義を記述するには** 次の `describe-task-definition` の例は、タスク定義の詳細情報を取得します。 ``` aws ecs describe-task-definition \ --task-definition hello_world:8 ``` 出力: ``` { "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": [] } ``` 詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS のタスク定義](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTaskDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/describe-task-definition.html)」を参照してください。 ### `describe-task-sets` 次のコード例は、`describe-task-sets` を使用する方法を示しています。 **AWS CLI** **タスクセットを記述するには** 次の `describe-task-sets` の例では、外部デプロイを使用するサービス内のタスクセットについて説明します。 ``` 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 ``` 出力: ``` { "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": [] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTaskSets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/describe-task-sets.html)」を参照してください。 ### `describe-tasks` 次の例は、`describe-tasks` を使用する方法を説明しています。 **AWS CLI** **例 1: 単一のタスクを記述するには** 次の `describe-tasks` の例は、クラスター内の単一のタスクの詳細情報を取得します。タスクの ID または完全な ARN を使用して、タスクを指定できます。この例では、タスクの完全な ARN を使用します。 ``` aws ecs describe-tasks \ --cluster MyCluster \ --tasks arn:aws:ecs:us-east-1:123456789012:task/MyCluster/4d590253bb114126b7afa7b58EXAMPLE ``` 出力: ``` { "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": [] } ``` 詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS のタスク定義](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html)」を参照してください。** **例 2: 複数のタスクを記述するには** 次の `describe-tasks` の例は、クラスター内の複数のタスクの詳細情報を取得します。タスクの ID または完全な ARN を使用して、タスクを指定できます。この例では、タスクの完全な ID を使用します。 ``` aws ecs describe-tasks \ --cluster MyCluster \ --tasks "74de0355a10a4f979ac495c14EXAMPLE" "d789e94343414c25b9f6bd59eEXAMPLE" ``` 出力: ``` { "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": [] } ``` 詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS のタスク定義](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/describe-tasks.html)」を参照してください。** ### `execute-command` 次のコード例は、`execute-command` を使用する方法を示しています。 **AWS CLI** **インタラクティブ /bin/sh コマンドを実行するには** 次の `execute-command` の例では、ID が `arn:aws:ecs:us-east-1:123456789012:task/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE` のタスクで、MyContainer という名前のコンテナに対してインタラクティブな /bin/sh コマンドを実行します。 ``` aws ecs execute-command \ --cluster MyCluster \ --task arn:aws:ecs:us-east-1:123456789012:task/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE \ --container MyContainer \ --interactive \ --command "/bin/sh" ``` このコマンドでは何も出力されません。 詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon ECS Exec を使用してデバッグする](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ExecuteCommand](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/execute-command.html)」を参照してください。 ### `get-task-protection` 次のコード例は、`get-task-protection` を使用する方法を示しています。 **AWS CLI** **ECS サービスでタスクの保護ステータスを取得する** 次の `get-task-protection` は、Amazon ECS サービスに属する ECS タスクの保護ステータスを返します。 ``` aws ecs get-task-protection \ --cluster ECS-project-update-cluster \ --tasks c43ed3b1331041f289316f958adb6a24 ``` 出力: ``` { "protectedTasks": [ { "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/c43ed3b1331041f289316f958adb6a24", "protectionEnabled": false } ], "failures": [] } ``` タスク保護の詳細については、*Amazon ECS デベロッパーガイド*の「[Amazon ECS タスクがスケールインイベントによって終了するのを防ぐ](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-scale-in-protection.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[GetTaskProtection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/get-task-protection.html)」を参照してください。 ### `list-account-settings` 次のコード例は、`list-account-settings` を使用する方法を示しています。 **AWS CLI** **例 1: アカウントのアカウント設定を表示するには** 次の `list-account-settings` の例は、アカウントの有効なアカウント設定を示しています。 ``` aws ecs list-account-settings --effective-settings ``` 出力: ``` { "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" } ] } ``` **例 2: 特定の IAM ユーザーまたは IAM ロールのアカウント設定を表示するには** 次の `list-account-settings` の例では、指定された IAM ユーザーまたは IAM ロールのアカウント設定を表示します。 ``` aws ecs list-account-settings --principal-arn arn:aws:iam::123456789012:user/MyUser ``` 出力: ``` { "settings": [ { "name": "serviceLongArnFormat", "value": "enabled", "principalArn": "arn:aws:iam::123456789012:user/MyUser" } ] } ``` 詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon リソースネーム (ARN) と ID](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-resource-ids.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAccountSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-account-settings.html)」を参照してください。 ### `list-attributes` 次のコード例は、`list-attributes` を使用する方法を示しています。 **AWS CLI** **特定の属性を含むコンテナインスタンスを一覧表示するには** 次の例では、デフォルトクラスターに `stack=production` 属性を持つコンテナインスタンスの属性を一覧表示します。 ``` aws ecs list-attributes \ --target-type container-instance \ --attribute-name stack \ --attribute-value production \ --cluster default ``` 出力: ``` { "attributes": [ { "name": "stack", "targetId": "arn:aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34", "value": "production" } ] } ``` 詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon ECS コンテナエージェントの設定](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-attributes.html)」を参照してください。 ### `list-clusters` 次のコード例は、`list-clusters` を使用する方法を示しています。 **AWS CLI** **使用可能なクラスターを一覧表示するには** 次の `list-clusters` の例は、使用可能なすべてのクラスターを一覧表示します。 ``` aws ecs list-clusters ``` 出力: ``` { "clusterArns": [ "arn:aws:ecs:us-west-2:123456789012:cluster/MyECSCluster1", "arn:aws:ecs:us-west-2:123456789012:cluster/AnotherECSCluster" ] } ``` 詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS Clusters](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_clusters.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[ListClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-clusters.html)」を参照してください。** ### `list-container-instances` 次のコード例は、`list-container-instances` を使用する方法を示しています。 **AWS CLI** **クラスター内のコンテナインスタンスを一覧表示するには** 次の `list-container-instances` の例は、クラスターで使用可能なすべてのコンテナインスタンスを一覧表示します。 ``` aws ecs list-container-instances --cluster MyCluster ``` 出力: ``` { "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" ] } ``` 詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon ECS コンテナインスタンス](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_instances.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListContainerInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-container-instances.html)」を参照してください。 ### `list-service-deployments` 次のコード例は、`list-service-deployments` を使用する方法を示しています。 **AWS CLI** **サービスデプロイを一覧表示するには** 次の `list-service-deployments` の例では、`example-service` という名前のサービスのサービスデプロイを取得します。 ``` aws ecs list-service-deployments \ --service arn:aws:ecs:us-east-1:123456789012:service/example-cluster/example-service ``` 出力: ``` { "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" } ] } ``` 詳細については、*Amazon ECS デベロッパーガイド*の「[Amazon ECS サービスデプロイを使用してサービス履歴を表示する](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-deployment.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[ListServiceDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-service-deployments.html)」を参照してください。 ### `list-services-by-namespace` 次のコード例は、`list-services-by-namespace` を使用する方法を示しています。 **AWS CLI** **名前空間内のサービスを一覧表示するには** 次の `list-services-by-namespace` の例では、デフォルトのリージョンで指定された名前空間に対して設定されたすべてのサービスを一覧表示します。 ``` aws ecs list-services-by-namespace \ --namespace service-connect ``` 出力: ``` { "serviceArns": [ "arn:aws:ecs:us-west-2:123456789012:service/MyCluster/MyService", "arn:aws:ecs:us-west-2:123456789012:service/tutorial/service-connect-nginx-service" ] } ``` 詳細については、「*Amazon ECS デベロッパーガイド*」の「[Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListServicesByNamespace](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-services-by-namespace.html)」を参照してください。 ### `list-services` 次のコード例は、`list-services` を使用する方法を示しています。 **AWS CLI** **クラスター内のサービスを一覧表示するには** 次の `list-services` の例は、クラスターで実行中のサービスを一覧表示する方法を示しています。 ``` aws ecs list-services --cluster MyCluster ``` 出力: ``` { "serviceArns": [ "arn:aws:ecs:us-west-2:123456789012:service/MyCluster/MyService" ] } ``` 詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS サービス](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[ListServices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-services.html)」を参照してください。** ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **リソースのタグを一覧表示するには** 次の `list-tags-for-resource` の例では、特定のクラスターのタグを一覧表示します。 ``` aws ecs list-tags-for-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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-tags-for-resource.html)」を参照してください。 ### `list-task-definition-families` 次のコード例は、`list-task-definition-families` を使用する方法を示しています。 **AWS CLI** **例 1: 登録されたタスク定義ファミリーを一覧表示するには** 次の `list-task-definition-families` の例では、登録されたすべてのタスク定義ファミリーを一覧表示します。 ``` aws ecs list-task-definition-families ``` 出力: ``` { "families": [ "node-js-app", "web-timer", "hpcc", "hpcc-c4-8xlarge" ] } ``` **例 2: 登録されたタスク定義ファミリーをフィルタリングするには** 次の `list-task-definition-families` の例では、「hpcc」で始まるタスク定義のリビジョンを一覧表示します。 ``` aws ecs list-task-definition-families --family-prefix hpcc ``` 出力: ``` { "families": [ "hpcc", "hpcc-c4-8xlarge" ] } ``` 詳細については、「*Amazon ECS デベロッパーガイド*」の「[タスク定義のパラメータ](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#family)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTaskDefinitionFamilies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-task-definition-families.html)」を参照してください。 ### `list-task-definitions` 次のコード例は、`list-task-definitions` を使用する方法を示しています。 **AWS CLI** **例 1: 登録されたタスク定義を一覧表示するには** 次の `list-task-definitions` の例では、登録されたすべてのタスク定義を一覧表示します。 ``` aws ecs list-task-definitions ``` 出力: ``` { "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" ] } ``` **例 2: ファミリーに登録されたタスク定義を一覧表示するには** 次の list-task-definitions の例では、指定されたファミリーのタスク定義リビジョンを一覧表示します。 ``` aws ecs list-task-definitions --family-prefix wordpress ``` 出力: ``` { "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" ] } ``` 詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS のタスク定義](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTaskDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-task-definitions.html)」を参照してください。 ### `list-tasks` 次のコード例は、`list-tasks` を使用する方法を示しています。 **AWS CLI** **例 1: クラスター内のタスクを一覧表示するには** 次の `list-tasks` の例は、クラスター内のすべてのタスクを一覧表示します。 ``` aws ecs list-tasks --cluster default ``` 出力: ``` { "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" ] } ``` **例 2: 特定のコンテナインスタンスのタスクを一覧表示するには** 次の `list-tasks` の例は、コンテナインスタンスの UUID をフィルタとして使用して、コンテナインスタンスのタスクを一覧表示します。 ``` aws ecs list-tasks --cluster default --container-instance a1b2c3d4-5678-90ab-cdef-33333EXAMPLE ``` 出力: ``` { "taskArns": [ "arn:aws:ecs:us-west-2:123456789012:task/a1b2c3d4-5678-90ab-cdef-44444EXAMPLE" ] } ``` 詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS のタスク定義](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[ListTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/list-tasks.html)」を参照してください。** ### `put-account-setting-default` 次のコード例は、`put-account-setting-default` を使用する方法を示しています。 **AWS CLI** **デフォルトのアカウント設定を変更するには** 次の `put-account-setting-default` の例では、アカウントのすべての IAM ユーザーまたはロールのデフォルトアカウント設定を変更します。これらの変更は、IAM ユーザーまたはロールがこれらの設定を明示的に上書きしない限り、AWS アカウント全体に適用されます。 ``` aws ecs put-account-setting-default --name serviceLongArnFormat --value enabled ``` 出力: ``` { "setting": { "name": "serviceLongArnFormat", "value": "enabled", "principalArn": "arn:aws:iam::123456789012:root" } } ``` 詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon リソースネーム (ARN) と ID](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-resource-ids.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutAccountSettingDefault](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/put-account-setting-default.html)」を参照してください。 ### `put-account-setting` 次のコード例は、`put-account-setting` を使用する方法を示しています。 **AWS CLI** **IAM ユーザーアカウントのアカウント設定を変更するには** 次の `put-account-setting` の例では、IAM ユーザーアカウントの `containerInsights` アカウント設定を `enhanced` に設定します。これにより、オブザーバビリティが強化された Container Insights が有効になります。 ``` aws ecs put-account-setting \ --name containerInsights \ --value enhanced ``` 出力: ``` { "setting": { "name": "containerInsights", "value": "enhanced", "principalArn": "arn:aws:iam::123456789012:user/johndoe", "type": "user" } } ``` 詳細については、「*Amazon ECS デベロッパーガイド*」の「[アカウント設定の変更](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-modifying-longer-id-settings.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutAccountSetting](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/put-account-setting.html)」を参照してください。 ### `put-account-settings` 次のコード例は、`put-account-settings` を使用する方法を示しています。 **AWS CLI** **IAM ユーザーまたは IAM ロールのアカウント設定を変更するには** 次の `put-account-setting` の例では、指定された IAM ユーザーまたは IAM ロールのアカウント設定を変更します。 ``` aws ecs put-account-setting \ --name serviceLongArnFormat \ --value enabled \ --principal-arn arn:aws:iam::123456789012:user/MyUser ``` 出力: ``` { "setting": { "name": "serviceLongArnFormat", "value": "enabled", "principalArn": "arn:aws:iam::123456789012:user/MyUser" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutAccountSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/put-account-settings.html)」を参照してください。 ### `put-attributes` 次のコード例は、`put-attributes` を使用する方法を示しています。 **AWS CLI** **属性を作成して Amazon ECS リソースに関連付けるには** 次の `put-attributes` では、名前 stack と値 production を含む属性をコンテナインスタンスに適用します。 ``` aws ecs put-attributes \ --attributes name=stack,value=production,targetId=arn:aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34 ``` 出力: ``` { "attributes": [ { "name": "stack", "targetId": "arn:aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34", "value": "production" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/put-attributes.html)」を参照してください。 ### `put-cluster-capacity-providers` 次のコード例は、`put-cluster-capacity-providers` を使用する方法を示しています。 **AWS CLI** **例 1: 既存のキャパシティプロバイダーをクラスターに追加するには** 次の `put-cluster-capacity-providers` の例では、既存のキャパシティープロバイダーをクラスターに追加します。キャパシティープロバイダーを作成するには、`create-capacity-provider` コマンドを使用します。`describe-clusters` コマンドは、現在のキャパシティープロバイダーとクラスターに関連付けられたデフォルトのキャパシティープロバイダー戦略を記述するために使用されます。新しいキャパシティープロバイダーをクラスターに追加するときは、クラスターに関連付ける新しいキャパシティープロバイダーに加えて、既存のすべてのキャパシティープロバイダーを指定する必要があります。また、クラスターに関連付けるデフォルトのキャパシティープロバイダー戦略も指定する必要があります。この例では、`MyCluster` クラスターは関連付けられた `MyCapacityProvider1` キャパシティープロバイダーがあり、`MyCapacityProvider2` キャパシティープロバイダーを追加して、それをデフォルトのキャパシティープロバイダー戦略に含めることで、タスクが両方のキャパシティープロバイダーに均等に分散されるようにしようとしています。 ``` aws ecs put-cluster-capacity-providers \ --cluster MyCluster \ --capacity-providers MyCapacityProvider1 MyCapacityProvider2 \ --default-capacity-provider-strategy capacityProvider=MyCapacityProvider1,weight=1 capacityProvider=MyCapacityProvider2,weight=1 ``` 出力: ``` { "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" } } ``` 詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS キャパシティープロバイダー](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html)」を参照してください。** **例 2: クラスターからキャパシティプロバイダーを削除するには** 次の `put-cluster-capacity-providers` の例では、クラスターからキャパシティプロバイダーを削除します。`describe-clusters` コマンドは、クラスターに関連付けられている現在のキャパシティプロバイダーを記述するために使用されます。クラスターからキャパシティープロバイダーを削除するときは、クラスターに関連付けられたままにするキャパシティープロバイダーと、クラスターに関連付けるデフォルトのキャパシティープロバイダー戦略を指定する必要があります。この例では、クラスターに `MyCapacityProvider1` と `MyCapacityProvider2` キャパシティープロバイダーが関連付けられており、`MyCapacityProvider2` キャパシティープロバイダーを削除しようと思っています。そのため、更新されたデフォルトのキャパシティープロバイダー戦略とともにコマンドで `MyCapacityProvider1` のみを指定します。 ``` aws ecs put-cluster-capacity-providers \ --cluster MyCluster \ --capacity-providers MyCapacityProvider1 \ --default-capacity-provider-strategy capacityProvider=MyCapacityProvider1,weight=1,base=0 ``` 出力: ``` { "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" } } ``` 詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS キャパシティープロバイダー](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html)」を参照してください。** **例 3: クラスターからすべてのキャパシティプロバイダーを削除するには** 次の `put-cluster-capacity-providers` の例では、クラスターからすべての既存のキャパシティプロバイダーを削除します。 ``` aws ecs put-cluster-capacity-providers \ --cluster MyCluster \ --capacity-providers [] \ --default-capacity-provider-strategy [] ``` 出力: ``` { "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" } } ``` 詳細については、「Amazon ECS ディベロッパーガイド」の「[Amazon ECS キャパシティープロバイダー](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutClusterCapacityProviders](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/put-cluster-capacity-providers.html)」を参照してください。 ### `register-task-definition` 次のコード例は、`register-task-definition` を使用する方法を示しています。 **AWS CLI** **例 1: タスク定義を JSON ファイルに登録するには** 次の `register-task-definition` の例では、タスク定義を指定されたファミリーに登録します。コンテナ定義は、指定されたファイルの場所に JSON 形式で保存されます。 ``` aws ecs register-task-definition \ --cli-input-json file:///sleep360.json ``` `sleep360.json` の内容: ``` { "containerDefinitions": [ { "name": "sleep", "image": "busybox", "cpu": 10, "command": [ "sleep", "360" ], "memory": 10, "essential": true } ], "family": "sleep360" } ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon ECS デベロッパーガイド*」の「[タスク定義の例](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/example_task_definitions.html)」を参照してください。 **例 2: タスク定義を JSON 文字列パラメータに登録するには** 次の `register-task-definition` の例では、エスケープされた二重引用符を持つ JSON 文字列パラメータとして提供されるコンテナ定義を使用してタスク定義を登録します。 ``` aws ecs register-task-definition \ --family sleep360 \ --container-definitions "[{\"name\":\"sleep\",\"image\":\"busybox\",\"cpu\":10,\"command\":[\"sleep\",\"360\"],\"memory\":10,\"essential\":true}]" ``` 出力は前の例と同じです。 詳細については、「*Amazon ECS デベロッパーガイド*」の「[タスク定義の作成](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/create-task-definition.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegisterTaskDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/register-task-definition.html)」を参照してください。 ### `run-task` 次のコード例は、`run-task` を使用する方法を示しています。 **AWS CLI** **例 1: デフォルトのクラスターでタスクを実行するには** 次の `run-task` の例では、デフォルトのクラスターでタスクを実行し、クライアントトークンを使用します。 ``` aws ecs run-task \ --cluster default \ --task-definition sleep360:1 \ --client-token 550e8400-e29b-41d4-a716-446655440000 ``` 出力: ``` { "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": [] } ``` 詳細については、「*Amazon ECS デベロッパーガイド*」の「[スタンドアロンタスクとしてのアプリケーションの実行](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/standalone-task-create.html)」を参照してください。 **例 2: スタンドアロンタスクの Amazon EBS ボリュームを設定するには** 次の `run-task` の例では、デフォルトのクラスターで Fargate タスク用に暗号化された Amazon EBS ボリュームを設定します。`AmazonECSInfrastructureRolePolicyForVolumes` マネージドポリシーがアタッチされた Amazon ECS インフラストラクチャロールを設定する必要があります。`run-task` リクエストと同じボリューム名でタスク定義を指定する必要があります。この例では、`--cli-input-json` オプションと JSON 入力ファイル (`ebs.json`) を使用します。 ``` aws ecs run-task \ --cli-input-json file://ebs.json ``` `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" } } ] } ``` 出力: ``` { "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": [] } ``` 詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon ECS での Amazon EBS ボリュームの使用](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RunTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/run-task.html)」を参照してください。 ### `start-task` 次のコード例は、`start-task` を使用する方法を示しています。 **AWS CLI** **例 1: 新しいタスクを開始するには** 次の `start-task` の例では、デフォルトクラスター内の指定されたコンテナインスタンスで、最新リビジョンの `sleep360` タスク定義を使用してタスクを開始します。 ``` aws ecs start-task \ --task-definition sleep360 \ --container-instances 765936fadbdd46b5991a4bd70c2a43d4 ``` 出力: ``` { "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": [] } ``` 詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon ECS でコンテナをスケジュールする](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html)」を参照してください。 **例 2: タスク開始時に Amazon EBS ボリュームを設定するには** 次の `start-task` の例では、指定されたコンテナインスタンスのタスク用に暗号化された Amazon EBS ボリュームを設定します。`AmazonECSInfrastructureRolePolicyForVolumes` マネージドポリシーがアタッチされた Amazon ECS インフラストラクチャロールを設定する必要があります。`start-task` リクエストと同じボリューム名でタスク定義を指定する必要があります。この例では、`--cli-input-json` オプションと、以下の内容を含む JSON 入力ファイル (`ebs.json`) を使用します。 ``` aws ecs start-task \ --cli-input-json file://ebs.json \ --container-instances 765936fadbdd46b5991a4bd70c2a43d4 ``` `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" } } ] } ``` 出力: ``` { "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": [] } ``` 詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon ECS での Amazon EBS ボリュームの使用](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/start-task.html)」を参照してください。 ### `stop-task` 次のコード例は、`stop-task` を使用する方法を示しています。 **AWS CLI** **タスクを停止するには** 次の `stop-task` は、指定されたタスクがデフォルトのクラスターで実行されないようにします。 ``` aws ecs stop-task \ --task 666fdccc2e2d4b6894dd422f4eeee8f8 ``` 出力: ``` { "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": [] } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/stop-task.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **リソースにタグを付けるには** 次の `tag-resource` の例では、指定されたリソースに単一のタグを追加します。 ``` aws ecs tag-resource \ --resource-arn arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster --tags key=key1,value=value1 ``` このコマンドでは何も出力されません。 **リソースに複数のタグを追加するには** 次の `tag-resource` の例では、指定されたリソースに複数のタグを追加します。 ``` 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 ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/tag-resource.html)」を参照してください。 ### `untag-resource` 次の例では、`untag-resource` を使用する方法を説明しています。 **AWS CLI** **リソースからタグを削除するには** 次の `untag-resource` の例では、指定されたリソース共有から一覧表示されたタグを削除します。 ``` aws ecs untag-resource \ --resource-arn arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster \ --tag-keys key1,key2 ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/untag-resource.html)」を参照してください。 ### `update-cluster-settings` 次のコード例は、`update-cluster-settings` を使用する方法を示しています。 **AWS CLI** **クラスターの設定を変更するには** 次の `update-cluster-settings`の例では、`MyCluster` クラスターに対して、オブザーバビリティが強化された CloudWatch Container Insights を有効にします。 ``` aws ecs update-cluster-settings \ --cluster MyCluster \ --settings name=containerInsights,value=enhanced ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*Amazon ECS デベロッパーガイド*」の「[アカウント設定の変更](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-modifying-longer-id-settings.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateClusterSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/update-cluster-settings.html)」を参照してください。 ### `update-cluster` 次のコード例は、`update-cluster` を使用する方法を示しています。 **AWS CLI** **例 1: containerInsights を有効にして ECS クラスターを更新する** 次の `update-cluster` では、作成済みのクラスターで containerInsights の値を `enabled` に更新します。デフォルトでは、これは無効になっています。 ``` aws ecs update-cluster \ --cluster ECS-project-update-cluster \ --settings name=containerInsights,value=enabled ``` 出力: ``` "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" } } ``` **例 2: デフォルトの Service Connect 名前空間を設定して ECS クラスターを更新する** 次の `update-cluster` は、デフォルトの Service Connect 名前空間を設定して ECS クラスターを更新します。 ``` aws ecs update-cluster \ --cluster ECS-project-update-cluster \ --service-connect-defaults namespace=test ``` 出力: ``` { "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" } } } ``` Service Connect の詳細については、*Amazon ECS デベロッパーガイド*の「[Service Connect を使用して Amazon ECS サービスを短縮名で接続する](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/update-cluster.html)」を参照してください。 ### `update-container-agent` 次のコード例は、`update-container-agent` を使用する方法を示しています。 **AWS CLI** **Amazon ECS コンテナインスタンスのコンテナエージェントを更新するには** 次の `update-container-agent` の例では、デフォルトのクラスターで指定されたコンテナインスタンスのコンテナエージェントを更新します。 ``` aws ecs update-container-agent --cluster default --container-instance a1b2c3d4-5678-90ab-cdef-11111EXAMPLE ``` 出力: ``` { "containerInstance": { "status": "ACTIVE", ... "agentUpdateStatus": "PENDING", "versionInfo": { "agentVersion": "1.0.0", "agentHash": "4023248", "dockerVersion": "DockerVersion: 1.5.0" } } } ``` 詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon ECS コンテナエージェントの更新](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateContainerAgent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/update-container-agent.html)」を参照してください。 ### `update-container-instances-state` 次のコード例は、`update-container-instances-state` を使用する方法を示しています。 **AWS CLI** **コンテナインスタンスの状態を更新するには** 次の `update-container-instances-state` は、指定されたコンテナインスタンスを `DRAINING` の状態を更新し、登録されているクラスターから削除します。 ``` aws ecs update-container-instances-state \ --container-instances 765936fadbdd46b5991a4bd70c2a43d4 \ --status DRAINING ``` 出力: ``` { "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": [] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateContainerInstancesState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/update-container-instances-state.html)」を参照してください。 ### `update-service-primary-task-set` 次のコード例は、`update-service-primary-task-set` を使用する方法を示しています。 **AWS CLI** **サービスのプライマリタスクセットを更新するには** 次の `update-service-primary-task-set` の例では、指定されたサービスのプライマリタスクセットを更新します。 ``` 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 ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateServicePrimaryTaskSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/update-service-primary-task-set.html)」を参照してください。 ### `update-service` 次のコード例は、`update-service` を使用する方法を示しています。 **AWS CLI** **例 1: サービスで使用されるタスク定義を変更するには** 次の `update-service` の例は、`amazon-ecs-sample` タスク定義を使用するように `my-http-service` サービスを更新します。 ``` aws ecs update-service \ --cluster test \ --service my-http-service \ --task-definition amazon-ecs-sample ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon ECS デベロッパーガイド*」の「[コンソールを使用した Amazon ECS サービスの更新](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/update-service-console-v2.html)」を参照してください。 **例 2: サービス内のタスク数を変更するには** 次の `update-service` の例では、`my-http-service` サービスの必要なタスク数を 2 に更新します。 ``` aws ecs update-service \ --cluster MyCluster \ --service my-http-service \ --desired-count 2 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon ECS デベロッパーガイド*」の「[コンソールを使用した Amazon ECS サービスの更新](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/update-service-console-v2.html)」を参照してください。 **例 3: サービスの更新時にアタッチメント用に Amazon EBS ボリュームを設定するには** 次の `update-service` の例では、Amazon EBS ボリュームを使用するように `my-http-service` サービスを更新します。`AmazonECSInfrastructureRolePolicyForVolumes` マネージドポリシーがアタッチされた Amazon ECS インフラストラクチャロールを設定する必要があります。また、`update-service` リクエストと同じボリューム名で、`configuredAtLaunch` を `true` に設定してタスク定義を指定する必要があります。この例では、`--cli-input-json` オプションと JSON 入力ファイル (`ebs.json`) を使用します。 ``` aws ecs update-service \ --cli-input-json file://ebs.json ``` `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" } } ] } ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon ECS での Amazon EBS ボリュームの使用](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html)」を参照してください。 **例 4: Amazon EBS ボリュームを今後使用しないようにサービスを更新するには** 次の `update-service` の例では、Amazon EBS ボリュームを今後使用しないように `my-http-service` サービスを更新します。`configuredAtLaunch` を `false` に設定したタスク定義リビジョンを指定する必要があります。 ``` aws ecs update-service \ --cluster mycluster \ --task-definition mytaskdef \ --service my-http-service \ --desired-count 2 \ --volume-configurations "[]" ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon ECS デベロッパーガイド*」の「[Amazon ECS での Amazon EBS ボリュームの使用](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html)」を参照してください。 **例 5: サービスのアベイラビリティーゾーンのリバランスを有効にするには** 次の `update-service` の例では、サービス `my-http-service` のアベイラビリティーゾーンのリバランスを有効にします。 ``` aws ecs update-service \ --cluster MyCluster \ --service my-http-service \ --availability-zone-rebalancing ENABLED ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon ECS デベロッパーガイド*」の「[コンソールを使用した Amazon ECS サービスの更新](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/update-service-console-v2.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[UpdateService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/update-service.html)」を参照してください。** ### `update-task-protection` 次のコード例は、`update-task-protection` を使用する方法を示しています。 **AWS CLI** **例 1: ECS タスクのタスク保護を有効にする** 次の `update-task-protection` は、デプロイまたは AutoScaling サービスによるスケールイン中の終了から ECS タスクを保護します。タスク保護のカスタム有効期限は 1 分から 2,880 分 (48 時間) の範囲で指定できます。有効期間を指定しない場合、タスク保護のデフォルトの有効期間は 2 時間になります。 ``` aws ecs update-task-protection \ --cluster ECS-project-update-cluster \ --tasks c43ed3b1331041f289316f958adb6a24 \ --protection-enabled \ --expires-in-minutes 300 ``` 出力: ``` { "protectedTasks": [ { "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/c43ed3b1331041f289316f958adb6a24", "protectionEnabled": true, "expirationDate": "2024-09-14T19:53:36.687000-05:00" } ], "failures": [] } ``` **例 2: ECS タスクのタスク保護を無効にする** 次の `update-task-protection` は、デプロイまたは Auto Scaling サービスによるスケールインから保護されているタスクの保護を無効にします。 ``` aws ecs update-task-protection \ --cluster ECS-project-update-cluster \ --tasks c43ed3b1331041f289316f958adb6a24 \ --no-protection-enabled ``` 出力: ``` { "protectedTasks": [ { "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/c43ed3b1331041f289316f958adb6a24", "protectionEnabled": false } ], "failures": [] } ``` タスク保護の詳細については、*Amazon ECS デベロッパーガイド*の「[Amazon ECS タスクがスケールインイベントによって終了するのを防ぐ](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-scale-in-protection.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[UpdateTaskProtection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/update-task-protection.html)」を参照してください。 ### `update-task-set` 次のコード例は、`update-task-set` を使用する方法を示しています。 **AWS CLI** **テストセットを更新するには** 次の `update-task-set` の例では、タスクセットを更新してスケールを調整します。 ``` 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 ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateTaskSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecs/update-task-set.html)」を参照してください。 # AWS CLI を使用した Amazon EFS の例 次のコード例は、Amazon EFS で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-file-system` 次のコード例は、`create-file-system` を使用する方法を示しています。 **AWS CLI** **暗号化されたファイルシステムのを作成するには** 次の `create-file-system` の例では、デフォルトの CMK を使用して暗号化されたファイルシステムを作成します。タグ `Name=my-file-system` も追加されます。 ``` aws efs create-file-system \ --performance-mode generalPurpose \ --throughput-mode bursting \ --encrypted \ --tags Key=Name,Value=my-file-system ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Elastic File System ユーザーガイド*」の「[Amazon EFS ファイルシステムの作成](https://docs.aws.amazon.com/efs/latest/ug/creating-using-create-fs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateFileSystem](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/efs/create-file-system.html)」を参照してください。 ### `create-mount-target` 次のコード例は、`create-mount-target` を使用する方法を示しています。 **AWS CLI** **マウントターゲットを作成するには** 次の `create-mount-target` の例では、指定されたファイルシステムのマウントターゲットを作成します。 ``` aws efs create-mount-target \ --file-system-id fs-c7a0456e \ --subnet-id subnet-02bf4c428bexample \ --security-groups sg-068f739363example ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Elastic File System ユーザーガイド*」の「[マウントターゲットの作成](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateMountTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/efs/create-mount-target.html)」を参照してください。 ### `delete-file-system` 次のコード例は、`delete-file-system` を使用する方法を示しています。 **AWS CLI** **ファイルシステムを削除するには** 次の `delete-file-system` の例は、指定されたファイルシステムを削除します。 ``` aws efs delete-file-system \ --file-system-id fs-c7a0456e ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Elastic File System ユーザーガイド*」の「[Amazon EFS ファイルシステムの削除](https://docs.aws.amazon.com/efs/latest/ug/delete-efs-fs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteFileSystem](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/efs/delete-file-system.html)」を参照してください。 ### `delete-mount-target` 次のコード例は、`delete-mount-target` を使用する方法を示しています。 **AWS CLI** **マウントターゲットを削除するには** 次の `delete-mount-target` の例は、指定されたマウントターゲットを削除します。 ``` aws efs delete-mount-target \ --mount-target-id fsmt-f9a14450 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Elastic File System ユーザーガイド*」の「[マウントターゲットの作成](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteMountTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/efs/delete-mount-target.html)」を参照してください。 ### `describe-file-systems` 次のコード例は、`describe-file-systems` を使用する方法を示しています。 **AWS CLI** **ファイルシステムを記述するには** 次の `describe-file-systems` の例では、指定したファイルシステムを記述しています。 ``` aws efs describe-file-systems \ --file-system-id fs-c7a0456e ``` 出力: ``` { "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" } ] } ] } ``` 詳細については、「*Amazon Elastic File System ユーザーガイド*」の「[Amazon EFS ファイルシステムの管理](https://docs.aws.amazon.com/efs/latest/ug/managing.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeFileSystems](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/efs/describe-file-systems.html)」を参照してください。 ### `describe-mount-targets` 次のコード例は、`describe-mount-targets` を使用する方法を示しています。 **AWS CLI** **マウントターゲットを記述するには** 次の `describe-mount-targets` の例では、指定したマウントターゲットを記述しています。 ``` aws efs describe-mount-targets \ --mount-target-id fsmt-f9a14450 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Elastic File System ユーザーガイド*」の「[マウントターゲットの作成](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeMountTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/efs/describe-mount-targets.html)」を参照してください。 ### `describe-tags` 次のコード例は、`describe-tags` を使用する方法を示しています。 **AWS CLI** **ファイルシステムのタグを記述するには** 次の `describe-tags` の例では、指定したファイルシステムのタグを記述しています。 ``` aws efs describe-tags \ --file-system-id fs-c7a0456e ``` 出力: ``` { "Tags": [ { "Key": "Name", "Value": "my-file-system" }, { "Key": "Department", "Value": "Business Intelligence" } ] } ``` 詳細については、「*Amazon Elastic File System ユーザーガイド*」の「[ファイルシステムタグの管理](https://docs.aws.amazon.com/efs/latest/ug/manage-fs-tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/efs/describe-tags.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **リソースのタグを取得するには** 次の `list-tags-for-resource` の例では、指定されたファイルシステムに関連付けられたタグを取得します。 ``` aws efs list-tags-for-resource \ --resource-id fs-c7a0456e ``` 出力: ``` { "Tags": [ { "Key": "Name", "Value": "my-file-system" }, { "Key": "Department", "Value": "Business Intelligence" } ] } ``` 詳細については、「*Amazon Elastic File System ユーザーガイド*」の「[ファイルシステムタグの管理](https://docs.aws.amazon.com/efs/latest/ug/manage-fs-tags.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/efs/list-tags-for-resource.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **リソースにタグを付けるには** 次の `tag-resource` の例では、ファイルシステムにタグ `Department=Business Intelligence` を追加します。 ``` aws efs tag-resource \ --resource-id fs-c7a0456e \ --tags Key=Department,Value="Business Intelligence" ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Elastic File System ユーザーガイド*」の「[ファイルシステムタグの管理](https://docs.aws.amazon.com/efs/latest/ug/manage-fs-tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/efs/tag-resource.html)」を参照してください。 ### `untag-resource` 次の例では、`untag-resource` を使用する方法を説明しています。 **AWS CLI** **リソースからタグを削除するには** 次の `untag-resource` の例は、タグキーが `Department` のタグを指定したファイルシステムから削除します。 ``` aws efs untag-resource \ --resource-id fs-c7a0456e \ --tag-keys Department ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Elastic File System ユーザーガイド*」の「[ファイルシステムタグの管理](https://docs.aws.amazon.com/efs/latest/ug/manage-fs-tags.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/efs/untag-resource.html)」を参照してください。 # AWS CLI を使用した Amazon EKS の例 次のコード例は、amazon EKS で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `associate-access-policy` 次のコード例は、`associate-access-policy` を使用する方法を示しています。 **AWS CLI** **アクセスポリシーとその範囲をクラスターのアクセスエントリに関連付けるには** 次の `associate-access-policy` は、アクセスポリシーとその範囲を、指定されたクラスターのアクセスエントリに関連付けます。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[アクセスポリシーをアクセスエントリに関連付ける](https://docs.aws.amazon.com/eks/latest/userguide/access-policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/associate-access-policy.html)」を参照してください。 ### `associate-encryption-config` 次のコード例は、`associate-encryption-config` を使用する方法を示しています。 **AWS CLI** **暗号化設定を既存のクラスターに関連付けるには** 次の `associate-encryption-config` の例では、暗号化が有効になっていない既存の EKS クラスターで暗号化を有効にします。 ``` aws eks associate-encryption-config \ --cluster-name my-eks-cluster \ --encryption-config '[{"resources":["secrets"],"provider":{"keyArn":"arn:aws:kms:region-code:account:key/key"}}]' ``` 出力: ``` { "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": [] } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[既存のクラスターでのシークレット暗号化の有効化](https://docs.aws.amazon.com/eks/latest/userguide/enable-kms.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateEncryptionConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/associate-encryption-config.html)」を参照してください。 ### `associate-identity-provider-config` 次のコード例は、`associate-identity-provider-config` を使用する方法を示しています。 **AWS CLI** **Amazon EKS クラスターに ID プロバイダーを関連付ける** 次の `associate-identity-provider-config` の例では、ID プロバイダーを 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 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[OpenID Connect ID プロバイダーからクラスターのユーザーを認証する - OIDC ID プロバイダーを関連付ける](https://docs.aws.amazon.com/eks/latest/userguide/authenticate-oidc-identity-provider.html#associate-oidc-identity-provider)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateIdentityProviderConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/associate-identity-provider-config.html)」を参照してください。 ### `create-access-entry` 次のコード例は、`create-access-entry` を使用する方法を示しています。 **AWS CLI** **例 1: EKS クラスターのアクセスエントリを作成するには** 次の `create-access-entry` の例では、IAM プリンシパルが EKS クラスターにアクセスできるようにするアクセスエントリを作成します。 ``` aws eks create-access-entry \ --cluster-name eks-customer \ --principal-arn arn:aws:iam::111122223333:user/eks-user ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[アクセスエントリを作成する](https://docs.aws.amazon.com/eks/latest/userguide/creating-access-entries.html)」を参照してください。 **例 2: アクセスエントリのタイプを指定して EKS クラスターのアクセスエントリを作成するには** 次の `create-access-entry` の例では、EKS クラスターにタイプ `EC2_LINUX` のアクセスエントリを作成します。デフォルトでは、タイプ `STANDARD` のアクセスエントリが作成されます。デフォルト以外に、他のアクセスエントリタイプを指定する場合は、CLI で IAM ロール ARN を渡す必要があります。 ``` aws eks create-access-entry \ --cluster-name eks-customer \ --principal-arn arn:aws:iam::111122223333:role/admin-test-ip \ --type EC2_LINUX ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[アクセスエントリを作成する](https://docs.aws.amazon.com/eks/latest/userguide/creating-access-entries.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateAccessEntry](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/create-access-entry.html)」を参照してください。 ### `create-addon` 次の例は、`create-addon` を使用する方法を説明しています。 **AWS CLI** **例 1: 各 EKS クラスターバージョンのデフォルトの互換性バージョンで Amazon EKS アドオンを作成するには** 次の `create-addon` の例では、それぞれの EKS クラスターバージョンのデフォルトの互換性バージョンを持つ Amazon 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 ``` 出力: ``` { "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": {} } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[Amazon EKS アドオンの管理 - アドオンの作成](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#creating-an-add-on)」を参照してください。 **例 2: 特定のアドオンバージョンで Amazon EKS アドオンを作成するには** 次の `create-addon` の例では、特定のアドオンバージョンを使用して Amazon 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 \ --addon-version v1.16.4-eksbuild.2 ``` 出力: ``` { "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": {} } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[Amazon EKS アドオンの管理 - アドオンの作成](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#creating-an-add-on)」を参照してください。 **例 3: カスタム設定値を使用して Amazon EKS アドオンを作成し、競合の詳細を解決するには** 次の `create-addon` の例では、カスタム設定値を使用して Amazon 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 \ --addon-version v1.16.4-eksbuild.2 \ --configuration-values '{"resources":{"limits":{"cpu":"100m"}}}' \ --resolve-conflicts OVERWRITE ``` 出力: ``` { "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\"}}}" } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[Amazon EKS アドオンの管理 - アドオンの作成](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#creating-an-add-on)」を参照してください。 **例 4: カスタム JSON 設定値ファイルを使用して Amazon EKS アドオンを作成するには** 次の `create-addon` の例では、カスタム設定値を使用して Amazon 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 \ --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"}' ``` `configuration-values.json` の内容: ``` { "resources": { "limits": { "cpu": "150m" } }, "env": { "AWS_VPC_K8S_CNI_LOGLEVEL": "ERROR" } } ``` 出力: ``` { "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}" } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[Amazon EKS アドオンの管理 - アドオンの作成](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#creating-an-add-on)」を参照してください。 **例 5: カスタム YAML 設定値ファイルを使用して Amazon EKS アドオンを作成するには** 次の `create-addon` の例では、カスタム設定値を使用して Amazon 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 \ --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"}' ``` `configuration-values.yaml` の内容: ``` resources: limits: cpu: '100m' env: AWS_VPC_K8S_CNI_LOGLEVEL: 'DEBUG' ``` 出力: ``` { "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'" } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[Amazon EKS アドオンの管理 - アドオンの作成](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#creating-an-add-on)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateAddon](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/create-addon.html)」を参照してください。 ### `create-cluster` 次のコード例は、`create-cluster` を使用する方法を示しています。 **AWS CLI** **新しいクラスターを作成するには** このコマンド例は、デフォルトリージョンに `prod` という名前のクラスターを作成します。 コマンド: ``` 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 ``` 出力: ``` { "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": {} } } ``` **プライベートエンドポイントアクセスを含むクラスターを作成してロギングを埋め込むには** このコマンド例は、パブリックエンドポイントアクセスを無効にし、プライベートエンドポイントアクセスを有効にして、すべてのロギングタイプが有効な、`example` という名前のクラスターをデフォルトのリージョンに作成します。 コマンド: ``` 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}]}' ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/create-cluster.html)」を参照してください。 ### `create-fargate-profile` 次のコード例は、`create-fargate-profile` を使用する方法を示しています。 **AWS CLI** **例 1: 名前空間を持つセレクターの EKS Fargate プロファイルを作成する** 次の `create-fargate-profile` の例では、名前空間を持つセレクターの EKS Fargate Profile を作成します。 ``` 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"}]' ``` 出力: ``` { "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": {} } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[AWS Fargate プロファイル - Fargate プロファイルの作成](https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html#create-fargate-profile)」を参照してください。 **例 2: 名前空間とラベルを持つセレクターの EKS Fargate プロファイルを作成する** 次の `create-fargate-profile` の例では、名前空間とラベルを持つセレクターの EKS Fargate プロファイルを作成します。 ``` 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"}}]' ``` 出力: ``` { "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": {} } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[AWS Fargate プロファイル - Fargate プロファイルの作成](https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html#create-fargate-profile)」を参照してください。 **例 3: 名前空間とラベル、およびポッドを起動するサブネットの ID を持つセレクターの EKS Fargate Profile を作成する。** 次の `create-fargate-profile` の例では、名前空間とラベル、およびポッドを起動するサブネットの ID を持つセレクターの EKS Fargate Profile を作成します。 ``` 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"]' ``` 出力: ``` { "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": {} } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[AWS Fargate プロファイル - Fargate プロファイルの作成](https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html#create-fargate-profile)」を参照してください。 **例 4: 複数の名前空間とラベル、およびポッドを起動するサブネットの ID を持つセレクターの EKS Fargate プロファイルを作成する** 次の `create-fargate-profile` の例では、複数の名前空間とラベル、およびポッドを起動するサブネットの ID を持つセレクターの EKS Fargate プロファイルを作成します。 ``` 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"}' ``` 出力: ``` { "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" } } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[AWS Fargate プロファイル - Fargate プロファイルの作成](https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html#create-fargate-profile)」を参照してください。 **例 5: 名前空間とラベル用のワイルドカードセレクタと、ポッドを起動するサブネットの IDs を使用して EKS Fargate Profile を作成する** 次の `create-fargate-profile` の例では、複数の名前空間とラベル、およびポッドを起動するサブネットの ID を持つセレクターの EKS Fargate プロファイルを作成します。 ``` 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"}' ``` 出力: ``` { "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" } } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[AWS Fargate プロファイル - Fargate プロファイルの作成](https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html#create-fargate-profile)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateFargateProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/create-fargate-profile.html)」を参照してください。 ### `create-nodegroup` 次のコード例は、`create-nodegroup` を使用する方法を示しています。 **AWS CLI** **例 1: Amazon EKS クラスターのマネージド型ノードグループを作成する** 次の `create-nodegroup` の例では、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 ``` 出力: ``` { "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": {} } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[マネージド型ノードグループの作成](https://docs.aws.amazon.com/eks/latest/userguide/create-managed-node-group.html)」を参照してください。 **例 2: カスタムの instance-types と disk-size のある Amazon EKS クラスターのマネージド型ノードグループを作成する** 次の `create-nodegroup` の例では、カスタムの instance-types と disk-size のある 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 \ --capacity-type ON_DEMAND \ --instance-types 'm5.large' \ --disk-size 50 \ --region us-east-2 ``` 出力: ``` { "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": {} } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[マネージド型ノードグループの作成](https://docs.aws.amazon.com/eks/latest/userguide/create-managed-node-group.html)」を参照してください。 **例 3: カスタムの instance-types、disk-size、ami-type、capacity-type、update-config、ラベル、テイント、タグを持つ Amazon EKS クラスターのマネージド型ノードグループを作成する。** 次の `create-nodegroup` の例では、カスタムの instance-types、disk-size、ami-type、capacity-type、update-config、ラベル、テイント、タグを持つ 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=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"}' ``` 出力: ``` { "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" } } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[マネージド型ノードグループの作成](https://docs.aws.amazon.com/eks/latest/userguide/create-managed-node-group.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateNodegroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/create-nodegroup.html)」を参照してください。 ### `create-pod-identity-association` 次のコード例は、`create-pod-identity-association` を使用する方法を示しています。 **AWS CLI** **例 1: EKS クラスターで EKS Pod Identity の関連付けを作成するには** 次の `create-pod-identity-association` の例では、EKS クラスター内のサービスアカウントと IAM ロールの間に EKS Pod Identity の関連付けを作成します。 ``` aws eks create-pod-identity-association \ --cluster-name eks-customer \ --namespace default \ --service-account default \ --role-arn arn:aws:iam::111122223333:role/my-role ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[EKS Pod Identity がポッドに AWS サービスへのアクセス権を付与する仕組みを学ぶ](https://docs.aws.amazon.com/eks/latest/userguide/pod-identities.html)」を参照してください。 **例 2: タグを使用する EKS クラスターに EKS Pod Identity の関連付けを作成するには** 次の `create-pod-identity-association` では、サービスアカウントとタグを使用する EKS クラスター内の IAM ロールとの間に EKS Pod Identity の関連付けを作成します。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[EKS Pod Identity がポッドに AWS サービスへのアクセス権を付与する仕組みを学ぶ](https://docs.aws.amazon.com/eks/latest/userguide/pod-identities.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreatePodIdentityAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/create-pod-identity-association.html)」を参照してください。 ### `delete-access-entry` 次のコード例は、`delete-access-entry` を使用する方法を示しています。 **AWS CLI** **クラスターに関連付けられたアクセスエントリを削除するには** 次の `delete-access-entry` は、`eks-customer` という名前の EKS クラスターに関連付けられたアクセスエントリを削除します。 ``` aws eks delete-access-entry \ --cluster-name eks-customer \ --principal-arn arn:aws:iam::111122223333:role/Admin ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EKS ユーザーガイド*」の「[アクセスエントリを削除する](https://docs.aws.amazon.com/eks/latest/userguide/deleting-access-entries.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAccessEntry](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/delete-access-entry.html)」を参照してください。 ### `delete-addon` 次のコード例は、`delete-addon` を使用する方法を示しています。 **AWS CLI** **例 1。Amazon EKS アドオンを削除し、アドオンソフトウェアを EKS クラスターに保存するには** 次の `delete-addon` コマンド例では、Amazon EKS アドオンを削除しますが、アドオンソフトウェアは EKS クラスターに保持されます。 ``` aws eks delete-addon \ --cluster-name my-eks-cluster \ --addon-name my-eks-addon \ --preserve ``` 出力: ``` { "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": {} } } ``` 詳細については、「*Amazon EKS*」の「[Amazon EKS アドオンの管理 - アドオンの削除](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#removing-an-add-on)」を参照してください。 **例 2。Amazon EKS アドオンを削除し、EKS クラスターからアドオンソフトウェアも削除するには** 次の `delete-addon` のコマンド例では、Amazon EKS アドオンを削除し、EKS クラスターからアドオンソフトウェアも削除します。 ``` aws eks delete-addon \ --cluster-name my-eks-cluster \ --addon-name my-eks-addon ``` 出力: ``` { "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": {} } } ``` 詳細については、「*Amazon EKS*」の「[Amazon EKS アドオンの管理 - アドオンの削除](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#removing-an-add-on)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAddon](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/delete-addon.html)」を参照してください。 ### `delete-cluster` 次のコード例は、`delete-cluster` を使用する方法を示しています。 **AWS CLI** **Amazon EKS クラスターコントロールプレーンを削除する** 次の `delete-cluster` の例では、Amazon EKS クラスターコントロールプレーンを削除します。 ``` aws eks delete-cluster \ --name my-eks-cluster ``` 出力: ``` { "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" } } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[Amazon EKS クラスターの削除](https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/delete-cluster.html)」を参照してください。 ### `delete-fargate-profile` 次のコード例は、`delete-fargate-profile` を使用する方法を示しています。 **AWS CLI** **例 1: 名前空間を持つセレクターの EKS Fargate プロファイルを作成する** 次の `delete-fargate-profile` の例では、名前空間を持つセレクターの EKS Fargate Profile を作成します。 ``` aws eks delete-fargate-profile \ --cluster-name my-eks-cluster \ --fargate-profile-name my-fargate-profile ``` 出力: ``` { "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": {} } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[AWS Fargate プロファイル - Fargate の削除](https://docs.aws.amazon.com/eks/latest/userguide/fargate-profile.html#delete-fargate-profile)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteFargateProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/delete-fargate-profile.html)」を参照してください。 ### `delete-nodegroup` 次のコード例は、`delete-nodegroup` を使用する方法を示しています。 **AWS CLI** **例 1: Amazon EKS クラスターのマネージドノードグループを削除する** 次の `delete-nodegroup` の例では、Amazon EKS クラスターのマネージド型ノードグループを削除します。 ``` aws eks delete-nodegroup \ --cluster-name my-eks-cluster \ --nodegroup-name my-eks-nodegroup ``` 出力: ``` { "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" } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteNodegroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/delete-nodegroup.html)」を参照してください。 ### `delete-pod-identity-association` 次のコード例は、`delete-pod-identity-association` を使用する方法を示しています。 **AWS CLI** **EKS Pod Identity の関連付けを削除するには** 次の `delete-pod-identity-association` の例では、`eks-customer` という名前の EKS クラスターから、関連付け ID `a-9njjin9gfghecgocd` との EKS Pod Identity の関連付けを削除します。 ``` aws eks delete-pod-identity-association \ --cluster-name eks-customer \ --association-id a-9njjin9gfghecgocd ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[EKS Pod Identity がポッドに AWS サービスへのアクセス権を付与する仕組みを学ぶ](https://docs.aws.amazon.com/eks/latest/userguide/pod-identities.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeletePodIdentityAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/delete-pod-identity-association.html)」を参照してください。 ### `deregister-cluster` 次のコード例は、`deregister-cluster` を使用する方法を示しています。 **AWS CLI** **接続されたクラスターの登録を解除して Amazon EKS コントロールプレーンから削除するには** 次の `deregister-cluster` の例では、接続されたクラスターを登録解除して、Amazon EKS コントロールプレーンから削除します。 ``` aws eks deregister-cluster \ --name my-eks-anywhere-cluster ``` 出力: ``` { "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" } } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[Deregistering a cluster](https://docs.aws.amazon.com/eks/latest/userguide/deregister-connected-cluster.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeregisterCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/deregister-cluster.html)」を参照してください。 ### `describe-access-entry` 次のコード例は、`describe-access-entry` を使用する方法を示しています。 **AWS CLI** **EKS クラスターのアクセスエントリを記述するには** 次の `describe-access-entry` の例では、EKS クラスターのアクセスエントリについて説明します。 ``` aws eks describe-access-entry \ --cluster-name eks-customer \ --principal-arn arn:aws:iam::111122223333:user/eks-admin-user ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[EKS アクセスエントリを使用して Kubernetes へのアクセス権を IAM ユーザーに付与する](https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAccessEntry](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/describe-access-entry.html)」を参照してください。 ### `describe-addon-configuration` 次のコード例は、`describe-addon-configuration` を使用する方法を示しています。 **AWS CLI** **例 1: Amazon vpc-cni AddOns を作成または更新するときに使用できる設定オプション** 次の `describe-addon-configuration` の例では、vpc-cni アドオンのアドオンが各バージョンで作成または更新されたときに使用するすべての使用可能な設定スキーマを返します。 ``` aws eks describe-addon-configuration \ --addon-name vpc-cni \ --addon-version v1.15.1-eksbuild.1 ``` 出力: ``` { "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\"}" } ``` **例 2: Amazon coredns AddOns を作成または更新するときに使用できる設定オプション** 次の `describe-addon-configuration` の例では、それぞれのバージョンで coredns アドオンのアドオンを作成または更新するときに使用するすべての使用可能な設定スキーマを返します。 ``` aws eks describe-addon-configuration \ --addon-name coredns \ --addon-version v1.8.7-eksbuild.4 ``` 出力: ``` { "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\"}}}" } ``` 詳細については、「*Amazon EKS*」の「[Amazon EKS クラスターの kubeconfig ファイルの作成または更新](https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAddonConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/describe-addon-configuration.html)」を参照してください。 ### `describe-addon-versions` 次のコード例は、`describe-addon-versions` を使用する方法を示しています。 **AWS CLI** **例 1: EKS クラスターで使用できるすべてのアドオンを一覧表示する** 次の `describe-addon-versions` の例は、使用可能な AWS のアドオンを一覧表示します。 ``` aws eks describe-addon-versions \ --query 'sort_by(addons &owner)[].{publisher: publisher, owner: owner, addonName: addonName, type: type}' \ --output table ``` 出力: ``` -------------------------------------------------------------------------------------------------------------------- | 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 | +---------------------------------------------+------------------+-----------------------+-------------------------+ ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[Amazon EKS アドオンの管理 - アドオンの作成](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#creating-an-add-on)」を参照してください。 **例 2: EKS 用にサポートされる指定された Kubernetes バージョンで使用可能なすべてのアドオンを一覧表示する** 次の `describe-addon-versions` の例では、EKS 用にサポートされる指定された Kubernetes バージョンで使用可能なアドオンを一覧表示します。 ``` aws eks describe-addon-versions \ --kubernetes-version=1.26 \ --query 'sort_by(addons &owner)[].{publisher: publisher, owner: owner, addonName: addonName, type: type}' \ --output table ``` 出力: ``` -------------------------------------------------------------------------------------------------------------------- | 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 | +---------------------------------------------+------------------+-----------------------+-------------------------+ ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[Amazon EKS アドオンの管理 - アドオンの作成](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#creating-an-add-on)」を参照してください。 **例 3: EKS 用にサポートされる指定された Kubernetes バージョンで使用可能なすべての vpc-cni アドオンバージョンを一覧表示する** 次の `describe-addon-versions` の例では、EKS 用にサポートされる指定された Kubernetes バージョンで使用可能なすべての vpc-cni アドオンバージョンを一覧表示します。 ``` aws eks describe-addon-versions \ --kubernetes-version=1.26 \ --addon-name=vpc-cni \ --query='addons[].addonVersions[].addonVersion' ``` 出力: ``` [ "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" ] ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[Amazon EKS アドオンの管理 - アドオンの作成](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#creating-an-add-on)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAddonVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/describe-addon-versions.html)」を参照してください。 ### `describe-addon` 次のコード例は、`describe-addon` を使用する方法を示しています。 **AWS CLI** **Amazon EKS クラスターでアクティブに実行されている EKS アドオンを記述する** 次の `describe-addon` の例では、Amazon EKS クラスターで EKS アドオンをアクティブに実行しています。 ``` aws eks describe-addon \ --cluster-name my-eks-cluster \ --addon-name vpc-cni ``` 出力: ``` { "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'" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAddon](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/describe-addon.html)」を参照してください。 ### `describe-cluster` 次のコード例は、`describe-cluster` を使用する方法を示しています。 **AWS CLI** **Amazon EKS クラスターでアクティブに実行されている EKS アドオンを記述する** 次の `describe-cluster` の例では、Amazon EKS クラスターで EKS アドオンをアクティブに実行しています。 ``` aws eks describe-cluster \ --name my-eks-cluster ``` 出力: ``` { "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" } } } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/describe-cluster.html)」を参照してください。** ### `describe-fargate-profile` 次のコード例は、`describe-fargate-profile` を使用する方法を示しています。 **AWS CLI** **Fargate プロファイルを記述する** 次の `describe-fargate-profile` の例では、Fargate プロファイルについて記述します。 ``` aws eks describe-fargate-profile \ --cluster-name my-eks-cluster \ --fargate-profile-name my-fargate-profile ``` 出力: ``` { "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" } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeFargateProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/describe-fargate-profile.html)」を参照してください。 ### `describe-identity-provider-config` 次のコード例は、`describe-identity-provider-config` を使用する方法を示しています。 **AWS CLI** **Amazon EKS クラスターに関連付けられた ID プロバイダー設定を記述する** 次の `describe-identity-provider-config` の例では、Amazon EKS クラスターに関連付けられた ID プロバイダー設定について記述します。 ``` aws eks describe-identity-provider-config \ --cluster-name my-eks-cluster \ --identity-provider-config type=oidc,name=my-identity-provider ``` 出力: ``` { "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" } } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[Authenticate users for your cluster from an OpenID Connect identity provider](https://docs.aws.amazon.com/eks/latest/userguide/authenticate-oidc-identity-provider.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeIdentityProviderConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/describe-identity-provider-config.html)」を参照してください。 ### `describe-insight` 次のコード例は、`describe-insight` を使用する方法を示しています。 **AWS CLI** **ID を使用して EKS クラスターのインサイトの詳細を取得するには** 次の `describe-insight` の例では、クラスター名とインサイト ID を使用して指定されたインサイトの詳細を返します。 ``` aws eks describe-insight \ --cluster-name eks-customer \ --id 38ea7a64-a14f-4e0e-95c7-8dbcab3c3623 ``` 出力: ``` { "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": [] } } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[クラスターインサイトを表示する](https://docs.aws.amazon.com/eks/latest/userguide/view-cluster-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeInsight](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/describe-insight.html)」を参照してください。 ### `describe-nodegroup` 次のコード例は、`describe-nodegroup` を使用する方法を示しています。 **AWS CLI** **Amazon EKS クラスターのマネージド型ノードグループを記述する** 次の `describe-nodegroup` の例では、Amazon EKS クラスターのマネージド型ノードグループについて説明します。 ``` aws eks describe-nodegroup \ --cluster-name my-eks-cluster \ --nodegroup-name my-eks-nodegroup ``` 出力: ``` { "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": {} } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeNodegroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/describe-nodegroup.html)」を参照してください。 ### `describe-pod-identity-association` 次のコード例は、`describe-pod-identity-association` を使用する方法を示しています。 **AWS CLI** **Pod Identity の関連付けの詳細を指定するには** 次の `describe-pod-identity-association` の例では、EKS クラスター内の Pod Identity の関連付けについて説明します。 ``` aws eks describe-pod-identity-association \ --cluster-name eks-customer \ --association-id a-9njjin9gfghecgocd ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[EKS Pod Identity がポッドに AWS サービスへのアクセス権を付与する仕組みを学ぶ](https://docs.aws.amazon.com/eks/latest/userguide/pod-identities.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribePodIdentityAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/describe-pod-identity-association.html)」を参照してください。 ### `describe-update` 次のコード例は、`describe-update` を使用する方法を示しています。 **AWS CLI** **例 1: クラスターの更新を記述するには** 次の `describe-update` の例では、名前の付いたクラスターの更新について記述しています。 ``` aws eks describe-update \ --name my-eks-cluster \ --update-id 10bddb13-a71b-425a-b0a6-71cd03e59161 ``` 出力: ``` { "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": [] } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[Updating an Amazon EKS cluster Kubernetes version](https://docs.aws.amazon.com/eks/latest/userguide/update-cluster.html)」を参照してください。 **例 2: クラスターの更新を記述するには** 次の `describe-update` の例では、名前の付いたクラスターの更新について記述しています。 ``` aws eks describe-update \ --name my-eks-cluster \ --update-id e4994991-4c0f-475a-a040-427e6da52966 ``` 出力: ``` { "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": [] } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[Updating an Amazon EKS cluster Kubernetes version](https://docs.aws.amazon.com/eks/latest/userguide/update-cluster.html)」を参照してください。 **例 3: クラスターの更新を記述するには** 次の `describe-update` の例では、名前の付いたクラスターの更新について記述しています。 ``` aws eks describe-update \ --name my-eks-cluster \ --update-id b5f0ba18-9a87-4450-b5a0-825e6e84496f ``` 出力: ``` { "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": [] } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[Updating an Amazon EKS cluster Kubernetes version](https://docs.aws.amazon.com/eks/latest/userguide/update-cluster.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeUpdate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/describe-update.html)」を参照してください。 ### `disassociate-access-policy` 次のコード例は、`disassociate-access-policy` を使用する方法を示しています。 **AWS CLI** **アクセスポリシーとアクセスエントリの関連付けを解除するには** 次の `disassociate-access-policy` では、アクセスエントリに関連付けられたアクセスポリシーを削除します。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon EKS ユーザーガイド*」の「[アクセスポリシーをアクセスエントリに関連付ける](https://docs.aws.amazon.com/eks/latest/userguide/access-policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/disassociate-access-policy.html)」を参照してください。 ### `disassociate-identity-provider-config` 次のコード例は、`disassociate-identity-provider-config` を使用する方法を示しています。 **AWS CLI** **ID プロバイダーと Amazon EKS クラスターの関連付けを解除するには** 次の `disassociate-identity-provider-config` の例では、Amazon EKS クラスターへの ID プロバイダーの関連付けを解除します。 ``` aws eks disassociate-identity-provider-config \ --cluster-name my-eks-cluster \ --identity-provider-config 'type=oidc,name=my-identity-provider' ``` 出力: ``` { "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": [] } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[Authenticate users for your cluster from an OpenID Connect identity provider - Disassociate an OIDC identity provider from your cluster](https://docs.aws.amazon.com/eks/latest/userguide/authenticate-oidc-identity-provider.html#disassociate-oidc-identity-provider)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateIdentityProviderConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/disassociate-identity-provider-config.html)」を参照してください。 ### `get-token` 次のコード例は、`get-token` を使用する方法を示しています。 **AWS CLI** **例 1:「my-eks-cluster」という名前の Amazon EKS クラスターの認証トークンを取得する** 次の `get-token` の例では、my-eks-cluster という名前の Amazon EKS クラスターの認証トークンを取得します。 ``` aws eks get-token \ --cluster-name my-eks-cluster ``` 出力: ``` { "kind": "ExecCredential", "apiVersion": "client.authentication.k8s.io/v1beta1", "spec": {}, "status": { "expirationTimestamp": "2024-04-11T20:59:56Z", "token": "k8s-aws-v1.EXAMPLE_TOKEN_DATA_STRING..." } } ``` **例 2: トークンの署名時に認証情報としてこの roleARN を引き受けることで、「my-eks-cluster」という名前の Amazon EKS クラスターの認証トークンを取得する** 次の `get-token` の例では、トークンの署名時に認証情報としてこの roleARN を引き受けることで、my-eks-cluster という名前の Amazon EKS クラスターの認証トークンを取得します。 ``` 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 ``` 出力: ``` { "kind": "ExecCredential", "apiVersion": "client.authentication.k8s.io/v1beta1", "spec": {}, "status": { "expirationTimestamp": "2024-04-11T21:05:26Z", "token": "k8s-aws-v1.EXAMPLE_TOKEN_DATA_STRING..." } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/get-token.html)」を参照してください。 ### `list-access-entries` 次のコード例は、`list-access-entries` を使用する方法を示しています。 **AWS CLI** **EKS クラスターのアクセスエントリを一覧表示するには** 次の `list-access-entries` は、EKS クラスター `eks-customer` に関連付けられたアクセスエントリのリストを返します。 ``` aws eks list-access-entries \ --cluster-name eks-customer ``` 出力: ``` { "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" ] } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[EKS アクセスエントリを使用して Kubernetes へのアクセスを IAM ユーザーに許可する](https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAccessEntries](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-access-entries.html)」を参照してください。 ### `list-access-policies` 次のコード例は、`list-access-policies` を使用する方法を示しています。 **AWS CLI** **利用可能なすべてのアクセスポリシーを一覧表示するには** この `list-access-policies` の例では、利用可能なすべてのアクセスポリシーのリストを返します。 ``` aws eks list-access-policies ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[アクセスポリシーをアクセスエントリに関連付ける](https://docs.aws.amazon.com/eks/latest/userguide/access-policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAccessPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-access-policies.html)」を参照してください。 ### `list-addons` 次のコード例は、`list-addons` を使用する方法を示しています。 **AWS CLI** **「my-eks-cluster」という名前の Amazon EKS クラスターにインストールされているすべてのアドオンを一覧表示する** 次の `list-addons` の例では、my-eks-cluster という名前の Amazon EKS クラスターにインストールされているすべてのアドオンを一覧表示します。 ``` aws eks list-addons \ --cluster-name my-eks-cluster ``` 出力: ``` { "addons": [ "kube-proxy", "vpc-cni" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAddons](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-addons.html)」を参照してください。 ### `list-associated-access-policies` 次のコード例は、`list-associated-access-policies` を使用する方法を示しています。 **AWS CLI** **アクセスエントリに関連付けられたアクセスポリシーを一覧表示するには** 次の `list-associated-access-policies` の例では、EKS クラスターのアクセスエントリに関連付けられたアクセスポリシーのリストを返します。 ``` aws eks list-associated-access-policies \ --cluster-name eks-customer \ --principal-arn arn:aws:iam::111122223333:role/Admin ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[EKS アクセスエントリを使用して Kubernetes へのアクセスを IAM ユーザーに許可する](https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAssociatedAccessPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-associated-access-policies.html)」を参照してください。 ### `list-clusters` 次のコード例は、`list-clusters` を使用する方法を示しています。 **AWS CLI** **「my-eks-cluster」という名前の Amazon EKS クラスターにインストールされているすべてのアドオンを一覧表示するには** 次の `list-clusters` の例では、my-eks-cluster という名前の Amazon EKS クラスターにインストールされているすべてのアドオンを一覧表示します。 ``` aws eks list-clusters ``` 出力: ``` { "clusters": [ "prod", "qa", "stage", "my-eks-cluster" ] } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[ListClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-clusters.html)」を参照してください。** ### `list-fargate-profiles` 次のコード例は、`list-fargate-profiles` を使用する方法を示しています。 **AWS CLI** **「my-eks-cluster」という名前の Amazon EKS クラスター内のすべての Fargate プロファイルを一覧表示するには** 次の `list-fargate-profiles` の例では、my-eks-cluster という名前の Amazon EKS クラスター内のすべての Fargate プロファイルを一覧表示します。 ``` aws eks list-fargate-profiles \ --cluster-name my-eks-cluster ``` 出力: ``` { "fargateProfileNames": [ "my-fargate-profile" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListFargateProfiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-fargate-profiles.html)」を参照してください。 ### `list-identity-provider-configs` 次のコード例は、`list-identity-provider-configs` を使用する方法を示しています。 **AWS CLI** **Amazon EKS クラスターに関連付けられている ID プロバイダーを一覧表示する** 次の `list-identity-provider-configs` の例では、Amazon EKS クラスターに関連付けられている ID プロバイダーを一覧表示します。 ``` aws eks list-identity-provider-configs \ --cluster-name my-eks-cluster ``` 出力: ``` { "identityProviderConfigs": [ { "type": "oidc", "name": "my-identity-provider" } ] } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[Authenticate users for your cluster from an OpenID Connect identity provider](https://docs.aws.amazon.com/eks/latest/userguide/authenticate-oidc-identity-provider.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListIdentityProviderConfigs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-identity-provider-configs.html)」を参照してください。 ### `list-insights` 次のコード例は、`list-insights` を使用する方法を示しています。 **AWS CLI** **指定されたクラスターのすべてのインサイトを一覧表示するには** 次の `list-insights` の例では、指定されたクラスターに対してチェックされたすべてのインサイトのリストを返します。 ``` aws eks list-insights \ --cluster-name eks-customer ``` 出力: ``` { "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." } } ] } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[クラスターインサイトを表示する](https://docs.aws.amazon.com/eks/latest/userguide/view-cluster-insights.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListInsights](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-insights.html)」を参照してください。 ### `list-nodegroups` 次のコード例は、`list-nodegroups` を使用する方法を示しています。 **AWS CLI** **Amazon EKS クラスター内のすべてのノードグループを一覧表示する** 次の `list-nodegroups` の例では、 Amazon EKS クラスターにすべてのノードグループを一覧表示します。 ``` aws eks list-nodegroups \ --cluster-name my-eks-cluster ``` 出力: ``` { "nodegroups": [ "my-eks-managed-node-group", "my-eks-nodegroup" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListNodegroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-nodegroups.html)」を参照してください。 ### `list-pod-identity-associations` 次のコード例は、`list-pod-identity-associations` を使用する方法を示しています。 **AWS CLI** **例 1: EKS クラスター内の Pod Identity の関連付けを一覧表示するには** 次の `list-pod-identity-associations` は、すべての名前空間とサービスアカウントで `eks-customer` という名前の EKS クラスターに関連付けられた Pod Identity の関連付けのリストを返します。 ``` aws eks list-pod-identity-associations \ --cluster-name eks-customer ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[EKS Pod Identity がポッドに AWS サービスへのアクセス権を付与する仕組みを学ぶ](https://docs.aws.amazon.com/eks/latest/userguide/pod-identities.html)」を参照してください。 **例 2: 名前空間とサービスアカウントに基づいて EKS クラスター内の Pod Identity の関連付けを一覧表示するには** 次の `list-pod-identity-associations` は、名前空間とサービスアカウントに基づいて EKS クラスター内の Pod Identity の関連付けのリストを返します。 ``` aws eks list-pod-identity-associations \ --cluster-name eks-customer \ --namespace kube-system \ --service-account eks-customer ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[EKS Pod Identity がポッドに AWS サービスへのアクセス権を付与する仕組みを学ぶ](https://docs.aws.amazon.com/eks/latest/userguide/pod-identities.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPodIdentityAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-pod-identity-associations.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **例 1: Amazon EKS クラスター ARN のすべてのタグを一覧表示するには** 次の `list-tags-for-resource` の例では、Amazon EKS クラスター ARN のすべてのタグを一覧表示します。 ``` aws eks list-tags-for-resource \ --resource-arn arn:aws:eks:us-east-2:111122223333:cluster/my-eks-cluster ``` 出力: ``` { "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" } } ``` **例 2: Amazon EKS ノードグループ ARN のすべてのタグを一覧表示するには** 次の `list-tags-for-resource` の例では、Amazon EKS ノードグループ ARN のすべてのタグを一覧表示します。 ``` 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 ``` 出力: ``` { "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" } } ``` **例 3: Amazon EKS Fargate プロフィル ARNe のすべてのタグを一覧表示するには** 次の `list-tags-for-resource` の例では、Amazon EKS Fargate プロファイル ARN のすべてのタグを一覧表示します。 ``` 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 ``` 出力: ``` { "tags": { "eks-fargate-profile-key-2": "value-2", "eks-fargate-profile-key-1": "value-1" } } ``` **例 4: Amazon EKS アドオン ARN のすべてのタグを一覧表示するには** 次の `list-tags-for-resource` の例では、Amazon EKS アドオン ARN のすべてのタグを一覧表示します。 ``` 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 ``` 出力: ``` { "tags": { "eks-addon-key-2": "value-2", "eks-addon-key-1": "value-1" } } ``` **例 5: Amazon EKS OIDC ID プロバイダー ARN のすべてのタグを一覧表示するには** 次の `list-tags-for-resource` の例では、Amazon EKS OIDC ID プロバイダー ARN のすべてのタグを一覧表示します。 ``` 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 ``` 出力: ``` { "tags": { "my-identity-provider": "test" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-tags-for-resource.html)」を参照してください。 ### `list-update` 次のコード例は、`list-update` を使用する方法を示しています。 **AWS CLI** **例 1: Amazon EKS クラスター名に関連付けられた更新を一覧表示するには** 次の `list-updates` の例では、Amazon EKS クラスター名のすべての更新 ID を一覧表示します。 ``` aws eks list-updates \ --name my-eks-cluster ``` 出力: ``` { "updateIds": [ "5f78d14e-c57b-4857-a3e4-cf664ae20949", "760e5a3f-adad-48c7-88d3-7ac283c09c26", "cd4ec863-bc55-47d5-a377-3971502f529b", "f12657ce-e869-4f17-b158-a82ab8b7d937" ] } ``` **例 2: Amazon EKS ノードグループのすべての更新 ID を一覧表示するには** 次の `list-updates` の例では、Amazon EKS ノードグループのすべての更新 ID を一覧表示します。 ``` aws eks list-updates \ --name my-eks-cluster \ --nodegroup-name my-eks-managed-node-group ``` 出力: ``` { "updateIds": [ "8c6c1bef-61fe-42ac-a242-89412387b8e7" ] } ``` **例 3: Amazon EKS アドオンのすべての更新 ID を一覧表示するには** 次の `list-updates` の例では、Amazon EKS アドオンのすべての更新 ID を一覧表示します。 ``` aws eks list-updates \ --name my-eks-cluster \ --addon-name vpc-cni ``` 出力: ``` { "updateIds": [ "9cdba8d4-79fb-3c83-afe8-00b508d33268" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListUpdate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-update.html)」を参照してください。 ### `list-updates` 次のコード例は、`list-updates` を使用する方法を示しています。 **AWS CLI** **クラスターの更新を一覧表示するには** このコマンド例では、デフォルトのリージョンで `example` という名前のクラスターの現在の更新を一覧表示します。 コマンド: ``` aws eks list-updates --name example ``` 出力: ``` { "updateIds": [ "10bddb13-a71b-425a-b0a6-71cd03e59161" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListUpdates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/list-updates.html)」を参照してください。 ### `register-cluster` 次のコード例は、`register-cluster` を使用する方法を示しています。 **AWS CLI** **例 1: 外部 EKS\$1ANYWHERE Kubernetes クラスターを Amazon EKS に登録する** 次の `register-cluster` の例では、外部 EKS\$1ANYWHERE Kubernetes クラスターを Amazon EKS に登録します。 ``` aws eks register-cluster \ --name my-eks-anywhere-cluster \ --connector-config 'roleArn=arn:aws:iam::111122223333:role/AmazonEKSConnectorAgentRole,provider=EKS_ANYWHERE' ``` 出力: ``` { "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" } } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[外部のクラスターの接続](https://docs.aws.amazon.com/eks/latest/userguide/connecting-cluster.html)」を参照してください。 **例 2: 外部 Kubernetes クラスターを Amazon EKS に登録する** 次の `register-cluster` の例では、外部 EKS\$1ANYWHERE Kubernetes クラスターを Amazon EKS に登録します。 ``` aws eks register-cluster \ --name my-eks-anywhere-cluster \ --connector-config 'roleArn=arn:aws:iam::111122223333:role/AmazonEKSConnectorAgentRole,provider=OTHER' ``` 出力: ``` { "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" } } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[外部のクラスターの接続](https://docs.aws.amazon.com/eks/latest/userguide/connecting-cluster.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegisterCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/register-cluster.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **例 1: 指定されたタグを Amazon EKS クラスターに追加するには** 次の `tag-resource` の例では、指定されたタグを 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' ``` このコマンドでは何も出力されません。 **例 2: 指定されたタグを Amazon EKS ノードグループに追加するには** 次の `tag-resource` の例では、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' ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **例 1: Amazon EKS クラスターから指定されたタグを削除するには** 次の `untag-resource` の例は、指定されたタグを 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" ``` このコマンドでは何も出力されません。 **例 2: Amazon EKS ノードグループから指定されたタグを削除するには** 次の `untag-resource` の例では、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" ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/untag-resource.html)」を参照してください。 ### `update-access-entry` 次のコード例は、`update-access-entry` を使用する方法を示しています。 **AWS CLI** **EKS クラスターのアクセスエントリを更新するには** 次の `update-access-entry` は、Kubernetes グループ `tester` を追加して、EKS クラスターのアクセスエントリを更新します。 ``` aws eks update-access-entry \ --cluster-name eks-customer \ --principal-arn arn:aws:iam::111122223333:role/Admin \ --kubernetes-groups tester ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[アクセスエントリを更新する](https://docs.aws.amazon.com/eks/latest/userguide/updating-access-entries.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateAccessEntry](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/update-access-entry.html)」を参照してください。 ### `update-addon` 次のコード例は、`update-addon` を使用する方法を示しています。 **AWS CLI** **例 1。サービスアカウントロール ARN を使用して Amazon EKS アドオンを更新するには** 次の `update-addon` の例では、サービスアカウントロール ARN を使用して Amazon EKS アドオンを更新します。 ``` 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 ``` 出力: ``` { "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": [] } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[Amazon EKS アドオンの管理 - アドオンの更新](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#updating-an-add-on)」を参照してください。 **例 2。特定のアドオンバージョンで Amazon EKS アドオンを更新するには** 次の `update-addon` のコマンド例では、Amazon EKS アドオンを特定のアドオンバージョンで更新します。 ``` 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 ``` 出力: ``` { "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": [] } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[Amazon EKS アドオンの管理 - アドオンの更新](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#updating-an-add-on)」を参照してください。 **例 3。Amazon EKS アドオンをカスタム設定値で更新し、競合の詳細を解決するには** 次の `update-addon` のコマンド例では、Amazon EKS アドオンをカスタム設定値で更新し、競合の詳細を解決します。 ``` 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 ``` 出力: ``` { "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": [] } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[Amazon EKS アドオンの管理 - アドオンの更新](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#updating-an-add-on)」を参照してください。 **例 4。Amazon EKS アドオンをカスタム JSON 設定値ファイルで更新するには** 次の `update-addon` の例では、カスタム JSON 設定値を使用して Amazon EKS アドオンを更新し、競合の詳細を解決します。 ``` 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 ``` `configuration-values.json` の内容: ``` { "resources": { "limits": { "cpu": "100m" }, "requests": { "cpu": "50m" } }, "env": { "AWS_VPC_K8S_CNI_LOGLEVEL": "ERROR" } } ``` 出力: ``` { "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": [] } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[Amazon EKS アドオンの管理 - アドオンの更新](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#updating-an-add-on)」を参照してください。 **例 5。Amazon EKS アドオンをカスタム YAML 設定値ファイルで更新するには** 次の `update-addon` の例では、カスタム YAML 設定値を使用して Amazon EKS アドオンを更新し、競合の詳細を解決します。 ``` 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 ``` `configuration-values.yaml` の内容: ``` resources: limits: cpu: '100m' requests: cpu: '50m' env: AWS_VPC_K8S_CNI_LOGLEVEL: 'DEBUG' ``` 出力: ``` { "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": [] } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[Amazon EKS アドオンの管理 - アドオンの更新](https://docs.aws.amazon.com/eks/latest/userguide/managing-add-ons.html#updating-an-add-on)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateAddon](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/update-addon.html)」を参照してください。 ### `update-cluster-config` 次のコード例は、`update-cluster-config` を使用する方法を示しています。 **AWS CLI** **クラスターエンドポイントアクセスを更新するには** このコマンド例では、クラスターを更新してエンドポイントのパブリックアクセスを無効にし、プライベートエンドポイントアクセスを有効にします。 コマンド: ``` aws eks update-cluster-config --name example \ --resources-vpc-config endpointPublicAccess=false,endpointPrivateAccess=true ``` 出力: ``` { "update": { "id": "ec883c93-2e9e-407c-a22f-8f6fa6e67d4f", "status": "InProgress", "type": "EndpointAccessUpdate", "params": [ { "type": "EndpointPublicAccess", "value": "false" }, { "type": "EndpointPrivateAccess", "value": "true" } ], "createdAt": 1565806986.506, "errors": [] } } ``` **クラスターのログ記録を有効にするには** このコマンド例では、`example` という名前のクラスターのすべてのクラスターコントロールプレーンのログ記録タイプを有効にします。 コマンド: ``` aws eks update-cluster-config --name example \ --logging '{"clusterLogging":[{"types":["api","audit","authenticator","controllerManager","scheduler"],"enabled":true}]}' ``` 出力: ``` { "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": [] } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateClusterConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/update-cluster-config.html)」を参照してください。 ### `update-cluster-version` 次のコード例は、`update-cluster-version` を使用する方法を示しています。 **AWS CLI** **my-eks-cluster」という名前の Amazon EKS クラスターを指定された Kubernetes バージョンに更新するには** 次の `update-cluster-version` の例では、Amazon EKS クラスターを指定された Kubernetes バージョンに更新します。 ``` aws eks update-cluster-version \ --name my-eks-cluster \ --kubernetes-version 1.27 ``` 出力: ``` { "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": [] } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[Updating an Amazon EKS cluster Kubernetes version](https://docs.aws.amazon.com/eks/latest/userguide/update-cluster.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateClusterVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/update-cluster-version.html)」を参照してください。 ### `update-kubeconfig` 次のコード例は、`update-kubeconfig` を使用する方法を示しています。 **AWS CLI** **例 1: 「my-eks-cluster」という名前の Amazon EKS クラスターに接続できるように、kubeconfig を作成または更新して kubectl を設定する** 次の `update-kubeconfig` の例では、my-eks-cluster という名前の Amazon EKS クラスターに接続できるように、kubeconfig を作成または更新して kubectl を設定します。 ``` aws eks update-kubeconfig \ --name my-eks-cluster ``` 出力: ``` Updated context arn:aws:eks:us-east-2:111122223333:cluster/my-eks-cluster in /Users/xxx/.kube/config ``` 詳細については、*Amazon EKS ユーザーガイド*の「[Amazon EKS クラスター用の kubeconfig ファイルの作成または更新](https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html)」を参照してください。 **例 2: kubeconfig (クラスター認証のロールを引き受ける role-arn オプションを使用) を作成または更新して kubectl を設定し、「my-eks-cluster」という名前の Amazon EKS クラスターに接続できるようにする** 次の `update-kubeconfig` の例では、my-eks-cluster という名前の Amazon EKS クラスターに接続できるように、kubeconfig (クラスター認証のロールを引き受ける role-arn オプションを使用) を作成または更新して kubectl を設定します。 ``` aws eks update-kubeconfig \ --name my-eks-cluster \ --role-arn arn:aws:iam::111122223333:role/eksctl-EKS-Linux-Cluster-v1-24-cluster-ServiceRole-j1k7AfTIQtnM ``` 出力: ``` Updated context arn:aws:eks:us-east-2:111122223333:cluster/my-eks-cluster in /Users/xxx/.kube/config ``` 詳細については、*Amazon EKS ユーザーガイド*の「[Amazon EKS クラスター用の kubeconfig ファイルの作成または更新](https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html)」を参照してください。 **例 3: kubeconfig (カスタムクラスターエイリアスとユーザーエイリアスとともにクラスター認証のロールを引き受ける role-arn オプションを使用) を作成または更新して kubectl を設定し、「my-eks-cluster」という名前の Amazon EKS クラスターに接続できるようにする** 次の `update-kubeconfig` の例では、my-eks-cluster という名前の Amazon EKS クラスターに接続できるように、kubeconfig (カスタムクラスターエイリアスとユーザーエイリアスとともにクラスター認証のロールを引き受ける role-arn オプションを使用) を作成または更新して kubectl を設定します。 ``` 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 ``` 出力: ``` Updated context stage-eks-cluster in /Users/dubaria/.kube/config ``` 詳細については、*Amazon EKS ユーザーガイド*の「[Amazon EKS クラスター用の kubeconfig ファイルの作成または更新](https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html)」を参照してください。 **例 4: レビュー用に kubeconfig ファイルエントリを印刷し、「my-eks-cluster」という名前の Amazon EKS クラスターに接続できるように kubectl を設定する** 次の `update-kubeconfig` の例では、my-eks-cluster という名前の Amazon EKS クラスターに接続できるように、kubeconfig (カスタムクラスターエイリアスとユーザーエイリアスとともにクラスター認証のロールを引き受ける role-arn オプションを使用) を作成または更新して kubectl を設定します。 ``` 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 ``` 出力: ``` 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 ``` 詳細については、*Amazon EKS ユーザーガイド*の「[Amazon EKS クラスター用の kubeconfig ファイルの作成または更新](https://docs.aws.amazon.com/eks/latest/userguide/create-kubeconfig.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateKubeconfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/update-kubeconfig.html)」を参照してください。 ### `update-nodegroup-config` 次のコード例は、`update-nodegroup-config` を使用する方法を示しています。 **AWS CLI** **例 1: マネージド型ノードグループを更新して、Amazon EKS クラスターの EKS ワーカーノードに新しいラベルとテイントを追加する** 次の `update-nodegroup-config` の例では、マネージド型ノードグループを更新して、Amazon EKS クラスターの 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}]' ``` 出力: ``` { "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": [] } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[マネージド型ノードグループの更新](https://docs.aws.amazon.com/eks/latest/userguide/update-managed-node-group.html)」を参照してください。 **例 2: マネージド型ノードグループを更新して、Amazon EKS クラスターの EKS ワーカーノードのラベルとテイントを削除する** 次の `update-nodegroup-config` の例では、マネージド型ノードグループを更新して、Amazon EKS クラスターの 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}]' ``` 出力: ``` { "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": [] } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[マネージド型ノードグループの更新](https://docs.aws.amazon.com/eks/latest/userguide/update-managed-node-group.html)」を参照してください。 **例 3: マネージド型ノードグループを更新して、Amazon EKS クラスターの EKS ワーカーノードのラベルとテイントを削除および追加する** 次の `update-nodegroup-config` の例では、マネージド型ノードグループを更新して、Amazon EKS クラスターの 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}]' ``` 出力: ``` { "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": [] } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[マネージド型ノードグループの更新](https://docs.aws.amazon.com/eks/latest/userguide/update-managed-node-group.html)」を参照してください。 **例 4: マネージド型ノードグループを更新して、Amazon EKS クラスターの EKS ワーカーノードの scaling-config と update-config を更新する** 次の `update-nodegroup-config` の例では、マネージド型ノードグループを更新して、Amazon EKS クラスターの EKS ワーカーノードの scaling-config と update-config を更新します。 ``` 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 ``` 出力: ``` { "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": [] } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[マネージド型ノードグループの更新](https://docs.aws.amazon.com/eks/latest/userguide/update-managed-node-group.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateNodegroupConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/update-nodegroup-config.html)」を参照してください。 ### `update-nodegroup-version` 次のコード例は、`update-nodegroup-version` を使用する方法を示しています。 **AWS CLI** **例 1: Amazon EKS マネージド型ノードグループの Kubernetes バージョンまたは AMI バージョンを更新する** 次の `update-nodegroup-version` の例では、Amazon EKS マネージド型ノードグループの Kubernetes バージョンまたは AMI バージョンを、Kubernetes クラスターで利用可能な最新バージョンに更新します。 ``` aws eks update-nodegroup-version \ --cluster-name my-eks-cluster \ --nodegroup-name my-eks-nodegroup \ --no-force ``` 出力: ``` { "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": [] } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[マネージド型ノードグループの更新](https://docs.aws.amazon.com/eks/latest/userguide/update-managed-node-group.html)」を参照してください。 **例 2: Amazon EKS マネージド型ノードグループの Kubernetes バージョンまたは AMI バージョンを更新する** 次の `update-nodegroup-version` の例では、Amazon EKS マネージド型ノードグループの Kubernetes バージョンまたは AMI バージョンを指定された AMI リリースバージョンに更新します。 ``` 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 ``` 出力: ``` { "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": [] } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「マネージド型ノードグループの更新 - 」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateNodegroupVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/update-nodegroup-version.html)」を参照してください。 ### `update-pod-identity-association` 次のコード例は、`update-pod-identity-association` を使用する方法を示しています。 **AWS CLI** **EKS Pod Identity の関連付けを更新するには** 次の `update-pod-identity-association` の例では、関連付け ID `a-9njjin9gfghecgocd` の関連付けられた IAM ロールを `arn:aws:iam::111122223333:role/my-role` から `arn:aws:iam::111122223333:role/s3-role` に変更することで、EKS Pod Identity の関連付けを更新します。この API は、関連付けられた IAM ロールの更新のみを許可します。 ``` aws eks update-pod-identity-association \ --cluster-name eks-customer \ --association-id a-9njjin9gfghecgocd \ --role-arn arn:aws:iam::111122223333:role/s3-role ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon EKS ユーザーガイド*」の「[EKS Pod Identity がポッドに AWS サービスへのアクセス権を付与する仕組みを学ぶ](https://docs.aws.amazon.com/eks/latest/userguide/pod-identities.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdatePodIdentityAssociation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/eks/update-pod-identity-association.html)」を参照してください。 # AWS CLI を使用した Elastic Beanstalk の例 次のコード例は、Elastic Beanstalk で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `abort-environment-update` 次のコード例は、`abort-environment-update` を使用する方法を示しています。 **AWS CLI** **デプロイを中止するには** 次のコマンドは、`my-env` という名前の環境に対して実行中のアプリケーションバージョンデプロイを中止します。 ``` aws elasticbeanstalk abort-environment-update --environment-name my-env ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AbortEnvironmentUpdate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/abort-environment-update.html)」を参照してください。 ### `check-dns-availability` 次のコード例は、`check-dns-availability` を使用する方法を示しています。 **AWS CLI** **CNAME を可用性を確認するには** 次のコマンドは、サブドメイン `my-cname.elasticbeanstalk.com` の可用性をチェックします。 ``` aws elasticbeanstalk check-dns-availability --cname-prefix my-cname ``` 出力: ``` { "Available": true, "FullyQualifiedCNAME": "my-cname.elasticbeanstalk.com" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CheckDnsAvailability](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/check-dns-availability.html)」を参照してください。 ### `create-application-version` 次のコード例は、`create-application-version` を使用する方法を示しています。 **AWS CLI** **新しいアプリケーションバージョンを作成するには** 次のコマンドは、「MyApp」という名前のアプリケーションの新しいバージョン「v1」を作成します。 ``` 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 ``` auto-create-application オプションにより、アプリケーションがまだ存在しない場合は自動的に作成されます。ソースバンドルは、「amzn-s3-demo-bucket」という名前の s3 バケットに保存されている .war ファイルであり、Apache Tomcat サンプルアプリケーションが含まれています。 出力: ``` { "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" } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateApplicationVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/create-application-version.html)」を参照してください。 ### `create-application` 次のコード例は、`create-application` を使用する方法を示しています。 **AWS CLI** **新しいアプリケーションを作成するには** 次のコマンドは、「MyApp」という名前の新しいアプリケーションを作成します。 ``` aws elasticbeanstalk create-application --application-name MyApp --description "my application" ``` `create-application` コマンドは、アプリケーションの名前と説明のみを設定します。アプリケーションのソースコードをアップロードするには、`create-application-version` を使用してアプリケーションの初期バージョンを作成します。`create-application-version` には、アプリケーションとアプリケーションバージョンを 1 ステップで作成できる `auto-create-application` オプションもあります。 出力: ``` { "Application": { "ApplicationName": "MyApp", "ConfigurationTemplates": [], "DateUpdated": "2015-02-12T18:32:21.181Z", "Description": "my application", "DateCreated": "2015-02-12T18:32:21.181Z" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/create-application.html)」を参照してください。 ### `create-configuration-template` 次のコード例は、`create-configuration-template` を使用する方法を示しています。 **AWS CLI** **設定テンプレートを作成するには** 次のコマンドは、ID が `e-rpqsewtp2j` の環境に適用される設定から `my-app-v1` という名前の設定テンプレートを作成します。 ``` aws elasticbeanstalk create-configuration-template --application-name my-app --template-name my-app-v1 --environment-id e-rpqsewtp2j ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateConfigurationTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/create-configuration-template.html)」を参照してください。 ### `create-environment` 次のコード例は、`create-environment` を使用する方法を示しています。 **AWS CLI** **アプリケーション用の新しい環境を作成するには** 次のコマンドは、「my-app」という名前の Java アプリケーションのバージョン「v1」用の新しい環境を作成します。 ``` 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" ``` 出力: ``` { "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` は、以前に create-application-version でアップロードされたアプリケーションバージョンのラベルです。 **環境設定オプションを定義する JSON ファイルを指定するには** 次の `create-environment` コマンドは、`myoptions.json` という名前の JSON ファイルを使用して、ソリューションスタックまたは設定テンプレートから取得した値を上書きするように指定します。 ``` aws elasticbeanstalk create-environment --environment-name sample-env --application-name sampleapp --option-settings file://myoptions.json ``` `myoptions.json` は、いくつかの設定を定義する JSON オブジェクトです。 ``` [ { "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" } ] ``` 詳細については、「*AWS Elastic Beanstalk デベロッパーガイド*」の「オプション値」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/create-environment.html)」を参照してください。 ### `create-storage-location` 次のコード例は、`create-storage-location` を使用する方法を示しています。 **AWS CLI** **ストレージの場所を作成するには** 次のコマンドは、Amazon S3 のストレージロケーションを作成します。 ``` aws elasticbeanstalk create-storage-location ``` 出力: ``` { "S3Bucket": "elasticbeanstalk-us-west-2-0123456789012" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateStorageLocation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/create-storage-location.html)」を参照してください。 ### `delete-application-version` 次のコード例は、`delete-application-version` を使用する方法を示しています。 **AWS CLI** **アプリケーションバージョンを削除するには** 次のコマンドは、`my-app` という名前のアプリケーションで `22a0-stage-150819_182129` という名前のアプリケーションバージョンを削除します。 ``` aws elasticbeanstalk delete-application-version --version-label 22a0-stage-150819_182129 --application-name my-app ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteApplicationVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/delete-application-version.html)」を参照してください。 ### `delete-application` 次のコード例は、`delete-application` を使用する方法を示しています。 **AWS CLI** **アプリケーションを削除するには** 次のコマンドは、`my-app` という名前のアプリケーションが削除します。 ``` aws elasticbeanstalk delete-application --application-name my-app ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/delete-application.html)」を参照してください。 ### `delete-configuration-template` 次のコード例は、`delete-configuration-template` を使用する方法を示しています。 **AWS CLI** **設定テンプレートを削除するには** 次のコマンドは、`my-app` という名前のアプリケーションの `my-template` という名前の設定テンプレートを削除します。 ``` aws elasticbeanstalk delete-configuration-template --template-name my-template --application-name my-app ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteConfigurationTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/delete-configuration-template.html)」を参照してください。 ### `delete-environment-configuration` 次のコード例は、`delete-environment-configuration` を使用する方法を示しています。 **AWS CLI** **ドラフト設定を削除するには** 次のコマンドは、`my-env` という名前の環境のドラフト設定を削除します。 ``` aws elasticbeanstalk delete-environment-configuration --environment-name my-env --application-name my-app ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteEnvironmentConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/delete-environment-configuration.html)」を参照してください。 ### `describe-application-versions` 次のコード例は、`describe-application-versions` を使用する方法を示しています。 **AWS CLI** **アプリケーションバージョンの情報を表示するには** 次のコマンドは、`v2` というラベルのアプリケーションバージョンに関する情報を取得します。 ``` aws elasticbeanstalk describe-application-versions --application-name my-app --version-label "v2" ``` 出力: ``` { "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" } } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeApplicationVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/describe-application-versions.html)」を参照してください。 ### `describe-applications` 次のコード例は、`describe-applications` を使用する方法を示しています。 **AWS CLI** **アプリケーションのリストを表示するには** 次のコマンドは、現在のリージョンのアプリケーションに関する情報を取得します。 ``` aws elasticbeanstalk describe-applications ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeApplications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/describe-applications.html)」を参照してください。 ### `describe-configuration-options` 次のコード例は、`describe-configuration-options` を使用する方法を示しています。 **AWS CLI** **環境の設定オプションを表示するには** 次のコマンドは、`my-env` という名前の環境で使用できるすべての設定オプションの記述を取得します。 ``` aws elasticbeanstalk describe-configuration-options --environment-name my-env --application-name my-app ``` 出力 (省略): ``` { "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" } ] } ``` 使用可能な設定オプションは、プラットフォームと設定バージョンによって異なります。名前空間とサポートされているオプションの詳細については、「*AWS Elastic Beanstalk デベロッパーガイド*」の「Option Values」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeConfigurationOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/describe-configuration-options.html)」を参照してください。 ### `describe-configuration-settings` 次のコード例は、`describe-configuration-settings` を使用する方法を示しています。 **AWS CLI** **環境の設定を表示するには** 次のコマンドは、`my-env` という名前の環境の設定を取得します。 ``` aws elasticbeanstalk describe-configuration-settings --environment-name my-env --application-name my-app ``` 出力 (省略): ``` { "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" } ] } ``` 名前空間とサポートされているオプションの詳細については、「*AWS Elastic Beanstalk デベロッパーガイド*」の「Option Values」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeConfigurationSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/describe-configuration-settings.html)」を参照してください。 ### `describe-environment-health` 次のコード例は、`describe-environment-health` を使用する方法を示しています。 **AWS CLI** **環境ヘルスを表示するには** 次のコマンドは、`my-env` という名前の全体的な環境ヘルス情報を取得します。 ``` aws elasticbeanstalk describe-environment-health --environment-name my-env --attribute-names All ``` 出力: ``` { "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": [] } ``` ヘルス情報は、拡張ヘルスレポートが有効になっている環境でのみ使用できます。詳細については、「*AWS Elastic Beanstalk デベロッパーガイド*」の「拡張ヘルスレポートおよびモニタリング」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEnvironmentHealth](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/describe-environment-health.html)」を参照してください。 ### `describe-environment-resources` 次のコード例は、`describe-environment-resources` を使用する方法を示しています。 **AWS CLI** **環境内の AWS リソースに関する情報を表示するには** 次のコマンドは、`my-env` という名前の環境内のリソースに関する情報を取得します。 ``` aws elasticbeanstalk describe-environment-resources --environment-name my-env ``` 出力: ``` { "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" } ] } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEnvironmentResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/describe-environment-resources.html)」を参照してください。 ### `describe-environments` 次のコード例は、`describe-environments` を使用する方法を示しています。 **AWS CLI** **環境に関する情報を表示するには** 次のコマンドは、`my-env` という名前の環境に関する情報を取得します。 ``` aws elasticbeanstalk describe-environments --environment-names my-env ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEnvironments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/describe-environments.html)」を参照してください。 ### `describe-events` 次のコード例は、`describe-events` を使用する方法を示しています。 **AWS CLI** **環境のイベントを表示するには** 次のコマンドは、`my-env` という名前の環境のイベントを取得します。 ``` aws elasticbeanstalk describe-events --environment-name my-env ``` 出力 (省略): ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/describe-events.html)」を参照してください。 ### `describe-instances-health` 次のコード例は、`describe-instances-health` を使用する方法を示しています。 **AWS CLI** **環境ヘルスを表示するには** 次のコマンドでは、`my-env` という名前の環境内のインスタンスのヘルス情報を取得できるようにします。 ``` aws elasticbeanstalk describe-instances-health --environment-name my-env --attribute-names All ``` 出力: ``` { "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" } ``` ヘルス情報は、拡張ヘルスレポートが有効になっている環境でのみ使用できます。詳細については、「*AWS Elastic Beanstalk デベロッパーガイド*」の「拡張ヘルスレポートおよびモニタリング」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeInstancesHealth](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/describe-instances-health.html)」を参照してください。 ### `list-available-solution-stacks` 次のコード例は、`list-available-solution-stacks` を使用する方法を示しています。 **AWS CLI** **ソリューションスタックを表示するには** 次のコマンドは、現在利用可能なすべてのプラットフォーム設定と、過去に使用したことがあるすべてのソリューションスタックを一覧表示します。 ``` aws elasticbeanstalk list-available-solution-stacks ``` 出力 (省略): ``` { "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" }, ... ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAvailableSolutionStacks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/list-available-solution-stacks.html)」を参照してください。 ### `rebuild-environment` 次のコード例は、`rebuild-environment` を使用する方法を示しています。 **AWS CLI** **環境のを再構築するには** 次のコマンドは、`my-env` という名前の環境でリソースを終了して再作成します。 ``` aws elasticbeanstalk rebuild-environment --environment-name my-env ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RebuildEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/rebuild-environment.html)」を参照してください。 ### `request-environment-info` 次のコード例は、`request-environment-info` を使用する方法を示しています。 **AWS CLI** **追跡ログをリクエストするには** 次のコマンドは、`my-env` という名前の環境からログをリクエストします。 ``` aws elasticbeanstalk request-environment-info --environment-name my-env --info-type tail ``` ログをリクエストしたら、retrieve-environment-info を使用してその場所を取得します。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RequestEnvironmentInfo](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/request-environment-info.html)」を参照してください。 ### `restart-app-server` 次のコード例は、`restart-app-server` を使用する方法を示しています。 **AWS CLI** **アプリケーションサーバーを再起動するには** 次のコマンドは、`my-env` という環境内のすべてのインスタンスでアプリケーションサーバーを再起動します。 ``` aws elasticbeanstalk restart-app-server --environment-name my-env ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RestartAppServer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/restart-app-server.html)」を参照してください。 ### `retrieve-environment-info` 次のコード例は、`retrieve-environment-info` を使用する方法を示しています。 **AWS CLI** **追跡ログを取得するには** 次のコマンドは、`my-env` という名前の環境からログへのリンクを取得します。 ``` aws elasticbeanstalk retrieve-environment-info --environment-name my-env --info-type tail ``` 出力: ``` { "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" } ] } ``` ブラウザでリンクを表示します。取得前に、request-environment-info を使用してログをリクエストする必要があります。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RetrieveEnvironmentInfo](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/retrieve-environment-info.html)」を参照してください。 ### `swap-environment-cnames` 次のコード例は、`swap-environment-cnames` を使用する方法を示しています。 **AWS CLI** **環境の CNAME を交換するには** 次のコマンドは、2 つの環境に割り当てられたサブドメインをスワップします。 ``` aws elasticbeanstalk swap-environment-cnames --source-environment-name my-env-blue --destination-environment-name my-env-green ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SwapEnvironmentCnames](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/swap-environment-cnames.html)」を参照してください。 ### `terminate-environment` 次のコード例は、`terminate-environment` を使用する方法を示しています。 **AWS CLI** 環境を終了するには 次のコマンドは、`my-env` という名前の Elastic Beanstalk 環境を終了します。 ``` aws elasticbeanstalk terminate-environment --environment-name my-env ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TerminateEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/terminate-environment.html)」を参照してください。 ### `update-application-version` 次のコード例は、`update-application-version` を使用する方法を示しています。 **AWS CLI** **アプリケーションバージョンの説明を変更するには** 次のコマンドは、`22a0-stage-150819_185942` という名前のアプリケーションバージョンの記述を更新します。 ``` aws elasticbeanstalk update-application-version --version-label 22a0-stage-150819_185942 --application-name my-app --description "new description" ``` 出力: ``` { "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" } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateApplicationVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/update-application-version.html)」を参照してください。 ### `update-application` 次のコード例は、`update-application` を使用する方法を示しています。 **AWS CLI** **アプリケーションの説明を変更するには** 次のコマンドは、`my-app` という名前のアプリケーションの記述を更新します。 ``` aws elasticbeanstalk update-application --application-name my-app --description "my Elastic Beanstalk application" ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateApplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/update-application.html)」を参照してください。 ### `update-configuration-template` 次のコード例は、`update-configuration-template` を使用する方法を示しています。 **AWS CLI** **設定テンプレートを更新するには** 次のコマンドは、`my-template` という名前の保存済み設定テンプレートから、設定済みの CloudWatch カスタムヘルスメトリクス設定 `ConfigDocument` を削除します。 ``` aws elasticbeanstalk update-configuration-template --template-name my-template --application-name my-app --options-to-remove Namespace=aws:elasticbeanstalk:healthreporting:system,OptionName=ConfigDocument ``` 出力: ``` { "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" } ``` 名前空間とサポートされているオプションの詳細については、「*AWS Elastic Beanstalk デベロッパーガイド*」の「Option Values」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateConfigurationTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/update-configuration-template.html)」を参照してください。 ### `update-environment` 次のコード例は、`update-environment` を使用する方法を示しています。 **AWS CLI** **環境を新しいバージョンに更新するには** 次のコマンドは、「my-env」という名前の環境を、それが属するアプリケーションのバージョン「v2」に更新します。 ``` aws elasticbeanstalk update-environment --environment-name my-env --version-label v2 ``` このコマンドでは、「my-env」環境が既に存在し、「v2」というラベルが付いた有効なアプリケーションバージョンを持つアプリケーションに属している必要があります。 出力: ``` { "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" } ``` **環境変数を設定するには** 次のコマンドは、「my-env」環境の「PARAM1」変数の値を「ParamValue」に設定します。 ``` aws elasticbeanstalk update-environment --environment-name my-env --option-settings Namespace=aws:elasticbeanstalk:application:environment,OptionName=PARAM1,Value=ParamValue ``` `option-settings` パラメータは、変数の名前と値に加えて名前空間を取得します。Elastic Beanstalk は、環境変数に加えて、オプション用のいくつかの名前空間をサポートしています。 **ファイルからオプション設定を設定するには** 次のコマンドは、ファイルから `aws:elb:loadbalancer` 名前空間内のいくつかのオプションを設定します。 ``` aws elasticbeanstalk update-environment --environment-name my-env --option-settings file://options.json ``` `options.json` は、いくつかの設定を定義する JSON オブジェクトです。 ``` [ { "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" } ] ``` 出力: ``` { "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" } ``` 名前空間とサポートされているオプションの詳細については、「*AWS Elastic Beanstalk デベロッパーガイド*」の「Option Values」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateEnvironment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/update-environment.html)」を参照してください。 ### `validate-configuration-settings` 次のコード例は、`validate-configuration-settings` を使用する方法を示しています。 **AWS CLI** **設定を検証するには** 次のコマンドは、CloudWatch カスタムメトリクス設定ドキュメントを検証します。 ``` aws elasticbeanstalk validate-configuration-settings --application-name my-app --environment-name my-env --option-settings file://options.json ``` `options.json` は、検証する 1 つ以上の設定を含む JSON ドキュメントです。 ``` [ { "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}" } ] ``` 指定したオプションが指定された環境に対して有効な場合、Elastic Beanstalk は空の Messages 配列を返します。 ``` { "Messages": [] } ``` 検証に失敗すると、レスポンスにはエラーに関する情報が含まれます。 ``` { "Messages": [ { "OptionName": "ConfigDocumet", "Message": "Invalid option specification (Namespace: 'aws:elasticbeanstalk:healthreporting:system', OptionName: 'ConfigDocumet'): Unknown configuration setting.", "Namespace": "aws:elasticbeanstalk:healthreporting:system", "Severity": "error" } ] } ``` 名前空間とサポートされているオプションの詳細については、「*AWS Elastic Beanstalk デベロッパーガイド*」の「Option Values」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ValidateConfigurationSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticbeanstalk/validate-configuration-settings.html)」を参照してください。 # Elastic Load Balancing - AWS CLI を使用したバージョン 1 の例 次のコード例は、Elastic Load Balancing - バージョン 1 で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `add-tags` 次のコード例は、`add-tags` を使用する方法を示しています。 **AWS CLI** **ロードバランサーにタグを追加するには** この例は、指定されたロードバランサーにタグを追加します。 コマンド: ``` aws elb add-tags --load-balancer-name my-load-balancer --tags "Key=project,Value=lima" "Key=department,Value=digital-media" ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/add-tags.html)」を参照してください。 ### `apply-security-groups-to-load-balancer` 次のコード例は、`apply-security-groups-to-load-balancer` を使用する方法を示しています。 **AWS CLI** **セキュリティグループを VPC 内のロードバランサーに関連付けるには** この例では、VPC 内の指定されたロードバランサーにセキュリティグループを関連付けます。 コマンド: ``` aws elb apply-security-groups-to-load-balancer --load-balancer-name my-load-balancer --security-groups sg-fc448899 ``` 出力: ``` { "SecurityGroups": [ "sg-fc448899" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ApplySecurityGroupsToLoadBalancer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/apply-security-groups-to-load-balancer.html)」を参照してください。 ### `attach-load-balancer-to-subnets` 次のコード例は、`attach-load-balancer-to-subnets` を使用する方法を示しています。 **AWS CLI** **サブネットをロードバランサーにアタッチするには** この例では、指定されたロードバランサーの一連の設定済みサブネットのセットに指定されたサブネットを追加します。 コマンド: ``` aws elb attach-load-balancer-to-subnets --load-balancer-name my-load-balancer --subnets subnet-0ecac448 ``` 出力: ``` { "Subnets": [ "subnet-15aaab61", "subnet-0ecac448" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AttachLoadBalancerToSubnets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/attach-load-balancer-to-subnets.html)」を参照してください。 ### `configure-health-check` 次のコード例は、`configure-health-check` を使用する方法を示しています。 **AWS CLI** **バックエンド EC2 インスタンスのヘルスチェック設定を指定するには** この例では、バックエンド EC2 インスタンスのヘルスを評価するために使用されるヘルスチェック設定を指定します。 コマンド: ``` 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 ``` 出力: ``` { "HealthCheck": { "HealthyThreshold": 2, "Interval": 30, "Target": "HTTP:80/png", "Timeout": 3, "UnhealthyThreshold": 2 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ConfigureHealthCheck](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/configure-health-check.html)」を参照してください。 ### `create-app-cookie-stickiness-policy` 次のコード例は、`create-app-cookie-stickiness-policy` を使用する方法を示しています。 **AWS CLI** **HTTPS ロードバランサーのスティッキーポリシーを生成するには** 次の例では、アプリケーションによって生成された Cookie のスティッキーセッション存続期間に従う維持ポリシーを生成します。 コマンド: ``` aws elb create-app-cookie-stickiness-policy --load-balancer-name my-load-balancer --policy-name my-app-cookie-policy --cookie-name my-app-cookie ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateAppCookieStickinessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/create-app-cookie-stickiness-policy.html)」を参照してください。 ### `create-lb-cookie-stickiness-policy` 次のコード例は、`create-lb-cookie-stickiness-policy` を使用する方法を示しています。 **AWS CLI** **HTTPS ロードバランサーの期間ベースの維持ポリシーを生成するには** この例では、指定された有効期限によって制御されたスティッキーセッションの存続期間を持つスティッキーポリシーを生成します。 コマンド: ``` aws elb create-lb-cookie-stickiness-policy --load-balancer-name my-load-balancer --policy-name my-duration-cookie-policy --cookie-expiration-period 60 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateLbCookieStickinessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/create-lb-cookie-stickiness-policy.html)」を参照してください。 ### `create-load-balancer-listeners` 次のコード例は、`create-load-balancer-listeners` を使用する方法を示しています。 **AWS CLI** **ロードバランサーの HTTP リスナーを作成するには** この例では、HTTP プロトコルを使用してポート 80 でロードバランサーのリスナーを作成します。 コマンド: ``` aws elb create-load-balancer-listeners --load-balancer-name my-load-balancer --listeners "Protocol=HTTP,LoadBalancerPort=80,InstanceProtocol=HTTP,InstancePort=80" ``` **ロードバランサーの HTTPS リスナーを作成するには** この例では、HTTP プロトコルを使用してポート 443 でロードバランサーのリスナーを作成します。 コマンド: ``` aws elb create-load-balancer-listeners --load-balancer-name my-load-balancer --listeners "Protocol=HTTPS,LoadBalancerPort=443,InstanceProtocol=HTTP,InstancePort=80" ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateLoadBalancerListeners](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/create-load-balancer-listeners.html)」を参照してください。 ### `create-load-balancer-policy` 次のコード例は、`create-load-balancer-policy` を使用する方法を示しています。 **AWS CLI** **ロードバランサーで Proxy Protocol を有効にするポリシーを作成するには** この例では、指定されたロードバランサーでプロキシプロトコルを有効にするポリシーを作成します。 コマンド: ``` 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 ``` **推奨されるセキュリティポリシーを使用して SSL ネゴシエーションポリシーを作成するには** この例では、推奨されるセキュリティポリシーを使用して、指定された HTTPS ロードバランサーの SSL ネゴシエーションポリシーを作成します。 コマンド: ``` 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 ``` **カスタムセキュリティポリシーを使用して SSL ネゴシエーションポリシーを作成するには** この例では、プロトコルと暗号を有効にして、カスタムセキュリティポリシーを使用して HTTPS ロードバランサーの SSL ネゴシエーションポリシーを作成します。 コマンド: ``` 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 ``` **パブリックキーポリシーを作成するには** この例では、パブリックキーポリシーを作成します。 コマンド: ``` 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 ``` **バックエンドサーバー認証ポリシーを作成するには** この例では、パブリックキーポリシーを使用してバックエンドインスタンスで認証を有効にするバックエンドサーバー認証ポリシーを作成します。 コマンド: ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateLoadBalancerPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/create-load-balancer-policy.html)」を参照してください。 ### `create-load-balancer` 次のコード例は、`create-load-balancer` を使用する方法を示しています。 **AWS CLI** **HTTP ロードバランサーを作成するには** この例では、VPC に HTTP リスナーを持つロードバランサーを作成します。 コマンド: ``` 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 ``` 出力: ``` { "DNSName": "my-load-balancer-1234567890.us-west-2.elb.amazonaws.com" } ``` この例では、EC2-Classic に HTTP リスナーを持つロードバランサーを作成します。 コマンド: ``` 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 ``` 出力: ``` { "DNSName": "my-load-balancer-123456789.us-west-2.elb.amazonaws.com" } ``` **HTTPS ロードバランサーを作成するには** この例では、VPC に HTTPS リスナーを持つロードバランサーを作成します。 コマンド: ``` 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 ``` 出力: ``` { "DNSName": "my-load-balancer-1234567890.us-west-2.elb.amazonaws.com" } ``` この例では、EC2-Classic に HTTPS リスナーを使用してロードバランサーを作成します。 コマンド: ``` 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 ``` 出力: ``` { "DNSName": "my-load-balancer-123456789.us-west-2.elb.amazonaws.com" } ``` **内部向けロードバランサーを作成するには** この例では、VPC に HTTP リスナーを持つ内部ロードバランサーを作成します。 コマンド: ``` 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 ``` 出力: ``` { "DNSName": "internal-my-load-balancer-123456789.us-west-2.elb.amazonaws.com" } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[CreateLoadBalancer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/create-load-balancer.html)」を参照してください。** ### `delete-load-balancer-listeners` 次のコード例は、`delete-load-balancer-listeners` を使用する方法を示しています。 **AWS CLI** **ロードバランサーからリスナーを削除するには** この例では、指定されたロードバランサーから指定されたポートのリスナーを削除します。 コマンド: ``` aws elb delete-load-balancer-listeners --load-balancer-name my-load-balancer --load-balancer-ports 80 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteLoadBalancerListeners](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/delete-load-balancer-listeners.html)」を参照してください。 ### `delete-load-balancer-policy` 次のコード例は、`delete-load-balancer-policy` を使用する方法を示しています。 **AWS CLI** **ロードバランサーからポリシーを削除するには** この例では、指定されたロードバランサーから指定されたポリシーを削除します。このポリシーでは、どのリスナーでも有効にできません。 コマンド: ``` aws elb delete-load-balancer-policy --load-balancer-name my-load-balancer --policy-name my-duration-cookie-policy ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteLoadBalancerPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/delete-load-balancer-policy.html)」を参照してください。 ### `delete-load-balancer` 次のコード例は、`delete-load-balancer` を使用する方法を示しています。 **AWS CLI** **ロードバランサーを削除するには** この例は、指定されたロードバランサーを削除します。 コマンド: ``` aws elb delete-load-balancer --load-balancer-name my-load-balancer ``` + API の詳細については、AWS CLI コマンドリファレンスの「[DeleteLoadBalancer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/delete-load-balancer.html)」を参照してください。** ### `deregister-instances-from-load-balancer` 次のコード例は、`deregister-instances-from-load-balancer` を使用する方法を示しています。 **AWS CLI** **ロードバランサーからインスタンスの登録を解除するには** この例では、指定されたロードバランサーから指定されたインスタンスを登録解除します。 コマンド: ``` aws elb deregister-instances-from-load-balancer --load-balancer-name my-load-balancer --instances i-d6f6fae3 ``` 出力: ``` { "Instances": [ { "InstanceId": "i-207d9717" }, { "InstanceId": "i-afefb49b" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeregisterInstancesFromLoadBalancer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/deregister-instances-from-load-balancer.html)」を参照してください。 ### `describe-account-limits` 次のコード例は、`describe-account-limits` を使用する方法を示しています。 **AWS CLI** **Classic Load Balancer の制限を記述するには** 次の `describe-account-limits` の例では、AWS アカウントの Classic Load Balancer の制限に関する詳細を表示します。 ``` aws elb describe-account-limits ``` 出力: ``` { "Limits": [ { "Name": "classic-load-balancers", "Max": "20" }, { "Name": "classic-listeners", "Max": "100" }, { "Name": "classic-registered-instances", "Max": "1000" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAccountLimits](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/describe-account-limits.html)」を参照してください。 ### `describe-instance-health` 次のコード例は、`describe-instance-health` を使用する方法を示しています。 **AWS CLI** **ロードバランサーのインスタンスのヘルスを記述するには** この例では、指定されたロードバランサーのインスタンスのヘルスを記述します。 コマンド: ``` aws elb describe-instance-health --load-balancer-name my-load-balancer ``` 出力: ``` { "InstanceStates": [ { "InstanceId": "i-207d9717", "ReasonCode": "N/A", "State": "InService", "Description": "N/A" }, { "InstanceId": "i-afefb49b", "ReasonCode": "N/A", "State": "InService", "Description": "N/A" } ] } ``` **ロードバランサーのインスタンスのヘルスを記述するには** この例では、指定されたロードバランサーの指定されたインスタンスのヘルスを記述します。 コマンド: ``` aws elb describe-instance-health --load-balancer-name my-load-balancer --instances i-7299c809 ``` 次は、登録しているインスタンスのレスポンスの例を次に示します。 出力: ``` { "InstanceStates": [ { "InstanceId": "i-7299c809", "ReasonCode": "ELB", "State": "OutOfService", "Description": "Instance registration is still in progress." } ] } ``` 次は、異常なインスタンスのレスポンスの例です。 出力: ``` { "InstanceStates": [ { "InstanceId": "i-7299c809", "ReasonCode": "Instance", "State": "OutOfService", "Description": "Instance has failed at least the UnhealthyThreshold number of health checks consecutively." } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeInstanceHealth](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/describe-instance-health.html)」を参照してください。 ### `describe-load-balancer-attributes` 次のコード例は、`describe-load-balancer-attributes` を使用する方法を示しています。 **AWS CLI** **ロードバランサーの属性を記述するには** この例では、指定されたロードバランサーの属性を記述します。 コマンド: ``` aws elb describe-load-balancer-attributes --load-balancer-name my-load-balancer ``` 出力: ``` { "LoadBalancerAttributes": { "ConnectionDraining": { "Enabled": false, "Timeout": 300 }, "CrossZoneLoadBalancing": { "Enabled": true }, "ConnectionSettings": { "IdleTimeout": 30 }, "AccessLog": { "Enabled": false } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeLoadBalancerAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/describe-load-balancer-attributes.html)」を参照してください。 ### `describe-load-balancer-policies` 次のコード例は、`describe-load-balancer-policies` を使用する方法を示しています。 **AWS CLI** **ロードバランサーに関連付けられたすべてのポリシーを記述するには** この例では、指定されたロードバランサーに関連付けられたすべてのポリシーを記述します。 コマンド: ``` aws elb describe-load-balancer-policies --load-balancer-name my-load-balancer ``` 出力: ``` { "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" }, . . . ] } ``` **ロードバランサーに関連付けられた特定のポリシーを記述するには** この例では、指定されたロードバランサーに関連付けられた指定されたポリシーを記述します。 コマンド: ``` aws elb describe-load-balancer-policies --load-balancer-name my-load-balancer --policy-name my-authentication-policy ``` 出力: ``` { "PolicyDescriptions": [ { "PolicyAttributeDescriptions": [ { "AttributeName": "PublicKeyPolicyName", "AttributeValue": "my-PublicKey-policy" } ], "PolicyName": "my-authentication-policy", "PolicyTypeName": "BackendServerAuthenticationPolicyType" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeLoadBalancerPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/describe-load-balancer-policies.html)」を参照してください。 ### `describe-load-balancer-policy-types` 次のコード例は、`describe-load-balancer-policy-types` を使用する方法を示しています。 **AWS CLI** **Elastic Load Balancing で定義されるロードバランサーポリシータイプを記述するには** この例では、ロードバランサーのポリシー設定を作成するために使用できるロードバランサーのポリシータイプを記述します。 コマンド: ``` aws elb describe-load-balancer-policy-types ``` 出力: ``` { "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." } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeLoadBalancerPolicyTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/describe-load-balancer-policy-types.html)」を参照してください。 ### `describe-load-balancers` 次のコード例は、`describe-load-balancers` を使用する方法を示しています。 **AWS CLI** **ロードバランサーを記述するには** この例は、すべてのロードバランサーを記述します。 コマンド: ``` aws elb describe-load-balancers ``` **ロードバランサーの 1 つを記述するには** この例は、指定されたロードバランサーを記述します。 コマンド: ``` aws elb describe-load-balancers --load-balancer-name my-load-balancer ``` 次の応答例は、VPC 内に HTTPS ロードバランサー用です。 出力: ``` { "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" } } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeLoadBalancers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/describe-load-balancers.html)」を参照してください。 ### `describe-tags` 次のコード例は、`describe-tags` を使用する方法を示しています。 **AWS CLI** **ロードバランサーに割り当てられたタグを記述するには** この例では、指定されたロードバランサーに割り当てられたタグを記述します。 コマンド: ``` aws elb describe-tags --load-balancer-name my-load-balancer ``` 出力: ``` { "TagDescriptions": [ { "Tags": [ { "Value": "lima", "Key": "project" }, { "Value": "digital-media", "Key": "department" } ], "LoadBalancerName": "my-load-balancer" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/describe-tags.html)」を参照してください。 ### `detach-load-balancer-from-subnets` 次のコード例は、`detach-load-balancer-from-subnets` を使用する方法を示しています。 **AWS CLI** **サブネットからロードバランサーをデタッチするには** この例では、指定されたロードバランサーを指定されたサブネットからデタッチします。 コマンド: ``` aws elb detach-load-balancer-from-subnets --load-balancer-name my-load-balancer --subnets subnet-0ecac448 ``` 出力: ``` { "Subnets": [ "subnet-15aaab61" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DetachLoadBalancerFromSubnets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/detach-load-balancer-from-subnets.html)」を参照してください。 ### `disable-availability-zones-for-load-balancer` 次のコード例は、`disable-availability-zones-for-load-balancer` を使用する方法を示しています。 **AWS CLI** **ロードバランサーのアベイラビリティーゾーンを無効にするには** この例では、指定されたアベイラビリティーゾーンを、指定されたロードバランサーの一連のアベイラビリティーゾーンから削除します。 コマンド: ``` aws elb disable-availability-zones-for-load-balancer --load-balancer-name my-load-balancer --availability-zones us-west-2a ``` 出力: ``` { "AvailabilityZones": [ "us-west-2b" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisableAvailabilityZonesForLoadBalancer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/disable-availability-zones-for-load-balancer.html)」を参照してください。 ### `enable-availability-zones-for-load-balancer` 次のコード例は、`enable-availability-zones-for-load-balancer` を使用する方法を示しています。 **AWS CLI** **ロードバランサーのアベイラビリティーゾーンを有効にするには** この例では、指定されたアベイラビリティーゾーンを指定されたロードバランサーに追加します。 コマンド: ``` aws elb enable-availability-zones-for-load-balancer --load-balancer-name my-load-balancer --availability-zones us-west-2b ``` 出力: ``` { "AvailabilityZones": [ "us-west-2a", "us-west-2b" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EnableAvailabilityZonesForLoadBalancer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/enable-availability-zones-for-load-balancer.html)」を参照してください。 ### `modify-load-balancer-attributes` 次のコード例は、`modify-load-balancer-attributes` を使用する方法を示しています。 **AWS CLI** **ロードバランサーの属性を変更するには** 次の例は、指定されたロードバランサーの `CrossZoneLoadBalancing` 属性を変更します。 コマンド: ``` aws elb modify-load-balancer-attributes --load-balancer-name my-load-balancer --load-balancer-attributes "{\"CrossZoneLoadBalancing\":{\"Enabled\":true}}" ``` 出力: ``` { "LoadBalancerAttributes": { "CrossZoneLoadBalancing": { "Enabled": true } }, "LoadBalancerName": "my-load-balancer" } ``` 次の例は、指定されたロードバランサーの `ConnectionDraining` 属性を変更します。 コマンド: ``` aws elb modify-load-balancer-attributes --load-balancer-name my-load-balancer --load-balancer-attributes "{\"ConnectionDraining\":{\"Enabled\":true,\"Timeout\":300}}" ``` 出力: ``` { "LoadBalancerAttributes": { "ConnectionDraining": { "Enabled": true, "Timeout": 300 } }, "LoadBalancerName": "my-load-balancer" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyLoadBalancerAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/modify-load-balancer-attributes.html)」を参照してください。 ### `register-instances-with-load-balancer` 次のコード例は、`register-instances-with-load-balancer` を使用する方法を示しています。 **AWS CLI** **ロードバランサーにインスタンスを登録するには** この例では、指定されたインスタンスを指定されたロードバランサーに登録します。 コマンド: ``` aws elb register-instances-with-load-balancer --load-balancer-name my-load-balancer --instances i-d6f6fae3 ``` 出力: ``` { "Instances": [ { "InstanceId": "i-d6f6fae3" }, { "InstanceId": "i-207d9717" }, { "InstanceId": "i-afefb49b" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegisterInstancesWithLoadBalancer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/register-instances-with-load-balancer.html)」を参照してください。 ### `remove-tags` 次のコード例は、`remove-tags` を使用する方法を示しています。 **AWS CLI** **ロードバランサーからタグを削除するには** この例では、指定されたロードバランサーからタグを削除します。 コマンド: ``` aws elb remove-tags --load-balancer-name my-load-balancer --tags project ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/remove-tags.html)」を参照してください。 ### `set-load-balancer-listener-ssl-certificate` 次のコード例は、`set-load-balancer-listener-ssl-certificate` を使用する方法を示しています。 **AWS CLI** **HTTPS ロードバランサーの SSL 証明書を更新するには** この例では、指定された HTTPS ロードバランサーの既存の SSL 証明書を置き換えます。 コマンド: ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetLoadBalancerListenerSslCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/set-load-balancer-listener-ssl-certificate.html)」を参照してください。 ### `set-load-balancer-policies-for-backend-server` 次のコード例は、`set-load-balancer-policies-for-backend-server` を使用する方法を示しています。 **AWS CLI** **バックエンドインスタンスのポートに関連付けられたポリシーを置き換えるには** この例では、指定されたポートに現在関連付けられているポリシーを置き換えます。 コマンド: ``` aws elb set-load-balancer-policies-for-backend-server --load-balancer-name my-load-balancer --instance-port 80 --policy-names my-ProxyProtocol-policy ``` **バックエンドインスタンスのポートに現在関連付けられているすべてのポリシーを削除するには** この例では、指定されたポートに関連付けられているすべてのポリシーを削除します。 コマンド: ``` aws elb set-load-balancer-policies-for-backend-server --load-balancer-name my-load-balancer --instance-port 80 --policy-names [] ``` ポリシーが削除されていることを確認するには、`describe-load-balancer-policies` コマンドを使用します。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetLoadBalancerPoliciesForBackendServer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/set-load-balancer-policies-for-backend-server.html)」を参照してください。 ### `set-load-balancer-policies-of-listener` 次のコード例は、`set-load-balancer-policies-of-listener` を使用する方法を示しています。 **AWS CLI** **リスナーに関連付けられたポリシーを置き換えるには** この例では、指定されたリスナーに現在関連付けられているポリシーを置き換えます。 コマンド: ``` aws elb set-load-balancer-policies-of-listener --load-balancer-name my-load-balancer --load-balancer-port 443 --policy-names my-SSLNegotiation-policy ``` **リスナーに関連付けられているすべてのポリシーを削除するには** この例では、指定したリスナーに現在関連付けられているすべてのポリシーを削除します。 コマンド: ``` aws elb set-load-balancer-policies-of-listener --load-balancer-name my-load-balancer --load-balancer-port 443 --policy-names [] ``` ポリシーがロードバランサーから削除されていることを確認するには、`describe-load-balancer-policies` コマンドを使用します。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetLoadBalancerPoliciesOfListener](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elb/set-load-balancer-policies-of-listener.html)」を参照してください。 # Elastic Load Balancing - AWS CLI を使用したバージョン 2 の例 次のコード例は、Elastic Load Balancing - バージョン 2 で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `add-listener-certificates` 次のコード例は、`add-listener-certificates` を使用する方法を示しています。 **AWS CLI** **セキュアリスナーに証明書を追加するには** この例では、指定された証明書を指定されたセキュアリスナーに追加します。 コマンド: ``` 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 ``` 出力: ``` { "Certificates": [ { "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/5cc54884-f4a3-4072-80be-05b9ba72f705", "IsDefault": false } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddListenerCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/add-listener-certificates.html)」を参照してください。 ### `add-tags` 次のコード例は、`add-tags` を使用する方法を示しています。 **AWS CLI** **ロードバランサーにタグを追加するには** 次の `add-tags` の例では、指定されたロードバランサーに `project` と `department` タグを追加します。 ``` 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" ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/add-tags.html)」を参照してください。 ### `create-listener` 次のコード例は、`create-listener` を使用する方法を示しています。 **AWS CLI** **例 1: HTTP リスナーを作成するには** 次の `create-listener` の例は、指定されたターゲットグループにリクエストを転送する、指定された Application Load Balancer の HTTP リスナーを作成します。 ``` 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 ``` 詳細については、「Application Load Balancers のユーザーガイド」の「[チュートリアル: AWS CLI を使用した Application Load Balancer の作成](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/tutorial-application-load-balancer-cli.html#create-load-balancer-aws-cli)」を参照してください。** **例 2: HTTPS リスナーを作成するには** 次の `create-listener` の例は、指定されたターゲットグループにリクエストを転送する、指定された Application Load Balancer の HTTPS リスナーを作成します。HTTPS リスナーの SSL 証明書を指定する必要があります。AWS Certificate Manager (ACM) を使用して証明書を作成および管理できます。また、SSL/TLS ツールを使用して証明書を作成し、認証局 (CA) から署名を取得して、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 ``` 詳細については、「Application Load Balancers のユーザーガイド」の「[HTTPS リスナーの追加](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/tutorial-application-load-balancer-cli.html#https-listener-aws-cli)」を参照してください。** **例 3: TCP リスナーを作成するには** 次の `create-listener` の例は、指定されたターゲットグループにリクエストを転送する、指定された Network Load Balancer の TCP リスナーを作成します。 ``` 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 ``` 詳細については、「Network Load Balancers のユーザーガイド」の「[チュートリアル: AWS CLI を使用して Network Load Balancer を作成する](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancer-cli.html#create-load-balancer-aws-cli)」を参照してください。** **例 4: TLS リスナーを作成するには** 次の `create-listener` の例は、指定されたターゲットグループにリクエストを転送する、指定された Network Load Balancer の TLS リスナーを作成します。TLS リスナーの SSL 証明書を指定する必要があります。 ``` 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 ``` 詳細については、「Network Load Balancers のユーザーガイド」の「[Network Load Balancer の TLS リスナー](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html)」を参照してください。** **例 5: UDP リスナーを作成するには** 次の `create-listener` の例は、指定されたターゲットグループにリクエストを転送する、指定された Network Load Balancer の UDP リスナーを作成します。 ``` 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 ``` 詳細については、「Network Load Balancers のユーザーガイド」の「[チュートリアル: AWS CLI を使用して Network Load Balancer を作成する](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancer-cli.html#create-load-balancer-aws-cli)」を参照してください。** **例 6: 指定されたゲートウェイのリスナーを作成して転送するには** 次の `create-listener` の例は、指定されたターゲットグループにリクエストを転送する、指定された Gateway Load Balancer のリスナーを作成します。 ``` 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 ``` 出力: ``` { "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" } ] } } ] } ] } ``` 詳細については、「Gateway Load Balancers のユーザーガイド」の「[AWS CLI を使用した Gateway Load Balancer の開始方法](https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/getting-started-cli.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[CreateListener](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/create-listener.html)」を参照してください。** ### `create-load-balancer` 次のコード例は、`create-load-balancer` を使用する方法を示しています。 **AWS CLI** **例 1: インターネット向けロードバランサーを作成するには** 次の `create-load-balancer` の例は、インターネット向けの Application Load Balancer を作成し、指定されたサブネットのアベイラビリティーゾーンを有効化します。 ``` aws elbv2 create-load-balancer \ --name my-load-balancer \ --subnets subnet-b7d581c0 subnet-8360a9e7 ``` 出力: ``` { "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" } ] } ``` 詳細については、「Application Load Balancers のユーザーガイド」の「[チュートリアル: AWS CLI を使用した Application Load Balancer の作成](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/tutorial-application-load-balancer-cli.html)」を参照してください。** **例 2: 内部向けロードバランサーを作成するには** 次の `create-load-balancer` の例は、内部向けの Application Load Balancer を作成し、指定されたサブネットのアベイラビリティーゾーンを有効化します。 ``` aws elbv2 create-load-balancer \ --name my-internal-load-balancer \ --scheme internal \ --subnets subnet-b7d581c0 subnet-8360a9e7 ``` 出力: ``` { "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" } ] } ``` 詳細については、「Application Load Balancers のユーザーガイド」の「[チュートリアル: AWS CLI を使用した Application Load Balancer の作成](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/tutorial-application-load-balancer-cli.html)」を参照してください。** **例 3: Network Load Balancer を作成するには** 次の `create-load-balancer` の例は、インターネット向けの Network Load Balancer を作成し、指定されたサブネットのアベイラビリティーゾーンを有効化します。サブネットマッピングを使用して、指定された Elastic IP アドレスを、アベイラビリティーゾーンのロードバランサーノードが使用するネットワークインターフェイスに関連付けます。 ``` aws elbv2 create-load-balancer \ --name my-network-load-balancer \ --type network \ --subnet-mappings SubnetId=subnet-b7d581c0,AllocationId=eipalloc-64d5890a ``` 出力: ``` { "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" } ] } ``` 詳細については、「Network Load Balancers のユーザーガイド」の「[チュートリアル: AWS CLI を使用して Network Load Balancer を作成する](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancer-cli.html)」を参照してください。** **例 4: Gateway Load Balancer を作成するには** 次の `create-load-balancer` の例は、Gateway Load Balancer を作成し、指定されたサブネットのアベイラビリティーゾーンを有効化します。 ``` aws elbv2 create-load-balancer \ --name my-gateway-load-balancer \ --type gateway \ --subnets subnet-dc83f691 subnet-a62583f9 ``` 出力: ``` { "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" } ] } ``` 詳細については、「Gateway Load Balancers のユーザーガイド」の「[AWS CLI を使用した Gateway Load Balancer の開始方法](https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/getting-started-cli.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[CreateLoadBalancer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/create-load-balancer.html)」を参照してください。** ### `create-rule` 次のコード例は、`create-rule` を使用する方法を示しています。 **AWS CLI** **例 1: パス条件とフォワードアクションを使用してルールを作成するには** 次の `create-rule` の例では、リクエストの URL に指定されたパターンが含まれる場合、指定されたターゲットグループへのリクエスト送信ルールを作成します。 ``` 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 ``` `conditions-pattern.json` の内容: ``` [ { "Field": "path-pattern", "PathPatternConfig": { "Values": ["/images/*"] } } ] ``` **例 2: ホスト条件と固定レスポンスを使用してルールを作成するには** 次の `create-rule` の例では、ホストヘッダーのホスト名が指定されたホスト名と一致する場合に、固定されたレスポンスを提供するルールを作成します。 ``` 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 ``` `conditions-host.json` の内容 ``` [ { "Field": "host-header", "HostHeaderConfig": { "Values": ["*.example.com"] } } ] ``` `actions-fixed-response.json` の内容 ``` [ { "Type": "fixed-response", "FixedResponseConfig": { "MessageBody": "Hello world", "StatusCode": "200", "ContentType": "text/plain" } } ] ``` **例 3: ソース IP アドレス条件、認証アクション、転送アクションを使用してルールを作成するには** 次の `create-rule` の例では、送信元 IP アドレスが指定された IP アドレスと一致する場合にユーザーを認証するルールを作成し、認証が成功した場合にリクエストを指定されたターゲットグループに転送します。 ``` 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 ``` `conditions-source-ip.json` の内容 ``` [ { "Field": "source-ip", "SourceIpConfig": { "Values": ["192.0.2.0/24", "198.51.100.10/32"] } } ] ``` `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 } ] ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/create-rule.html)」を参照してください。 ### `create-target-group` 次のコード例は、`create-target-group` を使用する方法を示しています。 **AWS CLI** **例 1: Application Load Balancer のターゲットグループを作成するには** 次の `create-target-group` の例は、Application Load Balancer のターゲットグループを作成し、インスタンス ID (ターゲットタイプは `instance`) でターゲットを登録します。このターゲットグループは HTTP プロトコル、ポート 80、および HTTP ターゲットグループのデフォルトのヘルスチェック設定を使用します。 ``` aws elbv2 create-target-group \ --name my-targets \ --protocol HTTP \ --port 80 \ --target-type instance \ --vpc-id vpc-3ac0fb5f ``` 出力: ``` { "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" } ] } ``` 詳細については、「Application Load Balancers のユーザーガイド」の「[ターゲットグループの作成](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-target-group.html)」を参照してください。** **例 2: Application Load Balancer から Lambda 関数にトラフィックをルーティングするターゲットグループを作成するには** 次の `create-target-group` の例は、Application Load Balancer のターゲットグループを作成します。ターゲットは Lambda 関数 (ターゲットタイプは `lambda`) です。このターゲットグループのヘルスチェックは、デフォルトでは無効化されています。 ``` aws elbv2 create-target-group \ --name my-lambda-target \ --target-type lambda ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Application Load Balancer ユーザーガイド*」の「[ターゲットとしての Lambda 関数](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/lambda-functions.html)」を参照してください。 **例 3: Network Load Balancer のターゲットグループを作成するには** 次の `create-target-group` の例は、Network Load Balancer のターゲットグループを作成し、IP アドレス (ターゲットタイプは `ip`) でターゲットを登録します。このターゲットグループは TCP プロトコル、ポート 80、および TCP ターゲットグループのデフォルトのヘルスチェック設定を使用します。 ``` aws elbv2 create-target-group \ --name my-ip-targets \ --protocol TCP \ --port 80 \ --target-type ip \ --vpc-id vpc-3ac0fb5f ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Network Load Balancer のユーザーガイド*」の「[Create a target group](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-target-group.html)」を参照してください。 **例 4: Network Load Balancer から Application Load Balancer にトラフィックをルーティングするターゲットグループを作成するには** 次の `create-target-group` の例は、Network Load Balancer のターゲットグループを作成し、そこにターゲットとして (ターゲットタイプは `alb`) Application Load Balancer をを登録します。 aws elbv2 create-target-group --name my-alb-target --protocol TCP --port 80 --target-type alb --vpc-id vpc-3ac0fb5f 出力: ``` { "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" } ] } ``` 詳細については、「*Network Load Balancer のユーザーガイド*」の「[Create a target group with an Application Load Balancer as the target](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/application-load-balancer-target.html)」を参照してください。 **例 5: Gateway Load Balancer のターゲットグループを作成するには** 次の `create-target-group` の例は、Gateway Load Balancer のターゲットグループを作成します。ターゲットはインスタンスで、ターゲットグループのプロトコルは `GENEVE` です。 ``` aws elbv2 create-target-group \ --name my-glb-targetgroup \ --protocol GENEVE \ --port 6081 \ --target-type instance \ --vpc-id vpc-838475fe ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Gateway Load Balancer ユーザーガイド*」の「ターゲットグループの作成 `\$1\$1」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[CreateTargetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/create-target-group.html)」を参照してください。** ### `delete-listener` 次のコード例は、`delete-listener` を使用する方法を示しています。 **AWS CLI** **リスナーを削除するには** 以下の `delete-listener` 例は、指定されたリスナーを削除します。 ``` aws elbv2 delete-listener \ --listener-arn arn:aws:elasticloadbalancing:ua-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteListener](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/delete-listener.html)」を参照してください。 ### `delete-load-balancer` 次のコード例は、`delete-load-balancer` を使用する方法を示しています。 **AWS CLI** **ロードバランサーを削除するには** 次の `delete-load-balancer` の例は、指定されたロードバランサーを削除します。 ``` aws elbv2 delete-load-balancer \ --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 ``` + API の詳細については、AWS CLI コマンドリファレンスの「[DeleteLoadBalancer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/delete-load-balancer.html)」を参照してください。** ### `delete-rule` 次のコード例は、`delete-rule` を使用する方法を示しています。 **AWS CLI** **ルールを削除するには** 次の `delete-rule` の例は、指定されたルールを削除します。 ``` aws elbv2 delete-rule \ --rule-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3 ``` + API の詳細については、AWS CLI コマンドリファレンスの「[DeleteRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/delete-rule.html)」を参照してください。** ### `delete-target-group` 次のコード例は、`delete-target-group` を使用する方法を示しています。 **AWS CLI** **ターゲットグループを削除するには** 次の `delete-target-group` の例は、指定されたターゲットグループを削除します。 ``` aws elbv2 delete-target-group \ --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 ``` このコマンドでは何も出力されません。 詳細については、「*Application Load Balancer ユーザーガイド*」の「[Delete a load balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-delete.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[DeleteTargetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/delete-target-group.html)」を参照してください。** ### `deregister-targets` 次のコード例は、`deregister-targets` を使用する方法を示しています。 **AWS CLI** **例 1: ターゲットグループからターゲットの登録を解除するには** 次の `deregister-targets` の例では、指定されたインスタンスを指定されたターゲットグループから削除します。 ``` aws elbv2 deregister-targets \ --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 \ --targets Id=i-1234567890abcdef0 ``` **例 2: ポートオーバーライドを使用して登録されたターゲットの登録を解除するには** 次の `deregister-targets` の例では、ポートオーバーライドを使用して登録されたターゲットグループからインスタンスを削除します。 ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeregisterTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/deregister-targets.html)」を参照してください。 ### `describe-account-limits` 次のコード例は、`describe-account-limits` を使用する方法を示しています。 **AWS CLI** **Elastic Load Balancing の制限を記述するには** 次の `describe-account-limits` の例は、現在のリージョンの AWS アカウントの Elastic Load Balancing 制限を示しています。 ``` aws elbv2 describe-account-limits ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS 全般リファレンス*」の「[Quotas](https://docs.aws.amazon.com/general/latest/gr/elb.html#limits_elastic_load_balancer)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAccountLimits](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/describe-account-limits.html)」を参照してください。 ### `describe-listener-certificates` 次のコード例は、`describe-listener-certificates` を使用する方法を示しています。 **AWS CLI** **セキュアリスナーの証明書を記述するには** この例では、指定されたセキュアリスナーの証明書を記述します。 コマンド: ``` aws elbv2 describe-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", "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeListenerCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/describe-listener-certificates.html)」を参照してください。 ### `describe-listeners` 次のコード例は、`describe-listeners` を使用する方法を示しています。 **AWS CLI** **リスナーを記述するには** この例では、指定されたリスナーを記述します。 コマンド: ``` aws elbv2 describe-listeners --listener-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 ``` 出力: ``` { "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" } ] } ``` **ロードバランサーのリスナーを記述するには** この例は、指定されたロードバランサーのリスナーを記述します。 コマンド: ``` aws elbv2 describe-listeners --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeListeners](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/describe-listeners.html)」を参照してください。 ### `describe-load-balancer-attributes` 次のコード例は、`describe-load-balancer-attributes` を使用する方法を示しています。 **AWS CLI** **ロードバランサー属性を記述するには** 次の `describe-load-balancer-attributes` の例では、指定されたロードバランサーの属性を表示します。 ``` aws elbv2 describe-load-balancer-attributes \ --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 ``` 次の出力例は、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" } ] } ``` 次の出力例には、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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeLoadBalancerAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/describe-load-balancer-attributes.html)」を参照してください。 ### `describe-load-balancers` 次のコード例は、`describe-load-balancers` を使用する方法を示しています。 **AWS CLI** **ロードバランサーを記述するには** この例は、指定されたロードバランサーを記述します。 コマンド: ``` aws elbv2 describe-load-balancers --load-balancer-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 ``` 出力: ``` { "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" } ] } ``` **すべてのロードバランサーを記述するには** この例は、すべてのロードバランサーを記述します。 コマンド: ``` aws elbv2 describe-load-balancers ``` + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeLoadBalancers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/describe-load-balancers.html)」を参照してください。** ### `describe-rules` 次のコード例は、`describe-rules` を使用する方法を示しています。 **AWS CLI** **例 1: ルールを記述するには** 次の `describe-rules` の例は、指定されたルールの詳細情報を表示します。 ``` aws elbv2 describe-rules \ --rule-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee ``` **例 2: リスナーのルールを記述するには** 次の `describe-rules` の例は、指定されたリスナーのルールの詳細を表示します。出力には、デフォルトのルールと、追加したその他のルールが含まれます。 ``` aws elbv2 describe-rules \ --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/describe-rules.html)」を参照してください。 ### `describe-ssl-policies` 次のコード例は、`describe-ssl-policies` を使用する方法を示しています。 **AWS CLI** **例 1: ロードバランサータイプ別に SSL ネゴシエーションに使用されるポリシーを一覧表示するには** 次の `describe-ssl-policies` の例は、Application Load Balancer との SSL ネゴシエーションに使用できるポリシーの名前を示しています。例では、`--query` パラメータを使用してポリシーの名前のみを表示しています。 ``` aws elbv2 describe-ssl-policies \ --load-balancer-type application \ --query SslPolicies[*].Name ``` 出力: ``` [ "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" ] ``` **例 2: 特定のプロトコルをサポートするポリシーを一覧表示するには** 次の `describe-ssl-policies` の例は、TLS 1.3 プロトコルをサポートするポリシーの名前を示しています。例では、`--query` パラメータを使用してポリシーの名前のみを表示しています。 ``` aws elbv2 describe-ssl-policies \ --load-balancer-type application \ --query SslPolicies[?contains(SslProtocols,'TLSv1.3')].Name ``` 出力: ``` [ "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" ] ``` **例 3: ポリシーの暗号を表示するには** 次の `describe-ssl-policies` の例では、指定されたポリシーの暗号の名前を表示します。例では、`--query` パラメータを使用して暗号の名前のみを表示しています。リスト内の最初の暗号の優先度は 1 で、残りの暗号は優先順位が付けられています。 ``` aws elbv2 describe-ssl-policies \ --names ELBSecurityPolicy-TLS13-1-2-2021-06 \ --query SslPolicies[*].Ciphers[*].Name ``` 出力: ``` [ "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" ] ``` 詳細については、「*Application Load Balancer のユーザーガイド*」の「[セキュリティポリシー](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeSslPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/describe-ssl-policies.html)」を参照してください。 ### `describe-tags` 次のコード例は、`describe-tags` を使用する方法を示しています。 **AWS CLI** **ロードバランサーに割り当てられたタグを記述するには** この例では、指定されたロードバランサーに割り当てられたタグを記述します。 コマンド: ``` aws elbv2 describe-tags --resource-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 ``` 出力: ``` { "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" } ] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/describe-tags.html)」を参照してください。 ### `describe-target-group-attributes` 次のコード例は、`describe-target-group-attributes` を使用する方法を示しています。 **AWS CLI** **ターゲットグループ属性を記述するには** 次の `describe-target-group-attributes` の例では、指定したターゲットグループの属性を表示します。 ``` aws elbv2 describe-target-group-attributes \ --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 ``` プロトコルが HTTP または HTTPS で、ターゲットタイプが `instance` または `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" } ] } ``` プロトコルが HTTP または HTTPS で、ターゲットタイプが `lambda` の場合、次の出力には属性が含まれます。 ``` { "Attributes": [ { "Value": "false", "Key": "lambda.multi_value_headers.enabled" } ] } ``` 次の出力には、プロトコルが TCP、TLS、UDP、または TCP\$1UDP の場合の属性が含まれます。 ``` { "Attributes": [ { "Value": "false", "Key": "proxy_protocol_v2.enabled" }, { "Value": "300", "Key": "deregistration_delay.timeout_seconds" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTargetGroupAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/describe-target-group-attributes.html)」を参照してください。 ### `describe-target-groups` 次のコード例は、`describe-target-groups` を使用する方法を示しています。 **AWS CLI** **例 1: ターゲットグループを記述するには** 次の `describe-target-groups` の例は、指定されたターゲットグループの詳細情報を表示します。 ``` aws elbv2 describe-target-groups \ --target-group-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 ``` 出力: ``` { "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" } ] } ``` **例 2: ロードバランサーのすべてのターゲットグループを記述するには** 次の `describe-target-groups` の例は、指定されたロードバランサーのすべてのターゲットグループの詳細情報を表示します。例では、`--query` パラメータを使用してターゲットグループの名前のみを表示しています。 ``` aws elbv2 describe-target-groups \ --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 \ --query TargetGroups[*].TargetGroupName ``` 出力: ``` [ "my-instance-targets", "my-ip-targets", "my-lambda-target" ] ``` 詳細については、「*Application Load Balancer ガイド*」の「[ターゲットグループ](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeTargetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/describe-target-groups.html)」を参照してください。** ### `describe-target-health` 次のコード例は、`describe-target-health` を使用する方法を示しています。 **AWS CLI** **例 1: ターゲットグループのターゲットのヘルスを記述するには** 次の `describe-target-health` の例は、指定されたターゲットグループのターゲットのヘルスの詳細情報を表示します。これらのターゲットは正常です。 ``` aws elbv2 describe-target-health \ --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 ``` 出力: ``` { "TargetHealthDescriptions": [ { "HealthCheckPort": "80", "Target": { "Id": "i-ceddcd4d", "Port": 80 }, "TargetHealth": { "State": "healthy" } }, { "HealthCheckPort": "80", "Target": { "Id": "i-0f76fade", "Port": 80 }, "TargetHealth": { "State": "healthy" } } ] } ``` **例 2: ターゲットのヘルスを記述するには** 次の `describe-target-health` の例は、指定されたターゲットのヘルスの詳細情報を表示します。このターゲットは正常です。 ``` 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 ``` 出力: ``` { "TargetHealthDescriptions": [ { "HealthCheckPort": "80", "Target": { "Id": "i-0f76fade", "Port": 80 }, "TargetHealth": { "State": "healthy" } } ] } ``` 次の出力例は、リスナーのアクションでターゲットグループが指定されていないターゲットの出力です。このターゲットはロードバランサーからのトラフィックを受信できません。 ``` { "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" } } ] } ``` 次の例は、リスナーのアクションでターゲットグループが指定されたばかりのターゲットの出力です。このターゲットは現在登録中です。 ``` { "TargetHealthDescriptions": [ { "HealthCheckPort": "80", "Target": { "Id": "i-0f76fade", "Port": 80 }, "TargetHealth": { "State": "initial", "Reason": "Elb.RegistrationInProgress", "Description": "Target registration is in progress" } } ] } ``` 次の例は、正常でないターゲットの出力です。 ``` { "TargetHealthDescriptions": [ { "HealthCheckPort": "80", "Target": { "Id": "i-0f76fade", "Port": 80 }, "TargetHealth": { "State": "unhealthy", "Reason": "Target.Timeout", "Description": "Connection to target timed out" } } ] } ``` 以下は、ターゲットが Lambda 関数で、ヘルスチェックが無効化されている出力の例です。 ``` { "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" } } ] } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeTargetHealth](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/describe-target-health.html)」を参照してください。** ### `modify-listener` 次のコード例は、`modify-listener` を使用する方法を示しています。 **AWS CLI** **例 1: デフォルトのアクションを転送アクションに変更するには** 次の `modify-listener` の例では、デフォルトのアクションを指定されたリスナーの `forward` アクションに変更します。 ``` 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 ``` 出力: ``` { "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" } ] } ] } ``` **例 2: デフォルトのアクションをリダイレクトアクションに変更するには** 次の `modify-listener` の例では、デフォルトのアクションを指定されたリスナーの `redirect` アクションに変更します。 ``` 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}' ``` 出力: ``` { "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", } } ] } ] } ``` **例 3: サーバー証明書を変更するには** 次の `modify-listener` の例では、指定された HTTPS リスナーのサーバー証明書を変更します。 ``` 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 ``` 出力: ``` { "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" } ], } ] } ``` 詳細については、「*Application Load Balancer のユーザーガイド*」の「[リスナールール](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html#listener-rules)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyListener](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/modify-listener.html)」を参照してください。 ### `modify-load-balancer-attributes` 次のコード例は、`modify-load-balancer-attributes` を使用する方法を示しています。 **AWS CLI** **削除保護を有効にするには** この例では、指定されたロードバランサーの削除保護を有効にします。 コマンド: ``` 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 ``` 出力: ``` { "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" } ] } ``` **アイドルタイムアウトを変更するには** この例では、指定されたロードバランサーのアイドルタイムアウト値を変更します。 コマンド: ``` 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 ``` 出力: ``` { "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" } ] } ``` **アクセスログを有効にするには** この例では、指定されたロードバランサーのアクセスログを有効にします。S3 バケットはロードバランサーと同じリージョンに存在し、Elastic Load Balancing サービスへのアクセスを許可するポリシーがアタッチされている必要があることに注意してください。 コマンド: ``` 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 ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyLoadBalancerAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/modify-load-balancer-attributes.html)」を参照してください。 ### `modify-rule` 次のコード例は、`modify-rule` を使用する方法を示しています。 **AWS CLI** **ルールを変更するには** 次の `modify-rule` の例では、指定されたルールのアクションと条件を更新します。 ``` 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 ``` 出力: ``` { "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" } ] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/modify-rule.html)」を参照してください。 ### `modify-target-group-attributes` 次のコード例は、`modify-target-group-attributes` を使用する方法を示しています。 **AWS CLI** **登録解除遅延タイムアウトを変更するには** この例では、登録解除遅延タイムアウトを指定されたターゲットグループの指定された値に設定します。 コマンド: ``` 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 ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyTargetGroupAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/modify-target-group-attributes.html)」を参照してください。 ### `modify-target-group` 次のコード例は、`modify-target-group` を使用する方法を示しています。 **AWS CLI** **ターゲットグループのヘルスチェック設定を変更するには** 次の `modify-target-group` の例では、指定されたターゲットグループのターゲットのヘルスを評価するために使用されるヘルスチェックの設定を変更します。CLI がカンマを解析する方法により、二重引用符ではなく一重引用符で `--matcher` オプションの範囲を囲む必要があることに注意してください。 ``` 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' ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Application Load Balancer ガイド*」の「[ターゲットグループ](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyTargetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/modify-target-group.html)」を参照してください。 ### `register-targets` 次のコード例は、`register-targets` を使用する方法を示しています。 **AWS CLI** **例 1: インスタンス ID でターゲットグループにターゲットを登録するには** 次の `register-targets` の例では、指定されたインスタンスをターゲットグループに登録します。ターゲットグループは、`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 ``` **例 2: ポートオーバーライドを使用してターゲットをターゲットグループに登録するには** 次の `register-targets` の例では、複数のポートを使用して、指定されたインスタンスをターゲットグループに登録します。これにより、ターゲットグループのターゲットと同じインスタンスにコンテナを登録できます。 ``` 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 ``` **例 3: IP アドレスでターゲットグループにターゲットを登録するには** 次の `register-targets` の例では、指定された IP アドレスをターゲットグループに登録します。ターゲットグループは、`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 ``` **例 4: Lambda 関数をターゲットとして登録するには** 次の `register-targets` の例では、指定された IP アドレスをターゲットグループに登録します。ターゲットグループは、`lambda` のターゲットタイプを持つ必要があります。Lambda 関数を呼び出すには、Elastic Load Balancing のアクセス許可が必要です。 ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegisterTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/register-targets.html)」を参照してください。 ### `remove-listener-certificates` 次のコード例は、`remove-listener-certificates` を使用する方法を示しています。 **AWS CLI** **セキュアリスナーから証明書を削除するには** この例では、指定された証明書を指定されたセキュアリスナーから削除します。 コマンド: ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveListenerCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/remove-listener-certificates.html)」を参照してください。 ### `remove-tags` 次のコード例は、`remove-tags` を使用する方法を示しています。 **AWS CLI** **ロードバランサーからタグを削除するには** 次の `remove-tags` の例では、指定されたロードバランサーから `project` と `department` タグを削除します。 ``` aws elbv2 remove-tags \ --resource-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 \ --tag-keys project department ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/remove-tags.html)」を参照してください。 ### `set-ip-address-type` 次のコード例は、`set-ip-address-type` を使用する方法を示しています。 **AWS CLI** **ロードバランサーのアドレスタイプを設定するには** この例では、指定されたロードバランサーのアドレスタイプを `dualstack` に設定します。ロードバランサーサブネットには IPv6 CIDR ブロックが関連付けられている必要があります。 コマンド: ``` 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 ``` 出力: ``` { "IpAddressType": "dualstack" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetIpAddressType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/set-ip-address-type.html)」を参照してください。 ### `set-rule-priorities` 次のコード例は、`set-rule-priorities` を使用する方法を示しています。 **AWS CLI** **ルールの優先度を設定するには** この例では、指定されたルールの優先度を設定します。 コマンド: ``` 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 ``` 出力: ``` { "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" } ] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetRulePriorities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/set-rule-priorities.html)」を参照してください。 ### `set-security-groups` 次のコード例は、`set-security-groups` を使用する方法を示しています。 **AWS CLI** **セキュリティグループをロードバランサーに関連付けるには** この例では、指定されたセキュリティグループを指定されたロードバランサーに関連付けます。 コマンド: ``` 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 ``` 出力: ``` { "SecurityGroupIds": [ "sg-5943793c" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetSecurityGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/set-security-groups.html)」を参照してください。 ### `set-subnets` 次のコード例は、`set-subnets` を使用する方法を示しています。 **AWS CLI** **ロードバランサーのアベイラビリティーゾーンを有効にするには** この例では、指定されたロードバランサーの指定されたサブネットのアベイラビリティーゾーンを有効にします。 コマンド: ``` 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 ``` 出力: ``` { "AvailabilityZones": [ { "SubnetId": "subnet-8360a9e7", "ZoneName": "us-west-2a" }, { "SubnetId": "subnet-b7d581c0", "ZoneName": "us-west-2b" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetSubnets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elbv2/set-subnets.html)」を参照してください。 # AWS CLI を使用した ElastiCache の例 次のコード例は、ElastiCache で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `add-tags-to-resource` 次のコード例は、`add-tags-to-resource` を使用する方法を示しています。 **AWS CLI** **リソースにタグを追加するには** 次の `add-tags-to-resource` の例では、クラスターまたはスナップショットリソースに最大 10 個のタグ、キーと値のペアを追加します。 ``` aws elasticache add-tags-to-resource \ --resource-name "arn:aws:elasticache:us-east-1:1234567890:cluster:my-mem-cluster" \ --tags '{"20150202":15, "ElastiCache":"Service"}' ``` 出力: ``` { "TagList": [ { "Value": "20150202", "Key": "APIVersion" }, { "Value": "ElastiCache", "Key": "Service" } ] } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Monitoring Costs with Cost Allocation Tags](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Tagging.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[AddTagsToResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/add-tags-to-resource.html)」を参照してください。 ### `authorize-cache-security-group-ingress` 次のコード例は、`authorize-cache-security-group-ingress` を使用する方法を示しています。 **AWS CLI** **キャッシュセキュリティグループの進入を承認するには** 次の `authorize-cache-security-group-ingress` の例では、キャッシュセキュリティグループへのネットワーク進入を許可します。 ``` 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" ``` このコマンドでは何も出力されません。 詳細については、「*ElastiCache ユーザーガイド*」の「[Self-Service Updates in Amazon ElastiCache](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Self-Service-Updates.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AuthorizeCacheSecurityGroupIngress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/authorize-cache-security-group-ingress.html)」を参照してください。 ### `batch-apply-update-action` 次のコード例は、`batch-apply-update-action` を使用する方法を示しています。 **AWS CLI** **サービスの更新を適用するには** 次の `batch-apply-update-action` の例では、Redis クラスターにサービス更新を適用します。 ``` aws elasticache batch-apply-update-action \ --service-update-name elc-xxxxx406-xxx \ --replication-group-ids test-cluster ``` 出力: ``` { "ProcessedUpdateActions": [ { "ReplicationGroupId": "pat-cluster", "ServiceUpdateName": "elc-xxxxx406-xxx", "UpdateActionStatus": "waiting-to-start" } ], "UnprocessedUpdateActions": [] } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Self-Service Updates in Amazon ElastiCache](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Self-Service-Updates.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchApplyUpdateAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/batch-apply-update-action.html)」を参照してください。 ### `batch-stop-update-action` 次のコード例は、`batch-stop-update-action` を使用する方法を示しています。 **AWS CLI** **サービスの更新を停止するには** 次の `batch-stop-update-action` の例では、Redis クラスターにサービス更新を適用します。 ``` aws elasticache batch-stop-update-action \ --service-update-name elc-xxxxx406-xxx \ --replication-group-ids test-cluster ``` 出力: ``` { "ProcessedUpdateActions": [ { "ReplicationGroupId": "pat-cluster", "ServiceUpdateName": "elc-xxxxx406-xxx", "UpdateActionStatus": "stopping" } ], "UnprocessedUpdateActions": [] } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Self-Service Updates in Amazon ElastiCache](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Self-Service-Updates.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchStopUpdateAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/batch-stop-update-action.html)」を参照してください。 ### `copy-snapshot` 次のコード例は、`copy-snapshot` を使用する方法を示しています。 **AWS CLI** **スナップショットをコピーするには** 次の `copy-snapshot` の例では、既存のスナップショットのコピーを作成します。 ``` aws elasticache copy-snapshot \ --source-snapshot-name "my-snapshot" \ --target-snapshot-name "my-snapshot-copy" ``` 出力: ``` { "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" } } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[バックアップのエクスポート](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CopySnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/copy-snapshot.html)」を参照してください。 ### `create-cache-cluster` 次のコード例は、`create-cache-cluster` を使用する方法を示しています。 **AWS CLI** **キャッシュクラスターを作成するには** 次の `create-cache-cluster` の例では、Redis エンジンを使用してキャッシュクラスターを作成します。 ``` aws elasticache create-cache-cluster \ --cache-cluster-id "cluster-test" \ --engine redis \ --cache-node-type cache.m5.large \ --num-cache-nodes 1 ``` 出力: ``` { "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 } } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[クラスターの作成](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.Create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCacheCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/create-cache-cluster.html)」を参照してください。 ### `create-cache-parameter-group` 次のコード例は、`create-cache-parameter-group` を使用する方法を示しています。 **AWS CLI** **キャッシュパラメータグループを作成するには** 次の `create-cache-parameter-group` の例では、新しい Amazon ElastiCache キャッシュパラメータグループを作成します。 ``` aws elasticache create-cache-parameter-group \ --cache-parameter-group-family "redis5.0" \ --cache-parameter-group-name "mygroup" \ --description "mygroup" ``` 出力: ``` { "CacheParameterGroup": { "CacheParameterGroupName": "mygroup", "CacheParameterGroupFamily": "redis5.0", "Description": "my group" } } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[パラメータグループの作成](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroups.Creating.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCacheParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/create-cache-parameter-group.html)」を参照してください。 ### `create-cache-subnet-group` 次のコード例は、`create-cache-subnet-group` を使用する方法を示しています。 **AWS CLI** **キャッシュサブネットグループを作成するには** 次の `create-cache-subnet-group` の例では、新しいキャッシュサブネットグループを作成します。 ``` aws elasticache create-cache-subnet-group \ --cache-subnet-group-name "mygroup" \ --cache-subnet-group-description "my subnet group" \ --subnet-ids "subnet-xxxxec4f" ``` 出力: ``` { "CacheSubnetGroup": { "CacheSubnetGroupName": "mygroup", "CacheSubnetGroupDescription": "my subnet group", "VpcId": "vpc-a3e97cdb", "Subnets": [ { "SubnetIdentifier": "subnet-xxxxec4f", "SubnetAvailabilityZone": { "Name": "us-west-2d" } } ] } } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[キャッシュサブネットグループの作成](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/VPCs.CreatingSubnetGroup.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCacheSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/create-cache-subnet-group.html)」を参照してください。 ### `create-global-replication-group` 次のコード例は、`create-global-replication-group` を使用する方法を示しています。 **AWS CLI** **グローバルレプリケーショングループを作成するには** 次の `create-global-replication-group` の例では、新しいグローバルレプリケーショングループを作成します。 ``` aws elasticache create-global-replication-group \ --global-replication-group-id-suffix my-global-replication-group \ --primary-replication-group-id my-primary-cluster ``` 出力: ``` { "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 } } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Replication Across AWS Regions Using Global Datastore](https://docs.amazonaws.cn/en_us/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateGlobalReplicationGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/create-global-replication-group.html)」を参照してください。 ### `create-replication-group` 次のコード例は、`create-replication-group` を使用する方法を示しています。 **AWS CLI** **レプリケーションサブネットグループを作成するには** 次の `create-replication-group` の例では、Redis (クラスターモードが無効) または Redis (クラスターモードが有効) レプリケーショングループを作成します。このオペレーションは Redis でのみ有効です。 ``` aws elasticache create-replication-group \ --replication-group-id "mygroup" \ --replication-group-description "my group" \ --engine "redis" \ --cache-node-type "cache.m5.large" ``` 出力: ``` { "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 } } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Creating a Redis Replication Group](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Replication.CreatingRepGroup.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateReplicationGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/create-replication-group.html)」を参照してください。 ### `create-snapshot` 次のコード例は、`create-snapshot` を使用する方法を示しています。 **AWS CLI** **スナップショットを作成するには** 次の `create-snapshot` の例では、Redis エンジンを使用してスナップショットを作成します。 ``` aws elasticache create-snapshot \ --snapshot-name mysnapshot \ --cache-cluster-id cluster-test ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Backup and Restore for ElastiCache for Redis](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/create-snapshot.html)」を参照してください。 ### `create-user-group` 次のコード例は、`create-user-group` を使用する方法を示しています。 **AWS CLI** **ユーザーグループを作成するには** 次の `create-user-group` の例では、新しいユーザーグループを作成します。 ``` aws elasticache create-user-group \ --user-group-id myusergroup \ --engine redis \ --user-ids default ``` 出力: ``` { "UserGroupId": "myusergroup", "Status": "creating", "Engine": "redis", "UserIds": [ "default" ], "ReplicationGroups": [], "ARN": "arn:aws:elasticache:us-west-2:xxxxxxxxxx52:usergroup:myusergroup" } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Authenticating Users with Role-Based Access Control (RBAC)](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateUserGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/create-user-group.html)」を参照してください。 ### `create-user` 次のコード例は、`create-user` を使用する方法を示しています。 **AWS CLI** **ユーザーを作成するには** 次の `create-user` の例では、新しいユーザーを作成します。 ``` aws elasticache create-user \ --user-id user1 \ --user-name myUser \ --passwords mYnuUzrpAxXw2rdzx \ --engine redis \ --access-string "on ~app::* -@all +@read" ``` 出力: ``` { "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" } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Authenticating Users with Role-Based Access Control (RBAC)](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/create-user.html)」を参照してください。 ### `decrease-node-groups-in-global-replication-group` 次のコード例は、`decrease-node-groups-in-global-replication-group` を使用する方法を示しています。 **AWS CLI** **グローバルレプリケーショングループ内のノードグループの数を減らすには** 次の `decrease-node-groups-in-global-replication-group` は、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 ``` 出力: ``` { "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 } } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Replication Across AWS Regions Using Global Datastore](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DecreaseNodeGroupsInGlobalReplicationGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/decrease-node-groups-in-global-replication-group.html)」を参照してください。 ### `decrease-replica-count` 次のコード例は、`decrease-replica-count` を使用する方法を示しています。 **AWS CLI** **レプリカ数を減らすには** 次の `decrease-replica-count` の例では、Redis (クラスターモード無効化) レプリケーショングループのレプリカ数、または Redis (クラスターモード有効化) レプリケーショングループの 1 つ以上のノードグループ (シャード) のレプリカノードの数を動的に減らします。このオペレーションは、クラスターのダウンタイムなしで実行されます。 ``` aws elasticache decrease-replica-count \ --replication-group-id my-cluster \ --apply-immediately \ --new-replica-count 2 ``` 出力: ``` { "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 } } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Changing the Number of Replicas](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/increase-decrease-replica-count.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DecreaseReplicaCount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/decrease-replica-count.html)」を参照してください。 ### `delete-cache-cluster` 次のコード例は、`delete-cache-cluster` を使用する方法を示しています。 **AWS CLI** **キャッシュクラスターを削除するには** 次の `delete-cache-cluster` の例は、指定された以前にプロビジョニングされたクラスターを削除します。コマンドは、関連付けられたすべてのキャッシュノード、ノードエンドポイント、およびクラスター自体を削除します。このオペレーションから正常まレスポンスを受信すると、Amazon ElastiCache はただちにクラスターの削除を開始します。このオペレーションをキャンセルしたり、元に戻したりすることはできません。 このオペレーションは、次には無効です。 Redis (クラスターモードが有効) クラスター。レプリケーショングループの最後のリードレプリカであるクラスター。マルチ AZ モードが有効になっているノードグループ (シャード)。Redis (クラスターモードが有効) レプリケーショングループのクラスター。使用可能な状態ではないクラスター ``` aws elasticache delete-cache-cluster \ --cache-cluster-id "my-cluster-002" ``` 出力: ``` { "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 } } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Deleting a Cluster](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.Delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCacheCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/delete-cache-cluster.html)」を参照してください。 ### `delete-cache-parameter-group` 次のコード例は、`delete-cache-parameter-group` を使用する方法を示しています。 **AWS CLI** **キャッシュパラメータグループを削除するには** 次の `delete-cache-parameter-group` の例では、指定されたキャッシュパラメータグループを削除します。キャッシュパラメータグループがキャッシュクラスターに関連付けられている場合は、そのキャッシュパラメータグループを削除できません。 ``` aws elasticache delete-cache-parameter-group \ --cache-parameter-group-name myparamgroup ``` このコマンドでは何も出力されません。 詳細については、「*ElastiCache ユーザーガイド*」の「[パラメータグループの削除](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroups.Deleting.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCacheParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/delete-cache-parameter-group.html)」を参照してください。 ### `delete-cache-subnet-group` 次のコード例は、`delete-cache-subnet-group` を使用する方法を示しています。 **AWS CLI** **キャッシュサブネットグループを削除するには** 次の `delete-cache-subnet-group` の例では、指定されたキャッシュサブネットグループを削除します。キャッシュサブネットグループが何らかのクラスターに関連付けられている場合は、そのキャッシュサブネットグループを削除できません。 ``` aws elasticache delete-cache-subnet-group \ --cache-subnet-group-name "mygroup" ``` このコマンドでは何も出力されません。 詳細については、「*ElastiCache ユーザーガイド*」の「[Deleting a Subnet Group](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.Deleting.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCacheSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/delete-cache-subnet-group.html)」を参照してください。 ### `delete-global-replication-group` 次のコード例は、`delete-global-replication-group` を使用する方法を示しています。 **AWS CLI** **グローバルレプリケーショングループを削除するには** 次の `delete-global-replication-group` の例では、新しいグローバルレプリケーショングループを削除します。 ``` aws elasticache delete-global-replication-group \ --global-replication-group-id my-global-replication-group \ --retain-primary-replication-group ``` 出力: ``` { "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 } } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Replication Across AWS Regions Using Global Datastore](https://docs.amazonaws.cn/en_us/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteGlobalReplicationGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/delete-global-replication-group.html)」を参照してください。 ### `delete-replication-group` 次のコード例は、`delete-replication-group` を使用する方法を示しています。 **AWS CLI** **レプリケーショングループを削除するには** 次の `delete-replication-group` の例では、既存のレプリケーショングループを削除します。デフォルトでは、このオペレーションはプライマリ/プライマリとすべてのリードレプリカを含むレプリケーショングループ全体を削除します。レプリケーショングループにプライマリが 1 つしかない場合は、オプションでリードレプリカのみを削除し、RetainPrimaryCluster=true を設定してプライマリを保持できます。 このオペレーションから正常まレスポンスを受信すると、Amazon ElastiCache はただちに選択したリソースの削除を開始します。このオペレーションをキャンセルしたり、元に戻したりすることはできません。Redis にのみ有効です。 ``` aws elasticache delete-replication-group \ --replication-group-id "mygroup" ``` 出力: ``` { "ReplicationGroup": { "ReplicationGroupId": "mygroup", "Description": "my group", "Status": "deleting", "PendingModifiedValues": {}, "AutomaticFailover": "disabled", "SnapshotRetentionLimit": 0, "SnapshotWindow": "06:00-07:00", "TransitEncryptionEnabled": false, "AtRestEncryptionEnabled": false } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteReplicationGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/delete-replication-group.html)」を参照してください。 ### `delete-snapshot` 次のコード例は、`delete-snapshot` を使用する方法を示しています。 **AWS CLI** **スナップショットを削除するには** 次の `delete-snapshot` の例では、Redis エンジンを使用してスナップショットを削除しました。 ``` aws elasticache delete-snapshot \ --snapshot-name mysnapshot ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Backup and Restore for ElastiCache for Redis](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[DeleteSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/delete-snapshot.html)」を参照してください。 ### `delete-user-group` 次のコード例は、`delete-user-group` を使用する方法を示しています。 **AWS CLI** **ユーザーグループを削除するには** 次の `delete-user-group` の例では、ユーザーグループを削除します。 ``` aws elasticache delete-user-group \ --user-group-id myusergroup ``` 出力: ``` { "UserGroupId": "myusergroup", "Status": "deleting", "Engine": "redis", "UserIds": [ "default" ], "ReplicationGroups": [], "ARN": "arn:aws:elasticache:us-west-2:xxxxxxxxxx52:usergroup:myusergroup" } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Authenticating Users with Role-Based Access Control (RBAC)](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteUserGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/delete-user-group.html)」を参照してください。 ### `delete-user` 次のコード例は、`delete-user` を使用する方法を示しています。 **AWS CLI** **ユーザーを削除するには** 次の `delete-user` の例では、ユーザーを削除します。 ``` aws elasticache delete-user \ --user-id user2 ``` 出力: ``` { "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" } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Authenticating Users with Role-Based Access Control (RBAC)](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/delete-user.html)」を参照してください。 ### `describe-cache-clusters` 次のコード例は、`describe-cache-clusters` を使用する方法を示しています。 **AWS CLI** **キャッシュクラスターを記述するには** 次の `describe-cache-clusters` の例は、キャッシュクラスターを表しています。 ``` aws elasticache describe-cache-clusters ``` 出力: ``` { "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" } ] } ] } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Managing Clusters](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeCacheClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-cache-clusters.html)」を参照してください。 ### `describe-cache-engine-versions` 次のコード例は、`describe-cache-engine-versions` を使用する方法を示しています。 **AWS CLI** **キャッシュエンジンのバージョンを記述するには** 次の `describe-cache-engine-versions` の例では、使用可能なキャッシュエンジンとそのバージョンのリストを返します。 ``` aws elasticache describe-cache-engine-versions \ --engine "Redis" ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeCacheEngineVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-cache-engine-versions.html)」を参照してください。 ### `describe-cache-parameter-groups` 次のコード例は、`describe-cache-parameter-groups` を使用する方法を示しています。 **AWS CLI** **キャッシュパラメータグループを記述するには** 次の `describe-cache-parameter-groups` の例では、キャッシュパラメータグループの記述のリストを返します。 ``` aws elasticache describe-cache-parameter-groups \ --cache-parameter-group-name "mygroup" ``` 出力: ``` { "CacheParameterGroups": [ { "CacheParameterGroupName": "mygroup", "CacheParameterGroupFamily": "redis5.0", "Description": " " } ] } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Configuring Engine Parameters Using Parameter Groups](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/ParameterGroups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeCacheParameterGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-cache-parameter-groups.html)」を参照してください。 ### `describe-cache-parameters` 次のコード例は、`describe-cache-parameters` を使用する方法を示しています。 **AWS CLI** **キャッシュパラメータを記述するには** 次の「describe-cache-parameters」の例は、特定のキャッシュパラメータグループの詳細なパラメータリストを返します。 ``` aws elasticache describe-cache-parameters \ --cache-parameter-group-name "myparamgroup" ``` 出力: ``` { "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" } ] } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Parameter Management](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/ParameterGroups.Management.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeCacheParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-cache-parameters.html)」を参照してください。 ### `describe-cache-subnet-groups` 次のコード例は、`describe-cache-subnet-groups` を使用する方法を示しています。 **AWS CLI** **キャッシュサブネットグループを記述するには** 次の `describe-cache-subnet-groups` の例では、サブネットグループのリストを返します。 ``` aws elasticache describe-cache-subnet-groups ``` 出力: ``` { "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" } } ] } ] } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Subnets and Subnet Groups](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.html)」または「*ElastiCache for Memcached ユーザーガイド*」の「[Subnets and Subnet Groups](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/SubnetGroups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeCacheSubnetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-cache-subnet-groups.html)」を参照してください。 ### `describe-engine-default-parameters` 次のコード例は、`describe-engine-default-parameters` を使用する方法を示しています。 **AWS CLI** **エンジンのデフォルトパラメータを記述するには** 次の `describe-engine-default-parameters` の例では、指定されたキャッシュエンジンのデフォルトのエンジンおよびシステムパラメータ情報を返します。 ``` aws elasticache describe-engine-default-parameters \ --cache-parameter-group-family "redis5.0" ``` 出力: ``` { "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" } ] } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEngineDefaultParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-engine-default-parameters.html)」を参照してください。 ### `describe-events` 次のコード例は、`describe-events` を使用する方法を示しています。 **AWS CLI** **レプリケーショングループのイベントを記述するには** 次の `describe-events` の例では、レプリケーショングループのイベントのリストを返します。 ``` aws elasticache describe-events \ --source-identifier test-cluster \ --source-type replication-group ``` 出力: ``` { "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" } ] } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Monitoring Events](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ECEvents.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-events.html)」を参照してください。 ### `describe-global-replication-groups` 次のコード例は、`describe-global-replication-groups` を使用する方法を示しています。 **AWS CLI** **グローバルレプリケーショングループを記述するには** 次の `describe-global-replication-groups` の例では、グローバルデータストアの詳細を返します。 ``` aws elasticache describe-global-replication-groups \ --global-replication-group-id my-grg ``` 出力: ``` { "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 } ] } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Replication Across AWS Regions Using Global Datastore](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeGlobalReplicationGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-global-replication-groups.html)」を参照してください。 ### `describe-replication-groups` 次のコード例は、`describe-replication-groups` を使用する方法を示しています。 **AWS CLI** **レプリケーショングループの詳細のリストを返すには** 次の `describe-replication-groups` の例では、レプリケーショングループを返します。 ``` aws elasticache describe-replication-groups ``` 出力: ``` { "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" } ] } ] } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Managing Clusters](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeReplicationGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-replication-groups.html)」を参照してください。 ### `describe-reserved-cache-nodes-offerings` 次のコード例は、`describe-reserved-cache-nodes-offerings` を使用する方法を示しています。 **AWS CLI** **reserved-cache-nodes-offerings を記述するには** 次の `describe-reserved-cache-nodes-offerings` の例では、予約済みキャッシュノードオプションの詳細を返します。 ``` aws elasticache describe-reserved-cache-nodes-offerings ``` 出力: ``` { "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" } ] }, ... ] } ``` 詳細については、「*ElastiCache Redis ユーザーガイド*」の「[Getting Info About Reserved Node Offerings](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/reserved-nodes-offerings.html)」または「*ElastiCache Memcached ユーザーガイド*」の「[Getting Info About Reserved Node Offerings](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/reserved-nodes-offerings.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeReservedCacheNodesOfferings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-reserved-cache-nodes-offerings.html)」を参照してください。 ### `describe-reserved-cache-nodes` 次のコード例は、`describe-reserved-cache-nodes` を使用する方法を示しています。 **AWS CLI** **予約済みキャッシュノードを記述するには** 次の `describe-reserved-cache-nodes` の例は、このアカウントの予約済みキャッシュノード、または指定した予約済みキャッシュノードに関する情報を返します。 aws elasticache describe-reserved-cache-nodes 出力: ``` { "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" } ] } ``` 詳細については、「*ElastiCache ユーザーガイド*」の[「Managing Costs with Reserved Nodes](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/reserved-nodes.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeReservedCacheNodes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-reserved-cache-nodes.html)」を参照してください。 ### `describe-service-updates` 次のコード例は、`describe-service-updates` を使用する方法を示しています。 **AWS CLI** **サービス更新を記述するには** 次の `describe-service-updates` の例では、サービスの更新に関する詳細を返します。 ``` aws elasticache describe-service-updates ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeServiceUpdates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-service-updates.html)」を参照してください。 ### `describe-snapshots` 次のコード例は、`describe-snapshots` を使用する方法を示しています。 **AWS CLI** **スナップショットを記述するには** 次の「describe-snapshots」の例は、クラスターまたはレプリケーショングループのスナップショットに関する情報を返します。 ``` aws elasticache describe-snapshots ``` 出力: ``` { "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" } ] } ] } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Backup and Restore for ElastiCache for Redis](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[DescribeSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-snapshots.html)」を参照してください。 ### `describe-update-actions` 次のコード例は、`describe-update-actions` を使用する方法を示しています。 **AWS CLI** **更新アクションを記述するには** 次の `describe-update-actions` の例では、更新アクションの詳細を返します。 ``` aws elasticache describe-update-actions ``` 出力: ``` { "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" } ] } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Self-Service Updates in Amazon ElastiCache](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Self-Service-Updates.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeUpdateActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-update-actions.html)」を参照してください。 ### `describe-user-groups` 次のコード例は、`describe-user-groups` を使用する方法を示しています。 **AWS CLI** **ユーザーグループを記述するには** 次の `describe-user-groups` の例では、ユーザーグループのリストを返します。 ``` aws elasticache describe-user-groups ``` 出力: ``` { "UserGroups": [ { "UserGroupId": "myusergroup", "Status": "active", "Engine": "redis", "UserIds": [ "default" ], "ReplicationGroups": [], "ARN": "arn:aws:elasticache:us-west-2:xxxxxxxxxx52:usergroup:myusergroup" } ] } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Authenticating Users with Role-Based Access Control (RBAC)](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeUserGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-user-groups.html)」を参照してください。 ### `describe-users` 次のコード例は、`describe-users` を使用する方法を示しています。 **AWS CLI** **ユーザーを記述するには** 次の `describe-users` の例では、ユーザーのリストを返します。 ``` aws elasticache describe-users ``` 出力: ``` { "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" } ] } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Authenticating Users with Role-Based Access Control (RBAC)](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeUsers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/describe-users.html)」を参照してください。 ### `disassociate-global-replication-group` 次のコード例は、`disassociate-global-replication-group` を使用する方法を示しています。 **AWS CLI** **グローバルレプリケーショングループからセカンダリクラスターの関連付けを解除するには** 次の `disassociate-global-replication-group` の例では、グローバルデータストアからセカンダリクラスターを削除します。 ``` 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 ``` 出力: ``` { "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 } } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Replication Across AWS Regions Using Global Datastore](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateGlobalReplicationGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/disassociate-global-replication-group.html)」を参照してください。 ### `increase-node-groups-in-global-replication-group` 次のコード例は、`increase-node-groups-in-global-replication-group` を使用する方法を示しています。 **AWS CLI** **グローバルレプリケーショングループのノードグループ数を増やすには** 次の `increase-node-groups-in-global-replication-group` は、Redis エンジンを使用してノードグループ数を増やします。 ``` aws elasticache increase-node-groups-in-global-replication-group \ --global-replication-group-id sgaui-pat-test-4 \ --node-group-count 6 \ --apply-immediately ``` 出力: ``` { "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 } } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Replication Across AWS Regions Using Global Datastore](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[IncreaseNodeGroupsInGlobalReplicationGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/increase-node-groups-in-global-replication-group.html)」を参照してください。 ### `increase-replica-count` 次のコード例は、`increase-replica-count` を使用する方法を示しています。 **AWS CLI** **レプリカ数を増やすには** 次の `increase-replica-count` の例では、2 つのモノのいずれかを実行します。Redis (クラスターモードが無効) レプリケーショングループのレプリカの数を動的に増やすことができます。または、Redis (クラスターモードが有効) レプリケーショングループの 1 つ以上のノードグループ (シャード) 内のレプリカノードの数を動的に増やすこともできます。このオペレーションは、クラスターのダウンタイムなしで実行されます。 ``` aws elasticache increase-replica-count \ --replication-group-id "my-cluster" \ --apply-immediately \ --new-replica-count 3 ``` 出力: ``` { "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 } } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[シャードのレプリカ数を増やす](https://docs.aws.amazon.c`m/AmazonElastiCache/latest/red-ug/increase-replica-count.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[IncreaseReplicaCount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/increase-replica-count.html)」を参照してください。 ### `list-allowed-node-type-modifications` 次のコード例は、`list-allowed-node-type-modifications` を使用する方法を示しています。 **AWS CLI** **許可されたノードの変更を一覧表示するには** 次の `list-allowed-node-type-modifications` の例では、Redis クラスターまたはレプリケーショングループの現在のノードタイプをスケールできるすべての使用可能なノードタイプを一覧表示します。 ``` aws elasticache list-allowed-node-type-modifications \ --replication-group-id "my-replication-group" ``` 出力: ``` { "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" ] } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Scaling ElastiCache for Redis Clusters](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAllowedNodeTypeModifications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/list-allowed-node-type-modifications.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **リソースのタグを一覧表示するには** 次の `list-tags-for-resource` の例では、リソースのタグを一覧表示します。 ``` aws elasticache list-tags-for-resource \ --resource-name "arn:aws:elasticache:us-east-1:123456789012:cluster:my-cluster" ``` 出力: ``` { "TagList": [ { "Key": "Project", "Value": "querySpeedUp" }, { "Key": "Environment", "Value": "PROD" } ] } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Listing Tags Using the AWS CLI](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Tagging.Managing.CLI.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/list-tags-for-resource.html)」を参照してください。 ### `modify-cache-cluster` 次のコード例は、`modify-cache-cluster` を使用する方法を示しています。 **AWS CLI** **キャッシュクラスターを変更するには** 次の `modify-cache-cluster` の例では、指定されたクラスターの設定を変更します。 ``` aws elasticache modify-cache-cluster \ --cache-cluster-id "my-cluster" \ --num-cache-nodes 1 ``` 出力: ``` { "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 } } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Modifying an ElastiCache Cluster](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.Modify.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyCacheCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/modify-cache-cluster.html)」を参照してください。 ### `modify-cache-parameter-group` 次のコード例は、`modify-cache-parameter-group` を使用する方法を示しています。 **AWS CLI** **キャッシュパラメータグループを変更するには** 次の `modify-cache-parameter-group` の例では、指定されたキャッシュパラメータグループのパラメータを変更します。 ``` aws elasticache modify-cache-parameter-group \ --cache-parameter-group-name "mygroup" \ --parameter-name-values "ParameterName=activedefrag, ParameterValue=no" ``` 出力: ``` { "CacheParameterGroupName": "mygroup" } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Modifying a Parameter Group](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroups.Modifying.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyCacheParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/modify-cache-parameter-group.html)」を参照してください。 ### `modify-cache-subnet-group` 次のコード例は、`modify-cache-subnet-group` を使用する方法を示しています。 **AWS CLI** **キャッシュサブネットグループを変更するには** 次の `modify-cache-subnet-group` の例では、指定されたキャッシュサブネットグループを変更します。 ``` aws elasticache modify-cache-subnet-group \ --cache-subnet-group-name kxkxk \ --cache-subnet-group-description "mygroup" ``` 出力: ``` { "CacheSubnetGroup": { "CacheSubnetGroupName": "kxkxk", "CacheSubnetGroupDescription": "mygroup", "VpcId": "vpc-xxxxcdb", "Subnets": [ { "SubnetIdentifier": "subnet-xxxxbff", "SubnetAvailabilityZone": { "Name": "us-west-2a" } } ] } } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Modifying a Subnet Group](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SubnetGroups.Modifying.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyCacheSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/modify-cache-subnet-group.html)」を参照してください。 ### `modify-global-replication-group` 次のコード例は、`modify-global-replication-group` を使用する方法を示しています。 **AWS CLI** **グローバルレプリケーショングループを変更するには** 次の `modify-global-replication-group` は、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 } } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Replication Across AWS Regions Using Global Datastore](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Redis-Global-Datastore.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyGlobalReplicationGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/modify-global-replication-group.html)」を参照してください。 ### `modify-replication-group-shard-configuration` 次のコード例は、`modify-replication-group-shard-configuration` を使用する方法を示しています。 **AWS CLI** **レプリケーショングループのシャード設定を変更するには** 次の `modify-replication-group-shard-configuration` は、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 } } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Scaling ElastiCache for Redis Clusters](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Scaling.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyReplicationGroupShardConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/modify-replication-group-shard-configuration.html)」を参照してください。 ### `modify-replication-group` 次のコード例は、`modify-replication-group` を使用する方法を説明しています。 **AWS CLI** **レプリケーショングループを変更するには** 次の `modify-replication-group` は、Redis エンジンを使用してマルチ AZ を無効にします。 ``` 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 } } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Modifying a Replication Group](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Replication.Modify.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyReplicationGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/modify-replication-group.html)」を参照してください。 ### `modify-user-group` 次のコード例は、`modify-user-group` を使用する方法を示しています。 **AWS CLI** **ユーザーグループを変更するには** 次の `modify-user-group` の例は、ユーザーをユーザーグループに追加します。 ``` aws elasticache modify-user-group \ --user-group-id myusergroup \ --user-ids-to-add user1 ``` 出力: ``` { "UserGroupId": "myusergroup", "Status": "modifying", "Engine": "redis", "UserIds": [ "default" ], "PendingChanges": { "UserIdsToAdd": [ "user1" ] }, "ReplicationGroups": [], "ARN": "arn:aws:elasticache:us-west-2:xxxxxxxxxx52:usergroup:myusergroup" } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Authenticating Users with Role-Based Access Control (RBAC)](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyUserGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/modify-user-group.html)」を参照してください。 ### `modify-user` 次のコード例は、`modify-user` を使用する方法を示しています。 **AWS CLI** ユーザーを変更するには 次の `modify-user` の例では、ユーザーのアクセス文字列を変更します。 ``` aws elasticache modify-user \ --user-id user2 \ --append-access-string "on ~* +@all" ``` 出力: ``` { "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" } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Authenticating Users with Role-Based Access Control (RBAC)](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Clusters.RBAC.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/modify-user.html)」を参照してください。 ### `purchase-reserved-cache-nodes-offering` 次のコード例は、`purchase-reserved-cache-nodes-offering` を使用する方法を示しています。 **AWS CLI** **reserved-cache-node-offering を購入するには** 次の `purchase-reserved-cache-nodes-offering` の例では、予約済みキャッシュノードサービスを購入できます。 ``` 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" } ] } } ``` 詳細については、「*ElastiCache Redis ユーザーガイド*」の「[Getting Info About Reserved Node Offerings](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/reserved-nodes-offerings.html)」または「*ElastiCache Memcached ユーザーガイド*」の「[Getting Info About Reserved Node Offerings](https://docs.aws.amazon.com/AmazonElastiCache/latest/mem-ug/reserved-nodes-offerings.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PurchaseReservedCacheNodesOffering](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/purchase-reserved-cache-nodes-offering.html)」を参照してください。 ### `reboot-cache-cluster` 次のコード例は、`reboot-cache-cluster` を使用する方法を示しています。 **AWS CLI** **キャッシュクラスターを再起動するには** 次の `reboot-cache-cluster` の例では、プロビジョニングされたクラスター内のキャッシュノードの一部またはすべてを再起動します。このオペレーションは、変更されたキャッシュパラメータグループをクラスターに適用します。再起動オペレーションはできるだけ早急に行われ、クラスターが一時停止になります。再起動中、クラスターステータスは `REBOOTING` に設定されます。 ``` aws elasticache reboot-cache-cluster \ --cache-cluster-id "my-cluster-001" \ --cache-node-ids-to-reboot "0001" ``` 出力: ``` { "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 } } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「Rebooting a Cluster」 次のコード例は、`reset-cache-parameter-group` を使用する方法を示しています。 **AWS CLI** **キャッシュパラメータグループをリセットするには** 次の `reset-cache-parameter-group` の例では、キャッシュパラメータグループのパラメータをエンジンまたはシステムのデフォルト値に変更します。パラメータ名のリストを送信することで、特定のパラメータをリセットできます。キャッシュパラメータグループ全体をリセットするには、`--reset-all-parameters` と `--cache-parameter-group-name` パラメータを指定します。 ``` aws elasticache reset-cache-parameter-group \ --cache-parameter-group-name "mygroup" \ --reset-all-parameters ``` 出力: ``` { "CacheParameterGroupName": "mygroup" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ResetCacheParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/reset-cache-parameter-group.html)」を参照してください。 ### `start-migration` 次のコード例は、`start-migration` を使用する方法を示しています。 **AWS CLI** **移行を開始するには** 次の `start-migration` は、Redis エンジンを使用して、Amazon EC2 のセルフホスト Redis から Amazon ElastiCache にデータを移行します。 ``` 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 } } ``` 詳細については、「*ElastiCache ユーザーガイド*」の「[Online Migration to ElastiCache](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/OnlineMigration.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartMigration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/start-migration.html)」を参照してください。 ### `test-failover` 次のコード例は、`test-failover` を使用する方法を示しています。 **AWS CLI** **ノードグループのフェイルオーバーをテストするには** 次の `test-failover` の例では、レプリケーショングループ (コンソールではクラスターと呼ばれる) の指定されたノードグループ (コンソールではシャードと呼ばれる) で、自動フェイルオーバーをテストします。 ``` aws elasticache test-failover / --replication-group-id "mycluster" / --node-group-id "0001" ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TestFailover](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/elasticache/test-failover.html)」を参照してください。 # AWS CLI を使用した MediaStore の例 次のコード例は、MediaStore で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-container` 次のコード例は、`create-container` を使用する方法を示しています。 **AWS CLI** **コンテナを作成するには** 次の `create-container` の例では、新しい空のコンテナを作成します。 ``` aws mediastore create-container --container-name ExampleContainer ``` 出力: ``` { "Container": { "AccessLoggingEnabled": false, "CreationTime": 1563557265, "Name": "ExampleContainer", "Status": "CREATING", "ARN": "arn:aws:mediastore:us-west-2:111122223333:container/ExampleContainer" } } ``` 詳細については、「*AWS Elemental MediaStore User Guide*」の「[Creating a Container](https://docs.aws.amazon.com/mediastore/latest/ug/containers-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateContainer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/create-container.html)」を参照してください。 ### `delete-container-policy` 次のコード例は、`delete-container-policy` を使用する方法を示しています。 **AWS CLI** **コンテナポリシーを削除するには** 次の `delete-container-policy` の例では、指定されたコンテナに割り当てられたポリシーを削除します。ポリシーが削除されると、AWS Elemental MediaStore はデフォルトのポリシーを自動的にコンテナに割り当てます。 ``` aws mediastore delete-container-policy \ --container-name LiveEvents ``` このコマンドでは何も出力されません。 詳細については、「*AWS Elemental MediaStore API reference*」の「[DeleteContainerPolicy](https://docs.aws.amazon.com/mediastore/latest/apireference/API_DeleteContainerPolicy.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteContainerPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/delete-container-policy.html)」を参照してください。 ### `delete-container` 次のコード例は、`delete-container` を使用する方法を示しています。 **AWS CLI** **コンテナを削除するには** 次の `delete-container` の例では、指定されたコンテナを削除します。コンテナにオブジェクトが含まれていない場合に限り、コンテナを削除できます。 ``` aws mediastore delete-container \ --container-name=ExampleLiveDemo ``` このコマンドでは何も出力されません。 詳細については、「*AWS Elemental MediaStore User Guide*」の「[Deleting a Container](https://docs.aws.amazon.com/mediastore/latest/ug/containers-delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteContainer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/delete-container.html)」を参照してください。 ### `delete-cors-policy` 次のコード例は、`delete-cors-policy` を使用する方法を示しています。 **AWS CLI** **CORS ポリシーを削除するには** 次の `delete-cors-policy` の例では、指定されたコンテナに割り当てられたクロスオリジンリソース共有 (CORS) ポリシーを削除します。 ``` aws mediastore delete-cors-policy \ --container-name ExampleContainer ``` このコマンドでは何も出力されません。 詳細については、「*AWS Elemental MediaStore User Guide*」の「[Deleting a CORS Policy](https://docs.aws.amazon.com/mediastore/latest/ug/cors-policy-deleting.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCorsPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/delete-cors-policy.html)」を参照してください。 ### `delete-lifecycle-policy` 次のコード例は、`delete-lifecycle-policy` を使用する方法を示しています。 **AWS CLI** **オブジェクトのライフサイクルポリシーを削除するには** 次の `delete-lifecycle-policy` の例では、指定されたコンテナにアタッチされたオブジェクトライフサイクルポリシーを削除します。この変更が有効になるまでに、最大 20 分かかります。 ``` aws mediastore delete-lifecycle-policy \ --container-name LiveEvents ``` このコマンドでは何も出力されません。 詳細については、「*AWS Elemental MediaStore User Guide*」の「[Deleting an Object Lifecycle Policy](https://docs.aws.amazon.com/mediastore/latest/ug/policies-object-lifecycle-delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteLifecyclePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/delete-lifecycle-policy.html)」を参照してください。 ### `describe-container` 次のコード例は、`describe-container` を使用する方法を示しています。 **AWS CLI** **コンテナの詳細を表示するには** 次の `describe-container` の例では、指定されたコンテナの詳細を表示します。 ``` aws mediastore describe-container \ --container-name ExampleContainer ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Elemental MediaStore User Guide*」の「[Viewing the Details for a Container](https://docs.aws.amazon.com/mediastore/latest/ug/containers-view-details.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeContainer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/describe-container.html)」を参照してください。 ### `describe-object` 次のコード例は、`describe-object` を使用する方法を示しています。 **AWS CLI** **特定のコンテナに含まれているオブジェクトとフォルダのリストを表示するには** 次の `describe-object` の例では、特定のコンテナに保存されている項目 (オブジェクトとフォルダ) を表示します。 ``` aws mediastore-data describe-object \ --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ --path /folder_name/file1234.jpg ``` 出力: ``` { "ContentType": "image/jpeg", "LastModified": "Fri, 19 Jul 2019 21:32:20 GMT", "ContentLength": "2307346", "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3" } ``` 詳細については、「*AWS Elemental MediaStore User Guide*」の「[Viewing the Details of an Object](https://docs.aws.amazon.com/mediastore/latest/ug/objects-view-details.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeObject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/describe-object.html)」を参照してください。 ### `get-container-policy` 次のコード例は、`get-container-policy` を使用する方法を示しています。 **AWS CLI** **コンテナポリシーを表示するには** 次の `get-container-policy` の例では、指定されたコンテナのリソースベースのポリシーを表示します。 ``` aws mediastore get-container-policy \ --container-name ExampleLiveDemo ``` 出力: ``` { "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" } } } ] } } ``` 詳細については、「*AWS Elemental MediaStore User Guide*」の「[Viewing a Container Policy](https://docs.aws.amazon.com/mediastore/latest/ug/policies-view.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetContainerPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/get-container-policy.html)」を参照してください。 ### `get-cors-policy` 次のコード例は、`get-cors-policy` を使用する方法を示しています。 **AWS CLI** **CORS ポリシーを表示するには** 次の `get-cors-policy` の例では、指定されたコンテナに割り当てられたクロスオリジンリソース共有 (CORS) ポリシーを表示します。 ``` aws mediastore get-cors-policy \ --container-name ExampleContainer \ --region us-west-2 ``` 出力: ``` { "CorsPolicy": [ { "AllowedMethods": [ "GET", "HEAD" ], "MaxAgeSeconds": 3000, "AllowedOrigins": [ "" ], "AllowedHeaders": [ "" ] } ] } ``` 詳細については、「*AWS Elemental MediaStore User Guide*」の「[Viewing a CORS Policy](https://docs.aws.amazon.com/mediastore/latest/ug/cors-policy-viewing.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetCorsPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/get-cors-policy.html)」を参照してください。 ### `get-lifecycle-policy` 次のコード例は、`get-lifecycle-policy` を使用する方法を示しています。 **AWS CLI** **オブジェクトのライフサイクルポリシーを表示するには** 次の `get-lifecycle-policy` の例では、指定されたコンテナにアタッチされたオブジェクトライフサイクルポリシーを表示します。 ``` aws mediastore get-lifecycle-policy \ --container-name LiveEvents ``` 出力: ``` { "LifecyclePolicy": { "rules": [ { "definition": { "path": [ { "prefix": "Football/" }, { "prefix": "Baseball/" } ], "days_since_create": [ { "numeric": [ ">", 28 ] } ] }, "action": "EXPIRE" } ] } } ``` 詳細については、「*AWS Elemental MediaStore User Guide*」の「[Viewing an Object Lifecycle Policy](https://docs.aws.amazon.com/mediastore/latest/ug/policies-object-lifecycle-view.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetLifecyclePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/get-lifecycle-policy.html)」を参照してください。 ### `get-object` 次のコード例は、`get-object` を使用する方法を示しています。 **AWS CLI** **オブジェクトをダウンロードするには** 次の `get-object` の例では、指定されたエンドポイントにオブジェクトをダウンロードします。 ``` aws mediastore-data get-object \ --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ --path=/folder_name/README.md README.md ``` 出力: ``` { "ContentLength": "2307346", "ContentType": "image/jpeg", "LastModified": "Fri, 19 Jul 2019 21:32:20 GMT", "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3", "StatusCode": 200 } ``` **オブジェクトの一部をダウンロードするには** 次の `get-object` の例では、指定されたエンドポイントにオブジェクトの一部をダウンロードします。 ``` 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 ``` 出力: ``` { "StatusCode": 206, "ContentRange": "bytes 0-100/2307346", "ContentLength": "101", "LastModified": "Fri, 19 Jul 2019 21:32:20 GMT", "ContentType": "image/jpeg", "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3" } ``` 詳細については、「*AWS Elemental MediaStore User Guide*」の「[Downloading an Object](https://docs.aws.amazon.com/mediastore/latest/ug/objects-download.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[GetObject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/get-object.html)」を参照してください。** ### `list-containers` 次のコード例は、`list-containers` を使用する方法を示しています。 **AWS CLI** **コンテナのリストを表示するには** 次の `list-containers` の例では、アカウントに関連付けられているすべてのコンテナのリストを表示します。 ``` aws mediastore list-containers ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS Elemental MediaStore User Guide*」の「[Viewing a List of Containers](https://docs.aws.amazon.com/mediastore/latest/ug/containers-view-list.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListContainers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/list-containers.html)」を参照してください。 ### `list-items` 次のコード例は、`list-items` を使用する方法を示しています。 **AWS CLI** **例 1: 特定のコンテナに含まれているオブジェクトとフォルダのリストを表示するには** 次の `list-items` の例では、指定されたコンテナに保存されている項目 (オブジェクトとフォルダ) を表示します。 ``` aws mediastore-data list-items \ --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com ``` 出力: ``` { "Items": [ { "ContentType": "image/jpeg", "LastModified": 1563571859.379, "Name": "filename.jpg", "Type": "OBJECT", "ETag": "543ab21abcd1a234ab123456a1a2b12345ab12abc12a1234abc1a2bc12345a12", "ContentLength": 3784 }, { "Type": "FOLDER", "Name": "ExampleLiveDemo" } ] } ``` **例 2: 特定のフォルダに含まれているオブジェクトとフォルダのリストを表示するには** 次の `list-items` の例では、特定のフォルダに保存されている項目 (オブジェクトとフォルダ) を表示します。 ``` aws mediastore-data list-items \ --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com ``` 出力: ``` { "Items": [ { "ContentType": "image/jpeg", "LastModified": 1563571859.379, "Name": "filename.jpg", "Type": "OBJECT", "ETag": "543ab21abcd1a234ab123456a1a2b12345ab12abc12a1234abc1a2bc12345a12", "ContentLength": 3784 }, { "Type": "FOLDER", "Name": "ExampleLiveDemo" } ] } ``` 詳細については、「*AWS Elemental MediaStore User Guide*」の「[Viewing a List of Objects](https://docs.aws.amazon.com/mediastore/latest/ug/objects-view-list.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListItems](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/list-items.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **コンテナのタグを一覧表示するには** 次の `list-tags-for-resource` の例では、指定されたコンテナに割り当てられたタグキーと値を表示します。 ``` aws mediastore list-tags-for-resource \ --resource arn:aws:mediastore:us-west-2:1213456789012:container/ExampleContainer ``` 出力: ``` { "Tags": [ { "Value": "Test", "Key": "Environment" }, { "Value": "West", "Key": "Region" } ] } ``` 詳細については、「*AWS Elemental MediaStore API Reference*」の「[ListTagsForResource](https://docs.aws.amazon.com/mediastore/latest/apireference/API_ListTagsForResource.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/list-tags-for-resource.html)」を参照してください。 ### `put-container-policy` 次のコード例は、`put-container-policy` を使用する方法を示しています。 **AWS CLI** **コンテナポリシーを編集するには** 次の `put-container-policy` の例では、指定されたコンテナに異なるポリシーを割り当てます。この例では、更新されたポリシーが `LiveEventsContainerPolicy.json` という名前のファイルで定義されます。 ``` aws mediastore put-container-policy \ --container-name LiveEvents \ --policy file://LiveEventsContainerPolicy.json ``` このコマンドでは何も出力されません。 詳細については、「*AWS Elemental MediaStore User Guide*」の「[Editing a Container Policy](https://docs.aws.amazon.com/mediastore/latest/ug/policies-edit.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutContainerPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/put-container-policy.html)」を参照してください。 ### `put-cors-policy` 次のコード例は、`put-cors-policy` を使用する方法を示しています。 **AWS CLI** **例 1: CORS ポリシーを追加するには** 次の `put-cors-policy` の例では、指定されたコンテナにクロスオリジンリソース共有 (CORS) ポリシーを追加します。CORS ポリシーの内容は、`corsPolicy.json` という名前のファイルにあります。 ``` aws mediastore put-cors-policy \ --container-name ExampleContainer \ --cors-policy file://corsPolicy.json ``` このコマンドでは何も出力されません。 詳細については、「*AWS Elemental MediaStore User Guide*」の「[Adding a CORS Policy to a Container](https://docs.aws.amazon.com/mediastore/latest/ug/cors-policy-adding.html)」を参照してください。 **例 2: CORS ポリシーを編集するには** 次の `put-cors-policy` の例では、指定されたコンテナに割り当てられたクロスオリジンリソース共有 (CORS) ポリシーを更新します。更新された CORS ポリシーの内容は、`corsPolicy2.json` という名前のファイルにあります。 詳細については、「*AWS Elemental MediaStore User Guide*」の「[Editing a CORS Policy](https://docs.aws.amazon.com/mediastore/latest/ug/cors-policy-editing.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutCorsPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/put-cors-policy.html)」を参照してください。 ### `put-lifecycle-policy` 次のコード例は、`put-lifecycle-policy` を使用する方法を示しています。 **AWS CLI** **オブジェクトのライフサイクルポリシーを作成するには** 次の `put-lifecycle-policy` の例では、指定されたコンテナにオブジェクトライフサイクルポリシーをアタッチします。これにより、サービスがコンテナにオブジェクトを保存すべき期間を指定できます。MediaStore は、`LiveEventsLifecyclePolicy.json` という名前のファイルにあるポリシーに示されているように、有効期限に達するとコンテナ内のオブジェクトを削除します。 ``` aws mediastore put-lifecycle-policy \ --container-name ExampleContainer \ --lifecycle-policy file://ExampleLifecyclePolicy.json ``` このコマンドでは何も出力されません。 詳細については、「*AWS Elemental MediaStore User Guide*」の「[Adding an Object Lifecycle Policy to a Container](https://docs.aws.amazon.com/mediastore/latest/ug/policies-object-lifecycle-add.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutLifecyclePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/put-lifecycle-policy.html)」を参照してください。 ### `put-object` 次のコード例は、`put-object` を使用する方法を示しています。 **AWS CLI** **オブジェクトをアップロードするには** 次の `put-object` の例では、指定されたコンテナにオブジェクトをアップロードします。オブジェクトをコンテナ内に保存するフォルダパスを指定できます。フォルダが既に存在する場合、AWS Elemental MediaStore はそのフォルダにオブジェクトを保存します。フォルダが存在しない場合は、フォルダが自動的に作成されて、そのフォルダにオブジェクトが保存されます。 ``` 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 ``` 出力: ``` { "ContentSHA256": "74b5fdb517f423ed750ef214c44adfe2be36e37d861eafe9c842cbe1bf387a9d", "StorageClass": "TEMPORAL", "ETag": "af3e4731af032167a106015d1f2fe934e68b32ed1aa297a9e325f5c64979277b" } ``` 詳細については、「*AWS Elemental MediaStore User Guide*」の「[Uploading an Object](https://docs.aws.amazon.com/mediastore/latest/ug/objects-upload.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutObject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/put-object.html)」を参照してください。 ### `start-access-logging` 次のコード例は、`start-access-logging` を使用する方法を示しています。 **AWS CLI** **コンテナでアクセスログ記録を有効にするには** 次の `start-access-logging` の例では、指定されたコンテナでアクセスログ記録を有効にします。 ``` aws mediastore start-access-logging \ --container-name LiveEvents ``` このコマンドでは何も出力されません。 詳細については、「*AWS Elemental MediaStore User Guide*」の「[Enabling Access Logging for a Container](https://docs.aws.amazon.com/mediastore/latest/ug/monitoring-cloudwatch-logs-enable.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartAccessLogging](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/start-access-logging.html)」を参照してください。 ### `stop-access-logging` 次のコード例は、`stop-access-logging` を使用する方法を示しています。 **AWS CLI** **コンテナでアクセスログ記録を無効にするには** 次の `stop-access-logging` の例では、指定されたコンテナでアクセスログ記録を無効にします。 ``` aws mediastore stop-access-logging \ --container-name LiveEvents ``` このコマンドでは何も出力されません。 詳細については、「*AWS Elemental MediaStore User Guide*」の「[Disabling Access Logging for a Container](https://docs.aws.amazon.com/mediastore/latest/ug/monitoring-cloudwatch-logs-disable.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopAccessLogging](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/stop-access-logging.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **コンテナにタグを追加するには** 次の `tag-resource` の例では、指定されたコンテナにタグキーと値を追加します。 ``` aws mediastore tag-resource \ --resource arn:aws:mediastore:us-west-2:123456789012:container/ExampleContainer \ --tags '[{"Key": "Region", "Value": "West"}, {"Key": "Environment", "Value": "Test"}]' ``` このコマンドでは何も出力されません。 詳細については、「*AWS Elemental MediaStore API Reference*」の「[TagResource](https://docs.aws.amazon.com/mediastore/latest/apireference/API_TagResource.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **コンテナからタグを削除するには** 次の `untag-resource` の例では、指定されたタグキーとその関連付けられた値をコンテナから削除します。 ``` aws mediastore untag-resource \ --resource arn:aws:mediastore:us-west-2:123456789012:container/ExampleContainer \ --tag-keys Region ``` このコマンドでは何も出力されません。 詳細については、「*AWS Elemental MediaStore API Reference*」の「[UntagResource](https://docs.aws.amazon.com/mediastore/latest/apireference/API_UntagResource.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore/untag-resource.html)」を参照してください。 # AWS CLI を使用した Amazon EMR の例 次のコード例は、Amazon EMR で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `add-instance-fleet` 次のコード例は、`add-instance-fleet` を使用する方法を示しています。 **AWS CLI** **タスクインスタンスフリートをクラスターに追加するには** この例では、指定されたクラスターに新しいタスクインスタンスフリートを追加します。 コマンド: ``` 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}'] ``` 出力: ``` { "ClusterId": "j-12ABCDEFGHI34JK", "InstanceFleetId": "if-23ABCDEFGHI45JJ" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddInstanceFleet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/add-instance-fleet.html)」を参照してください。 ### `add-steps` 次のコード例は、`add-steps` を使用する方法を示しています。 **AWS CLI** **1. クラスターにカスタム JAR ステップを追加するには** コマンド: ``` 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 ``` 必須パラメータ: ``` Jar ``` 任意指定のパラメータ: ``` Type, Name, ActionOnFailure, Args ``` 出力: ``` { "StepIds":[ "s-XXXXXXXX", "s-YYYYYYYY" ] } ``` **2. ストリーミングステップをクラスターに追加するには** コマンド: ``` 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] ``` 必須パラメータ: ``` Type, Args ``` 任意指定のパラメータ: ``` Name, ActionOnFailure ``` JSON と同等のもの (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" } ] ``` 注: JSON 引数には、リスト内の独自の項目としてオプションと値を含める必要があります。 コマンド (step.json を使用): ``` aws emr add-steps --cluster-id j-XXXXXXXX --steps file://./step.json ``` 出力: ``` { "StepIds":[ "s-XXXXXXXX", "s-YYYYYYYY" ] } ``` **3. 複数のファイルを含むストリーミングステップをクラスターに追加するには (JSON のみ)** JSON (multiplefiles.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"] } ] ``` コマンド: ``` aws emr add-steps --cluster-id j-XXXXXXXX --steps file://./multiplefiles.json ``` 必須パラメータ: ``` Type, Args ``` 任意指定のパラメータ: ``` Name, ActionOnFailure ``` 出力: ``` { "StepIds":[ "s-XXXXXXXX", ] } ``` **4. クラスターに Hive ステップを追加するには** コマンド: ``` 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] ``` 必須パラメータ: ``` Type, Args ``` 任意指定のパラメータ: ``` Name, ActionOnFailure ``` 出力: ``` { "StepIds":[ "s-XXXXXXXX", "s-YYYYYYYY" ] } ``` **5. クラスターに Pig ステップを追加するには** コマンド: ``` 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] ``` 必須パラメータ: ``` Type, Args ``` 任意指定のパラメータ: ``` Name, ActionOnFailure ``` 出力: ``` { "StepIds":[ "s-XXXXXXXX", "s-YYYYYYYY" ] } ``` **6. Impala ステップをクラスターに追加するには** コマンド: ``` 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 ``` 必須パラメータ: ``` Type, Args ``` 任意指定のパラメータ: ``` Name, ActionOnFailure ``` 出力: ``` { "StepIds":[ "s-XXXXXXXX", "s-YYYYYYYY" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddSteps](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/add-steps.html)」を参照してください。 ### `add-tags` 次のコード例は、`add-tags` を使用する方法を示しています。 **AWS CLI** **1. クラスターにタグを追加するには** コマンド: ``` aws emr add-tags --resource-id j-xxxxxxx --tags name="John Doe" age=29 sex=male address="123 East NW Seattle" ``` 出力: ``` None ``` **2. クラスターのタグを一覧表示するには** --コマンド: ``` aws emr describe-cluster --cluster-id j-XXXXXXYY --query Cluster.Tags ``` 出力: ``` [ { "Value": "male", "Key": "sex" }, { "Value": "123 East NW Seattle", "Key": "address" }, { "Value": "John Doe", "Key": "name" }, { "Value": "29", "Key": "age" } ] ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/add-tags.html)」を参照してください。 ### `create-cluster-examples` 次のコード例は、`create-cluster-examples` を使用する方法を示しています。 **AWS CLI** 次の例のほとんどは、Amazon EMR サービスロールと Amazon EC2 インスタンスプロファイルを指定していることを前提としています。これを行っていない場合は、必要な各 IAM ロールを指定するか、クラスターの作成時に `--use-default-roles` パラメータを使用する必要があります。IAM ロールの指定に関する詳細については、「*Amazon EMR 管理ガイド*」の「[AWS サービスに Amazon EMR アクセス許可の IAM ロールを設定する](https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-iam-roles.html)」を参照してください。 **例 1: クラスターを作成するには** 以下の `create-cluster` の例は、シンプルな EMR クラスターを作成します。 ``` aws emr create-cluster \ --release-label emr-5.14.0 \ --instance-type m4.large \ --instance-count 2 ``` このコマンドでは何も出力されません。 **例 2: デフォルトの ServiceRole ロールと InstanceProfile ロールを使用して Amazon EMR クラスターを作成するには** 次の `create-cluster` の例では、`--instance-groups` 設定を使用する Amazon EMR クラスターを作成します。 ``` 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 ``` **例 3: インスタンスフリートを使用する Amazon EMR クラスターを作成するには** 次の `create-cluster` の例では、`--instance-fleets` 設定を使用する Amazon EMR クラスターを作成し、フリートごとに 2 つのインスタンスタイプと 2 つの 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}'} ``` **例 4: デフォルトロールを使用してクラスターを作成するには** 次の `create-cluster` 例では、`--use-default-roles` パラメータを使用して、デフォルトのサービスロールとインスタンスプロファイルを指定します。 ``` 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 ``` **例 5: クラスターを作成し、インストールするアプリケーションを指定するには** 次の `create-cluster` の例では、`--applications` パラメータを使用して、Amazon EMR がインストールするアプリケーションを指定します。この例では、Hadoop、Hive、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 ``` **例 6: Spark を含むクラスターを作成するには** 次の例では、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 ``` **例 7: クラスターインスタンスに使用するカスタム AMI を指定するには** 次の `create-cluster` の例では、ID `ami-a518e6df` を持つ Amazon Linux AMI に基づいてクラスターインスタンスを作成します。 ``` 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 ``` **例 8: アプリケーション設定をカスタマイズするには** 次の例では、`--configurations` パラメータを使用して、Hadoop のアプリケーションのカスタマイズを含む JSON 設定ファイルを指定します。詳細については、*Amazon EMR リリースガイド*の「[アプリケーションの設定](https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-configure-apps.html)」を参照してください。 `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" } } ] } ] ``` 以下の例では、ローカルファイルとして `configurations.json` を参照します。 ``` 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 ``` 次の例では、Amazon S3 のファイルとして `configurations.json` を参照します。 ``` 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 ``` **例 9: マスター、コア、タスクインスタンスグループを使用してクラスターを作成するには** 次の `create-cluster` の例では、`--instance-groups` を使用して、マスター、コア、タスクインスタンスグループに使用する EC2 インスタンスのタイプと数を指定します。 ``` 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 ``` **例 10: すべてのステップを完了した後にクラスターを終了するように指定するには** 次の `create-cluster` 例では、`--auto-terminate` を使用して、すべてのステップを完了した後にクラスターを自動的にシャットダウンするように指定します。 ``` 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 ``` **例 11: Amazon EC2 キーペア、ネットワーク設定、セキュリティグループなどのクラスター設定の詳細を指定するには** 次の `create-cluster` の例では、`myKey` という名前の Amazon EC2 キーペアと `myProfile` という名前のカスタマイズされたインスタンスプロファイルを持つクラスターを作成します。キーペアは、クラスターノード、ほとんどの場合プライマリノードへの SSH 接続を承認するために使用されます。詳細は、「*Amazon EMR 管理ガイド*」の「[SSH 認証情報に EC2 キーペアを使用する](https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-plan-access-ssh.html)」を参照してください。 ``` 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 ``` 次の例では、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 ``` 次の例では、`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 ``` 次の例では、クラスターを作成し、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 ``` 次の例では、クラスターを作成し、追加の 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 ``` 次の例では、クラスターを作成し、EMR マネージドセキュリティグループと追加のセキュリティグループを指定します。 ``` 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 ``` 次の例では、VPC プライベートサブネットにクラスターを作成し、特定の Amazon EC2 セキュリティグループを使用して Amazon EMR サービスアクセスを有効にします。これは、プライベートサブネットのクラスターに必要です。 ``` 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 ``` 次の例では、ローカルに保存されている `ec2_attributes.json` という名前の JSON ファイルを使用してセキュリティグループ設定パラメータを指定します。注: JSON 引数には、リスト内の独自の項目としてオプションと値を含める必要があります。 ``` 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 ``` `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"] } ] ``` **例 12: デバッグを有効にしてログ URI を指定するには** 次の `create-cluster` の例では、`--enable-debugging` パラメータを使用しており、Amazon EMR コンソールのデバッグツールを使用してログファイルをより簡単に表示できます。`--log-uri` パラメータは `--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 ``` **例 13: クラスターの作成時にタグを追加するには** タグは、クラスターの特定と管理に役立つキーと値のペアです。次の `create-cluster` の例では、`--tags` パラメータを使用してクラスターに 3 つのタグを作成します。1 つ目はキー名 `name` と値 `Shirley Rodriguez`、2 つ目はキー名 `age` と値 `29`、3 つ目のタグはキー名 `department` と値 `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 ``` 次の例では、クラスターに適用されるタグを一覧表示します。 ``` aws emr describe-cluster \ --cluster-id j-XXXXXXYY \ --query Cluster.Tags ``` **例 14: 暗号化やその他のセキュリティ機能を有効にするセキュリティ設定を使用するには** 次の `create-cluster` の例では、`--security-configuration` パラメータを使用して EMR クラスターのセキュリティ設定を指定します。Amazon EMR バージョン 4.8.0 以降では、セキュリティ設定を使用できます。 ``` aws emr create-cluster \ --instance-type m4.large \ --release-label emr-5.9.0 \ --security-configuration mySecurityConfiguration ``` **例 15: インスタンスグループに設定された追加の EBS ストレージボリュームを持つクラスターを作成するには** 追加の EBS ボリュームを指定する場合は、次の引数が必要です。`EbsBlockDeviceConfigs` が指定されている場合、`VolumeType`、`SizeInGB`。 次の `create-cluster` の例では、コアインスタンスグループの EC2 インスタンスに複数の EBS ボリュームがアタッチされたクラスターを作成します。 ``` 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 ``` 次の例では、マスターインスタンスグループの EC2 インスタンスに複数の EBS ボリュームがアタッチされたクラスターを作成します。 ``` 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 ``` **例 16: 自動スケーリングポリシーを使用してクラスターを作成するには** Amazon EMR バージョン 4.0 以降を使用して、コアインスタンスグループとタスクインスタンスグループに自動スケーリングポリシーをアタッチできます。自動スケーリングポリシーは、Amazon CloudWatch メトリクスに応答して EC2 インスタンスを動的に追加および削除します。詳細については、「*Amazon EMR 管理ガイド*」の「Amazon EMR で自動スケーリングを使用する `\$1」を参照してください。 自動スケーリングポリシーをアタッチする場合は、`--auto-scaling-role EMR_AutoScaling_DefaultRole` を使用して自動スケーリングのデフォルトロールを指定する必要があります。 次の `create-cluster` の例では、スケーリングポリシー設定を指定する JSON 構造が埋め込まれた `AutoScalingPolicy` 引数を使用して、`CORE` インスタンスグループの自動スケーリングポリシーを指定します。JSON 構造が埋め込まれたインスタンスグループには、引数のコレクション全体が一重引用符で囲まれている必要があります。JSON 構造が埋め込まれていないインスタンスグループでは、単一引用符の使用はオプションです。 ``` 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}]}}}]}' ``` 次の例では、JSON ファイルの `instancegroupconfig.json` を使用して、クラスター内のすべてのインスタンスグループの設定を指定します。JSON ファイルは、コアインスタンスグループの自動スケーリングポリシー設定を指定します。 ``` 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 ``` `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}" } ] } } } ] } } ] ``` **例 17: クラスターを作成するときにカスタム JAR ステップを追加する** 次の `create-cluster` の例では、Amazon S3 に保存されている JAR ファイルを指定してステップを追加します。ステップではクラスターに作業を送信します。JAR ファイルで定義されたメイン関数は、EC2 インスタンスがプロビジョニングされ、ブートストラップアクションが実行され、アプリケーションがインストールされた後に実行されます。これらのステップは `Type=CUSTOM_JAR` を使用して指定します。 カスタム JAR ステップには、JAR のパスとファイル名を指定する `Jar=` パラメータが必要です。オプションのパラメータは、`Type`、`Name`、`Args`、`ActionOnFailure`、および `MainClass` です。メインクラスを指定しない場合、JAR ファイルはマニフェストファイルで `Main-Class` を指定する必要があります。 ``` 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 ``` **例 18: クラスターの作成時にストリーミングステップを追加するには** 次の `create-cluster` の例では、すべてのステップの実行後に終了するストリーミングステップをクラスターに追加します。ストリーミングステップにはパラメータ `Type` と `Args` が必要です。ストリーミングステップのオプションパラメータは `Name` および `ActionOnFailure` です。 次の例はステップインラインを指定します。 ``` 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 ``` 次の例では、`multiplefiles.json` という名前のローカルに保存された JSON 設定ファイルを使用します。JSON 設定では、複数のファイルを指定します。ステップ内で複数のファイルを指定するには、JSON 設定ファイルを使用してステップを指定する必要があります。JSON 引数には、リスト内の独自の項目としてオプションと値を含める必要があります。 ``` 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 ``` `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" } ] ``` **例 19: クラスターの作成時に Hive ステップを追加するには** 次の例では、クラスターを作成するときに Hive ステップを追加します。Hive ステップには、パラメータ `Type` と `Args` が必要です。Hive ステップのオプションパラメータは `Name` と `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 ``` **例 20: クラスターの作成時に Pig ステップを追加するには** 次の例では、クラスターを作成するときに Pig ステップを追加します。Pig ステップに必要なパラメータは `Type` と `Args` です。Pig ステップのオプションパラメータは `Name` と `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 ``` **例 21: ブートストラップアクションを追加するには** 次の `create-cluster` の例では、Amazon S3 に保存されているスクリプトとして定義された 2 つのブートストラップアクションを実行します。 ``` 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 ``` **例 22: EMRFS の一貫性のあるビューを有効にし、RetryCount と RetryPeriod の設定をカスタマイズするには** 次の `create-cluster` の例では、EMRFS の一貫性のあるビューの再試行回数と再試行期間を指定します。`Consistent=true` 引数が必要です。 ``` aws emr create-cluster \ --instance-type m4.large \ --release-label emr-5.9.0 \ --emrfs Consistent=true,RetryCount=6,RetryPeriod=30 ``` 次の例では、`emrfsconfig.json` という名前のローカルに保存された JSON 設定ファイルを使用して、前の例と同じ EMRFS 設定を指定します。 ``` aws emr create-cluster \ --instance-type m4.large \ --release-label emr-5.9.0 \ --emrfs file://emrfsconfig.json ``` `emrfsconfig.json` の内容: ``` { "Consistent": true, "RetryCount": 6, "RetryPeriod": 30 } ``` **例 23: Kerberos が設定されたクラスターを作成するには** 次の `create-cluster` の例では、Kerberos を有効にしたセキュリティ設定を使用してクラスターを作成し、`--kerberos-attributes` を使用してクラスターの Kerberos パラメータを確立します。 次のコマンドは、クラスターの Kerberos 属性をインラインで指定します。 ``` 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 ``` 次のコマンドは同じ属性を指定しますが、`kerberos_attributes.json` という名前のローカルに保存された JSON ファイルを参照します。この例では、ファイルはコマンドを実行するディレクトリに保存されます。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 ``` `kerberos_attributes.json` の内容: ``` { "Realm": "EC2.INTERNAL", "KdcAdminPassword": "123", "CrossRealmTrustPrincipalPassword": "123", } ``` 次の `create-cluster` の例では、`--instance-groups` 設定を使用し、マネージドスケーリングポリシーを持つ Amazon EMR クラスターを作成します。 ``` 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}' ``` 次の `create-cluster` の例では、「--log-encryption-kms-key-id」を使用して、ログ暗号化に使用される KMS キー ID を定義する Amazon EMR クラスターを作成します。 ``` 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 ``` 次の `create-cluster` の例では、「-placement-group-configs」設定を使用して、`SPREAD` プレイスメント戦略を使用して EC2 プレイスメントグループ内の高可用性 (HA) クラスターにプライマリノードを配置する Amazon EMR クラスターを作成します。 ``` 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 ``` 次の `create-cluster` の例では、「--auto-termination-policy」設定を使用してクラスターの自動アイドル終了しきい値を配置する Amazon EMR クラスターを作成します。 ``` 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 ``` 次の `create-cluster` の例では、「--os-release-label」を使用してクラスター起動用の Amazon Linux リリースを定義する Amazon EMR クラスターを作成します。 ``` 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 ``` **例 24: EMR リリース 6.15.0 以降で作成されたクラスターインスタンスのサイズ、iops、スループットの EBS ルートボリューム属性を指定するには** 次の `create-cluster` の例では、ルートボリューム属性を使用して EC2 インスタンスのルートボリューム仕様を設定する Amazon EMR クラスターを作成します。 ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateClusterExamples](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/create-cluster-examples.html)」を参照してください。 ### `create-default-roles` 次のコード例は、`create-default-roles` を使用する方法を示しています。 **AWS CLI** **1. EC2 のデフォルトの IAM ロールを作成するには** コマンド: ``` aws emr create-default-roles ``` 出力: ``` 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" } } ] ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDefaultRoles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/create-default-roles.html)」を参照してください。 ### `create-security-configuration` 次のコード例は、`create-security-configuration` を使用する方法を示しています。 **AWS CLI** **1. 証明書プロバイダーの PEM で転送中の暗号化を有効にし、SSE-S3 で S3 暗号化を有効にし、ローカルディスクキープロバイダーの AWS-KMS で保管時の S3 暗号化を有効にしたセキュリティ設定を作成するには** コマンド: ``` 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" } } } }' ``` 出力: ``` { "CreationDateTime": 1474070889.129, "Name": "MySecurityConfig" } ``` JSON と同等のもの (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" } } } } ``` コマンド (security\$1configuration.json を使用): ``` aws emr create-security-configuration --name "MySecurityConfig" --security-configuration file://./security_configuration.json ``` 出力: ``` { "CreationDateTime": 1474070889.129, "Name": "MySecurityConfig" } ``` **2. クラスター専用 KDC とクロスレルム信頼を使用して Kerberos を有効にしてセキュリティ設定を作成するには** コマンド: ``` 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" } } } } }' ``` 出力: ``` { "CreationDateTime": 1490225558.982, "Name": "MySecurityConfig" } ``` JSON と同等のもの (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" } } } } } ``` コマンド (security\$1configuration.json を使用): ``` aws emr create-security-configuration --name "MySecurityConfig" --security-configuration file://./security_configuration.json ``` 出力: ``` { "CreationDateTime": 1490225558.982, "Name": "MySecurityConfig" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateSecurityConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/create-security-configuration.html)」を参照してください。 ### `delete-security-configuration` 次のコード例は、`delete-security-configuration` を使用する方法を示しています。 **AWS CLI** **現在のリージョンのセキュリティ設定を削除するには** コマンド: ``` aws emr delete-security-configuration --name MySecurityConfig ``` 出力: ``` None ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteSecurityConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/delete-security-configuration.html)」を参照してください。 ### `describe-cluster` 次のコード例は、`describe-cluster` を使用する方法を示しています。 **AWS CLI** コマンド: ``` aws emr describe-cluster --cluster-id j-XXXXXXXX ``` 出力: ``` 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" } } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/describe-cluster.html)」を参照してください。** ### `describe-step` 次のコード例は、`describe-step` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、クラスター ID `j-3SD91U2E1L2QX` を持つクラスターでステップ ID `s-3LZC0QUT43AM` を持つステップを記述します。 ``` aws emr describe-step --cluster-id j-3SD91U2E1L2QX --step-id s-3LZC0QUT43AM ``` 出力: ``` { "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" } } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeStep](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/describe-step.html)」を参照してください。** ### `get` 次のコード例は、`get` を使用する方法を示しています。 **AWS CLI** 次は、クラスター ID `j-3SD91U2E1L2QX` を持つクラスター内のマスターインスタンスから `hadoop-examples.jar` アーカイブをダウンロードします。 ``` aws emr get --cluster-id j-3SD91U2E1L2QX --key-pair-file ~/.ssh/mykey.pem --src /home/hadoop-examples.jar --dest ~ ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[Get](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/get.html)」を参照してください。 ### `list-clusters` 次のコード例は、`list-clusters` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、現在のリージョン内のすべてのアクティブな EMR クラスターを一覧表示します。 ``` aws emr list-clusters --active ``` 出力: ``` { "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" } ] } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[ListClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/list-clusters.html)」を参照してください。** ### `list-instance-fleets` 次のコード例は、`list-instance-fleets` を使用する方法を示しています。 **AWS CLI** **クラスター内のインスタンスフリートの設定情報を取得するには** この例では、指定されたクラスター内のインスタンスフリートの詳細を一覧表示します。 コマンド: ``` list-instance-fleets --cluster-id 'j-12ABCDEFGHI34JK' ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListInstanceFleets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/list-instance-fleets.html)」を参照してください。 ### `list-instances` 次のコード例は、`list-instances` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、クラスター ID `j-3C6XNQ39VR9WL` を持つクラスターのすべてのインスタンスを一覧表示します。 ``` aws emr list-instances --cluster-id j-3C6XNQ39VR9WL ``` 出力: ``` 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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/list-instances.html)」を参照してください。 ### `list-security-configurations` 次のコード例は、`list-security-configurations` を使用する方法を示しています。 **AWS CLI** **現在のリージョンのセキュリティ設定を一覧表示するには** コマンド: ``` aws emr list-security-configurations ``` 出力: ``` { "SecurityConfigurations": [ { "CreationDateTime": 1473889697.417, "Name": "MySecurityConfig-1" }, { "CreationDateTime": 1473889697.417, "Name": "MySecurityConfig-2" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListSecurityConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/list-security-configurations.html)」を参照してください。 ### `list-steps` 次のコード例は、`list-steps` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、クラスター ID `j-3SD91U2E1L2QX` を持つクラスターのすべてのステップを一覧表示します。 ``` aws emr list-steps --cluster-id j-3SD91U2E1L2QX ``` + API の詳細については、AWS CLI コマンドリファレンスの「[ListSteps](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/list-steps.html)」を参照してください。** ### `modify-cluster-attributes` 次のコード例は、`modify-cluster-attributes` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、ID `j-301CDNY0J5XM4` の EMR クラスターの可視性をすべてのユーザーに設定します。 ``` aws emr modify-cluster-attributes --cluster-id j-301CDNY0J5XM4 --visible-to-all-users ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyClusterAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/modify-cluster-attributes.html)」を参照してください。 ### `modify-instance-fleet` 次のコード例は、`modify-instance-fleet` を使用する方法を示しています。 **AWS CLI** **インスタンスフリートのターゲット容量を変更するには** この例では、指定されたインスタンスフリートのオンデマンドおよびスポットターゲット容量を 1 に変更します。 コマンド: ``` aws emr modify-instance-fleet --cluster-id 'j-12ABCDEFGHI34JK' --instance-fleet InstanceFleetId='if-2ABC4DEFGHIJ4',TargetOnDemandCapacity=1,TargetSpotCapacity=1 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyInstanceFleet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/modify-instance-fleet.html)」を参照してください。 ### `put` 次のコード例は、`put` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、`healthcheck.sh` という名前のファイルを、クラスター ID `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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[Put](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/put.html)」を参照してください。 ### `remove-tags` 次のコード例は、`remove-tags` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、`prod` キーを持つタグをクラスター ID `j-3SD91U2E1L2QX` のクラスターから削除します。 ``` aws emr remove-tags --resource-id j-3SD91U2E1L2QX --tag-keys prod ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/remove-tags.html)」を参照してください。 ### `schedule-hbase-backup` 次のコード例は、`schedule-hbase-backup` を使用する方法を示しています。 **AWS CLI** **注: このコマンドは、AMI バージョン 2.x および 3.x の HBase でのみ使用できます** **1. フル HBase バックアップをスケジュールするには** >>>>>>> 06ab6d6e13564b5733d75abaf3b599f93cf39a23 コマンド: ``` 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 ``` 出力: ``` None ``` **2. 増分 HBase バックアップをスケジュールするには** コマンド: ``` 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 ``` 出力: ``` None ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ScheduleHbaseBackup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/schedule-hbase-backup.html)」を参照してください。 ### `socks` 次のコード例は、`socks` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、クラスター ID `j-3SD91U2E1L2QX` のクラスター内のマスターインスタンスとのソックス接続を開きます。 ``` aws emr socks --cluster-id j-3SD91U2E1L2QX --key-pair-file ~/.ssh/mykey.pem ``` キーペアファイルオプションは、プライベートキーファイルへのローカルパスを取得します。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[Socks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/socks.html)」を参照してください。 ### `ssh` 次のコード例は、`ssh` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、クラスター ID `j-3SD91U2E1L2QX` のクラスター内のマスターインスタンスとの ssh 接続を開きます。 ``` aws emr ssh --cluster-id j-3SD91U2E1L2QX --key-pair-file ~/.ssh/mykey.pem ``` キーペアファイルオプションは、プライベートキーファイルへのローカルパスを取得します。 出力: ``` 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 ~]$ ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[Ssh](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr/ssh.html)」を参照してください。 # AWS CLI を使用した Amazon EMR on EKS の例 次のコード例は、Amazon EMR on EKS で AWS Command Line Interfaceを使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `update-role-trust-policy` 次のコード例は、`update-role-trust-policy` を使用する方法を示しています。 **AWS CLI** **Amazon EMR on EKS で使用する IAM ロールの信頼ポリシーを更新するには** このコマンド例では、**example\$1iam\$1role** という名前のロールの信頼ポリシーを更新して、**example\$1cluster** という名前の EKS クラスターの **example\$1namespace** 名前空間で Amazon EMR on EKS で使用できるようにします。 コマンド: ``` aws emr-containers update-role-trust-policy \ --cluster example_cluster \ --namespace example_namespace \ --role-name example_iam_role ``` 出力: ``` 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. ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateRoleTrustPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/emr-containers/update-role-trust-policy.html)」を参照してください。 # AWS CLI を使用した EventBridge の例 次のコード例は、EventBridgeで AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `delete-rule` 次のコード例は、`delete-rule` を使用する方法を示しています。 **AWS CLI** **CloudWatch Events ルールを削除するには** この例は、EC2InstanceStateChanges という名前のルールを削除します。 ``` aws events delete-rule --name "EC2InstanceStateChanges" ``` + API の詳細については、AWS CLI コマンドリファレンスの「[DeleteRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/delete-rule.html)」を参照してください。** ### `describe-rule` 次のコード例は、`describe-rule` を使用する方法を示しています。 **AWS CLI** **CloudWatch Events ルールに関する情報を表示するには** この例は、DailyLambdaFunction という名前のルールに関する情報を表示します。 ``` aws events describe-rule --name "DailyLambdaFunction" ``` + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/describe-rule.html)」を参照してください。** ### `disable-rule` 次のコード例は、`disable-rule` を使用する方法を示しています。 **AWS CLI** **CloudWatch Events ルールを無効にするには** この例は、DailyLambdaFunction という名前のルールを無効にします。ルールは削除されません。 ``` aws events disable-rule --name "DailyLambdaFunction" ``` + API の詳細については、AWS CLI コマンドリファレンス**の「[DisableRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/disable-rule.html)」を参照してください。 ### `enable-rule` 次のコード例は、`enable-rule` を使用する方法を示しています。 **AWS CLI** **CloudWatch Events ルールを有効にするには** この例は、無効になっていた DailyLambdaFunction という名前のルールを有効にします。 ``` aws events enable-rule --name "DailyLambdaFunction" ``` + API の詳細については、AWS CLI コマンドリファレンス**の「[EnableRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/enable-rule.html)」を参照してください。 ### `list-rule-names-by-target` 次のコード例は、`list-rule-names-by-target` を使用する方法を示しています。 **AWS CLI** **ターゲットが指定されているルールをすべて表示するには** この例は、「MyFunctionName」という名前の Lambda 関数をターゲットとするすべてのルールを表示します。 ``` aws events list-rule-names-by-target --target-arn "arn:aws:lambda:us-east-1:123456789012:function:MyFunctionName" ``` + API の詳細については、AWS CLI コマンドリファレンスの「[ListRuleNamesByTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/list-rule-names-by-target.html)」を参照してください。** ### `list-rules` 次のコード例は、`list-rules` を使用する方法を示しています。 **AWS CLI** **すべての CloudWatch Events ルールを一覧表示するには** この例は、リージョン内のすべての CloudWatch Events ルールを表示します。 ``` aws events list-rules ``` **特定の文字列で始まる CloudWatch Events ルールを一覧表示するには** この例では、名前が「Daily」で始まるリージョン内のすべての CloudWatch Events ルールを表示します。 ``` aws events list-rules --name-prefix "Daily" ``` + API の詳細については、AWS CLI コマンドリファレンスの「[ListRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/list-rules.html)」を参照してください。** ### `list-targets-by-rule` 次のコード例は、`list-targets-by-rule` を使用する方法を示しています。 **AWS CLI** **CloudWatch Events ルールのすべてのターゲットを表示するには** この例は、DailyLambdaFunction という名前のルールのすべてのターゲットを表示します。 ``` aws events list-targets-by-rule --rule "DailyLambdaFunction" ``` + API の詳細については、AWS CLI コマンドリファレンスの「[ListTargetsByRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/list-targets-by-rule.html)」を参照してください。** ### `put-events` 次のコード例は、`put-events` を使用する方法を示しています。 **AWS CLI** **カスタムイベントを CloudWatch Events に送信するには** この例は、カスタムイベントを CloudWatch Events に送信します。このイベントは putevents.json ファイルに含まれています。 ``` aws events put-events --entries file://putevents.json ``` putevents.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" } ] ``` + API の詳細については、AWS CLI コマンドリファレンスの「[PutEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/put-events.html)」を参照してください。** ### `put-rule` 次のコード例は、`put-rule` を使用する方法を示しています。 **AWS CLI** **CloudWatch Events ルールを作成するには** この例は、毎日午前 9:00 (UTC) にトリガーされるルールを作成します。put-targets を使用して Lambda 関数をこのルールのターゲットとして追加すると、指定した時刻に Lambda 関数を毎日実行できます。 ``` aws events put-rule --name "DailyLambdaFunction" --schedule-expression "cron(0 9 * * ? *)" ``` この例は、リージョン内の任意の EC2 インスタンスの状態が変わったときにトリガーされるルールを作成します。 ``` 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" ``` この例は、リージョン内の任意の EC2 インスタンスが停止または終了したときにトリガーされるルールを作成します。 ``` 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" ``` + API の詳細については、AWS CLI コマンドリファレンスの「[PutRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/put-rule.html)」を参照してください。** ### `put-targets` 次のコード例は、`put-targets` を使用する方法を示しています。 **AWS CLI** **CloudWatch Events ルールのターゲットを追加するには** この例は、ルールのターゲットとして Lambda 関数を追加します。 ``` aws events put-targets --rule DailyLambdaFunction --targets "Id"="1","Arn"="arn:aws:lambda:us-east-1:123456789012:function:MyFunctionName" ``` この例は、Amazon Kinesis ストリームをターゲットとして設定し、このルールによって捕捉されたイベントがストリームに中継されるようにします。 ``` 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" ``` この例は、2 つの Amazon Kinesis ストリームを 1 つのルールのターゲットとして設定します。 ``` 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" ``` + API の詳細については、AWS CLI コマンドリファレンスの「[PutTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/put-targets.html)」を参照してください。** ### `remove-targets` 次のコード例は、`remove-targets` を使用する方法を示しています。 **AWS CLI** **イベントのターゲットを削除するには** この例は、MyStream1 という名前の Amazon Kinesis ストリームを、DailyLambdaFunction というルールのターゲットから削除します。DailyLambdaFunction が作成されたとき、このストリームは Target1 の ID を持つターゲットとして設定されました。 ``` aws events remove-targets --rule "DailyLambdaFunction" --ids "Target1" ``` + API の詳細については、AWS CLI コマンドリファレンス**の「[RemoveTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/remove-targets.html)」を参照してください。 ### `test-event-pattern` 次のコード例は、`test-event-pattern` を使用する方法を示しています。 **AWS CLI** **イベントパターンが指定されたイベントと一致するかどうかを確認するには** この例では、パターン「source:com.mycompany.myapp」が指定されたイベントと一致するかどうかをテストします。この例では、出力は「true」になります。 ``` 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\"}" ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TestEventPattern](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/events/test-event-pattern.html)」を参照してください。 # AWS CLI を使用した EventBridge Pipes の例 次のコード例では、EventBridge Pipes で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-pipe` 次のコード例は、`create-pipe` を使用する方法を示しています。 **AWS CLI** **パイプを作成するには** 次の `create-pipe` の例では、ソースとして SQS、ターゲットとして CloudWatch Log Group を使用して、`Demo_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 ``` 出力: ``` { "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" } ``` 詳細については、*Amazon EventBridge ユーザーガイド*の「[Amazon EventBridge Pipes の概念](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[CreatePipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/create-pipe.html)」を参照してください。 ### `delete-pipe` 次のコード例は、`delete-pipe` を使用する方法を示しています。 **AWS CLI** **既存のパイプを削除するには** 次の `delete-pipe` の例では、指定したアカウントから `Demo_Pipe` という名前のパイプを削除します。 ``` aws pipes delete-pipe \ --name Demo_Pipe ``` 出力: ``` { "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" } ``` 詳細については、*Amazon EventBridge ユーザーガイド*の「[Amazon EventBridge Pipes の概念](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DeletePipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/delete-pipe.html)」を参照してください。 ### `describe-pipe` 次のコード例は、`describe-pipe` を使用する方法を示しています。 **AWS CLI** **パイプに関する情報を取得するには** 次の `describe-pipe` の例では、指定したアカウントのパイプ `Demo_Pipe` に関する情報を表示します。 ``` aws pipes describe-pipe \ --name Demo_Pipe ``` 出力: ``` { "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" } } ``` 詳細については、*Amazon EventBridge ユーザーガイド*の「[Amazon EventBridge Pipes の概念](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DescribePipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/describe-pipe.html)」を参照してください。 ### `list-pipes` 次のコード例は、`list-pipes` を使用する方法を示しています。 **AWS CLI** **パイプのリストを取得するには** 次の `list-pipes` の例では、指定したアカウントのすべてのパイプを表示します。 ``` aws pipes list-pipes ``` 出力: ``` { "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" } ] } ``` 詳細については、*Amazon EventBridge ユーザーガイド*の「[Amazon EventBridge Pipes の概念](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[ListPipes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/list-pipes.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **既存のパイプに関連付けられているタグを一覧表示するには** 次の `list-tags-for-resource` の例では、指定したアカウントの `Demo_Pipe` という名前のパイプに関連付けられているすべてのタグを一覧表示します。 ``` aws pipes list-tags-for-resource \ --resource-arn arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe ``` 出力: ``` { "tags": { "stack": "Production", "team": "DevOps" } } ``` 詳細については、*Amazon EventBridge ユーザーガイド*の「[Amazon EventBridge Pipes の概念](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/list-tags-for-resource.html)」を参照してください。 ### `start-pipe` 次のコード例は、`start-pipe` を使用する方法を示しています。 **AWS CLI** **既存のパイプを開始するには** 次の `start-pipe` の例では、指定したアカウントの `Demo_Pipe` という名前のパイプを開始します。 ``` aws pipes start-pipe \ --name Demo_Pipe ``` 出力: ``` { "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" } ``` 詳細については、*Amazon EventBridge ユーザーガイド*の「[Amazon EventBridge パイプの開始または停止](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-start-stop.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[StartPipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/start-pipe.html)」を参照してください。 ### `stop-pipe` 次のコード例は、`stop-pipe` を使用する方法を示しています。 **AWS CLI** **既存のパイプを停止するには** 次の `stop-pipe` の例では、指定したアカウントの `Demo_Pipe` という名前のパイプを停止します。 ``` aws pipes stop-pipe \ --name Demo_Pipe ``` 出力: ``` { "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" } ``` 詳細については、*Amazon EventBridge ユーザーガイド*の「[Amazon EventBridge パイプの開始または停止](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-start-stop.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[StopPipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/stop-pipe.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **既存のパイプにタグを付けるには** 次の `tag-resource` の例では、`Demo_Pipe` という名前のパイプにタグを付けます。コマンドが成功した場合、出力は返りません。 ``` aws pipes tag-resource \ --resource-arn arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe \ --tags stack=Production ``` 詳細については、*Amazon EventBridge ユーザーガイド*の「[Amazon EventBridge Pipes の概念](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **既存のパイプからタグを削除するには** 次の `untag-resource` の例では、`Demo_Pipe` という名前のパイプから、キーが `stack` のタグを削除します。コマンドが成功した場合、出力は返りません。 ``` aws pipes untag-resource \ --resource-arn arn:aws:pipes:us-east-1:123456789012:pipe/Demo_Pipe \ --tags stack ``` 詳細については、*Amazon EventBridge ユーザーガイド*の「[Amazon EventBridge Pipes の概念](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/untag-resource.html)」を参照してください。 ### `update-pipe` 次のコード例は、`update-pipe` を使用する方法を示しています。 **AWS CLI** **既存のパイプを更新するには** 次の `update-pipe` の例では、CloudWatch Log 設定パラメータを追加して `Demo_Pipe` という名前のパイプを更新します。パイプの実行ロールが 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 ``` 出力: ``` { "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" } ``` 詳細については、*Amazon EventBridge ユーザーガイド*の「[Amazon EventBridge Pipes の概念](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-concepts.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[UpdatePipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pipes/update-pipe.html)」を参照してください。 # Firewall Manager examples using AWS CLI 次のコード例は、Firewall Manager で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `associate-admin-account` 次のコード例は、`associate-admin-account` を使用する方法を示しています。 **AWS CLI** Firewall Manager 管理者アカウントを設定するには 次の `associate-admin-account` の例では、Firewall Manager に管理者アカウントが設定されます。 ``` aws fms associate-admin-account \ --admin-account 123456789012 ``` このコマンドでは何も出力されません。 詳細については、「*AWS WAF、AWS Firewall Manager、および AWS Shield Advanced デベロッパーガイド*」の「[AWS Firewall Manager 管理者アカウントを設定する](https://docs.aws.amazon.com/waf/latest/developerguide/enable-integration.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateAdminAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fms/associate-admin-account.html)」を参照してください。 ### `delete-notification-channel` 次のコード例は、`delete-notification-channel` を使用する方法を示しています。 **AWS CLI** **Firewall Manager ログの SNS トピック情報を削除するには** 次の `delete-notification-channel` の例では、SNS トピック情報を削除します。 ``` aws fms delete-notification-channel ``` このコマンドでは何も出力されません。 詳細については、「*AWS WAF、AWS Firewall Manager、AWS Shield Advanced デベロッパーガイド*」の「[Amazon SNS 通知と Amazon CloudWatch アラームを設定する](https://docs.aws.amazon.com/waf/latest/developerguide/get-started-fms-shield-cloudwatch.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteNotificationChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fms/delete-notification-channel.html)」を参照してください。 ### `delete-policy` 次のコード例は、`delete-policy` を使用する方法を示しています。 **AWS CLI** **Firewall Manager ポリシーを削除するには** 次の `delete-policy` の例では、指定された ID を持つポリシーとそのすべてのリソースを削除します。 ``` aws fms delete-policy \ --policy-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ --delete-all-policy-resources ``` このコマンドでは何も出力されません。 詳細については、「*AWS WAF、AWS Firewall Manager、および AWS Shield Advanced デベロッパーガイド*」の「[AWS Firewall Manager ポリシーの使用](https://docs.aws.amazon.com/waf/latest/developerguide/working-with-policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeletePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fms/delete-policy.html)」を参照してください。 ### `disassociate-admin-account` 次のコード例は、`disassociate-admin-account` を使用する方法を示しています。 **AWS CLI** **Firewall Manager 管理者アカウントを削除するには** 次の `disassociate-admin-account` の例では、Firewall Manager から現在の管理者アカウントの関連付けを削除します。 ``` aws fms disassociate-admin-account ``` このコマンドでは何も出力されません。 詳細については、「*AWS WAF、AWS Firewall Manager、および AWS Shield Advanced デベロッパーガイド*」の「[AWS Firewall Manager 管理者アカウントを設定する](https://docs.aws.amazon.com/waf/latest/developerguide/enable-integration.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateAdminAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fms/disassociate-admin-account.html)」を参照してください。 ### `get-admin-account` 次のコード例は、`get-admin-account` を使用する方法を示しています。 **AWS CLI** **Firewall Manager 管理者アカウントを取得するには** 次の `get-admin-account` の例では、管理者アカウントを取得します。 ``` aws fms get-admin-account ``` 出力: ``` { "AdminAccount": "123456789012", "RoleStatus": "READY" } ``` 詳細については、「*AWS WAF、AWS Firewall Manager、および AWS Shield Advanced デベロッパーガイド*」の「[AWS Firewall Manager の前提条件](https://docs.aws.amazon.com/waf/latest/developerguide/fms-prereq.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAdminAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fms/get-admin-account.html)」を参照してください。 ### `get-compliance-detail` 次のコード例は、`get-compliance-detail` を使用する方法を示しています。 **AWS CLI** **アカウントのコンプライアンス情報を取得するには** 次の `get-compliance-detail` の例では、指定されたポリシーとメンバーアカウントのコンプライアンス情報を取得します。 ``` aws fms get-compliance-detail \ --policy-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ --member-account 123456789012 ``` 出力: ``` { "PolicyComplianceDetail": { "EvaluationLimitExceeded": false, "IssueInfoMap": {}, "MemberAccount": "123456789012", "PolicyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "PolicyOwner": "123456789012", "Violators": [] } ``` 詳細については、「*AWS WAF、AWS Firewall Manager、AWS Shield Advanced デベロッパーガイド*」の「[ポリシーによるリソースコンプライアンスの表示](https://docs.aws.amazon.com/waf/latest/developerguide/fms-compliance.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetComplianceDetail](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fms/get-compliance-detail.html)」を参照してください。 ### `get-notification-channel` 次のコード例は、`get-notification-channel` を使用する方法を示しています。 **AWS CLI** **Firewall Manager ログの SNS トピック情報を取得するには** 次の `get-notification-channel` の例では、SNS トピック情報を取得します。 ``` aws fms get-notification-channel ``` 出力: ``` { "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" } ``` 詳細については、「*AWS WAF、AWS Firewall Manager、AWS Shield Advanced デベロッパーガイド*」の「[Amazon SNS 通知と Amazon CloudWatch アラームを設定する](https://docs.aws.amazon.com/waf/latest/developerguide/get-started-fms-shield-cloudwatch.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetNotificationChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fms/get-notification-channel.html)」を参照してください。 ### `get-policy` 次のコード例は、`get-policy` を使用する方法を示しています。 **AWS CLI** **Firewall Manager ポリシーを取得するには** 次の `get-policy` の例では、指定された ID のポリシーを取得します。 ``` aws fms get-policy \ --policy-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` 出力: ``` { "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" } ``` 詳細については、「*AWS WAF、AWS Firewall Manager、および AWS Shield Advanced デベロッパーガイド*」の「[AWS Firewall Manager ポリシーの使用](https://docs.aws.amazon.com/waf/latest/developerguide/working-with-policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fms/get-policy.html)」を参照してください。 ### `list-compliance-status` 次のコード例は、`list-compliance-status` を使用する方法を示しています。 **AWS CLI** **メンバーアカウントのポリシーコンプライアンス情報を取得するには** 次の `list-compliance-status` の例では、指定されたポリシーのメンバーアカウントコンプライアンス情報を取得します。 ``` aws fms list-compliance-status \ --policy-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` 出力: ``` { "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": {} } ] } ``` 詳細については、「*AWS WAF、AWS Firewall Manager、AWS Shield Advanced デベロッパーガイド*」の「[ポリシーによるリソースコンプライアンスの表示](https://docs.aws.amazon.com/waf/latest/developerguide/fms-compliance.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListComplianceStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fms/list-compliance-status.html)」を参照してください。 ### `list-member-accounts` 次のコード例は、`list-member-accounts` を使用する方法を示しています。 **AWS CLI** **組織内のメンバーアカウントを取得するには** 次の `list-member-accounts` の例では、Firewall Manager 管理者の組織内にあるすべてのメンバーアカウントを一覧表示します。 ``` aws fms list-member-accounts ``` 出力: ``` { "MemberAccounts": [ "222222222222", "333333333333", "444444444444" ] } ``` 詳細については、「*AWS WAF、AWS Firewall Manager、および AWS Shield Advanced デベロッパーガイド*」の「[AWS Firewall Manager](https://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListMemberAccounts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fms/list-member-accounts.html)」を参照してください。 ### `list-policies` 次のコード例は、`list-policies` を使用する方法を示しています。 **AWS CLI** **すべての Firewall Manager ポリシーを取得するには** 次の `list-policies` の例では、アカウントのポリシーのリストを取得します。この例では、出力はリクエストごとに 2 つの結果に制限されています。各呼び出しは、リストの次の結果セットを取得するために、次の `list-policies` 呼び出しで `--starting-token` パラメータの値として使用できる `NextToken` を返します。 ``` aws fms list-policies \ --max-items 2 ``` 出力: ``` { "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==" } ``` 詳細については、「*AWS WAF、AWS Firewall Manager、および AWS Shield Advanced デベロッパーガイド*」の「[AWS Firewall Manager ポリシーの使用](https://docs.aws.amazon.com/waf/latest/developerguide/working-with-policies.html)」を参照してください。 + API の詳細については、「AWS CLI Command Reference」の「[ListPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fms/list-policies.html)」を参照してください。** ### `put-notification-channel` 次のコード例は、`put-notification-channel` を使用する方法を示しています。 **AWS CLI** **Firewall Manager ログの SNS トピック情報を設定するには** 次の `put-notification-channel` の例では、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 ``` このコマンドでは何も出力されません。 詳細については、「*AWS WAF、AWS Firewall Manager、AWS Shield Advanced デベロッパーガイド*」の「[Amazon SNS 通知と Amazon CloudWatch アラームを設定する](https://docs.aws.amazon.com/waf/latest/developerguide/get-started-fms-shield-cloudwatch.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutNotificationChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fms/put-notification-channel.html)」を参照してください。 ### `put-policy` 次のコード例は、`put-policy` を使用する方法を示しています。 **AWS CLI** **Firewall Manager ポリシーを作成するには** 次の `put-policy` の例では、Firewall Manager セキュリティグループポリシーを作成します。 ``` aws fms put-policy \ --cli-input-json file://policy.json ``` `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" } ] } ``` 出力: ``` { "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" } ``` 詳細については、「*AWS WAF、AWS Firewall Manager、および AWS Shield Advanced デベロッパーガイド*」の「[AWS Firewall Manager ポリシーの使用](https://docs.aws.amazon.com/waf/latest/developerguide/working-with-policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fms/put-policy.html)」を参照してください。 # AWS FIS examples using AWS CLI 次のコード例では、AWS FIS で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-experiment-template` 次のコード例は、`create-experiment-template` を使用する方法を示しています。 **AWS CLI** **実験テンプレートを作成するには** 次の `create-experiment-template` の例では、AWS FIS アカウントに実験テンプレートを作成します。 ``` aws fis create-experiment-template \ --cli-input-json file://myfile.json ``` `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" } ``` 出力: ``` { "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": {} } } ``` 詳細については、「*AWS Fault Injection Simulator ユーザーガイド*」の「[実験テンプレートを作成する](https://docs.aws.amazon.com/fis/latest/userguide/working-with-templates.html#create-template)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateExperimentTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fis/create-experiment-template.html)」を参照してください。 ### `delete-experiment-template` 次のコード例は、`delete-experiment-template` を使用する方法を示しています。 **AWS CLI** **実験テンプレートを削除するには** 次の `delete-experiment-template` の例では、指定された実験テンプレートを削除します。 ``` aws fis delete-experiment-template \ --id ABCDE1fgHIJkLmNop ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Fault Injection Simulator ユーザーガイド*」の「[実験テンプレートを削除する](https://docs.aws.amazon.com/fis/latest/userguide/working-with-templates.html#delete-template)」を参照してください。 + API の詳細については、「**AWS CLI コマンドリファレンス」の「[DeleteExperimentTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fis/delete-experiment-template.html)」を参照してください。 ### `get-action` 次のコード例は、`get-action` を使用する方法を示しています。 **AWS CLI** **アクションの詳細を取得するには** 次の `get-action` の例では、指定されたアクションの詳細を取得します。 ``` aws fis get-action \ --id aws:ec2:stop-instances ``` 出力: ``` { "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": {} } } ``` 詳細については、「*AWS Fault Injection Simulator ユーザーガイド*」の「[アクション](https://docs.aws.amazon.com/fis/latest/userguide/actions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fis/get-action.html)」を参照してください。 ### `get-experiment-template` 次のコード例は、`get-experiment-template` を使用する方法を示しています。 **AWS CLI** **実験テンプレートの詳細を取得するには** 次の `get-experiment-template` の例では、指定された実験テンプレートの詳細を取得します。 ``` aws fis get-experiment-template \ --id ABCDE1fgHIJkLmNop ``` 出力: ``` { "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" } } } ``` 詳細については、「*AWS Fault Injection Simulator ユーザーガイド*」の「[実験テンプレート](https://docs.aws.amazon.com/fis/latest/userguide/experiment-templates.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetExperimentTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fis/get-experiment-template.html)」を参照してください。 ### `get-experiment` 次のコード例は、`get-experiment` を使用する方法を示しています。 **AWS CLI** **実験の詳細を取得するには** 次の `get-experiment` の例では、指定された実験の詳細を取得します。 ``` aws fis get-experiment \ --id ABC12DeFGhI3jKLMNOP ``` 出力: ``` { "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": {} } } ``` 詳細については、「*AWS Fault Injection Simulator ユーザーガイド*」の「[AWS FIS の実験](https://docs.aws.amazon.com/fis/latest/userguide/experiments.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetExperiment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fis/get-experiment.html)」を参照してください。 ### `list-actions` 次のコード例は、`list-actions` を使用する方法を示しています。 **AWS CLI** **アクションを一覧表示するには** 次の `list-actions` の例は、使用可能なアクションを一覧表示します。 ``` aws fis list-actions ``` 出力: ``` { "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": {} } ] } ``` 詳細については、「*AWS Fault Injection Simulator ユーザーガイド*」の「[アクション](https://docs.aws.amazon.com/fis/latest/userguide/actions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fis/list-actions.html)」を参照してください。 ### `list-experiment-templates` 次のコード例は、`list-experiment-templates` を使用する方法を示しています。 **AWS CLI** **実験テンプレートを一覧表示するには** 次の `list-experiment-templates` の例では、AWS アカウントの実験テンプレートを一覧表示します。 ``` aws fis list-experiment-templates ``` 出力: ``` { "experimentTemplates": [ { "id": "ABCDE1fgHIJkLmNop", "description": "myExperimentTemplate", "creationTime": 1616017191.124, "lastUpdateTime": 1616017191.124, "tags": { "key": "value" } } ] } ``` 詳細については、「*AWS Fault Injection Simulator ユーザーガイド*」の「[実験テンプレート](https://docs.aws.amazon.com/fis/latest/userguide/experiment-templates.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListExperimentTemplates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fis/list-experiment-templates.html)」を参照してください。 ### `list-experiments` 次のコード例は、`list-experiments` を使用する方法を示しています。 **AWS CLI** **実験を一覧表示するには** 次の `list-experiments` 例では、AWS アカウントの実験を一覧表示します。 ``` aws fis list-experiments ``` 出力: ``` { "experiments": [ { "id": "ABCdeF1GHiJkLM23NO", "experimentTemplateId": "ABCDE1fgHIJkLmNop", "state": { "status": "running", "reason": "Experiment is running." }, "creationTime": 1616017341.197, "tags": { "key": "value" } } ] } ``` 詳細については、「*AWS Fault Injection Simulator ユーザーガイド*」の「[実験](https://docs.aws.amazon.com/fis/latest/userguide/experiments.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListExperiments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fis/list-experiments.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **リソースのタグを一覧表示するには** 次の `list-tags-for-resource` の例では、指定したリソースのタグを一覧表示します。 ``` aws fis list-tags-for-resource \ --resource-arn arn:aws:fis:us-west-2:123456789012:experiment/ABC12DeFGhI3jKLMNOP ``` 出力: ``` { "tags": { "key1": "value1", "key2": "value2" } } ``` 詳細については、「*AWS Fault Injection Simulator ユーザーガイド*」の「[AWS FIS リソースのタグ付け](https://docs.aws.amazon.com/fis/latest/userguide/tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fis/list-tags-for-resource.html)」を参照してください。 ### `start-experiment` 次のコード例は、`start-experiment` を使用する方法を示しています。 **AWS CLI** **実験を開始するには** 次の `start-experiment` の例では、指定された実験を開始します。 ``` aws fis start-experiment \ --experiment-template-id ABCDE1fgHIJkLmNop ``` 出力: ``` { "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": {} } } ``` 詳細については、「*AWS Fault Injection Simulator ユーザーガイド*」の「[AWS FIS の実験](https://docs.aws.amazon.com/fis/latest/userguide/experiments.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartExperiment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fis/start-experiment.html)」を参照してください。 ### `stop-experiment` 次のコード例は、`stop-experiment` を使用する方法を示しています。 **AWS CLI** **実験を中止するには** 次の `stop-experiment` の例では、指定された実験の実行を停止します。 ``` aws fis stop-experiment \ --id ABC12DeFGhI3jKLMNOP ``` 出力: ``` { "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": {} } } ``` 詳細については、「*AWS Fault Injection Simulator ユーザーガイド*」の「[AWS FIS の実験](https://docs.aws.amazon.com/fis/latest/userguide/experiments.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopExperiment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fis/stop-experiment.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **リソースにタグを付けるには** 次の `tag-resource` の例では、指定されたリソースにタグ付けします。 ``` aws fis tag-resource \ --resource-arn arn:aws:fis:us-west-2:123456789012:experiment/ABC12DeFGhI3jKLMNOP \ --tags key1=value1,key2=value2 ``` このコマンドでは何も出力されません。 詳細については、「*AWS Fault Injection Simulator ユーザーガイド*」の「[AWS FIS リソースのタグ付け](https://docs.aws.amazon.com/fis/latest/userguide/tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fis/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **リソースのタグを削除するには** 次の `untag-resource` の例では、指定されたリソースからタグを削除します。 ``` aws fis untag-resource \ --resource-arn arn:aws:fis:us-west-2:123456789012:experiment/ABC12DeFGhI3jKLMNOP ``` このコマンドでは何も出力されません。 詳細については、「*AWS Fault Injection Simulator ユーザーガイド*」の「[AWS FIS リソースのタグ付け](https://docs.aws.amazon.com/fis/latest/userguide/tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fis/untag-resource.html)」を参照してください。 ### `update-experiment-template` 次のコード例は、`update-experiment-template` を使用する方法を示しています。 **AWS CLI** **実験テンプレートを更新するには** 次の `update-experiment-template` の例では、指定された実験テンプレートの説明を更新します。 ``` aws fis update-experiment-template \ --id ABCDE1fgHIJkLmNop \ ---description myExperimentTemplate ``` 出力: ``` { "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" } } } ``` 詳細については、「*AWS Fault Injection Simulator ユーザーガイド*」の「[実験テンプレートを更新する](https://docs.aws.amazon.com/fis/latest/userguide/working-with-templates.html#update-template)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateExperimentTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/fis/update-experiment-template.html)」を参照してください。 # AWS CLI を使用する Amazon GameLift サーバーの例 次のコード例は、Amazon GameLift サーバーで AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-build` 次のコード例は、`create-build` を使用する方法を示しています。 **AWS CLI** **Example1: S3 バケット内のファイルからゲームビルドを作成するには** 次の `create-build` の例では、カスタムゲームビルドリソースを作成します。コントロールする AWS アカウントの S3 ロケーションに保存されている zip ファイルを使用します。この例では、Amazon GameLift に S3 ロケーションへのアクセス許可を付与する IAM ロールを既に作成していることを前提としています。リクエストはオペレーティングシステムを指定しないため、新しいビルドリソースはデフォルトで WINDOWS\$12012 になります。 ``` aws gamelift create-build \ --storage-location file://storage-loc.json \ --name MegaFrogRaceServer.NA \ --build-version 12345.678 ``` `storage-loc.json` の内容: ``` { "Bucket":"MegaFrogRaceServer_NA_build_files" "Key":"MegaFrogRaceServer_build_123.zip" "RoleArn":"arn:aws:iam::123456789012:role/gamelift" } ``` 出力: ``` { "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" } } ``` **Example2: GameLift にファイルを手動でアップロードするためのゲームビルドリソースを作成するには** 次の `create-build` の例では、新しいビルドリソースを作成します。また、Amazon S3 の GameLift ロケーションにゲームビルドを手動でアップロードできるストレージロケーションと一時的な認証情報も取得します。ビルドが正常にアップロードされると、GameLift サービスはビルドを検証し、新しいビルドのステータスを更新します。 ``` aws gamelift create-build \ --name MegaFrogRaceServer.NA \ --build-version 12345.678 \ --operating-system AMAZON_LINUX ``` 出力: ``` { "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==" } } ``` 詳細については、「*Amazon GameLift デベロッパーガイド*」の「[カスタムサーバービルドを GameLift にアップロードする](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateBuild](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/create-build.html)」を参照してください。 ### `create-fleet` 次のコード例は、`create-fleet` を使用する方法を示しています。 **AWS CLI** **例 1: 基本的な Linux フリートを作成するには** 次の `create-fleet` の例では、カスタムサーバービルドをホストするために、最小限の設定でオンデマンド Linux インスタンスのフリートを作成します。これは、`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}]' ``` 出力: ``` { "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" } } ``` **例 2: 基本的な Windows フリートを作成するには** 次の `create-fleet` の例では、カスタムサーバービルドをホストするために、最小限の設定でスポット Windows インスタンスのフリートを作成します。これは、`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}]' ``` 出力: ``` { "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" } } ``` **例 3: 完全に設定されたフリートを作成するには** 次の `create-fleet` の例では、カスタムサーバービルド用のスポット Windows インスタンスのフリートを作成し、最も一般的に使用される設定を提供します。 ``` 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' ``` `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}] ``` 出力: ``` { "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" } } } ``` **例 4: Realtime サーバーフリートを作成するには** 次の `create-fleet` の例では、Amazon GameLift にアップロードされたリアルタイム設定スクリプトを使用して、スポットインスタンスのフリートを作成します。すべてのリアルタイムサーバーは Linux マシンにデプロイされます。この例では、アップロードされた Realtime スクリプトに複数のスクリプトファイルが含まれ、`MainScript.js` というスクリプトファイルにある `Init()` 関数があるとします。図に示すように、このファイルはランタイム設定で起動スクリプトとして識別されます。 ``` 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}]' ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateFleet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/create-fleet.html)」を参照してください。 ### `create-game-session-queue` 次のコード例は、`create-game-session-queue` を使用する方法を示しています。 **AWS CLI** **例 1: 順序付けられたゲームセッションキューを設定するには** 次の `create-game-session-queue` の例では、2 つのリージョンに送信先を持つ新しいゲームセッションキューを作成します。また、配置を 10 分待ってからゲームセッションリクエストがタイムアウトするようにキューを設定します。レイテンシーポリシーは定義されていないため、GameLift は最初の送信先がリストされているすべてのゲームセッションを配置しようとします。 ``` aws gamelift create-game-session-queue \ --name MegaFrogRaceServer-NA \ --destinations file://destinations.json \ --timeout-in-seconds 600 ``` `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" } ] } ``` 出力: ``` { "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"} ] } ] } ``` **例 2: プレイヤーのレイテンシーポリシーを使用してゲームセッションキューを設定するには** 次の `create-game-session-queue` の例では、2 つのプレイヤーレイテンシーポリシーを持つ新しいゲームセッションキューを作成します。最初のポリシーは、ゲームセッションプレイスメントの最初の 1 分間に強制される 100 ミリ秒のレイテンシー上限を設定します。2 番目のポリシーでは、プレイスメントリクエストが 3 分でタイムアウトするまで、レイテンシーの上限が 200 ミリ秒に引き上げられます。 ``` aws gamelift create-game-session-queue \ --name MegaFrogRaceServer-NA \ --destinations file://destinations.json \ --player-latency-policies file://latency-policies.json \ --timeout-in-seconds 180 ``` `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" } ] } ``` `latency-policies.json` の内容: ``` { "PlayerLatencyPolicies": [ {"MaximumIndividualPlayerLatencyMilliseconds": 200}, {"MaximumIndividualPlayerLatencyMilliseconds": 100, "PolicyDurationSeconds": 60} ] } ``` 出力: ``` { "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"} ], } } ``` 詳細については、「*Amazon GameLift デベロッパーガイド*」の「[キューを作成する](https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-creating.html#queues-creating-cli)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateGameSessionQueue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/create-game-session-queue.html)」を参照してください。 ### `delete-build` 次のコード例は、`delete-build` を使用する方法を示しています。 **AWS CLI** **カスタムゲームビルドを削除するには** 次の `delete-build` の例では、Amazon GameLift アカウントからビルドを削除します。ビルドが削除された後は、それを使用して新しいフリートを作成することはできません。この操作は元に戻すことができません。 ``` aws gamelift delete-build \ --build-id build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteBuild](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/delete-build.html)」を参照してください。 ### `delete-fleet` 次のコード例は、`delete-fleet` を使用する方法を示しています。 **AWS CLI** **使用されていないフリートを削除するには** 次の `delete-fleet` の例では、ゼロインスタンスにスケールダウンされたフリートを削除します。フリート容量が 0 より大きい場合、リクエストは HTTP 400 エラーで失敗します。 ``` aws gamelift delete-fleet \ --fleet-id fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon GameLift デベロッパーガイド*」の「[GameLift フリートを管理する](https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-editing.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteFleet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/delete-fleet.html)」を参照してください。 ### `delete-game-session-queue` 次のコード例は、`delete-game-session-queue` を使用する方法を示しています。 **AWS CLI** **ゲームセッションキューを削除するには** 次の `delete-game-session-queue` の例では、指定されたゲームセッションキューを削除します。 ``` aws gamelift delete-game-session-queue \ --name MegaFrogRace-NA ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteGameSessionQueue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/delete-game-session-queue.html)」を参照してください。 ### `describe-build` 次のコード例は、`describe-build` を使用する方法を示しています。 **AWS CLI** **カスタムゲームビルドに関する情報を取得するには** 次の `describe-build` の例では、ゲームサーバービルドリソースのプロパティを取得します。 ``` aws gamelift describe-build \ --build-id build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon GameLift デベロッパーガイド*」の「[カスタムサーバービルドを GameLift にアップロードする](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-builds)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeBuild](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/describe-build.html)」を参照してください。 ### `describe-ec2-instance-limits` 次のコード例は、`describe-ec2-instance-limits` を使用する方法を示しています。 **AWS CLI** **EC2 インスタンスタイプのサービス制限を取得するには** 次の `describe-ec2-instance-limits` の例では、現在のリージョンで指定された EC2 インスタンスタイプで使用されている最大許容インスタンスと現在のインスタンスを表示します。結果は、許可された 20 個のインスタンスのうち 5 個のみが使用されていることを示します。 ``` aws gamelift describe-ec2-instance-limits \ --ec2-instance-type m5.large ``` 出力: ``` { "EC2InstanceLimits": [ { "EC2InstanceType": ""m5.large", "CurrentInstances": 5, "InstanceLimit": 20 } ] } ``` 詳細については、「*Amazon GameLift デベロッパーガイド*」の「[コンピューティングリソースを選択する](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEc2InstanceLimits](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/describe-ec2-instance-limits.html)」を参照してください。 ### `describe-fleet-attributes` 次のコード例は、`describe-fleet-attributes` を使用する方法を示しています。 **AWS CLI** **例 1: フリートのリストの属性を表示するには** 次の `describe-fleet-attributes` の例では、指定された 2 つのフリートのフリート属性を取得します。図に示すように、リクエストされたフリートは同じビルドでデプロイされます。1 つはオンデマンドインスタンス用、もう 1 つはスポットインスタンス用で、設定には若干の違いがあります。 ``` 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 ``` 出力: ``` { "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" } } ] } ``` **Example2: すべてのフリートの属性をリクエストするには** 次の `describe-fleet-attributes` は、ステータスが のすべてのフリートのフリート属性を返します。この例では、ページ分割パラメータを使用して一度に 1 つのフリートを返す方法を示しています。 ``` aws gamelift describe-fleet-attributes \ --limit 1 ``` 出力: ``` { "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" } ``` 出力には、コマンドを 2 回呼び出すときに使用できる `NextToken` 値が含まれます。値を `--next-token` パラメータに渡して、出力を受け取る場所を指定します。このコマンドは、出力の 2 つ目の結果を返します。 ``` aws gamelift describe-fleet-attributes \ --limit 1 \ --next-token eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC01NWYxZTZmMS1jY2FlLTQ3YTctOWI5ZS1iYjFkYTQwMjEXAMPLE1 ``` レスポンスに `NextToken` 値が含まれなくなるまで繰り返します。 詳細については、「*Amazon GameLift デベロッパーガイド*」の「[GameLift フリートのセットアップ](https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeFleetAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/describe-fleet-attributes.html)」を参照してください。 ### `describe-fleet-capacity` 次のコード例は、`describe-fleet-capacity` を使用する方法を示しています。 **AWS CLI** **フリートのリストのキャパシティステータスを表示するには** 次の `describe-fleet-capacity` の例では、指定された 2 つのフリートの現在のキャパシティを取得します。 ``` 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 ``` 出力: ``` { "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 } } ] } ``` 詳細については、「*Amazon GameLift デベロッパーガイド*」の「[フリートの GameLift メトリクス](https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeFleetCapacity](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/describe-fleet-capacity.html)」を参照してください。 ### `describe-fleet-events` 次のコード例は、`describe-fleet-events` を使用する方法を示しています。 **AWS CLI** **指定された期間にイベントをリクエストするには** 次の `describe-fleet-events` の例では、指定された期間に発生したすべてのフリート関連イベントの詳細を表示します。 ``` 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 ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon GameLift デベロッパーガイド*」の「[GameLift フリートの問題をデバッグする](https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeFleetEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/describe-fleet-events.html)」を参照してください。 ### `describe-fleet-port-settings` 次のコード例は、`describe-fleet-port-settings` を使用する方法を示しています。 **AWS CLI** **フリートに設定されているインバウンド接続のアクセス許可を表示するには** 次の `describe-fleet-port-settings` の例では、指定されたフリートの接続設定を取得します。 ``` aws gamelift describe-fleet-port-settings \ --fleet-id arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon GameLift デベロッパーガイド*」の「[GameLift フリートのセットアップ](https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeFleetPortSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/describe-fleet-port-settings.html)」を参照してください。 ### `describe-fleet-utilization` 次のコード例は、`describe-fleet-utilization` を使用する方法を示しています。 **AWS CLI** **例 1: フリートのリストの使用状況データを表示するには** 次の `describe-fleet-utilization` の例では、指定された 1 つのフリートの現在の使用状況の情報を取得します。 ``` aws gamelift describe-fleet-utilization \ --fleet-ids arn:aws:gamelift:us-west-2::fleet/fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` 出力: ``` { "FleetUtilization": [ { "FleetId": "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "ActiveServerProcessCount": 100, "ActiveGameSessionCount": 62, "CurrentPlayerSessionCount": 329, "MaximumPlayerSessionCount": 1000 } ] } ``` **例 2: すべてのフリートの使用データをリクエストするには** 次の `describe-fleet-utilization` は、ステータスにかかわらずすべてのフリートのフリート使用状況データを返します。この例では、ページ分割パラメータを使用して、一度に 2 つのフリートのデータを返します。 ``` aws gamelift describe-fleet-utilization \ --limit 2 ``` 出力: ``` { "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" } ``` コマンドを 2 回呼び出し、`NextToken` 値を引数として `--next-token` パラメータに渡して、次の 2 つの結果を確認します。 ``` aws gamelift describe-fleet-utilization \ --limit 2 \ --next-token eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC01NWYxZTZmMS1jY2FlLTQ3YTctOWI5ZS1iYjFkYTQwMjEXAMPLE2 ``` レスポンスに出力の `NextToken` 値が含まれなくなるまで繰り返します。 詳細については、「*Amazon GameLift デベロッパーガイド*」の「[フリートの GameLift メトリクス](https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeFleetUtilization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/describe-fleet-utilization.html)」を参照してください。 ### `describe-game-session-queues` 次のコード例は、`describe-game-session-queues` を使用する方法を示しています。 **AWS CLI** **ゲームセッションキューを表示するには** 次の `describe-game-session-queues` の例では、指定された 2 つのキューのプロパティを取得します。 ``` aws gamelift describe-game-session-queues \ --names MegaFrogRace-NA MegaFrogRace-EU ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon GameLift デベロッパーガイド*」の「[マルチリージョンキューの使用](https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeGameSessionQueues](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/describe-game-session-queues.html)」を参照してください。 ### `describe-runtime-configuration` 次のコード例は、`describe-runtime-configuration` を使用する方法を示しています。 **AWS CLI** **フリートのランタイム設定をリクエストするには** 次の `describe-runtime-configuration` の例では、指定されたフリートの現在のランタイム設定の詳細を取得します。 ``` aws gamelift describe-runtime-configuration \ --fleet-id fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon GameLift デベロッパーガイド*」の「[フリートで複数のプロセスを実行する](https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeRuntimeConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/describe-runtime-configuration.html)」を参照してください。 ### `list-builds` 次のコード例は、`list-builds` を使用する方法を示しています。 **AWS CLI** **例 1: カスタムゲームビルドのリストを取得するには** 次の `list-builds` の例では、現在のリージョン内のすべてのゲームサーバービルドのプロパティを取得します。サンプルリクエストは、ページ分割パラメータ `Limit` と `NextToken` を使用してシーケンシャルセットで結果を取得する方法を示しています。最初のコマンドは、最初の 2 つのビルドを取得します。利用可能な結果が 3 つ以上あるため、レスポンスにはより多くの結果が利用可能であることを示す `NextToken` が含まれます。 ``` aws gamelift list-builds \ --limit 2 ``` 出力: ``` { "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=" } ``` その後、次のように `--next-token` パラメータを使用してコマンドを再度呼び出して、次の 2 つのビルドを確認できます。 ``` aws gamelift list-builds \ --limit 2 --next-token eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC01NWYxZTZmMS1jY2FlLTQ3YTctOWI5ZS1iYjFkYTQwMjJEXAMPLE= ``` レスポンスに `NextToken` 値が含まれなくなるまで繰り返します。 **例 2: 失敗ステータスのカスタムゲームビルドのリストを取得するには** 次の `list-builds` の例では、現在 ステータスが FAILED になっている現在のリージョンのすべてのゲームサーバービルドのプロパティを取得します。 ``` aws gamelift list-builds \ --status FAILED ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListBuilds](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/list-builds.html)」を参照してください。 ### `list-fleets` 次のコード例は、`list-fleets` を使用する方法を示しています。 **AWS CLI** **例 1: リージョン内のすべてのフリートのリストを取得するには** 次の `list-fleets` の例では、現在のリージョン内のすべてのフリートのフリート ID を表示します。この例では、ページ分割パラメータを使用して、一度に 2 つのフリート ID を取得します。レスポンスには、取得する結果が多いことを示す `next-token` 属性が含まれます。 ``` aws gamelift list-fleets \ --limit 2 ``` 出力: ``` { "FleetIds": [ "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" ], "NextToken": "eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC01NWYxZTZmMS1jY2FlLTQ3YTctOWI5ZS1iYjFkYTQwMjJEXAMPLE=" } ``` 次の 2 つの結果を取得するには、ここに示すように、次のコマンドで前のレスポンスの `NextToken` 値を渡すことができます。 ``` aws gamelift list-fleets \ --limit 2 \ --next-token eyJhd3NBY2NvdW50SWQiOnsicyI6IjMwMjc3NjAxNjM5OCJ9LCJidWlsZElkIjp7InMiOiJidWlsZC00NDRlZjQxZS1hM2I1LTQ2NDYtODJmMy0zYzI4ZTgxNjVjEXAMPLE= ``` **例 2: 特定のビルドまたはスクリプトを持つリージョン内のすべてのフリートのリストを取得するには** 次の `list-builds` の例では、指定されたゲームビルドでデプロイされたフリートの ID を取得します。Realtime サーバーを使用している場合は、ビルド ID の代わりにスクリプト ID を指定できます。この例では制限パラメータを指定しないため、結果には最大 16 個のフリート ID を含めることができます。 ``` aws gamelift list-fleets \ --build-id build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` 出力: ``` { "FleetIds": [ "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", "fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE44444" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListFleets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/list-fleets.html)」を参照してください。 ### `request-upload-credentials` 次のコード例は、`request-upload-credentials` を使用する方法を示しています。 **AWS CLI** **ビルドをアップロードするためのアクセス認証情報を更新するには** 次の `create-build` の例では、Amazon S3 ロケーションに GameLift ビルドファイルをアップロードするための新しい有効なアクセス認証情報を取得します。認証情報の有効期間は限られています。元の `CreateBuild` リクエストに対するレスポンスからビルド ID を取得します。 ``` aws gamelift request-upload-credentials \ --build-id build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` 出力: ``` { "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==" } } ``` 詳細については、「*Amazon GameLift デベロッパーガイド*」の「[カスタムサーバービルドを GameLift にアップロードする](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RequestUploadCredentials](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/request-upload-credentials.html)」を参照してください。 ### `start-fleet-actions` 次のコード例は、`start-fleet-actions` を使用する方法を示しています。 **AWS CLI** **フリートの自動スケーリングアクティビティを再起動するには** 次の `start-fleet-actions` の例では、指定されたフリートに定義されているが、「stop-fleet-actions」を呼び出すことで停止されたすべてのスケーリングポリシーの使用を再開します。開始すると、スケーリングポリシーはすぐにそれぞれのメトリクスの追跡を開始します。 ``` aws gamelift start-fleet-actions \ --fleet-id fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ --actions AUTO_SCALING ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartFleetActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/start-fleet-actions.html)」を参照してください。 ### `stop-fleet-actions` 次のコード例は、`stop-fleet-actions` を使用する方法を示しています。 **AWS CLI** **フリートの自動スケーリングアクティビティを停止するには** 次の `stop-fleet-actions` の例では、指定されたフリートに定義されているすべてのスケーリングポリシーの使用を停止します。ポリシーが一時停止された後も、手動で調整しない限り、フリートキャパシティは同じアクティブなインスタンス数のままになります。 ``` aws gamelift start-fleet-actions \ --fleet-id fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ --actions AUTO_SCALING ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopFleetActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/stop-fleet-actions.html)」を参照してください。 ### `update-build` 次のコード例は、`update-build` を使用する方法を示しています。 **AWS CLI** **カスタムゲームビルドを更新するには** 次の `update-build` の例では、指定されたビルドリソースに関連付けられている名前とバージョン情報を変更します。返されたビルドオブジェクトは、変更が正常に行われたことを確認します。 ``` aws gamelift update-build \ --build-id build-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \ --name MegaFrogRaceServer.NA.east \ --build-version 12345.east ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon GameLift デベロッパーガイド*」の「[ビルドファイルを更新する](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-update-build-files)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateBuild](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/update-build.html)」を参照してください。 ### `update-game-session-queue` 次のコード例は、`update-game-session-queue` を使用する方法を示しています。 **AWS CLI** **ゲームセッションキュー設定を更新するには** 次の `update-game-session-queue` の例では、新しい送信先を追加し、既存のゲームセッションキューのプレイヤーレイテンシーポリシーを更新します。 ``` aws gamelift update-game-session-queue \ --name MegaFrogRace-NA \ --destinations file://destinations.json \ --player-latency-policies file://latency-policies.json ``` `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"} ] } ``` `latency-policies.json` の内容: ``` { "PlayerLatencyPolicies": [ {"MaximumIndividualPlayerLatencyMilliseconds": 200}, {"MaximumIndividualPlayerLatencyMilliseconds": 150, "PolicyDurationSeconds": 120}, {"MaximumIndividualPlayerLatencyMilliseconds": 100, "PolicyDurationSeconds": 120} ] } ``` 出力: ``` { "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} ] } } ``` 詳細については、「*Amazon GameLift デベロッパーガイド*」の「[マルチリージョンキューの使用](https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateGameSessionQueue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/update-game-session-queue.html)」を参照してください。 ### `upload-build` 次のコード例は、`upload-build` を使用する方法を示しています。 **AWS CLI** **例 1: Linux ゲームサーバービルドをアップロードするには** 次の `upload-build` の例では、Linux ゲームサーバービルドファイルをファイルディレクトリから GameLift サービスにアップロードし、ビルドリソースを作成します。 ``` 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 ``` 出力: ``` 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 ``` **例 2: Windows ゲームサーバービルドをアップロードするには** 次の `upload-build` 例では、Windows ゲームサーバーのビルドファイルをディレクトリから GameLift サービスにアップロードし、ビルドレコードを作成します。 ``` 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 ``` 出力: ``` 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 ``` 詳細については、「*Amazon GameLift デベロッパーガイド*」の「[カスタムサーバービルドを GameLift にアップロードする](https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UploadBuild](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/gamelift/upload-build.html)」を参照してください。 # AWS CLI を使用する Amazon Glacier の例 次のコード例は、Amazon Glacier で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `abort-multipart-upload` 次のコード例は、`abort-multipart-upload` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、`my-vault` という名前のボールトへの進行中のマルチパートアップロードを削除します。 ``` aws glacier abort-multipart-upload --account-id - --vault-name my-vault --upload-id 19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ ``` このコマンドでは、出力が生成されません。Amazon Glacier では、オペレーションを実行する際にアカウント ID 引数が必要ですが、ハイフンを使用して使用中のアカウントを指定できます。アップロード ID は `aws glacier initiate-multipart-upload` コマンドによって返され、`aws glacier list-multipart-uploads` を使用して取得することもできます。 AWS CLI を使用した Amazon Glacier へのマルチパートアップロードの詳細については、「*AWS CLI ユーザーガイド*」の「Amazon Glacier の使用」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AbortMultipartUpload](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/abort-multipart-upload.html)」を参照してください。 ### `abort-vault-lock` 次のコード例は、`abort-vault-lock` を使用する方法を示しています。 **AWS CLI** **進行中のボールトロックプロセスを中止するには** 次の `abort-vault-lock` の例では、指定されたボールトからボールトロックポリシーを削除し、ボールトロックのロック状態をロック解除にリセットします。 ``` aws glacier abort-vault-lock \ --account-id - \ --vault-name MyVaultName ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Glacier API デベロッパーガイド*」の「[ボールトロックを中止する (DELETE ロックポリシー)](https://docs.aws.amazon.com/amazonglacier/latest/dev/api-AbortVaultLock.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AbortVaultLock](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/abort-vault-lock.html)」を参照してください。 ### `add-tags-to-vault` 次のコード例は、`add-tags-to-vault` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、`my-vault` という名前のボールトに 2 つのタグを追加します。 ``` aws glacier add-tags-to-vault --account-id - --vault-name my-vault --tags id=1234,date=july2015 ``` Amazon Glacier では、オペレーションを実行する際にアカウント ID 引数が必要ですが、ハイフンを使用して使用中のアカウントを指定できます。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddTagsToVault](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/add-tags-to-vault.html)」を参照してください。 ### `complete-multipart-upload` 次のコード例は、`complete-multipart-upload` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、3 MiB アーカイブのマルチパートアップロードを完了します。 ``` aws glacier complete-multipart-upload --archive-size 3145728 --checksum 9628195fcdbcbbe76cdde456d4646fa7de5f219fb39823836d81f0cc0e18aa67 --upload-id 19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ --account-id - --vault-name my-vault ``` Amazon Glacier では、オペレーションを実行する際にアカウント ID 引数が必要ですが、ハイフンを使用して使用中のアカウントを指定できます。 アップロード ID は `aws glacier initiate-multipart-upload` コマンドによって返され、`aws glacier list-multipart-uploads` を使用して取得することもできます。チェックサムパラメータは、アーカイブの SHA-256 ツリーハッシュを 16 進数で取得します。 ツリーハッシュの計算に関する手順を含め、AWS CLI を使用した Amazon Glacier へのマルチパートアップロードの詳細については、「*AWS CLI ユーザーガイド*」の「Amazon Glacier の使用」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[CompleteMultipartUpload](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/complete-multipart-upload.html)」を参照してください。** ### `complete-vault-lock` 次のコード例は、`complete-vault-lock` を使用する方法を示しています。 **AWS CLI** **進行中のボールトロックプロセスを完了するには** 次の `complete-vault-lock` の例では、指定されたボールトの進行中のロック進行状況を完了し、ボールトロックのロック状態を `Locked` に設定します。`initiate-lock-process` を実行すると、`lock-id` パラメータの値を取得します。 ``` aws glacier complete-vault-lock \ --account-id - \ --vault-name MyVaultName \ --lock-id 9QZgEXAMPLEPhvL6xEXAMPLE ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Glacier API デベロッパーガイド*」の「[完全なボールトロック (POST lockId)](https://docs.aws.amazon.com/amazonglacier/latest/dev/api-CompleteVaultLock.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CompleteVaultLock](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/complete-vault-lock.html)」を参照してください。 ### `create-vault` 次のコード例は、`create-vault` を使用する方法を示しています。 **AWS CLI** 次のコマンドでは、`my-vault` という名前の新しいボールトが作成されます。 ``` aws glacier create-vault --vault-name my-vault --account-id - ``` Amazon Glacier では、オペレーションを実行する際にアカウント ID 引数が必要ですが、ハイフンを使用して使用中のアカウントを指定できます。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateVault](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/create-vault.html)」を参照してください。 ### `delete-archive` 次のコード例は、`delete-archive` を使用する方法を示しています。 **AWS CLI** **ボールトからアーカイブを削除するには** 次の `delete-archive` の例では、`example_vault` から指定されたアーカイブを削除します。 ``` aws glacier delete-archive \ --account-id 111122223333 \ --vault-name example_vault \ --archive-id Sc0u9ZP8yaWkmh-XGlIvAVprtLhaLCGnNwNl5I5x9HqPIkX5mjc0DrId3Ln-Gi_k2HzmlIDZUz117KSdVMdMXLuFWi9PJUitxWO73edQ43eTlMWkH0pd9zVSAuV_XXZBVhKhyGhJ7w ``` このコマンドは何も出力しません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteArchive](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/delete-archive.html)」を参照してください。 ### `delete-vault-access-policy` 次のコード例は、`delete-vault-access-policy` を使用する方法を示しています。 **AWS CLI** **ボールトのアクセスポリシーを削除するには** 次の `delete-vault-access-policy` の例では、指定されたボールトのアクセスポリシーを削除します。 ``` aws glacier delete-vault-access-policy \ --account-id 111122223333 \ --vault-name example_vault ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteVaultAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/delete-vault-access-policy.html)」を参照してください。 ### `delete-vault-notifications` 次のコード例は、`delete-vault-notifications` を使用する方法を示しています。 **AWS CLI** **ボールトの SNS 通知を削除するには** 次の `delete-vault-notifications` の例は、指定されたボールトに対して Amazon Simple Notification Service (Amazon SNS) で送信される通知を削除します。 ``` aws glacier delete-vault-notifications \ --account-id 111122223333 \ --vault-name example_vault ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteVaultNotifications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/delete-vault-notifications.html)」を参照してください。 ### `delete-vault` 次のコード例は、`delete-vault` を使用する方法を示しています。 **AWS CLI** 次のコマンドでは、`my-vault` という名前のボールトが削除されます。 ``` aws glacier delete-vault --vault-name my-vault --account-id - ``` このコマンドでは、出力が生成されません。Amazon Glacier では、オペレーションを実行する際にアカウント ID 引数が必要ですが、ハイフンを使用して使用中のアカウントを指定できます。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteVault](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/delete-vault.html)」を参照してください。 ### `describe-job` 次のコード例は、`describe-job` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、`my-vault` という名前のボールトでのインベントリ取得ジョブに関する情報を取得します。 ``` aws glacier describe-job --account-id - --vault-name my-vault --job-id zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW ``` 出力: ``` { "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" } ``` ジョブ ID は、`aws glacier initiate-job` と `aws glacier list-jobs` の出力にあります。Amazon Glacier では、オペレーションを実行する際にアカウント ID 引数が必要ですが、ハイフンを使用して使用中のアカウントを指定できます。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/describe-job.html)」を参照してください。 ### `describe-vault` 次のコード例は、`describe-vault` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、`my-vault` という名前のボールトに関するデータを取得します。 ``` aws glacier describe-vault --vault-name my-vault --account-id - ``` Amazon Glacier では、オペレーションを実行する際にアカウント ID 引数が必要ですが、ハイフンを使用して使用中のアカウントを指定できます。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeVault](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/describe-vault.html)」を参照してください。 ### `get-data-retrieval-policy` 次のコード例は、`get-data-retrieval-policy` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、使用中アカウントのデータ取得ポリシーを取得します。 ``` aws glacier get-data-retrieval-policy --account-id - ``` 出力: ``` { "Policy": { "Rules": [ { "BytesPerHour": 10737418240, "Strategy": "BytesPerHour" } ] } } ``` Amazon Glacier では、オペレーションを実行する際にアカウント ID 引数が必要ですが、ハイフンを使用して使用中のアカウントを指定できます。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDataRetrievalPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/get-data-retrieval-policy.html)」を参照してください。 ### `get-job-output` 次のコード例は、`get-job-output` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、ボールトインベントリジョブの出力を、現在のディレクトリの `output.json` という名前のファイルに保存します。 ``` aws glacier get-job-output --account-id - --vault-name my-vault --job-id zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW output.json ``` `job-id` は、`aws glacier list-jobs` の出力にあります。出力ファイル名はオプション名の前に付いていない位置引数であることに注意してください。Amazon Glacier では、オペレーションを実行する際にアカウント ID 引数が必要ですが、ハイフンを使用して使用中のアカウントを指定できます。 出力: ``` { "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"}]} ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetJobOutput](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/get-job-output.html)」を参照してください。 ### `get-vault-access-policy` 次のコード例は、`get-vault-access-policy` を使用する方法を示しています。 **AWS CLI** **ボールトのアクセスポリシーを取得するには** 次の `get-vault-access-policy` の例では、指定されたボールトのアクセスポリシーを取得します。 ``` aws glacier get-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\"}]}" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetVaultAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/get-vault-access-policy.html)」を参照してください。 ### `get-vault-lock` 次のコード例は、`get-vault-lock` を使用する方法を示しています。 **AWS CLI** **ボールトロックの詳細を取得するには** 次の `get-vault-lock` の例では、指定されたボールトのロックに関する詳細情報を取得しました。 ``` aws glacier get-vault-lock \ --account-id - \ --vault-name MyVaultName ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Glacier API デベロッパーガイド*」の「[ボールトロックを取得する (GET ロックポリシー)](https://docs.aws.amazon.com/amazonglacier/latest/dev/api-GetVaultLock.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetVaultLock](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/get-vault-lock.html)」を参照してください。 ### `get-vault-notifications` 次のコード例は、`get-vault-notifications` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、`my-vault` という名前のボールトの通知設定の説明を取得します。 ``` aws glacier get-vault-notifications --account-id - --vault-name my-vault ``` 出力: ``` { "vaultNotificationConfig": { "Events": [ "InventoryRetrievalCompleted", "ArchiveRetrievalCompleted" ], "SNSTopic": "arn:aws:sns:us-west-2:0123456789012:my-vault" } } ``` ボールトに通知が設定されていない場合、エラーが返されます。Amazon Glacier では、オペレーションを実行する際にアカウント ID 引数が必要ですが、ハイフンを使用して使用中のアカウントを指定できます。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetVaultNotifications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/get-vault-notifications.html)」を参照してください。 ### `initiate-job` 次のコード例は、`initiate-job` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、ボールト `my-vault` のインベントリを取得するジョブを開始します。 ``` aws glacier initiate-job --account-id - --vault-name my-vault --job-parameters '{"Type": "inventory-retrieval"}' ``` 出力: ``` { "location": "/0123456789012/vaults/my-vault/jobs/zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW", "jobId": "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW" } ``` Amazon Glacier では、オペレーションを実行する際にアカウント ID 引数が必要ですが、ハイフンを使用して使用中のアカウントを指定できます。 次のコマンドは、ボールト `my-vault` からアーカイブを取得するジョブを開始します。 ``` aws glacier initiate-job --account-id - --vault-name my-vault --job-parameters file://job-archive-retrieval.json ``` `job-archive-retrieval.json` はローカルフォルダ内の JSON ファイルで、ジョブのタイプ、アーカイブ ID、いくつかのオプションパラメータを指定する以下の内容を含みます。 ``` { "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" } ``` アーカイブ ID は、`aws glacier upload-archive` および `aws glacier get-job-output` の出力で確認できます。 出力: ``` { "location": "/011685312445/vaults/mwunderl/jobs/l7IL5-EkXyEY9Ws95fClzIbk2O5uLYaFdAYOi-azsX_Z8V6NH4yERHzars8wTKYQMX6nBDI9cMNHzyZJO59-8N9aHWav", "jobId": "l7IL5-EkXy2O5uLYaFdAYOiEY9Ws95fClzIbk-azsX_Z8V6NH4yERHzars8wTKYQMX6nBDI9cMNHzyZJO59-8N9aHWav" } ``` ジョブパラメータの形式の詳細については、「*Amazon Glacier API リファレンス*」の「ジョブの開始」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[InitiateJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/initiate-job.html)」を参照してください。 ### `initiate-multipart-upload` 次のコード例は、`initiate-multipart-upload` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、ファイルごとに 1 MiB (1024 x 1024 バイト) のパートサイズで、`my-vault` という名前のボールトへのマルチパートアップロードを開始します。 ``` aws glacier initiate-multipart-upload --account-id - --part-size 1048576 --vault-name my-vault --archive-description "multipart upload test" ``` アーカイブの説明パラメータはオプションです。Amazon Glacier では、オペレーションを実行する際にアカウント ID 引数が必要ですが、ハイフンを使用して使用中のアカウントを指定できます。 このコマンドは、成功するとアップロード ID を出力します。`aws glacier upload-multipart-part` でアーカイブの各部分をアップロードするときは、アップロード ID を使用します。AWS CLI を使用した Amazon Glacier へのマルチパートアップロードの詳細については、「*AWS CLI ユーザーガイド*」の「Amazon Glacier の使用」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[InitiateMultipartUpload](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/initiate-multipart-upload.html)」を参照してください。 ### `initiate-vault-lock` 次のコード例は、`initiate-vault-lock` を使用する方法を示しています。 **AWS CLI** **ボールトロック処理を開始するには** 次の `initiate-vault-lock` の例では、指定されたボールトにボールトロックポリシーをインストールし、ボールトロックのロック状態を `InProgress` に設定します。ボールトロック処理を完了するには、24 時間以内に `complete-vault-lock` を呼び出してボールトロックの状態を `Locked` に設定します。 ``` aws glacier initiate-vault-lock \ --account-id - \ --vault-name MyVaultName \ --policy file://vault_lock_policy.json ``` `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\"}}}]}"} ``` 出力は、ボールトロックプロセスを完了するために使用できるボールトロック ID です。 ``` { "lockId": "9QZgEXAMPLEPhvL6xEXAMPLE" } ``` 詳細については、「*Amazon Glacier API デベロッパーガイド*」の「[ボールトロックを開始する (POST ロックポリシー)](https://docs.aws.amazon.com/amazonglacier/latest/dev/api-InitiateVaultLock.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[InitiateVaultLock](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/initiate-vault-lock.html)」を参照してください。 ### `list-jobs` 次のコード例は、`list-jobs` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、`my-vault` という名前のボールトで進行中のジョブと最近完了したジョブを一覧表示します。 ``` aws glacier list-jobs --account-id - --vault-name my-vault ``` 出力: ``` { "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"" } ] } ``` Amazon Glacier では、オペレーションを実行する際にアカウント ID 引数が必要ですが、ハイフンを使用して使用中のアカウントを指定できます。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/list-jobs.html)」を参照してください。 ### `list-multipart-uploads` 次のコード例は、`list-multipart-uploads` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、`my-vault` という名前のボールトに対して進行中のすべてのマルチパートアップロードを示しています。 ``` aws glacier list-multipart-uploads --account-id - --vault-name my-vault ``` Amazon Glacier では、オペレーションを実行する際にアカウント ID 引数が必要ですが、ハイフンを使用して使用中のアカウントを指定できます。 AWS CLI を使用した Amazon Glacier へのマルチパートアップロードの詳細については、「*AWS CLI ユーザーガイド*」の「Amazon Glacier の使用」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[ListMultipartUploads](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/list-multipart-uploads.html)」を参照してください。** ### `list-parts` 次のコード例は、`list-parts` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、`my-vault` という名前のボールトへのマルチパートアップロード用にアップロードされたパートを一覧表示します。 ``` aws glacier list-parts --account-id - --vault-name my-vault --upload-id "SYZi7qnL-YGqGwAm8Kn3BLP2ElNCvnB-5961R09CSaPmPwkYGHOqeN_nX3-Vhnd2yF0KfB5FkmbnBU9GubbdrCs8ut-D" ``` 出力: ``` { "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 } ``` Amazon Glacier では、オペレーションを実行する際にアカウント ID 引数が必要ですが、ハイフンを使用して使用中のアカウントを指定できます。 AWS CLI を使用した Amazon Glacier へのマルチパートアップロードの詳細については、「*AWS CLI ユーザーガイド*」の「Amazon Glacier の使用」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListParts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/list-parts.html)」を参照してください。 ### `list-provisioned-capacity` 次のコード例は、`list-provisioned-capacity` を使用する方法を示しています。 **AWS CLI** **プロビジョニングされたキャパシティーユニットを取得するには** 次の `list-provisioned-capacity` の例では、指定されたアカウントのプロビジョニングされたキャパシティユニットの詳細を取得します。 ``` aws glacier list-provisioned-capacity \ --account-id 111122223333 ``` 出力: ``` { "ProvisionedCapacityList": [ { "CapacityId": "HpASAuvfRFiVDbOjMfEIcr8K", "ExpirationDate": "2020-03-18T19:59:24.000Z", "StartDate": "2020-02-18T19:59:24.912Z" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListProvisionedCapacity](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/list-provisioned-capacity.html)」を参照してください。 ### `list-tags-for-vault` 次のコード例は、`list-tags-for-vault` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、`my-vault` という名前のボールトに適用されたタグを一覧表示します。 ``` aws glacier list-tags-for-vault --account-id - --vault-name my-vault ``` 出力: ``` { "Tags": { "date": "july2015", "id": "1234" } } ``` Amazon Glacier では、オペレーションを実行する際にアカウント ID 引数が必要ですが、ハイフンを使用して使用中のアカウントを指定できます。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForVault](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/list-tags-for-vault.html)」を参照してください。 ### `list-vaults` 次のコード例は、`list-vaults` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、デフォルトのアカウントとリージョンのボールトを一覧表示します。 ``` aws glacier list-vaults --account-id - ``` 出力: ``` { "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" } ] } ``` Amazon Glacier では、オペレーションを実行する際にアカウント ID 引数が必要ですが、ハイフンを使用して使用中のアカウントを指定できます。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListVaults](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/list-vaults.html)」を参照してください。 ### `purchase-provisioned-capacity` 次のコード例は、`purchase-provisioned-capacity` を使用する方法を示しています。 **AWS CLI** **プロビジョニングされたキャパシティーユニットを購入するには** 次の `purchase-provisioned-capacity` の例では、プロビジョニングされたキャパシティユニットを購入します。 ``` aws glacier purchase-provisioned-capacity \ --account-id 111122223333 ``` 出力: ``` { "capacityId": "HpASAuvfRFiVDbOjMfEIcr8K" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PurchaseProvisionedCapacity](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/purchase-provisioned-capacity.html)」を参照してください。 ### `remove-tags-from-vault` 次のコード例は、`remove-tags-from-vault` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、`my-vault` という名前のボールトから `date` キーを持つタグを削除します。 ``` aws glacier remove-tags-from-vault --account-id - --vault-name my-vault --tag-keys date ``` Amazon Glacier では、オペレーションを実行する際にアカウント ID 引数が必要ですが、ハイフンを使用して使用中のアカウントを指定できます。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveTagsFromVault](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/remove-tags-from-vault.html)」を参照してください。 ### `set-data-retrieval-policy` 次のコード例は、`set-data-retrieval-policy` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、使用中アカウントのデータ取得ポリシーを設定します。 ``` aws glacier set-data-retrieval-policy --account-id - --policy file://data-retrieval-policy.json ``` `data-retrieval-policy.json` は、データ取得ポリシーを指定する現在のフォルダ内の JSON ファイルです。 ``` { "Rules":[ { "Strategy":"BytesPerHour", "BytesPerHour":10737418240 } ] } ``` Amazon Glacier では、オペレーションを実行する際にアカウント ID 引数が必要ですが、ハイフンを使用して使用中のアカウントを指定できます。 次のコマンドは、インライン JSON を使用するようにデータ取得ポリシーを `FreeTier` に設定します。 ``` aws glacier set-data-retrieval-policy --account-id - --policy '{"Rules":[{"Strategy":"FreeTier"}]}' ``` ポリシー形式の詳細については、「*Amazon Glacier API リファレンス*」の「データ取得ポリシーを設定する」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetDataRetrievalPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/set-data-retrieval-policy.html)」を参照してください。 ### `set-vault-access-policy` 次のコード例は、`set-vault-access-policy` を使用する方法を示しています。 **AWS CLI** **ボールトのアクセスポリシーを設定するには** 次の `set-vault-access-policy` の例では、指定されたボールトにアクセス許可ポリシーをアタッチします。 ``` 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\"}]}"}' ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetVaultAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/set-vault-access-policy.html)」を参照してください。 ### `set-vault-notifications` 次のコード例は、`set-vault-notifications` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、`my-vault` という名前のボールトの SNS 通知を設定します。 ``` aws glacier set-vault-notifications --account-id - --vault-name my-vault --vault-notification-config file://notificationconfig.json ``` `notificationconfig.json` は、現在のフォルダにある JSON ファイルで、公開する SNS トピックとイベントを指定します。 ``` { "SNSTopic": "arn:aws:sns:us-west-2:0123456789012:my-vault", "Events": ["ArchiveRetrievalCompleted", "InventoryRetrievalCompleted"] } ``` Amazon Glacier では、オペレーションを実行する際にアカウント ID 引数が必要ですが、ハイフンを使用して使用中のアカウントを指定できます。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetVaultNotifications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/set-vault-notifications.html)」を参照してください。 ### `upload-archive` 次のコード例は、`upload-archive` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、`archive.zip` という名前の現在のフォルダにあるアーカイブを、`my-vault` という名前のボールトにアップロードします。 ``` aws glacier upload-archive --account-id - --vault-name my-vault --body archive.zip ``` 出力: ``` { "archiveId": "kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw", "checksum": "969fb39823836d81f0cc028195fcdbcbbe76cdde932d4646fa7de5f21e18aa67", "location": "/0123456789012/vaults/my-vault/archives/kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw" } ``` Amazon Glacier では、オペレーションを実行する際にアカウント ID 引数が必要ですが、ハイフンを使用して使用中のアカウントを指定できます。 アップロードしたアーカイブを取得するには、aws glacier initiate-job コマンドを使用して取得ジョブを開始します。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UploadArchive](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/upload-archive.html)」を参照してください。 ### `upload-multipart-part` 次のコード例は、`upload-multipart-part` を使用する方法を示しています。 **AWS CLI** 次のコマンドは、アーカイブの最初の 1 MiB (1024 x 1024 バイト) の部分をアップロードします。 ``` aws glacier upload-multipart-part --body part1 --range 'bytes 0-1048575/*' --account-id - --vault-name my-vault --upload-id 19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ ``` Amazon Glacier では、オペレーションを実行する際にアカウント ID 引数が必要ですが、ハイフンを使用して使用中のアカウントを指定できます。 body パラメータは、ローカルファイルシステム上のパートファイルへのパスを受け取ります。range パラメータは、完了したアーカイブ内でそのパートが占めるバイト数を示す HTTP コンテンツ範囲を受け取ります。アップロード ID は `aws glacier initiate-multipart-upload` コマンドによって返され、`aws glacier list-multipart-uploads` を使用して取得することもできます。 AWS CLI を使用した Amazon Glacier へのマルチパートアップロードの詳細については、「*AWS CLI ユーザーガイド*」の「Amazon Glacier の使用」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UploadMultipartPart](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glacier/upload-multipart-part.html)」を参照してください。 # Global Accelerator examples using AWS CLI 次のコード例は、Global Accelerator で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `add-custom-routing-endpoints` 次のコード例は、`add-custom-routing-endpoints` を使用する方法を示しています。 **AWS CLI** **カスタムルーティングアクセラレーターのエンドポイントグループに VPC サブネットエンドポイントを追加するには** 次の `add-custom-routing-endpoints` の例では、VPC サブネットエンドポイントをカスタムルーティングアクセラレーターのエンドポイントグループに追加します。 ``` 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" ``` 出力: ``` { "EndpointDescriptions": [ { "EndpointId": "subnet-1234567890abcdef0" } ], "EndpointGroupArn":"arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz/endpoint-group/4321abcd" } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のカスタムルーティングアクセラレーターの VPC サブネットエンドポイント](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-endpoints.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddCustomRoutingEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/add-custom-routing-endpoints.html)」を参照してください。 ### `advertise-byoip-cidr` 次のコード例は、`advertise-byoip-cidr` を使用する方法を示しています。 **AWS CLI** **アドレス範囲をアドバタイズするには** 次の `advertise-byoip-cidr` の例では、AWS リソースで使用できるようにプロビジョニングしたアドレス範囲をアドバタイズするように AWS にリクエストしています。 ``` aws globalaccelerator advertise-byoip-cidr \ --cidr 198.51.100.0/24 ``` 出力: ``` { "ByoipCidr": { "Cidr": "198.51.100.0/24", "State": "PENDING_ADVERTISING" } } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator の Bring Your Own IP アドレス](https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AdvertiseByoipCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/advertise-byoip-cidr.html)」を参照してください。 ### `allow-custom-routing-traffic` 次のコード例は、`allow-custom-routing-traffic` を使用する方法を示しています。 **AWS CLI** **カスタムルーティングアクセラレーターの VPC サブネット内の特定の Amazon EC2 インスタンスの送信先へのトラフィックを許可するには** 次の `allow-custom-routing-traffic` の例では、カスタムルーティングアクセラレーターでトラフィックを受信できる VPC サブネットエンドポイントの特定の Amazon EC2 インスタンス (送信先) IP アドレスとポートへのトラフィックが許可されていることを指定します。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のカスタムルーティングアクセラレーターの VPC サブネットエンドポイント](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-endpoints.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AllowCustomRoutingTraffic](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/allow-custom-routing-traffic.html)」を参照してください。 ### `create-accelerator` 次のコード例は、`create-accelerator` を使用する方法を示しています。 **AWS CLI** **アクセラレーターを作成するには** 次の `create-accelerator` の例では、2 つの BYOIP 静的 IP アドレスを持つ 2 つのタグを持つアクセラレーターを作成します。アクセラレーターを作成または更新するには、`US-West-2 (Oregon)` リージョンを指定する必要があります。 ``` 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 ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のアクセラレーター](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-accelerators.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateAccelerator](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/create-accelerator.html)」を参照してください。 ### `create-custom-routing-accelerator` 次のコード例は、`create-custom-routing-accelerator` を使用する方法を示しています。 **AWS CLI** **カスタムルーティングアクセラレーターを作成するには** 次の `create-custom-routing-accelerator` の例では、`Name` タグ `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 ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のカスタムルーティングアクセラレーター](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-accelerators.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCustomRoutingAccelerator](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/create-custom-routing-accelerator.html)」を参照してください。 ### `create-custom-routing-endpoint-group` 次のコード例は、`create-custom-routing-endpoint-group` を使用する方法を示しています。 **AWS CLI** **カスタムルーティングアクセラレーターのエンドポイントグループを作成するには** 次の `create-custom-routing-endpoint-group` の例では、カスタムルーティングアクセラレーターのエンドポイントグループを作成します。 ``` 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" ``` 出力: ``` { "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": [] } } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のカスタムルーティングアクセラレーターのエンドポイントグループ](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-endpoint-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCustomRoutingEndpointGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/create-custom-routing-endpoint-group.html)」を参照してください。 ### `create-custom-routing-listener` 次のコード例は、`create-custom-routing-listener` を使用する方法を示しています。 **AWS CLI** **カスタムルーティングアクセラレーターのリスナーを作成するには** 次の `create-custom-routing-listener` の例では、カスタムルーティングアクセラレーターのポート範囲が 5000～10000 のリスナーを作成します。 ``` aws globalaccelerator create-custom-routing-listener \ --accelerator-arn arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh \ --port-ranges FromPort=5000,ToPort=10000 ``` 出力: ``` { "Listener": { "PortRange": [ "FromPort": 5000, "ToPort": 10000 ], "ListenerArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz" } } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のカスタムルーティングアクセラレーターのリスナー](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-listeners.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCustomRoutingListener](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/create-custom-routing-listener.html)」を参照してください。 ### `create-endpoint-group` 次のコード例は、`create-endpoint-group` を使用する方法を示しています。 **AWS CLI** **エンドポイントグループを作成するには** 次の `create-endpoint-group` の例では、1 つのエンドポイントを持つエンドポイントグループを作成します。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のエンドポイントグループ](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateEndpointGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/create-endpoint-group.html)」を参照してください。 ### `create-listener` 次のコード例は、`create-listener` を使用する方法を示しています。 **AWS CLI** **リスナーを作成するには** 次の `create-listener` の例では、2 つのポートを持つリスナーを作成します。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のリスナー](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-listeners.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[CreateListener](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/create-listener.html)」を参照してください。** ### `deny-custom-routing-traffic` 次のコード例は、`deny-custom-routing-traffic` を使用する方法を示しています。 **AWS CLI** **カスタムルーティングアクセラレーターでトラフィックを受信できない送信先アドレスを指定するには** 次の `deny-custom-routing-traffic` の例では、カスタムルーティングアクセラレーターのトラフィックを受信できないサブネットエンドポイントの送信先アドレスを指定します。複数の送信先アドレスを指定するには、アドレスをスペースで区切ります。deny-custom-routing-traffic 呼び出しが成功してもレスポンスはありません。 ``` 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" ``` このコマンドでは何も出力されません。 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のカスタムルーティングアクセラレーターの VPC サブネットエンドポイント](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-endpoints.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DenyCustomRoutingTraffic](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/deny-custom-routing-traffic.html)」を参照してください。 ### `deprovision-byoip-cidr` 次のコード例は、`deprovision-byoip-cidr` を使用する方法を示しています。 **AWS CLI** **アドレス範囲のプロビジョニングを解除するには** 次の `deprovision-byoip-cidr` の例では、AWS リソースで使用するようにプロビジョニングした指定されたアドレス範囲を解放します。 ``` aws globalaccelerator deprovision-byoip-cidr \ --cidr "198.51.100.0/24" ``` 出力: ``` { "ByoipCidr": { "Cidr": "198.51.100.0/24", "State": "PENDING_DEPROVISIONING" } } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator の Bring Your Own IP アドレス](https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeprovisionByoipCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/deprovision-byoip-cidr.html)」を参照してください。 ### `describe-accelerator-attributes` 次のコード例は、`describe-accelerator-attributes` を使用する方法を示しています。 **AWS CLI** **アクセラレーターの属性を記述するには** 次の `describe-accelerator-attributes` の例は、アクセラレーターの属性の詳細を取得します。 ``` aws globalaccelerator describe-accelerator-attributes \ --accelerator-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh ``` 出力: ``` { "AcceleratorAttributes": { "FlowLogsEnabled": true "FlowLogsS3Bucket": flowlogs-abc "FlowLogsS3Prefix": bucketprefix-abc } } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のアクセラレーター](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-accelerators.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAcceleratorAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/describe-accelerator-attributes.html)」を参照してください。 ### `describe-accelerator` 次のコード例は、`describe-accelerator` を使用する方法を示しています。 **AWS CLI** **アクセラレーターを記述するには** 次の `describe-accelerator` の例では、指定されたアクセラレーターの詳細情報を取得します。 ``` aws globalaccelerator describe-accelerator \ --accelerator-arn arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のアクセラレーター](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-accelerators.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAccelerator](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/describe-accelerator.html)」を参照してください。 ### `describe-custom-routing-accelerator-attributes` 次のコード例は、`describe-custom-routing-accelerator-attributes` を使用する方法を示しています。 **AWS CLI** **カスタムルーティングアクセラレーターの属性を記述するには** 次の `describe-custom-routing-accelerator-attributes` の例では、カスタムルーティングアクセラレーターの属性について記述します。 ``` aws globalaccelerator describe-custom-routing-accelerator-attributes \ --accelerator-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh ``` 出力: ``` { "AcceleratorAttributes": { "FlowLogsEnabled": false } } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のカスタムルーティングアクセラレーター](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-accelerators.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeCustomRoutingAcceleratorAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/describe-custom-routing-accelerator-attributes.html)」を参照してください。 ### `describe-custom-routing-accelerator` 次のコード例は、`describe-custom-routing-accelerator` を使用する方法を示しています。 **AWS CLI** **カスタムルーティングアクセラレーターを記述するには** 次の `describe-custom-routing-accelerator` の例では、指定されたカスタムルーティングアクセラレーターの詳細を取得します。 ``` aws globalaccelerator describe-custom-routing-accelerator \ --accelerator-arn arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のカスタムルーティングアクセラレーター](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-accelerators.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeCustomRoutingAccelerator](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/describe-custom-routing-accelerator.html)」を参照してください。 ### `describe-custom-routing-endpoint-group` 次のコード例は、`describe-custom-routing-endpoint-group` を使用する方法を示しています。 **AWS CLI** **カスタムルーティングアクセラレーターのエンドポイントグループを記述するには** 次の `describe-custom-routing-endpoint-group` の例では、カスタムルーティングアクセラレーターのエンドポイントグループを記述します。 ``` 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 ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のカスタムルーティングアクセラレーターのエンドポイントグループ](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-endpoint-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeCustomRoutingEndpointGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/describe-custom-routing-endpoint-group.html)」を参照してください。 ### `describe-custom-routing-listener` 次のコード例は、`describe-custom-routing-listener` を使用する方法を示しています。 **AWS CLI** **カスタムルーティングアクセラレーターのリスナーを記述するには** 次の `describe-custom-routing-listener` の例では、カスタムルーティングアクセラレーターのリスナーにつを記述します。 ``` aws globalaccelerator describe-custom-routing-listener \ --listener-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234 ``` 出力: ``` { "Listener": { "PortRanges": [ "FromPort": 5000, "ToPort": 10000 ], "ListenerArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234" } } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のカスタムルーティングアクセラレーターのリスナー](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-listeners.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeCustomRoutingListener](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/describe-custom-routing-listener.html)」を参照してください。 ### `describe-endpoint-group` 次のコード例は、`describe-endpoint-group` を使用する方法を示しています。 **AWS CLI** **エンドポイントグループを記述するには** 次の `describe-endpoint-group` の例では、Amazon EC2 インスタンス、ALB、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 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のエンドポイントグループ](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEndpointGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/describe-endpoint-group.html)」を参照してください。 ### `describe-listener` 次のコード例は、`describe-listener` を使用する方法を示しています。 **AWS CLI** **リスナーを記述するには** 次の `describe-listener` の例では、リスナーを記述しています。 ``` aws globalaccelerator describe-listener \ --listener-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234 ``` 出力: ``` { "Listener": { "ListenerArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234", "PortRanges": [ { "FromPort": 80, "ToPort": 80 } ], "Protocol": "TCP", "ClientAffinity": "NONE" } } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のリスナー](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-listeners.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeListener](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/describe-listener.html)」を参照してください。 ### `list-accelerators` 次のコード例は、`list-accelerators` を使用する方法を示しています。 **AWS CLI** **アクセラレーターを一覧表示するには** 次の `list-accelerators` 例では、AWS アカウントのアクセラレーターを一覧表示します。このアカウントには 2 つのアクセラレーターがあります。 ``` aws globalaccelerator list-accelerators ``` 出力: ``` { "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 }, ] } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のアクセラレーター](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-accelerators.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAccelerators](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/list-accelerators.html)」を参照してください。 ### `list-byoip-cidr` 次のコード例は、`list-byoip-cidr` を使用する方法を示しています。 **AWS CLI** **アドレス範囲を一覧表示するには** 次の `list-byoip-cidr` の例では、Global Accelerator で使用するようにプロビジョニングした Bring Your Own IP アドレス (BYOIP) アドレス範囲を一覧表示します。 ``` aws globalaccelerator list-byoip-cidrs ``` 出力: ``` { "ByoipCidrs": [ { "Cidr": "198.51.100.0/24", "State": "READY" } { "Cidr": "203.0.113.25/24", "State": "READY" } ] } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator の Bring Your Own IP アドレス](https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListByoipCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/list-byoip-cidr.html)」を参照してください。 ### `list-custom-routing-accelerators` 次のコード例は、`list-custom-routing-accelerators` を使用する方法を示しています。 **AWS CLI** **カスタムルーティングアクセラレーターを一覧表示するには** 次の `list-custom-routing-accelerators` の例では、AWS アカウントのカスタムルーティングアクセラレーターを一覧表示します。 ``` aws globalaccelerator list-custom-routing-accelerators ``` 出力: ``` { "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 }, ] } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のカスタムルーティングアクセラレーター](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-accelerators.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListCustomRoutingAccelerators](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/list-custom-routing-accelerators.html)」を参照してください。 ### `list-custom-routing-endpoint-groups` 次のコード例は、`list-custom-routing-endpoint-groups` を使用する方法を示しています。 **AWS CLI** **カスタムルーティングアクセラレーターでリスナーのエンドポイントグループを一覧表示するには** 次の `list-custom-routing-endpoint-groups` の例では、カスタムルーティングアクセラレーターのリスナーのエンドポイントグループを一覧表示します。 ``` aws globalaccelerator list-custom-routing-endpoint-groups \ --listener-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234 ``` 出力: ``` { "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" } ] } ] } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のカスタムルーティングアクセラレーターのエンドポイントグループ](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-endpoint-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListCustomRoutingEndpointGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/list-custom-routing-endpoint-groups.html)」を参照してください。 ### `list-custom-routing-listeners` 次のコード例は、`list-custom-routing-listeners` を使用する方法を示しています。 **AWS CLI** **カスタムルーティングアクセラレーターのリスナーを一覧表示するには** 次の `list-custom-routing-listeners` の例では、カスタムルーティングアクセラレーターのリスナーを一覧表示します。 ``` aws globalaccelerator list-custom-routing-listeners \ --accelerator-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh ``` 出力: ``` { "Listeners": [ { "ListenerArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234", "PortRanges": [ { "FromPort": 5000, "ToPort": 10000 } ], "Protocol": "TCP" } ] } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のカスタムルーティングアクセラレーターのリスナー](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-listeners.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListCustomRoutingListeners](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/list-custom-routing-listeners.html)」を参照してください。 ### `list-custom-routing-port-mappings-by-destination` 次のコード例は、`list-custom-routing-port-mappings-by-destination` を使用する方法を示しています。 **AWS CLI** **特定のカスタムルーティングアクセラレーターの送信先のポートマッピングを一覧表示するには** 次の `list-custom-routing-port-mappings-by-destination` の例では、カスタムルーティングアクセラレーターの特定の送信先 EC2 サーバー (送信先アドレス) のポートマッピングを示します。 ``` aws globalaccelerator list-custom-routing-port-mappings-by-destination \ --endpoint-id subnet-abcd123example \ --destination-address 198.51.100.52 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator でのカスタムルーティングアクセラレーターの仕組み](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-how-it-works.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListCustomRoutingPortMappingsByDestination](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/list-custom-routing-port-mappings-by-destination.html)」を参照してください。 ### `list-custom-routing-port-mappings` 次のコード例は、`list-custom-routing-port-mappings` を使用する方法を示しています。 **AWS CLI** **カスタムルーティングアクセラレーターのポートマッピングを一覧表示するには** 次の `list-custom-routing-port-mappings` の例は、カスタムルーティングアクセラレーターのポートマッピングの部分的なリストを示しています。 ``` aws globalaccelerator list-custom-routing-port-mappings \ --accelerator-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator でのカスタムルーティングアクセラレーターの仕組み](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-how-it-works.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListCustomRoutingPortMappings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/list-custom-routing-port-mappings.html)」を参照してください。 ### `list-endpoint-groups` 次のコード例は、`list-endpoint-groups` を使用する方法を示しています。 **AWS CLI** **エンドポイントグループを一覧表示するには** 次の `list-endpoint-groups` の例では、リスナーのエンドポイントグループを一覧表示します。このリスナーには 2 つのエンドポイントグループがあります。 ``` aws globalaccelerator --region us-west-2 list-endpoint-groups \ --listener-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234 ``` 出力: ``` { "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 } ] } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のエンドポイントグループ](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListEndpointGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/list-endpoint-groups.html)」を参照してください。 ### `list-listeners` 次のコード例は、`list-listeners` を使用する方法を示しています。 **AWS CLI** **リスナーを一覧表示するには** 次の `list-listeners` の例では、アクセラレーターのリスナーを一覧表示します。 ``` aws globalaccelerator list-listeners \ --accelerator-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh ``` 出力: ``` { "Listeners": [ { "ListenerArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/abcdef1234", "PortRanges": [ { "FromPort": 80, "ToPort": 80 } ], "Protocol": "TCP", "ClientAffinity": "NONE" } ] } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のリスナー](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-listeners.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListListeners](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/list-listeners.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **アクセラレーターのタグを一覧表示するには** 次の `list-tags-for-resource` の例では、特定のアクセラレーターのタグを一覧表示します。 ``` aws globalaccelerator list-tags-for-resource \ --accelerator-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh ``` 出力: ``` { "Tags": [ { "Key": "Project", "Value": "A123456" } ] } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のタグ付け](https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/list-tags-for-resource.html)」を参照してください。 ### `provision-byoip-cidr` 次のコード例は、`provision-byoip-cidr` を使用する方法を示しています。 **AWS CLI** **アドレス範囲をプロビジョニングするには** 次の `provision-byoip-cidr` の例では、AWS リソースで使用する指定されたアドレス範囲をプロビジョニングします。 ``` aws globalaccelerator provision-byoip-cidr \ --cidr 192.0.2.250/24 \ --cidr-authorization-context Message="$text_message",Signature="$signed_message" ``` 出力: ``` { "ByoipCidr": { "Cidr": "192.0.2.250/24", "State": "PENDING_PROVISIONING" } } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator の Bring Your Own IP アドレス](https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ProvisionByoipCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/provision-byoip-cidr.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **アクセラレーターにタグを付けるには** 次の `tag-resource` の例では、タグ Name とタグ Project をアクセラレーターに追加し、それぞれに対応する値を追加します。 ``` 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" ``` このコマンドでは何も出力されません。 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のタグ付け](https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **アクセラレーターからタグを削除するには** 次の `untag-resource` の例では、アクセラレーターから Name タグと Project タグを削除します。 ``` aws globalaccelerator untag-resource \ --resource-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh \ --tag-keys Key="Name" Key="Project" ``` このコマンドでは何も出力されません。 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のタグ付け](https://docs.aws.amazon.com/global-accelerator/latest/dg/tagging-in-global-accelerator.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/untag-resource.html)」を参照してください。 ### `update-accelerator-attributes` 次のコード例は、`update-accelerator-attributes` を使用する方法を示しています。 **AWS CLI** **アクセラレーターの属性を更新するには** 次の `update-accelerator-attributes` の例では、フローログを有効にするためにアクセラレーターを更新します。アクセラレーター属性を作成または更新するには、`US-West-2 (Oregon)` リージョンを指定する必要があります。 ``` 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 ``` 出力: ``` { "AcceleratorAttributes": { "FlowLogsEnabled": true "FlowLogsS3Bucket": flowlogs-abc "FlowLogsS3Prefix": bucketprefix-abc } } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のアクセラレーター](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-accelerators.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateAcceleratorAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/update-accelerator-attributes.html)」を参照してください。 ### `update-accelerator` 次のコード例は、`update-accelerator` を使用する方法を示しています。 **AWS CLI** **アクセラレーターを更新するには** 次の `update-accelerator` の例では、アクセラレーター名を `ExampleAcceleratorNew` に変更するようにアクセラレーターを変更します。アクセラレーターを作成または更新するには、`US-West-2 (Oregon)` リージョンを指定する必要があります。 ``` aws globalaccelerator update-accelerator \ --accelerator-arn arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh \ --name ExampleAcceleratorNew ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のアクセラレーター](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-accelerators.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateAccelerator](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/update-accelerator.html)」を参照してください。 ### `update-custom-routing-accelerator-attributes` 次のコード例は、`update-custom-routing-accelerator-attributes` を使用する方法を示しています。 **AWS CLI** **カスタムルーティングアクセラレーターの属性を更新するには** 次の `update-custom-routing-accelerator-attributes` の例では、カスタムルーティングアクセラレーターを更新してフローログを有効にします。 ``` 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 ``` 出力: ``` { "AcceleratorAttributes": { "FlowLogsEnabled": true "FlowLogsS3Bucket": flowlogs-abc "FlowLogsS3Prefix": bucketprefix-abc } } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のカスタムルーティングアクセラレーター](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-accelerators.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateCustomRoutingAcceleratorAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/update-custom-routing-accelerator-attributes.html)」を参照してください。 ### `update-custom-routing-accelerator` 次のコード例は、`update-custom-routing-accelerator` を使用する方法を示しています。 **AWS CLI** **カスタムルーティングアクセラレーターを更新するには** 次の `update-custom-routing-accelerator` の例では、カスタムルーティングアクセラレーターを変更して、アクセラレーター名を変更します。 ``` aws globalaccelerator --region us-west-2 update-custom-routing-accelerator \ --accelerator-arn arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh \ --name ExampleCustomRoutingAcceleratorNew ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のカスタムルーティングアクセラレーター](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-accelerators.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateCustomRoutingAccelerator](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/update-custom-routing-accelerator.html)」を参照してください。 ### `update-custom-routing-listener` 次のコード例は、`update-custom-routing-listener` を使用する方法を示しています。 **AWS CLI** **カスタムルーティングアクセラレーターのリスナーを更新するには** 次の `update-custom-routing-listener` の例では、リスナーを更新してポート範囲を変更します。 ``` 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 ``` 出力: ``` { "Listener": { "ListenerArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz "PortRanges": [ { "FromPort": 10000, "ToPort": 20000 } ], "Protocol": "TCP" } } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のカスタムルーティングアクセラレーターのリスナー](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-custom-routing-listeners.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateCustomRoutingListener](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/update-custom-routing-listener.html)」を参照してください。 ### `update-endpoint-group` 次のコード例は、`update-endpoint-group` を使用する方法を示しています。 **AWS CLI** **エンドポイントグループを更新するには** 次の `update-endpoint-group` の例では、Elastic IP アドレス、ALB、NLB の 3 つのエンドポイントをエンドポイントグループに追加します。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のエンドポイントグループ](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-endpoint-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateEndpointGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/update-endpoint-group.html)」を参照してください。 ### `update-listener` 次のコード例は、`update-listener` を使用する方法を示しています。 **AWS CLI** **リスナーを更新するには** 次の `update-listener` の例では、リスナーを更新してポートを 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 ``` 出力: ``` { "Listener": { "ListenerArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz "PortRanges": [ { "FromPort": 100, "ToPort": 100 } ], "Protocol": "TCP", "ClientAffinity": "NONE" } } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator のリスナー](https://docs.aws.amazon.com/global-accelerator/latest/dg/about-listeners.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateListener](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/update-listener.html)」を参照してください。 ### `withdraw-byoip-cidr` 次のコード例は、`withdraw-byoip-cidr` を使用する方法を示しています。 **AWS CLI** **アドレス範囲を取り消すには** 次の `withdraw-byoip-cidr` の例では、以前に AWS リソースでの使用をアドバタイズした AWS Global Accelerator からアドレス範囲を取り消します。 ``` aws globalaccelerator withdraw-byoip-cidr \ --cidr 192.0.2.250/24 ``` 出力: ``` { "ByoipCidr": { "Cidr": "192.0.2.250/24", "State": "PENDING_WITHDRAWING" } } ``` 詳細については、「*AWS Global Accelerator デベロッパーガイド*」の「[AWS Global Accelerator の Bring Your Own IP アドレス](https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[WithdrawByoipCidr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/globalaccelerator/withdraw-byoip-cidr.html)」を参照してください。 # AWS Glue examples using AWS CLI 次のコード例では、AWS Glue で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `batch-stop-job-run` 次のコード例は、`batch-stop-job-run` を使用する方法を示しています。 **AWS CLI** **ジョブの実行を停止するには** 次の `batch-stop-job-run` の例ではジョブの実行を停止します。 ``` aws glue batch-stop-job-run \ --job-name "my-testing-job" \ --job-run-id jr_852f1de1f29fb62e0ba4166c33970803935d87f14f96cfdee5089d5274a61d3f ``` 出力: ``` { "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 } } ``` 詳細については、*AWS Glue デベロッパーガイド* の「[ジョブの実行](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-runs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchStopJobRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/batch-stop-job-run.html)」を参照してください。 ### `create-connection` 次のコード例は、`create-connection` を使用する方法を示しています。 **AWS CLI** **AWS Glue データストアの接続を作成するには** 次の `create-connection` の例では、Kafka データストアの接続情報を提供する接続を AWS Glue データカタログに作成します。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*AWS デベロッパーガイド*」の「[AWS Glue データカタログでの接続の定義](https://docs.aws.amazon.com/glue/latest/dg/populate-add-connection.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateConnection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/create-connection.html)」を参照してください。 ### `create-database` 次のコード例は、`create-database` を使用する方法を示しています。 **AWS CLI** **データベースを作成する** 次の `create-database` の例では、AWS Glue データカタログにデータベースを作成します。 ``` aws glue create-database \ --database-input "{\"Name\":\"tempdb\"}" \ --profile my_profile \ --endpoint https://glue.us-east-1.amazonaws.com ``` このコマンドでは何も出力されません。 詳細については、*AWS Glue デベロッパーガイド* の「[データカタログにデータベースを定義する](https://docs.aws.amazon.com/glue/latest/dg/define-database.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDatabase](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/create-database.html)」を参照してください。 ### `create-job` 次のコード例は、`create-job` を使用する方法を示しています。 **AWS CLI** **データを変換するジョブを作成するには** 次の `create-job` 例では、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 ``` `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() } } ``` 出力: ``` { "Name": "my-testing-job" } ``` 詳細については、*AWS デベロッパーガイド* の「[AWS Glue でのジョブの作成](https://docs.aws.amazon.com/glue/latest/dg/author-job.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス* の「[CreateJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/create-job.html)」を参照してください。 ### `create-table` 次のコード例は、`create-table` を使用する方法を示しています。 **AWS CLI** **例 1: Kinesis データストリームのテーブルを作成するには** 次の `create-table` の例では、Kinesis データストリームを記述するテーブルを AWS Glue データカタログに作成します。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、*AWS Glue デベロッパーガイド* の「[AWS Glue データカタログでのテーブルの定義](https://docs.aws.amazon.com/glue/latest/dg/tables-described.html)」を参照してください。 **例 2: Kafka データストアのテーブルを作成するには** 次の `create-table` の例では、Kafka データストアを記述するテーブルを AWS Glue データカタログに作成します。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、*AWS Glue デベロッパーガイド* の「[AWS Glue データカタログでのテーブルの定義](https://docs.aws.amazon.com/glue/latest/dg/tables-described.html)」を参照してください。 **例 3: AWS S3 データストアのテーブルを作成するには** 次の `create-table` の例では、AWS Simple Storage Service (AWS S3) データストアを記述するテーブルを AWS Glue データカタログに作成します。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、*AWS Glue デベロッパーガイド* の「[AWS Glue データカタログでのテーブルの定義](https://docs.aws.amazon.com/glue/latest/dg/tables-described.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateTable](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/create-table.html)」を参照してください。 ### `delete-job` 次のコード例は、`delete-job` を使用する方法を示しています。 **AWS CLI** **ジョブを削除するには** 次の `delete-job` 例では、不要になったジョブを削除します。 ``` aws glue delete-job \ --job-name my-testing-job ``` 出力: ``` { "JobName": "my-testing-job" } ``` 詳細については、*AWS Glue デベロッパーガイド* の「[AWS Glue コンソールでのジョブの操作](https://docs.aws.amazon.com/glue/latest/dg/console-jobs.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス* の「[DeleteJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/delete-job.html)」を参照してください。 ### `get-databases` 次のコード例は、`get-databases` を使用する方法を示しています。 **AWS CLI** **AWS Glue データカタログの一部またはすべてのデータベースの定義を一覧表示するには** 次の `get-databases` の例では、データカタログのデータベースに関する情報を返します。 ``` aws glue get-databases ``` 出力: ``` { "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" } ] } ``` 詳細については、*AWS Glue デベロッパーガイド* の「[データカタログにデータベースを定義する](https://docs.aws.amazon.com/glue/latest/dg/define-database.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス* の「[GetDatabases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/get-databases.html)」を参照してください。 ### `get-job-run` 次のコード例は、`get-job-run` を使用する方法を示しています。 **AWS CLI** **ジョブの実行に関する情報を取得するには** 次の `get-job-run` の例では、ジョブ実行に関する情報を取得します。　 ``` aws glue get-job-run \ --job-name "Combine legistators data" \ --run-id jr_012e176506505074d94d761755e5c62538ee1aad6f17d39f527e9140cf0c9a5e ``` 出力: ``` { "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" } } ``` 詳細については、*AWS Glue デベロッパーガイド* の「[ジョブの実行](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-runs.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス* の「[GetJobRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/get-job-run.html)」を参照してください。 ### `get-job-runs` 次のコード例は、`get-job-runs` を使用する方法を示しています。 **AWS CLI** **ジョブのすべてのジョブ実行に関する情報を取得するには** 次の `get-job-runs` の例では、ジョブのジョブ実行に関する情報を取得します。 ``` aws glue get-job-runs \ --job-name "my-testing-job" ``` 出力: ``` { "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" } ] } ``` 詳細については、*AWS Glue デベロッパーガイド* の「[ジョブの実行](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-runs.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス* の「[GetJobRuns](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/get-job-runs.html)」を参照してください。 ### `get-job` 次のコード例は、`get-job` を使用する方法を示しています。 **AWS CLI** **ジョブに関する情報を取得するには** 次の `get-job` の例では、ジョブに関する情報を取得します。　 ``` aws glue get-job \ --job-name my-testing-job ``` 出力: ``` { "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" } } ``` 詳細については、*AWS Glue デベロッパーガイド* の「[ジョブ](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス* の「[GetJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/get-job.html)」を参照してください。 ### `get-plan` 次のコード例は、`get-plan` を使用する方法を示しています。 **AWS CLI** **ソーステーブルからターゲットテーブルにデータをマッピングするために生成されたコードを取得するには** 次の `get-plan` は、データソースからデータターゲットに列をマッピングするために生成されたコードを取得します。 ``` 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" ``` 出力: ``` 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() } } ``` 詳細については、「*AWS Glue デベロッパーガイド*」の「[AWS Glue でのスクリプトの編集](https://docs.aws.amazon.com/glue/latest/dg/edit-script.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPlan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/get-plan.html)」を参照してください。 ### `get-tables` 次のコード例は、`get-tables` を使用する方法を示しています。 **AWS CLI** **指定されたデータベース内で、一部またはすべてのテーブルの定義を一覧表示するには** 次の `get-tables` の例では、指定されたデータベース内のテーブルに関する情報を返します。 ``` aws glue get-tables --database-name 'tempdb' ``` 出力: ``` { "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" } ] } ``` 詳細については、*AWS Glue デベロッパーガイド* の「[AWS Glue データカタログでのテーブルの定義](https://docs.aws.amazon.com/glue/latest/dg/tables-described.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス* の「[GetTables](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/get-tables.html)」を参照してください。 ### `start-crawler` 次のコード例は、`start-crawler` を使用する方法を示しています。 **AWS CLI** **クローラーを開始するには** 次の `start-crawler` の例では、クローラーを開始します。 ``` aws glue start-crawler --name my-crawler ``` 出力: ``` None ``` 詳細については、*AWS Glue デベロッパーガイド* の「[クローラーの定義](https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス* の「[StartCrawler](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/start-crawler.html)」を参照してください。 ### `start-job-run` 次のコード例は、`start-job-run` を使用する方法を示しています。 **AWS CLI** **ジョブの実行を開始するには** 次の `start-job-run` の例ではジョブを開始します。 ``` aws glue start-job-run \ --job-name my-job ``` 出力: ``` { "JobRunId": "jr_22208b1f44eb5376a60569d4b21dd20fcb8621e1a366b4e7b2494af764b82ded" } ``` 詳細については、*AWS Glue デベロッパーガイド* の「[ジョブの作成](https://docs.aws.amazon.com/glue/latest/dg/author-job.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス* の「[StartJobRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/start-job-run.html)」を参照してください。 # AWS CLI を使用した GuardDuty の例 次のコード例は、GuardDuty で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `accept-invitation` 次のコード例は、`accept-invitation` を使用する方法を示しています。 **AWS CLI** **現在のリージョンで GuardDuty メンバーアカウントになるための招待を受け入れるには** 次の `accept-invitation` の例は、現在のリージョンで GuardDuty メンバーアカウントになるための招待を受け入れる方法を示しています。 ``` aws guardduty accept-invitation \ --detector-id 12abc34d567e8fa901bc2d34eexample \ --master-id 123456789111 \ --invitation-id d6b94fb03a66ff665f7db8764example ``` このコマンドでは何も出力されません。 詳細については、「GuardDuty ユーザーガイド」の「[招待による GuardDuty アカウントの管理](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_invitations.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AcceptInvitation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/accept-invitation.html)」を参照してください。 ### `archive-findings` 次のコード例は、`archive-findings` を使用する方法を示しています。 **AWS CLI** **現在のリージョンで検出結果をアーカイブするには** この `archive-findings` の例では、現在のリージョンで検出結果をアーカイブする方法を示します。 ``` aws guardduty archive-findings \ --detector-id 12abc34d567e8fa901bc2d34eexample \ --finding-ids d6b94fb03a66ff665f7db8764example 3eb970e0de00c16ec14e6910fexample ``` このコマンドでは何も出力されません。 詳細については、*GuardDuty ユーザーガイド*の「[抑制ルールの作成](https://docs.aws.amazon.com/guardduty/latest/ug/findings_suppression-rules-console.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ArchiveFindings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/archive-findings.html)」を参照してください。 ### `create-detector` 次のコード例は、`create-detector` を使用する方法を示しています。 **AWS CLI** **現在のリージョンで GuardDuty を有効にするには** この例では、現在のリージョンで GuardDuty を有効にする新しいディテクターを作成する方法を示しています。 ``` aws guardduty create-detector \ --enable ``` 出力: ``` { "DetectorId": "b6b992d6d2f48e64bc59180bfexample" } ``` 詳細については、「*GuardDuty ユーザーガイド*」の「[Amazon GuardDuty を有効にする](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_settingup.html#guardduty_enable-gd)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDetector](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/create-detector.html)」を参照してください。 ### `create-filter` 次のコード例は、`create-filter` を使用する方法を示しています。 **AWS CLI** **例 1: 現在のリージョンに新しいフィルタを作成するには** 次の `create-filter` の例では、特定のイメージから作成されたインスタンスのすべての Portscan 検出結果に一致するフィルタを作成します。このフィルタは、これらの検出結果を抑制するものではありません。 ``` aws guardduty create-filter \ --detector-id b6b992d6d2f48e64bc59180bfexample \ --name myFilterExample \ --finding-criteria '{"Criterion": {"type": {"Eq": ["Recon:EC2/Portscan"]},"resource.instanceDetails.imageId": {"Eq": ["ami-0a7a207083example"]}}}' ``` 出力: ``` { "Name": "myFilterExample" } ``` 詳細については、*GuardDuty ユーザーガイド*の「[GuardDuty 検出結果のフィルタリング](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_filter-findings.html)」を参照してください。 **例 2: 現在のリージョンで新しいフィルタを作成し、検出結果を抑制するには** 次の `create-filter` の例では、特定のイメージから作成されたインスタンスのすべての Portscan 検出結果に一致するフィルタを作成します。このフィルタは、これらの検出結果をアーカイブして、現在の検出結果に表示されないようにします。 ``` 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"]}}}' ``` 出力: ``` { "Name": "myFilterSecondExample" } ``` 詳細については、*GuardDuty ユーザーガイド*の「[GuardDuty 検出結果のフィルタリング](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_filter-findings.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateFilter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/create-filter.html)」を参照してください。 ### `create-ip-set` 次のコード例は、`create-ip-set` を使用する方法を示しています。 **AWS CLI** **信頼された IP セットを作成して有効化するには** 次の `create-ip-set` の例では、現在のリージョンで信頼された IP セットを作成して有効化します。 ``` aws guardduty create-ip-set \ --detector-id 12abc34d567e8fa901bc2d34eexample \ --name new-ip-set-example \ --format TXT \ --location s3://amzn-s3-demo-bucket/customtrustlist.csv \ --activate ``` 出力: ``` { "IpSetId": "d4b94fc952d6912b8f3060768example" } ``` 詳細については、*GuardDuty ユーザーガイド*の「[信頼された IP リストと脅威リストの使用](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_upload_lists.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateIpSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/create-ip-set.html)」を参照してください。 ### `create-members` 次のコード例は、`create-members` を使用する方法を示しています。 **AWS CLI** **新しいメンバーを現在のリージョンの GuardDuty マスターアカウントに関連付けるには** この例では、現在のアカウントが管理するメンバーアカウントを GuardDuty マスターとして関連付ける方法を示します。 ``` aws guardduty create-members --detector-id b6b992d6d2f48e64bc59180bfexample \ --account-details AccountId=111122223333,Email=first+member@example.com AccountId=111111111111 ,Email=another+member@example.com ``` 出力: ``` { "UnprocessedAccounts": [] } ``` 詳細については、「GuardDuty ユーザーガイド」の「[複数のアカウントを管理する](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_accounts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateMembers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/create-members.html)」を参照してください。 ### `create-publishing-destination` 次のコード例は、`create-publishing-destination` を使用する方法を示しています。 **AWS CLI** **現在のリージョンの GuardDuty 検出結果をエクスポートする発行先を作成するには** 次の `create-publishing-destination` の例では、現在の (アーカイブされていない) GuardDuty の検索結果をエクスポートして、過去の検索結果データを追跡するための、発行先を設定する方法を示します。 ``` 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' ``` 出力: ``` { "DestinationId": "46b99823849e1bbc242dfbe3cexample" } ``` 詳細については、*GuardDuty ユーザーガイド*の「[生成された GuardDuty 検出結果を Amazon S3 バケットにエクスポートする](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_exportfindings.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreatePublishingDestination](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/create-publishing-destination.html)」を参照してください。 ### `create-sample-findings` 次のコード例は、`create-sample-findings` を使用する方法を示しています。 **AWS CLI** **現在のリージョンでサンプルの GuardDuty 検出結果を作成するには** この例では、指定されたタイプのサンプル検出結果を作成する方法を示します。 ``` aws guardduty create-sample-findings \ --detector-id b6b992d6d2f48e64bc59180bfexample \ --finding-types UnauthorizedAccess:EC2/TorClient UnauthorizedAccess:EC2/TorRelay ``` このコマンドでは何も出力されません。 詳細については、「*GuardDuty ユーザーガイド*」の「[サンプルも検出結果](https://docs.aws.amazon.com/guardduty/latest/ug/sample_findings.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateSampleFindings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/create-sample-findings.html)」を参照してください。 ### `create-threat-intel-set` 次のコード例は、`create-threat-intel-set` を使用する方法を示しています。 **AWS CLI** **新しい脅威インテリジェンスセットを作成して有効化するには** 次の `create-threat-intel-set` の例では、現在のリージョンで脅威インテリジェンスセットを作成して有効化します。 ``` aws guardduty create-threat-intel-set \ --detector-id b6b992d6d2f48e64bc59180bfexample \ --name myThreatSet-example \ --format TXT \ --location s3://amzn-s3-demo-bucket/threatlist.csv \ --activate ``` 出力: ``` { "ThreatIntelSetId": "20b9a4691aeb33506b808878cexample" } ``` 詳細については、*GuardDuty ユーザーガイド*の「[信頼された IP リストと脅威リストの使用](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_upload_lists.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateThreatIntelSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/create-threat-intel-set.html)」を参照してください。 ### `decline-invitations` 次のコード例は、`decline-invitations` を使用する方法を示しています。 **AWS CLI** **現在のリージョンの別のアカウントによって Guardduty が管理される招待を拒否するには** この例では、メンバーシップの招待を拒否する方法を示しています。 ``` aws guardduty decline-invitations \ --account-ids 111122223333 ``` 出力: ``` { "UnprocessedAccounts": [] } ``` 詳細については、「GuardDuty ユーザーガイド」の「[招待による GuardDuty アカウントの管理](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_invitations.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeclineInvitations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/decline-invitations.html)」を参照してください。 ### `delete-detector` 次のコード例は、`delete-detector` を使用する方法を示しています。 **AWS CLI** **現在のリージョンでディテクターを削除し、GuardDuty を無効にするには** この例では、ディテクターを削除する方法を示しています。成功すると、そのディテクターに関連付けられたリージョンで GuardDuty が無効になります。 ``` aws guardduty delete-detector \ --detector-id b6b992d6d2f48e64bc59180bfexample ``` このコマンドでは何も出力されません。 詳細については、「*GuardDuty ユーザーガイド*」の「[GuardDuty の一時停止または無効化](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_suspend-disable.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDetector](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/delete-detector.html)」を参照してください。 ### `delete-filter` 次のコード例は、`delete-filter` を使用する方法を示しています。 **AWS CLI** **現在のリージョンの既存のフィルターを削除するには** この例では、フィルターを削除する方法を示します。 ``` aws guardduty delete-filter \ --detector-id b6b992d6d2f48e64bc59180bfexample \ --filter-name byebyeFilter ``` このコマンドでは何も出力されません。 詳細については、「GuardDuty ユーザーガイド」の「[検出結果のフィルタリング](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_filter-findings.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteFilter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/delete-filter.html)」を参照してください。 ### `disable-organization-admin-account` 次のコード例は、`disable-organization-admin-account` を使用する方法を示しています。 **AWS CLI** **組織内の GuardDuty の委任管理者としてアカウントを削除するには** この例では、GuardDuty の委任管理者としてアカウントを削除する方法を示します。 ``` aws guardduty disable-organization-admin-account \ --admin-account-id 111122223333 ``` このコマンドでは何も出力されません。 詳細については、「*GuardDuty ユーザーガイド*」の「[AWS Organizations でのアカウントの管理](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_organizations.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisableOrganizationAdminAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/disable-organization-admin-account.html)」を参照してください。 ### `disassociate-from-master-account` 次のコード例は、`disassociate-from-master-account` を使用する方法を示しています。 **AWS CLI** **現在のリージョンの現在の管理者アカウントとの関連付けを解除するには** 次の `disassociate-from-master-account` の例では、アカウントと現在の AWS リージョンの現在の GuardDuty 管理者アカウントとの関連付けを解除します。 ``` aws guardduty disassociate-from-master-account \ --detector-id d4b040365221be2b54a6264dcexample ``` このコマンドでは何も出力されません。 詳細については、*GuardDuty ユーザーガイド*の「[GuardDuty 管理者アカウントとメンバーアカウントの関係について理解する](https://docs.aws.amazon.com/guardduty/latest/ug/administrator_member_relationships.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateFromMasterAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/disassociate-from-master-account.html)」を参照してください。 ### `get-detector` 次のコード例は、`get-detector` を使用する方法を示しています。 **AWS CLI** **特定のディテクターの詳細を取得するには** 次の `get-detector` の例では、指定されたディテクターの設定の詳細を表示します。 ``` aws guardduty get-detector \ --detector-id 12abc34d567e8fa901bc2d34eexample ``` 出力: ``` { "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" } ``` 詳細については、GuardDuty ユーザーガイドの「[概念と用語](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_concepts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDetector](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/get-detector.html)」を参照してください。 ### `get-findings` 次のコード例は、`get-findings` を使用する方法を示しています。 **AWS CLI** **例 1: 特定の検出結果の詳細を取得するには** 次の `get-findings` の例では、指定された検出結果の完全な JSON 検出結果の詳細を取得します。 ``` aws guardduty get-findings \ --detector-id 12abc34d567e8fa901bc2d34eexample \ --finding-id 1ab92989eaf0e742df4a014d5example ``` 出力: ``` { "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" } ] } ``` 詳細については、「GuardDuty ユーザーガイド」の「[検出結果](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_findings.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetFindings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/get-findings.html)」を参照してください。 ### `get-ip-set` 次のコード例は、`get-ip-set` を使用する方法を示しています。 **AWS CLI** **指定された信頼された IP セットの詳細を一覧表示するには** 次の `get-ip-set` の例では、指定した信頼された IP セットのステータスと詳細を表示します。 ``` aws guardduty get-ip-set \ --detector-id 12abc34d567e8fa901bc2d34eexample \ --ip-set-id d4b94fc952d6912b8f3060768example ``` 出力: ``` { "Status": "ACTIVE", "Location": "s3://amzn-s3-demo-bucket.s3-us-west-2.amazonaws.com/customlist.csv", "Tags": {}, "Format": "TXT", "Name": "test-ip-set-example" } ``` 詳細については、*GuardDuty ユーザーガイド*の「[信頼された IP リストと脅威リストの使用](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_upload_lists.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetIpSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/get-ip-set.html)」を参照してください。 ### `get-master-account` 次のコード例は、`get-master-account` を使用する方法を示しています。 **AWS CLI** **現在のリージョンでマスターアカウントに関する詳細を取得するには** 次の `get-master-account` の例では、現在のリージョンのディテクターに関連付けられたマスターアカウントのステータスと詳細を表示します。 ``` aws guardduty get-master-account \ --detector-id 12abc34d567e8fa901bc2d34eexample ``` 出力: ``` { "Master": { "InvitationId": "04b94d9704854a73f94e061e8example", "InvitedAt": "2020-06-09T22:23:04.970Z", "RelationshipStatus": "Enabled", "AccountId": "111122223333" } } ``` 詳細については、*GuardDuty ユーザーガイド*の「[GuardDuty 管理者アカウントとメンバーアカウントの関係について理解する](https://docs.aws.amazon.com/guardduty/latest/ug/administrator_member_relationships.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetMasterAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/get-master-account.html)」を参照してください。 ### `list-detectors` 次のコード例は、`list-detectors` を使用する方法を示しています。 **AWS CLI** **現在のリージョンで使用可能なディテクターを一覧表示するには** 次の `list-detectors` の例では、現在の AWS リージョンで使用可能なディテクターを一覧表示します。 ``` aws guardduty list-detectors ``` 出力: ``` { "DetectorIds": [ "12abc34d567e8fa901bc2d34eexample" ] } ``` 詳細については、GuardDuty ユーザーガイドの「[概念と用語](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_concepts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDetectors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/list-detectors.html)」を参照してください。 ### `list-findings` 次のコード例は、`list-findings` を使用する方法を示しています。 **AWS CLI** **例 1: 現在のリージョンのすべての検出結果を一覧表示するには** 次の `list-findings` の例では、現在のリージョンのすべての findingIds のリストを重要度の高いものから低いものの順に表示します。 ``` aws guardduty list-findings \ --detector-id 12abc34d567e8fa901bc2d34eexample \ --sort-criteria '{"AttributeName": "severity","OrderBy":"DESC"}' ``` 出力: ``` { "FindingIds": [ "04b8ab50fd29c64fc771b232dexample", "5ab8ab50fd21373735c826d3aexample", "90b93de7aba69107f05bbe60bexample", ... ] } ``` 詳細については、「GuardDuty ユーザーガイド」の「[検出結果](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_findings.html)」を参照してください。 **例 2: 特定の検出結果基準に一致する現在のリージョンの検出結果を一覧表示するには** 次の `list-findings` の例では、指定された findingIds のリストを表示します。 ``` aws guardduty list-findings \ --detector-id 12abc34d567e8fa901bc2d34eexample \ --finding-criteria '{"Criterion":{"type": {"Eq":["UnauthorizedAccess:EC2/SSHBruteForce"]}}}' ``` 出力: ``` { "FindingIds": [ "90b93de7aba69107f05bbe60bexample", "6eb9430d7023d30774d6f05e3example", "2eb91a2d060ac9a21963a5848example", "44b8ab50fd2b0039a9e48f570example", "9eb8ab4cd2b7e5b66ba4f5e96example", "e0b8ab3a38e9b0312cc390ceeexample" ] } ``` 詳細については、「GuardDuty ユーザーガイド」の「[検出結果](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_findings.html)」を参照してください。 **例 3: JSON ファイル内で定義された特定の検出基準のセットに一致する現在のリージョンの検出結果を一覧表示するには** 次の `list-findings` の例では、JSON ファイルで指定されているように、アーカイブされておらず、「testuser」という名前の IAM ユーザーを含む findingIds のリストを表示します。 ``` aws guardduty list-findings \ --detector-id 12abc34d567e8fa901bc2d34eexample \ --finding-criteria file://myfile.json ``` `myfile.json` の内容: ``` {"Criterion": { "resource.accessKeyDetails.userName":{ "Eq":[ "testuser" ] }, "service.archived": { "Eq": [ "false" ] } } } ``` 出力: ``` { "FindingIds": [ "1ab92989eaf0e742df4a014d5example" ] } ``` 詳細については、「GuardDuty ユーザーガイド」の「[検出結果](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_findings.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListFindings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/list-findings.html)」を参照してください。 ### `list-invitations` 次のコード例は、`list-invitations` を使用する方法を示しています。 **AWS CLI** **現在のリージョンのメンバーアカウントになるための招待の詳細を一覧表示するには** 次の `list-invitations` の例では、現在のリージョンで GuardDuty メンバーアカウントになるための招待の詳細とステータスを一覧表示します。 ``` aws guardduty list-invitations ``` 出力: ``` { "Invitations": [ { "InvitationId": "d6b94fb03a66ff665f7db8764example", "InvitedAt": "2020-06-10T17:56:38.221Z", "RelationshipStatus": "Invited", "AccountId": "123456789111" } ] } ``` 詳細については、「GuardDuty ユーザーガイド」の「[招待による GuardDuty アカウントの管理](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_invitations.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListInvitations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/list-invitations.html)」を参照してください。 ### `list-ip-sets` 次のコード例は、`list-ip-sets` を使用する方法を示しています。 **AWS CLI** **現在のリージョンで信頼された IP セットを一覧表示するには** 次の `list-ip-sets` の例では、現在の AWS リージョンの信頼された IP セットを一覧表示します。 ``` aws guardduty list-ip-sets \ --detector-id 12abc34d567e8fa901bc2d34eexample ``` 出力: ``` { "IpSetIds": [ "d4b94fc952d6912b8f3060768example" ] } ``` 詳細については、「GuardDuty ユーザーガイド」の「[信頼された IP リストと脅威リストの使用](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_upload_lists.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListIpSets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/list-ip-sets.html)」を参照してください。 ### `list-members` 次のコード例は、`list-members` を使用する方法を示しています。 **AWS CLI** **例 1: 現在のリージョン内の現在のメンバーのみを一覧表示するには** 次の `list-members` の例では、現在のリージョンで、GuardDuty 管理者アカウントに関連付けられている現在のメンバーアカウントのみを一覧表示し、詳細を出力します。 ``` aws guardduty list-members \ --detector-id 12abc34d567e8fa901bc2d34eexample \ --only-associated="true" ``` 出力: ``` { "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" } ] } ``` 詳細については、*GuardDuty ユーザーガイド*の「[GuardDuty 管理者アカウントとメンバーアカウントの関係について理解する](https://docs.aws.amazon.com/guardduty/latest/ug/administrator_member_relationships.html)」を参照してください。 **例 2: 現在のリージョン内のすべてのメンバーを一覧表示するには** 次の `list-members` の例では、現在のリージョンで、関連付けが解除されたメンバーや、GuardDuty 管理者からの招待をまだ承諾していないメンバーを含め、すべてのメンバーアカウントを一覧表示し、詳細を出力します。 ``` aws guardduty list-members \ --detector-id 12abc34d567e8fa901bc2d34eexample \ --only-associated="false" ``` 出力: ``` { "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" } ] } ``` 詳細については、*GuardDuty ユーザーガイド*の「[GuardDuty 管理者アカウントとメンバーアカウントの関係について理解する](https://docs.aws.amazon.com/guardduty/latest/ug/administrator_member_relationships.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListMembers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/list-members.html)」を参照してください。 ### `update-detector` 次の例は、`update-detector` を使用する方法を説明しています。 **AWS CLI** **例 1: GuardDuty でランタイムモニタリングを有効にするには** 次の `update-detector` の例では、追加の設定なしでランタイムモニタリングを有効にします。 ``` aws guardduty update-detector \ --detector-id 12abc34d567e8fa901bc2d34eexample \ --features 'Name=RUNTIME_MONITORING,Status=ENABLED' ``` このコマンドでは何も出力されません。 詳細については、「*GuardDuty ユーザーガイド*」の「[ランタイムモニタリング](https://docs.aws.amazon.com/guardduty/latest/ug/runtime-monitoring.html)」を参照してください。 **例 2: 追加設定でランタイムモニタリングを有効にするには** 次の `update-detector` の例では、EC2、ECS Fargate、および 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}]' ``` このコマンドでは何も出力されません。 詳細については、「*GuardDuty ユーザーガイド*」の「[ランタイムモニタリング](https://docs.aws.amazon.com/guardduty/latest/ug/runtime-monitoring.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateDetector](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/update-detector.html)」を参照してください。 ### `update-ip-set` 次の例は、`update-ip-set` を使用する方法を説明しています。 **AWS CLI** **信頼された IP セットを更新するには** 次の `update-ip-set` 例は、信頼された IP セットの詳細を更新する方法を示しています。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、*GuardDuty ユーザーガイド*の「[信頼された IP リストと脅威リストの使用](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_upload_lists.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateIpSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/update-ip-set.html)」を参照してください。 # AWS Health examples using AWS CLI 次のコード例では、AWS Health で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `describe-affected-entities` 次のコード例は、`describe-affected-entities` を使用する方法を示しています。 **AWS CLI** **指定された AWS Health イベントの影響を受けるエンティティを一覧表示するには** 次の `describe-affected-entities` の例では、指定された AWS Health イベントの影響を受けるエンティティを一覧表示します。このイベントは、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 ``` 出力: ``` { "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 } ] } ``` 詳細については、「*AWS ユーザーガイド*」の「[イベントログ](https://docs.aws.amazon.com/health/latest/ug/getting-started-phd.html#event-log)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAffectedEntities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/health/describe-affected-entities.html)」を参照してください。 ### `describe-event-details` 次のコード例は、`describe-event-details` を使用する方法を示しています。 **AWS CLI** **AWS Health イベントに関する情報を一覧表示するには** 次の `describe-event-details` の例は、指定された 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 ``` 出力: ``` { "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": [] } ``` 詳細については、「*AWS Health ユーザーガイド*」の「[イベントの詳細ペイン](https://docs.aws.amazon.com/health/latest/ug/getting-started-phd.html#event-details)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEventDetails](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/health/describe-event-details.html)」を参照してください。 ### `describe-events` 次のコード例は、`describe-events` を使用する方法を示しています。 **AWS CLI** **例 1: AWS Health イベントを一覧表示するには** 次の `describe-events` の例では、最近の AWS Health イベントを一覧表示します。 ``` aws health describe-events \ --region us-east-1 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS Health ユーザーガイド*」の「[AWS Personal Health Dashboard の開始方法](https://docs.aws.amazon.com/health/latest/ug/getting-started-phd.html)」をご参照ください。 **例 2: サービスおよびイベントステータスコード別に AWS Health イベントを一覧表示するには** 次の `describe-events` の例では、イベントステータスが閉じられている Amazon Elastic Compute Cloud (Amazon EC2) の AWS Health イベントを一覧表示します。 ``` aws health describe-events \ --filter "services=EC2,eventStatusCodes=closed" ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS Health ユーザーガイド*」の「[AWS Personal Health Dashboard の開始方法](https://docs.aws.amazon.com/health/latest/ug/getting-started-phd.html)」をご参照ください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/health/describe-events.html)」を参照してください。 # AWS CLI を使用した HealthImaging の例 次のコード例は、HealthImaging で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `copy-image-set` 次のコード例は、`copy-image-set` を使用する方法を示しています。 **AWS CLI** **例 1：コピー先を指定せずに画像セットをコピーするには。** 次の `copy-image-set` の例では、コピー先を指定せずに画像セットの複製コピーを作成します。 ``` aws medical-imaging copy-image-set \ --datastore-id 12345678901234567890123456789012 \ --source-image-set-id ea92b0d8838c72a3f25d00d13616f87e \ --copy-image-set-information '{"sourceImageSet": {"latestVersionId": "1" } }' ``` 出力: ``` { "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" } ``` **例 2：コピー先を指定して画像セットをコピーするには。** 次の `copy-image-set` の例では、コピー先を指定して画像セットの複製コピーを作成します。 ``` 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"} }' ``` 出力: ``` { "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" } ``` **例 3: ソース画像セットからコピー先画像セットにインスタンスのサブセットをコピーするには。** 次の `copy-image-set` の例では、ソース画像セットからコピー先画像セットに 1 つの DICOM インスタンスをコピーします。force パラメータは、患者、検査、シリーズレベルの属性の不整合を上書きするために提供されます。 ``` 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 ``` 出力: ``` { "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" } ``` 詳細については、「*AWS HealthImaging Developer Guide*」の「[Copying an image set](https://docs.aws.amazon.com/healthimaging/latest/devguide/copy-image-set.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CopyImageSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/copy-image-set.html)」を参照してください。 ### `create-datastore` 次の例は、`create-datastore` を使用する方法を説明しています。 **AWS CLI** **例 1：データストアにタグを付けるには** 次の `create-datastore` コード例では、`my-datastore` という名が付けられたデータストアを作成しています。`--lossless-storage-format` を指定せずにデータストアを作成すると、AWS HealthImaging はデフォルトで HTJ2K (高スループット JPEG 2000) になります。 ``` aws medical-imaging create-datastore \ --datastore-name "my-datastore" ``` 出力: ``` { "datastoreId": "12345678901234567890123456789012", "datastoreStatus": "CREATING" } ``` **例 2: JPEG 2000 ロスレスストレージ形式でデータストアを作成するには** JPEG 2000 ロスレスストレージ形式で設定されたデータストアは、可逆イメージフレームを JPEG 2000 形式でトランスコードして保持します。その後、画像フレームは JPEG 2000 ロスレス、トランスコーディングなしで取得できます。次の `create-datastore` コード例では、`my-datastore` という名前の JPEG 2000 ロスレスストレージ形式用に設定されたデータストアを作成します。 ``` aws medical-imaging create-datastore \ --datastore-name "my-datastore" \ --lossless-storage-format JPEG_2000_LOSSLESS ``` 出力: ``` { "datastoreId": "12345678901234567890123456789012", "datastoreStatus": "CREATING" } ``` 詳細については、「*AWS HealthImaging Developer Guide*」の「[Creating a data store](https://docs.aws.amazon.com/healthimaging/latest/devguide/create-data-store.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/create-datastore.html)」を参照してください。 ### `delete-datastore` 次のコード例は、`delete-datastore` を使用する方法を示しています。 **AWS CLI** **データストアを削除するには** 次の `delete-datastore` コード例では、データストアを削除しています。 ``` aws medical-imaging delete-datastore \ --datastore-id "12345678901234567890123456789012" ``` 出力: ``` { "datastoreId": "12345678901234567890123456789012", "datastoreStatus": "DELETING" } ``` 詳細については、「*AWS HealthImaging Developer Guide*」の「[Deleting a data store](https://docs.aws.amazon.com/healthimaging/latest/devguide/delete-data-store.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/delete-datastore.html)」を参照してください。 ### `delete-image-set` 次のコード例は、`delete-image-set` を使用する方法を示しています。 **AWS CLI** **画像セットを削除するには** 以下の `delete-image-set` コード例は画像セットを削除しています。 ``` aws medical-imaging delete-image-set \ --datastore-id 12345678901234567890123456789012 \ --image-set-id ea92b0d8838c72a3f25d00d13616f87e ``` 出力: ``` { "imageSetWorkflowStatus": "DELETING", "imageSetId": "ea92b0d8838c72a3f25d00d13616f87e", "imageSetState": "LOCKED", "datastoreId": "12345678901234567890123456789012" } ``` 詳細については、「*AWS HealthImaging Developer Guide*」の「[Deleting an image set](https://docs.aws.amazon.com/healthimaging/latest/devguide/delete-image-set.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteImageSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/delete-image-set.html)」を参照してください。 ### `get-datastore` 次の例は、`get-datastore` を使用する方法を説明しています。 **AWS CLI** **例 1: データストアのプロパティを取得するには** 次の `get-datastore` コード例では、データストアのプロパティを取得しています。 ``` aws medical-imaging get-datastore \ --datastore-id 12345678901234567890123456789012 ``` 出力: ``` { "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" } } ``` **例 2: JPEG 2000 用に設定されたデータストアのプロパティを取得するには** 次の `get-datastore` コード例では、JPEG 2000 ロスレスストレージ形式用に設定されたデータストアのデータストアのプロパティを取得します。 ``` aws medical-imaging get-datastore \ --datastore-id 12345678901234567890123456789012 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS HealthImaging Developer Guide*」の「[Getting data store properties](https://docs.aws.amazon.com/healthimaging/latest/devguide/get-data-store.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/get-datastore.html)」を参照してください。 ### `get-dicom-import-job` 次のコード例は、`get-dicom-import-job` を使用する方法を示しています。 **AWS CLI** **DICOM インポートジョブのプロパティを取得するには** 次の `get-dicom-import-job` コード例では、DICOM インポートジョブのプロパティを取得しています。 ``` aws medical-imaging get-dicom-import-job \ --datastore-id "12345678901234567890123456789012" \ --job-id "09876543210987654321098765432109" ``` 出力: ``` { "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/" } } ``` 詳細については、「*AWS HealthImaging Developer Guide*」の「[Getting import job properties](https://docs.aws.amazon.com/healthimaging/latest/devguide/get-dicom-import-job.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDICOMImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/get-dicom-import-job.html)」を参照してください。 ### `get-image-frame` 次のコード例は、`get-image-frame` を使用する方法を示しています。 **AWS CLI** **画像セットのピクセルデータを取得するには** 次の `get-image-frame` コード例では、画像フレームを取得しています。 ``` aws medical-imaging get-image-frame \ --datastore-id "12345678901234567890123456789012" \ --image-set-id "98765412345612345678907890789012" \ --image-frame-information imageFrameId=3abf5d5d7ae72f80a0ec81b2c0de3ef4 \ imageframe.jph ``` 注：このコード例には出力は含まれていません。GetImageFrame という操作は、ピクセルデータのストリームを imageframe.jph ファイルに返すからです。画像フレームのデコードと表示については、「HTJ2K デコードライブラリ」を参照してください。 詳細については、「*AWS HealthImaging Developer Guide*」の「[Getting image set pixel data](https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-frame.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetImageFrame](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/get-image-frame.html)」を参照してください。 ### `get-image-set-metadata` 次のコード例は、`get-image-set-metadata` を使用する方法を示しています。 **AWS CLI** **例 1：画像セットのメタデータをバージョンなしで取得するには** 次の `get-image-set-metadata` コード例では、バージョンを指定せずに画像セットのメタデータを取得しています。 注：`outfile` は必須のパラメータです ``` aws medical-imaging get-image-set-metadata \ --datastore-id 12345678901234567890123456789012 \ --image-set-id ea92b0d8838c72a3f25d00d13616f87e \ studymetadata.json.gz ``` 返されたメタデータは gzip で圧縮され、studymetadata.json.gz ファイルに保存されます。返された JSON オブジェクトの内容を表示するには、まずオブジェクトを解凍する必要があります。 出力: ``` { "contentType": "application/json", "contentEncoding": "gzip" } ``` **例 2：画像セットのメタデータをバージョン付きで取得するには** 次の `get-image-set-metadata` コード例では、指定されたバージョンの画像セットのメタデータを取得しています。 注：`outfile` は必須のパラメータです ``` aws medical-imaging get-image-set-metadata \ --datastore-id 12345678901234567890123456789012 \ --image-set-id ea92b0d8838c72a3f25d00d13616f87e \ --version-id 1 \ studymetadata.json.gz ``` 返されたメタデータは gzip で圧縮され、studymetadata.json.gz ファイルに保存されます。返された JSON オブジェクトの内容を表示するには、まずオブジェクトを解凍する必要があります。 出力: ``` { "contentType": "application/json", "contentEncoding": "gzip" } ``` 詳細については、「*AWS HealthImaging Developer Guide*」の「[Getting image set metadata](https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-set-metadata.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetImageSetMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/get-image-set-metadata.html)」を参照してください。 ### `get-image-set` 次のコード例は、`get-image-set` を使用する方法を示しています。 **AWS CLI** **画像セットのプロパティを取得するには** 以下の `get-image-set` コード例では、画像セットのプロパティを取得しています。 ``` aws medical-imaging get-image-set \ --datastore-id 12345678901234567890123456789012 \ --image-set-id 18f88ac7870584f58d56256646b4d92b \ --version-id 1 ``` 出力: ``` { "versionId": "1", "imageSetWorkflowStatus": "COPIED", "updatedAt": 1680027253.471, "imageSetId": "18f88ac7870584f58d56256646b4d92b", "imageSetState": "ACTIVE", "createdAt": 1679592510.753, "datastoreId": "12345678901234567890123456789012" } ``` 詳細については、「*AWS HealthImaging Developer Guide*」の「[Getting image set properties](https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-set-properties.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetImageSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/get-image-set.html)」を参照してください。 ### `list-datastores` 次のコード例は、`list-datastores` を使用する方法を示しています。 **AWS CLI** **データストアを一覧表示するには** 次の `list-datastores` コード例では、利用可能なデータストアを一覧表示しています。 ``` aws medical-imaging list-datastores ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS HealthImaging Developer Guide*」の「[Listing data stores](https://docs.aws.amazon.com/healthimaging/latest/devguide/list-data-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDatastores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/list-datastores.html)」を参照してください。 ### `list-dicom-import-jobs` 次のコード例は、`list-dicom-import-jobs` を使用する方法を示しています。 **AWS CLI** **DICOM インポートジョブを一覧表示するには** 次の `list-dicom-import-jobs` コード例では、インポートジョブを一覧表示します。 ``` aws medical-imaging list-dicom-import-jobs \ --datastore-id "12345678901234567890123456789012" ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS HealthImaging Developer Guide*」の「[Listing import jobs](https://docs.aws.amazon.com/healthimaging/latest/devguide/list-dicom-import-jobs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDICOMImportJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/list-dicom-import-jobs.html)」を参照してください。 ### `list-image-set-versions` 次のコード例は、`list-image-set-versions` を使用する方法を示しています。 **AWS CLI** **画像セットバージョンを一覧表示するには** 次の `list-image-set-versions` コード例では、画像セットのバージョン履歴を一覧表示しています。 ``` aws medical-imaging list-image-set-versions \ --datastore-id 12345678901234567890123456789012 \ --image-set-id ea92b0d8838c72a3f25d00d13616f87e ``` 出力: ``` { "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 } ] } ``` 詳細については、「*AWS HealthImaging Developer Guide*」の「[Listing image set versions](https://docs.aws.amazon.com/healthimaging/latest/devguide/list-image-set-versions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListImageSetVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/list-image-set-versions.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **例 1：データストアリソースのタグを一覧表示するには** 次の `list-tags-for-resource` コード例では、データストアのタグを一覧表示しています。 ``` aws medical-imaging list-tags-for-resource \ --resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012" ``` 出力: ``` { "tags":{ "Deployment":"Development" } } ``` **例 2：画像セットリソースのタグを一覧表示するには** 次の `list-tags-for-resource` コード例では、画像セットのタグを一覧表示しています。 ``` aws medical-imaging list-tags-for-resource \ --resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012/imageset/18f88ac7870584f58d56256646b4d92b" ``` 出力: ``` { "tags":{ "Deployment":"Development" } } ``` 詳細については、「*AWS HealthImaging Developer Guide*」の「[Tagging resources with AWS HealthImaging](https://docs.aws.amazon.com/healthimaging/latest/devguide/tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/list-tags-for-resource.html)」を参照してください。 ### `search-image-sets` 次のコード例は、`search-image-sets` を使用する方法を示しています。 **AWS CLI** **例 1：EQUAL 演算子を使用して画像セットを検索するには** 次の `search-image-sets` コード例では、EQUAL 演算子を使用し、特定の値に基づいて画像セットを検索しています。 ``` aws medical-imaging search-image-sets \ --datastore-id 12345678901234567890123456789012 \ --search-criteria file://search-criteria.json ``` `search-criteria.json` の内容 ``` { "filters": [{ "values": [{"DICOMPatientId" : "SUBJECT08701"}], "operator": "EQUAL" }] } ``` 出力: ``` { "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" }] } ``` **例 2：DICOMStudyDate と DICOMStudyTime を使用することで、BETWEEN 演算子を使用して画像セットを検索するには** 次の `search-image-sets` コード例では、1990 年 1 月 1 日 (午前 0 時) から 2023 年 1 月 1 日 (午前 0 時) の間に生成された DICOM スタディを含む画像セットを検索します。 注：DICOMStudyTime は選択可能です。入力されていない場合は、フィルターで指定された日付の時間値は午前 0 時 (1 日の始まり) になります。 ``` aws medical-imaging search-image-sets \ --datastore-id 12345678901234567890123456789012 \ --search-criteria file://search-criteria.json ``` `search-criteria.json` の内容 ``` { "filters": [{ "values": [{ "DICOMStudyDateAndTime": { "DICOMStudyDate": "19900101", "DICOMStudyTime": "000000" } }, { "DICOMStudyDateAndTime": { "DICOMStudyDate": "20230101", "DICOMStudyTime": "000000" } }], "operator": "BETWEEN" }] } ``` 出力: ``` { "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" }] } ``` **例 3：createdAt を使用して BETWEEN 演算子を使用して画像セットを検索するには (スタディが以前に保存されていた時間)** 次の `search-image-sets` コード例では、UTC タイムゾーンの時間範囲の間で、HealthImaging に保持されている DICOM スタディを含む画像セットを検索します。 注：createdAt をサンプル形式 ("1985-04-12T23:20:50.52Z") で提供してください。 ``` aws medical-imaging search-image-sets \ --datastore-id 12345678901234567890123456789012 \ --search-criteria file://search-criteria.json ``` `search-criteria.json` の内容 ``` { "filters": [{ "values": [{ "createdAt": "1985-04-12T23:20:50.52Z" }, { "createdAt": "2022-04-12T23:20:50.52Z" }], "operator": "BETWEEN" }] } ``` 出力: ``` { "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" }] } ``` **例 4: DICOMSeriesInstanceUID で EQUAL 演算子を使用し、updatedAt で BETWEEN 演算子を使用して画像セットを検索し、updatedAt フィールドのレスポンスを ASC 順序でソートするには** 次の `search-image-sets` コード例では、DICOMSeriesInstanceUID で EQUAL 演算子を使用し、updatedAt で BETWEEN 演算子を使用して画像セットを検索し、updatedAt フィールドのレスポンスを ASC 順序でソートします。 注: updatedAt をサンプル形式 ("1985-04-12T23:20:50.52Z") で提供してください。 ``` aws medical-imaging search-image-sets \ --datastore-id 12345678901234567890123456789012 \ --search-criteria file://search-criteria.json ``` `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" } } ``` 出力: ``` { "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" }] } ``` 詳細については、「*AWS HealthImaging Developer Guide*」の「[Searching image sets](https://docs.aws.amazon.com/healthimaging/latest/devguide/search-image-sets.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SearchImageSets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/search-image-sets.html)」を参照してください。 ### `start-dicom-import-job` 次のコード例は、`start-dicom-import-job` を使用する方法を示しています。 **AWS CLI** **DICOM インポートジョブを開始するには** 次の `start-dicom-import-job` コード例では、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" ``` 出力: ``` { "datastoreId": "12345678901234567890123456789012", "jobId": "09876543210987654321098765432109", "jobStatus": "SUBMITTED", "submittedAt": "2022-08-12T11:28:11.152000+00:00" } ``` 詳細については、「*AWS HealthImaging Developer Guide*」の「[Starting an import job](https://docs.aws.amazon.com/healthimaging/latest/devguide/start-dicom-import-job.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartDICOMImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/start-dicom-import-job.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **例 1：データストアにタグを付けるには** 次の `tag-resource` コード例では、データストアにタグを付けています。 ``` aws medical-imaging tag-resource \ --resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012" \ --tags '{"Deployment":"Development"}' ``` このコマンドでは何も出力されません。 **例 2：画像セットにタグを付けるには** 次の `tag-resource` コード例では、画像セットにタグを付けています。 ``` aws medical-imaging tag-resource \ --resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012/imageset/18f88ac7870584f58d56256646b4d92b" \ --tags '{"Deployment":"Development"}' ``` このコマンドでは何も出力されません。 詳細については、「*AWS HealthImaging Developer Guide*」の「[Tagging resources with AWS HealthImaging](https://docs.aws.amazon.com/healthimaging/latest/devguide/tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **例 1：データストアのタグを削除するには** 次の `untag-resource` コード例では、データストアにタグを削除します。 ``` aws medical-imaging untag-resource \ --resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012" \ --tag-keys '["Deployment"]' ``` このコマンドでは何も出力されません。 **例 2：画像セットにタグを削除するには** 次の `untag-resource` コード例では、画像セットにタグを削除します。 ``` aws medical-imaging untag-resource \ --resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012/imageset/18f88ac7870584f58d56256646b4d92b" \ --tag-keys '["Deployment"]' ``` このコマンドでは何も出力されません。 詳細については、「*AWS HealthImaging Developer Guide*」の「[Tagging resources with AWS HealthImaging](https://docs.aws.amazon.com/healthimaging/latest/devguide/tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/untag-resource.html)」を参照してください。 ### `update-image-set-metadata` 次のコード例は、`update-image-set-metadata` を使用する方法を示しています。 **AWS CLI** **例 1: 画像セットメタデータに属性を挿入または更新するには** 次の `update-image-set-metadata` の例では、画像セットメタデータに属性を挿入または更新します。 ``` 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 ``` `metadata-updates.json` の内容 ``` { "DICOMUpdates": { "updatableAttributes": "{\"SchemaVersion\":1.1,\"Patient\":{\"DICOM\":{\"PatientName\":\"MX^MX\"}}}" } } ``` 出力: ``` { "latestVersionId": "2", "imageSetWorkflowStatus": "UPDATING", "updatedAt": 1680042257.908, "imageSetId": "ea92b0d8838c72a3f25d00d13616f87e", "imageSetState": "LOCKED", "createdAt": 1680027126.436, "datastoreId": "12345678901234567890123456789012" } ``` **例 2: 画像セットメタデータから属性を削除するには** 次の `update-image-set-metadata` の例では、画像セットメタデータから属性を削除します。 ``` 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 ``` `metadata-updates.json` の内容 ``` { "DICOMUpdates": { "removableAttributes": "{\"SchemaVersion\":1.1,\"Study\":{\"DICOM\":{\"StudyDescription\":\"CHEST\"}}}" } } ``` 出力: ``` { "latestVersionId": "2", "imageSetWorkflowStatus": "UPDATING", "updatedAt": 1680042257.908, "imageSetId": "ea92b0d8838c72a3f25d00d13616f87e", "imageSetState": "LOCKED", "createdAt": 1680027126.436, "datastoreId": "12345678901234567890123456789012" } ``` **例 3: 画像セットメタデータからインスタンスを削除するには** 次の `update-image-set-metadata` の例では、画像セットメタデータからインスタンスを削除します。 ``` 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 ``` `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\": {}}}}}}" } } ``` 出力: ``` { "latestVersionId": "2", "imageSetWorkflowStatus": "UPDATING", "updatedAt": 1680042257.908, "imageSetId": "ea92b0d8838c72a3f25d00d13616f87e", "imageSetState": "LOCKED", "createdAt": 1680027126.436, "datastoreId": "12345678901234567890123456789012" } ``` **例 4: 画像セットを以前のバージョンに戻すには** 次の `update-image-set-metadata` の例は、画像セットを以前のバージョンに戻す方法を示しています。CopyImageSet および UpdateImageSetMetadata アクションは、新しいバージョンの画像セットを作成します。 ``` 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"}' ``` 出力: ``` { "datastoreId": "12345678901234567890123456789012", "imageSetId": "53d5fdb05ca4d46ac7ca64b06545c66e", "latestVersionId": "4", "imageSetState": "LOCKED", "imageSetWorkflowStatus": "UPDATING", "createdAt": 1680027126.436, "updatedAt": 1680042257.908 } ``` **例 5: インスタンスにプライベート DICOM データ要素を追加するには** 次の `update-image-set-metadata` の例は、画像セット内で指定されたインスタンスにプライベート要素を追加する方法を示しています。DICOM 標準では、標準データ要素に含めることができない情報の通信に、プライベートデータ要素が許可されます。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 ``` `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\"}}}}}}}" } } ``` 出力: ``` { "latestVersionId": "2", "imageSetWorkflowStatus": "UPDATING", "updatedAt": 1680042257.908, "imageSetId": "53d5fdb05ca4d46ac7ca64b06545c66e", "imageSetState": "LOCKED", "createdAt": 1680027126.436, "datastoreId": "12345678901234567890123456789012" } ``` **例 6: プライベート DICOM データ要素をインスタンスに対して更新するには** 次の `update-image-set-metadata` の例は、画像セット内のインスタンスに属するプライベートデータ要素の値を更新する方法を示しています。 ``` 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 ``` `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\"}}}}}}}" } } ``` 出力: ``` { "latestVersionId": "2", "imageSetWorkflowStatus": "UPDATING", "updatedAt": 1680042257.908, "imageSetId": "53d5fdb05ca4d46ac7ca64b06545c66e", "imageSetState": "LOCKED", "createdAt": 1680027126.436, "datastoreId": "12345678901234567890123456789012" } ``` **例 7: force パラメータを使用して SOPInstanceUID を更新するには** 次の `update-image-set-metadata` の例は、force パラメータを使用して SOPInstanceUID を更新し、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 ``` `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\"}}}}}}}" } } ``` 出力: ``` { "latestVersionId": "2", "imageSetWorkflowStatus": "UPDATING", "updatedAt": 1680042257.908, "imageSetId": "53d5fdb05ca4d46ac7ca64b06545c66e", "imageSetState": "LOCKED", "createdAt": 1680027126.436, "datastoreId": "12345678901234567890123456789012" } ``` 詳細については、「*AWS HealthImaging Developer Guide*」の「[Updating image set metadata](https://docs.aws.amazon.com/healthimaging/latest/devguide/update-image-set-metadata.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateImageSetMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/update-image-set-metadata.html)」を参照してください。 # AWS CLI を使用した HealthLake の例 次のコード例は、HealthLake で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-fhir-datastore` 次のコード例は、`create-fhir-datastore` を使用する方法を示しています。 **AWS CLI** **例 1: SigV4 対応の HealthLake データストアを作成する** 次の `create-fhir-datastore` の例では、AWS HealthLake で新しいデータストアを作成する方法を示します。 ``` aws healthlake create-fhir-datastore \ --datastore-type-version R4 \ --datastore-name "FhirTestDatastore" ``` 出力: ``` { "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)" } ``` **例 2: SMART on FHIR 対応の HealthLake データストアを作成する** 次の `create-fhir-datastore` の例では、AWS HealthLake で新しい SMART on FHIR 対応のデータストアを作成する方法を示します。 ``` 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 ``` `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\"]}" } ``` 出力: ``` { "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)" } ``` 詳細については、*AWS HealthLake デベロッパーガイド*の「[FHIR データストアの作成とモニタリング](https://docs.aws.amazon.com/healthlake/latest/devguide/working-with-FHIR-healthlake.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[CreateFHIRDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/create-fhir-datastore.html)」を参照してください。 ### `delete-fhir-datastore` 次のコード例は、`delete-fhir-datastore` を使用する方法を示しています。 **AWS CLI** **FHIR Data Store を削除するには** 次の `delete-fhir-datastore` の例では、AWS HealthLake でデータストアとそのすべてのコンテンツを削除する方法を示します。 ``` aws healthlake delete-fhir-datastore \ --datastore-id (Data store ID) ``` 出力: ``` { "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)" } ``` 詳細については、*AWS HealthLake デベロッパーガイド*の「FHIR データストアの作成とモニタリング 」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DeleteFHIRDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/delete-fhir-datastore.html)」を参照してください。 ### `describe-fhir-datastore` 次のコード例は、`describe-fhir-datastore` を使用する方法を示しています。 **AWS CLI** **FHIR データストアの詳細を取得するには** 次の `describe-fhir-datastore` の例では、AWS HealthLake でデータストアのプロパティを見つける方法を示します。 ``` aws healthlake describe-fhir-datastore \ --datastore-id "1f2f459836ac6c513ce899f9e4f66a59" ``` 出力: ``` { "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 } } } ``` 詳細については、*AWS HealthLake デベロッパーガイド*の「[FHIR データストアの作成とモニタリング](https://docs.aws.amazon.com/healthlake/latest/devguide/working-with-FHIR-healthlake.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DescribeFHIRDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/describe-fhir-datastore.html)」を参照してください。 ### `describe-fhir-export-job` 次のコード例は、`describe-fhir-export-job` を使用する方法を示しています。 **AWS CLI** **FHIR エクスポートジョブを記述するには** 次の `describe-fhir-export-job` の例では、AWS HealthLake で FHIR エクスポートジョブのプロパティを見つける方法を示します。 ``` aws healthlake describe-fhir-export-job \ --datastore-id (Data store ID) \ --job-id 9b9a51943afaedd0a8c0c26c49135a31 ``` 出力: ``` { "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)" } } ``` 詳細については、*AWS HealthLake デベロッパーガイド*の「[FHIR データストアからのファイルエクスポート](https://docs.aws.amazon.com/healthlake/latest/devguide/export-datastore.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DescribeFHIRExportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/describe-fhir-export-job.html)」を参照してください。 ### `describe-fhir-import-job` 次のコード例は、`describe-fhir-import-job` を使用する方法を示しています。 **AWS CLI** **FHIR インポートジョブを記述するには** 次の `describe-fhir-import-job` の例では、AWS HealthLake を使用して FHIR インポートジョブのプロパティを学習する方法を示します。 ``` aws healthlake describe-fhir-import-job \ --datastore-id (Data store ID) \ --job-id c145fbb27b192af392f8ce6e7838e34f ``` 出力: ``` { "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)" } } ``` 詳細については、*AWS HealthLake デベロッパーガイド*の「[FHIR データストアへのファイルインポート](https://docs.aws.amazon.com/healthlake/latest/devguide/import-datastore.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DescribeFHIRImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/describe-fhir-import-job.html)」を参照してください。 ### `list-fhir-datastores` 次のコード例は、`list-fhir-datastores` を使用する方法を示しています。 **AWS CLI** **FHIR データストアを一覧表示するには** 次の `list-fhir-datastores` の例では、AWS HealthLake でコマンドを使用する方法と、データストアのステータスに基づいてユーザーが結果をフィルタリングする方法を示します。 ``` aws healthlake list-fhir-datastores \ --filter DatastoreStatus=ACTIVE ``` 出力: ``` { "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 } } ] } ``` 詳細については、*AWS HealthLake デベロッパーガイド*の「[FHIR データストアの作成とモニタリング](https://docs.aws.amazon.com/healthlake/latest/devguide/working-with-FHIR-healthlake.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[ListFHIRDatastores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/list-fhir-datastores.html)」を参照してください。 ### `list-fhir-export-jobs` 次のコード例は、`list-fhir-export-jobs` を使用する方法を示しています。 **AWS CLI** **すべての FHIR エクスポートジョブを一覧表示するには** 次の `list-fhir-export-jobs` の例は、コマンドを使用して、アカウントに関連付けられたエクスポートジョブのリストを表示する方法を示しています。 ``` 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) ``` 出力: ``` { "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)" } } ] } ``` 詳細については、AWS HealthLake デベロッパーガイドの「[FHIR データストアからのファイルエクスポート](https://docs.aws.amazon.com/healthlake/latest/devguide/export-datastore.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[ListFHIRExportJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/list-fhir-export-jobs.html)」を参照してください。 ### `list-fhir-import-jobs` 次のコード例は、`list-fhir-import-jobs` を使用する方法を示しています。 **AWS CLI** **すべての FHIR インポートジョブを一覧表示するには** 次の `list-fhir-import-jobs` の例は、コマンドを使用して、アカウントに関連付けられているすべてのインポートジョブのリストを表示する方法を示しています。 ``` 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) ``` 出力: ``` { "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)" } ] } ``` 詳細については、AWS HealthLake デベロッパーガイドの「[FHIR データストアへのファイルインポート](https://docs.aws.amazon.com/healthlake/latest/devguide/import-examples.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[ListFHIRImportJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/list-fhir-import-jobs.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **データストアのタグを一覧表示するには** 次の `list-tags-for-resource` の例では、指定したデータストアに関連付けられているタグを一覧表示します。 ``` aws healthlake list-tags-for-resource \ --resource-arn "arn:aws:healthlake:us-east-1:123456789012:datastore/fhir/0725c83f4307f263e16fd56b6d8ebdbe" ``` 出力: ``` { "tags": { "key": "value", "key1": "value1" } } ``` 詳細については、AWS HealthLake デベロッパーガイドの「[AWS HealthLake でのリソースのタグ付け](https://docs.aws.amazon.com/healthlake/latest/devguide/tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/list-tags-for-resource.html)」を参照してください。 ### `start-fhir-export-job` 次のコード例は、`start-fhir-export-job` を使用する方法を示しています。 **AWS CLI** **FHIR エクスポートジョブを開始するには** 次の `start-fhir-export-job` の例は、AWS HealthLake を使用して FHIR エクスポートジョブを開始する方法を示しています。 ``` 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) ``` 出力: ``` { "DatastoreId": "(Data store ID)", "JobStatus": "SUBMITTED", "JobId": "9b9a51943afaedd0a8c0c26c49135a31" } ``` 詳細については、*AWS HealthLake デベロッパーガイド*の「[FHIR データストアからのファイルエクスポート](https://docs.aws.amazon.com/healthlake/latest/devguide/export-datastore.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[StartFHIRExportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/start-fhir-export-job.html)」を参照してください。 ### `start-fhir-import-job` 次のコード例は、`start-fhir-import-job` を使用する方法を示しています。 **AWS CLI** **FHIR インポートジョブを開始するには** 次の `start-fhir-import-job` の例は、AWS HealthLake を使用して FHIR インポートジョブを開始する方法を示しています。 ``` 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)" ``` 出力: ``` { "DatastoreId": "(Data store ID)", "JobStatus": "SUBMITTED", "JobId": "c145fbb27b192af392f8ce6e7838e34f" } ``` 詳細については、*AWS HealthLake デベロッパーガイド*の「[FHIR データストアへのファイルインポート](https://docs.aws.amazon.com/healthlake/latest/devguide/import-datastore.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[StartFHIRImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/start-fhir-import-job.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **データストアにタグを追加するには** 次の `tag-resource` の例では、データストアにタグを追加する方法を示します。 ``` aws healthlake tag-resource \ --resource-arn "arn:aws:healthlake:us-east-1:123456789012:datastore/fhir/0725c83f4307f263e16fd56b6d8ebdbe" \ --tags '[{"Key": "key1", "Value": "value1"}]' ``` このコマンドでは何も出力されません。 詳細については、*AWS HealthLake デベロッパーガイド*の「[データストアへのタグの追加](https://docs.aws.amazon.com/healthlake/latest/devguide/add-a-tag.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **データストアからタグを削除するには** 次の `untag-resource` の例では、データストアからタグを削除する方法を示します。 ``` aws healthlake untag-resource \ --resource-arn "arn:aws:healthlake:us-east-1:123456789012:datastore/fhir/b91723d65c6fdeb1d26543a49d2ed1fa" \ --tag-keys '["key1"]' ``` このコマンドでは何も出力されません。 詳細については、*AWS HealthLake デベロッパーガイド*の「[データストアからのタグの削除](https://docs.aws.amazon.com/healthlake/latest/devguide/remove-tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/untag-resource.html)」を参照してください。 # AWS CLI を使用した HealthOmics の例 次のコード例は、HealthOmics で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `abort-multipart-read-set-upload` 次のコード例は、`abort-multipart-read-set-upload` を使用する方法を示しています。 **AWS CLI** **マルチパート読み取りセットのアップロードを停止するには** 次の `abort-multipart-read-set-upload` の例では、HealthOmics シーケンスストアへのマルチパート読み取りセットのアップロードを停止します。 ``` aws omics abort-multipart-read-set-upload \ --sequence-store-id 0123456789 \ --upload-id 1122334455 ``` このコマンドでは何も出力されません。 詳細については、「*AWS HealthOmics User Guide*」の「[Direct upload to a sequence store](https://docs.aws.amazon.com/omics/latest/dev/synchronous-uploads.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AbortMultipartReadSetUpload](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/abort-multipart-read-set-upload.html)」を参照してください。 ### `accept-share` 次のコード例は、`accept-share` を使用する方法を示しています。 **AWS CLI** **分析ストアデータの共有を受け入れるには** 次の `accept-share` の例では、HealthOmics 分析ストアデータの共有を受け入れます。 ``` aws omics accept-share \ ----share-id "495c21bedc889d07d0ab69d710a6841e-dd75ab7a1a9c384fa848b5bd8e5a7e0a" ``` 出力: ``` { "status": "ACTIVATING" } ``` 詳細については、「*AWS HealthOmics User Guide*」の「[Cross-account sharing](https://docs.aws.amazon.com/omics/latest/dev/cross-account-sharing.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AcceptShare](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/accept-share.html)」を参照してください。 ### `batch-delete-read-set` 次のコード例は、`batch-delete-read-set` を使用する方法を示しています。 **AWS CLI** **複数の読み取りセットを削除するには** 次の `batch-delete-read-set` の例では、2 つの読み取りセットを削除します。 ``` aws omics batch-delete-read-set \ --sequence-store-id 1234567890 \ --ids 1234567890 0123456789 ``` 指定された読み取りセットの削除でエラーが発生した場合、サービスはエラーリストを返します。 ``` { "errors": [ { "code": "", "id": "0123456789", "message": "The specified readset does not exist." } ] } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchDeleteReadSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/batch-delete-read-set.html)」を参照してください。 ### `cancel-annotation-import-job` 次のコード例は、`cancel-annotation-import-job` を使用する方法を示しています。 **AWS CLI** **注釈インポートジョブをキャンセルするには** 次の `cancel-annotation-import-job` の例では、ID `04f57618-xmpl-4fd0-9349-e5a85aefb997` の注釈インポートジョブをキャンセルします。 ``` aws omics cancel-annotation-import-job \ --job-id 04f57618-xmpl-4fd0-9349-e5a85aefb997 ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelAnnotationImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/cancel-annotation-import-job.html)」を参照してください。 ### `cancel-run` 次のコード例は、`cancel-run` を使用する方法を示しています。 **AWS CLI** **実行をキャンセルするには** 次の `cancel-run` の例では、ID `1234567` の実行をキャンセルします。 ``` aws omics cancel-run \ --id 1234567 ``` 詳細については、「*AWS HealthOmics ユーザーガイド*」の「[Run lifecycle in a workflow](https://docs.aws.amazon.com/omics/latest/dev/monitoring-runs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/cancel-run.html)」を参照してください。 ### `cancel-variant-import-job` 次のコード例は、`cancel-variant-import-job` を使用する方法を示しています。 **AWS CLI** **バリアントインポートジョブをキャンセルするには** 次の `cancel-variant-import-job` の例では、ID `69cb65d6-xmpl-4a4a-9025-4565794b684e` のバリアントインポートジョブをキャンセルします。 ``` aws omics cancel-variant-import-job \ --job-id 69cb65d6-xmpl-4a4a-9025-4565794b684e ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelVariantImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/cancel-variant-import-job.html)」を参照してください。 ### `complete-multipart-read-set-upload` 次のコード例は、`complete-multipart-read-set-upload` を使用する方法を示しています。 **AWS CLI** **すべてのコンポーネントをアップロードした後で、マルチパートアップロードを終了するには** 次の `complete-multipart-read-set-upload` の例では、すべてのコンポーネントがアップロードされた後で、シーケンスストアへのマルチパートアップロードを終了します。 ``` aws omics complete-multipart-read-set-upload \ --sequence-store-id 0123456789 \ --upload-id 1122334455 \ --parts '[{"checksum":"gaCBQMe+rpCFZxLpoP6gydBoXaKKDA/Vobh5zBDb4W4=","partNumber":1,"partSource":"SOURCE1"}]' ``` 出力: ``` { "readSetId": "0000000001" "readSetId": "0000000002" "readSetId": "0000000003" } ``` 詳細については、「*AWS HealthOmics User Guide*」の「[Direct upload to a sequence store](https://docs.aws.amazon.com/omics/latest/dev/synchronous-uploads.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CompleteMultipartReadSetUpload](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/complete-multipart-read-set-upload.html)」を参照してください。 ### `create-annotation-store-version` 次のコード例は、`create-annotation-store-version` を使用する方法を示しています。 **AWS CLI** **注釈ストアの新しいバージョンを作成するには** 次の `create-annotation-store-version` の例では、注釈ストアの新しいバージョンを作成します。 ``` aws omics create-annotation-store-version \ --name my_annotation_store \ --version-name my_version ``` 出力: ``` { "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" } ``` 詳細については、「*AWS HealthOmics User Guide*」の「[Creating new versions of annotation stores](https://docs.aws.amazon.com/omics/latest/dev/annotation-store-versioning.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateAnnotationStoreVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/create-annotation-store-version.html)」を参照してください。 ### `create-annotation-store` 次のコード例は、`create-annotation-store` を使用する方法を示しています。 **AWS CLI** **例 1: VCF 注釈ストアを作成するには** 次の `create-annotation-store` の例では、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 ``` 出力: ``` { "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" } ``` **例 2: TSV 注釈ストアを作成するには** 次の `create-annotation-store` の例では、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` は注釈の形式オプションを設定します。 ``` { "tsvStoreOptions": { "annotationType": "CHR_START_END_ZERO_BASE", "formatToHeader": { "CHR": "chromosome", "START": "start", "END": "end" }, "schema": [ { "chromosome": "STRING" }, { "start": "LONG" }, { "end": "LONG" }, { "name": "STRING" } ] } } ``` 出力: ``` { "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" } ] } } } ``` 詳細については、「Amazon Omics Developer Guide」の「[Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateAnnotationStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/create-annotation-store.html)」を参照してください。 ### `create-multipart-read-set-upload` 次のコード例は、`create-multipart-read-set-upload` を使用する方法を示しています。 **AWS CLI** **マルチパート読み取りセットのアップロードを開始するには** 次の `create-multipart-read-set-upload` の例では、マルチパート読み取りセットのアップロードを開始します。 ``` 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" ``` 出力: ``` { "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" } ``` 詳細については、「*AWS HealthOmics User Guide*」の「[Direct upload to a sequence store](https://docs.aws.amazon.com/omics/latest/dev/synchronous-uploads.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateMultipartReadSetUpload](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/create-multipart-read-set-upload.html)」を参照してください。 ### `create-reference-store` 次のコード例は、`create-reference-store` を使用する方法を示しています。 **AWS CLI** **参照ストアを作成するには** 次の `create-reference-store` の例では、参照ストア `my-ref-store` を作成します。 ``` aws omics create-reference-store \ --name my-ref-store ``` 出力: ``` { "arn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890", "creationTime": "2022-11-22T22:13:25.947Z", "id": "1234567890", "name": "my-ref-store" } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateReferenceStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/create-reference-store.html)」を参照してください。 ### `create-run-group` 次のコード例は、`create-run-group` を使用する方法を示しています。 **AWS CLI** **実行グループを作成するには** 次の `create-run-group` の例では、`cram-converter` という名前の実行グループを作成します。 ``` aws omics create-run-group \ --name cram-converter \ --max-cpus 20 \ --max-gpus 10 \ --max-duration 600 \ --max-runs 5 ``` 出力: ``` { "arn": "arn:aws:omics:us-west-2:123456789012:runGroup/1234567", "id": "1234567", "tags": {} } ``` 詳細については、「*AWS HealthOmics ユーザーガイド*」の「[Creating run groups](https://docs.aws.amazon.com/omics/latest/dev/creating-run-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateRunGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/create-run-group.html)」を参照してください。 ### `create-sequence-store` 次のコード例は、`create-sequence-store` を使用する方法を示しています。 **AWS CLI** **シーケンスストアを作成するには** 次の `create-sequence-store` の例では、シーケンスストアを作成します。 ``` aws omics create-sequence-store \ --name my-seq-store ``` 出力: ``` { "arn": "arn:aws:omics:us-west-2:123456789012:sequenceStore/1234567890", "creationTime": "2022-11-23T01:24:33.629Z", "id": "1234567890", "name": "my-seq-store" } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateSequenceStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/create-sequence-store.html)」を参照してください。 ### `create-share` 次のコード例は、`create-share` を使用する方法を示しています。 **AWS CLI** **HealthOmics 分析ストアの共有を作成するには** 次の `create-share` の例は、アカウント外のサブスクライバーが受け入れることができる HealthOmics 分析ストアの共有を作成する方法を示しています。 ``` 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" ``` 出力: ``` { "shareId": "495c21bedc889d07d0ab69d710a6841e-dd75ab7a1a9c384fa848b5bd8e5a7e0a", "name": "my_Share-123", "status": "PENDING" } ``` 詳細については、「*AWS HealthOmics ユーザーガイド*」の「[Cross-acount sharing](https://docs.aws.amazon.com/omics/latest/dev/cross-account-sharing.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateShare](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/create-share.html)」を参照してください。 ### `create-variant-store` 次のコード例は、`create-variant-store` を使用する方法を示しています。 **AWS CLI** **バリアントストアを作成するには** 次の `create-variant-store` の例では、`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 ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateVariantStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/create-variant-store.html)」を参照してください。 ### `create-workflow` 次のコード例は、`create-workflow` を使用する方法を示しています。 **AWS CLI** **ワークフローを作成するには** 次の `create-workflow` の例では、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` は、ワークフロー定義を含む ZIP アーカイブです。`workflow-params.json` は、ワークフローのランタイムパラメータを定義します。 ``` { "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 } } ``` 出力: ``` { "arn": "arn:aws:omics:us-west-2:123456789012:workflow/1234567", "id": "1234567", "status": "CREATING", "tags": {} } ``` 詳細については、「*AWS HealthOmics ユーザーガイド*」の「[Creating private workflows](https://docs.aws.amazon.com/omics/latest/dev/workflows-setup.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateWorkflow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/create-workflow.html)」を参照してください。 ### `delete-annotation-store-versions` 次のコード例は、`delete-annotation-store-versions` を使用する方法を示しています。 **AWS CLI** **注釈ストアのバージョンを削除するには** 次の `delete-annotation-store-versions` の例では、注釈ストアのバージョンを削除します。 ``` aws omics delete-annotation-store-versions \ --name my_annotation_store \ --versions my_version ``` 出力: ``` { "errors": [] } ``` 詳細については、「*AWS HealthOmics User Guide*」の「[Creating new versions of annotation stores](https://docs.aws.amazon.com/omics/latest/dev/annotation-store-versioning.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAnnotationStoreVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/delete-annotation-store-versions.html)」を参照してください。 ### `delete-annotation-store` 次のコード例は、`delete-annotation-store` を使用する方法を示しています。 **AWS CLI** **注釈ストアを削除するには** 次の `delete-annotation-store` の例では、`my_vcf_store` という名前の注釈ストアを削除します。 ``` aws omics delete-annotation-store \ --name my_vcf_store ``` 出力: ``` { "status": "DELETING" } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAnnotationStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/delete-annotation-store.html)」を参照してください。 ### `delete-reference-store` 次のコード例は、`delete-reference-store` を使用する方法を示しています。 **AWS CLI** **参照ストアを削除するには** 次の `delete-reference-store` の例では、ID `1234567890` の参照ストアを削除します。 ``` aws omics delete-reference-store \ --id 1234567890 ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteReferenceStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/delete-reference-store.html)」を参照してください。 ### `delete-reference` 次のコード例は、`delete-reference` を使用する方法を示しています。 **AWS CLI** **参照を削除するには** 次の `delete-reference` の例では、参照を削除します。 ``` aws omics delete-reference \ --reference-store-id 1234567890 \ --id 1234567890 ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteReference](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/delete-reference.html)」を参照してください。 ### `delete-run-group` 次のコード例は、`delete-run-group` を使用する方法を示しています。 **AWS CLI** **実行グループを削除するには** 次の `delete-run-group` の例では、ID `1234567` の実行グループを削除します。 ``` aws omics delete-run-group \ --id 1234567 ``` 詳細については、「*AWS HealthOmics ユーザーガイド*」の「[Deleting runs and run groups](https://docs.aws.amazon.com/omics/latest/dev/deleting-workflows-and-runs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRunGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/delete-run-group.html)」を参照してください。 ### `delete-run` 次のコード例は、`delete-run` を使用する方法を示しています。 **AWS CLI** **ワークフローの実行を削除するには** 次の `delete-run` の例では、ID `1234567` の実行を削除します。 ``` aws omics delete-run \ --id 1234567 ``` 詳細については、「*AWS HealthOmics ユーザーガイド*」の「[Deleting runs and run groups](https://docs.aws.amazon.com/omics/latest/dev/deleting-workflows-and-runs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/delete-run.html)」を参照してください。 ### `delete-sequence-store` 次のコード例は、`delete-sequence-store` を使用する方法を示しています。 **AWS CLI** **シーケンスストアを削除するには** 次の `delete-sequence-store` の例では、ID `1234567890` のシーケンスストアを削除します。 ``` aws omics delete-sequence-store \ --id 1234567890 ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteSequenceStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/delete-sequence-store.html)」を参照してください。 ### `delete-share` 次のコード例は、`delete-share` を使用する方法を示しています。 **AWS CLI** **HealthOmics 分析データの共有を削除するには** 次の `delete-share` の例では、分析データのクロスアカウント共有を削除します。 ``` aws omics delete-share \ --share-id "495c21bedc889d07d0ab69d710a6841e-dd75ab7a1a9c384fa848b5bd8e5a7e0a" ``` 出力: ``` { "status": "DELETING" } ``` 詳細については、「*AWS HealthOmics User Guide*」の「[Cross-account sharing](https://docs.aws.amazon.com/omics/latest/dev/cross-account-sharing.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteShare](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/delete-share.html)」を参照してください。 ### `delete-variant-store` 次のコード例は、`delete-variant-store` を使用する方法を示しています。 **AWS CLI** **バリアントストアを削除するには** 次の `delete-variant-store` の例では、`my_var_store` というバリアントストアを削除します。 ``` aws omics delete-variant-store \ --name my_var_store ``` 出力: ``` { "status": "DELETING" } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteVariantStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/delete-variant-store.html)」を参照してください。 ### `delete-workflow` 次のコード例は、`delete-workflow` を使用する方法を示しています。 **AWS CLI** **ワークフローを削除するには** 次の `delete-workflow` の例では、ID `1234567` のワークフローを削除します。 ``` aws omics delete-workflow \ --id 1234567 ``` 詳細については、「*AWS HealthOmics ユーザーガイド*」の「[Delete a private workflow](https://docs.aws.amazon.com/omics/latest/dev/delete-private-workflow.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteWorkflow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/delete-workflow.html)」を参照してください。 ### `get-annotation-import-job` 次のコード例は、`get-annotation-import-job` を使用する方法を示しています。 **AWS CLI** **注釈インポートジョブを表示するには** 次の `get-annotation-import-job` の例では、注釈インポートジョブの詳細を取得します。 ``` aws omics get-annotation-import-job \ --job-id 984162c7-xmpl-4d23-ab47-286f7950bfbf ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAnnotationImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-annotation-import-job.html)」を参照してください。 ### `get-annotation-store-version` 次のコード例は、`get-annotation-store-version` を使用する方法を示しています。 **AWS CLI** **注釈ストアバージョンのメタデータを取得するには** 次の `get-annotation-store-version` の例では、リクエストされた注釈ストアバージョンのメタデータを取得します。 ``` aws omics get-annotation-store-version \ --name my_annotation_store \ --version-name my_version ``` 出力: ``` { "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 } ``` 詳細については、「*AWS HealthOmics User Guide*」の「[Creating new versions of annotation stores](https://docs.aws.amazon.com/omics/latest/dev/annotation-store-versioning.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAnnotationStoreVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-annotation-store-version.html)」を参照してください。 ### `get-annotation-store` 次のコード例は、`get-annotation-store` を使用する方法を示しています。 **AWS CLI** **注釈ストアを表示するには** 次の `get-annotation-store` の例では、`my_ann_store` という名前の注釈ストアの詳細を取得します。 ``` aws omics get-annotation-store \ --name my_ann_store ``` 出力: ``` { "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": {} } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAnnotationStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-annotation-store.html)」を参照してください。 ### `get-read-set-activation-job` 次のコード例は、`get-read-set-activation-job` を使用する方法を示しています。 **AWS CLI** **読み取りセットのアクティベーションジョブを表示するには** 次の `get-read-set-activation-job` の例では、読み取りセットのアクティベーションジョブの詳細を取得します。 ``` aws omics get-read-set-activation-job \ --sequence-store-id 1234567890 \ --id 1234567890 ``` 出力: ``` { "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." } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetReadSetActivationJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-read-set-activation-job.html)」を参照してください。 ### `get-read-set-export-job` 次のコード例は、`get-read-set-export-job` を使用する方法を示しています。 **AWS CLI** **読み取りセットのエクスポートジョブを表示するには** 次の `get-read-set-export-job` の例では、読み取りセットのエクスポートジョブの詳細を取得します。 ``` aws omics get-read-set-export-job \ --sequence-store-id 1234567890 \ --id 1234567890 ``` 出力: ``` { "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." } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetReadSetExportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-read-set-export-job.html)」を参照してください。 ### `get-read-set-import-job` 次のコード例は、`get-read-set-import-job` を使用する方法を示しています。 **AWS CLI** **読み取りセットのインポートジョブを表示するには** 次の `get-read-set-import-job` の例では、読み取りセットのインポートジョブの詳細を取得します。 ``` aws omics get-read-set-import-job \ --sequence-store-id 1234567890 \ --id 1234567890 ``` 出力: ``` { "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." } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetReadSetImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-read-set-import-job.html)」を参照してください。 ### `get-read-set-metadata` 次のコード例は、`get-read-set-metadata` を使用する方法を示しています。 **AWS CLI** **読み取りセットを表示するには** 次の `get-read-set-metadata` の例では、読み取りセットのファイルの詳細を取得します。 ``` aws omics get-read-set-metadata \ --sequence-store-id 1234567890 \ --id 1234567890 ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetReadSetMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-read-set-metadata.html)」を参照してください。 ### `get-read-set` 次のコード例は、`get-read-set` を使用する方法を示しています。 **AWS CLI** **読み取りセットをダウンロードするには** 次の `get-read-set` の例では、読み取りセットのパート 3 を `1234567890.3.bam` としてダウンロードします。 ``` aws omics get-read-set \ --sequence-store-id 1234567890 \ --id 1234567890 \ --part-number 3 1234567890.3.bam ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetReadSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-read-set.html)」を参照してください。 ### `get-reference-import-job` 次のコード例は、`get-reference-import-job` を使用する方法を示しています。 **AWS CLI** **参照インポートジョブを表示するには** 次の `get-reference-import-job` の例では、参照インポートジョブの詳細を取得します。 ``` aws omics get-reference-import-job \ --reference-store-id 1234567890 \ --id 1234567890 ``` 出力: ``` { "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." } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetReferenceImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-reference-import-job.html)」を参照してください。 ### `get-reference-metadata` 次のコード例は、`get-reference-metadata` を使用する方法を示しています。 **AWS CLI** **参照を表示するには** 次の `get-reference-metadata` の例では、参照の詳細を取得します。 ``` aws omics get-reference-metadata \ --reference-store-id 1234567890 \ --id 1234567890 ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetReferenceMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-reference-metadata.html)」を参照してください。 ### `get-reference-store` 次のコード例は、`get-reference-store` を使用する方法を示しています。 **AWS CLI** **参照ストアを表示するには** 次の `get-reference-store` の例では、参照ストアの詳細を取得します。 ``` aws omics get-reference-store \ --id 1234567890 ``` 出力: ``` { "arn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890", "creationTime": "2022-09-23T23:27:20.364Z", "id": "1234567890", "name": "my-rstore-0" } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetReferenceStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-reference-store.html)」を参照してください。 ### `get-reference` 次のコード例は、`get-reference` を使用する方法を示しています。 **AWS CLI** **ゲノム参照をダウンロードするには** 次の `get-reference` の例では、ゲノムのパート 1 を `hg38.1.fa` としてダウンロードします。 ``` aws omics get-reference \ --reference-store-id 1234567890 \ --id 1234567890 \ --part-number 1 hg38.1.fa ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetReference](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-reference.html)」を参照してください。 ### `get-run-group` 次のコード例は、`get-run-group` を使用する方法を示しています。 **AWS CLI** **実行グループを表示するには** 次の `get-run-group` の例では、実行グループの詳細を取得します。 ``` aws omics get-run-group \ --id 1234567 ``` 出力: ``` { "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": {} } ``` 詳細については、「*AWS HealthOmics ユーザーガイド*」の「[Creating run groups](https://docs.aws.amazon.com/omics/latest/dev/creating-run-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRunGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-run-group.html)」を参照してください。 ### `get-run-task` 次のコード例は、`get-run-task` を使用する方法を示しています。 **AWS CLI** **タスクを表示するには** 次の `get-run-task` の例では、ワークフロータスクの詳細を取得します。 ``` aws omics get-run-task \ --id 1234567 \ --task-id 1234567 ``` 出力: ``` { "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" } ``` 詳細については、「*AWS HealthOmics ユーザーガイド*」の「[Task lifecycle in a HealthOmics run](https://docs.aws.amazon.com/omics/latest/dev/workflow-run-tasks.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRunTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-run-task.html)」を参照してください。 ### `get-run` 次のコード例は、`get-run` を使用する方法を示しています。 **AWS CLI** **ワークフローの実行を表示するには** 次の `get-run` の例では、ワークフロー実行の詳細を取得します。 ``` aws omics get-run \ --id 1234567 ``` 出力: ``` { "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" } ``` 詳細については、「*AWS HealthOmics ユーザーガイド*」の「[Run lifecycle in a workflow‭](https://docs.aws.amazon.com/omics/latest/dev/monitoring-runs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-run.html)」を参照してください。 ### `get-sequence-store` 次のコード例は、`get-sequence-store` を使用する方法を示しています。 **AWS CLI** **シーケンスストアを表示するには** 次の `get-sequence-store` の例では、ID `1234567890` のシーケンスストアの詳細を取得します。 ``` aws omics get-sequence-store \ --id 1234567890 ``` 出力: ``` { "arn": "arn:aws:omics:us-east-1:123456789012:sequenceStore/1234567890", "creationTime": "2022-11-23T19:55:48.376Z", "id": "1234567890", "name": "my-seq-store" } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetSequenceStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-sequence-store.html)」を参照してください。 ### `get-share` 次のコード例は、`get-share` を使用する方法を示しています。 **AWS CLI** **HealthOmics 分析データの共有に関するメタデータを取得するには** 次の `get-share` の例では、分析データのクロスアカウント共有のメタデータを取得します。 ``` aws omics get-share \ --share-id "495c21bedc889d07d0ab69d710a6841e-dd75ab7a1a9c384fa848b5bd8e5a7e0a" ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS HealthOmics User Guide*」の「[Cross-account sharing](https://docs.aws.amazon.com/omics/latest/dev/cross-account-sharing.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetShare](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-share.html)」を参照してください。 ### `get-variant-import-job` 次のコード例は、`get-variant-import-job` を使用する方法を示しています。 **AWS CLI** **バリアントインポートジョブを表示するには** 次の `get-variant-import-job` の例では、バリアントインポートジョブの詳細を取得します。 ``` aws omics get-variant-import-job \ --job-id edd7b8ce-xmpl-47e2-bc99-258cac95a508 ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetVariantImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-variant-import-job.html)」を参照してください。 ### `get-variant-store` 次のコード例は、`get-variant-store` を使用する方法を示しています。 **AWS CLI** **バリアントストアを表示するには** 次の `get-variant-store` の例では、バリアントストアの詳細を取得します。 ``` aws omics get-variant-store \ --name my_var_store ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetVariantStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-variant-store.html)」を参照してください。 ### `get-workflow` 次のコード例は、`get-workflow` を使用する方法を示しています。 **AWS CLI** **ワークフローを表示するには** 次の `get-workflow` の例では、ID `1234567` のワークフローの詳細を取得します。 ``` aws omics get-workflow \ --id 1234567 ``` 出力: ``` { "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" } ``` 詳細については、「*AWS HealthOmics ユーザーガイド*」の「[Creating private workflows](https://docs.aws.amazon.com/omics/latest/dev/workflows-setup.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetWorkflow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/get-workflow.html)」を参照してください。 ### `list-annotation-import-jobs` 次のコード例は、`list-annotation-import-jobs` を使用する方法を示しています。 **AWS CLI** **注釈インポートジョブのリストを取得するには** 次の `list-annotation-import-jobs` は、注釈インポートジョブのリストを取得します。 ``` aws omics list-annotation-import-jobs ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAnnotationImportJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-annotation-import-jobs.html)」を参照してください。 ### `list-annotation-store-versions` 次のコード例は、`list-annotation-store-versions` を使用する方法を示しています。 **AWS CLI** **注釈ストアのすべてのバージョンを一覧表示するには** 次の `list-annotation-store-versions` の例では、注釈ストアが存在するすべてのバージョンを一覧表示します。 ``` aws omics list-annotation-store-versions \ --name my_annotation_store ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS HealthOmics User Guide*」の「[Creating new versions of annotation stores](https://docs.aws.amazon.com/omics/latest/dev/annotation-store-versioning.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAnnotationStoreVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-annotation-store-versions.html)」を参照してください。 ### `list-annotation-stores` 次のコード例は、`list-annotation-stores` を使用する方法を示しています。 **AWS CLI** **注釈ストアのリストを取得するには** 次の `list-annotation-stores` の例では、注釈ストアのリストを取得します。 ``` aws omics list-annotation-stores ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAnnotationStores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-annotation-stores.html)」を参照してください。 ### `list-multipart-read-set-uploads` 次のコード例は、`list-multipart-read-set-uploads` を使用する方法を示しています。 **AWS CLI** **すべてのマルチパート読み取りセットのアップロードとそのステータスを一覧表示するには** 次の `list-multipart-read-set-uploads` の例では、すべてのマルチパート読み取りセットのアップロードとそのステータスを一覧表示します。 ``` aws omics list-multipart-read-set-uploads \ --sequence-store-id 0123456789 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS HealthOmics User Guide*」の「[Direct upload to a sequence store](https://docs.aws.amazon.com/omics/latest/dev/synchronous-uploads.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListMultipartReadSetUploads](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-multipart-read-set-uploads.html)」を参照してください。 ### `list-read-set-activation-jobs` 次のコード例は、`list-read-set-activation-jobs` を使用する方法を示しています。 **AWS CLI** **読み取りセットのアクティベーションジョブのリストを取得するには** 次の `list-read-set-activation-jobs` の例では、ID `1234567890` のシーケンスストアのアクティベーションジョブのリストを取得します。 ``` aws omics list-read-set-activation-jobs \ --sequence-store-id 1234567890 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListReadSetActivationJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-read-set-activation-jobs.html)」を参照してください。 ### `list-read-set-export-jobs` 次のコード例は、`list-read-set-export-jobs` を使用する方法を示しています。 **AWS CLI** **読み取りセットのエクスポートジョブのリストを取得するには** 次の `list-read-set-export-jobs` の例では、ID `1234567890` のシーケンスストアのエクスポートジョブのリストを取得します。 ``` aws omics list-read-set-export-jobs \ --sequence-store-id 1234567890 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListReadSetExportJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-read-set-export-jobs.html)」を参照してください。 ### `list-read-set-import-jobs` 次のコード例は、`list-read-set-import-jobs` を使用する方法を示しています。 **AWS CLI** **読み取りセットインポートジョブのリストを取得するには** 次の `list-read-set-import-jobs` の例では、ID `1234567890` のシーケンスストアのインポートジョブのリストを取得します。 ``` aws omics list-read-set-import-jobs \ --sequence-store-id 1234567890 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListReadSetImportJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-read-set-import-jobs.html)」を参照してください。 ### `list-read-set-upload-parts` 次のコード例は、`list-read-set-upload-parts` を使用する方法を示しています。 **AWS CLI** **シーケンスストアのリクエストされたマルチパートアップロード内のすべてのパートを一覧表示するには** 次の `list-read-set-upload-parts` の例では、シーケンスストアのリクエストされたマルチパートアップロードのすべてのパートを一覧表示します。 ``` aws omics list-read-set-upload-parts \ --sequence-store-id 0123456789 \ --upload-id 1122334455 \ --part-source SOURCE1 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS HealthOmics User Guide*」の「[Direct upload to a sequence store](https://docs.aws.amazon.com/omics/latest/dev/synchronous-uploads.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListReadSetUploadParts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-read-set-upload-parts.html)」を参照してください。 ### `list-read-sets` 次のコード例は、`list-read-sets` を使用する方法を示しています。 **AWS CLI** **読み取りセットのリストを取得するには** 次の `list-read-sets` の例では、ID `1234567890` のシーケンスストアの読み取りセットのリストを取得します。 ``` aws omics list-read-sets \ --sequence-store-id 1234567890 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListReadSets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-read-sets.html)」を参照してください。 ### `list-reference-import-jobs` 次のコード例は、`list-reference-import-jobs` を使用する方法を示しています。 **AWS CLI** **参照インポートジョブのリストを取得するには** 次の `list-reference-import-jobs` の例では、ID `1234567890` の参照ストアの参照インポートジョブのリストを取得します。 ``` aws omics list-reference-import-jobs \ --reference-store-id 1234567890 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListReferenceImportJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-reference-import-jobs.html)」を参照してください。 ### `list-reference-stores` 次のコード例は、`list-reference-stores` を使用する方法を示しています。 **AWS CLI** **参照ストアのリストを取得するには** 次の `list-reference-stores` の例では、参照ストアのリストを取得します。 ``` aws omics list-reference-stores ``` 出力: ``` { "referenceStores": [ { "arn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890", "creationTime": "2022-11-22T22:13:25.947Z", "id": "1234567890", "name": "my-ref-store" } ] } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListReferenceStores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-reference-stores.html)」を参照してください。 ### `list-references` 次のコード例は、`list-references` を使用する方法を示しています。 **AWS CLI** **参照のリストを取得するには** 次の `list-references` の例では、ID `1234567890` の参照ストアのゲノム参照のリストを取得します。 ``` aws omics list-references \ --reference-store-id 1234567890 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListReferences](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-references.html)」を参照してください。 ### `list-run-groups` 次のコード例は、`list-run-groups` を使用する方法を示しています。 **AWS CLI** **実行グループのリストを取得するには** 次の `list-run-groups` の例では、実行グループのリストを取得します。 ``` aws omics list-run-groups ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS HealthOmics ユーザーガイド*」の「[Creating run groups](https://docs.aws.amazon.com/omics/latest/dev/creating-run-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRunGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-run-groups.html)」を参照してください。 ### `list-run-tasks` 次のコード例は、`list-run-tasks` を使用する方法を示しています。 **AWS CLI** **タスクのリストを取得するには** 次の `list-run-tasks` の例では、ワークフロー実行のタスクのリストを取得します。 ``` aws omics list-run-tasks \ --id 1234567 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS HealthOmics ユーザーガイド*」の「[Task lifecycle in a HealthOmics run](https://docs.aws.amazon.com/omics/latest/dev/workflow-run-tasks.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRunTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-run-tasks.html)」を参照してください。 ### `list-runs` 次のコード例は、`list-runs` を使用する方法を示しています。 **AWS CLI** **ワークフロー実行のリストを取得するには** 次の `list-runs` の例では、ワークフロー実行のリストを取得します。 ``` aws omics list-runs ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS HealthOmics ユーザーガイド*」の「[Run lifecycle in a workflow‭](https://docs.aws.amazon.com/omics/latest/dev/monitoring-runs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRuns](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-runs.html)」を参照してください。 ### `list-sequence-stores` 次のコード例は、`list-sequence-stores` を使用する方法を示しています。 **AWS CLI** **シーケンスストアのリストを取得するには** 次の `list-sequence-stores` の例では、シーケンスストアのリストを取得します。 ``` aws omics list-sequence-stores ``` 出力: ``` { "sequenceStores": [ { "arn": "arn:aws:omics:us-west-2:123456789012:sequenceStore/1234567890", "creationTime": "2022-11-23T01:24:33.629Z", "id": "1234567890", "name": "my-seq-store" } ] } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListSequenceStores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-sequence-stores.html)」を参照してください。 ### `list-shares` 次のコード例は、`list-shares` を使用する方法を示しています。 **AWS CLI** **HealthOmics 分析データの使用可能な共有を一覧表示するには** 次の `list-shares` の例では、リソース所有者用に作成されたすべての共有を一覧表示します。 ``` aws omics list-shares \ --resource-owner SELF ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS HealthOmics User Guide*」の「[Cross-account sharing](https://docs.aws.amazon.com/omics/latest/dev/cross-account-sharing.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListShares](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-shares.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **タグのリストを取得するには** 次の `list-tags-for-resource` の例では、ID `1234567` のワークフローのタグのリストを取得します。 ``` aws omics list-tags-for-resource \ --resource-arn arn:aws:omics:us-west-2:123456789012:workflow/1234567 ``` 出力: ``` { "tags": { "department": "analytics" } } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Amazon Omics リソースにタグを付ける](https://docs.aws.amazon.com/omics/latest/dev/workflows.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-tags-for-resource.html)」を参照してください。 ### `list-variant-import-jobs` 次のコード例は、`list-variant-import-jobs` を使用する方法を示しています。 **AWS CLI** **バリアントインポートジョブのリストを取得するには** 次の `list-variant-import-jobs` の例では、バリアントインポートジョブのリストを取得します。 ``` aws omics list-variant-import-jobs ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListVariantImportJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-variant-import-jobs.html)」を参照してください。 ### `list-variant-stores` 次のコード例は、`list-variant-stores` を使用する方法を示しています。 **AWS CLI** **バリアントストアのリストを取得するには** 次の `list-variant-stores` の例では、バリアントストアのリストを取得します。 ``` aws omics list-variant-stores ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListVariantStores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-variant-stores.html)」を参照してください。 ### `list-workflows` 次のコード例は、`list-workflows` を使用する方法を示しています。 **AWS CLI** **ワークフローのリストを取得するには** 次の `list-workflows` の例では、ワークフローのリストを取得します。 ``` aws omics list-workflows ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS HealthOmics ユーザーガイド*」の「[Creating private workflows](https://docs.aws.amazon.com/omics/latest/dev/workflows-setup.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListWorkflows](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/list-workflows.html)」を参照してください。 ### `start-annotation-import-job` 次のコード例は、`start-annotation-import-job` を使用する方法を示しています。 **AWS CLI** **注釈をインポートするには** 次の `start-annotation-import-job` の例では、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 ``` 出力: ``` { "jobId": "984162c7-xmpl-4d23-ab47-286f7950bfbf" } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartAnnotationImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/start-annotation-import-job.html)」を参照してください。 ### `start-read-set-activation-job` 次のコード例は、`start-read-set-activation-job` を使用する方法を示しています。 **AWS CLI** **アーカイブされた読み取りセットをアクティブ化するには** 次の `start-read-set-activation-job` の例では、2 つの読み取りセットをアクティブ化します。 ``` aws omics start-read-set-activation-job \ --sequence-store-id 1234567890 \ --sources readSetId=1234567890 readSetId=1234567890 ``` 出力: ``` { "creationTime": "2022-12-06T22:35:10.100Z", "id": "1234567890", "sequenceStoreId": "1234567890", "status": "SUBMITTED" } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartReadSetActivationJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/start-read-set-activation-job.html)」を参照してください。 ### `start-read-set-export-job` 次のコード例は、`start-read-set-export-job` を使用する方法を示しています。 **AWS CLI** **読み取りセットをエクスポートするには** 次の `start-read-set-export-job` の例では、2 つの読み取りセットを 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/ ``` 出力: ``` { "creationTime": "2022-12-06T22:37:18.612Z", "destination": "s3://omics-artifacts-01d6xmpl4e72dd32/read-set-export/", "id": "1234567890", "sequenceStoreId": "1234567890", "status": "SUBMITTED" } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartReadSetExportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/start-read-set-export-job.html)」を参照してください。 ### `start-read-set-import-job` 次のコード例は、`start-read-set-import-job` を使用する方法を示しています。 **AWS CLI** **読み取りセットをインポートするには** 次の `start-read-set-import-job` の例では、読み取りセットをインポートします。 ``` 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 は、次のコンテンツを含む JSON ドキュメントです。 ``` [ { "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" } ] ``` 出力: ``` { "creationTime": "2022-11-23T01:36:38.158Z", "id": "1234567890", "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ", "sequenceStoreId": "1234567890", "status": "SUBMITTED" } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartReadSetImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/start-read-set-import-job.html)」を参照してください。 ### `start-reference-import-job` 次のコード例は、`start-reference-import-job` を使用する方法を示しています。 **AWS CLI** **参照ゲノムをインポートするには** 次の `start-reference-import-job` の例では、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 ``` 出力: ``` { "creationTime": "2022-11-22T22:25:41.124Z", "id": "1234567890", "referenceStoreId": "1234567890", "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ", "status": "SUBMITTED" } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/sequence-stores.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartReferenceImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/start-reference-import-job.html)」を参照してください。 ### `start-run` 次のコード例は、`start-run` を使用する方法を示しています。 **AWS CLI** **ワークフローを実行するには** 次の `start-run` の例では、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 は、次のコンテンツを含む JSON ドキュメントです。 ``` { "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" } ``` 出力: ``` { "arn": "arn:aws:omics:us-west-2:123456789012:run/1234567", "id": "1234567", "status": "PENDING", "tags": {} } ``` 詳細については、「*AWS HealthOmics ユーザーガイド*」の「[Starting a run](https://docs.aws.amazon.com/omics/latest/dev/starting-a-run.html)」を参照してください。 **Amazon Omics からソースファイルをロードするには** サービス固有の URI を使用して、Amazon Omics Storage からソースファイルをロードすることもできます。次の workflow-inputs.json ファイルの例では、読み取りセットおよび参照ゲノムのソースに Amazon Omics URI を使用します。 ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/start-run.html)」を参照してください。 ### `start-variant-import-job` 次のコード例は、`start-variant-import-job` を使用する方法を示しています。 **AWS CLI** **バリアントファイルをインポートするには** 次の `start-variant-import-job` の例では、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 ``` 出力: ``` { "jobId": "edd7b8ce-xmpl-47e2-bc99-258cac95a508" } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartVariantImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/start-variant-import-job.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **リソースにタグを付けるには** 次の `tag-resource` の例では、ID `1234567` のワークフローに `department` タグを追加します。 ``` aws omics tag-resource \ --resource-arn arn:aws:omics:us-west-2:123456789012:workflow/1234567 \ --tags department=analytics ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Amazon Omics リソースにタグを付ける](https://docs.aws.amazon.com/omics/latest/dev/workflows.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/tag-resource.html)」を参照してください。 ### `untag-resource` 次の例では、`untag-resource` を使用する方法を説明しています。 **AWS CLI** **リソースからタグを削除するには** 次の `untag-resource` の例では、ワークフローから `department` タグを削除します。 ``` aws omics untag-resource \ --resource-arn arn:aws:omics:us-west-2:123456789012:workflow/1234567 \ --tag-keys department ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Storage](https://docs.aws.amazon.com/omics/latest/dev/tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/untag-resource.html)」を参照してください。 ### `update-annotation-store` 次のコード例は、`update-annotation-store` を使用する方法を示しています。 **AWS CLI** **注釈ストアを更新するには** 次の `update-annotation-store` の例では、`my_vcf_store` という名前の注釈ストアの説明を更新します。 ``` aws omics update-annotation-store \ --name my_vcf_store \ --description "VCF annotation store" ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateAnnotationStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/update-annotation-store.html)」を参照してください。 ### `update-run-group` 次のコード例は、`update-run-group` を使用する方法を示しています。 **AWS CLI** **実行グループを更新するには** 次の `update-run-group` の例では、ID `1234567` の実行グループの設定を更新します。 ``` aws omics update-run-group \ --id 1234567 \ --max-cpus 10 ``` 出力: ``` { "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": {} } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Workflows](https://docs.aws.amazon.com/omics/latest/dev/workflows.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateRunGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/update-run-group.html)」を参照してください。 ### `update-variant-store` 次のコード例は、`update-variant-store` を使用する方法を示しています。 **AWS CLI** **バリアントストアを更新するには** 次の `update-variant-store` の例では、`my_var_store` という名前のバリアントストアの説明を更新します。 ``` aws omics update-variant-store \ --name my_var_store \ --description "variant store" ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Omics Developer Guide*」の「[Omics Analytics](https://docs.aws.amazon.com/omics/latest/dev/omics-analytics.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateVariantStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/update-variant-store.html)」を参照してください。 ### `update-workflow` 次のコード例は、`update-workflow` を使用する方法を示しています。 **AWS CLI** **ワークフローを更新するには** 次の `update-workflow` の例では、ID `1234567` のワークフローの説明を更新します。 ``` aws omics update-workflow \ --id 1234567 \ --description "copy workflow" ``` 詳細については、「*AWS HealthOmics ユーザーガイド*」の「[Creating or updating a workflow](https://docs.aws.amazon.com/omics/latest/dev/creating-private-workflows.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateWorkflow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/update-workflow.html)」を参照してください。 ### `upload-read-set-part` 次のコード例は、`upload-read-set-part` を使用する方法を示しています。 **AWS CLI** **読み取りセットのパートをアップロードするには** 次の `upload-read-set-part` の例では、読み取りセットの指定されたパートをアップロードします。 ``` 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 ``` 出力: ``` { "checksum": "984979b9928ae8d8622286c4a9cd8e99d964a22d59ed0f5722e1733eb280e635" } ``` 詳細については、「*AWS HealthOmics User Guide*」の「[Direct upload to a sequence store](https://docs.aws.amazon.com/omics/latest/dev/synchronous-uploads.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UploadReadSetPart](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/omics/upload-read-set-part.html)」を参照してください。 # AWS CLI を使用した IAM の例 次のコード例は、IAM で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `add-client-id-to-open-id-connect-provider` 次のコード例は、`add-client-id-to-open-id-connect-provider` を使用する方法を示しています。 **AWS CLI** **Open-ID Connect (OIDC) プロバイダーにクライアント ID (対象者) を追加するには** 次の `add-client-id-to-open-id-connect-provider` コマンドは、クライアント ID `my-application-ID` を `server.example.com` という名前の OIDC プロバイダーに追加します。 ``` 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 ``` このコマンドでは何も出力されません。 OIDC プロバイダーを作成するには、`create-open-id-connect-provider` コマンドを使用します。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM で OpenID Connect (OIDC) ID プロバイダーを作成する](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddClientIdToOpenIdConnectProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/add-client-id-to-open-id-connect-provider.html)」を参照してください。 ### `add-role-to-instance-profile` 次のコード例は、`add-role-to-instance-profile` を使用する方法を示しています。 **AWS CLI** **ロールをインスタンスプロファイルに追加するには** 次の `add-role-to-instance-profile` コマンドは、`S3Access` という名前のロールを `Webserver` という名前のインスタンスプロファイルに追加します。 ``` aws iam add-role-to-instance-profile \ --role-name S3Access \ --instance-profile-name Webserver ``` このコマンドでは何も出力されません。 インスタンスプロファイルを作成するには、`create-instance-profile` コマンドを使用します。 詳細については、「*AWS IAM ユーザーガイド*」の「[Amazon EC2 インスタンスで実行されるアプリケーションに IAM ロールを使用してアクセス許可を付与する](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddRoleToInstanceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/add-role-to-instance-profile.html)」を参照してください。 ### `add-user-to-group` 次のコード例は、`add-user-to-group` を使用する方法を示しています。 **AWS CLI** **IAM グループにユーザーを追加するには** 次の `add-user-to-group` コマンドは、`Bob` という名前の IAM ユーザーを `Admins` という名前の IAM グループに追加します。 ``` aws iam add-user-to-group \ --user-name Bob \ --group-name Admins ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ユーザーグループへのユーザーの追加と削除](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage_add-remove-users.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddUserToGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/add-user-to-group.html)」を参照してください。 ### `attach-group-policy` 次のコード例は、`attach-group-policy` を使用する方法を示しています。 **AWS CLI** **管理ポリシーを IAM グループにアタッチするには** 次の `attach-group-policy` コマンドは、`ReadOnlyAccess` という名前の AWS 管理ポリシーを `Finance` という名前の IAM グループにアタッチします。 ``` aws iam attach-group-policy \ --policy-arn arn:aws:iam::aws:policy/ReadOnlyAccess \ --group-name Finance ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[管理ポリシーとインラインポリシー](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AttachGroupPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/attach-group-policy.html)」を参照してください。 ### `attach-role-policy` 次のコード例は、`attach-role-policy` を使用する方法を示しています。 **AWS CLI** **管理ポリシーを IAM ロールにアタッチするには** 次の `attach-role-policy` コマンドは、`ReadOnlyAccess` と呼ばれる AWS 管理ポリシーIAM ロールを `ReadOnlyRole` と呼ばれる IAM ロールにアタッチします。 ``` aws iam attach-role-policy \ --policy-arn arn:aws:iam::aws:policy/ReadOnlyAccess \ --role-name ReadOnlyRole ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[管理ポリシーとインラインポリシー](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AttachRolePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/attach-role-policy.html)」を参照してください。 ### `attach-user-policy` 次のコード例は、`attach-user-policy` を使用する方法を示しています。 **AWS CLI** **管理ポリシーを IAM ユーザーにアタッチするには** 次の `attach-user-policy` コマンドは、`AdministratorAccess` という名前の AWS 管理ポリシーを `Alice` という名前の IAM ユーザーにアタッチします。 ``` aws iam attach-user-policy \ --policy-arn arn:aws:iam::aws:policy/AdministratorAccess \ --user-name Alice ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[管理ポリシーとインラインポリシー](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AttachUserPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/attach-user-policy.html)」を参照してください。 ### `change-password` 次のコード例は、`change-password` を使用する方法を示しています。 **AWS CLI** **IAM ユーザーのパスワードを変更するには** IAM ユーザーのパスワードを変更するには、`--cli-input-json` パラメータを使用して、古いパスワードと新しいパスワードを含む JSON ファイルを渡すことをお勧めします。この方法を使用すると、英数字以外の文字を含む強力なパスワードを使用できます。英数字以外の文字を含むパスワードをコマンドラインパラメータとして渡す場合、そのパスワードの使用が難しい場合があります。`--cli-input-json` パラメータを使用するには、まず次の例のように、`change-password` コマンドと `--generate-cli-skeleton` パラメータを組み合わせて使用します。 ``` aws iam change-password \ --generate-cli-skeleton > change-password.json ``` 前のコマンドは change-password.json という名前の JSON ファイルを作成し、これを使用して古いパスワードと新しいパスワードを入力できます。例えば、ファイルは次のようになります。 ``` { "OldPassword": "3s0K_;xh4~8XXI", "NewPassword": "]35d/{pB9Fo9wJ" } ``` 次に、パスワードを変更するには、`change-password` コマンドをもう一度使用します。今度は、JSON ファイルを指定する `--cli-input-json` パラメータを渡します。次の `change-password` コマンドでは、change-password.json という名前の JSON ファイルと共に `--cli-input-json` パラメータを使用します。 ``` aws iam change-password \ --cli-input-json file://change-password.json ``` このコマンドでは何も出力されません。 このコマンドは、IAM ユーザーのみが呼び出すことができます。AWS アカウント (ルート) 認証情報を使用してこのコマンドを呼び出すと、コマンドは `InvalidUserType` エラーを返します。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ユーザーが自分のパスワードを変更する方法](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_user-change-own.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ChangePassword](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/change-password.html)」を参照してください。 ### `create-access-key` 次のコード例は、`create-access-key` を使用する方法を示しています。 **AWS CLI** **IAM ユーザーのアクセスキーを作成するには** 次の `create-access-key` コマンドは、`Bob` という名前の IAM ユーザーのためにアクセスキー (アクセスキー ID とシークレットアクセスキー) を作成します。 ``` aws iam create-access-key \ --user-name Bob ``` 出力: ``` { "AccessKey": { "UserName": "Bob", "Status": "Active", "CreateDate": "2015-03-09T18:39:23.411Z", "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY", "AccessKeyId": "AKIAIOSFODNN7EXAMPLE" } } ``` シークレットアクセスキーを安全な場所に保管します。紛失した場合は回復できないため、新しいアクセスキーを作成する必要があります。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ユーザーのアクセスキーの管理](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateAccessKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-access-key.html)」を参照してください。 ### `create-account-alias` 次のコード例は、`create-account-alias` を使用する方法を示しています。 **AWS CLI** **アカウントエイリアスを作成するには** 次の `create-account-alias` コマンドは、AWS アカウントのエイリアス `examplecorp` を作成します。 ``` aws iam create-account-alias \ --account-alias examplecorp ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[AWS アカウント ID とそのエイリアス](https://docs.aws.amazon.com/IAM/latest/UserGuide/console_account-alias.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[CreateAccountAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-account-alias.html)」を参照してください。 ### `create-group` 次のコード例は、`create-group` を使用する方法を示しています。 **AWS CLI** **IAM グループを作成するには** 次の `create-group` コマンドは、`Admins` という名前の IAM グループを作成します。 ``` aws iam create-group \ --group-name Admins ``` 出力: ``` { "Group": { "Path": "/", "CreateDate": "2015-03-09T20:30:24.940Z", "GroupId": "AIDGPMS9RO4H3FEXAMPLE", "Arn": "arn:aws:iam::123456789012:group/Admins", "GroupName": "Admins" } } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ユーザーグループの作成](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-group.html)」を参照してください。 ### `create-instance-profile` 次のコード例は、`create-instance-profile` を使用する方法を示しています。 **AWS CLI** **インスタンスプロファイルを作成するには** 次の `create-instance-profile` コマンドは、`Webserver` という名前のインスタンスプロファイルを作成します。 ``` aws iam create-instance-profile \ --instance-profile-name Webserver ``` 出力: ``` { "InstanceProfile": { "InstanceProfileId": "AIPAJMBYC7DLSPEXAMPLE", "Roles": [], "CreateDate": "2015-03-09T20:33:19.626Z", "InstanceProfileName": "Webserver", "Path": "/", "Arn": "arn:aws:iam::123456789012:instance-profile/Webserver" } } ``` インスタンスプロファイルにロールを追加するには、`add-role-to-instance-profile` コマンドを使用します。 詳細については、「*AWS IAM ユーザーガイド*」の「[Amazon EC2 インスタンスで実行されるアプリケーションに IAM ロールを使用してアクセス許可を付与する](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateInstanceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-instance-profile.html)」を参照してください。 ### `create-login-profile` 次のコード例は、`create-login-profile` を使用する方法を示しています。 **AWS CLI** **IAM ユーザーのパスワードを作成するには** IAM ユーザーのパスワードを作成するには、`--cli-input-json` パラメータを使用して、パスワードを含む JSON ファイルを渡すことをお勧めします。この方法を使用すると、英数字以外の文字を含む強力なパスワードを作成できます。英数字以外の文字を含むパスワードをコマンドラインパラメータとして渡す場合、そのパスワードの作成が難しい場合があります。 `--cli-input-json` パラメータを使用するには、まず次の例のように、`create-login-profile` コマンドと `--generate-cli-skeleton` パラメータを組み合わせて使用します。 ``` aws iam create-login-profile \ --generate-cli-skeleton > create-login-profile.json ``` 前のコマンドでは、create-login-profile.json という名前の JSON ファイルが作成されます。このファイルを使用して、後続の `create-login-profile` コマンドの情報を入力できます。例えば、次のようになります。 ``` { "UserName": "Bob", "Password": "&1-3a6u:RA0djs", "PasswordResetRequired": true } ``` 次に、IAM ユーザーのパスワードを作成するには、`create-login-profile` コマンドをもう一度使用します。今度は、JSON ファイルを指定する `--cli-input-json` パラメータを渡します。次の `create-login-profile` コマンドでは、create-login-profile.json という名前の JSON ファイルと共に `--cli-input-json` パラメータを使用します。 ``` aws iam create-login-profile \ --cli-input-json file://create-login-profile.json ``` 出力: ``` { "LoginProfile": { "UserName": "Bob", "CreateDate": "2015-03-10T20:55:40.274Z", "PasswordResetRequired": true } } ``` 新しいパスワードがアカウントのパスワードポリシーに違反している場合、コマンドは `PasswordPolicyViolation` エラーを返します。 既にパスワードを持っているユーザーのパスワードを変更するには、`update-login-profile` を使用します。アカウントのパスワードポリシーを設定するには、`update-account-password-policy` コマンドを使用します。 アカウントのパスワードポリシーで許可されている場合、IAM ユーザーは `change-password` コマンドを使用して自分のパスワードを変更できます。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ユーザーのパスワードの管理](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_admin-change-user.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateLoginProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-login-profile.html)」を参照してください。 ### `create-open-id-connect-provider` 次のコード例は、`create-open-id-connect-provider` を使用する方法を示しています。 **AWS CLI** **OpenID Connect (OIDC) プロバイダーを作成するには** OpenID Connect (OIDC) プロバイダーを作成するには、`--cli-input-json` パラメータを使用して、必要なパラメータを含む JSON ファイルを渡すことをお勧めします。OIDC プロバイダーを作成するときは、プロバイダーの URL を渡す必要があり、URL は `https://` で始まる必要があります。コマンドライン環境によっては、コロン (:) とフォワードスラッシュ (/) の文字が特別な意味を持つため、URL をコマンドラインパラメータとして渡すのは難しい場合があります。この `--cli-input-json` パラメータを使用すると、この制限を回避できます。 `--cli-input-json` パラメータを使用するには、まず次の例のように、`create-open-id-connect-provider` コマンドと `--generate-cli-skeleton` パラメータを組み合わせて使用します。 ``` aws iam create-open-id-connect-provider \ --generate-cli-skeleton > create-open-id-connect-provider.json ``` 前のコマンドでは、create-open-id-connect-provider.json という名前の JSON ファイルが作成されます。このファイルを使用して、後続の `create-open-id-connect-provider` コマンドの情報を入力できます。例えば、次のようになります。 ``` { "Url": "https://server.example.com", "ClientIDList": [ "example-application-ID" ], "ThumbprintList": [ "c3768084dfb3d2b68b7897bf5f565da8eEXAMPLE" ] } ``` 次に、OpenID Connect (OIDC) プロバイダーを作成するには、`create-open-id-connect-provider` コマンドをもう一度使用します。今度は、JSON ファイルを指定する `--cli-input-json` パラメータを渡します。次の `create-open-id-connect-provider` コマンドでは、create-open-id-connect-provider.json という名前の JSON ファイルと共に `--cli-input-json` パラメータを使用します。 ``` aws iam create-open-id-connect-provider \ --cli-input-json file://create-open-id-connect-provider.json ``` 出力: ``` { "OpenIDConnectProviderArn": "arn:aws:iam::123456789012:oidc-provider/server.example.com" } ``` OIDC プロバイダーの詳細については、「*AWS IAM ユーザーガイド*」の「[IAM で OpenID Connect (OIDC) ID プロバイダーを作成する](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html)」を参照してください。 OIDC プロバイダーのサムプリントの取得に関する詳細については、「*AWS IAM ユーザーガイド*」の「[OpenID Connect ID プロバイダーのサムプリントを取得する](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc_verify-thumbprint.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateOpenIdConnectProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-open-id-connect-provider.html)」を参照してください。 ### `create-policy-version` 次のコード例は、`create-policy-version` を使用する方法を示しています。 **AWS CLI** **新しいバージョンの管理ポリシーを作成するには** この例では、ARN が `arn:aws:iam::123456789012:policy/MyPolicy` である IAM ポリシーの新しい `v2` バージョンを作成し、それをデフォルトのバージョンにします。 ``` aws iam create-policy-version \ --policy-arn arn:aws:iam::123456789012:policy/MyPolicy \ --policy-document file://NewPolicyVersion.json \ --set-as-default ``` 出力: ``` { "PolicyVersion": { "CreateDate": "2015-06-16T18:56:03.721Z", "VersionId": "v2", "IsDefaultVersion": true } } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ポリシーのバージョニング](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-versioning.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreatePolicyVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-policy-version.html)」を参照してください。 ### `create-policy` 次のコード例は、`create-policy` を使用する方法を示しています。 **AWS CLI** **例 1: カスタマー管理ポリシーを作成するには** 次のコマンドは、`my-policy` という名前でカスタマー管理ポリシーを作成します。このファイル `policy.json` は、現在のフォルダにある JSON ドキュメントで、`amzn-s3-demo-bucket` という名前の Amazon S3 バケット内の `shared` フォルダに対する読み取り専用アクセスを付与します。 ``` aws iam create-policy \ --policy-name my-policy \ --policy-document file://policy.json ``` policy.json の内容: ``` { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "s3:Get*", "s3:List*" ], "Resource": [ "arn:aws:s3:::amzn-s3-demo-bucket/shared/*" ] } ] } ``` 出力: ``` { "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" } } ``` 文字列パラメータの入力としてファイルを使用する方法の詳細については、「*AWS CLI ユーザーガイド*」の「[AWS CLI のパラメータ値を指定する](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html)」を参照してください。 **例 2: 説明を含むカスタマー管理ポリシーを作成するには** 次のコマンドは、変更不可能な説明を使用して `my-policy` という名前のカスタマー管理ポリシーを作成します。 このファイル `policy.json` は、`amzn-s3-demo-bucket` という名前の Amazon S3 バケットに対するすべての Put、List、および Get アクションへのアクセスを付与する、現在のフォルダにある JSON ドキュメントです。 ``` 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" ``` policy.json の内容: ``` { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "s3:ListBucket*", "s3:PutBucket*", "s3:GetBucket*" ], "Resource": [ "arn:aws:s3:::amzn-s3-demo-bucket" ] } ] } ``` 出力: ``` { "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" } } ``` アイデンティティベースのポリシーの詳細については、「*AWS IAM ユーザーガイド*」の「[アイデンティティベースおよびリソースベースのポリシー](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_identity-vs-resource.html)」を参照してください。 **例 3: タグを使用してカスタマー管理ポリシーを作成するには** 次のコマンドは、タグを使用して `my-policy` という名前のカスタマー管理ポリシーを作成します。この例では、次の JSON 形式のタグを持つ `--tags` パラメーターを使用します: `'{"Key": "Department", "Value": "Accounting"}' '{"Key": "Location", "Value": "Seattle"}'`。あるいは、`--tags` パラメーターを次の短縮形式のタグとともに使用することもできます: `'Key=Department,Value=Accounting Key=Location,Value=Seattle'`。 このファイル `policy.json` は、`amzn-s3-demo-bucket` という名前の Amazon S3 バケットに対するすべての Put、List、および Get アクションへのアクセスを付与する、現在のフォルダにある JSON ドキュメントです。 ``` aws iam create-policy \ --policy-name my-policy \ --policy-document file://policy.json \ --tags '{"Key": "Department", "Value": "Accounting"}' '{"Key": "Location", "Value": "Seattle"}' ``` policy.json の内容: ``` { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "s3:ListBucket*", "s3:PutBucket*", "s3:GetBucket*" ], "Resource": [ "arn:aws:s3:::amzn-s3-demo-bucket" ] } ] } ``` 出力: ``` { "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" { ] } } ``` ポリシーのタグ付けの詳細については、「*AWS IAM ユーザーガイド*」の「[カスタマー管理ポリシーのタグ付け](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags_customer-managed-policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreatePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-policy.html)」を参照してください。 ### `create-role` 次のコード例は、`create-role` を使用する方法を示しています。 **AWS CLI** **例 1: IAM ロールを作成するには** 次の `create-role` コマンドは、`Test-Role` という名前のロールを作成し、それに信頼ポリシーをアタッチします。 ``` aws iam create-role \ --role-name Test-Role \ --assume-role-policy-document file://Test-Role-Trust-Policy.json ``` 出力: ``` { "Role": { "AssumeRolePolicyDocument": "", "RoleId": "AKIAIOSFODNN7EXAMPLE", "CreateDate": "2013-06-07T20:43:32.821Z", "RoleName": "Test-Role", "Path": "/", "Arn": "arn:aws:iam::123456789012:role/Test-Role" } } ``` 信頼ポリシーは、*Test-Role-Trust-Policy.json *ファイル内で JSON ドキュメントとして定義されます。(ファイル名と拡張子には意味はありません。) 信頼ポリシーはプリンシパルを指定する必要があります。 アクセス許可ポリシーをロールにアタッチするには、`put-role-policy` コマンドを使用します。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ロールの作成](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html)」を参照してください。 **例 2: 最大セッション期間を指定して IAM ロールを作成するには** 次の `create-role` コマンドは、`Test-Role` という名前のロールを作成し、最大セッション時間を 7,200 秒 (2 時間) に設定します。 ``` aws iam create-role \ --role-name Test-Role \ --assume-role-policy-document file://Test-Role-Trust-Policy.json \ --max-session-duration 7200 ``` 出力: ``` { "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" } ] } } } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[ロールの最大セッション時間の変更 (AWS API)](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-managingrole-editing-api.html#roles-modify_max-session-duration-api)」を参照してください。 **例 3: タグを使用して IAM ロールを作成するには** 次のコマンドは、タグを使用して IAM ロール `Test-Role` を作成します。この例では、次の JSON 形式のタグを持つ `--tags` パラメータフラグを使用します: `'{"Key": "Department", "Value": "Accounting"}' '{"Key": "Location", "Value": "Seattle"}'`。あるいは、`--tags` フラグを次の短縮形式のタグとともに使用することもできます: `'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"}' ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ロールのタグ付け](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags_roles.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[CreateRole](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-role.html)」を参照してください。 ### `create-saml-provider` 次のコード例は、`create-saml-provider` を使用する方法を示しています。 **AWS CLI** **SAML プロバイダーを作成するには** この例では、IAM に `MySAMLProvider` という名前の新しい SAML プロバイダーを作成します。これは、ファイル `SAMLMetaData.xml` 内の SAML メタデータドキュメントによって記述されます。 ``` aws iam create-saml-provider \ --saml-metadata-document file://SAMLMetaData.xml \ --name MySAMLProvider ``` 出力: ``` { "SAMLProviderArn": "arn:aws:iam::123456789012:saml-provider/MySAMLProvider" } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM SAML ID プロバイダーの作成](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateSAMLProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-saml-provider.html)」を参照してください。 ### `create-service-linked-role` 次のコード例は、`create-service-linked-role` を使用する方法を示しています。 **AWS CLI** **サービスにリンクされたロールを作成するには** 次の `create-service-linked-role` の例では、指定された AWS サービスのためにサービスにリンクされたロールを作成し、指定された説明をアタッチします。 ``` aws iam create-service-linked-role \ --aws-service-name lex.amazonaws.com \ --description "My service-linked role to support Lex" ``` 出力: ``` { "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" ] } } ] } } } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[サービスにリンクされたロールの使用](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateServiceLinkedRole](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-service-linked-role.html)」を参照してください。 ### `create-service-specific-credential` 次のコード例は、`create-service-specific-credential` を使用する方法を示しています。 **AWS CLI** **ユーザーのサービス固有の認証情報のセットを作成する** 次の `create-service-specific-credential` の例では、設定されたサービスにのみアクセスできるユーザー名とパスワードを作成します。 ``` aws iam create-service-specific-credential \ --user-name sofia \ --service-name codecommit.amazonaws.com ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[CodeCommit への HTTPS 接続用の Git 認証情報を作成する](https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html#setting-up-gc-iam)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateServiceSpecificCredential](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-service-specific-credential.html)」を参照してください。 ### `create-user` 次のコード例は、`create-user` を使用する方法を示しています。 **AWS CLI** **例 1: IAM ユーザーを作成するには** 次の `create-user` コマンドは、現在のアカウントに `Bob` という名前の IAM ユーザーを作成します。 ``` aws iam create-user \ --user-name Bob ``` 出力: ``` { "User": { "UserName": "Bob", "Path": "/", "CreateDate": "2023-06-08T03:20:41.270Z", "UserId": "AIDAIOSFODNN7EXAMPLE", "Arn": "arn:aws:iam::123456789012:user/Bob" } } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[AWS アカウントでの IAM ユーザーの作成](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html)」を参照してください。 **例 2: 指定したパスに IAM ユーザーを作成するには** 次の `create-user` コマンドは、指定されたパスに `Bob` という名前の IAM ユーザーを作成します。 ``` aws iam create-user \ --user-name Bob \ --path /division_abc/subdivision_xyz/ ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ID](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html)」を参照してください。 **例 3: タグを使用して IAM ユーザーを作成するには** 次の `create-user` コマンドは、タグを使用して `Bob` という名前の IAM ユーザーを作成します。この例では、次の JSON 形式のタグを持つ `--tags` パラメータフラグを使用します: `'{"Key": "Department", "Value": "Accounting"}' '{"Key": "Location", "Value": "Seattle"}'`。あるいは、`--tags` フラグを次の短縮形式のタグとともに使用することもできます: `'Key=Department,Value=Accounting Key=Location,Value=Seattle'`。 ``` aws iam create-user \ --user-name Bob \ --tags '{"Key": "Department", "Value": "Accounting"}' '{"Key": "Location", "Value": "Seattle"}' ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*AWS IAM ユーザーガイド*」で「[IAM ユーザーのタグ付け](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags_users.html)」を参照してください。 **例 3: アクセス許可の境界が設定された IAM ユーザーを作成するには** 次の `create-user` コマンドは、AmazonS3FullAccess のアクセス許可の境界を持つ `Bob` という名前の IAM ユーザーを作成します。 ``` aws iam create-user \ --user-name Bob \ --permissions-boundary arn:aws:iam::aws:policy/AmazonS3FullAccess ``` 出力: ``` { "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" } } } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM エンティティのアクセス許可の境界](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[CreateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-user.html)」を参照してください。 ### `create-virtual-mfa-device` 次のコード例は、`create-virtual-mfa-device` を使用する方法を示しています。 **AWS CLI** **仮想 MFA デバイスを作成するには** この例では、`BobsMFADevice` という新しい仮想 MFA デバイスを作成します。`QRCode.png` というブートストラップ情報を含むファイルを作成し、`C:/` ディレクトリに配置します。この例で使用されているブートストラップメソッドは `QRCodePNG` です。 ``` aws iam create-virtual-mfa-device \ --virtual-mfa-device-name BobsMFADevice \ --outfile C:/QRCode.png \ --bootstrap-method QRCodePNG ``` 出力: ``` { "VirtualMFADevice": { "SerialNumber": "arn:aws:iam::210987654321:mfa/BobsMFADevice" } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[AWS での多要素認証 (MFA) の使用](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateVirtualMfaDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/create-virtual-mfa-device.html)」を参照してください。 ### `deactivate-mfa-device` 次のコード例は、`deactivate-mfa-device` を使用する方法を示しています。 **AWS CLI** **デバイスを無効にするには** このコマンドは、ユーザー `Bob` に関連付けられている ARN `arn:aws:iam::210987654321:mfa/BobsMFADevice` を持つ仮想 MFA デバイスを無効にします。 ``` aws iam deactivate-mfa-device \ --user-name Bob \ --serial-number arn:aws:iam::210987654321:mfa/BobsMFADevice ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[AWS での多要素認証 (MFA) の使用](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeactivateMfaDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/deactivate-mfa-device.html)」を参照してください。 ### `decode-authorization-message` 次のコード例は、`decode-authorization-message` を使用する方法を示しています。 **AWS CLI** **認証失敗メッセージをデコードするには** 次の `decode-authorization-message` の例では、必要なアクセス許可なしでインスタンスを起動しようとすると、EC2 コンソールから返されるメッセージをデコードします。 ``` aws sts decode-authorization-message \ --encoded-message lxzA8VEjEvu-s0TTt3PgYCXik9YakOqsrFJGRZR98xNcyWAxwRq14xIvd-npzbgTevuufCTbjeBAaDARg9cbTK1rJbg3awM33o-Vy3ebPErE2-mWR9hVYdvX-0zKgVOWF9pWjZaJSMqxB-aLXo-I_8TTvBq88x8IFPbMArNdpu0IjxDjzf22PF3SOE3XvIQ-_PEO0aUqHCCcsSrFtvxm6yQD1nbm6VTIVrfa0Bzy8lsoMo7SjIaJ2r5vph6SY5vCCwg6o2JKe3hIHTa8zRrDbZSFMkcXOT6EOPkQXmaBsAC6ciG7Pz1JnEOvuj5NSTlSMljrAXczWuRKAs5GsMYiU8KZXZhokVzdQCUZkS5aVHumZbadu0io53jpgZqhMqvS4fyfK4auK0yKRMtS6JCXPlhkolEs7ZMFA0RVkutqhQqpSDPB5SX5l00lYipWyFK0_AyAx60vumPuVh8P0AzXwdFsT0l4D0m42NFIKxbWXsoJdqaOqVFyFEd0-Xx9AYAAIr6bhcis7C__bZh4dlAAWooHFGKgfoJcWGwgdzgbu9hWyVvKTpeot5hsb8qANYjJRCPXTKpi6PZfdijIkwb6gDMEsJ9qMtr62qP_989mwmtNgnVvBa_ir6oxJxVe_kL9SH1j5nsGDxQFajvPQhxWOHvEQIg_H0bnKWk ``` 出力は、任意の JSON テキストプロセッサで解析できる JSON テキストの 1 行文字列としてフォーマットされます。 ``` { "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/*\"}]}}]}}}" } ``` 詳細については、「*AWS re:Post*」の「[EC2 インスタンスの起動中に 「UnauthorizedOperation」というエラーを受け取った後、認可失敗のメッセージをデコードするには](https://repost.aws/knowledge-center/ec2-not-auth-launch)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DecodeAuthorizationMessage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/decode-authorization-message.html)」を参照してください。 ### `delete-access-key` 次のコード例は、`delete-access-key` を使用する方法を示しています。 **AWS CLI** **IAM ユーザーのためにアクセスキーを削除するには** 次の `delete-access-key` コマンドは、`Bob` という名前の IAM ユーザーのために指定されたアクセスキー (アクセスキー ID とシークレットアクセスキー) を削除します。 ``` aws iam delete-access-key \ --access-key-id AKIDPMS9RO4H3FEXAMPLE \ --user-name Bob ``` このコマンドでは何も出力されません。 IAM ユーザーのためにに定義されたアクセスキーを一覧表示するには、`list-access-keys` コマンドを使用します。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ユーザーのアクセスキーの管理](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAccessKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-access-key.html)」を参照してください。 ### `delete-account-alias` 次のコード例は、`delete-account-alias` を使用する方法を示しています。 **AWS CLI** **アカウントエイリアスを削除するには** 次の `delete-account-alias` コマンドは、現在のアカウントのエイリアス `mycompany` を削除します。 ``` aws iam delete-account-alias \ --account-alias mycompany ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[AWS アカウント ID とそのエイリアス](https://docs.aws.amazon.com/IAM/latest/UserGuide/console_account-alias.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DeleteAccountAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-account-alias.html)」を参照してください。 ### `delete-account-password-policy` 次のコード例は、`delete-account-password-policy` を使用する方法を示しています。 **AWS CLI** **現在のアカウントのパスワードポリシーを削除するには** 次の `delete-account-password-policy` コマンドは、現在のアカウントのパスワードポリシーを削除します。 ``` aws iam delete-account-password-policy ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ユーザーのアカウントパスワードポリシーの設定](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_account-policy.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAccountPasswordPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-account-password-policy.html)」を参照してください。 ### `delete-group-policy` 次のコード例は、`delete-group-policy` を使用する方法を示しています。 **AWS CLI** **IAM グループからポリシーを削除するには** 次の `delete-group-policy` コマンドは、`Admins` という名前のグループから `ExamplePolicy` という名前のポリシーを削除します。 ``` aws iam delete-group-policy \ --group-name Admins \ --policy-name ExamplePolicy ``` このコマンドでは何も出力されません。 グループにアタッチされているポリシーを表示するには、`list-group-policies` コマンドを使用します。 IAM ポリシーの詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ポリシーを管理する](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteGroupPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-group-policy.html)」を参照してください。 ### `delete-group` 次のコード例は、`delete-group` を使用する方法を示しています。 **AWS CLI** **IAM グループを削除するには** 次の `delete-group` コマンドは、`MyTestGroup` という名前の IAM グループを削除します。 ``` aws iam delete-group \ --group-name MyTestGroup ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ユーザーグループの削除](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage_delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-group.html)」を参照してください。 ### `delete-instance-profile` 次のコード例は、`delete-instance-profile` を使用する方法を示しています。 **AWS CLI** **インスタンスプロファイルを削除するには** 次の `delete-instance-profile` コマンドは、`ExampleInstanceProfile` という名前のインスタンスプロファイルを削除します。 ``` aws iam delete-instance-profile \ --instance-profile-name ExampleInstanceProfile ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[インスタンスプロファイルの使用](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteInstanceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-instance-profile.html)」を参照してください。 ### `delete-login-profile` 次のコード例は、`delete-login-profile` を使用する方法を示しています。 **AWS CLI** **IAM ユーザーのパスワードを削除するには** 次の `delete-login-profile` コマンドは、`Bob` という名前の IAM ユーザーのパスワードを削除します。 ``` aws iam delete-login-profile \ --user-name Bob ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ユーザーのパスワードの管理](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_admin-change-user.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteLoginProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-login-profile.html)」を参照してください。 ### `delete-open-id-connect-provider` 次のコード例は、`delete-open-id-connect-provider` を使用する方法を示しています。 **AWS CLI** **IAM OpenID Connect ID プロバイダーを削除するには** この例では、プロバイダー `example.oidcprovider.com` に接続する IAM OIDC プロバイダーを削除します。 ``` aws iam delete-open-id-connect-provider \ --open-id-connect-provider-arn arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM で OpenID Connect (OIDC) ID プロバイダーを作成する](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteOpenIdConnectProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-open-id-connect-provider.html)」を参照してください。 ### `delete-policy-version` 次のコード例は、`delete-policy-version` を使用する方法を示しています。 **AWS CLI** **管理ポリシーのバージョンを削除するには** この例では、`v2` と識別されたバージョンを ARN が `arn:aws:iam::123456789012:policy/MySamplePolicy` であるポリシーから削除します。 ``` aws iam delete-policy-version \ --policy-arn arn:aws:iam::123456789012:policy/MyPolicy \ --version-id v2 ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM のポリシーとアクセス許可](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeletePolicyVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-policy-version.html)」を参照してください。 ### `delete-policy` 次のコード例は、`delete-policy` を使用する方法を示しています。 **AWS CLI** **IAM ポリシーを削除するには** この例では、ARN が `arn:aws:iam::123456789012:policy/MySamplePolicy` であるポリシーを削除します。 ``` aws iam delete-policy \ --policy-arn arn:aws:iam::123456789012:policy/MySamplePolicy ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM のポリシーとアクセス許可](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[DeletePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-policy.html)」を参照してください。 ### `delete-role-permissions-boundary` 次のコード例は、`delete-role-permissions-boundary` を使用する方法を示しています。 **AWS CLI** **IAM ロールからアクセス許可の境界を削除するには** 次の `delete-role-permissions-boundary` の例では、指定した IAM ロールのアクセス許可の境界を削除します。アクセス許可の境界をロールに適用するには、`put-role-permissions-boundary` コマンドを使用します。 ``` aws iam delete-role-permissions-boundary \ --role-name lambda-application-role ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM のポリシーとアクセス許可](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRolePermissionsBoundary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-role-permissions-boundary.html)」を参照してください。 ### `delete-role-policy` 次のコード例は、`delete-role-policy` を使用する方法を示しています。 **AWS CLI** **IAM ロールからポリシーを削除するには** 次の `delete-role-policy` コマンドは、`Test-Role` という名前のロールから `ExamplePolicy` という名前のポリシーを削除します。 ``` aws iam delete-role-policy \ --role-name Test-Role \ --policy-name ExamplePolicy ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[ロールの変更](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage_modify.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRolePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-role-policy.html)」を参照してください。 ### `delete-role` 次のコード例は、`delete-role` を使用する方法を示しています。 **AWS CLI** **IAM ロールを削除するには** 次の `delete-role` コマンドは、`Test-Role` という名前のロールを削除します。 ``` aws iam delete-role \ --role-name Test-Role ``` このコマンドでは何も出力されません。 ロールを削除する前に、インスタンスプロファイルからロールを削除し (`remove-role-from-instance-profile`)、管理ポリシーをデタッチして (`detach-role-policy`)、ロールにアタッチされているインラインポリシーを削除する (`delete-role-policy`) 必要があります。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ロールの作成](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html)」および「[インスタンスプロファイルの使用](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRole](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-role.html)」を参照してください。 ### `delete-saml-provider` 次のコード例は、`delete-saml-provider` を使用する方法を示しています。 **AWS CLI** **SAML プロバイダーを削除するには** この例では、ARN が `arn:aws:iam::123456789012:saml-provider/SAMLADFSProvider` である IAM SAML 2.0 プロバイダーを削除します。 ``` aws iam delete-saml-provider \ --saml-provider-arn arn:aws:iam::123456789012:saml-provider/SAMLADFSProvider ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM SAML ID プロバイダーの作成](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteSAMLProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-saml-provider.html)」を参照してください。 ### `delete-server-certificate` 次のコード例は、`delete-server-certificate` を使用する方法を示しています。 **AWS CLI** **AWS アカウントからサーバー証明書を削除するには** 次の `delete-server-certificate` コマンドは、指定されたサーバー証明書を AWS アカウントから削除します。 ``` aws iam delete-server-certificate \ --server-certificate-name myUpdatedServerCertificate ``` このコマンドでは何も出力されません。 AWS アカウントで使用可能なサーバー証明書を一覧表示するには、`list-server-certificates` コマンドを使用します。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM でのサーバー証明書の管理](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteServerCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-server-certificate.html)」を参照してください。 ### `delete-service-linked-role` 次のコード例は、`delete-service-linked-role` を使用する方法を示しています。 **AWS CLI** **サービスにリンクされたロールを削除するには** 次の `delete-service-linked-role` の例では、不要になったサービスにリンクされたロールのうち、指定されたものを削除します。削除は非同期で実行されます。`get-service-linked-role-deletion-status` コマンドを使用して、削除のステータスをチェックし、削除がいつ完了したかを確認できます。 ``` aws iam delete-service-linked-role \ --role-name AWSServiceRoleForLexBots ``` 出力: ``` { "DeletionTaskId": "task/aws-service-role/lex.amazonaws.com/AWSServiceRoleForLexBots/1a2b3c4d-1234-abcd-7890-abcdeEXAMPLE" } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[サービスにリンクされたロールの使用](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteServiceLinkedRole](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-service-linked-role.html)」を参照してください。 ### `delete-service-specific-credential` 次のコード例は、`delete-service-specific-credential` を使用する方法を示しています。 **AWS CLI** **例 1: リクエストするユーザーのサービス固有の認証情報を削除する** 次の `delete-service-specific-credential` の例では、リクエストを行うユーザーの指定されたサービス固有の認証情報を削除します。`service-specific-credential-id` は、認証情報を作成するときに提供され、`list-service-specific-credentials` コマンドを使用して取得できます。 ``` aws iam delete-service-specific-credential \ --service-specific-credential-id ACCAEXAMPLE123EXAMPLE ``` このコマンドでは何も出力されません。 **例 2: 指定されたユーザーのサービス固有の認証情報を削除する** 次の `delete-service-specific-credential` の例では、指定されたユーザーの指定されたサービス固有の認証情報を削除します。`service-specific-credential-id` は、認証情報を作成するときに提供され、`list-service-specific-credentials` コマンドを使用して取得できます。 ``` aws iam delete-service-specific-credential \ --user-name sofia \ --service-specific-credential-id ACCAEXAMPLE123EXAMPLE ``` このコマンドでは何も出力されません。 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[CodeCommit への HTTPS 接続用の Git 認証情報を作成する](https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html#setting-up-gc-iam)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteServiceSpecificCredential](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-service-specific-credential.html)」を参照してください。 ### `delete-signing-certificate` 次のコード例は、`delete-signing-certificate` を使用する方法を示しています。 **AWS CLI** **IAM ユーザーの署名証明書を削除するには** 次の `delete-signing-certificate` コマンドは、`Bob` という名前の IAM ユーザーの指定された署名証明書を削除します。 ``` aws iam delete-signing-certificate \ --user-name Bob \ --certificate-id TA7SMP42TDN5Z26OBPJE7EXAMPLE ``` このコマンドでは何も出力されません。 署名証明書の ID を取得するには、`list-signing-certificates` コマンドを使用します。 詳細については、「*Amazon EC2 ユーザーガイド*」の「[署名証明書の管理](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/set-up-ami-tools.html#ami-tools-managing-certs)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteSigningCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-signing-certificate.html)」を参照してください。 ### `delete-ssh-public-key` 次のコード例は、`delete-ssh-public-key` を使用する方法を示しています。 **AWS CLI** **IAM ユーザーにアタッチされた SSH パブリックキーを削除するには** 次の `delete-ssh-public-key` のコマンドは、IAM ユーザー `sofia` にアタッチされた指定された SSH パブリックキーを削除します。 ``` aws iam delete-ssh-public-key \ --user-name sofia \ --ssh-public-key-id APKA123456789EXAMPLE ``` このコマンドでは何も出力されません。 詳細については、「*AWSIAM ユーザーガイド*」の「[CodeCommit で SSH キーと SSH を使用する](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_ssh-keys.html#ssh-keys-code-commit)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteSshPublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-ssh-public-key.html)」を参照してください。 ### `delete-user-permissions-boundary` 次のコード例は、`delete-user-permissions-boundary` を使用する方法を示しています。 **AWS CLI** **IAM ユーザーからアクセス許可の境界を削除するには** 次の `delete-user-permissions-boundary` の例では、`intern` という名前の IAM ユーザーにアタッチされているアクセス許可の境界を削除します。アクセス許可の境界をユーザーに適用するには、`put-user-permissions-boundary` コマンドを使用します。 ``` aws iam delete-user-permissions-boundary \ --user-name intern ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM のポリシーとアクセス許可](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteUserPermissionsBoundary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-user-permissions-boundary.html)」を参照してください。 ### `delete-user-policy` 次のコード例は、`delete-user-policy` を使用する方法を示しています。 **AWS CLI** **IAM ユーザーからポリシーを削除するには** 次の `delete-user-policy` コマンドは、指定されたポリシーを `Bob` という名前の IAM ユーザーから削除します。 ``` aws iam delete-user-policy \ --user-name Bob \ --policy-name ExamplePolicy ``` このコマンドでは何も出力されません。 IAM ユーザーのポリシーのリストを取得するには、`list-user-policies` コマンドを使用します。 詳細については、「*AWS IAM ユーザーガイド*」の「[AWS アカウントでの IAM ユーザーの作成](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteUserPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-user-policy.html)」を参照してください。 ### `delete-user` 次のコード例は、`delete-user` を使用する方法を示しています。 **AWS CLI** **IAM ユーザーを削除するには** 次の `delete-user` コマンドは、現在のアカウントから `Bob` という名前の IAM ユーザーを削除します。 ``` aws iam delete-user \ --user-name Bob ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ユーザーの削除](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_manage.html#id_users_deleting)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[DeleteUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-user.html)」を参照してください。 ### `delete-virtual-mfa-device` 次のコード例は、`delete-virtual-mfa-device` を使用する方法を示しています。 **AWS CLI** **仮想 MFA デバイスを削除するには** 次の `delete-virtual-mfa-device` コマンドは、指定した MFA デバイスを現在のアカウントから削除します。 ``` aws iam delete-virtual-mfa-device \ --serial-number arn:aws:iam::123456789012:mfa/MFATest ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[MFA デバイスの無効化](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_disable.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteVirtualMfaDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/delete-virtual-mfa-device.html)」を参照してください。 ### `detach-group-policy` 次のコード例は、`detach-group-policy` を使用する方法を示しています。 **AWS CLI** **グループからポリシーをデタッチするには** この例では、ARN `arn:aws:iam::123456789012:policy/TesterAccessPolicy` を持つ管理ポリシーを `Testers` というグループから削除します。 ``` aws iam detach-group-policy \ --group-name Testers \ --policy-arn arn:aws:iam::123456789012:policy/TesterAccessPolicy ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ユーザーグループの管理](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DetachGroupPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/detach-group-policy.html)」を参照してください。 ### `detach-role-policy` 次のコード例は、`detach-role-policy` を使用する方法を示しています。 **AWS CLI** **ロールからポリシーをデタッチするには** この例では、ARN `arn:aws:iam::123456789012:policy/FederatedTesterAccessPolicy` を持つ管理ポリシーを `FedTesterRole` というロールから削除します。 ``` aws iam detach-role-policy \ --role-name FedTesterRole \ --policy-arn arn:aws:iam::123456789012:policy/FederatedTesterAccessPolicy ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[ロールの変更](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage_modify.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DetachRolePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/detach-role-policy.html)」を参照してください。 ### `detach-user-policy` 次のコード例は、`detach-user-policy` を使用する方法を示しています。 **AWS CLI** **ユーザーからポリシーをデタッチするには** この例では、ARN `arn:aws:iam::123456789012:policy/TesterPolicy` を持つ管理ポリシーをユーザー `Bob` から削除します。 ``` aws iam detach-user-policy \ --user-name Bob \ --policy-arn arn:aws:iam::123456789012:policy/TesterPolicy ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ユーザーのアクセス許可の変更](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_change-permissions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DetachUserPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/detach-user-policy.html)」を参照してください。 ### `disable-organizations-root-credentials-management` 次のコード例は、`disable-organizations-root-credentials-management` を使用する方法を示しています。 **AWS CLI** **組織で RootCredentialsManagement 機能を無効にするには** 次の `disable-organizations-root-credentials-management` コマンドは、組織内のメンバーアカウント全体で特権ルートユーザー認証情報の管理を無効にします。 ``` aws iam disable-organizations-root-credentials-management ``` 出力: ``` { "EnabledFeatures": [ "RootSessions" ] "OrganizationId": "o-aa111bb222" } ``` 詳細については、*AWS IAM ユーザーガイド*の「[メンバーアカウントのルートアクセスを一元化する](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-enable-root-access.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DisableOrganizationsRootCredentialsManagement](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/disable-organizations-root-credentials-management.html)」を参照してください。 ### `disable-organizations-root-sessions` 次のコード例は、`disable-organizations-root-sessions` を使用する方法を示しています。 **AWS CLI** **組織で RootSessions 機能を無効にするには** 次の `disable-organizations-root-sessions` コマンドは、組織内のメンバーアカウント全体で特権タスクのルートユーザーセッションを無効にします。 ``` aws iam disable-organizations-root-sessions ``` 出力: ``` { "EnabledFeatures": [ "RootCredentialsManagement" ] "OrganizationId": "o-aa111bb222" } ``` 詳細については、*AWS IAM ユーザーガイド*の「[メンバーアカウントのルートアクセスを一元化する](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-enable-root-access.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DisableOrganizationsRootSessions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/disable-organizations-root-sessions.html)」を参照してください。 ### `enable-mfa-device` 次のコード例は、`enable-mfa-device` を使用する方法を示しています。 **AWS CLI** **MFA デバイスを有効にするには** `create-virtual-mfa-device` コマンドを使用して新しい仮想 MFA デバイスを作成したら、その MFA デバイスをユーザーに割り当てることができます。次の `enable-mfa-device` の例では、シリアル番号 `arn:aws:iam::210987654321:mfa/BobsMFADevice` を持つ MFA デバイスをユーザー `Bob` に割り当てます。また、このコマンドは、仮想 MFA デバイスからの最初の 2 つのコードを順番に含めることで、デバイスを AWS と同期します。 ``` aws iam enable-mfa-device \ --user-name Bob \ --serial-number arn:aws:iam::210987654321:mfa/BobsMFADevice \ --authentication-code1 123456 \ --authentication-code2 789012 ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[仮想多要素認証 (MFA) デバイスの有効化 (コンソール)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_enable_virtual.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EnableMfaDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/enable-mfa-device.html)」を参照してください。 ### `enable-organizations-root-credentials-management` 次のコード例は、`enable-organizations-root-credentials-management` を使用する方法を示しています。 **AWS CLI** **組織で RootCredentialsManagement 機能を有効にするには** 次の `enable-organizations-root-credentials-management` コマンドは、組織内のメンバーアカウント全体で特権ルートユーザー認証情報の管理を有効にします。 ``` aws iam enable-organizations-root-credentials-management ``` 出力: ``` { "EnabledFeatures": [ "RootCredentialsManagement" ] "OrganizationId": "o-aa111bb222" } ``` 詳細については、*AWS IAM ユーザーガイド*の「[メンバーアカウントのルートアクセスを一元化する](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-enable-root-access.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[EnableOrganizationsRootCredentialsManagement](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/enable-organizations-root-credentials-management.html)」を参照してください。 ### `enable-organizations-root-sessions` 次のコード例は、`enable-organizations-root-sessions` を使用する方法を示しています。 **AWS CLI** **組織で RootSessions 機能を有効にするには** 次の `enable-organizations-root-sessions` コマンドにより、管理アカウントまたは委任管理者が組織内のメンバーアカウントで特権タスクを実行できるようになります。 ``` aws iam enable-organizations-root-sessions ``` 出力: ``` { "EnabledFeatures": [ "RootSessions" ] "OrganizationId": "o-aa111bb222" } ``` 詳細については、*AWS IAM ユーザーガイド*の「[メンバーアカウントのルートアクセスを一元化する](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-enable-root-access.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[EnableOrganizationsRootSessions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/enable-organizations-root-sessions.html)」を参照してください。 ### `generate-credential-report` 次のコード例は、`generate-credential-report` を使用する方法を示しています。 **AWS CLI** **認証情報レポートを生成するには** 次の例では、AWS アカウントについての認証情報レポートの生成を試みます。 ``` aws iam generate-credential-report ``` 出力: ``` { "State": "STARTED", "Description": "No report exists. Starting a new report generation task" } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[AWS アカウントの認証情報レポートの取得](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_getting-report.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GenerateCredentialReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/generate-credential-report.html)」を参照してください。 ### `generate-organizations-access-report` 次のコード例は、`generate-organizations-access-report` を使用する方法を示しています。 **AWS CLI** **例 1: 組織内のルートのアクセスレポートを生成するには** 次の `generate-organizations-access-report` の例では、バックグラウンドジョブを開始して、組織内の指定されたルートのアクセスレポートを作成します。`get-organizations-access-report` コマンドを実行すると、レポートを作成した後に表示できます。 ``` aws iam generate-organizations-access-report \ --entity-path o-4fxmplt198/r-c3xb ``` 出力: ``` { "JobId": "a8b6c06f-aaa4-8xmp-28bc-81da71836359" } ``` **例 2: 組織内のアカウントのアクセスレポートを生成するには** 次の `generate-organizations-access-report` の例では、バックグラウンドジョブを開始して、組織 `o-4fxmplt198` のアカウント ID `123456789012` のアクセスレポートを作成します。`get-organizations-access-report` コマンドを実行すると、レポートを作成した後に表示できます。 ``` aws iam generate-organizations-access-report \ --entity-path o-4fxmplt198/r-c3xb/123456789012 ``` 出力: ``` { "JobId": "14b6c071-75f6-2xmp-fb77-faf6fb4201d2" } ``` **例 3: 組織内の組織単位のアカウントのアクセスレポートを生成するには** 次の `generate-organizations-access-report` の例では、バックグラウンドジョブを開始して、組織 `o-4fxmplt198` の組織単位 `ou-c3xb-lmu7j2yg` にアカウント ID `234567890123` のアクセスレポートを作成します。`get-organizations-access-report` コマンドを実行すると、レポートを作成した後に表示できます。 ``` aws iam generate-organizations-access-report \ --entity-path o-4fxmplt198/r-c3xb/ou-c3xb-lmu7j2yg/234567890123 ``` 出力: ``` { "JobId": "2eb6c2e6-0xmp-ec04-1425-c937916a64af" } ``` 組織内のルートと組織単位の詳細については、`organizations list-roots` コマンドと `organizations list-organizational-units-for-parent` コマンドを使用します。 詳細については、「*AWS IAM ユーザーガイド*」の「[最終アクセス情報を使用した AWS のアクセス許可の調整](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GenerateOrganizationsAccessReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/generate-organizations-access-report.html)」を参照してください。 ### `generate-service-last-accessed-details` 次のコード例は、`generate-service-last-accessed-details` を使用する方法を示しています。 **AWS CLI** **例 1: カスタムポリシーのサービスアクセスレポートを生成するには** 次の `generate-service-last-accessed-details` の例では、バックグラウンドジョブを開始し、`intern-boundary` という名前のカスタムポリシーを使用して IAM ユーザーやその他のエンティティがアクセスしたサービスを一覧表示するレポートを生成します。`get-service-last-accessed-details` コマンドを実行すると、レポートを作成した後に表示できます。 ``` aws iam generate-service-last-accessed-details \ --arn arn:aws:iam::123456789012:policy/intern-boundary ``` 出力: ``` { "JobId": "2eb6c2b8-7b4c-3xmp-3c13-03b72c8cdfdc" } ``` **例 2: AWS 管理 AdministratorAccess ポリシーのサービスアクセスレポートを生成するには** 次の `generate-service-last-accessed-details` の例では、バックグラウンドジョブを開始し、AWS 管理 `AdministratorAccess` ポリシーを使用して IAM ユーザーやその他のエンティティがアクセスしたサービスを一覧表示するレポートを生成します。`get-service-last-accessed-details` コマンドを実行すると、レポートを作成した後に表示できます。 ``` aws iam generate-service-last-accessed-details \ --arn arn:aws:iam::aws:policy/AdministratorAccess ``` 出力: ``` { "JobId": "78b6c2ba-d09e-6xmp-7039-ecde30b26916" } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[最終アクセス情報を使用した AWS のアクセス許可の調整](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GenerateServiceLastAccessedDetails](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/generate-service-last-accessed-details.html)」を参照してください。 ### `get-access-key-last-used` 次のコード例は、`get-access-key-last-used` を使用する方法を示しています。 **AWS CLI** **指定されたアクセスキーの最後の使用時の情報を取得するには** 次の例では、アクセスキー `ABCDEXAMPLE` が最後に使用されたときに関する情報を取得します。 ``` aws iam get-access-key-last-used \ --access-key-id ABCDEXAMPLE ``` 出力: ``` { "UserName": "Bob", "AccessKeyLastUsed": { "Region": "us-east-1", "ServiceName": "iam", "LastUsedDate": "2015-06-16T22:45:00Z" } } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ユーザーのアクセスキーの管理](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAccessKeyLastUsed](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-access-key-last-used.html)」を参照してください。 ### `get-account-authorization-details` 次のコード例は、`get-account-authorization-details` を使用する方法を示しています。 **AWS CLI** **AWS アカウントの IAM ユーザー、グループ、ロール、ポリシーを一覧表示するには** 次の `get-account-authorization-details` コマンドは、AWS アカウント内のすべての IAM ユーザー、グループ、ロール、ポリシーに関する情報を返します。 ``` aws iam get-account-authorization-details ``` 出力: ``` { "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 } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[AWS セキュリティ監査ガイドライン](https://docs.aws.amazon.com/IAM/latest/UserGuide/security-audit-guide.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAccountAuthorizationDetails](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-account-authorization-details.html)」を参照してください。 ### `get-account-password-policy` 次のコード例は、`get-account-password-policy` を使用する方法を示しています。 **AWS CLI** **現在のアカウントのパスワードポリシーを表示するには** 次の `get-account-password-policy` コマンドは、現在のアカウントのパスワードポリシーに関する詳細を表示します。 ``` aws iam get-account-password-policy ``` 出力: ``` { "PasswordPolicy": { "AllowUsersToChangePassword": false, "RequireLowercaseCharacters": false, "RequireUppercaseCharacters": false, "MinimumPasswordLength": 8, "RequireNumbers": true, "RequireSymbols": true } } ``` アカウントのためにパスワードポリシーが定義されていない場合、コマンドは `NoSuchEntity` エラーを返します。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ユーザーのアカウントパスワードポリシーの設定](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_account-policy.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAccountPasswordPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-account-password-policy.html)」を参照してください。 ### `get-account-summary` 次のコード例は、`get-account-summary` を使用する方法を示しています。 **AWS CLI** **現在のアカウントの IAM エンティティの使用状況と IAM クォータに関する情報を取得するには** 次の `get-account-summary` コマンドは、アカウント内の現在の IAM エンティティの使用状況と現在の IAM エンティティのクォータに関する情報を返します。 ``` aws iam get-account-summary ``` 出力: ``` { "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 } } ``` エンティティ制限の詳細については、「*AWS IAM ユーザーガイド*」の「[IAM および AWS STS クォータ](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAccountSummary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-account-summary.html)」を参照してください。 ### `get-context-keys-for-custom-policy` 次のコード例は、`get-context-keys-for-custom-policy` を使用する方法を示しています。 **AWS CLI** **例 1: コマンドラインでパラメータとして指定された 1 つ以上のカスタム JSON ポリシーによって参照されるコンテキストキーを一覧表示するには** 次の `get-context-keys-for-custom-policy` コマンドは、指定された各ポリシーを解析し、それらのポリシーが使用するコンテキストキーを一覧表示します。このコマンドを使用して、ポリシーシミュレータコマンド `simulate-custom-policy` と `simulate-custom-policy` を正常に使用するために指定する必要があるコンテキストキー値を特定します。また、`get-context-keys-for-custom-policy` コマンドを使用して、IAM ユーザーまたはロールに関連付けられたすべてのポリシーで使用されるコンテキストキーのリストを取得することもできます。`file://` で始まるパラメータ値は、ファイルを読み取り、ファイル名自体ではなくその内容をパラメータの値として使用するようにコマンドに指示します。 ``` 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"}}}}' ``` 出力: ``` { "ContextKeyNames": [ "aws:username", "aws:CurrentTime" ] } ``` **例 2: ファイル入力として提供される 1 つ以上のカスタム JSON ポリシーによって参照されるコンテキストキーを一覧表示するには** 次の `get-context-keys-for-custom-policy` コマンドは前の例と同じですが、ポリシーがパラメータとしてではなくファイルで提供される点が異なります。このコマンドは JSON 構造のリストではなく JSON 文字列のリストを想定しているため、ファイルは次のような構造にする必要があります。ただし、1 つにまとめることはできます。 ``` [ "Policy1", "Policy2" ] ``` そのため、例えば、前の例のポリシーを含むファイルは次のようになっている必要があります。ポリシー文字列内に埋め込まれている各二重引用符の前に「バックスラッシュ」を付けてエスケープする必要があります。 ``` [ "{\"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\"}}}}" ] ``` その後、このファイルを次のコマンドに送信できます。 ``` aws iam get-context-keys-for-custom-policy \ --policy-input-list file://policyfile.json ``` 出力: ``` { "ContextKeyNames": [ "aws:username", "aws:CurrentTime" ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ポリシーシミュレーターの使用 (AWS CLI および AWS API)](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html#policies-simulator-using-api)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetContextKeysForCustomPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-context-keys-for-custom-policy.html)」を参照してください。 ### `get-context-keys-for-principal-policy` 次のコード例は、`get-context-keys-for-principal-policy` を使用する方法を示しています。 **AWS CLI** **IAM プリンシパルに関連付けられているすべてのポリシーが参照するコンテキストキーを一覧表示するには** 次の `get-context-keys-for-principal-policy` コマンドは、ユーザー `saanvi` とそのユーザーがメンバーとなっているグループにアタッチされているすべてのポリシーを取得します。次に、このコマンドは各ポリシーを解析し、それらのポリシーで使用されているコンテキストキーを一覧表示します。このコマンドを使用して、`simulate-custom-policy` および `simulate-principal-policy` コマンドを正常に使用するために指定する必要があるコンテキストキー値を特定します。`get-context-keys-for-custom-policy` コマンドを使用して、任意の JSON ポリシーで使用されているコンテキストキーのリストを取得することもできます。 ``` aws iam get-context-keys-for-principal-policy \ --policy-source-arn arn:aws:iam::123456789012:user/saanvi ``` 出力: ``` { "ContextKeyNames": [ "aws:username", "aws:CurrentTime" ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ポリシーシミュレーターの使用 (AWS CLI および AWS API)](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html#policies-simulator-using-api)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetContextKeysForPrincipalPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-context-keys-for-principal-policy.html)」を参照してください。 ### `get-credential-report` 次のコード例は、`get-credential-report` を使用する方法を示しています。 **AWS CLI** **認証情報レポートを取得するには** この例では、返されたレポートを開き、それをテキスト行の配列としてパイプラインに出力します。 ``` aws iam get-credential-report ``` 出力: ``` { "GeneratedTime": "2015-06-17T19:11:50Z", "ReportFormat": "text/csv" } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[AWS アカウントの認証情報レポートの取得](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_getting-report.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetCredentialReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-credential-report.html)」を参照してください。 ### `get-group-policy` 次のコード例は、`get-group-policy` を使用する方法を示しています。 **AWS CLI** **IAM グループにアタッチされたポリシーに関する情報を取得するには** 次の `get-group-policy` コマンドは、`Test-Group` という名前のグループにアタッチされている指定されたポリシーに関する情報を取得します。 ``` aws iam get-group-policy \ --group-name Test-Group \ --policy-name S3-ReadOnly-Policy ``` 出力: ``` { "GroupName": "Test-Group", "PolicyDocument": { "Statement": [ { "Action": [ "s3:Get*", "s3:List*" ], "Resource": "*", "Effect": "Allow" } ] }, "PolicyName": "S3-ReadOnly-Policy" } ``` IAM ポリシーの詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ポリシーを管理する](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetGroupPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-group-policy.html)」を参照してください。 ### `get-group` 次のコード例は、`get-group` を使用する方法を示しています。 **AWS CLI** **IAM グループを取得するには** この例では、IAM グループ `Admins` に関する詳細を返します。 ``` aws iam get-group \ --group-name Admins ``` 出力: ``` { "Group": { "Path": "/", "CreateDate": "2015-06-16T19:41:48Z", "GroupId": "AIDGPMS9RO4H3FEXAMPLE", "Arn": "arn:aws:iam::123456789012:group/Admins", "GroupName": "Admins" }, "Users": [] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ID (ユーザー、ユーザーグループ、ロール)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-group.html)」を参照してください。 ### `get-instance-profile` 次のコード例は、`get-instance-profile` を使用する方法を示しています。 **AWS CLI** **インスタンスプロファイルの情報を取得するには** 次の `get-instance-profile` コマンドは、`ExampleInstanceProfile` という名前のインスタンスプロファイルに関する情報を取得します。 ``` aws iam get-instance-profile \ --instance-profile-name ExampleInstanceProfile ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[インスタンスプロファイルの使用](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetInstanceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-instance-profile.html)」を参照してください。 ### `get-login-profile` 次のコード例は、`get-login-profile` を使用する方法を示しています。 **AWS CLI** **IAM ユーザーのパスワード情報を取得するには** 次の `get-login-profile` コマンドは、`Bob` という名前の IAM ユーザーのパスワードに関する情報を取得します。 ``` aws iam get-login-profile \ --user-name Bob ``` 出力: ``` { "LoginProfile": { "UserName": "Bob", "CreateDate": "2012-09-21T23:03:39Z" } } ``` `get-login-profile` コマンドを使用して、IAM ユーザーがパスワードを持っていることを確認できます。ユーザーのためにパスワードが定義されていない場合、コマンドは `NoSuchEntity` エラーを返します。 このコマンドを使用してパスワードを表示することはできません。パスワードを忘れた場合は、ユーザーのパスワードをリセットできます (`update-login-profile`)。または、ユーザーのログインプロファイルを削除し (`delete-login-profile`)、新しいログインプロファイルを作成することもできます (`create-login-profile`)。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ユーザーのパスワードの管理](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_admin-change-user.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetLoginProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-login-profile.html)」を参照してください。 ### `get-mfa-device` 次のコード例は、`get-mfa-device` を使用する方法を示しています。 **AWS CLI** **FIDO セキュリティキーに関する情報を取得するには** 次の `get-mfa-device` のコマンド例では、指定された FIDO セキュリティキーに関する情報を取得します。 ``` aws iam get-mfa-device \ --serial-number arn:aws:iam::123456789012:u2f/user/alice/fidokeyname-EXAMPLEBN5FHTECLFG7EXAMPLE ``` 出力: ``` { "UserName": "alice", "SerialNumber": "arn:aws:iam::123456789012:u2f/user/alice/fidokeyname-EXAMPLEBN5FHTECLFG7EXAMPLE", "EnableDate": "2023-09-19T01:49:18+00:00", "Certifications": { "FIDO": "L1" } } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[AWS での多要素認証 (MFA) の使用](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetMfaDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-mfa-device.html)」を参照してください。 ### `get-open-id-connect-provider` 次のコード例は、`get-open-id-connect-provider` を使用する方法を示しています。 **AWS CLI** **指定した OpenID Connect プロバイダーに関する情報を返すには** この例では、ARN が `arn:aws:iam::123456789012:oidc-provider/server.example.com` である OpenID Connect プロバイダーに関する詳細を返します。 ``` aws iam get-open-id-connect-provider \ --open-id-connect-provider-arn arn:aws:iam::123456789012:oidc-provider/server.example.com ``` 出力: ``` { "Url": "server.example.com" "CreateDate": "2015-06-16T19:41:48Z", "ThumbprintList": [ "12345abcdefghijk67890lmnopqrst987example" ], "ClientIDList": [ "example-application-ID" ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM で OpenID Connect (OIDC) ID プロバイダーを作成する](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetOpenIdConnectProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-open-id-connect-provider.html)」を参照してください。 ### `get-organizations-access-report` 次のコード例は、`get-organizations-access-report` を使用する方法を示しています。 **AWS CLI** **アクセスレポートを取得するには** 次の `get-organizations-access-report` の例では、以前に生成された AWS Organizations エンティティのアクセスレポートを表示します。レポートを生成するには、`generate-organizations-access-report` コマンドを使用します。 ``` aws iam get-organizations-access-report \ --job-id a8b6c06f-aaa4-8xmp-28bc-81da71836359 ``` 出力: ``` { "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 }, ... } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[最終アクセス情報を使用した AWS のアクセス許可の調整](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetOrganizationsAccessReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-organizations-access-report.html)」を参照してください。 ### `get-policy-version` 次のコード例は、`get-policy-version` を使用する方法を示しています。 **AWS CLI** **指定された管理ポリシーの指定されたバージョンに関する情報を取得するには** この例では、ARN が `arn:aws:iam::123456789012:policy/MyManagedPolicy` であるポリシーの v2 バージョンのポリシードキュメントを返します。 ``` aws iam get-policy-version \ --policy-arn arn:aws:iam::123456789012:policy/MyPolicy \ --version-id v2 ``` 出力: ``` { "PolicyVersion": { "Document": { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "iam:*", "Resource": "*" } ] }, "VersionId": "v2", "IsDefaultVersion": true, "CreateDate": "2023-04-11T00:22:54+00:00" } } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM のポリシーとアクセス許可](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPolicyVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-policy-version.html)」を参照してください。 ### `get-policy` 次のコード例は、`get-policy` を使用する方法を示しています。 **AWS CLI** **指定した管理ポリシーに関する情報を取得するには** この例では、ARN が `arn:aws:iam::123456789012:policy/MySamplePolicy` である管理ポリシーに関する詳細を返します。 ``` aws iam get-policy \ --policy-arn arn:aws:iam::123456789012:policy/MySamplePolicy ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM のポリシーとアクセス許可](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-policy.html)」を参照してください。 ### `get-role-policy` 次のコード例は、`get-role-policy` を使用する方法を示しています。 **AWS CLI** **IAM ロールにアタッチされたポリシーに関する情報を取得するには** 次の `get-role-policy` コマンドは、`Test-Role` という名前のロールにアタッチされている指定されたポリシーに関する情報を取得します。 ``` aws iam get-role-policy \ --role-name Test-Role \ --policy-name ExamplePolicy ``` 出力: ``` { "RoleName": "Test-Role", "PolicyDocument": { "Statement": [ { "Action": [ "s3:ListBucket", "s3:Put*", "s3:Get*", "s3:*MultipartUpload*" ], "Resource": "*", "Effect": "Allow", "Sid": "1" } ] } "PolicyName": "ExamplePolicy" } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ロールの作成](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRolePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-role-policy.html)」を参照してください。 ### `get-role` 次のコード例は、`get-role` を使用する方法を示しています。 **AWS CLI** **IAM ロールに関する情報を取得するには** 次の `get-role` コマンドは、`Test-Role` という名前のロールに関する情報を取得します。 ``` aws iam get-role \ --role-name Test-Role ``` 出力: ``` { "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" } } ``` このコマンドは、ロールにアタッチされている信頼ポリシーを表示します。ロールにアタッチされているアクセス許可ポリシーを一覧表示するには、`list-role-policies` コマンドを使用します。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ロールの作成](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRole](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-role.html)」を参照してください。 ### `get-saml-provider` 次のコード例は、`get-saml-provider` を使用する方法を示しています。 **AWS CLI** **SAML プロバイダーのメタドキュメントを取得するには** この例では、ARM が `arn:aws:iam::123456789012:saml-provider/SAMLADFS` である SAML 2.0 プロバイダーに関する詳細を取得します。レスポンスには、AWS SAML プロバイダーエンティティを作成するために ID プロバイダーから取得したメタデータドキュメントと、作成日と有効期限が含まれます。 ``` aws iam get-saml-provider \ --saml-provider-arn arn:aws:iam::123456789012:saml-provider/SAMLADFS ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM SAML ID プロバイダーの作成](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetSamlProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-saml-provider.html)」を参照してください。 ### `get-server-certificate` 次のコード例は、`get-server-certificate` を使用する方法を示しています。 **AWS CLI** **AWS アカウントのサーバー証明書の詳細を取得するには** 次の `get-server-certificate` コマンドは、AWS アカウント内の指定されたサーバー証明書に関するすべての詳細を取得します。 ``` aws iam get-server-certificate \ --server-certificate-name myUpdatedServerCertificate ``` 出力: ``` { "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-----" } } ``` AWS アカウントで使用可能なサーバー証明書を一覧表示するには、`list-server-certificates` コマンドを使用します。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM でのサーバー証明書の管理](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetServerCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-server-certificate.html)」を参照してください。 ### `get-service-last-accessed-details-with-entities` 次のコード例は、`get-service-last-accessed-details-with-entities` を使用する方法を示しています。 **AWS CLI** **サービスの詳細を含むサービスアクセスレポートを取得するには** 次の `get-service-last-accessed-details-with-entities` の例では、指定されたサービスにアクセスした IAM ユーザーやその他のエンティティに関する詳細を含むレポートを取得します。レポートを生成するには、`generate-service-last-accessed-details` コマンドを使用します。名前空間でアクセスされるサービスのリストを取得するには、`get-service-last-accessed-details` を使用します。 ``` aws iam get-service-last-accessed-details-with-entities \ --job-id 78b6c2ba-d09e-6xmp-7039-ecde30b26916 \ --service-namespace lambda ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[最終アクセス情報を使用した AWS のアクセス許可の調整](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetServiceLastAccessedDetailsWithEntities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-service-last-accessed-details-with-entities.html)」を参照してください。 ### `get-service-last-accessed-details` 次のコード例は、`get-service-last-accessed-details` を使用する方法を示しています。 **AWS CLI** **サービスアクセスレポートを取得するには** 次の `get-service-last-accessed-details` の例では、IAM エンティティがアクセスしたサービスを一覧表示する、以前に生成したレポートを取得します。レポートを生成するには、`generate-service-last-accessed-details` コマンドを使用します。 ``` aws iam get-service-last-accessed-details \ --job-id 2eb6c2b8-7b4c-3xmp-3c13-03b72c8cdfdc ``` 出力: ``` { "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 }, ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[最終アクセス情報を使用した AWS のアクセス許可の調整](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetServiceLastAccessedDetails](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-service-last-accessed-details.html)」を参照してください。 ### `get-service-linked-role-deletion-status` 次のコード例は、`get-service-linked-role-deletion-status` を使用する方法を示しています。 **AWS CLI** **サービスにリンクされたロールの削除リクエストのステータスを確認するには** 次の `get-service-linked-role-deletion-status` の例では、サービスにリンクされたロールを削除するという以前のリクエストのステータスが表示されます。削除オペレーションは非同期で実行されます。リクエストを実行すると、このコマンドのパラメータとして指定した `DeletionTaskId` の値を取得します。 ``` aws iam get-service-linked-role-deletion-status \ --deletion-task-id task/aws-service-role/lex.amazonaws.com/AWSServiceRoleForLexBots/1a2b3c4d-1234-abcd-7890-abcdeEXAMPLE ``` 出力: ``` { "Status": "SUCCEEDED" } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[サービスにリンクされたロールの使用](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetServiceLinkedRoleDeletionStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-service-linked-role-deletion-status.html)」を参照してください。 ### `get-ssh-public-key` 次のコード例は、`get-ssh-public-key` を使用する方法を示しています。 **AWS CLI** **例 1: SSH エンコード形式で IAM ユーザーに添付された SSH パブリックキーを取得するには** 次の `get-ssh-public-key` コマンドは、IAM ユーザー `sofia` から指定された SSH パブリックキーを取得します。出力は SSH エンコーディングです。 ``` aws iam get-ssh-public-key \ --user-name sofia \ --ssh-public-key-id APKA123456789EXAMPLE \ --encoding SSH ``` 出力: ``` { "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" } } ``` **例 2: PEM エンコード形式で IAM ユーザーに添付された SSH パブリックキーを取得するには** 次の `get-ssh-public-key` コマンドは、IAM ユーザー `sofia` から指定された SSH パブリックキーを取得します。出力は PEM エンコーディングです。 ``` aws iam get-ssh-public-key \ --user-name sofia \ --ssh-public-key-id APKA123456789EXAMPLE \ --encoding PEM ``` 出力: ``` { "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" } } ``` 詳細については、「*AWSIAM ユーザーガイド*」の「[CodeCommit で SSH キーと SSH を使用する](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_ssh-keys.html#ssh-keys-code-commit)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetSshPublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-ssh-public-key.html)」を参照してください。 ### `get-user-policy` 次のコード例は、`get-user-policy` を使用する方法を示しています。 **AWS CLI** **IAM ユーザーのポリシーの詳細を一覧表示するには** 次の `get-user-policy` コマンドは、`Bob` という名前の IAM ユーザーにアタッチされている指定されたポリシーの詳細を一覧表示します。 ``` aws iam get-user-policy \ --user-name Bob \ --policy-name ExamplePolicy ``` 出力: ``` { "UserName": "Bob", "PolicyName": "ExamplePolicy", "PolicyDocument": { "Version":"2012-10-17", "Statement": [ { "Action": "*", "Resource": "*", "Effect": "Allow" } ] } } ``` IAM ユーザーのポリシーのリストを取得するには、`list-user-policies` コマンドを使用します。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM のポリシーとアクセス許可](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetUserPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-user-policy.html)」を参照してください。 ### `get-user` 次のコード例は、`get-user` を使用する方法を示しています。 **AWS CLI** **IAM ユーザーに関する情報を取得するには** 次の `get-user` コマンドは、`Paulo` という名前の IAM ユーザーに関する情報を取得します。 ``` aws iam get-user \ --user-name Paulo ``` 出力: ``` { "User": { "UserName": "Paulo", "Path": "/", "CreateDate": "2019-09-21T23:03:13Z", "UserId": "AIDA123456789EXAMPLE", "Arn": "arn:aws:iam::123456789012:user/Paulo" } } ``` IAM ポリシーの詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ユーザーを管理する](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_manage.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/get-user.html)」を参照してください。 ### `list-access-keys` 次のコード例は、`list-access-keys` を使用する方法を示しています。 **AWS CLI** **IAM ユーザーのアクセスキー ID を一覧表示するには** 次の `list-access-keys` コマンドは、`Bob` という名前の IAM ユーザーのアクセスキー ID を一覧表示します。 ``` aws iam list-access-keys \ --user-name Bob ``` 出力: ``` { "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" } ] } ``` IAM ユーザーのシークレットアクセスキーを一覧表示することはできません。シークレットアクセスキーを紛失した場合は、`create-access-keys` コマンドを使用して新しいアクセスキーを作成する必要があります。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ユーザーのアクセスキーの管理](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAccessKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-access-keys.html)」を参照してください。 ### `list-account-aliases` 次のコード例は、`list-account-aliases` を使用する方法を示しています。 **AWS CLI** **アカウントエイリアスを一覧表示するには** 次の `list-account-aliases` コマンドは、現在のアカウントのエイリアスを一覧表示します。 ``` aws iam list-account-aliases ``` 出力: ``` { "AccountAliases": [ "mycompany" ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[AWS アカウント ID とそのエイリアス](https://docs.aws.amazon.com/IAM/latest/UserGuide/console_account-alias.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAccountAliases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-account-aliases.html)」を参照してください。 ### `list-attached-group-policies` 次のコード例は、`list-attached-group-policies` を使用する方法を示しています。 **AWS CLI** **指定されたグループにアタッチされているすべての管理ポリシーを一覧表示するには** この例では、AWS アカウントの `Admins` という名前の IAM グループにアタッチされている管理ポリシーの名前と ARN を返します。 ``` aws iam list-attached-group-policies \ --group-name Admins ``` 出力: ``` { "AttachedPolicies": [ { "PolicyName": "AdministratorAccess", "PolicyArn": "arn:aws:iam::aws:policy/AdministratorAccess" }, { "PolicyName": "SecurityAudit", "PolicyArn": "arn:aws:iam::aws:policy/SecurityAudit" } ], "IsTruncated": false } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM のポリシーとアクセス許可](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAttachedGroupPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-attached-group-policies.html)」を参照してください。 ### `list-attached-role-policies` 次のコード例は、`list-attached-role-policies` を使用する方法を示しています。 **AWS CLI** **指定された IAM ロールにアタッチされている管理ポリシーを一覧表示するには** このコマンドは、AWS アカウントの `SecurityAuditRole` という名前の IAM ロールにアタッチされている管理ポリシーの名前と ARN を返します。 ``` aws iam list-attached-role-policies \ --role-name SecurityAuditRole ``` 出力: ``` { "AttachedPolicies": [ { "PolicyName": "SecurityAudit", "PolicyArn": "arn:aws:iam::aws:policy/SecurityAudit" } ], "IsTruncated": false } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM のポリシーとアクセス許可](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAttachedRolePolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-attached-role-policies.html)」を参照してください。 ### `list-attached-user-policies` 次のコード例は、`list-attached-user-policies` を使用する方法を示しています。 **AWS CLI** **指定されたユーザーにアタッチされているすべての管理ポリシーを一覧表示するには** このコマンドは、AWS アカウントの `Bob` という名前の IAM ユーザーの管理ポリシーの名前と ARN を返します。 ``` aws iam list-attached-user-policies \ --user-name Bob ``` 出力: ``` { "AttachedPolicies": [ { "PolicyName": "AdministratorAccess", "PolicyArn": "arn:aws:iam::aws:policy/AdministratorAccess" }, { "PolicyName": "SecurityAudit", "PolicyArn": "arn:aws:iam::aws:policy/SecurityAudit" } ], "IsTruncated": false } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM のポリシーとアクセス許可](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAttachedUserPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-attached-user-policies.html)」を参照してください。 ### `list-entities-for-policy` 次のコード例は、`list-entities-for-policy` を使用する方法を示しています。 **AWS CLI** **指定された管理ポリシーがアタッチされているすべてのユーザー、グループ、ロールを一覧表示するには** この例では、ポリシー `arn:aws:iam::123456789012:policy/TestPolicy` がアタッチされている IAM グループ、ロール、ユーザーのリストを返します。 ``` aws iam list-entities-for-policy \ --policy-arn arn:aws:iam::123456789012:policy/TestPolicy ``` 出力: ``` { "PolicyGroups": [ { "GroupName": "Admins", "GroupId": "AGPACKCEVSQ6C2EXAMPLE" } ], "PolicyUsers": [ { "UserName": "Alice", "UserId": "AIDACKCEVSQ6C2EXAMPLE" } ], "PolicyRoles": [ { "RoleName": "DevRole", "RoleId": "AROADBQP57FF2AEXAMPLE" } ], "IsTruncated": false } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM のポリシーとアクセス許可](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListEntitiesForPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-entities-for-policy.html)」を参照してください。 ### `list-group-policies` 次のコード例は、`list-group-policies` を使用する方法を示しています。 **AWS CLI** **指定されたグループにアタッチされているすべてのインラインポリシーを一覧表示するには** 次の `list-group-policies` コマンドは、現在のアカウントの `Admins` という名前の IAM グループにアタッチされているインラインポリシーの名前を一覧表示します。 ``` aws iam list-group-policies \ --group-name Admins ``` 出力: ``` { "PolicyNames": [ "AdminRoot", "ExamplePolicy" ] } ``` IAM ポリシーの詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ポリシーを管理する](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListGroupPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-group-policies.html)」を参照してください。 ### `list-groups-for-user` 次のコード例は、`list-groups-for-user` を使用する方法を示しています。 **AWS CLI** **IAM ユーザーが属する IAM グループを一覧表示するには** 次の `list-groups-for-user` コマンドは、`Bob` という IAM ユーザーが属するグループを表示します。 ``` aws iam list-groups-for-user \ --user-name Bob ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ユーザーグループの管理](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListGroupsForUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-groups-for-user.html)」を参照してください。 ### `list-groups` 次のコード例は、`list-groups` を使用する方法を示しています。 **AWS CLI** **現在のアカウントの IAM グループを一覧表示するには** 次の `list-groups` コマンドは、現在のアカウントの IAM グループを一覧表示します。 ``` aws iam list-groups ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ユーザーグループの管理](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-groups.html)」を参照してください。 ### `list-instance-profile-tags` 次のコード例は、`list-instance-profile-tags` を使用する方法を示しています。 **AWS CLI** **インスタンスプロファイルにアタッチされているタグを一覧表示するには** 次の `list-instance-profile-tags` コマンドは、指定されたインスタンスプロファイルに関連付けられているタグのリストを取得します。 ``` aws iam list-instance-profile-tags \ --instance-profile-name deployment-role ``` 出力: ``` { "Tags": [ { "Key": "DeptID", "Value": "123456" }, { "Key": "Department", "Value": "Accounting" } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM リソースのタグ付け](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListInstanceProfileTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-instance-profile-tags.html)」を参照してください。 ### `list-instance-profiles-for-role` 次のコード例は、`list-instance-profiles-for-role` を使用する方法を示しています。 **AWS CLI** **IAM ロールのインスタンスプロファイルを一覧表示するには** 次の `list-instance-profiles-for-role` コマンドは、ロール `Test-Role` に関連付けられているインスタンスプロファイルを一覧表示します。 ``` aws iam list-instance-profiles-for-role \ --role-name Test-Role ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[インスタンスプロファイルの使用](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListInstanceProfilesForRole](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-instance-profiles-for-role.html)」を参照してください。 ### `list-instance-profiles` 次のコード例は、`list-instance-profiles` を使用する方法を示しています。 **AWS CLI** **アカウントのインスタンスプロファイルを一覧表示するには** 次の `list-instance-profiles` コマンドは、現在のアカウントに関連付けられているインスタンスプロファイルを一覧表示します。 ``` aws iam list-instance-profiles ``` 出力: ``` { "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" } ] } } ] } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[インスタンスプロファイルの使用](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListInstanceProfiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-instance-profiles.html)」を参照してください。 ### `list-mfa-device-tags` 次のコード例は、`list-mfa-device-tags` を使用する方法を示しています。 **AWS CLI** **MFA デバイスにアタッチされたタグを一覧表示するには** 次の `list-mfa-device-tags` コマンドは、指定された MFA デバイスに関連付けられているタグのリストを取得します。 ``` aws iam list-mfa-device-tags \ --serial-number arn:aws:iam::123456789012:mfa/alice ``` 出力: ``` { "Tags": [ { "Key": "DeptID", "Value": "123456" }, { "Key": "Department", "Value": "Accounting" } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM リソースのタグ付け](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListMfaDeviceTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-mfa-device-tags.html)」を参照してください。 ### `list-mfa-devices` 次のコード例は、`list-mfa-devices` を使用する方法を示しています。 **AWS CLI** **指定したユーザーのすべての MFA デバイスを一覧表示するには** この例では、IAM ユーザー `Bob` に割り当てられた MFA デバイスに関する詳細を返します。 ``` aws iam list-mfa-devices \ --user-name Bob ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[AWS での多要素認証 (MFA) の使用](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListMfaDevices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-mfa-devices.html)」を参照してください。 ### `list-open-id-connect-provider-tags` 次のコード例は、`list-open-id-connect-provider-tags` を使用する方法を示しています。 **AWS CLI** **OpenID Connect (OIDC) 互換 ID プロバイダーにアタッチされたタグを一覧表示するには** 次の `list-open-id-connect-provider-tags` コマンドは、指定された OIDC ID プロバイダーに関連付けられているタグのリストを取得します。 ``` aws iam list-open-id-connect-provider-tags \ --open-id-connect-provider-arn arn:aws:iam::123456789012:oidc-provider/server.example.com ``` 出力: ``` { "Tags": [ { "Key": "DeptID", "Value": "123456" }, { "Key": "Department", "Value": "Accounting" } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM リソースのタグ付け](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListOpenIdConnectProviderTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-open-id-connect-provider-tags.html)」を参照してください。 ### `list-open-id-connect-providers` 次のコード例は、`list-open-id-connect-providers` を使用する方法を示しています。 **AWS CLI** **AWS アカウント内の OpenID Connect プロバイダーに関する情報を一覧表示するには** この例では、現在の AWS アカウントで定義されているすべての OpenID Connect プロバイダーの ARN のリストを返します。 ``` aws iam list-open-id-connect-providers ``` 出力: ``` { "OpenIDConnectProviderList": [ { "Arn": "arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com" } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM で OpenID Connect (OIDC) ID プロバイダーを作成する](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListOpenIdConnectProviders](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-open-id-connect-providers.html)」を参照してください。 ### `list-organizations-features` 次のコード例は、`list-organizations-features` を使用する方法を示しています。 **AWS CLI** **組織で有効になっている一元化されたルートアクセス機能を一覧表示するには** 次の `list-organizations-features` コマンドは、組織で有効になっている一元化されたルートアクセス機能を一覧表示します。 ``` aws iam list-organizations-features ``` 出力: ``` { "EnabledFeatures": [ "RootCredentialsManagement", "RootSessions" ] "OrganizationId": "o-aa111bb222" } ``` 詳細については、*AWS IAM ユーザーガイド*の「[メンバーアカウントのルートアクセスを一元管理する](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_root-user.html#id_root-user-access-management)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[ListOrganizationsFeatures](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-organizations-features.html)」を参照してください。 ### `list-policies-granting-service-access` 次のコード例は、`list-policies-granting-service-access` を使用する方法を示しています。 **AWS CLI** **指定されたサービスへのプリンシパルアクセスを許可するポリシーを一覧表示するには** 次の `list-policies-granting-service-access` の例では、IAM ユーザー `sofia` に AWS CodeCommit サービスへのアクセスを許可するポリシーのリストを取得します。 ``` aws iam list-policies-granting-service-access \ --arn arn:aws:iam::123456789012:user/sofia \ --service-namespaces codecommit ``` 出力: ``` { "PoliciesGrantingServiceAccess": [ { "ServiceNamespace": "codecommit", "Policies": [ { "PolicyName": "Grant-Sofia-Access-To-CodeCommit", "PolicyType": "INLINE", "EntityType": "USER", "EntityName": "sofia" } ] } ], "IsTruncated": false } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[CodeCommit での IAM の使用: Git 認証情報、SSH キー、および AWS アクセスキー](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_ssh-keys.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPoliciesGrantingServiceAccess](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-policies-granting-service-access.html)」を参照してください。 ### `list-policies` 次のコード例は、`list-policies` を使用する方法を示しています。 **AWS CLI** **AWS アカウントで使用できる管理ポリシーを一覧表示するには** この例では、現在の AWS アカウントで使用可能な最初の 2 つの管理ポリシーのコレクションを返します。 ``` aws iam list-policies \ --max-items 3 ``` 出力: ``` { "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==" } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM のポリシーとアクセス許可](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html)」を参照してください。 + API の詳細については、「AWS CLI Command Reference」の「[ListPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-policies.html)」を参照してください。** ### `list-policy-tags` 次のコード例は、`list-policy-tags` を使用する方法を示しています。 **AWS CLI** **マネージドポリシーにアタッチされたタグを一覧表示するには** 次の `list-policy-tags` コマンドは、指定されたマネージドポリシーに関連付けられているタグのリストを取得します。 ``` aws iam list-policy-tags \ --policy-arn arn:aws:iam::123456789012:policy/billing-access ``` 出力: ``` { "Tags": [ { "Key": "DeptID", "Value": "123456" }, { "Key": "Department", "Value": "Accounting" } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM リソースのタグ付け](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPolicyTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-policy-tags.html)」を参照してください。 ### `list-policy-versions` 次のコード例は、`list-policy-versions` を使用する方法を示しています。 **AWS CLI** **指定された管理ポリシーのバージョンに関する情報を一覧表示するには** この例では、ARN が `arn:aws:iam::123456789012:policy/MySamplePolicy` であるポリシーの使用可能なバージョンのリストを返します。 ``` aws iam list-policy-versions \ --policy-arn arn:aws:iam::123456789012:policy/MySamplePolicy ``` 出力: ``` { "IsTruncated": false, "Versions": [ { "VersionId": "v2", "IsDefaultVersion": true, "CreateDate": "2015-06-02T23:19:44Z" }, { "VersionId": "v1", "IsDefaultVersion": false, "CreateDate": "2015-06-02T22:30:47Z" } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM のポリシーとアクセス許可](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPolicyVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-policy-versions.html)」を参照してください。 ### `list-role-policies` 次のコード例は、`list-role-policies` を使用する方法を示しています。 **AWS CLI** **IAM ロールにアタッチされているポリシーを一覧表示するには** 次の `list-role-policies` コマンドは、指定された IAM ロールのアクセス許可ポリシーの名前を一覧表示します。 ``` aws iam list-role-policies \ --role-name Test-Role ``` 出力: ``` { "PolicyNames": [ "ExamplePolicy" ] } ``` ロールにアタッチされている信頼ポリシーを表示するには、`get-role` コマンドを使用します。アクセス許可ポリシーの詳細を表示するには、`get-role-policy` コマンドを使用します。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ロールの作成](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRolePolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-role-policies.html)」を参照してください。 ### `list-role-tags` 次のコード例は、`list-role-tags` を使用する方法を示しています。 **AWS CLI** **ロールにアタッチされたタグを一覧表示するには** 次の `list-role-tags` コマンドは、指定されたロールに関連付けられているタグのリストを取得します。 ``` aws iam list-role-tags \ --role-name production-role ``` 出力: ``` { "Tags": [ { "Key": "Department", "Value": "Accounting" }, { "Key": "DeptID", "Value": "12345" } ], "IsTruncated": false } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM リソースのタグ付け](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRoleTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-role-tags.html)」を参照してください。 ### `list-roles` 次のコード例は、`list-roles` を使用する方法を示しています。 **AWS CLI** **現在のアカウントの IAM ロールを一覧表示するには** 次の `list-roles` コマンドは、現在のアカウントの IAM ロールを一覧表示します。 ``` aws iam list-roles ``` 出力: ``` { "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 } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ロールの作成](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRoles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-roles.html)」を参照してください。 ### `list-saml-provider-tags` 次のコード例は、`list-saml-provider-tags` を使用する方法を示しています。 **AWS CLI** **SAML プロバイダーにアタッチされたタグを一覧表示するには** 次の `list-saml-provider-tags` コマンドは、指定された SAML プロバイダーに関連付けられているタグのリストを取得します。 ``` aws iam list-saml-provider-tags \ --saml-provider-arn arn:aws:iam::123456789012:saml-provider/ADFS ``` 出力: ``` { "Tags": [ { "Key": "DeptID", "Value": "123456" }, { "Key": "Department", "Value": "Accounting" } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM リソースのタグ付け](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListSamlProviderTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-saml-provider-tags.html)」を参照してください。 ### `list-saml-providers` 次のコード例は、`list-saml-providers` を使用する方法を示しています。 **AWS CLI** **AWS アカウント内の SAML プロバイダーを一覧表示するには** この例では、現在の AWS アカウントで作成された SAML 2.0 プロバイダーのリストを取得します。 ``` aws iam list-saml-providers ``` 出力: ``` { "SAMLProviderList": [ { "Arn": "arn:aws:iam::123456789012:saml-provider/SAML-ADFS", "ValidUntil": "2015-06-05T22:45:14Z", "CreateDate": "2015-06-05T22:45:14Z" } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM SAML ID プロバイダーの作成](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListSAMLProviders](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-saml-providers.html)」を参照してください。 ### `list-server-certificate-tags` 次のコード例は、`list-server-certificate-tags` を使用する方法を示しています。 **AWS CLI** **サーバー証明書にアタッチされているタグを一覧表示するには** 次の `list-server-certificate-tags` コマンドは、指定されたサーバー証明書に関連付けられているタグを取得します。 ``` aws iam list-server-certificate-tags \ --server-certificate-name ExampleCertificate ``` 出力: ``` { "Tags": [ { "Key": "DeptID", "Value": "123456" }, { "Key": "Department", "Value": "Accounting" } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM リソースのタグ付け](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListServerCertificateTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-server-certificate-tags.html)」を参照してください。 ### `list-server-certificates` 次のコード例は、`list-server-certificates` を使用する方法を示しています。 **AWS CLI** **AWS アカウント内のサーバー証明書を一覧表示するには** 次の `list-server-certificates` コマンドは、AWS アカウントに保存され、当該アカウントで使用できるすべてのサーバー証明書を一覧表示します。 ``` aws iam list-server-certificates ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM でのサーバー証明書の管理](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[ListServerCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-server-certificates.html)」を参照してください。 ### `list-service-specific-credential` 次のコード例は、`list-service-specific-credential` を使用する方法を示しています。 **AWS CLI** **例 1: ユーザーのサービス固有の認証情報を一覧表示する** 次の `list-service-specific-credentials` の例では、指定されたユーザーに割り当てられたすべてのサービス固有の認証情報を表示します。パスワードはレスポンスに含まれません。 ``` aws iam list-service-specific-credentials \ --user-name sofia ``` 出力: ``` { "ServiceSpecificCredential": { "CreateDate": "2019-04-18T20:45:36+00:00", "ServiceName": "codecommit.amazonaws.com", "ServiceUserName": "sofia-at-123456789012", "ServiceSpecificCredentialId": "ACCAEXAMPLE123EXAMPLE", "UserName": "sofia", "Status": "Active" } } ``` **例 2: 指定されたサービスにフィルタリングされたユーザーのサービス固有の認証情報を一覧表示する** 次の `list-service-specific-credentials` の例では、リクエストを行うユーザーに割り当てられたサービス固有の認証情報を表示します。リストは、指定されたサービスの認証情報のみを含むようにフィルタリングされます。パスワードはレスポンスに含まれません。 ``` aws iam list-service-specific-credentials \ --service-name codecommit.amazonaws.com ``` 出力: ``` { "ServiceSpecificCredential": { "CreateDate": "2019-04-18T20:45:36+00:00", "ServiceName": "codecommit.amazonaws.com", "ServiceUserName": "sofia-at-123456789012", "ServiceSpecificCredentialId": "ACCAEXAMPLE123EXAMPLE", "UserName": "sofia", "Status": "Active" } } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[CodeCommit への HTTPS 接続用の Git 認証情報を作成する](https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html#setting-up-gc-iam)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListServiceSpecificCredential](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-service-specific-credential.html)」を参照してください。 ### `list-service-specific-credentials` 次のコード例は、`list-service-specific-credentials` を使用する方法を示しています。 **AWS CLI** **認証情報のリストを取得するには** 次の `list-service-specific-credentials` の例では、`developer` という名前のユーザーの AWS CodeCommit リポジトリへの HTTPS アクセス用に生成された認証情報を一覧表示します。 ``` aws iam list-service-specific-credentials \ --user-name developer \ --service-name codecommit.amazonaws.com ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[CodeCommit への HTTPS 接続用の Git 認証情報を作成する](https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html#setting-up-gc-iam)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListServiceSpecificCredentials](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-service-specific-credentials.html)」を参照してください。 ### `list-signing-certificates` 次のコード例は、`list-signing-certificates` を使用する方法を示しています。 **AWS CLI** **IAM ユーザーの署名証明書を一覧表示するには** 次の `list-signing-certificates` コマンドは、`Bob` という名前の IAM ユーザーの署名証明書を一覧表示します。 ``` aws iam list-signing-certificates \ --user-name Bob ``` 出力: ``` { "Certificates": [ { "UserName": "Bob", "Status": "Inactive", "CertificateBody": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE", "UploadDate": "2013-06-06T21:40:08Z" } ] } ``` 詳細については、「*Amazon EC2 ユーザーガイド*」の「[署名証明書の管理](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/set-up-ami-tools.html#ami-tools-managing-certs)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListSigningCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-signing-certificates.html)」を参照してください。 ### `list-ssh-public-keys` 次のコード例は、`list-ssh-public-keys` を使用する方法を示しています。 **AWS CLI** **IAM ユーザーにアタッチされた SSH パブリックキーを一覧表示するには** 次の `list-ssh-public-keys` の例では、IAM ユーザー `sofia` にアタッチされた SSH パブリックキーを一覧表示します。 ``` aws iam list-ssh-public-keys \ --user-name sofia ``` 出力: ``` { "SSHPublicKeys": [ { "UserName": "sofia", "SSHPublicKeyId": "APKA1234567890EXAMPLE", "Status": "Inactive", "UploadDate": "2019-04-18T17:04:49+00:00" } ] } ``` 詳細については、「*AWSIAM ユーザーガイド*」の「[CodeCommit で SSH キーと SSH を使用する](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_ssh-keys.html#ssh-keys-code-commit)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListSshPublicKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-ssh-public-keys.html)」を参照してください。 ### `list-user-policies` 次のコード例は、`list-user-policies` を使用する方法を示しています。 **AWS CLI** **IAM ユーザーのポリシーを一覧表示するには** 次の `list-user-policies` コマンドは、`Bob` という名前の IAM ユーザーにアタッチされているポリシーを一覧表示します。 ``` aws iam list-user-policies \ --user-name Bob ``` 出力: ``` { "PolicyNames": [ "ExamplePolicy", "TestPolicy" ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[AWS アカウントでの IAM ユーザーの作成](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListUserPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-user-policies.html)」を参照してください。 ### `list-user-tags` 次のコード例は、`list-user-tags` を使用する方法を示しています。 **AWS CLI** **ユーザーにアタッチされたタグを一覧表示するには** 次の `list-user-tags` コマンドは、指定された IAM ユーザーに関連付けられているタグを取得します。 ``` aws iam list-user-tags \ --user-name alice ``` 出力: ``` { "Tags": [ { "Key": "Department", "Value": "Accounting" }, { "Key": "DeptID", "Value": "12345" } ], "IsTruncated": false } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM リソースのタグ付け](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListUserTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-user-tags.html)」を参照してください。 ### `list-users` 次のコード例は、`list-users` を使用する方法を示しています。 **AWS CLI** **IAM ユーザーを一覧表示するには** 次の `list-users` コマンドは、現在のアカウントの IAM ユーザーを一覧表示します。 ``` aws iam list-users ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ユーザーの一覧表示](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_manage.html#id_users_manage_list)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListUsers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-users.html)」を参照してください。 ### `list-virtual-mfa-devices` 次のコード例は、`list-virtual-mfa-devices` を使用する方法を示しています。 **AWS CLI** **仮想 MFA デバイスを一覧表示するには** 次の `list-virtual-mfa-devices` コマンドは、現在のアカウントに設定されている仮想 MFA デバイスを一覧表示します。 ``` aws iam list-virtual-mfa-devices ``` 出力: ``` { "VirtualMFADevices": [ { "SerialNumber": "arn:aws:iam::123456789012:mfa/ExampleMFADevice" }, { "SerialNumber": "arn:aws:iam::123456789012:mfa/Fred" } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[仮想多要素認証 (MFA) デバイスの有効化 (コンソール)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa_enable_virtual.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListVirtualMfaDevices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/list-virtual-mfa-devices.html)」を参照してください。 ### `put-group-policy` 次のコード例は、`put-group-policy` を使用する方法を示しています。 **AWS CLI** **グループにポリシーを追加するには** 次の `put-group-policy` コマンドは、`Admins` という名前の IAM グループにポリシーを追加します。 ``` aws iam put-group-policy \ --group-name Admins \ --policy-document file://AdminPolicy.json \ --policy-name AdminRoot ``` このコマンドでは何も出力されません。 ポリシーは、*AdminPolicy.json* ファイル内で JSON ドキュメントとして定義されます。(ファイル名と拡張子には意味はありません。) IAM ポリシーの詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ポリシーを管理する](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutGroupPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/put-group-policy.html)」を参照してください。 ### `put-role-permissions-boundary` 次のコード例は、`put-role-permissions-boundary` を使用する方法を示しています。 **AWS CLI** **例 1: カスタムポリシーに基づくアクセス許可の境界を IAM ロールに適用するには** 次の `put-role-permissions-boundary` の例では、指定した IAM ロールのアクセス許可の境界として、`intern-boundary` という名前のカスタムポリシーを適用します。 ``` aws iam put-role-permissions-boundary \ --permissions-boundary arn:aws:iam::123456789012:policy/intern-boundary \ --role-name lambda-application-role ``` このコマンドでは何も出力されません。 **例 2: AWS 管理ポリシーに基づくアクセス許可の境界を IAM ロールに適用するには** 次の `put-role-permissions-boundary` の例では、指定した IAM ロールのアクセス許可の境界として、AWS 管理 `PowerUserAccess` ポリシーを適用します。 ``` aws iam put-role-permissions-boundary \ --permissions-boundary arn:aws:iam::aws:policy/PowerUserAccess \ --role-name x-account-admin ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[ロールの変更](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage_modify.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutRolePermissionsBoundary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/put-role-permissions-boundary.html)」を参照してください。 ### `put-role-policy` 次のコード例は、`put-role-policy` を使用する方法を示しています。 **AWS CLI** **アクセス許可ポリシーを IAM ロールにアタッチするには** 次の `put-role-policy` コマンドは、`Test-Role` という名前のロールにアクセス許可ポリシーを追加します。 ``` aws iam put-role-policy \ --role-name Test-Role \ --policy-name ExamplePolicy \ --policy-document file://AdminPolicy.json ``` このコマンドでは何も出力されません。 ポリシーは、*AdminPolicy.json* ファイル内で JSON ドキュメントとして定義されます。(ファイル名と拡張子には意味はありません。) 信頼ポリシーをロールにアタッチするには、`update-assume-role-policy` コマンドを使用します。 詳細については、「*AWS IAM ユーザーガイド*」の「[ロールの変更](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage_modify.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutRolePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/put-role-policy.html)」を参照してください。 ### `put-user-permissions-boundary` 次のコード例は、`put-user-permissions-boundary` を使用する方法を示しています。 **AWS CLI** **例 1: カスタムポリシーに基づくアクセス許可の境界を IAM ユーザーに適用するには** 次の `put-user-permissions-boundary` の例では、指定した IAM ユーザーのアクセス許可の境界として、`intern-boundary` という名前のカスタムポリシーを適用します。 ``` aws iam put-user-permissions-boundary \ --permissions-boundary arn:aws:iam::123456789012:policy/intern-boundary \ --user-name intern ``` このコマンドでは何も出力されません。 **例 2: AWS 管理ポリシーに基づくアクセス許可の境界を IAM ユーザーに適用するには** 次の `put-user-permissions-boundary` の例では、指定した IAM ユーザーのアクセス許可の境界として、`PowerUserAccess` という名前の AWS 管理ポリシーを適用します。 ``` aws iam put-user-permissions-boundary \ --permissions-boundary arn:aws:iam::aws:policy/PowerUserAccess \ --user-name developer ``` このコマンドでは何も出力されません。 詳細については、*AWS IAM ユーザーガイド*の「[IAM ID アクセス許可の追加および削除](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage-attach-detach.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutUserPermissionsBoundary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/put-user-permissions-boundary.html)」を参照してください。 ### `put-user-policy` 次のコード例は、`put-user-policy` を使用する方法を示しています。 **AWS CLI** **ポリシーを IAM ユーザーにアタッチするには** 次の `put-user-policy` コマンドは、`Bob` という名前の IAM ユーザーにポリシーをアタッチします。 ``` aws iam put-user-policy \ --user-name Bob \ --policy-name ExamplePolicy \ --policy-document file://AdminPolicy.json ``` このコマンドでは何も出力されません。 ポリシーは、*AdminPolicy.json* ファイル内で JSON ドキュメントとして定義されます。(ファイル名と拡張子には意味はありません。) 詳細については、*AWS IAM ユーザーガイド*の「[IAM ID アクセス許可の追加および削除](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage-attach-detach.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutUserPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/put-user-policy.html)」を参照してください。 ### `remove-client-id-from-open-id-connect-provider` 次のコード例は、`remove-client-id-from-open-id-connect-provider` を使用する方法を示しています。 **AWS CLI** **指定の IAM OpenID Connect プロバイダーに対して登録されているクライアント ID のリストから、指定のクライアント ID を削除するには** この例では、ARN が `arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com` である IAM OIDC プロバイダーに関連付けられているクライアント ID のリストから、クライアント ID `My-TestApp-3` を削除します。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM で OpenID Connect (OIDC) ID プロバイダーを作成する](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveClientIdFromOpenIdConnectProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/remove-client-id-from-open-id-connect-provider.html)」を参照してください。 ### `remove-role-from-instance-profile` 次のコード例は、`remove-role-from-instance-profile` を使用する方法を示しています。 **AWS CLI** **ロールをインスタンスプロファイルから削除するには** 次の `remove-role-from-instance-profile` コマンドは、`ExampleInstanceProfile` という名前のインスタンスプロファイルから `Test-Role` という名前のロールを削除します。 ``` aws iam remove-role-from-instance-profile \ --instance-profile-name ExampleInstanceProfile \ --role-name Test-Role ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[インスタンスプロファイルの使用](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveRoleFromInstanceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/remove-role-from-instance-profile.html)」を参照してください。 ### `remove-user-from-group` 次のコード例は、`remove-user-from-group` を使用する方法を示しています。 **AWS CLI** **IAM グループからユーザーを削除するには** 次の `remove-user-from-group` コマンドは、`Admins` という名前の IAM グループから `Bob` というユーザーを削除します。 ``` aws iam remove-user-from-group \ --user-name Bob \ --group-name Admins ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ユーザーグループへのユーザーの追加と削除](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage_add-remove-users.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveUserFromGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/remove-user-from-group.html)」を参照してください。 ### `reset-service-specific-credential` 次のコード例は、`reset-service-specific-credential` を使用する方法を示しています。 **AWS CLI** **例 1: リクエストを行うユーザーにアタッチされたサービス固有の認証情報のパスワードをリセットする** 次の `reset-service-specific-credential` の例では、リクエストを行うユーザーにアタッチされた、指定されたサービス固有の認証情報の新しい暗号化された強力なパスワードを生成します。 ``` aws iam reset-service-specific-credential \ --service-specific-credential-id ACCAEXAMPLE123EXAMPLE ``` 出力: ``` { "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" } } ``` **例 2: 指定されたユーザーにアタッチされたサービス固有の認証情報のパスワードをリセットする** 次の `reset-service-specific-credential` の例では、指定されたユーザーにアタッチされたサービス固有の認証情報の新しい暗号化された強力なパスワードを生成します。 ``` aws iam reset-service-specific-credential \ --user-name sofia \ --service-specific-credential-id ACCAEXAMPLE123EXAMPLE ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[CodeCommit への HTTPS 接続用の Git 認証情報を作成する](https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html#setting-up-gc-iam)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ResetServiceSpecificCredential](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/reset-service-specific-credential.html)」を参照してください。 ### `resync-mfa-device` 次のコード例は、`resync-mfa-device` を使用する方法を示しています。 **AWS CLI** **MFA デバイスを同期するには** 次の `resync-mfa-device` の例では、IAM ユーザー `Bob` に関連付けられていて、ARN が `arn:aws:iam::123456789012:mfa/BobsMFADevice` である MFA デバイスを、2 つの認証コードを提供した認証プログラムと同期します。 ``` aws iam resync-mfa-device \ --user-name Bob \ --serial-number arn:aws:iam::210987654321:mfa/BobsMFADevice \ --authentication-code1 123456 \ --authentication-code2 987654 ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[AWS での多要素認証 (MFA) の使用](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ResyncMfaDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/resync-mfa-device.html)」を参照してください。 ### `set-default-policy-version` 次のコード例は、`set-default-policy-version` を使用する方法を示しています。 **AWS CLI** **指定されたポリシーの指定されたバージョンを、ポリシーのデフォルトバージョンとして設定するには** この例では、ARN が `arn:aws:iam::123456789012:policy/MyPolicy` であるポリシーの `v2` バージョンをデフォルトのアクティブなバージョンとして設定します。 ``` aws iam set-default-policy-version \ --policy-arn arn:aws:iam::123456789012:policy/MyPolicy \ --version-id v2 ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM のポリシーとアクセス許可](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetDefaultPolicyVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/set-default-policy-version.html)」を参照してください。 ### `set-security-token-service-preferences` 次のコード例は、`set-security-token-service-preferences` を使用する方法を示しています。 **AWS CLI** **グローバルエンドポイントトークンバージョンを設定するには** 次の `set-security-token-service-preferences` の例では、グローバルエンドポイントに対して認証するときにバージョン 2 トークンを使用するように Amazon STS を設定します。 ``` aws iam set-security-token-service-preferences \ --global-endpoint-token-version v2Token ``` このコマンドでは何も出力されません。 詳細については、*AWSIAM ユーザーガイド*の「[AWS リージョンでの AWS STS の管理](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_enable-regions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetSecurityTokenServicePreferences](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/set-security-token-service-preferences.html)」を参照してください。 ### `simulate-custom-policy` 次のコード例は、`simulate-custom-policy` を使用する方法を示しています。 **AWS CLI** **例 1: IAM ユーザーまたはロールに関連付けられているすべての IAM ポリシーの効果をシミュレートするには** 次の `simulate-custom-policy` は、ポリシーと変数値の両方を指定し、API コールをシミュレートして、許可または拒否されているかどうかを確認する方法を示しています。次の例は、指定された日付と時刻の後にのみデータベースアクセスを有効にするポリシーを示しています。シミュレーションは成功します。シミュレーションされたアクションと指定された `aws:CurrentTime` 変数がすべてポリシーの要件と一致するためです。 ``` 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" ``` 出力: ``` { "EvaluationResults": [ { "EvalActionName": "dynamodb:CreateBackup", "EvalResourceName": "*", "EvalDecision": "allowed", "MatchedStatements": [ { "SourcePolicyId": "PolicyInputList.1", "StartPosition": { "Line": 1, "Column": 38 }, "EndPosition": { "Line": 1, "Column": 167 } } ], "MissingContextValues": [] } ] } ``` **例 2: ポリシーで禁止されているコマンドをシミュレートするには** 次の `simulate-custom-policy` の例は、ポリシーで禁止されているコマンドをシミュレートした結果を示しています。この例での指定された日付は、ポリシーの条件で必要とされる日付より前です。 ``` 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" ``` 出力: ``` { "EvaluationResults": [ { "EvalActionName": "dynamodb:CreateBackup", "EvalResourceName": "*", "EvalDecision": "implicitDeny", "MatchedStatements": [], "MissingContextValues": [] } ] } ``` 詳細については、「*AWSIAM ユーザーガイド*」の「[IAM ポリシーシミュレーターを使用した IAM ポリシーのテスト](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SimulateCustomPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/simulate-custom-policy.html)」を参照してください。 ### `simulate-principal-policy` 次のコード例は、`simulate-principal-policy` を使用する方法を示しています。 **AWS CLI** **例 1: 任意の IAM ポリシーの効果をシミュレートするには** 次の `simulate-principal-policy` は、API アクションを呼び出すユーザーをシミュレートし、そのユーザーに関連付けられたポリシーがアクションを許可または拒否するかどうかを決定する方法を示します。次の例では、ユーザーに `codecommit:ListRepositories` アクションのみを許可するポリシーがあります。 ``` aws iam simulate-principal-policy \ --policy-source-arn arn:aws:iam::123456789012:user/alejandro \ --action-names codecommit:ListRepositories ``` 出力: ``` { "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": [] } ] } ``` **例 2: 禁止されているコマンドの影響をシミュレートするには** 次の `simulate-custom-policy` の例は、ユーザーのポリシーのいずれかで禁止されているコマンドをシミュレートした結果を示しています。次の例では、ユーザーに特定の日付と時刻の後にのみ DynamoDB データベースへのアクセスを許可するポリシーがあります。このシミュレーションでは、ポリシーの条件が許可する値よりも前の `aws:CurrentTime` 値でデータベースにアクセスしようとします。 ``` 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" ``` 出力: ``` { "EvaluationResults": [ { "EvalActionName": "dynamodb:CreateBackup", "EvalResourceName": "*", "EvalDecision": "implicitDeny", "MatchedStatements": [], "MissingContextValues": [] } ] } ``` 詳細については、「*AWSIAM ユーザーガイド*」の「[IAM ポリシーシミュレーターを使用した IAM ポリシーのテスト](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SimulatePrincipalPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/simulate-principal-policy.html)」を参照してください。 ### `tag-instance-profile` 次のコード例は、`tag-instance-profile` を使用する方法を示しています。 **AWS CLI** **タグをインスタンスプロファイルに追加するには** 次の `tag-instance-profile` コマンドは、部門名を持つタグを指定したインスタンスプロファイルに追加します。 ``` aws iam tag-instance-profile \ --instance-profile-name deployment-role \ --tags '[{"Key": "Department", "Value": "Accounting"}]' ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM リソースのタグ付け](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagInstanceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/tag-instance-profile.html)」を参照してください。 ### `tag-mfa-device` 次のコード例は、`tag-mfa-device` を使用する方法を示しています。 **AWS CLI** **MFA デバイスにタグを追加するには** 次の `tag-mfa-device` コマンドは、部門名を持つタグを指定した MFA デバイスに追加します。 ``` aws iam tag-mfa-device \ --serial-number arn:aws:iam::123456789012:mfa/alice \ --tags '[{"Key": "Department", "Value": "Accounting"}]' ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM リソースのタグ付け](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagMfaDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/tag-mfa-device.html)」を参照してください。 ### `tag-open-id-connect-provider` 次のコード例は、`tag-open-id-connect-provider` を使用する方法を示しています。 **AWS CLI** **OpenID Connect (OIDC) 互換 ID プロバイダーにタグを追加するには** 次の `tag-open-id-connect-provider` コマンドは、部門名を持つタグを指定した OIDC ID プロバイダーに追加します。 ``` 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"}]' ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM リソースのタグ付け](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagOpenIdConnectProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/tag-open-id-connect-provider.html)」を参照してください。 ### `tag-policy` 次のコード例は、`tag-policy` を使用する方法を示しています。 **AWS CLI** **カスタマー管理ポリシーにタグを追加するには** 次の `tag-policy` コマンドは、部門名を持つタグを指定したカスタマー管理ポリシーに追加します。 ``` aws iam tag-policy \ --policy-arn arn:aws:iam::123456789012:policy/billing-access \ --tags '[{"Key": "Department", "Value": "Accounting"}]' ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM リソースのタグ付け](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/tag-policy.html)」を参照してください。 ### `tag-role` 次のコード例は、`tag-role` を使用する方法を示しています。 **AWS CLI** **ロールにタグを追加するには** 次の `tag-role` コマンドは、部門名を持つタグを指定したロールに追加します。 ``` aws iam tag-role --role-name my-role \ --tags '{"Key": "Department", "Value": "Accounting"}' ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM リソースのタグ付け](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagRole](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/tag-role.html)」を参照してください。 ### `tag-saml-provider` 次のコード例は、`tag-saml-provider` を使用する方法を示しています。 **AWS CLI** **SAML プロバイダーにタグを追加するには** 次の `tag-saml-provider` コマンドは、部門名を持つタグを指定した SAML プロバイダーに追加します。 ``` aws iam tag-saml-provider \ --saml-provider-arn arn:aws:iam::123456789012:saml-provider/ADFS \ --tags '[{"Key": "Department", "Value": "Accounting"}]' ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM リソースのタグ付け](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagSamlProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/tag-saml-provider.html)」を参照してください。 ### `tag-server-certificate` 次のコード例は、`tag-server-certificate` を使用する方法を示しています。 **AWS CLI** **サーバー証明書にタグを追加するには** 次の `tag-saml-provider` コマンドは、部門名を持つタグを指定したサーバー証明書に追加します。 ``` aws iam tag-server-certificate \ --server-certificate-name ExampleCertificate \ --tags '[{"Key": "Department", "Value": "Accounting"}]' ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM リソースのタグ付け](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagServerCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/tag-server-certificate.html)」を参照してください。 ### `tag-user` 次のコード例は、`tag-user` を使用する方法を示しています。 **AWS CLI** **ユーザーにタグを追加するには** 次の `tag-user` コマンドは、関連付けらた部門を持つタグを指定したユーザーに追加します。 ``` aws iam tag-user \ --user-name alice \ --tags '{"Key": "Department", "Value": "Accounting"}' ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM リソースのタグ付け](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/tag-user.html)」を参照してください。 ### `untag-instance-profile` 次のコード例は、`untag-instance-profile` を使用する方法を示しています。 **AWS CLI** **タグをインスタンスプロファイルから削除するには** 次の `untag-instance-profile` コマンドは、キー名が「Department」のタグを指定されたインスタンスプロファイルから削除します。 ``` aws iam untag-instance-profile \ --instance-profile-name deployment-role \ --tag-keys Department ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM リソースのタグ付け](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagInstanceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/untag-instance-profile.html)」を参照してください。 ### `untag-mfa-device` 次のコード例は、`untag-mfa-device` を使用する方法を示しています。 **AWS CLI** **MFA デバイスからタグを削除するには** 次の `untag-mfa-device` コマンドは、キー名が「Department」のタグを指定された MFA デバイスから削除します。 ``` aws iam untag-mfa-device \ --serial-number arn:aws:iam::123456789012:mfa/alice \ --tag-keys Department ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM リソースのタグ付け](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagMfaDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/untag-mfa-device.html)」を参照してください。 ### `untag-open-id-connect-provider` 次のコード例は、`untag-open-id-connect-provider` を使用する方法を示しています。 **AWS CLI** **OIDC ID プロバイダーからタグを削除するには** 次の `untag-open-id-connect-provider` コマンドは、キー名が「Department」のタグを指定された OIDC ID プロバイダーから削除します。 ``` aws iam untag-open-id-connect-provider \ --open-id-connect-provider-arn arn:aws:iam::123456789012:oidc-provider/server.example.com \ --tag-keys Department ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM リソースのタグ付け](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagOpenIdConnectProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/untag-open-id-connect-provider.html)」を参照してください。 ### `untag-policy` 次のコード例は、`untag-policy` を使用する方法を示しています。 **AWS CLI** **カスタマー管理ポリシーからタグを削除するには** 次の `untag-policy` コマンドは、キー名が「Department」のタグを指定されたカスタマー管理ポリシーから削除します。 ``` aws iam untag-policy \ --policy-arn arn:aws:iam::452925170507:policy/billing-access \ --tag-keys Department ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM リソースのタグ付け](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/untag-policy.html)」を参照してください。 ### `untag-role` 次のコード例は、`untag-role` を使用する方法を示しています。 **AWS CLI** **ロールからタグを削除するには** 次の `untag-role` コマンドは、キー名「Department」のタグを指定されたロールから削除します。 ``` aws iam untag-role \ --role-name my-role \ --tag-keys Department ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM リソースのタグ付け](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagRole](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/untag-role.html)」を参照してください。 ### `untag-saml-provider` 次のコード例は、`untag-saml-provider` を使用する方法を示しています。 **AWS CLI** **SAML プロバイダーからタグを削除するには** 次の `untag-saml-provider` コマンドは、キー名が「Department」のタグを指定されたインスタンスプロファイルから削除します。 ``` aws iam untag-saml-provider \ --saml-provider-arn arn:aws:iam::123456789012:saml-provider/ADFS \ --tag-keys Department ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM リソースのタグ付け](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagSamlProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/untag-saml-provider.html)」を参照してください。 ### `untag-server-certificate` 次のコード例は、`untag-server-certificate` を使用する方法を示しています。 **AWS CLI** **サーバー証明書からタグを削除するには** 次の `untag-server-certificate` コマンドは、キー名が「Department」のタグを指定されたサーバー証明書から削除します。 ``` aws iam untag-server-certificate \ --server-certificate-name ExampleCertificate \ --tag-keys Department ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM リソースのタグ付け](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagServerCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/untag-server-certificate.html)」を参照してください。 ### `untag-user` 次のコード例は、`untag-user` を使用する方法を示しています。 **AWS CLI** **ユーザーからタグを削除するには** 次の `untag-user` コマンドは、キー名が「Department」のタグを指定されたユーザーから削除します。 ``` aws iam untag-user \ --user-name alice \ --tag-keys Department ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM リソースのタグ付け](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/untag-user.html)」を参照してください。 ### `update-access-key` 次のコード例は、`update-access-key` を使用する方法を示しています。 **AWS CLI** **IAM ユーザーのためにアクセスキーをアクティブ化または非アクティブ化するには** 次の `update-access-key` コマンドは、`Bob` という名前の IAM ユーザーのために指定されたアクセスキー (アクセスキー ID とシークレットアクセスキー) を非アクティブ化します。 ``` aws iam update-access-key \ --access-key-id AKIAIOSFODNN7EXAMPLE \ --status Inactive \ --user-name Bob ``` このコマンドでは何も出力されません。 キーを非アクティブ化すると、そのキーをプログラムによる AWS へのアクセスに使用できなくなります。ただし、キーは引き続き使用可能であり、再アクティブ化することができます。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ユーザーのアクセスキーの管理](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[UpdateAccessKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/update-access-key.html)」を参照してください。 ### `update-account-password-policy` 次のコード例は、`update-account-password-policy` を使用する方法を示しています。 **AWS CLI** **現在のアカウントのパスワードポリシーを設定または変更するには** 次の `update-account-password-policy` コマンドは、8 文字以上の長さを要求し、パスワードに 1 つ以上の数字を要求するようにパスワードポリシーを設定します。 ``` aws iam update-account-password-policy \ --minimum-password-length 8 \ --require-numbers ``` このコマンドでは何も出力されません。 アカウントのパスワードポリシーを変更すると、そのアカウントの IAM ユーザー用に作成された新しいパスワードに影響します。パスワードポリシーを変更しても、既存のパスワードには影響しません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ユーザーのアカウントパスワードポリシーの設定](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_account-policy.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateAccountPasswordPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/update-account-password-policy.html)」を参照してください。 ### `update-assume-role-policy` 次のコード例は、`update-assume-role-policy` を使用する方法を示しています。 **AWS CLI** **IAM ロールの信頼ポリシーを更新するには** 次の `update-assume-role-policy` コマンドは、`Test-Role` という名前のロールの信頼ポリシーを更新します。 ``` aws iam update-assume-role-policy \ --role-name Test-Role \ --policy-document file://Test-Role-Trust-Policy.json ``` このコマンドでは何も出力されません。 信頼ポリシーは、*Test-Role-Trust-Policy.json *ファイル内で JSON ドキュメントとして定義されます。(ファイル名と拡張子には意味はありません。) 信頼ポリシーはプリンシパルを指定する必要があります。 ロールのアクセス許可ポリシーを更新するには、`put-role-policy` コマンドを使用します。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ロールの作成](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateAssumeRolePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/update-assume-role-policy.html)」を参照してください。 ### `update-group` 次のコード例は、`update-group` を使用する方法を示しています。 **AWS CLI** **IAM グループの名前を変更するには** 次の `update-group` コマンドは、IAM グループ `Test` の名前を `Test-1` に変更します。 ``` aws iam update-group \ --group-name Test \ --new-group-name Test-1 ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ユーザーグループの名前の変更](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage_rename.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/update-group.html)」を参照してください。 ### `update-login-profile` 次のコード例は、`update-login-profile` を使用する方法を示しています。 **AWS CLI** **IAM ユーザーのパスワードを更新するには** 次の `update-login-profile` コマンドは、`Bob` という名前の IAM ユーザーの新しいパスワードを作成します。 ``` aws iam update-login-profile \ --user-name Bob \ --password ``` このコマンドでは何も出力されません。 アカウントのパスワードポリシーを設定するには、`update-account-password-policy` コマンドを使用します。新しいパスワードがアカウントのパスワードポリシーに違反している場合、コマンドは `PasswordPolicyViolation` エラーを返します。 アカウントのパスワードポリシーで許可されている場合、IAM ユーザーは `change-password` コマンドを使用して自分のパスワードを変更できます。 パスワードを安全な場所に保存します。パスワードを紛失した場合は回復できないため、`create-login-profile` コマンドを使用して新しいパスワードを作成する必要があります。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ユーザーのパスワードの管理](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_passwords_admin-change-user.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateLoginProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/update-login-profile.html)」を参照してください。 ### `update-open-id-connect-provider-thumbprint` 次のコード例は、`update-open-id-connect-provider-thumbprint` を使用する方法を示しています。 **AWS CLI** **サーバー証明書のサムプリントの既存のリストを新しいリストに置き換えるには** この例では、ARN が `arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com` である OIDC プロバイダーの証明書サムプリントリストを更新して、新しいサムプリントを使用します。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM で OpenID Connect (OIDC) ID プロバイダーを作成する](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateOpenIdConnectProviderThumbprint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/update-open-id-connect-provider-thumbprint.html)」を参照してください。 ### `update-role-description` 次のコード例は、`update-role-description` を使用する方法を示しています。 **AWS CLI** **IAM ロールの説明を変更するには** 次の `update-role` コマンドは、IAM ロール `production-role` の説明を `Main production role` に変更します。 ``` aws iam update-role-description \ --role-name production-role \ --description 'Main production role' ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[ロールの変更](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage_modify.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateRoleDescription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/update-role-description.html)」を参照してください。 ### `update-role` 次のコード例は、`update-role` を使用する方法を示しています。 **AWS CLI** **IAM ロールの説明またはセッション期間を変更するには** 次の `update-role` コマンドは、IAM ロールの説明 `production-role` を `Main production role` に変更し、最大セッション期間を 12 時間に設定します。 ``` aws iam update-role \ --role-name production-role \ --description 'Main production role' \ --max-session-duration 43200 ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[ロールの変更](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage_modify.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateRole](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/update-role.html)」を参照してください。 ### `update-saml-provider` 次のコード例は、`update-saml-provider` を使用する方法を示しています。 **AWS CLI** **既存の SAML プロバイダーのメタデータドキュメントを更新するには** この例では、ARN が `arn:aws:iam::123456789012:saml-provider/SAMLADFS` である IAM の SAML プロバイダーを、ファイル `SAMLMetaData.xml` の新しい SAML メタデータドキュメントで更新します。 ``` aws iam update-saml-provider \ --saml-metadata-document file://SAMLMetaData.xml \ --saml-provider-arn arn:aws:iam::123456789012:saml-provider/SAMLADFS ``` 出力: ``` { "SAMLProviderArn": "arn:aws:iam::123456789012:saml-provider/SAMLADFS" } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM SAML ID プロバイダーの作成](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_saml.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateSamlProvider](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/update-saml-provider.html)」を参照してください。 ### `update-server-certificate` 次のコード例は、`update-server-certificate` を使用する方法を示しています。 **AWS CLI** **AWS アカウント内のサーバー証明書のパスまたは名前を変更するには** 次の `update-server-certificate` コマンドは、証明書の名前を `myServerCertificate` から `myUpdatedServerCertificate` に変更します。また、Amazon CloudFront サービスからアクセスできるように `/cloudfront/` へのパスも変更します。このコマンドでは何も出力されません。`list-server-certificates` コマンドを実行すると、更新の結果を表示できます。 ``` aws-iam update-server-certificate \ --server-certificate-name myServerCertificate \ --new-server-certificate-name myUpdatedServerCertificate \ --new-path /cloudfront/ ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM でのサーバー証明書の管理](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateServerCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/update-server-certificate.html)」を参照してください。 ### `update-service-specific-credential` 次のコード例は、`update-service-specific-credential` を使用する方法を示しています。 **AWS CLI** **例 1: リクエストするユーザーのサービス固有の認証情報のステータスを更新するには** 次の `update-service-specific-credential` の例では、`Inactive` にリクエストを行うユーザーの指定された認証情報のステータスを変更します。 ``` aws iam update-service-specific-credential \ --service-specific-credential-id ACCAEXAMPLE123EXAMPLE \ --status Inactive ``` このコマンドでは何も出力されません。 **例 2: 指定されたユーザーのサービス固有の認証情報のステータスを更新するには** 次の `update-service-specific-credential` の例では、指定されたユーザーの認証情報のステータスを非アクティブに変更します。 ``` aws iam update-service-specific-credential \ --user-name sofia \ --service-specific-credential-id ACCAEXAMPLE123EXAMPLE \ --status Inactive ``` このコマンドでは何も出力されません。 詳細については、「*AWS CodeCommit ユーザーガイド*」の「[CodeCommit への HTTPS 接続用の Git 認証情報を作成する](https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html#setting-up-gc-iam)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateServiceSpecificCredential](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/update-service-specific-credential.html)」を参照してください。 ### `update-signing-certificate` 次のコード例は、`update-signing-certificate` を使用する方法を示しています。 **AWS CLI** **IAM ユーザーの署名証明書を有効または無効にするには** 次の `update-signing-certificate` コマンドは、`Bob` という名前の IAM ユーザーの指定された署名証明書を無効にします。 ``` aws iam update-signing-certificate \ --certificate-id TA7SMP42TDN5Z26OBPJE7EXAMPLE \ --status Inactive \ --user-name Bob ``` 署名証明書の ID を取得するには、`list-signing-certificates` コマンドを使用します。 詳細については、「*Amazon EC2 ユーザーガイド*」の「[署名証明書の管理](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/set-up-ami-tools.html#ami-tools-managing-certs)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateSigningCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/update-signing-certificate.html)」を参照してください。 ### `update-ssh-public-key` 次のコード例は、`update-ssh-public-key` を使用する方法を示しています。 **AWS CLI** **SSH パブリックキーのステータスを変更するには** 次の `update-ssh-public-key` コマンドは、指定されたパブリックキーのステータスを `Inactive` に変更します。 ``` aws iam update-ssh-public-key \ --user-name sofia \ --ssh-public-key-id APKA1234567890EXAMPLE \ --status Inactive ``` このコマンドでは何も出力されません。 詳細については、「*AWSIAM ユーザーガイド*」の「[CodeCommit で SSH キーと SSH を使用する](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_ssh-keys.html#ssh-keys-code-commit)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateSshPublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/update-ssh-public-key.html)」を参照してください。 ### `update-user` 次のコード例は、`update-user` を使用する方法を示しています。 **AWS CLI** **IAM ユーザー名を変更するには** 次の `update-user` コマンドは、IAM ユーザー `Bob` の名前を `Robert` に変更します。 ``` aws iam update-user \ --user-name Bob \ --new-user-name Robert ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM ユーザーグループの名前の変更](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage_rename.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/update-user.html)」を参照してください。 ### `upload-server-certificate` 次のコード例は、`upload-server-certificate` を使用する方法を示しています。 **AWS CLI** **サーバー証明書を AWS アカウントにアップロードするには** 次の **upload-server-certificate** コマンドは、サーバー証明書を AWS アカウントにアップロードします。この例では、証明書はファイル `public_key_cert_file.pem` 内に、関連付けられたプライベートキーはファイル `my_private_key.pem` 内に、認証局 (CA) によって提供される証明書チェーンは `my_certificate_chain_file.pem` ファイル内に、それぞれ存在しています。ファイルのアップロードが完了すると、*myServerCertificate* という名前で使用できるようになります。`file://` で始まるパラメータは、ファイルの内容を読み取り、それをファイル名自体の代わりにパラメータ値として使用するようにコマンドに指示します。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、*IAM の使用*に関するガイドの「サーバー証明書の作成、アップロード、削除」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UploadServerCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/upload-server-certificate.html)」を参照してください。 ### `upload-signing-certificate` 次のコード例は、`upload-signing-certificate` を使用する方法を示しています。 **AWS CLI** **IAM ユーザーの署名証明書をアップロードするには** 次の `upload-signing-certificate` コマンドは、`Bob` という名前の IAM ユーザーの署名証明書をアップロードします。 ``` aws iam upload-signing-certificate \ --user-name Bob \ --certificate-body file://certificate.pem ``` 出力: ``` { "Certificate": { "UserName": "Bob", "Status": "Active", "CertificateBody": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE", "UploadDate": "2013-06-06T21:40:08.121Z" } } ``` 証明書は PEM 形式の *certificate.pem* という名前のファイルにあります。 詳細については、*IAM の使用*に関するガイドの「Creating and Uploading a User Signing Certificate」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UploadSigningCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/upload-signing-certificate.html)」を参照してください。 ### `upload-ssh-public-key` 次のコード例は、`upload-ssh-public-key` を使用する方法を示しています。 **AWS CLI** **SSH パブリックキーをアップロードしてユーザーに関連付けるには** 次の `upload-ssh-public-key` のコマンドは、`sshkey.pub` ファイルにあるパブリックキーをアップロードし、ユーザー `sofia` にアタッチします。 ``` aws iam upload-ssh-public-key \ --user-name sofia \ --ssh-public-key-body file://sshkey.pub ``` 出力: ``` { "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" } } ``` このコマンドに適した形式でキーを生成する方法の詳細については、「*AWS CodeCommit* ユーザーガイド」の「[SSH および Linux、macOS、または Unix: Git と CodeCommit のパブリックキーとプライベートキーをセットアップする](https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-ssh-unixes.html#setting-up-ssh-unixes-keys)」または「[SSH と Windows: Git と CodeCommit 用のパブリックキーとプライベートキーのセットアップ](https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-ssh-windows.html#setting-up-ssh-windows-keys-windows)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UploadSshPublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iam/upload-ssh-public-key.html)」を参照してください。 # AWS CLI を使用した IAM Access Analyzer の例 次のコード例では、IAM Access Analyzer で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `apply-archive-rule` 次の例では、`apply-archive-rule` を使用する方法を説明しています。 **AWS CLI** **アーカイブルール基準を満たす既存の検出結果にアーカイブルールを適用する方法** 次の `apply-archive-rule` の例では、アーカイブルールの基準を満たす既存の検出結果にアーカイブルールを適用します。 ``` aws accessanalyzer apply-archive-rule \ --analyzer-arn arn:aws:access-analyzer:us-west-2:111122223333:analyzer/UnusedAccess-ConsoleAnalyzer-organization \ --rule-name MyArchiveRule ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[アーカイブのルール](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-archive-rules.html)」を参照してください。 + API の詳細については、 「*AWS CLI コマンドリファレンス*」の「[ApplyArchiveRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/apply-archive-rule.html)」を参照してください。 ### `cancel-policy-generation` 次の例では、`cancel-policy-generation` を使用する方法を説明しています。 **AWS CLI** **ポリシー生成要求をキャンセルする方法** 次の `cancel-policy-generation` 例では、リクエストされたポリシー生成ジョブ ID をキャンセルします。 ``` aws accessanalyzer cancel-policy-generation \ --job-id 923a56b0-ebb8-4e80-8a3c-a11ccfbcd6f2 ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM Access Analyzer ポリシーの生成](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-policy-generation.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelPolicyGeneration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/cancel-policy-generation.html)」を参照してください。 ### `check-access-not-granted` 次の例では、`check-access-not-granted` を使用する方法を説明しています。 **AWS CLI** **指定されたアクセスがポリシーによって許可されていないかどうかを確認する方法** `check-access-not-granted` の例では、指定されたアクセスがポリシーによって許可されていないかどうかを確認します。 ``` aws accessanalyzer check-access-not-granted \ --policy-document file://myfile.json \ --access actions="s3:DeleteBucket","s3:GetBucketLocation" \ --policy-type IDENTITY_POLICY ``` `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/*" ] } ] } ``` 出力: ``` { "result": "PASS", "message": "The policy document does not grant access to perform one or more of the listed actions." } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM Access Analyzer API でプレビュー](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-preview-access-apis.html)」を参照してください。 + API の詳細については、 「*AWS CLI コマンドリファレンス*」の「[CheckAccessNotGranted](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/check-access-not-granted.html)」を参照してください。 ### `check-no-new-access` 次の例では、`check-no-new-access` を使用する方法を説明しています。 **AWS CLI** **既存のポリシーと比較して、更新されたポリシーで新しいアクセスが許可されるかどうかを確認する方法** `check-no-new-access` の例では、既存のポリシーと比較して、更新されたポリシーで新しいアクセスが許可されるかどうかを確認します。 ``` aws accessanalyzer check-no-new-access \ --existing-policy-document file://existing-policy.json \ --new-policy-document file://new-policy.json \ --policy-type IDENTITY_POLICY ``` `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/*" ] } ] } ``` `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/*" ] } ] } ``` 出力: ``` { "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 } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM Access Analyzer API でプレビュー](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-preview-access-apis.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CheckNoNewAccess](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/check-no-new-access.html)」を参照してください。 ### `check-no-public-access` 次の例では、`check-no-public-access` を使用する方法を説明しています。 **AWS CLI** **リソースポリシーが、指定したリソースタイプへのパブリックアクセスを許可できるかどうかを確認する方法** `check-no-public-access` の例では、リソースポリシーが、指定したリソースタイプへのパブリックアクセスを許可できるかどうかを確認します。 ``` aws accessanalyzer check-no-public-access \ --policy-document file://check-no-public-access-myfile.json \ --resource-type AWS::S3::Bucket ``` `myfile.json` の内容: ``` { "Version":"2012-10-17", "Statement": [ { "Sid": "CheckNoPublicAccess", "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::111122223333:user/JohnDoe" }, "Action": [ "s3:GetObject" ] } ] } ``` 出力: ``` { "result": "PASS", "message": "The resource policy does not grant public access for the given resource type." } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM Access Analyzer API でプレビュー](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-preview-access-apis.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CheckNoPublicAccess](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/check-no-public-access.html)」を参照してください。 ### `create-access-preview` 次の例では、`create-access-preview` を使用する方法を説明しています。 **AWS CLI** **リソースアクセス許可をデプロイする前に、リソースの IAM Access Analyzer の検出結果をプレビューできるアクセスプレビューを作成する方法** 次の `create-access-preview` の例では、 AWS アカウントにリソースアクセス許可をデプロイする前に、リソースの IAM Access Analyzer の検出結果をプレビューできるアクセスプレビューを作成します。 ``` aws accessanalyzer create-access-preview \ --analyzer-arn arn:aws:access-analyzer:us-west-2:111122223333:analyzer/ConsoleAnalyzer-account \ --configurations file://myfile.json ``` `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" } ] } } } ``` 出力: ``` { "id": "3c65eb13-6ef9-4629-8919-a32043619e6b" } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM Access Analyzer API でプレビュー](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-preview-access-apis.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateAccessPreview](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/create-access-preview.html)」を参照してください。 ### `create-analyzer` 次の例では、`create-analyzer` を使用する方法を説明しています。 **AWS CLI** **アナライザーを作成する方法方法** 次の `create-analyzer` の例では、AWS アカウントにアナライザーを作成します。 ``` aws accessanalyzer create-analyzer \ --analyzer-name example \ --type ACCOUNT ``` 出力: ``` { "arn": "arn:aws:access-analyzer:us-east-2:111122223333:analyzer/example" } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[AWS Identity and Access Management Access Analyzer の検出結果について](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateAnalyzer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/create-analyzer.html)」を参照してください。 ### `create-archive-rule` 次の例では、`create-archive-rule` を使用する方法を説明しています。 **AWS CLI** **指定されたアナライザーのアーカイブルールを作成する方法** 次の `create-archive-rule` の例では、 AWS アカウントに指定されたアナライザーのアーカイブルールを作成します。 ``` aws accessanalyzer create-archive-rule \ --analyzer-name UnusedAccess-ConsoleAnalyzer-organization \ --rule-name MyRule \ --filter '{"resource": {"contains": ["Cognito"]}, "resourceType": {"eq": ["AWS::IAM::Role"]}}' ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[アーカイブのルール](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-archive-rules.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateArchiveRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/create-archive-rule.html)」を参照してください。 ### `delete-analyzer` 次の例では、`delete-analyzer` を使用する方法を説明しています。 **AWS CLI** **指定されたアナライザーを削除する方法** 次の `delete-analyzer` の例では、AWS アカウントで指定されたアナライザーを削除します。 ``` aws accessanalyzer delete-analyzer \ --analyzer-name example ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[アーカイブのルール](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-archive-rules.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAnalyzer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/delete-analyzer.html)」を参照してください。 ### `delete-archive-rule` 次の例では、`delete-archive-rule` を使用する方法を説明しています。 **AWS CLI** **指定されたアーカイブルールを削除する方法** 次の `delete-archive-rule` の例では、 AWS アカウントで指定されたアーカイブルールを削除します。 ``` aws accessanalyzer delete-archive-rule \ --analyzer-name UnusedAccess-ConsoleAnalyzer-organization \ --rule-name MyRule ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[アーカイブのルール](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-archive-rules.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteArchiveRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/delete-archive-rule.html)」を参照してください。 ### `get-access-preview` 次の例では、`get-access-preview` を使用する方法を説明しています。 **AWS CLI** **指定されたアナライザーのアクセスプレビューに関する情報を取得する方法** 次の `get-access-preview` の例では、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 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM Access Analyzer API でプレビュー](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-preview-access-apis.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAccessPreview](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/get-access-preview.html)」を参照してください。 ### `get-analyzed-resource` 次の例では、`get-analyzed-resource` を使用する方法を説明しています。 **AWS CLI** **分析されたリソースに関する情報を取得する方法** 次の `get-analyzed-resource` の例では、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 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[AWS Identity and Access Management Access Analyzer の使用](https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAnalyzedResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/get-analyzed-resource.html)」を参照してください。 ### `get-analyzer` 次の例では、`get-analyzer` を使用する方法を説明しています。 **AWS CLI** **指定した管理ポリシーに関する情報を取得する方法** 次の `get-analyzer` の例では、AWS アカウントで指定されたアナライザーに関する情報を取得します。 ``` aws accessanalyzer get-analyzer \ --analyzer-name ConsoleAnalyzer-account ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[AWS Identity and Access Management Access Analyzer の使用](https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAnalyzer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/get-analyzer.html)」を参照してください。 ### `get-archive-rule` 次の例では、`get-archive-rule` を使用する方法を説明しています。 **AWS CLI** **アーカイブルールに関する情報を取得する方法** 次の `get-archive-rule` の例では、AWS アカウントのアーカイブルールに関する情報を取得します。 ``` aws accessanalyzer get-archive-rule \ --analyzer-name UnusedAccess-ConsoleAnalyzer-organization \ --rule-name MyArchiveRule ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[アーカイブのルール](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-archive-rules.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetArchiveRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/get-archive-rule.html)」を参照してください。 ### `get-finding-v2` 次の例では、`get-finding-v2` を使用する方法を説明しています。 **AWS CLI** **指定された検出結果に関する情報を取得する方法** 次の `get-finding-v2` の例では、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 ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[検出結果の確認](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-findings-view.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetFindingV2](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/get-finding-v2.html)」を参照してください。 ### `get-finding` 次の例では、`get-finding` を使用する方法を説明しています。 **AWS CLI** **指定された検出結果に関する情報を取得する方法** 次の `get-finding` の例では、AWS アカウントで指定された検出結果に関する情報を取得します。 ``` aws accessanalyzer get-finding \ --analyzer-arn arn:aws:access-analyzer:us-west-2:111122223333:analyzer/ConsoleAnalyzer-organization \ --id 0910eedb-381e-4e95-adda-0d25c19e6e90 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[検出結果の確認](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-findings-view.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetFinding](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/get-finding.html)」を参照してください。 ### `get-generated-policy` 次の例では、`get-generated-policy` を使用する方法を説明しています。 **AWS CLI** **`StartPolicyGeneration ` API を使用して生成されたポリシーを取得する方法** 次の `get-generated-policy` の例では、 AWS アカウントで StartPolicyGeneration API を使用して生成されたポリシーを取得します。 ``` aws accessanalyzer get-generated-policy \ --job-id c557dc4a-0338-4489-95dd-739014860ff9 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM Access Analyzer ポリシーの生成](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-policy-generation.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetGeneratedPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/get-generated-policy.html)」を参照してください。 ### `list-access-preview-findings` 次の例では、`list-access-preview-findings` を使用する方法を説明しています。 **AWS CLI** **指定されたアクセスプレビューによって生成されたアクセスプレビュー検出結果の一覧を取得する方法** 次の `list-access-preview-findings` の例では、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 ``` 出力: ``` { "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" } ] } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM Access Analyzer API でプレビュー](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-preview-access-apis.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAccessPreviewFindings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/list-access-preview-findings.html)」を参照してください。 ### `list-access-previews` 次の例では、`list-access-previews` を使用する方法を説明しています。 **AWS CLI** **指定されたアナライザーのアクセスプレビューの一覧を取得する方法** 次の `list-access-previews` の例では、AWS アカウントで指定されたアナライザーのアクセスプレビューの一覧を取得します。 ``` aws accessanalyzer list-access-previews \ --analyzer-arn arn:aws:access-analyzer:us-west-2:111122223333:analyzer/ConsoleAnalyzer-account ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM Access Analyzer API でプレビュー](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-preview-access-apis.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAccessPreviews](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/list-access-previews.html)」を参照してください。 ### `list-analyzed-resources` 次の例では、`list-analyzed-resources` を使用する方法を説明しています。 **AWS CLI** **使用可能なウィジェットを一覧表示する方法** 次の `list-analyzed-resources` の例では、AWS アカウントで使用可能なウィジェットを一覧表示します。 ``` aws accessanalyzer list-analyzed-resources \ --analyzer-arn arn:aws:access-analyzer:us-west-2:111122223333:analyzer/ConsoleAnalyzer-account \ --resource-type AWS::IAM::Role ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[AWS Identity and Access Management Access Analyzer の使用](https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAnalyzedResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/list-analyzed-resources.html)」を参照してください。 ### `list-analyzers` 次の例では、`list-analyzers` を使用する方法を説明しています。 **AWS CLI** **アナライザーの一覧を取得する方法** 次の `list-analyzers` の例では、AWS アカウントのアナライザーの一覧を取得します。 ``` aws accessanalyzer list-analyzers ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[AWS Identity and Access Management Access Analyzer の使用](https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAnalyzers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/list-analyzers.html)」を参照してください。 ### `list-archive-rules` 次の例では、`list-archive-rules` を使用する方法を説明しています。 **AWS CLI** **指定されたアナライザー用に作成されたアーカイブルールの一覧を取得する方法** 次の `list-archive-rules` の例では、AWS アカウントで指定されたアナライザー用に作成されたアーカイブルールの一覧を取得します。 ``` aws accessanalyzer list-archive-rules \ --analyzer-name UnusedAccess-ConsoleAnalyzer-organization ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[AWS Identity and Access Management Access Analyzer の使用](https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListArchiveRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/list-archive-rules.html)」を参照してください。 ### `list-findings-v2` 次の例では、`list-findings-v2` を使用する方法を説明しています。 **AWS CLI** **指定されたアナライザーによって生成された検出結果の一覧を取得する方法** 次の `list-findings-v2` の例では、 AWS アカウントで指定されたアナライザーによって生成された検出結果の一覧を取得します。この例では、名前に「`Cognito`」が含まれている IAM ロールのみが含まれるように結果をフィルタリングします。 ``` 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"]}}' ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[AWS Identity and Access Management Access Analyzer の使用](https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListFindingsV2](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/list-findings-v2.html)」を参照してください。 ### `list-findings` 次の例では、`list-findings` を使用する方法を説明しています。 **AWS CLI** **指定されたアナライザーによって生成された検出結果の一覧を取得する方法** 次の `list-findings` の例では、 AWS アカウントで指定されたアナライザーによって生成された検出結果の一覧を取得します。この例では、名前に「`Cognito`」が含まれている IAM ロールのみが含まれるように結果をフィルタリングします。 ``` 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"]}}' ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[AWS Identity and Access Management Access Analyzer の使用](https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListFindings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/list-findings.html)」を参照してください。 ### `list-policy-generations` 次の例では、`list-policy-generations` を使用する方法を説明しています。 **AWS CLI** **過去 7 日間にリクエストされたすべてのポリシー生成を一覧表示する方法** 次の `list-policy-generations` の例では、過去 7 日間に AWS アカウントでリクエストされたすべてのポリシー生成を一覧表示します。 ``` aws accessanalyzer list-policy-generations ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM Access Analyzer ポリシーの生成](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-policy-generation.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPolicyGenerations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/list-policy-generations.html)」を参照してください。 ### `list-tags-for-resource` 次の例では、`list-tags-for-resource` を使用する方法を説明しています。 **AWS CLI** **指定されたリソースに適用されたタグの一覧を取得する方法** 次の `list-tags-for-resource` の例では、AWS アカウント内の指定されたリソースに適用されたタグの一覧を取得します。 ``` aws accessanalyzer list-tags-for-resource \ --resource-arn arn:aws:access-analyzer:us-west-2:111122223333:analyzer/ConsoleAnalyzer-account ``` 出力: ``` { "tags": { "Zone-of-trust": "Account", "Name": "ConsoleAnalyzer" } } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM Access Analyzer ポリシーの生成](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-policy-generation.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/list-tags-for-resource.html)」を参照してください。 ### `start-policy-generation` 次の例では、`start-policy-generation` を使用する方法を説明しています。 **AWS CLI** **ポリシー生成リクエストを開始する方法** 次の `start-policy-generation` の例では、 AWS アカウントでポリシー生成リクエストを開始します。 ``` aws accessanalyzer start-policy-generation \ --policy-generation-details '{"principalArn":"arn:aws:iam::111122223333:role/Admin"}' \ --cloud-trail-details file://myfile.json ``` `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" } ] } ``` 出力: ``` { "jobId": "c557dc4a-0338-4489-95dd-739014860ff9" } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM Access Analyzer ポリシーの生成](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-policy-generation.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartPolicyGeneration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/start-policy-generation.html)」を参照してください。 ### `start-resource-scan` 次の例では、`start-resource-scan` を使用する方法を説明しています。 **AWS CLI** **指定されたリソースに適用されるポリシーのスキャンをすぐに開始する方法** 次の `start-resource-scan` の例では、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 ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[IAM Access Analyzer ポリシーの生成](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-policy-generation.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartResourceScan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/start-resource-scan.html)」を参照してください。 ### `tag-resource` 次の例では、`tag-resource` を使用する方法を説明しています。 **AWS CLI** **指定されたリソースにタグを追加する方法** 次の `tag-resource` の例では、AWS アカウントで指定されたリソース共有にタグを追加します。 ``` aws accessanalyzer tag-resource \ --resource-arn arn:aws:access-analyzer:us-west-2:111122223333:analyzer/ConsoleAnalyzer-account \ --tags Environment=dev,Purpose=testing ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[AWS Identity and Access Management Access Analyzer の使用](https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/tag-resource.html)」を参照してください。 ### `untag-resource` 次の例では、`untag-resource` を使用する方法を説明しています。 **AWS CLI** **指定されたリソースからタグを削除する方法** 次の `untag-resource` の例では、 AWS アカウントの指定されたリソースからタグを削除します。 ``` aws accessanalyzer untag-resource \ --resource-arn arn:aws:access-analyzer:us-west-2:111122223333:analyzer/ConsoleAnalyzer-account \ --tag-keys Environment Purpose ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[AWS Identity and Access Management Access Analyzer の使用](https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/untag-resource.html)」を参照してください。 ### `update-archive-rule` 次の例では、`update-archive-rule` を使用する方法を説明しています。 **AWS CLI** **指定されたアーカイブルールの基準と値を更新する方法** 次の `update-archive-rule` の例では、AWS アカウントで指定されたアーカイブルールの基準と値を更新します。 ``` aws accessanalyzer update-archive-rule \ --analyzer-name UnusedAccess-ConsoleAnalyzer-organization \ --rule-name MyArchiveRule \ --filter '{"resource": {"contains": ["Cognito"]}, "resourceType": {"eq": ["AWS::IAM::Role"]}}' ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[アーカイブのルール](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-archive-rules.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateArchiveRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/update-archive-rule.html)」を参照してください。 ### `update-findings` 次の例では、`update-findings` を使用する方法を説明しています。 **AWS CLI** **指定された検出結果のステータスを更新する方法** 次の `update-findings` の例では、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 ``` このコマンドでは何も出力されません。 詳細については、「*AWS IAM ユーザーガイド*」の「[AWS Identity and Access Management Access Analyzer の使用](https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateFindings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/update-findings.html)」を参照してください。 ### `validate-policy` 次の例では、`validate-policy` を使用する方法を説明しています。 **AWS CLI** **ポリシーの検証をリクエストし、検出結果の一覧を返す方法** 次の `validate-policy` の例では、ポリシーの検証をリクエストし、検出結果の一覧を返します。この例のポリシーは、ウェブ ID フェデレーションに使用される Amazon Cognito ロールのロール信頼ポリシーです。信頼ポリシーから生成された検出結果は、使用されているロールの引き受けアクション「`sts:AssumeRole`」が正しくないため、空の `Sid` の要素の値とポリシープリンシパルが一致しません。Cognito で使用する正しいロールの引き受けアクションは「`sts:AssumeRoleWithWebIdentity`」です。 ``` aws accessanalyzer validate-policy \ --policy-document file://myfile.json \ --policy-type RESOURCE_POLICY ``` `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" } } } ] } ``` 出力: ``` { "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 } } } ] } ] } ``` 詳細については、「*AWS IAM ユーザーガイド*」の「[ポリシーを検証する際の確認事項](https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-checks-validating-policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ValidatePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/accessanalyzer/validate-policy.html)」を参照してください。 # AWS CLI を使用した Image Builder の例 次のコード例は、Image Builder で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-component` 次のコード例は、`create-component` を使用する方法を示しています。 **AWS CLI** **コンポーネントを作成しするには** 次の `create-component` の例では、JSON ドキュメントファイルを使用するコンポーネントを作成し、Amazon S3 バケットにアップロードされる YAML 形式のコンポーネントドキュメントを参照します。 ``` aws imagebuilder create-component \ --cli-input-json file://create-component.json ``` `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" } ``` 出力: ``` { "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" } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateComponent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/create-component.html)」を参照してください。 ### `create-distribution-configuration` 次のコード例は、`create-distribution-configuration` を使用する方法を示しています。 **AWS CLI** **ディストリビューション設定を作成するには** 次の `create-distribution-configuration` の例では、JSON ファイルを使用してディストリビューション設定を作成します。 ``` aws imagebuilder create-distribution-configuration \ --cli-input-json file:/create-distribution-configuration.json ``` `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" ] } } } ] } ``` 出力: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution" } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDistributionConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/create-distribution-configuration.html)」を参照してください。 ### `create-image-pipeline` 次のコード例は、`create-image-pipeline` を使用する方法を示しています。 **AWS CLI** **イメージパイプラインを作成するには** 次の `create-image-pipeline` の例では、JSON ファイルを使用してイメージパイプラインを作成します。 ``` aws imagebuilder create-image-pipeline \ --cli-input-json file://create-image-pipeline.json ``` `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" } ``` 出力: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline" } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateImagePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/create-image-pipeline.html)」を参照してください。 ### `create-image-recipe` 次のコード例は、`create-image-recipe` を使用する方法を示しています。 **AWS CLI** **レシピを作成するには** 次の `create-image-recipe` の例では、JSON ファイルを使用してイメージレシピを作成します。コンポーネントは、指定された順序でインストールされます。 ``` aws imagebuilder create-image-recipe \ --cli-input-json file://create-image-recipe.json ``` `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" } ``` 出力: ``` { "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" } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateImageRecipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/create-image-recipe.html)」を参照してください。 ### `create-image` 次のコード例は、`create-image` を使用する方法を示しています。 **AWS CLI** **イメージを作成するには** 次の `create-image` の例ではイメージを作成します。 ``` 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 ``` 出力: ``` { "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" } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/create-image.html)」を参照してください。 ### `create-infrastructure-configuration` 次のコード例は、`create-infrastructure-configuration` を使用する方法を示しています。 **AWS CLI** **インフラストラクチャ設定を作成するには** 次の `create-infrastructure-configuration` の例では、JSON ファイルを使用してインフラストラクチャ設定を作成します。 ``` aws imagebuilder create-infrastructure-configuration \ --cli-input-json file://create-infrastructure-configuration.json ``` `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" } ``` 出力: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure" } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateInfrastructureConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/create-infrastructure-configuration.html)」を参照してください。 ### `delete-component` 次のコード例は、`delete-component` を使用する方法を示しています。 **AWS CLI** **コンポーネントを削除するには** 次の `delete-component` の例は、ARN を指定してコンポーネントのビルドバージョンを削除します。 ``` aws imagebuilder delete-component \ --component-build-version-arn arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02/1 ``` 出力: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "componentBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02/1" } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteComponent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/delete-component.html)」を参照してください。 ### `delete-image-pipeline` 次のコード例は、`delete-image-pipeline` を使用する方法を示しています。 **AWS CLI** **イメージパイプラインを削除するには** 次の `delete-image-pipeline` の例では、ARN を指定してイメージパイプラインを削除します。 ``` aws imagebuilder delete-image-pipeline \ --image-pipeline-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/my-example-pipeline ``` 出力: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline" } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteImagePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/delete-image-pipeline.html)」を参照してください。 ### `delete-image-recipe` 次のコード例は、`delete-image-recipe` を使用する方法を示しています。 **AWS CLI** **イメージレシピを削除するには** 次の `delete-image-recipe` の例では、ARN を指定してイメージレシピを削除します。 ``` aws imagebuilder delete-image-recipe \ --image-recipe-arn arn:aws:imagebuilder:us-east-1:123456789012:image-recipe/mybasicrecipe/2019.12.03 ``` 出力: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03" } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteImageRecipe](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/delete-image-recipe.html)」を参照してください。 ### `delete-image` 次のコード例は、`delete-image` を使用する方法を示しています。 **AWS CLI** **イメージを削除するには** 次の `delete-image` の例は、ARN を指定してイメージのビルドバージョンを削除します。 ``` aws imagebuilder delete-image \ --image-build-version-arn arn:aws:imagebuilder:us-west-2:123456789012:image/my-example-image/2019.12.02/1 ``` 出力: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "imageBuildVersionArn": "arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1" } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/delete-image.html)」を参照してください。 ### `delete-infrastructure-configuration` 次のコード例は、`delete-infrastructure-configuration` を使用する方法を示しています。 **AWS CLI** **インフラストラクチャ設定を削除するには** 次の `delete-infrastructure-configuration` の例では、ARN を指定してイメージパイプラインを削除します。 ``` aws imagebuilder delete-infrastructure-configuration \ --infrastructure-configuration-arn arn:aws:imagebuilder:us-east-1:123456789012:infrastructure-configuration/myexampleinfrastructure ``` 出力: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure" } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteInfrastructureConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/delete-infrastructure-configuration.html)」を参照してください。 ### `get-component-policy` 次のコード例は、`get-component-policy` を使用する方法を示しています。 **AWS CLI** **コンポーネントポリシーの詳細を取得するには** 次の `get-component-policy` の例では、ARN を指定してコンポーネントポリシーの詳細を一覧表示します。 ``` aws imagebuilder get-component-policy \ --component-arn arn:aws:imagebuilder:us-west-2:123456789012:component/my-example-component/2019.12.03/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/my-example-component/2019.12.03/1" ] } ] }" } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理`\$1\$1」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetComponentPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-component-policy.html)」を参照してください。 ### `get-component` 次のコード例は、`get-component` を使用する方法を示しています。 **AWS CLI** **コンポーネントの詳細を取得するには** 次の `get-component` の例では、ARN を指定してコンポーネントの詳細を一覧表示します。 ``` aws imagebuilder get-component \ --component-build-version-arn arn:aws:imagebuilder:us-west-2:123456789012:component/component-name/1.0.0/1 ``` 出力: ``` { "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": {} } } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetComponent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-component.html)」を参照してください。 ### `get-distribution-configuration` 次のコード例は、`get-distribution-configuration` を使用する方法を示しています。 **AWS CLI** **ディストリビューション設定の詳細を取得するには** 次の `get-distribution-configuration` の例では、ARN を指定してディストリビューション設定の詳細を表示します。 ``` aws imagebuilder get-distribution-configuration \ --distribution-configuration-arn arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution ``` 出力: ``` { "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": {} } } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDistributionConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-distribution-configuration.html)」を参照してください。 ### `get-image-pipeline` 次のコード例は、`get-image-pipeline` を使用する方法を示しています。 **AWS CLI** **イメージパイプラインの詳細を取得するには** 次の `get-image-pipeline` の例では、ARN を指定してイメージパイプラインの詳細を一覧表示します。 ``` aws imagebuilder get-image-pipeline \ --image-pipeline-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline ``` 出力: ``` { "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": {} } } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetImagePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-image-pipeline.html)」を参照してください。 ### `get-image-policy` 次のコード例は、`get-image-policy` を使用する方法を示しています。 **AWS CLI** **イメージポリシーの詳細を取得するには** 次の `get-image-policy` の例では、ARN を指定してイメージポリシーの詳細を一覧表示します。 ``` aws imagebuilder get-image-policy \ --image-arn arn:aws:imagebuilder:us-west-2:123456789012:image/my-example-image/2019.12.03/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/my-example-image/2019.12.03/1" ] } ] }" } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetImagePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-image-policy.html)」を参照してください。 ### `get-image-recipe-policy` 次のコード例は、`get-image-recipe-policy` を使用する方法を示しています。 **AWS CLI** **イメージレシピポリシーの詳細を取得するには** 次の `get-image-recipe-policy` の例では、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 ``` 出力: ``` { "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" ] } ] }" } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetImageRecipePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-image-recipe-policy.html)」を参照してください。 ### `get-image` 次のコード例は、`get-image` を使用する方法を示しています。 **AWS CLI** **イメージの詳細を取得するには** 次の `get-image` の例では、ARN を指定してイメージの詳細を一覧表示します。 ``` aws imagebuilder get-image \ --image-build-version-arn arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03/1 ``` 出力: ``` { "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": {} } } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetImage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-image.html)」を参照してください。 ### `get-infrastructure-configuration` 次のコード例は、`get-infrastructure-configuration` を使用する方法を示しています。 **AWS CLI** **インフラストラクチャ設定の詳細を取得するには** 次の `get-infrastructure-configuration` の例では、ARN を指定してインフラストラクチャ設定の詳細を一覧表示します。 ``` aws imagebuilder get-infrastructure-configuration \ --infrastructure-configuration-arn arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure ``` 出力: ``` { "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": {} } } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetInfrastructureConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/get-infrastructure-configuration.html)」を参照してください。 ### `import-component` 次のコード例は、`import-component` を使用する方法を示しています。 **AWS CLI** **コンポーネントをインポートするには** 次の `import-component` の例では、JSON ファイルを使用して既存のスクリプトをインポートします。 ``` aws imagebuilder import-component \ --cli-input-json file://import-component.json ``` `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" } ``` 出力: ``` { "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" } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ImportComponent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/import-component.html)」を参照してください。 ### `list-component-build-versions` 次のコード例は、`list-component-build-versions` を使用する方法を示しています。 **AWS CLI** **コンポーネントのビルドバージョンを一覧表示するには** 次の `list-component-build-versions` の例では、特定のセマンティックバージョンを持つコンポーネントビルドバージョンを一覧表示します。 ``` aws imagebuilder list-component-build-versions --component-version-arn arn:aws:imagebuilder:us-west-2:123456789012:component/myexamplecomponent/2019.12.02 ``` 出力: ``` { "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" } } ] } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListComponentBuildVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-component-build-versions.html)」を参照してください。 ### `list-components` 次のコード例は、`list-components` を使用する方法を示しています。 **AWS CLI** **すべてのコンポーネントセマンティックバージョンを一覧表示するには** 次の `list-components` の例では、アクセスできるすべてのコンポーネントセマンティックバージョンを一覧表示します。必要に応じて、自分が所有するコンポーネント、Amazon が所有するコンポーネント、または他のアカウントによって共有されているコンポーネントを一覧表示するかどうかをフィルタリングできます。 ``` aws imagebuilder list-components ``` 出力: ``` { "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" } ] } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListComponents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-components.html)」を参照してください。 ### `list-distribution-configurations` 次のコード例は、`list-distribution-configurations` を使用する方法を示しています。 **AWS CLI** **ディストリビューションの一覧表示するには** 次の `list-distribution-configurations` の例では、すべてのディストリビューションバケットを一覧表示します。 ``` aws imagebuilder list-distribution-configurations ``` 出力: ``` { "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" } } ] } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDistributionConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-distribution-configurations.html)」を参照してください。 ### `list-image-build-versions` 次のコード例は、`list-image-build-versions` を使用する方法を示しています。 **AWS CLI** **イメージビルドバージョンを一覧表示するには** 次の `list-image-build-versions` の例では、セマンティックバージョンを持つすべてのイメージビルドバージョンを一覧表示します。 ``` aws imagebuilder list-image-build-versions \ --image-version-arn arn:aws:imagebuilder:us-west-2:123456789012:image/mybasicrecipe/2019.12.03 ``` 出力: ``` { "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": {} } ] } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListImageBuildVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-image-build-versions.html)」を参照してください。 ### `list-image-pipeline-images` 次のコード例は、`list-image-pipeline-images` を使用する方法を示しています。 **AWS CLI** **イメージパイプラインのパイプラインイメージを一覧表示するには** 次の `list-image-pipeline-images` の例では、特定のイメージパイプラインによって作成されたすべてのイメージを一覧表示します。 ``` aws imagebuilder list-image-pipeline-images \ --image-pipeline-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline ``` 出力: ``` { "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" } } ] } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListImagePipelineImages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-image-pipeline-images.html)」を参照してください。 ### `list-image-recipes` 次のコード例は、`list-image-recipes` を使用する方法を示しています。 **AWS CLI** **イメージレシピを一覧表示するには** 以下の `list-image-recipes` 例では、すべてのイメージレシピを一覧表示します。 ``` aws imagebuilder list-image-recipes ``` 出力: ``` { "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" } } ] } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListImageRecipes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-image-recipes.html)」を参照してください。 ### `list-images` 次のコード例は、`list-images` を使用する方法を示しています。 **AWS CLI** **イメージを一覧表示するには** 次の `list-images` の例では、アクセスできるすべてのセマンティックバージョンを一覧表示します。 ``` aws imagebuilder list-images ``` 出力: ``` { "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" } ] } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[ListImages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-images.html)」を参照してください。** ### `list-infrastructure-configurations` 次のコード例は、`list-infrastructure-configurations` を使用する方法を示しています。 **AWS CLI** **インフラストラクチャ設定を一覧表示するには** 次の `list-infrastructure-configurations` の例では、すべてのインフラストラクチャ設定を一覧表示します。 ``` aws imagebuilder list-infrastructure-configurations ``` 出力: ``` { "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" } } ] } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListInfrastructureConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-infrastructure-configurations.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **特定のリソースのタグを一覧表示するには** 次の `list-tags-for-resource` の例では、特定のリソースのタグを一覧表示します。 ``` aws imagebuilder list-tags-for-resource \ --resource-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline ``` 出力: ``` { "tags": { "KeyName": "KeyValue" } } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/list-tags-for-resource.html)」を参照してください。 ### `put-component-policy` 次のコード例は、`put-component-policy` を使用する方法を示しています。 **AWS CLI** **リソースポリシーをコンポーネントに適用するには** 次の `put-component-policy` のコマンドは、ビルドコンポーネントにリソースポリシーを適用して、ビルドコンポーネントのクロスアカウント共有を有効にします。RAM CLI コマンド `create-resource-share` を使用することをお勧めします。EC2 Image Builder CLI コマンド `put-component-policy` を使用する場合は、リソースを共有するすべてのプリンシパルにリソースを表示するため、RAM CLI コマンド `promote-resource-share-create-from-policy` も使用する必要があります。 ``` 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" ] } ] }' ``` 出力: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "componentArn": "arn:aws:imagebuilder:us-west-2:123456789012:component/examplecomponent/2019.12.02/1" } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutComponentPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/put-component-policy.html)」を参照してください。 ### `put-image-policy` 次のコード例は、`put-image-policy` を使用する方法を示しています。 **AWS CLI** **リソースポリシーをイメージに適用するには** 次の `put-image-policy` のコマンドは、イメージにリソースポリシーを適用して、イメージのクロスアカウント共有を有効にします。RAM CLI コマンド create-resource-share を使用することをお勧めします。EC2 Image Builder CLI コマンド put-image-policy を使用する場合、リソースが共有されているすべてのプリンシパルにリソースを表示するには、RAM CLI コマンド promote-resource-share-create-from-policy も使用する必要があります。 ``` 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" ] } ] }' ``` 出力: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "imageArn": "arn:aws:imagebuilder:us-west-2:123456789012:image/example-image/2019.12.02/1" } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutImagePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/put-image-policy.html)」を参照してください。 ### `put-image-recipe-policy` 次のコード例は、`put-image-recipe-policy` を使用する方法を示しています。 **AWS CLI** **リソースポリシーをイメージレシピに適用するには** 次の `put-image-recipe-policy` のコマンドは、イメージレシピにリソースポリシーを適用して、イメージレシピのクロスアカウント共有を有効にします。RAM CLI コマンド `create-resource-share` を使用することをお勧めします。EC2 Image Builder CLI コマンド `put-image-recipe-policy` を使用する場合は、リソースを共有するすべてのプリンシパルにリソースを表示するため、RAM CLI コマンド `promote-resource-share-create-from-policy` も使用する必要があります。 ``` 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" ] } ] }' ``` 出力: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/example-image-recipe/2019.12.02/1" } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutImageRecipePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/put-image-recipe-policy.html)」を参照してください。 ### `start-image-pipeline-execution` 次のコード例は、`start-image-pipeline-execution` を使用する方法を示しています。 **AWS CLI** **イメージパイプラインを手動で開始するには** 次の `start-image-pipeline-execution` の例では、イメージパイプラインを手動で開始します。 ``` aws imagebuilder start-image-pipeline-execution \ --image-pipeline-arn arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline ``` 出力: ``` { "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" } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartImagePipelineExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/start-image-pipeline-execution.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **リソースにタグを付けるには** 次の `tag-resource` の例では、JSON ファイルを使用して EC2 Image Builder にリソースを追加およびタグ付けします。 ``` aws imagebuilder tag-resource \ --cli-input-json file://tag-resource.json ``` `tag-resource.json` の内容: ``` { "resourceArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline", "tags": { "KeyName: "KeyValue" } } ``` このコマンドでは何も出力されません。 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/tag-resource.html)」を参照してください。 ### `untag-resource` 次の例では、`untag-resource` を使用する方法を説明しています。 **AWS CLI** **リソースからタグを削除するには** 次の `untag-resource` の例では、JSON ファイルを使用してリソースからタグを削除します。 ``` aws imagebuilder untag-resource \ --cli-input-json file://tag-resource.json ``` `untag-resource.json` の内容: ``` { "resourceArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline", "tagKeys": [ "KeyName" ] } ``` このコマンドでは何も出力されません。 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/untag-resource.html)」を参照してください。 ### `update-distribution-configuration` 次のコード例は、`update-distribution-configuration` を使用する方法を示しています。 **AWS CLI** **ディストリビューション設定を更新するには** 次の `update-distribution-configuration` の例では、JSON ファイルを使用してディストリビューション設定を更新します。 ``` aws imagebuilder update-distribution-configuration \ --cli-input-json file://update-distribution-configuration.json ``` `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}}" } } ] } ``` 出力: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateDistributionConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/update-distribution-configuration.html)」を参照してください。 ### `update-image-pipeline` 次のコード例は、`update-image-pipeline` を使用する方法を示しています。 **AWS CLI** **イメージパイプラインを更新するには** 次の `update-image-pipeline` の例では、JSON ファイルを使用してイメージパイプラインを更新します。 ``` aws imagebuilder update-image-pipeline \ --cli-input-json file://update-image-pipeline.json ``` `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" } ``` 出力: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateImagePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/update-image-pipeline.html)」を参照してください。 ### `update-infrastructure-configuration` 次のコード例は、`update-infrastructure-configuration` を使用する方法を示しています。 **AWS CLI** **インフラストラクチャ設定を更新するには** 次の `update-infrastructure-configuration` 例では、JSON ファイルを使用してインフラストラクチャ設定を更新します。 ``` aws imagebuilder update-infrastructure-configuration \ --cli-input-json file:/update-infrastructure-configuration.json ``` `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" } ``` 出力: ``` { "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } ``` 詳細については、「*EC2 Image Builder ユーザーガイド*」の「[AWS CLI を使用した EC2 Image Builder Image Pipeline のセットアップと管理](https://docs.aws.amazon.com/imagebuilder/latest/userguide/managing-image-builder-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateInfrastructureConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/imagebuilder/update-infrastructure-configuration.html)」を参照してください。 # AWS CLI を使用した Incident Manager の例 次のコード例は、Incident Manager で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-replication-set` 次のコード例は、`create-replication-set` を使用する方法を示しています。 **AWS CLI** **レプリケーションセットを作成するには** 次の `create-replication-set` の例では、Incident Manager が Amazon Web Services アカウントのデータをレプリケートおよび暗号化するために使用するレプリケーションセットを作成します。この例では、レプリケーションセットの作成時に us-east-1 リージョンと us-east-2 リージョンを使用します。 ``` 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"}}' ``` 出力: ``` { "replicationSetArns": [ "arn:aws:ssm-incidents::111122223333:replication-set/c4bcb603-4bf9-bb3f-413c-08df53673b57" ] } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[Incident Manager レプリケーションセットの使用](https://docs.aws.amazon.com/incident-manager/latest/userguide/replication.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateReplicationSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/create-replication-set.html)」を参照してください。 ### `create-response-plan` 次のコード例は、`create-response-plan` を使用する方法を示しています。 **AWS CLI** **対応計画を作成するには** 次の `create-response-plan` の例では、指定された詳細情報を含む対応計画を作成します。 ``` 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"]' ``` 出力: ``` { "arn": "arn:aws:ssm-incidents::111122223333:response-plan/example-response" } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[インシデントの準備](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-response.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateResponsePlan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/create-response-plan.html)」を参照してください。 ### `create-timeline-event` 次のコード例は、`create-timeline-event` を使用する方法を示しています。 **AWS CLI** **例 1: カスタムタイムラインイベントを作成するには** 次の `create-timeline-event` の例では、指定されたインシデントの指定された時間にカスタムタイムラインイベントを作成します。 ``` 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" ``` 出力: ``` { "eventId": "c0bcc885-a41d-eb01-b4ab-9d2deEXAMPLE", "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4EXAMPLE" } ``` **例 2: インシデントノートを使用してタイムラインイベントを作成するには** 次の `create-timeline-event` の例では、「インシデントメモ」パネルに一覧表示されるタイムラインイベントを作成します。 ``` 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"}]' ``` 出力: ``` { "eventId": "a41dc885-c0bc-b4ab-eb01-de9d2EXAMPLE", "incidentRecordArn": "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4EXAMPLE" } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[インシデントの詳細](https://docs.aws.amazon.com/incident-manager/latest/userguide/tracking-details.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateTimelineEvent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/create-timeline-event.html)」を参照してください。 ### `delete-incident-record` 次のコード例は、`delete-incident-record` を使用する方法を示しています。 **AWS CLI** **インシデントレコードを削除するには** 次の `delete-incident-record` の例では、指定されたインシデントレコードを削除します。 ``` aws ssm-incidents delete-incident-record \ --arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" ``` このコマンドでは何も出力されません。 詳細については、「*Incident Manager ユーザーガイド*」の「[インシデントの追跡](https://docs.aws.amazon.com/incident-manager/latest/userguide/tracking.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[DeleteIncidentRecord](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/delete-incident-record.html)」を参照してください。 ### `delete-replication-set` 次のコード例は、`delete-replication-set` を使用する方法を示しています。 **AWS CLI** **レプリケーションセットを削除するには** 次の `delete-replication-set` の例では、Amazon Web Services アカウントからレプリケーションセットを削除します。レプリケーションセットを削除すると、Incident Manager のデータもすべて削除されます。これは元に戻すことができません。 ``` aws ssm-incidents delete-replication-set \ --arn "arn:aws:ssm-incidents::111122223333:replication-set/c4bcb603-4bf9-bb3f-413c-08df53673b57" ``` このコマンドでは何も出力されません。 詳細については、「*Incident Manager ユーザーガイド*」の「[Incident Manager レプリケーションセットの使用](https://docs.aws.amazon.com/incident-manager/latest/userguide/replication.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteReplicationSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/delete-replication-set.html)」を参照してください。 ### `delete-resource-policy` 次のコード例は、`delete-resource-policy` を使用する方法を示しています。 **AWS CLI** **リソースポリシーを削除するには** 次の `delete-resource-policy` の例では、対応計画からリソースポリシーを削除します。これにより、対応計画を共有していたプリンシパルまたは組織からのアクセスが取り消されます。 ``` aws ssm-incidents delete-resource-policy \ --policy-id "be8b57191f0371f1c6827341aa3f0a03" \ --resource-arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan" ``` このコマンドでは何も出力されません。 詳細については、「*Incident Manager ユーザーガイド*」の「[共有連絡先と対応計画の操作](https://docs.aws.amazon.com/incident-manager/latest/userguide/sharing.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteResourcePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/delete-resource-policy.html)」を参照してください。 ### `delete-response-plan` 次のコード例は、`delete-response-plan` を使用する方法を示しています。 **AWS CLI** **対応計画を削除するには** 次の `delete-response-plan` の例では、指定された対応計画を削除します。 ``` aws ssm-incidents delete-response-plan \ --arn "arn:aws:ssm-incidents::111122223333:response-plan/example-response" ``` このコマンドでは何も出力されません。 詳細については、「*Incident Manager ユーザーガイド*」の「[インシデントの準備](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-response.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteResponsePlan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/delete-response-plan.html)」を参照してください。 ### `delete-timeline-event` 次のコード例は、`delete-timeline-event` を使用する方法を示しています。 **AWS CLI** **タイムラインイベントを削除するには** 次の `delete-timeline-event` の例では、指定されたインシデントレコードからカスタムタイムラインイベントを削除します。 ``` 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" ``` このコマンドでは何も出力されません。 詳細については、「*Incident Manager ユーザーガイド*」の「[インシデントの詳細](https://docs.aws.amazon.com/incident-manager/latest/userguide/tracking-details.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteTimelineEvent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/delete-timeline-event.html)」を参照してください。 ### `get-incident-record` 次のコード例は、`get-incident-record` を使用する方法を示しています。 **AWS CLI** **インシデントレコードを取得するには** 次の `get-incident-record` の例では、指定されたインシデントレコードの詳細情報を取得します。 ``` aws ssm-incidents get-incident-record \ --arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" ``` 出力: ``` { "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" } } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[インシデントの詳細](https://docs.aws.amazon.com/incident-manager/latest/userguide/tracking-details.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetIncidentRecord](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/get-incident-record.html)」を参照してください。 ### `get-replication-set` 次のコード例は、`get-replication-set` を使用する方法を示しています。 **AWS CLI** **レプリケーションセットを取得するには** 次の `get-replication-set` の例では、Incident Manager が Amazon Web Services アカウントのデータをレプリケートおよび暗号化するために使用するレプリケーションセットの詳細情報を取得します。 ``` aws ssm-incidents get-replication-set \ --arn "arn:aws:ssm-incidents::111122223333:replication-set/c4bcb603-4bf9-bb3f-413c-08df53673b57" ``` 出力: ``` { "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" } } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[Incident Manager レプリケーションセットの使用](https://docs.aws.amazon.com/incident-manager/latest/userguide/replication.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetReplicationSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/get-replication-set.html)」を参照してください。 ### `get-resource-policies` 次のコード例は、`get-resource-policies` を使用する方法を示しています。 **AWS CLI** **対応計画のリソースポリシーを一覧表示するには** 次の `command-name` の例では、指定された対応計画に関連付けられたリソースポリシーを一覧表示します。 ``` aws ssm-incidents get-resource-policies \ --resource-arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan" ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[共有連絡先と対応計画の操作](https://docs.aws.amazon.com/incident-manager/latest/userguide/sharing.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetResourcePolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/get-resource-policies.html)」を参照してください。 ### `get-response-plan` 次のコード例は、`get-response-plan` を使用する方法を示しています。 **AWS CLI** **対応計画の詳細を取得するには** 次の `command-name` の例では、AWS アカウントで指定された対応計画の詳細情報を取得します。 ``` aws ssm-incidents get-response-plan \ --arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan" ``` 出力: ``` { "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" } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[インシデントの準備](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-response.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetResponsePlan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/get-response-plan.html)」を参照してください。 ### `get-timeline-event` 次のコード例は、`get-timeline-event` を使用する方法を示しています。 **AWS CLI** **タイムラインイベントの詳細を取得するには** 次の `get-timeline-event` の例は、指定されたタイムラインイベントの詳細情報を返します。 ``` 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" ``` 出力: ``` { "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" } } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[インシデントの詳細](https://docs.aws.amazon.com/incident-manager/latest/userguide/tracking-details.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetTimelineEvent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/get-timeline-event.html)」を参照してください。 ### `list-incident-records` 次のコード例は、`list-incident-records` を使用する方法を示しています。 **AWS CLI** **インシデントレコードを一覧表示するには** 次の `command-name` の例では、Amazon Web Services アカウントのインシデントレコードを一覧表示します。 ``` aws ssm-incidents list-incident-records ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[インシデントリスト](https://docs.aws.amazon.com/incident-manager/latest/userguide/tracking-list.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListIncidentRecords](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/list-incident-records.html)」を参照してください。 ### `list-related-items` 次のコード例は、`list-related-items` を使用する方法を示しています。 **AWS CLI** **関連項目を一覧表示するには** 次の `list-related-items` の例では、指定されたインシデントの関連項目を一覧表示します。 ``` aws ssm-incidents list-related-items \ --incident-record-arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[インシデントの詳細](https://docs.aws.amazon.com/incident-manager/latest/userguide/tracking-details.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRelatedItems](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/list-related-items.html)」を参照してください。 ### `list-replication-sets` 次のコード例は、`list-replication-sets` を使用する方法を示しています。 **AWS CLI** **レプリケーションセットを一覧表示するには** 次の `list-replication-set` の例では、Incident Manager が AWS アカウント内のデータをレプリケートおよび暗号化するために使用するレプリケーションセットを一覧表示します。 ``` aws ssm-incidents list-replication-sets ``` 出力: ``` { "replicationSetArns": [ "arn:aws:ssm-incidents::111122223333:replication-set/c4bcb603-4bf9-bb3f-413c-08df53673b57" ] } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[Incident Manager レプリケーションセットの使用](https://docs.aws.amazon.com/incident-manager/latest/userguide/replication.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListReplicationSets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/list-replication-sets.html)」を参照してください。 ### `list-response-plans` 次のコード例は、`list-response-plans` を使用する方法を示しています。 **AWS CLI** **使用可能な対応計画を一覧表示するには** 次の `list-response-plans` 例では、Amazon Web Services アカウントで使用可能な対応計画を一覧表示します。 ``` aws ssm-incidents list-response-plans ``` 出力: ``` { "responsePlanSummaries": [ { "arn": "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan", "displayName": "Example response plan", "name": "Example-Response-Plan" } ] } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[インシデントの準備](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-response.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListResponsePlans](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/list-response-plans.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **対応計画のタグを一覧表示するには** 次の `list-tags-for-resource` の例では、指定された対応計画に関連付けられたタグを一覧表示します。 ``` aws ssm-incidents list-tags-for-resource \ --resource-arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan" ``` 出力: ``` { "tags": { "group1": "1" } } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[タグ付け](https://docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/list-tags-for-resource.html)」を参照してください。 ### `list-timeline-events` 次のコード例は、`list-timeline-events` を使用する方法を示しています。 **AWS CLI** **インシデントのタイムラインイベントを一覧表示するには** 次の `command-name` の例では、指定されたインシデントのタイムラインイベントを一覧表示します。 ``` aws ssm-incidents list-timeline-events \ --incident-record-arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[インシデントの詳細](https://docs.aws.amazon.com/incident-manager/latest/userguide/tracking-details.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTimelineEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/list-timeline-events.html)」を参照してください。 ### `put-resource-policy` 次のコード例は、`put-resource-policy` を使用する方法を示しています。 **AWS CLI** **対応計画とインシデントを共有するには** 次の `command-name` の例では、指定されたプリンシパルと対応計画および関連付けられたインシデントを共有するリソースポリシーを Example-Response-Plan に追加します。 ``` 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/*\"]}]}" ``` 出力: ``` { "policyId": "be8b57191f0371f1c6827341aa3f0a03" } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[共有連絡先と対応計画の操作](https://docs.aws.amazon.com/incident-manager/latest/userguide/sharing.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutResourcePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/put-resource-policy.html)」を参照してください。 ### `start-incident` 次のコード例は、`start-incident` を使用する方法を示しています。 **AWS CLI** **インシデントを開始するには** 次の `start-incident` の例では、指定された対応計画を使用してインシデントを開始します。 ``` aws ssm-incidents start-incident \ --response-plan-arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan" ``` 出力: ``` { "incidentRecordArn": "arn:aws:ssm-incidents::682428703967:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[インシデントの作成](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-creation.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartIncident](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/start-incident.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **対応計画にタグを付けるには** 次の `tag-resource` の例では、指定された対応計画に指定されたタグキーと値のペアをタグ付けします。 ``` aws ssm-incidents tag-resource \ --resource-arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan" \ --tags '{"group1":"1"}' ``` このコマンドでは何も出力されません。 詳細については、「*Incident Manager ユーザーガイド*」の「[タグ付け](https://docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **対応計画からタグを削除するには** 次の `untag-resource` の例では、指定されたタグを対応計画から削除します。 ``` aws ssm-incidents untag-resource \ --resource-arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan" \ --tag-keys '["group1"]' ``` このコマンドでは何も出力されません。 詳細については、「*Incident Manager ユーザーガイド*」の「[タグ付け](https://docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/untag-resource.html)」を参照してください。 ### `update-deletion-protection` 次のコード例は、`update-deletion-protection` を使用する方法を示しています。 **AWS CLI** **レプリケーションセットの削除保護を更新するには** 次の `update-deletion-protection` の例では、レプリケーションセット内の最後のリージョンを削除しないように、アカウントの削除保護を更新します。 ``` aws ssm-incidents update-deletion-protection \ --arn "arn:aws:ssm-incidents::111122223333:replication-set/a2bcc5c9-0f53-8047-7fef-c20749989b40" \ --deletion-protected ``` このコマンドでは何も出力されません。 詳細については、「*Incident Manager ユーザーガイド*」の「[Incident Manager レプリケーションセットの使用](https://docs.aws.amazon.com/incident-manager/latest/userguide/replication.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateDeletionProtection](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/update-deletion-protection.html)」を参照してください。 ### `update-incident-record` 次のコード例は、`update-incident-record` を使用する方法を示しています。 **AWS CLI** **インシデントレコードを更新するには** 次の `command-name` の例では、指定されたインシデントを解決します。 ``` aws ssm-incidents update-incident-record \ --arn "arn:aws:ssm-incidents::111122223333:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" \ --status "RESOLVED" ``` このコマンドでは何も出力されません。 詳細については、「*Incident Manager ユーザーガイド*」の「[インシデントの詳細](https://docs.aws.amazon.com/incident-manager/latest/userguide/tracking-details.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateIncidentRecord](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/update-incident-record.html)」を参照してください。 ### `update-related-items` 次のコード例は、`update-related-items` を使用する方法を示しています。 **AWS CLI** **インシデント関連項目を更新するには** 次の `update-related-item` の例では、指定されたインシデントレコードから関連項目を削除します。 ``` 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"}}}' ``` このコマンドでは何も出力されません。 詳細については、「*Incident Manager ユーザーガイド*」の「[インシデントの詳細](https://docs.aws.amazon.com/incident-manager/latest/userguide/tracking-details.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateRelatedItems](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/update-related-items.html)」を参照してください。 ### `update-replication-set` 次のコード例は、`update-replication-set` を使用する方法を示しています。 **AWS CLI** **レプリケーションセットを更新するには** 次の `command-name` の例では、us-east-2 リージョンをレプリケーションセットから削除します。 ``` 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"}}]' ``` このコマンドでは何も出力されません。 詳細については、「*Incident Manager ユーザーガイド*」の「[Incident Manager レプリケーションセットの使用](https://docs.aws.amazon.com/incident-manager/latest/userguide/replication.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateReplicationSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/update-replication-set.html)」を参照してください。 ### `update-response-plan` 次のコード例は、`update-response-plan` を使用する方法を示しています。 **AWS CLI** **対応計画を更新するには** 次の `update-response-plan` の例では、指定された対応計画からチャットチャネルを削除します。 ``` aws ssm-incidents update-response-plan \ --arn "arn:aws:ssm-incidents::111122223333:response-plan/Example-Response-Plan" \ --chat-channel '{"empty":{}}' ``` このコマンドでは何も出力されません。 詳細については、「*Incident Manager ユーザーガイド*」の「[インシデントの準備](https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-response.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateResponsePlan](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/update-response-plan.html)」を参照してください。 ### `update-timeline-event` 次のコード例は、`update-timeline-event` を使用する方法を示しています。 **AWS CLI** **タイムラインイベントを更新するには** 次の `update-timeline-event` の例では、イベントが発生した時刻を更新します。 ``` 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" ``` このコマンドでは何も出力されません。 詳細については、「*Incident Manager ユーザーガイド*」の「[インシデントの詳細](https://docs.aws.amazon.com/incident-manager/latest/userguide/tracking-details.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateTimelineEvent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-incidents/update-timeline-event.html)」を参照してください。 # AWS CLI を使用した Incident Manager Contacts の例 次のコード例は、Incident Manager Contacts で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `accept-page` 次のコード例は、`accept-page` を使用する方法を示しています。 **AWS CLI** **エンゲージメント中にページを受け入れるには** 次の `accept-page` の例では、連絡先チャネルに送信された承認コードを使用してページを受け入れます。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*Incident Manager ユーザーガイド*」の「[連絡先](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AcceptPage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/accept-page.html)」を参照してください。 ### `activate-contact-channel` 次のコード例は、`activate-contact-channel` を使用する方法を示しています。 **AWS CLI** **連絡先の連絡先チャネルを有効にする** 次の `activate-contact-channel` の例では、連絡先チャネルを有効にして、インシデントの一部として使用できるようにします。 ``` 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" ``` このコマンドでは何も出力されません。 詳細については、「*Incident Manager ユーザーガイド*」の「[連絡先](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ActivateContactChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/activate-contact-channel.html)」を参照してください。 ### `command-name` 次のコード例は、`command-name` を使用する方法を示しています。 **AWS CLI** **連絡先を削除するには** 次の `command-name` の例では、連絡先を削除します。連絡先を参照するエスカレーションプランから、連絡先にアクセスできなくなります。 ``` aws ssm-contacts delete-contact \ --contact-id "arn:aws:ssm-contacts:us-east-1:682428703967:contact/alejr" ``` このコマンドでは何も出力されません。 詳細については、「*Incident Manager ユーザーガイド*」の「[連絡先](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CommandName](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/command-name.html)」を参照してください。 ### `create-contact-channel` 次のコード例は、`create-contact-channel` を使用する方法を示しています。 **AWS CLI** **連絡先チャネルを作成するには** 連絡先 Akua Mansa の SMS タイプの連絡先チャネルを作成します。連絡先チャネルは、SMS、E メール、または音声のタイプで作成できます。 ``` 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"}' ``` 出力: ``` { "ContactChannelArn": "arn:aws:ssm-contacts:us-east-1:111122223333:contact-channel/akuam/02f506b9-ea5d-4764-af89-2daa793ff024" } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[連絡先](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateContactChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/create-contact-channel.html)」を参照してください。 ### `create-contact` 次のコード例は、`create-contact` を使用する方法を示しています。 **AWS CLI** **連絡先を作成するには** 次の `create-contact` の例では、空白のプランを使用して、環境内で連絡先を作成します。プランは、連絡先チャネルの作成後に更新できます。このコマンドの ARN を出力して create-contact-channel コマンドを使用します。この連絡先の連絡先チャネルを作成したら、update-contact を使用してプランを更新します。 ``` aws ssm-contacts create-contact \ --alias "akuam" \ --display-name "Akua Mansa" \ --type PERSONAL \ --plan '{"Stages": []}' ``` 出力: ``` { "ContactArn": "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam" } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[連絡先](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateContact](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/create-contact.html)」を参照してください。 ### `deactivate-contact-channel` 次のコード例は、`deactivate-contact-channel` を使用する方法を示しています。 **AWS CLI** **連絡先チャネルを無効にするには** 次の `deactivate-contact-channel` の例では、連絡先チャネルを無効にします。連絡先チャネルを無効にすると、インシデント中に連絡先チャネルがページングされなくなります。`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" ``` このコマンドでは何も出力されません。 詳細については、「*Incident Manager ユーザーガイド*」の「[連絡先](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeactivateContactChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/deactivate-contact-channel.html)」を参照してください。 ### `delete-contact-channel` 次のコード例は、`delete-contact-channel` を使用する方法を示しています。 **AWS CLI** **連絡先チャネルを削除するには** 次の `delete-contact-channel` の例では、連絡先チャネルを削除します。連絡先チャネルを削除すると、インシデント中に連絡先チャネルがページングされなくなります。 ``` 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" ``` このコマンドでは何も出力されません。 詳細については、「*Incident Manager ユーザーガイド*」の「[連絡先](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteContactChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/delete-contact-channel.html)」を参照してください。 ### `delete-contact` 次のコード例は、`delete-contact` を使用する方法を示しています。 **AWS CLI** **連絡先を削除するには** 次の `delete-contact` の例では、連絡先を削除します。連絡先を参照するエスカレーションプランから、連絡先にアクセスできなくなります。 ``` aws ssm-contacts delete-contact \ --contact-id "arn:aws:ssm-contacts:us-east-1:111122223333:contact/alejr" ``` このコマンドでは何も出力されません。 詳細については、「*Incident Manager ユーザーガイド*」の「[連絡先](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteContact](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/delete-contact.html)」を参照してください。 ### `describe-engagement` 次のコード例は、`describe-engagement` を使用する方法を示しています。 **AWS CLI** **エンゲージメントの詳細を記述するには** 次の `describe-engagement` の例では、連絡先またはエスカレーションプランへのエンゲージメントの詳細情報を一覧表示します。件名とコンテンツが連絡先チャネルに送信されます。 ``` aws ssm-contacts describe-engagement \ --engagement-id "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", "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" } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[連絡先](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEngagement](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/describe-engagement.html)」を参照してください。 ### `describe-page` 次のコード例は、`describe-page` を使用する方法を示しています。 **AWS CLI** **連絡先チャネルのページの詳細を一覧表示するには** 次の `describe-page` の例では、連絡先チャネルのページの詳細情報を一覧表示します。このページには、提供された件名とコンテンツが含まれます。 ``` aws ssm-contacts describe-page \ --page-id "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/ad0052bd-e606-498a-861b-25726292eb93" ``` 出力: ``` { "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" } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[連絡先](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribePage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/describe-page.html)」を参照してください。 ### `get-contact-channel` 次のコード例は、`get-contact-channel` を使用する方法を示しています。 **AWS CLI** **連絡先チャネルの詳細を一覧表示するには** 次の `get-contact-channel` の例では、連絡先チャネルの詳細情報を一覧表示します。 ``` 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" ``` 出力: ``` { "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" } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[連絡先](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetContactChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/get-contact-channel.html)」を参照してください。 ### `get-contact-policy` 次のコード例は、`get-contact-policy` を使用する方法を示しています。 **AWS CLI** **連絡先のリソースポリシーを一覧表示するには** 次の `get-contact-policy` の例では、指定された連絡先に関連付けられているリソースポリシーを一覧表示します。 ``` aws ssm-contacts get-contact-policy \ --contact-arn "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam" ``` 出力: ``` { "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/*\"]}]}" } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[共有連絡先と対応計画の操作](https://docs.aws.amazon.com/incident-manager/latest/userguide/sharing.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetContactPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/get-contact-policy.html)」を参照してください。 ### `get-contact` 次のコード例は、`get-contact` を使用する方法を示しています。 **AWS CLI** **例 1: 連絡先プランを記述するには** 次の `get-contact` の例では、連絡先を記述します。 ``` aws ssm-contacts get-contact \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam" ``` 出力: ``` { "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 } } ] } ] } } ``` **例 2: エスカレーションプランを記述するには** 次の `get-contact` の例では、エスカレーションプランを記述します。 ``` aws ssm-contacts get-contact \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/example_escalation" ``` 出力: ``` { "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 } } ] } ] } } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[連絡先](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetContact](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/get-contact.html)」を参照してください。 ### `list-contact-channels` 次のコード例は、`list-contact-channels` を使用する方法を示しています。 **AWS CLI** **連絡先の連絡先チャネルを一覧表示するには** 次の `list-contact-channels` の例では、指定された連絡先で使用可能な連絡先チャネルを一覧表示します。 ``` aws ssm-contacts list-contact-channels \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam" ``` 出力: ``` { [ { "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" } ] } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[連絡先](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListContactChannels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/list-contact-channels.html)」を参照してください。 ### `list-contacts` 次のコード例は、`list-contacts` を使用する方法を示しています。 **AWS CLI** **すべてのエスカレーションプランと連絡先を一覧表示するには** 次の `list-contacts` の例では、アカウントの連絡先とエスカレーションプランを一覧表示します。 ``` aws ssm-contacts list-contacts ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[連絡先](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListContacts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/list-contacts.html)」を参照してください。 ### `list-engagements` 次のコード例は、`list-engagements` を使用する方法を示しています。 **AWS CLI** **すべてのエンゲージメントを一覧表示するには** 次の `list-engagements` の例では、エスカレーションプランと連絡先へのエンゲージメントを一覧表示します。1 つのインシデントのエンゲージメントを表示することもできます。 ``` aws ssm-contacts list-engagements ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[連絡先](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListEngagements](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/list-engagements.html)」を参照してください。 ### `list-page-receipts` 次のコード例は、`list-page-receipts` を使用する方法を示しています。 **AWS CLI** **ページ受信を一覧表示するには** 次の `command-name` の例は、連絡先がページを受信したかどうかを一覧表示します。 ``` aws ssm-contacts list-page-receipts \ --page-id "arn:aws:ssm-contacts:us-east-2:111122223333:page/akuam/94ea0c7b-56d9-46c3-b84a-a37c8b067ad3" ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[連絡先](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPageReceipts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/list-page-receipts.html)」を参照してください。 ### `list-pages-by-contact` 次のコード例は、`list-pages-by-contact` を使用する方法を示しています。 **AWS CLI** **連絡先別にページを一覧表示するには** 次の `list-pages-by-contact` の例では、指定された連絡先へのすべてのページを一覧表示します。 ``` aws ssm-contacts list-pages-by-contact \ --contact-id "arn:aws:ssm-contacts:us-east-2:111122223333:contact/akuam" ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[連絡先](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListPagesByContact](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/list-pages-by-contact.html)」を参照してください。 ### `list-pages-by-engagement` 次のコード例は、`list-pages-by-engagement` を使用する方法を示しています。 **AWS CLI** **エンゲージメントから開始された連絡先チャネルのページを一覧表示するには** 次の `list-pages-by-engagement` の例は、定義されたエンゲージメントプランのエンゲージ中に発生したページを一覧表示します。 ``` aws ssm-contacts list-pages-by-engagement \ --engagement-id "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/78a29753-3674-4ac5-9f83-0468563567f0" ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[連絡先](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPagesByEngagement](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/list-pages-by-engagement.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **連絡先のタグを一覧表示するには** 次の `list-tags-for-resource` の例では、指定された連絡先のタグを一覧表示します。 ``` aws ssm-contacts list-tags-for-resource \ --resource-arn "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam" ``` 出力: ``` { "Tags": [ { "Key": "group1", "Value": "1" } ] } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[タグ付け](https://docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/list-tags-for-resource.html)」を参照してください。 ### `put-contact-policy` 次のコード例は、`put-contact-policy` を使用する方法を示しています。 **AWS CLI** **連絡先とエンゲージメントを共有するには** 次の `put-contact-policy` の例では、連絡先および関連するエンゲージメントをプリンシパルと共有するリソースポリシーを連絡先の Akua に追加します。 ``` 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\/*\"]}]}" ``` このコマンドでは何も出力されません。 詳細については、「*Incident Manager ユーザーガイド*」の「[共有連絡先と対応計画の操作](https://docs.aws.amazon.com/incident-manager/latest/userguide/sharing.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutContactPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/put-contact-policy.html)」を参照してください。 ### `send-activation-code` 次のコード例は、`send-activation-code` を使用する方法を示しています。 **AWS CLI** **アクティベーションコードを送信するには** 次の `send-activation-code` の例では、指定された連絡先チャネルにアクティベーションコードとメッセージを送信します。 ``` 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" ``` このコマンドでは何も出力されません。 詳細については、「*Incident Manager ユーザーガイド*」の「[連絡先](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SendActivationCode](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/send-activation-code.html)」を参照してください。 ### `start-engagement` 次のコード例は、`start-engagement` を使用する方法を示しています。 **AWS CLI** **例 1: 連絡先の連絡先チャネルをページングするには** 次の `start-engagement` では、連絡先の連絡先チャネルをページングします。送信者、サブジェクト、パブリックサブジェクト、パブリックコンテンツにはすべてフィールドがありません。Incident Manager は、提供された音声または E メールの連絡先チャネルに件名とコンテンツを送信します。Incident Manager は、提供された SMS の連絡先チャネルにパブリックサブジェクトとパブリックコンテンツを送信します。送信者を使用して、エンゲージメントを開始したユーザーを追跡します。 ``` 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" ``` 出力: ``` { "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/akuam/607ced0e-e8fa-4ea7-8958-a237b8803f8f" } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[連絡先](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)」を参照してください。 **例 2: 指定されたエスカレーションプランの連絡先をページングするには** 次の `start-engagement` は、エスカレーションプランを通じて連絡先をエンゲージします。各連絡先は、エンゲージメントプランに従ってページングされます。 ``` 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" ``` 出力: ``` { "EngagementArn": "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356" } ``` 詳細については、「*Incident Manager ユーザーガイド*」の「[連絡先](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartEngagement](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/start-engagement.html)」を参照してください。 ### `stop-engagement` 次のコード例は、`stop-engagement` を使用する方法を示しています。 **AWS CLI** **エンゲージメントを停止するには** 次の `stop-engagement` の例では、エンゲージメントによる連絡先と連絡先チャネルのさらなるページングを停止します。 ``` aws ssm-contacts stop-engagement \ --engagement-id "arn:aws:ssm-contacts:us-east-2:111122223333:engagement/example_escalation/69e40ce1-8dbb-4d57-8962-5fbe7fc53356" ``` このコマンドでは何も出力されません。 詳細については、「*Incident Manager ユーザーガイド*」の「[連絡先](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopEngagement](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/stop-engagement.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **連絡先にタグを付けるには** 次の `tag-resource` の例では、指定された連絡先に指定されたタグキーと値のペアをタグ付けします。 ``` aws ssm-contacts tag-resource \ --resource-arn "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam" \ --tags '[{"Key":"group1","Value":"1"}]' ``` このコマンドでは何も出力されません。 詳細については、「*Incident Manager ユーザーガイド*」の「[タグ付け](https://docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンス**の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **連絡先からタグを削除するには** 次の `untag-resource` の例では、指定された連絡先から group1 タグを削除します。 ``` aws ssm-contacts untag-resource \ --resource-arn "arn:aws:ssm-contacts:us-east-1:111122223333:contact/akuam" \ --tag-keys "group1" ``` このコマンドでは何も出力されません。 詳細については、「*Incident Manager ユーザーガイド*」の「[タグ付け](https://docs.aws.amazon.com/incident-manager/latest/userguide/tagging.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/untag-resource.html)」を参照してください。 ### `update-contact-channel` 次のコード例は、`update-contact-channel` を使用する方法を示しています。 **AWS CLI** **連絡先チャネルを更新するには** 次の `update-contact-channel` の例では、連絡先チャネルの名前と配信アドレスを更新します。 ``` 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"}' ``` このコマンドでは何も出力されません。 詳細については、「*Incident Manager ユーザーガイド*」の「[連絡先](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateContactChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/update-contact-channel.html)」を参照してください。 ### `update-contact` 次のコード例は、`update-contact` を使用する方法を示しています。 **AWS CLI** **連絡先のエンゲージメントプランを更新するには** 次の `update-contact` の例では、連絡先 Akua のエンゲージメントプランを更新して、3 種類の連絡先チャネルを含めます。これは、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 }}]}]}' ``` このコマンドでは何も出力されません。 詳細については、「*Incident Manager ユーザーガイド*」の「[連絡先](https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateContact](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ssm-contacts/update-contact.html)」を参照してください。 # AWS CLI を使用した Amazon Inspector の例 次のコード例は、Amazon Inspector で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `add-attributes-to-findings` 次のコード例は、`add-attributes-to-findings` を使用する方法を示しています。 **AWS CLI** **検出結果に属性を追加するには** 次の `add-attribute-to-finding` のコマンドは、`Example` のキーと `example` の値を持つ属性を、`arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-8l1VIE0D/run/0-Z02cjjug/finding/0-T8yM9mEU` の ARN を持つ検出結果に割り当てます。 ``` 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 ``` 出力: ``` { "failedItems": {} } ``` 詳細については、*Amazon Inspector* ガイドの「Amazon Inspector の検出結果」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddAttributesToFindings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/add-attributes-to-findings.html)」を参照してください。 ### `associate-member` 次のコード例は、`associate-member` を使用する方法を示しています。 **AWS CLI** **例: AWS アカウントを Amazon Inspector 委任管理者に関連付けるには** 次の `associate-member` の例では、AWS アカウントを Amazon Inspector の委任管理者に関連付けます。 ``` aws inspector2 associate-member \ --account-id 123456789012 ``` 出力: ``` { "accountId": "123456789012" } ``` 詳細については、* Amazon Inspector ユーザーガイド*の「[AWS Organizations を使用して Amazon Inspector での複数アカウントを管理する](https://docs.aws.amazon.com/inspector/latest/user/managing-multiple-accounts.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[AssociateMember](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/associate-member.html)」を参照してください。 ### `create-assessment-target` 次のコード例は、`create-assessment-target` を使用する方法を示しています。 **AWS CLI** **評価ターゲットを作成するには** 次の `create-assessment-target` のコマンドは、ARN が `arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-AB6DMKnv` のリソースグループを使用して、`ExampleAssessmentTarget` という名前の評価ターゲットを作成します。 ``` aws inspector create-assessment-target --assessment-target-name ExampleAssessmentTarget --resource-group-arn arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-AB6DMKnv ``` 出力: ``` { "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX" } ``` 詳細については、*Amazon Inspector* ガイドの 「Amazon Inspector 評価ターゲット」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateAssessmentTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/create-assessment-target.html)」を参照してください。 ### `create-assessment-template` 次のコード例は、`create-assessment-template` を使用する方法を示しています。 **AWS CLI** **評価ターゲットテンプレートを作成するには** 次の `create-assessment-template` のコマンドは、ARN が `arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX` の評価ターゲットに `ExampleAssessmentTemplate` という評価テンプレートを作成します。 ``` 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 ``` 出力: ``` { "assessmentTemplateArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T" } ``` 詳細については、*Amazon Inspector* ガイドの 「Amazon Inspector 評価テンプレートと評価実行」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateAssessmentTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/create-assessment-template.html)」を参照してください。 ### `create-filter` 次のコード例は、`create-filter` を使用する方法を示しています。 **AWS CLI** **フィルタを作成するには** 次の `create-filter` の例では、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"}]' ``` 出力: ``` { "arn": "arn:aws:inspector2:us-west-2:123456789012:owner/o-EXAMPLE222/filter/EXAMPLE444444444" } ``` 詳細については、「*Amazon Inspector ユーザーガイド*」の「[Amazon Inspector の検出結果のフィルタリング](https://docs.aws.amazon.com/inspector/latest/user/findings-managing-filtering.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateFilter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/create-filter.html)」を参照してください。 ### `create-findings-report` 次のコード例は、`create-findings-report` を使用する方法を示しています。 **AWS CLI** **検出結果レポートを作成するには** 次の `create-findings-report` の例では、検出結果レポートを作成します。 ``` 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"}]}' ``` 出力: ``` { "reportId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333" } ``` 詳細については、「*Amazon Inspector ユーザーガイド*」の「[Amazon Inspector での検出結果の管理](https://docs.aws.amazon.com/inspector/latest/user/findings-managing.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateFindingsReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/create-findings-report.html)」を参照してください。 ### `create-resource-group` 次のコード例は、`create-resource-group` を使用する方法を示しています。 **AWS CLI** **リソースグループを作成するには** 次の `create-resource-group` のコマンドは、`Name` のタグキーと `example` の値を使用してリソースグループを作成します。 ``` aws inspector create-resource-group --resource-group-tags key=Name,value=example ``` 出力: ``` { "resourceGroupArn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-AB6DMKnv" } ``` 詳細については、「*Amazon Inspector* ガイド」の「Amazon Inspector 評価ターゲット」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateResourceGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/create-resource-group.html)」を参照してください。 ### `create-sbom-export` 次のコード例は、`create-sbom-export` を使用する方法を示しています。 **AWS CLI** **ソフトウェア部品表 (SBOM) レポートを作成するには** 次の `create-sbom-export` の例では、ソフトウェア部品表 (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 ``` 出力: ``` { "reportId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333" } ``` 詳細については、「*Amazon Inspector ユーザーガイド*」の「[Amazon Inspector による SBOM のエクスポート](https://docs.aws.amazon.com/inspector/latest/user/sbom-export.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドレットリファレンス*」の「[CreateSbomExport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/create-sbom-export.html)」を参照してください。 ### `delete-assessment-run` 次のコード例は、`delete-assessment-run` を使用する方法を示しています。 **AWS CLI** **評価実行を削除するには** 次の `delete-assessment-run` のコマンドは、ARN が `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 ``` 詳細については、*Amazon Inspector* ガイドの「Amazon Inspector 評価テンプレートと評価実行」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAssessmentRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/delete-assessment-run.html)」を参照してください。 ### `delete-assessment-target` 次のコード例は、`delete-assessment-target` を使用する方法を示しています。 **AWS CLI** **評価ターゲットを削除するには** 次の `delete-assessment-target` のコマンドは、ARN が `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 ``` 詳細については、「*Amazon Inspector* ガイド」の「Amazon Inspector 評価ターゲット」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAssessmentTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/delete-assessment-target.html)」を参照してください。 ### `delete-assessment-template` 次のコード例は、`delete-assessment-template` を使用する方法を示しています。 **AWS CLI** **評価テンプレートを削除するには** 次の `delete-assessment-template` のコマンドは、ARN が `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 ``` 詳細については、*Amazon Inspector* ガイドの 「Amazon Inspector 評価テンプレートと評価実行」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAssessmentTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/delete-assessment-template.html)」を参照してください。 ### `delete-filter` 次のコード例は、`delete-filter` を使用する方法を示しています。 **AWS CLI** **フィルターを削除するには** 次の `delete-filter` の例は、フィルターを削除します。 ``` aws inspector2 delete-filter \ --arn "arn:aws:inspector2:us-west-2:123456789012:owner/o-EXAMPLE222/filter/EXAMPLE444444444" ``` 出力: ``` { "arn": "arn:aws:inspector2:us-west-2:123456789012:owner/o-EXAMPLE222/filter/EXAMPLE444444444" } ``` 詳細については、「*Amazon Inspector ユーザーガイド*」の「[Amazon Inspector の検出結果のフィルタリング](https://docs.aws.amazon.com/inspector/latest/user/findings-managing-filtering.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteFilter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/delete-filter.html)」を参照してください。 ### `describe-assessment-runs` 次のコード例は、`describe-assessment-runs` を使用する方法を示しています。 **AWS CLI** **評価実行を記述するには** 次の `describe-assessment-run` のコマンドは、`arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE` の ARN を使用した評価実行について説明します。 ``` aws inspector describe-assessment-runs --assessment-run-arns arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE ``` 出力: ``` { "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": {} } ``` 詳細については、*Amazon Inspector* ガイドの 「Amazon Inspector 評価テンプレートと評価実行」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAssessmentRuns](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/describe-assessment-runs.html)」を参照してください。 ### `describe-assessment-targets` 次のコード例は、`describe-assessment-targets` を使用する方法を示しています。 **AWS CLI** **評価ターゲットを記述するには** 次の `describe-assessment-targets` のコマンドは、ARN が `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 ``` 出力: ``` { "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": {} } ``` 詳細については、「*Amazon Inspector* ガイド」の「Amazon Inspector 評価ターゲット」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAssessmentTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/describe-assessment-targets.html)」を参照してください。 ### `describe-assessment-templates` 次のコード例は、`describe-assessment-templates` を使用する方法を示しています。 **AWS CLI** **評価テンプレートを記述するには** 次の `describe-assessment-templates` のコマンドは、ARN が `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 ``` 出力: ``` { "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": {} } ``` 詳細については、*Amazon Inspector* ガイドの 「Amazon Inspector 評価テンプレートと評価実行」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAssessmentTemplates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/describe-assessment-templates.html)」を参照してください。 ### `describe-cross-account-access-role` 次のコード例は、`describe-cross-account-access-role` を使用する方法を示しています。 **AWS CLI** **クロスアカウントアクセスロールを記述するには** 次の `describe-cross-account-access-role` コマンドは、Amazon Inspector の AWS アカウントへのアクセスを可能にする IAM ロールを記述します。 ``` aws inspector describe-cross-account-access-role ``` 出力: ``` { "registeredAt": 1458069182.826, "roleArn": "arn:aws:iam::123456789012:role/inspector", "valid": true } ``` 詳細については、「*Amazon Inspector* ガイド」の「Amazon Inspector のセットアップ」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeCrossAccountAccessRole](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/describe-cross-account-access-role.html)」を参照してください。 ### `describe-findings` 次のコード例は、`describe-findings` を使用する方法を示しています。 **AWS CLI** **検出結果を記述するには** 次の `describe-findings` のコマンドは、`arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4` の ARN を持つ検出結果を記述します。 ``` 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 ``` 出力: ``` { "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": [] } ] } ``` 詳細については、*Amazon Inspector* ガイドの「Amazon Inspector の検出結果」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeFindings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/describe-findings.html)」を参照してください。 ### `describe-resource-groups` 次のコード例は、`describe-resource-groups` を使用する方法を示しています。 **AWS CLI** **リソースグループを記述するには** 次の`describe-resource-groups`コマンドは、ARN が `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 ``` 出力: ``` { "failedItems": {}, "resourceGroups": [ { "arn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI", "createdAt": 1458074191.098, "tags": [ { "key": "Name", "value": "example" } ] } ] } ``` 詳細については、「*Amazon Inspector* ガイド」の「Amazon Inspector 評価ターゲット」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeResourceGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/describe-resource-groups.html)」を参照してください。 ### `describe-rules-packages` 次のコード例は、`describe-rules-packages` を使用する方法を示しています。 **AWS CLI** **ルールパッケージを記述するには** 次の `describe-rules-packages` のコマンドは、`arn:aws:inspector:us-west-2:758058086616:rulespackage/0-9hgA516p` の ARN を持つルールパッケージを記述します。 ``` aws inspector describe-rules-packages --rules-package-arns arn:aws:inspector:us-west-2:758058086616:rulespackage/0-9hgA516p ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Inspector* ガイド」の「Amazon Inspector ルールパッケージとルール」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeRulesPackages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/describe-rules-packages.html)」を参照してください。 ### `disassociate-member` 次のコード例は、`disassociate-member` を使用する方法を示しています。 **AWS CLI** **例: メンバーアカウントを Amazon Inspector 委任管理者から関連付け解除するには** 次の `disassociate-member` の例では、AWS アカウントを Amazon Inspector 委任管理者から関連付け解除します。 ``` aws inspector2 disassociate-member \ --account-id 123456789012 ``` 出力: ``` { "accountId": "123456789012" } ``` 詳細については、* Amazon Inspector ユーザーガイド*の「[AWS Organizations を使用して Amazon Inspector での複数アカウントを管理する](https://docs.aws.amazon.com/inspector/latest/user/managing-multiple-accounts.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DisassociateMember](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/disassociate-member.html)」を参照してください。 ### `get-configuration` 次のコード例は、`get-configuration` を使用する方法を示しています。 **AWS CLI** **Inspector スキャンの設定を取得するには** 次の `get-configuration` の例では、Inspector スキャンの設定を取得します。 ``` aws inspector2 get-configuration ``` 出力: ``` { "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" } } } ``` 詳細については、「*Amazon Inspector ユーザーガイド*」の「[Amazon Inspector による自動リソーススキャン](https://docs.aws.amazon.com/inspector/latest/user/scanning-resources.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/get-configuration.html)」を参照してください。 ### `get-member` 次のコード例は、`get-member` を使用する方法を示しています。 **AWS CLI** **例: 組織のメンバー情報を取得するには** aws inspector2 get-member --account-id 123456789012 出力: ``` { "member": { "accountId": "123456789012", "delegatedAdminAccountId": "123456789012", "relationshipStatus": "ENABLED", "updatedAt": "2023-09-11T09:57:20.520000-07:00" } } ``` 詳細については、* Amazon Inspector ユーザーガイド*の「[AWS Organizations を使用して Amazon Inspector での複数アカウントを管理する](https://docs.aws.amazon.com/inspector/latest/user/managing-multiple-accounts.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[GetMember](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/get-member.html)」を参照してください。 ### `get-telemetry-metadata` 次のコード例は、`get-telemetry-metadata` を使用する方法を示しています。 **AWS CLI** **テレメトリメタデータを取得するには** 次の `get-telemetry-metadata` のコマンドは、ARN が `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 ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetTelemetryMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/get-telemetry-metadata.html)」を参照してください。 ### `list-account-permissions` 次のコード例は、`list-account-permissions` を使用する方法を示しています。 **AWS CLI** **アカウントのアクセス許可を一覧表示するには** 次の `list-account-permissions` の例では、アカウントのアクセス許可を一覧表示します。 ``` aws inspector2 list-account-permissions ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Inspector ユーザーガイド*」の「[Amazon Inspector のアイデンティティとアクセス管理](https://docs.aws.amazon.com/inspector/latest/user/security-iam.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAccountPermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/list-account-permissions.html)」を参照してください。 ### `list-assessment-run-agents` 次のコード例は、`list-assessment-run-agents` を使用する方法を示しています。 **AWS CLI** **評価実行のエージェントを一覧表示するには** 次の `list-assessment-run-agents` のコマンドは、指定された ARN を持つ評価実行のエージェントを一覧表示します。 ``` 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 ``` 出力: ``` { "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" } ] } ] } ``` 詳細については、「*Amazon Inspector ユーザーガイド*」の「[AWS エージェント](https://docs.aws.amazon.com/inspector/latest/userguide/inspector_agents.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAssessmentRunAgents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/list-assessment-run-agents.html)」を参照してください。 ### `list-assessment-runs` 次のコード例は、`list-assessment-runs` を使用する方法を示しています。 **AWS CLI** **評価実行を一覧表示するには** 次の `list-assessment-runs` のコマンドは、既存のすべての評価実行を一覧表示します。 ``` aws inspector list-assessment-runs ``` 出力: ``` { "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" ] } ``` 詳細については、「*Amazon Inspector ユーザーガイド*」の「[Amazon Inspector 評価テンプレートと評価実行](https://docs.aws.amazon.com/inspector/latest/userguide/inspector_assessments.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAssessmentRuns](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/list-assessment-runs.html)」を参照してください。 ### `list-assessment-targets` 次のコード例は、`list-assessment-targets` を使用する方法を示しています。 **AWS CLI** **評価ターゲットを一覧表示するには** 次の `list-assessment-targets` のコマンドは、既存のすべての評価ターゲットを一覧表示します。 ``` aws inspector list-assessment-targets ``` 出力: ``` { "assessmentTargetArns": [ "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq" ] } ``` 詳細については、「*Amazon Inspector* ガイド」の「Amazon Inspector 評価ターゲット」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAssessmentTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/list-assessment-targets.html)」を参照してください。 ### `list-assessment-templates` 次のコード例は、`list-assessment-templates` を使用する方法を示しています。 **AWS CLI** **評価テンプレートを一覧表示するには** 次の `list-assessment-templates` のコマンドは、既存のすべての評価テンプレートを一覧表示します。 ``` aws inspector list-assessment-templates ``` 出力: ``` { "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" ] } ``` 詳細については、*Amazon Inspector* ガイドの「Amazon Inspector 評価テンプレートと評価実行」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAssessmentTemplates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/list-assessment-templates.html)」を参照してください。 ### `list-coverage-statistics` 次のコード例は、`list-coverage-statistics` を使用する方法を示しています。 **AWS CLI** **例 1: グループ別にカバレッジ統計を一覧表示するには** 次の `list-coverage-statistics` の例では、AWS 環境のカバレッジ統計をグループ別に一覧表示します。 ``` aws inspector2 list-coverage-statistics \ --group-by RESOURCE_TYPE ``` 出力: ``` { "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 } ``` 詳細については、「*Amazon Inspector ユーザーガイド*」の「[AWS 環境の Amazon Inspector カバレッジの評価](https://docs.aws.amazon.com/inspector/latest/user/assessing-coverage.html)」を参照してください。 **例 2: リソースタイプ別にカバレッジ統計を一覧表示するには** 次の `list-coverage-statistics` の例では、AWS 環境のカバレッジ統計をリソースタイプ別に一覧表示します。 ``` aws inspector2 list-coverage-statistics --filter-criteria '{"resourceType":[{"comparison":"EQUALS","value":"AWS_ECR_REPOSITORY"}]}' --group-by SCAN_STATUS_REASON ``` 出力: ``` { "countsByGroup": [ { "count": 27, "groupKey": "SUCCESSFUL" } ], "totalCounts": 27 } ``` 詳細については、「*Amazon Inspector ユーザーガイド*」の「[AWS 環境の Amazon Inspector カバレッジの評価](https://docs.aws.amazon.com/inspector/latest/user/assessing-coverage.html)」を参照してください。 **例 3: ECR リポジトリ名別にカバレッジ統計を一覧表示するには** 次の `list-coverage-statistics` の例では、AWS 環境のカバレッジ統計をリポジトリ名別に一覧表示します。 ``` aws inspector2 list-coverage-statistics --filter-criteria '{"ecrRepositoryName":[{"comparison":"EQUALS","value":"debian"}]}' --group-by SCAN_STATUS_REASON ``` 出力: ``` { "countsByGroup": [ { "count": 3, "groupKey": "SUCCESSFUL" } ], "totalCounts": 3 } ``` 詳細については、「*Amazon Inspector ユーザーガイド*」の「[AWS 環境の Amazon Inspector カバレッジの評価](https://docs.aws.amazon.com/inspector/latest/user/assessing-coverage.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListCoverageStatistics](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/list-coverage-statistics.html)」を参照してください。 ### `list-coverage` 次のコード例は、`list-coverage` を使用する方法を示しています。 **AWS CLI** **例 1: 環境に関するカバレッジの詳細を一覧表示するには** 次の `list-coverage` の例では、環境のカバレッジの詳細を一覧表示します。 ``` aws inspector2 list-coverage ``` 出力: ``` { "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" } ] } ``` **例 2: Lambda 関数リソースタイプに関するカバレッジの詳細を一覧表示するには** 次の `list-coverage` の例では、Lambda 関数のリソースタイプの詳細を一覧表示します。 ``` aws inspector2 list-coverage --filter-criteria '{"resourceType":[{"comparison":"EQUALS","value":"AWS_LAMBDA_FUNCTION"}]}' ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListCoverage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/list-coverage.html)」を参照してください。 ### `list-delegated-admin-accounts` 次のコード例は、`list-delegated-admin-accounts` を使用する方法を示しています。 **AWS CLI** **組織の委任管理者アカウントに関する情報を一覧表示するには** 次の `list-delegated-admin-accounts` の例は、組織の委任管理者アカウントに関する情報を示しています。 ``` aws inspector2 list-delegated-admin-accounts ``` 出力: ``` { "delegatedAdminAccounts": [ { "accountId": "123456789012", "status": "ENABLED" } ] } ``` 詳細については、「*Amazon Inspector ユーザーガイド*」の「[Amazon Inspector の委任管理者の指定](https://docs.aws.amazon.com/inspector/latest/user/admin-member-relationship.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDelegatedAdminAccounts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/list-delegated-admin-accounts.html)」を参照してください。 ### `list-event-subscriptions` 次のコード例は、`list-event-subscriptions` を使用する方法を示しています。 **AWS CLI** **イベントサブスクリプションを一覧表示するには** 次の `list-event-subscriptions` のコマンドは、ARN が `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 ``` 出力: ``` { "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" } ] } ``` 詳細については、*Amazon Inspector* ガイドの 「Amazon Inspector 評価テンプレートと評価実行」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListEventSubscriptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/list-event-subscriptions.html)」を参照してください。 ### `list-filters` 次のコード例は、`list-filters` を使用する方法を示しています。 **AWS CLI** **Amazon Inspector のアクティブ化に使用したアカウントに関連付けられたフィルターを一覧表示するには** 次の `list-filters` の例では、Amazon Inspector のアクティブ化に使用したアカウントに関連付けられたフィルターを一覧表示します。 ``` aws inspector2 list-filters ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Inspector ユーザーガイド*」の「[Amazon Inspector の検出結果のフィルタリング](https://docs.aws.amazon.com/inspector/latest/user/findings-managing-filtering.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListFilters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/list-filters.html)」を参照してください。 ### `list-findings` 次のコード例は、`list-findings` を使用する方法を示しています。 **AWS CLI** **検出結果を一覧表示するには** 次の `list-findings` のコマンドは、生成されたすべての検出結果を一覧表示します。 ``` aws inspector list-findings ``` 出力: ``` { "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" ] } ``` 詳細については、*Amazon Inspector* ガイドの「Amazon Inspector の検出結果」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListFindings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/list-findings.html)」を参照してください。 ### `list-members` 次のコード例は、`list-members` を使用する方法を示しています。 **AWS CLI** **例 1: 組織の Amazon Inspector 委任管理者に関連付けられているすべてのメンバーアカウントを一覧表示するには** aws inspector2 list-members --only-associated 出力: ``` { { "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" } ] } ``` 詳細については、* Amazon Inspector ユーザーガイド*の「[AWS Organizations を使用して Amazon Inspector での複数アカウントを管理する](https://docs.aws.amazon.com/inspector/latest/user/managing-multiple-accounts.html)」を参照してください。 **例 2: 組織の Amazon Inspector 委任管理者に対して、関連付けられているメンバーアカウントと、関連付けが解除されたメンバーアカウントをすべて一覧表示するには** aws inspector2 list-members --no-only-associated 出力: ``` { { "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" } ] } ``` 詳細については、* Amazon Inspector ユーザーガイド*の「[AWS Organizations を使用して Amazon Inspector での複数アカウントを管理する](https://docs.aws.amazon.com/inspector/latest/user/managing-multiple-accounts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListMembers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/list-members.html)」を参照してください。 ### `list-rules-packages` 次のコード例は、`list-rules-packages` を使用する方法を示しています。 **AWS CLI** **ルールパッケージを一覧表示するには** 次の `list-rules-packages` のコマンドは、使用可能なすべての Inspector ルールパッケージを一覧表示します。 ``` aws inspector list-rules-packages ``` 出力: ``` { "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" ] } ``` 詳細については、「*Amazon Inspector* ガイド」の「Amazon Inspector ルールパッケージとルール」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRulesPackages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/list-rules-packages.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **リソースのタグを一覧表示するには** 次の `list-tags-for-resource` のコマンドは、`arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-gcwFliYu` の ARN を持つ評価テンプレートに関連付けられたすべてのタグを一覧表示します。 ``` aws inspector list-tags-for-resource --resource-arn arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-gcwFliYu ``` 出力: ``` { "tags": [ { "key": "Name", "value": "Example" } ] } ``` 詳細については、*Amazon Inspector* ガイドの 「Amazon Inspector 評価テンプレートと評価実行」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/list-tags-for-resource.html)」を参照してください。 ### `list-usage-totals` 次のコード例は、`list-usage-totals` を使用する方法を示しています。 **AWS CLI** **過去 30 日間の使用状況の合計を一覧表示するには** 次の `list-usage-totals` の例では、過去 30 日間の使用状況の合計を一覧表示します。 ``` aws inspector2 list-usage-totals ``` 出力: ``` { "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" } ] } ] } ``` 詳細については、「*Amazon Inspector ユーザーガイド*」の「[Amazon Inspector での使用状況とコストのモニタリング](https://docs.aws.amazon.com/inspector/latest/user/usage.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListUsageTotals](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/list-usage-totals.html)」を参照してください。 ### `preview-agents` 次のコード例は、`preview-agents` を使用する方法を示しています。 **AWS CLI** **エージェントをプレビューするには** 次の `preview-agents` のコマンドは、ARN が `arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq` の評価ターゲットの一部である EC2 インスタンスにインストールされたエージェントをプレビューします。 ``` aws inspector preview-agents --preview-agents-arn arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq ``` 出力: ``` { "agentPreviews": [ { "agentId": "i-49113b93" } ] } ``` 詳細については、「*Amazon Inspector* ガイド」の「Amazon Inspector 評価ターゲット」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PreviewAgents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/preview-agents.html)」を参照してください。 ### `register-cross-account-access-role` 次のコード例は、`register-cross-account-access-role` を使用する方法を示しています。 **AWS CLI** **クロスアカウントアクセスロールを登録するには** 次の `register-cross-account-access-role` コマンドは、評価実行の開始時または preview-agents コマンドを呼び出す際に Amazon Inspector が EC2 インスタンスを一覧表示するのに使用する ARN が `arn:aws:iam::123456789012:role/inspector` の IAM ロールを登録します。 ``` aws inspector register-cross-account-access-role --role-arn arn:aws:iam::123456789012:role/inspector ``` 詳細については、「*Amazon Inspector* ガイド」の「Amazon Inspector のセットアップ」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegisterCrossAccountAccessRole](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/register-cross-account-access-role.html)」を参照してください。 ### `remove-attributes-from-findings` 次のコード例は、`remove-attributes-from-findings` を使用する方法を示しています。 **AWS CLI** **検出結果から属性を削除するには** 次の `remove-attributes-from-finding` のコマンドは、ARN が `arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-8l1VIE0D/run/0-Z02cjjug/finding/0-T8yM9mEU` の検出結果から、キー が `Example` で値が `example` の属性を削除します。 ``` 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 ``` 出力: ``` { "failedItems": {} } ``` 詳細については、*Amazon Inspector* ガイドの「Amazon Inspector の検出結果」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveAttributesFromFindings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/remove-attributes-from-findings.html)」を参照してください。 ### `set-tags-for-resource` 次のコード例は、`set-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **リソースのタグを設定するには** 次の `set-tags-for-resource` のコマンドは、キーが `Example` で値が `example` のタグを ARN が `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 ``` 詳細については、*Amazon Inspector* ガイドの 「Amazon Inspector 評価テンプレートと評価実行」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/set-tags-for-resource.html)」を参照してください。 ### `start-assessment-run` 次のコード例は、`start-assessment-run` を使用する方法を示しています。 **AWS CLI** **評価実行を開始するには** 次の `start-assessment-run` のコマンドは、ARN が `arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T` の評価テンプレートを使用して、`examplerun` という名前の評価実行を開始します。 ``` 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 ``` 出力: ``` { "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-jOoroxyY" } ``` 詳細については、*Amazon Inspector* ガイドの 「Amazon Inspector 評価テンプレートと評価実行」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartAssessmentRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/start-assessment-run.html)」を参照してください。 ### `stop-assessment-run` 次のコード例は、`stop-assessment-run` を使用する方法を示しています。 **AWS CLI** **評価実行を停止するには** 次の `stop-assessment-run` のコマンドは、ARN が `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 ``` 詳細については、*Amazon Inspector* ガイドの 「Amazon Inspector 評価テンプレートと評価実行」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopAssessmentRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/stop-assessment-run.html)」を参照してください。 ### `subscribe-to-event` 次のコード例は、`subscribe-to-event` を使用する方法を示しています。 **AWS CLI** **イベントをサブスクライブするには** 次の例では、`ASSESSMENT_RUN_COMPLETED` イベントに関する Amazon SNS 通知を ARN が `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 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Inspector* ガイド」の「[Amazon Inspector 評価テンプレートと評価実行](https://docs.aws.amazon.com/inspector/latest/userguide/inspector_assessments.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SubscribeToEvent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/subscribe-to-event.html)」を参照してください。 ### `unsubscribe-from-event` 次のコード例は、`unsubscribe-from-event` を使用する方法を示しています。 **AWS CLI** **イベントからサブスクライブを解除するには** 次の `unsubscribe-from-event` コマンドは、`ASSESSMENT_RUN_COMPLETED` イベントに関する Amazon SNS 通知を ARN が `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 ``` 詳細については、*Amazon Inspector* ガイドの 「Amazon Inspector 評価テンプレートと評価実行」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UnsubscribeFromEvent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/unsubscribe-from-event.html)」を参照してください。 ### `update-assessment-target` 次のコード例は、`update-assessment-target` を使用する方法を示しています。 **AWS CLI** **評価ターゲットを更新するには** 次の `update-assessment-target` のコマンドは、ARN が `arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX` で名前が `Example` の評価ターゲットと ARN が `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 ``` 詳細については、「*Amazon Inspector* ガイド」の「Amazon Inspector 評価ターゲット」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateAssessmentTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector/update-assessment-target.html)」を参照してください。 ### `update-filter` 次のコード例は、`update-filter` を使用する方法を示しています。 **AWS CLI** **フィルタを更新するには** 次の `update-filter` の例では、ECR インスタンスの検出結果の代わりに Lambda の検出結果を省略するようにフィルターを更新します。 ``` 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" ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Inspector ユーザーガイド*」の「[Amazon Inspector での検出結果の管理](https://docs.aws.amazon.com/inspector/latest/user/findings-managing.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateFilter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/inspector2/update-filter.html)」を参照してください。 # AWS IoT examples using AWS CLI 次のコード例では、AWS IoT で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `accept-certificate-transfer` 次のコード例は、`accept-certificate-transfer` を使用する方法を示しています。 **AWS CLI** **別の AWS アカウントから転送されたデバイス証明書を受け入れるには** 次の `accept-certificate-transfer` の例では、別の AWS アカウントから転送されたデバイス証明書を受け入れます。証明書は ID で識別されます。 ``` aws iot accept-certificate-transfer \ --certificate-id 488b6a7f2acdeb00a77384e63c4e40b18bEXAMPLEe57b7272ba44c45e3448142 ``` このコマンドでは、出力が生成されません。 詳細については、「*AWSIoT Core デベロッパーガイド*」の「[証明書を別のアカウントに転送する](https://docs.aws.amazon.com/iot/latest/developerguide/transfer-cert.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AcceptCertificateTransfer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/accept-certificate-transfer.html)」を参照してください。 ### `add-thing-to-billing-group` 次のコード例は、`add-thing-to-billing-group` を使用する方法を示しています。 **AWS CLI** **例 1: 請求グループにモノを名前で追加するには** 次の `add-thing-to-billing-group` の例では、`MyLightBulb` という名前のモノを `GroupOne` という名前の請求グループに追加します。 ``` aws iot add-thing-to-billing-group \ --billing-group-name GroupOne \ --thing-name MyLightBulb ``` このコマンドでは何も出力されません。 **例 2: 請求グループに ARN でモノを追加するには** 次の `add-thing-to-billing-group` の例では、指定された ARN を持つモノを、指定された ARN を持つ請求グループに追加します。ARN の指定は、複数の AWS リージョンまたはアカウントを操作する場合に役立ちます。これにより、適切なリージョンとアカウントに追加できます。 ``` 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" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[請求グループ](https://docs.aws.amazon.com/iot/latest/developerguide/tagging-iot-billing-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddThingToBillingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/add-thing-to-billing-group.html)」を参照してください。 ### `add-thing-to-thing-group` 次のコード例は、`add-thing-to-thing-group` を使用する方法を示しています。 **AWS CLI** **モノをグループに追加するには** 次の `add-thing-to-thing-group` の例では、指定されたモノを指定されたモノグループに追加します。 ``` aws iot add-thing-to-thing-group \ --thing-name MyLightBulb \ --thing-group-name LightBulbs ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[モノのグループ](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddThingToThingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/add-thing-to-thing-group.html)」を参照してください。 ### `associate-targets-with-job` 次のコード例は、`associate-targets-with-job` を使用する方法を示しています。 **AWS CLI** **モノのグループを連続ジョブに関連付けるには** 次の `associate-targets-with-job` の例では、指定されたモノのグループを指定された連続ジョブに関連付けます。 ``` aws iot associate-targets-with-job \ --targets "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" \ --job-id "example-job-04" ``` 出力: ``` { "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-04", "jobId": "example-job-04", "description": "example continuous job" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[ジョブ (CLI) の作成と管理](https://docs.aws.amazon.com/iot/latest/developerguide/manage-job-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateTargetsWithJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/associate-targets-with-job.html)」を参照してください。 ### `attach-policy` 次のコード例は、`attach-policy` を使用する方法を示しています。 **AWS CLI** **例 1: モノのグループにポリシーをアタッチするには** 次の `attach-policy` の例では、指定されたポリシーを ARN で識別されるモノのグループにアタッチします。 ``` aws iot attach-policy \ --target "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" \ --policy-name "UpdateDeviceCertPolicy" ``` このコマンドでは、出力が生成されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[モノのグループ](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html)」を参照してください。 **例 2: ポリシーを証明書にアタッチするには** 次の `attach-policy` の例では、証明書で指定されたプリンシパルにポリシー `UpdateDeviceCertPolicy` をアタッチします。 ``` aws iot attach-policy \ --policy-name UpdateDeviceCertPolicy \ --target "arn:aws:iot:us-west-2:123456789012:cert/4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e" ``` このコマンドでは、出力が生成されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT ポリシーをデバイス証明書にアタッチする](https://docs.aws.amazon.com/iot/latest/developerguide/attach-policy-to-certificate.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[AttachPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/attach-policy.html)」を参照してください。** ### `attach-security-profile` 次のコード例は、`attach-security-profile` を使用する方法を示しています。 **AWS CLI** **セキュリティプロファイルをすべての未登録のデバイスに関連付けるには** 次の `attach-security-profile` の例では、`Testprofile` という名前の AWS IoT Device Defender セキュリティプロファイルを、この AWS アカウントの `us-west-2` リージョン内のすべての未登録デバイスと関連付けます。 ``` aws iot attach-security-profile \ --security-profile-name Testprofile \ --security-profile-target-arn "arn:aws:iot:us-west-2:123456789012:all/unregistered-things" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[Detect コマンド](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス」*の「[AttachSecurityProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/attach-security-profile.html)」を参照してください。 ### `attach-thing-principal` 次のコード例は、`attach-thing-principal` を使用する方法を示しています。 **AWS CLI** **モノに証明書をアタッチするには** 次の `attach-thing-principal` 例では、MyTemperatureSensor モノに証明書をアタッチします。証明書は ARN によって識別されます。証明書の ARN は AWS IoT コンソールで確認できます。 ``` aws iot attach-thing-principal \ --thing-name MyTemperatureSensor \ --principal arn:aws:iot:us-west-2:123456789012:cert/2e1eb273792174ec2b9bf4e9b37e6c6c692345499506002a35159767055278e8 ``` このコマンドでは何も出力されません。 詳細については、「AWS IoT ディベロッパーガイド」の「[レジストリによるモノの管理方法](https://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html)」を参照してください。** + API の詳細については、「*AWS CLI API リファレンス*」の「[AttachThingPrincipal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/attach-thing-principal.html)」を参照してください。 ### `cancel-audit-mitigation-actions-task` 次のコード例は、`cancel-audit-mitigation-actions-task` を使用する方法を示しています。 **AWS CLI** **監査緩和アクションタスクをキャンセルするには** 次の `cancel-audit-mitigations-action-task` の例では、指定されたタスクの緩和アクションの適用をキャンセルします。すでに完了したタスクはキャンセルできません。 ``` aws iot cancel-audit-mitigation-actions-task --task-id "myActionsTaskId" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[CancelAuditMitigationActionsTask (緩和アクションコマンド)](https://docs.aws.amazon.com/iot/latest/developerguide/mitigation-action-commands.html#dd-api-iot-CancelAuditMitigationActionsTask)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelAuditMitigationActionsTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/cancel-audit-mitigation-actions-task.html)」を参照してください。 ### `cancel-audit-task` 次のコード例は、`cancel-audit-task` を使用する方法を示しています。 **AWS CLI** **監査タスクをキャンセルするには** 次の `cancel-audit-task` の例では、指定されたタスク ID を持つ監査タスクをキャンセルします。完了したタスクをキャンセルできません。 ``` aws iot cancel-audit-task \ --task-id a3aea009955e501a31b764abe1bebd3d ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[Audit コマンド](https://docs.aws.amazon.com/iot/latest/developerguide/AuditCommands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelAuditTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/cancel-audit-task.html)」を参照してください。 ### `cancel-certificate-transfer` 次のコード例は、`cancel-certificate-transfer` を使用する方法を示しています。 **AWS CLI** **別の AWS のアカウントへの証明書の転送をキャンセルするには** 次の `cancel-certificate-transfer` の例では、指定された証明書転送の転送をキャンセルします。証明書は証明書 ID によって識別されます。AWS IoT コンソールで証明書の ID を確認できます。 ``` aws iot cancel-certificate-transfer \ --certificate-id f0f33678c7c9a046e5cc87b2b1a58dfa0beec26db78addd5e605d630e05c7fc8 ``` このコマンドでは何も出力されません。 詳細については、「*AWSIoT Core デベロッパーガイド*」の「[証明書を別のアカウントに転送する](https://docs.aws.amazon.com/iot/latest/developerguide/transfer-cert.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelCertificateTransfer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/cancel-certificate-transfer.html)」を参照してください。 ### `cancel-job-execution` 次のコード例は、`cancel-job-execution` を使用する方法を示しています。 **AWS CLI** **デバイスでジョブ実行をキャンセルするには** 次の `cancel-job-execution` の例では、デバイスで指定されたジョブの実行をキャンセルします。ジョブが `QUEUED` の状態にない場合は、`--force` パラメータを追加する必要があります。 ``` aws iot cancel-job-execution \ --job-id "example-job-03" \ --thing-name "MyRPi" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[ジョブ (CLI) の作成と管理](https://docs.aws.amazon.com/iot/latest/developerguide/manage-job-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelJobExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/cancel-job-execution.html)」を参照してください。 ### `cancel-job` 次のコード例は、`cancel-job` を使用する方法を示しています。 **AWS CLI** **ジョブをキャンセルするには** 以下の `cancel-job` の例では、指定したジョブをキャンセルします。 ``` aws iot cancel-job \ --job-job "example-job-03" ``` 出力: ``` { "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-03", "jobId": "example-job-03", "description": "example job test" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[ジョブ (CLI) の作成と管理](https://docs.aws.amazon.com/iot/latest/developerguide/manage-job-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/cancel-job.html)」を参照してください。 ### `clear-default-authorizer` 次のコード例は、`clear-default-authorizer` を使用する方法を示しています。 **AWS CLI** **デフォルトのオーソライザーをクリアするには** 次の `clear-default-authorizer` の例では、現在設定されているデフォルトのカスタムオーソライザーをクリアします。このコマンドを実行すると、デフォルトのオーソライザーはなくなります。カスタムオーソライザーを使用する場合は、HTTP リクエストヘッダーに名前で指定する必要があります。 ``` aws iot clear-default-authorizer ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT API リファレンス*」の「[ClearDefaultAuthorizer](https://docs.aws.amazon.com/iot/latest/apireference/API_ClearDefaultAuthorizer.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ClearDefaultAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/clear-default-authorizer.html)」を参照してください。 ### `confirm-topic-rule-destination` 次のコード例は、`confirm-topic-rule-destination` を使用する方法を示しています。 **AWS CLI** **トピックルールの送信先を確認するには** 次の `confirm-topic-rule-destination` の例では、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" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[トピックルールの送信先の確認](https://docs.aws.amazon.com/iot/latest/developerguide/rule-destination.html#confirm-destination)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ConfirmTopicRuleDestination](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/confirm-topic-rule-destination.html)」を参照してください。 ### `create-audit-suppression` 次のコード例は、`create-audit-suppression` を使用する方法を示しています。 **AWS CLI** **監査検出結果の抑制を作成するには** 次の `create-audit-suppression` の例では、「virtualMachinePolicy」という名前のポリシーに対して、過度に許容されているというフラグが付けられた監査検出結果の抑制を作成します。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[監査の検出結果の抑制](https://docs.aws.amazon.com/iot/latest/developerguide/audit-finding-suppressions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateAuditSuppression](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-audit-suppression.html)」を参照してください。 ### `create-authorizer` 次のコード例は、`create-authorizer` を使用する方法を示しています。 **AWS CLI** **カスタムオーソライザーを作成するには** 次の `create-authorizer` の例では、カスタム認証サービスの一部として指定された Lambda 関数を使用するカスタムオーソライザーを作成します。 ``` 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-----" ``` 出力: ``` { "authorizerName": "CustomAuthorizer", "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer2" } ``` 詳細については、「*AWS IoT API リファレンス*」の「[CreateAuthorizer](https://docs.aws.amazon.com/iot/latest/apireference/API_CreateAuthorizer.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-authorizer.html)」を参照してください。 ### `create-billing-group` 次のコード例は、`create-billing-group` を使用する方法を示しています。 **AWS CLI** **請求グループを作成するには** 次の `create-billing-group` 例では、`GroupOne` という名前のシンプルな請求グループが作成されます。 ``` aws iot create-billing-group \ --billing-group-name GroupOne ``` 出力: ``` { "billingGroupName": "GroupOne", "billingGroupArn": "arn:aws:iot:us-west-2:123456789012:billinggroup/GroupOne", "billingGroupId": "103de383-114b-4f51-8266-18f209ef5562" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[請求グループ](https://docs.aws.amazon.com/iot/latest/developerguide/tagging-iot-billing-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateBillingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-billing-group.html)」を参照してください。 ### `create-certificate-from-csr` 次のコード例は、`create-certificate-from-csr` を使用する方法を示しています。 **AWS CLI** **証明書署名リクエスト (CSR) からデバイス証明書を作成するには** 次の `create-certificate-from-csr` の例では、CSR からデバイス証明書を作成します。`openssl` コマンドを使用して、CSR を作成できます。 ``` aws iot create-certificate-from-csr \ --certificate-signing-request=file://certificate.csr ``` 出力: ``` { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/c0c57bbc8baaf4631a9a0345c957657f5e710473e3ddbee1428d216d54d53ac9", "certificateId": "c0c57bbc8baaf4631a9a0345c957657f5e710473e3ddbee1428d216d54d53ac9", "certificatePem": "" } ``` 詳細については、「*AWS IoT API リファレンス*」の「[CreateCertificateFromCSR](https://docs.aws.amazon.com/iot/latest/apireference/API_CreateCertificateFromCsr.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCertificateFromCsr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-certificate-from-csr.html)」を参照してください。 ### `create-custom-metric` 次のコード例は、`create-custom-metric` を使用する方法を示しています。 **AWS CLI** **デバイスが Device Defender に発行するカスタムメトリクスを作成するには** 次の `create-custom-metric` の例では、バッテリーの割合を測定するカスタムメトリクスを作成します。 ``` 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" ``` 出力: ``` { "metricName": "batteryPercentage", "metricArn": "arn:aws:iot:us-east-1:1234564789012:custommetric/batteryPercentage" } ``` 詳細については、「*AWS IoT Core デベロッパーガイド*」の「[カスタムメトリクス](https://docs.aws.amazon.com/iot/latest/developerguide/dd-detect-custom-metrics.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCustomMetric](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-custom-metric.html)」を参照してください。 ### `create-dimension` 次のコード例は、`create-dimension` を使用する方法を示しています。 **AWS CLI** **ディメンションを作成するには** 次の `create-dimension` では、`TopicFilterForAuthMessages` という 1 つのトピックフィルターを使用してディメンションを作成します。 ``` aws iot create-dimension \ --name TopicFilterForAuthMessages \ --type TOPIC_FILTER \ --string-values device/+/auth ``` 出力: ``` { "name": "TopicFilterForAuthMessages", "arn": "arn:aws:iot:eu-west-2:123456789012:dimension/TopicFilterForAuthMessages" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[Detect コマンド](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDimension](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-dimension.html)」を参照してください。 ### `create-domain-configuration` 次のコード例は、`create-domain-configuration` を使用する方法を示しています。 **AWS CLI** **ドメイン設定を作成するには** 次の `create-domain-configuration` の例では、サービスタイプが `DATA` の AWS マネージドドメイン設定を作成します。 ``` aws iot create-domain-configuration \ --domain-configuration-name "additionalDataDomain" \ --service-type "DATA" ``` 出力: ``` { "domainConfigurationName": "additionalDataDomain", "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/additionalDataDomain/dikMh" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[設定可能なエンドポイント](https://docs.aws.amazon.com/iot/latest/developerguide/iot-custom-endpoints-configurable-aws.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDomainConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-domain-configuration.html)」を参照してください。 ### `create-dynamic-thing-group` 次のコード例は、`create-dynamic-thing-group` を使用する方法を示しています。 **AWS CLI** **モノの動的グループを作成するには** 次の `create-dynamic-thing-group` の例では、60 度を超える温度属性を持つ任意のモノを含むモノの動的グループを作成します。モノの動的グループを使用する前に、AWS IoT フリートのインデックス作成を有効にする必要があります。 ``` aws iot create-dynamic-thing-group \ --thing-group-name "RoomTooWarm" \ --query-string "attributes.temperature>60" ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」「[モノの動的グループ](https://docs.aws.amazon.com/iot/latest/developerguide/dynamic-thing-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDynamicThingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-dynamic-thing-group.html)」を参照してください。 ### `create-job` 次のコード例は、`create-job` を使用する方法を示しています。 **AWS CLI** **例 1: ジョブを作成するには** 次の `create-job` の例では、`MyRaspberryPi` デバイスに JSON ドキュメントを送信するシンプルな AWS IoT ジョブを作成します。 ``` 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 ``` 出力: ``` { "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-01", "jobId": "example-job-01", "description": "example job test" } ``` **例 2: 連続ジョブを作成するには** 次の `create-job` の例では、ターゲットとして指定されたモノがジョブを完了した後も実行し続けるジョブを作成します。この例では、ターゲットはモノのグループであるため、新しいデバイスがグループに追加されると、それらの新しいモノに対して連続ジョブが実行されます。 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 出力: ``` { "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-04", "jobId": "example-job-04", "description": "example continuous job" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[ジョブ (CLI) の作成と管理](https://docs.aws.amazon.com/iot/latest/developerguide/manage-job-cli.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス* の「[CreateJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-job.html)」を参照してください。 ### `create-keys-and-certificate` 次のコード例は、`create-keys-and-certificate` を使用する方法を示しています。 **AWS CLI** **RSA キーペアを作成して X.509 証明書を発行するには** 以下の `create-keys-and-certificate` は、2048 ビットの RSA キーペアを作成し、発行されたパブリックキーを使用して X.509 証明書を発行します。AWS IoT がこの証明書のプライベートキーを提供するのは今回のみですので、必ず安全な場所に保管してください。 ``` aws iot create-keys-and-certificate \ --certificate-pem-outfile "myTest.cert.pem" \ --public-key-outfile "myTest.public.key" \ --private-key-outfile "myTest.private.key" ``` 出力: ``` { "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" } } ``` 詳細については、「**AWS IoT デベロッパーガイド**」の「[AWS IoT デバイス証明書の作成と登録](https://docs.aws.amazon.com/iot/latest/developerguide/device-certs-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateKeysAndCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-keys-and-certificate.html)」を参照してください。 ### `create-mitigation-action` 次のコード例は、`create-mitigation-action` を使用する方法を示しています。 **AWS CLI** **緩和アクションを作成するには** 次の `create-mitigation-action` の例では、`AddThingsToQuarantineGroup1Action` という名前の緩和アクションを定義しています。この緩和アクションを適用すると、モノは `QuarantineGroup1` という名前のモノのグループに移動します。このアクションは、モノの動的グループをオーバーライドします。 ``` aws iot create-mitigation-action --cli-input-json file::params.json ``` `params.json` の内容: ``` { "actionName": "AddThingsToQuarantineGroup1Action", "actionParams": { "addThingsToThingGroupParams": { "thingGroupNames": [ "QuarantineGroup1" ], "overrideDynamicGroups": true } }, "roleArn": "arn:aws:iam::123456789012:role/service-role/MoveThingsToQuarantineGroupRole" } ``` 出力: ``` { "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/AddThingsToQuarantineGroup1Action", "actionId": "992e9a63-a899-439a-aa50-4e20c52367e1" } ``` 詳細については、「*AWSIoT デベロッパーガイド*」の「[CreateMitigationAction (緩和アクションコマンド)](https://docs.aws.amazon.com/iot/latest/developerguide/iot/latest/developerguide/iot/latest/developerguide/mitigation-action-commands.html.html#dd-api-iot-CreateMitigationAction)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateMitigationAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-mitigation-action.html)」を参照してください。 ### `create-ota-update` 次のコード例は、`create-ota-update` を使用する方法を示しています。 **AWS CLI** **Amazon FreeRTOS で使用する OTA 更新を作成するには** 次の `create-ota-update` の例では、ターゲットまたはグループのグループに AWS IoT OTAUpdate を作成します。これは Amazon FreeRTOS の無線通信更新の一部であり、新しいファームウェアイメージを単一のデバイスまたはデバイスのグループにデプロイできます。 ``` aws iot create-ota-update \ --cli-input-json file://create-ota-update.json ``` `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" } ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT API リファレンス*」の「[CreateOTAUpdate](https://docs.aws.amazon.com/iot/latest/apireference/API_CreateOTAUpdate.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateOtaUpdate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-ota-update.html)」を参照してください。 ### `create-policy-version` 次のコード例は、`create-policy-version` を使用する方法を示しています。 **AWS CLI** **ポリシーを新しいバージョンで更新するには** 次の `create-policy-version` の例では、ポリシー定義を更新し、新しいポリシーバージョンを作成します。また、この例では新しいバージョンをデフォルトにします。 ``` aws iot create-policy-version \ --policy-name UpdateDeviceCertPolicy \ --policy-document file://policy.json \ --set-as-default ``` `policy.json` の内容: ``` { "Version":"2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "iot:UpdateCertificate", "Resource": "*" } ] } ``` 出力: ``` { "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 } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT ポリシー](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreatePolicyVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-policy-version.html)」を参照してください。 ### `create-policy` 次のコード例は、`create-policy` を使用する方法を示しています。 **AWS CLI** **AWS IoT ポリシーを作成するには** 次の `create-policy` の例では、TemperatureSensorPolicy という名前の AWS IoT ポリシーを作成します。`policy.json` ファイルには、AWS IoT ポリシーアクションを許可するステートメントが含まれています。 ``` aws iot create-policy \ --policy-name TemperatureSensorPolicy \ --policy-document file://policy.json ``` `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" ] } ] } ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT ポリシー](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreatePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-policy.html)」を参照してください。 ### `create-provisioning-claim` 次のコード例は、`create-provisioning-claim` を使用する方法を示しています。 **AWS CLI** **プロビジョニングクレームを作成するには** 次の `create-provisioning-claim` の例では、プロビジョニングテンプレートからプロビジョニングクレームを作成します。 ``` aws iot create-provisioning-claim \ --template-name MyTestProvisioningTemplate ``` 出力: ``` { "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 } ``` 詳細については、「*AWS IoT Core デベロッパーガイド*」の「[信頼できるユーザーによるプロビジョニング](https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#trusted-user)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateProvisioningClaim](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-provisioning-claim.html)」を参照してください。 ### `create-provisioning-template-version` 次のコード例は、`create-provisioning-template-version` を使用する方法を示しています。 **AWS CLI** **プロビジョニングテンプレートバージョンを作成するには** 次の例では、指定されたプロビジョニングテンプレートのバージョンを作成します。新しいバージョンの本文は `template.json` ファイルに記載されています。 ``` aws iot create-provisioning-template-version \ --template-name widget-template \ --template-body file://template.json ``` `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"]} } } } ``` 出力: ``` { "templateArn": "arn:aws:iot:us-east-1:123456789012:provisioningtemplate/widget-template", "templateName": "widget-template", "versionId": 2, "isDefaultVersion": false } ``` 詳細については、「*AWS IoT Core デベロッパーガイド*」の「[AWS セキュアトンネリング](https://docs.aws.amazon.com/iot/latest/developerguide/secure-tunneling.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateProvisioningTemplateVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-provisioning-template-version.html)」を参照してください。 ### `create-provisioning-template` 次のコード例は、`create-provisioning-template` を使用する方法を示しています。 **AWS CLI** **プロビジョニングテンプレートを作成するには** 次の `create-provisioning-template` の例では、`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 ``` `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"]} } } } ``` 出力: ``` { "templateArn": "arn:aws:iot:us-east-1:123456789012:provisioningtemplate/widget-template", "templateName": "widget-template", "defaultVersionId": 1 } ``` 詳細については、「*AWS IoT Core デベロッパーガイド*」の「[AWS セキュアトンネリング](https://docs.aws.amazon.com/iot/latest/developerguide/secure-tunneling.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateProvisioningTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-provisioning-template.html)」を参照してください。 ### `create-role-alias` 次のコード例は、`create-role-alias` を使用する方法を示しています。 **AWS CLI** **ロールエイリアスを作成するには** 次の `create-role-alias` の例では、指定されたロールに `LightBulbRole` というロールエイリアスを作成します。 ``` aws iot create-role-alias \ --role-alias LightBulbRole \ --role-arn arn:aws:iam::123456789012:role/lightbulbrole-001 ``` 出力: ``` { "roleAlias": "LightBulbRole", "roleAliasArn": "arn:aws:iot:us-west-2:123456789012:rolealias/LightBulbRole" } ``` 詳細については、「*AWS IoT API リファレンス*」の「[CreateRoleAlias](https://docs.aws.amazon.com/iot/latest/apireference/API_CreateRoleAlias.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateRoleAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-role-alias.html)」を参照してください。 ### `create-scheduled-audit` 次のコード例は、`create-scheduled-audit` を使用する方法を示しています。 **AWS CLI** **スケジュールされた監査を作成するには** 次の `create-scheduled-audit` の例では、CA 証明書またはデバイス証明書の有効期限が切れているかどうかを確認するために、毎週水曜日に実行されるスケジュールされた監査を作成します。 ``` 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 ``` 出力: ``` { "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/WednesdayCertCheck" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[Audit コマンド](https://docs.aws.amazon.com/iot/latest/developerguide/AuditCommands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateScheduledAudit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-scheduled-audit.html)」を参照してください。 ### `create-security-profile` 次のコード例は、`create-security-profile` を使用する方法を示しています。 **AWS CLI** **セキュリティプロファイルを作成するには** 次の `create-security-profile` の例では、セルラー帯域幅がしきい値を超えているか、または 5 分以内に 10 件を超える認証失敗が発生したかを確認するセキュリティプロファイルを作成します。 ``` 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}}]" ``` 出力: ``` { "securityProfileName": "PossibleIssue", "securityProfileArn": "arn:aws:iot:us-west-2:123456789012:securityprofile/PossibleIssue" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[Detect コマンド](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateSecurityProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-security-profile.html)」を参照してください。 ### `create-stream` 次のコード例は、`create-stream` を使用する方法を示しています。 **AWS CLI** **MQTT を介して 1 つ以上の大きなファイルをチャンクで配信するためのストリームを作成するには** 次の `create-stream` の例では、MQTT を介して 1 つ以上の大きなファイルをチャンクで配信するためのストリームを作成します。ストリームは、S3 のような送信元から MQTT メッセージとしてパッケージ化されたチャンクまたはブロックのデータバイトを転送します。1 つ以上のファイルをストリームに関連付けることができます。 ``` aws iot create-stream \ --cli-input-json file://create-stream.json ``` `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" } ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT API リファレンス*」の「[CreateStream](https://docs.aws.amazon.com/iot/latest/apireference/API_CreateStream.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[CreateStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-stream.html)」を参照してください。** ### `create-thing-group` 次のコード例は、`create-thing-group` を使用する方法を示しています。 **AWS CLI** **例 1: モノのグループを作成するには** 次の `create-thing-group` の例では、説明と 2 つの属性を持つ `LightBulbs` という名前のモノのグループを作成します。 ``` aws iot create-thing-group \ --thing-group-name LightBulbs \ --thing-group-properties "thingGroupDescription=\"Generic bulb group\", attributePayload={attributes={Manufacturer=AnyCompany,wattage=60}}" ``` 出力: ``` { "thingGroupName": "LightBulbs", "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs", "thingGroupId": "9198bf9f-1e76-4a88-8e8c-e7140142c331" } ``` **例 2: 親グループの一部であるモノのグループを作成するには** 次の `create-thing-group` は、`LightBulbs` という名前の親モノグループを持つ `HalogenBulbs` という名前のモノグループを作成します。 ``` aws iot create-thing-group \ --thing-group-name HalogenBulbs \ --parent-group-name LightBulbs ``` 出力: ``` { "thingGroupName": "HalogenBulbs", "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/HalogenBulbs", "thingGroupId": "f4ec6b84-b42b-499d-9ce1-4dbd4d4f6f6e" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[モノのグループ](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateThingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-thing-group.html)」を参照してください。 ### `create-thing-type` 次のコード例は、`create-thing-type` を使用する方法を示しています。 **AWS CLI** **モノのタイプを定義するには** 次の `create-thing-type` の例では、モノのタイプと関連する属性を定義します。 ``` aws iot create-thing-type \ --thing-type-name "LightBulb" \ --thing-type-properties "thingTypeDescription=light bulb type, searchableAttributes=wattage,model" ``` 出力: ``` { "thingTypeName": "LightBulb", "thingTypeArn": "arn:aws:iot:us-west-2:123456789012:thingtype/LightBulb", "thingTypeId": "ce3573b0-0a3c-45a7-ac93-4e0ce14cd190" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」「[モノのタイプ](https://docs.aws.amazon.com/iot/latest/developerguide/thing-types.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateThingType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-thing-type.html)」を参照してください。 ### `create-thing` 次のコード例は、`create-thing` を使用する方法を示しています。 **AWS CLI** **例 1: レジストリにモノのレコードを作成するには** 次の `create-thing` 例では、AWS IoT モノのレジストリにデバイスのエントリを作成します。 ``` aws iot create-thing \ --thing-name SampleIoTThing ``` 出力: ``` { "thingName": "SampleIoTThing", "thingArn": "arn:aws:iot:us-west-2: 123456789012:thing/SampleIoTThing", "thingId": " EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE " } ``` **例 2: モノのタイプに関連付けられているモノを定義するには** 次の `create-thing` 例では、指定されたモノのタイプとその属性を持つモノを作成します。 ``` aws iot create-thing \ --thing-name "MyLightBulb" \ --thing-type-name "LightBulb" \ --attribute-payload "{"attributes": {"wattage":"75", "model":"123"}}" ``` 出力: ``` { "thingName": "MyLightBulb", "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyLightBulb", "thingId": "40da2e73-c6af-406e-b415-15acae538797" } ``` 詳細については、「*AWS IoT ディベロッパーガイド*」の「[レジストリによるモノの管理方法](https://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html)」と「[モノのタイプ](https://docs.aws.amazon.com/iot/latest/developerguide/thing-types.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-thing.html)」を参照してください。 ### `create-topic-rule-destination` 次のコード例は、`create-topic-rule-destination` を使用する方法を示しています。 **AWS CLI** **トピックルールの送信先を作成するには** 次の `create-topic-rule-destination` の例では、HTTP エンドポイントのトピックルールの送信先を作成します。 ``` aws iot create-topic-rule-destination \ --destination-configuration httpUrlConfiguration={confirmationUrl=https://example.com} ``` 出力: ``` { "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" } } } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[トピックルールの送信先の作成](https://docs.aws.amazon.com/iot/latest/developerguide/rule-destination.html#create-destination)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateTopicRuleDestination](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-topic-rule-destination.html)」を参照してください。 ### `create-topic-rule` 次のコード例は、`create-topic-rule` を使用する方法を示しています。 **AWS CLI** **Amazon SNS アラートを送信するルールを作成するには** 次の`create-topic-rule` 例では、デバイスシャドウにある土壌湿度レベルの読み取り値が低くなったときに Amazon SNS メッセージを送信するルールを作成します。 ``` aws iot create-topic-rule \ --rule-name "LowMoistureRule" \ --topic-rule-payload file://plant-rule.json ``` この例では、次の JSON コードを `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" } }] } ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT ルールの作成](https://docs.aws.amazon.com/iot/latest/developerguide/iot-create-rule.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateTopicRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/create-topic-rule.html)」を参照してください。 ### `delete-account-audit-configuration` 次のコード例は、`delete-account-audit-configuration` を使用する方法を示しています。 **AWS CLI** **AWS アカウントのすべての監査チェックを無効にするには** 次の `delete-account-audit-configuration` の例では、このアカウントの AWS IoT Device Defender のデフォルト設定を復元し、すべての監査チェックを無効にして設定データを消去します。また、このアカウントのスケジュールされた監査も削除されます。**このコマンドは注意して使用してください。** ``` aws iot delete-account-audit-configuration \ --delete-scheduled-audits ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[Audit コマンド](https://docs.aws.amazon.com/iot/latest/developerguide/AuditCommands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAccountAuditConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-account-audit-configuration.html)」を参照してください。 ### `delete-audit-suppression` 次のコード例は、`delete-audit-suppression` を使用する方法を示しています。 **AWS CLI** **監査検出結果の抑制を削除するには** 次の `delete-audit-suppression` の例では、DEVICE\$1CERTIFICATE\$1EXPIRING\$1CHECK の監査結果の抑制を削除します。 ``` aws iot delete-audit-suppression \ --check-name DEVICE_CERTIFICATE_EXPIRING_CHECK \ --resource-identifier deviceCertificateId="c7691e" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[監査の検出結果の抑制](https://docs.aws.amazon.com/iot/latest/developerguide/audit-finding-suppressions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAuditSuppression](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-audit-suppression.html)」を参照してください。 ### `delete-authorizer` 次のコード例は、`delete-authorizer` を使用する方法を示しています。 **AWS CLI** **カスタムオーソライザーを削除するには** 次の `delete-authorizer` の例では、`CustomAuthorizer` という名前のオーソライザーを削除します。カスタムオーソライザーは、削除する前に `INACTIVE` の状態にある必要があります。 ``` aws iot delete-authorizer \ --authorizer-name CustomAuthorizer ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」「[DeleteAuthorizer](https://docs.aws.amazon.com/iot/latest/apireference/API_DeleteAuthorizer.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-authorizer.html)」を参照してください。 ### `delete-billing-group` 次のコード例は、`delete-billing-group` を使用する方法を示しています。 **AWS CLI** **請求グループを削除するには** 次の `delete-billing-group` の例は、指定された請求グループを削除します。請求グループは、1 つ以上のモノが含まれている場合でも削除できます。 ``` aws iot delete-billing-group \ --billing-group-name BillingGroupTwo ``` このコマンドでは、出力が生成されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[請求グループ](https://docs.aws.amazon.com/iot/latest/developerguide/tagging-iot-billing-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteBillingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-billing-group.html)」を参照してください。 ### `delete-ca-certificate` 次のコード例は、`delete-ca-certificate` を使用する方法を示しています。 **AWS CLI** **CA 証明書を削除するには** 次の `delete-ca-certificate` の例では、指定された証明書 ID を持つ CA 証明書を削除します。 ``` aws iot delete-ca-certificate \ --certificate-id f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467 ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT API リファレンス*」の「[DeleteCACertificate](https://docs.aws.amazon.com/iot/latest/apireference/API_DeleteCACertificate.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCaCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-ca-certificate.html)」を参照してください。 ### `delete-certificate` 次のコード例は、`delete-certificate` を使用する方法を示しています。 **AWS CLI** **デバイス証明書を削除するには** 次の `delete-certificate` 例は、指定した ID のデバイス証明書を削除します。 ``` aws iot delete-certificate \ --certificate-id c0c57bbc8baaf4631a9a0345c957657f5e710473e3ddbee1428d216d54d53ac9 ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT API リファレンス*」の「[DeleteCertificate](https://docs.aws.amazon.com/iot/latest/apireference/API_DeleteCertificate.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-certificate.html)」を参照してください。 ### `delete-custom-metric` 次のコード例は、`delete-custom-metric` を使用する方法を示しています。 **AWS CLI** **カスタムメトリクスを削除するには** 次の `delete-custom-metric` の例では、カスタムメトリクスを削除します。 ``` aws iot delete-custom-metric \ --metric-name batteryPercentage \ --region us-east-1 ``` 出力: ``` HTTP 200 ``` 詳細については、「*AWS IoT Core デベロッパーガイド*」の「[カスタムメトリクス](https://docs.aws.amazon.com/iot/latest/developerguide/dd-detect-custom-metrics.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCustomMetric](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-custom-metric.html)」を参照してください。 ### `delete-dimension` 次のコード例は、`delete-dimension` を使用する方法を示しています。 **AWS CLI** **ディメンションを削除するには** 次の `delete-dimension` の例では、`TopicFilterForAuthMessages` というディメンションを削除します。 ``` aws iot delete-dimension \ --name TopicFilterForAuthMessages ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[Detect コマンド](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDimension](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-dimension.html)」を参照してください。 ### `delete-domain-configuration` 次のコード例は、`delete-domain-configuration` を使用する方法を示しています。 **AWS CLI** **ドメイン設定を削除するには** 次の `delete-domain-configuration` の例では、`additionalDataDomain` という名前のドメイン設定を AWS アカウントから削除します。 ``` aws iot delete-domain-configuration \ --domain-configuration-name "additionalDataDomain" \ --domain-configuration-status "OK" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[設定可能なエンドポイント](https://docs.aws.amazon.com/iot/latest/developerguide/iot-custom-endpoints-configurable-aws.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDomainConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-domain-configuration.html)」を参照してください。 ### `delete-dynamic-thing-group` 次のコード例は、`delete-dynamic-thing-group` を使用する方法を示しています。 **AWS CLI** **モノの動的グループを削除するには** 次の `delete-dynamic-thing-group` の例は、指定されたモノの動的グループを削除します。 ``` aws iot delete-dynamic-thing-group \ --thing-group-name "RoomTooWarm" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」「[モノの動的グループ](https://docs.aws.amazon.com/iot/latest/developerguide/dynamic-thing-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDynamicThingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-dynamic-thing-group.html)」を参照してください。 ### `delete-job-execution` 次のコード例は、`delete-job-execution` を使用する方法を示しています。 **AWS CLI** **ジョブの実行を削除するには** 次の `delete-job-execution` の例では、デバイス上の指定されたジョブのジョブ実行を削除します。`describe-job-execution` を使用して実行番号を取得します。 ``` aws iot delete-job-execution --job-id "example-job-02" --thing-name "MyRaspberryPi" --execution-number 1 ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[ジョブ (CLI) の作成と管理](https://docs.aws.amazon.com/iot/latest/developerguide/manage-job-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteJobExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-job-execution.html)」を参照してください。 ### `delete-job` 次のコード例は、`delete-job` を使用する方法を示しています。 **AWS CLI** **ジョブを削除するには** 次の `delete-job` の例では、指定されたジョブを削除します。`--force` オプションを指定することで、ステータスが `IN_PROGRESS` であってもジョブは削除されます。 ``` aws iot delete-job \ --job-id "example-job-04" \ --force ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[ジョブ (CLI) の作成と管理](https://docs.aws.amazon.com/iot/latest/developerguide/manage-job-cli.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス* の「[DeleteJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-job.html)」を参照してください。 ### `delete-mitigation-action` 次のコード例は、`delete-mitigation-action` を使用する方法を示しています。 **AWS CLI** **緩和アクションを削除するには** 次の `delete-mitigation-action` 例は、指定された緩和アクションを削除します。 ``` aws iot delete-mitigation-action \ --action-name AddThingsToQuarantineGroup1Action ``` このコマンドでは何も出力されません。 詳細については、「*AWSIoT デベロッパーガイド*」の「[DeleteMitigationAction (緩和アクションコマンド)](https://docs.aws.amazon.com/iot/latest/developerguide/mitigation-action-commands.html#dd-api-iot-DeleteMitigationAction)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteMitigationAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-mitigation-action.html)」を参照してください。 ### `delete-ota-update` 次のコード例は、`delete-ota-update` を使用する方法を示しています。 **AWS CLI** **OTA 更新を削除するには** 次の `delete-ota-update` の例では、指定された OTA 更新を削除します。 ``` aws iot delete-ota-update \ --ota-update-id ota12345 \ --delete-stream \ --force-delete-aws-job ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT API リファレンス*」の「[DeleteOTAUpdate](https://docs.aws.amazon.com/iot/latest/apireference/API_DeleteOTAUpdate.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteOtaUpdate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-ota-update.html)」を参照してください。 ### `delete-policy-version` 次のコード例は、`delete-policy-version` を使用する方法を示しています。 **AWS CLI** **ポリシーのバージョンを削除するには** 次の `delete-policy-version` の例では、指定されたポリシーのバージョン 2 を AWS アカウントから削除します。 ``` aws iot delete-policy-version \ --policy-name UpdateDeviceCertPolicy \ --policy-version-id 2 ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT ポリシー](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeletePolicyVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-policy-version.html)」を参照してください。 ### `delete-policy` 次のコード例は、`delete-policy` を使用する方法を示しています。 **AWS CLI** **ポリシーを削除するには** 次の `delete-policy` の例では、指定されたポリシーを AWS アカウントから削除します。 ``` aws iot delete-policy --policy-name UpdateDeviceCertPolicy ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT ポリシー](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[DeletePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-policy.html)」を参照してください。 ### `delete-provisioning-template-version` 次のコード例は、`delete-provisioning-template-version` を使用する方法を示しています。 **AWS CLI** **プロビジョニングテンプレートのバージョンを削除するには** 次の `delete-provisioning-template-version` の例では、指定されたプロビジョニングテンプレートのバージョン 2 を削除します。 ``` aws iot delete-provisioning-template-version \ --version-id 2 \ --template-name "widget-template" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Core デベロッパーガイド*」の「[AWS セキュアトンネリング](https://docs.aws.amazon.com/iot/latest/developerguide/secure-tunneling.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteProvisioningTemplateVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-provisioning-template-version.html)」を参照してください。 ### `delete-provisioning-template` 次のコード例は、`delete-provisioning-template` を使用する方法を示しています。 **AWS CLI** **プロビジョニングテンプレートを削除するには** 次の `delete-provisioning-template` の例は、指定されたプロビジョニングテンプレートを削除します。 ``` aws iot delete-provisioning-template \ --template-name widget-template ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Core デベロッパーガイド*」の「[AWS セキュアトンネリング](https://docs.aws.amazon.com/iot/latest/developerguide/secure-tunneling.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteProvisioningTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-provisioning-template.html)」を参照してください。 ### `delete-registration-code` 次のコード例は、`delete-registration-code` を使用する方法を示しています。 **AWS CLI** **登録コードを削除するには** 次の `delete-registration-code` の例では、AWS IoT アカウント固有の登録コードを削除します。 ``` aws iot delete-registration-code ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[独自の証明書を使用する](https://docs.aws.amazon.com/iot/latest/developerguide/device-certs-your-own.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRegistrationCode](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-registration-code.html)」を参照してください。 ### `delete-role-alias` 次のコード例は、`delete-role-alias` を使用する方法を示しています。 **AWS CLI** **AWS IoT ロールエイリアスを削除するには** 次の `delete-role-alias` の例では、`LightBulbRole` という名前の AWS IoT ロールエイリアスを削除します。 ``` aws iot delete-role-alias \ --role-alias LightBulbRole ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS サービスへの直接呼び出しの認証](https://docs.aws.amazon.com/iot/latest/developerguide/authorizing-direct-aws.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRoleAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-role-alias.html)」を参照してください。 ### `delete-scheduled-audit` 次のコード例は、`delete-scheduled-audit` を使用する方法を示しています。 **AWS CLI** **スケジュールされた監査を削除するには** 次の `delete-scheduled-audit` の例では、`AWSIoTDeviceDefenderDailyAudit` という名前の AWS IoT Device Defender のスケジュールされた監査を削除します。 ``` aws iot delete-scheduled-audit \ --scheduled-audit-name AWSIoTDeviceDefenderDailyAudit ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[Audit コマンド](https://docs.aws.amazon.com/iot/latest/developerguide/AuditCommands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteScheduledAudit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-scheduled-audit.html)」を参照してください。 ### `delete-security-profile` 次のコード例は、`delete-security-profile` を使用する方法を示しています。 **AWS CLI** **セキュリティプロファイルを削除するには** 次の `delete-security-profile` の例では、`PossibleIssue` という名前のセキュリティプロファイルを削除します。 ``` aws iot delete-security-profile \ --security-profile-name PossibleIssue ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[Detect コマンド](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteSecurityProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-security-profile.html)」を参照してください。 ### `delete-stream` 次のコード例は、`delete-stream` を使用する方法を示しています。 **AWS CLI** **ストリームを削除するには** 以下の `delete-stream` 例は、指定されたストリームを削除します。 ``` aws iot delete-stream \ --stream-id stream12345 ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT API リファレンス*」の「[DeleteStream](https://docs.aws.amazon.com/iot/latest/apireference/API_DeleteStream.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-stream.html)」を参照してください。 ### `delete-thing-group` 次のコード例は、`delete-thing-group` を使用する方法を示しています。 **AWS CLI** **モノのグループを削除するには** 次の `delete-thing-group` の例は、指定されたモノのグループを削除します。モノの子グループが含まれている場合、モノのグループを削除することはできません。 ``` aws iot delete-thing-group \ --thing-group-name DefectiveBulbs ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[モノのグループ](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteThingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-thing-group.html)」を参照してください。 ### `delete-thing-type` 次のコード例は、`delete-thing-type` を使用する方法を示しています。 **AWS CLI** **例 1: モノのタイプを削除するには** 次の `delete-thing-type` の例では、廃止されたモノのタイプを削除します。 ``` aws iot delete-thing-type \ --thing-type-name "obsoleteThingType" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」「[モノのタイプ](https://docs.aws.amazon.com/iot/latest/developerguide/thing-types.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteThingType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-thing-type.html)」を参照してください。 ### `delete-thing` 次のコード例は、`delete-thing` を使用する方法を示しています。 **AWS CLI** **モノに関する詳細情報を表示するには** 次の `delete-thing` 例では、AWS アカウントの AWS IoT レジストリからモノを削除します。 aws iot delete-thing --thing-name "FourthBulb" このコマンドでは何も出力されません。 詳細については、「AWS IoT ディベロッパーガイド」の「[レジストリによるモノの管理方法](https://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-thing.html)」を参照してください。 ### `delete-topic-rule-destination` 次のコード例は、`delete-topic-rule-destination` を使用する方法を示しています。 **AWS CLI** **トピックルールの送信先を削除するには** 次の `delete-topic-rule-destination` の例では、指定したトピックルールの送信先を削除します。 ``` aws iot delete-topic-rule-destination \ --arn "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[トピックルールの送信先の削除](https://docs.aws.amazon.com/iot/latest/developerguide/rule-destination.html#delete-destination)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteTopicRuleDestination](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-topic-rule-destination.html)」を参照してください。 ### `delete-topic-rule` 次のコード例は、`delete-topic-rule` を使用する方法を示しています。 **AWS CLI** **ルールを削除するには** 次の `delete-topic-rule` の例は、指定されたルールを削除します。 ``` aws iot delete-topic-rule \ --rule-name "LowMoistureRule" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[ルールの削除](https://docs.aws.amazon.com/iot/latest/developerguide/iot-delete-rule.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteTopicRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-topic-rule.html)」を参照してください。 ### `delete-v2-logging-level` 次のコード例は、`delete-v2-logging-level` を使用する方法を示しています。 **AWS CLI** **モノのグループのログ記録レベルを削除するには** 次の `delete-v2-logging-level` の例は、指定されたモノのグループのログ記録レベルを削除します。 ``` aws iot delete-v2-logging-level \ --target-type THING_GROUP \ --target-name LightBulbs ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteV2LoggingLevel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/delete-v2-logging-level.html)」を参照してください。 ### `deprecate-thing-type` 次のコード例は、`deprecate-thing-type` を使用する方法を示しています。 **AWS CLI** **例 1: モノのタイプを廃止にするには** 次の `deprecate-thing-type` の例では、ユーザーが新しいモノを関連付けられないように、モノのタイプを廃止します。 ``` aws iot deprecate-thing-type \ --thing-type-name "obsoleteThingType" ``` このコマンドでは何も出力されません。 **例 2: モノのタイプの廃止を元に戻すには** 次の `deprecate-thing-type` の例では、モノのタイプの廃止を元に戻し、ユーザーが新しいモノを再び関連付けることができるようにします。 ``` aws iot deprecate-thing-type \ --thing-type-name "obsoleteThingType" \ --undo-deprecate ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」「[モノのタイプ](https://docs.aws.amazon.com/iot/latest/developerguide/thing-types.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeprecateThingType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/deprecate-thing-type.html)」を参照してください。 ### `describe-account-audit-configuration` 次のコード例は、`describe-account-audit-configuration` を使用する方法を示しています。 **AWS CLI** **現在の監査設定を表示するには** 次の `describe-account-audit-configuration` の例では、AWS IoT Device Defender 監査設定の現在の設定を一覧表示します。 ``` aws iot describe-account-audit-configuration ``` 出力: ``` { "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 } } } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[Audit コマンド](https://docs.aws.amazon.com/iot/latest/developerguide/AuditCommands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAccountAuditConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-account-audit-configuration.html)」を参照してください。 ### `describe-audit-finding` 次のコード例は、`describe-audit-finding` を使用する方法を示しています。 **AWS CLI** **監査検出結果の詳細を一覧表示するには** 次の `describe-audit-finding` の例では、指定された AWS IoT Device Defender 監査検出結果の詳細を一覧表示します。監査は複数の検出結果を生成できます。`list-audit-findings` コマンドを使用して、監査から検出結果のリストを取得し、`findingId` を取得します。 ``` aws iot describe-audit-finding \ --finding-id "ef4826b8-e55a-44b9-b460-5c485355371b" ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[監査結果をチェックする (Audit コマンド)](https://docs.aws.amazon.com/iot/latest/developerguide/AuditCommands.html#device-defender-AuditCommandsFindings)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAuditFinding](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-audit-finding.html)」を参照してください。 ### `describe-audit-mitigation-actions-task` 次のコード例は、`describe-audit-mitigation-actions-task` を使用する方法を示しています。 **AWS CLI** **監査緩和アクションタスクの詳細を表示するには** 次の `describe-audit-mitigation-actions-task` の例は、`ResetPolicyVersionAction` が検出結果に適用された、指定されたタスクの詳細を示しています。結果には、タスクの開始と終了のタイミング、ターゲットとなった検出結果の数 (および結果）、このタスクの一部として適用されるアクションの定義が含まれます。 ``` aws iot describe-audit-mitigation-actions-task \ --task-id ResetPolicyTask01 ``` 出力: ``` { "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" } } } ] } ``` 詳細については、「*AWSIoT デベロッパーガイド*」の「[DescribeAuditMitigationActionsTask (緩和アクションコマンド)](https://docs.aws.amazon.com/iot/latest/developerguide/mitigation-action-commands.html#dd-api-iot-DescribeAuditMitigationActionsTask)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAuditMitigationActionsTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-audit-mitigation-actions-task.html)」を参照してください。 ### `describe-audit-suppression` 次のコード例は、`describe-audit-suppression` を使用する方法を示しています。 **AWS CLI** **監査の検出結果の抑制の詳細を取得するには** 次の `describe-audit-suppression` の例では、監査の検出結果の抑制の詳細を一覧表示します。 ``` aws iot describe-audit-task \ --task-id "787ed873b69cb4d6cdbae6ddd06996c5" ``` 出力: ``` { "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 } } } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[監査の検出結果の抑制](https://docs.aws.amazon.com/iot/latest/developerguide/audit-finding-suppressions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAuditSuppression](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-audit-suppression.html)」を参照してください。 ### `describe-audit-task` 次のコード例は、`describe-audit-task` を使用する方法を示しています。 **AWS CLI** **監査インスタンスの情報を取得するには** 次の `describe-audit-task` の例では、AWS IoT Device Defender 監査のインスタンスに関する情報を取得します。監査が完了すると、結果に含まれる実行のサマリー統計が結果に含まれます。 ``` aws iot describe-audit-task \ --task-id a3aea009955e501a31b764abe1bebd3d ``` 出力: ``` { "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 } } } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[Audit コマンド](https://docs.aws.amazon.com/iot/latest/developerguide/AuditCommands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAuditTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-audit-task.html)」を参照してください。 ### `describe-authorizer` 次のコード例は、`describe-authorizer` を使用する方法を示しています。 **AWS CLI** **カスタムオーソライザーに関する情報を取得するには** 次の `describe-authorizer` の例は、指定されたカスタムオーソライザーのヘルスの詳細情報を表示します。 ``` aws iot describe-authorizer \ --authorizer-name CustomAuthorizer ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS IoT API リファレンス*」の「[DescribeAuthorizer](https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeAuthorizer.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-authorizer.html)」を参照してください。 ### `describe-billing-group` 次のコード例は、`describe-billing-group` を使用する方法を示しています。 **AWS CLI** **請求グループに関する情報を取得するには** 次の `describe-billing-group` の例では、指定された請求グループの情報を取得します。 ``` aws iot describe-billing-group --billing-group-name GroupOne ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[請求グループ](https://docs.aws.amazon.com/iot/latest/developerguide/tagging-iot-billing-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeBillingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-billing-group.html)」を参照してください。 ### `describe-ca-certificate` 次のコード例は、`describe-ca-certificate` を使用する方法を示しています。 **AWS CLI** **CA 証明書の詳細を取得するには** 次の `describe-ca-certificate` の例では、指定された CA 証明書の詳細を表示します。 ``` aws iot describe-ca-certificate \ --certificate-id f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467 ``` 出力: ``` { "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 } } } ``` 詳細については、「*AWS IoT API リファレンス*」の「[DescribeCACertificate](https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeCACertificate.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeCaCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-ca-certificate.html)」を参照してください。 ### `describe-certificate` 次のコード例は、`describe-certificate` を使用する方法を示しています。 **AWS CLI** **証明書に関する情報を取得するには** 次の `describe-certificate` の例では、指定された証明書の詳細を表示します。 ``` aws iot describe-certificate \ --certificate-id "4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e" ``` 出力: ``` { "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 } } } ``` 詳細については、「*AWS IoT API リファレンス*」の「[DescribeCertificate](https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeCertificate.html)」を参照してください。 + API の詳細については、**AWS CLI コマンドリファレンスの「[DescribeCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-certificate.html)」を参照してください。 ### `describe-custom-metric` 次のコード例は、`describe-custom-metric` を使用する方法を示しています。 **AWS CLI** **Device Defender カスタムメトリクスに関する情報を取得するには** 次の `describe-custom-metric` 例では、`myCustomMetric` という名前のカスタムメトリクスに関する情報を取得します。 ``` aws iot describe-custom-metric \ --metric-name myCustomMetric ``` 出力: ``` { "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 } ``` 詳細については、「*AWS IoT Core デベロッパーガイド*」の「[カスタムメトリクス](https://docs.aws.amazon.com/iot/latest/developerguide/dd-detect-custom-metrics.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeCustomMetric](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-custom-metric.html)」を参照してください。 ### `describe-default-authorizer` 次のコード例は、`describe-default-authorizer` を使用する方法を示しています。 **AWS CLI** **デフォルトのカスタムオーソライザーに関する情報を取得するには** 次の `describe-default-authorizer` の例は、デフォルトのカスタムオーソライザーのヘルスの詳細情報を表示します。 ``` aws iot describe-default-authorizer ``` 出力: ``` { "authorizerName": "CustomAuthorizer", "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer" } ``` 詳細については、「*AWS IoT API リファレンス*」の「[DescribeDefaultAuthorizer](https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeDefautAuthorizer.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDefaultAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-default-authorizer.html)」を参照してください。 ### `describe-dimension` 次のコード例は、`describe-dimension` を使用する方法を示しています。 **AWS CLI** **ディメンションに関する情報を取得するには** 次の `describe-dimension` の例では、`TopicFilterForAuthMessages` という名前のディメンションに関する情報を取得します。 ``` aws iot describe-dimension \ --name TopicFilterForAuthMessages ``` 出力: ``` { "name": "TopicFilterForAuthMessages", "arn": "arn:aws:iot:eu-west-2:123456789012:dimension/TopicFilterForAuthMessages", "type": "TOPIC_FILTER", "stringValues": [ "device/+/auth" ], "creationDate": 1578620223.255, "lastModifiedDate": 1578620223.255 } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[Detect コマンド](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDimension](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-dimension.html)」を参照してください。 ### `describe-domain-configuration` 次のコード例は、`describe-domain-configuration` を使用する方法を示しています。 **AWS CLI** **ドメイン設定を記述するには** 次の `describe-domain-configuration` の例は、指定されたドメイン設定の詳細を表示します。 ``` aws iot describe-domain-configuration \ --domain-configuration-name "additionalDataDomain" ``` 出力: ``` { "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 } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[設定可能なエンドポイント](https://docs.aws.amazon.com/iot/latest/developerguide/iot-custom-endpoints-configurable-aws.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDomainConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-domain-configuration.html)」を参照してください。 ### `describe-endpoint` 次のコード例は、`describe-endpoint` を使用する方法を示しています。 **AWS CLI** **例 1: 現在の AWS エンドポイントを取得するには** 次の `describe-endpoint` の例は、すべてのコマンドが適用されるデフォルトの AWS エンドポイントを取得します。 ``` aws iot describe-endpoint ``` 出力: ``` { "endpointAddress": "abc123defghijk.iot.us-west-2.amazonaws.com" } ``` 詳細については、「AWS IoT ディベロッパーガイド」の「[DescribeEndpoint](https://docs.aws.amazon.com/iot/latest/developerguide/iot-commands.html#api-iot-DescribeEndpoint)」を参照してください。** **例 2: ATS エンドポイントを取得するには** 次の `describe-endpoint` の例は、Amazon Trust Services (ATS) エンドポイントを取得します。 ``` aws iot describe-endpoint \ --endpoint-type iot:Data-ATS ``` 出力: ``` { "endpointAddress": "abc123defghijk-ats.iot.us-west-2.amazonaws.com" } ``` 詳細については、「AWS IoT ディベロッパーガイド」の「[X.509 証明書と AWS IoT](https://docs.aws.amazon.com/iot/latest/developerguide/managing-device-certs.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-endpoint.html)」を参照してください。** ### `describe-event-configurations` 次のコード例は、`describe-event-configurations` を使用する方法を示しています。 **AWS CLI** **公開されるイベントタイプを表示するには** 次の `describe-event-configurations` の例では、何かを追加、更新、または削除したときに生成されるイベントを制御する設定を一覧表示します。 ``` aws iot describe-event-configurations ``` 出力: ``` { "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 } } } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[イベントメッセージ](https://docs.aws.amazon.com/iot/latest/developerguide/iot-events.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEventConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-event-configurations.html)」を参照してください。 ### `describe-index` 次のコード例は、`describe-index` を使用する方法を示しています。 **AWS CLI** **モノのインデックスの現在のステータスを取得するには** 次の `describe-index` の例では、モノのインデックスの現在のステータスを取得します。 ``` aws iot describe-index \ --index-name "AWS_Things" ``` 出力: ``` { "indexName": "AWS_Things", "indexStatus": "ACTIVE", "schema": "REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[モノのインデックス作成の管理](https://docs.aws.amazon.com/iot/latest/developerguide/managing-index.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeIndex](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-index.html)」を参照してください。 ### `describe-job-execution` 次のコード例は、`describe-job-execution` を使用する方法を示しています。 **AWS CLI** **デバイス上のジョブの実行の詳細を取得するには** 次の `describe-job-execution` の例では、指定されたジョブの実行の詳細を取得します。 ``` aws iot describe-job-execution \ --job-id "example-job-01" \ --thing-name "MyRaspberryPi" ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[ジョブ (CLI) の作成と管理](https://docs.aws.amazon.com/iot/latest/developerguide/manage-job-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeJobExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-job-execution.html)」を参照してください。 ### `describe-job` 次のコード例は、`describe-job` を使用する方法を示しています。 **AWS CLI** **ジョブの詳細なステータスを取得するには** 次の `describe-job` の例では、ID が `example-job-01` のジョブの詳細なステータスを取得します。 ``` aws iot describe-job \ --job-id "example-job-01" ``` 出力: ``` { "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": {} } } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[ジョブ (CLI) の作成と管理](https://docs.aws.amazon.com/iot/latest/developerguide/manage-job-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-job.html)」を参照してください。 ### `describe-mitigation-action` 次のコード例は、`describe-mitigation-action` を使用する方法を示しています。 **AWS CLI** **定義された緩和アクションの詳細を表示するには** 次の `describe-mitigation-action` 例では、指定された緩和アクションの詳細を表示します。 ``` aws iot describe-mitigation-action \ --action-name AddThingsToQuarantineGroupAction ``` 出力: ``` { "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" } ``` 詳細については、「*AWSIoT デベロッパーガイド*」の「[DescribeMitigationAction (緩和アクションコマンド)](https://docs.aws.amazon.com/iot/latest/developerguide/mitigation-action-commands.html#dd-api-iot-DescribeMitigationAction)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeMitigationAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-mitigation-action.html)」を参照してください。 ### `describe-provisioning-template-version` 次のコード例は、`describe-provisioning-template-version` を使用する方法を示しています。 **AWS CLI** **プロビジョニングテンプレートのバージョンを記述するには** 次の `describe-provisioning-template-version` の例では、プロビジョニングテンプレートのバージョンを記述します。 ``` aws iot describe-provisioning-template-version \ --template-name MyTestProvisioningTemplate \ --version-id 1 ``` 出力: ``` { "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 } ``` 詳細については、「*AWS IoT Core デベロッパーガイド*」の「[フリートプロビジョニングを使用したデバイス証明書がないデバイスのプロビジョニング](https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeProvisioningTemplateVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-provisioning-template-version.html)」を参照してください。 ### `describe-provisioning-template` 次のコード例は、`describe-provisioning-template` を使用する方法を示しています。 **AWS CLI** **プロビジョニングテンプレートを記述するには** 次の `describe-provisioning-template` の例では、プロビジョニングテンプレートを記述します。 ``` aws iot describe-provisioning-template \ --template-name MyTestProvisioningTemplate ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT Core デベロッパーガイド*」の「[フリートプロビジョニングを使用したデバイス証明書がないデバイスのプロビジョニング](https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeProvisioningTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-provisioning-template.html)」を参照してください。 ### `describe-role-alias` 次のコード例は、`describe-role-alias` を使用する方法を示しています。 **AWS CLI** **AWS IoT ロールエイリアスに関する情報を取得するには** 次の `describe-role-alias` の例は、指定されたロールエイリアスの詳細情報を表示します。 ``` aws iot describe-role-alias \ --role-alias LightBulbRole ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS IoT API リファレンス*」の「[DescribeRoleAlias](https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeRoleAlias.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeRoleAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-role-alias.html)」を参照してください。 ### `describe-scheduled-audit` 次のコード例は、`describe-scheduled-audit` を使用する方法を示しています。 **AWS CLI** **スケジュールされた監査に関する情報を取得するには** 次の`describe-scheduled-audit`例では、`AWSIoTDeviceDefenderDailyAudit` という名前の AWS IOT Device Defender スケジュールされた監査に関する詳細情報を取得します。 ``` aws iot describe-scheduled-audit \ --scheduled-audit-name AWSIoTDeviceDefenderDailyAudit ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[Audit コマンド](https://docs.aws.amazon.com/iot/latest/developerguide/AuditCommands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeScheduledAudit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-scheduled-audit.html)」を参照してください。 ### `describe-security-profile` 次のコード例は、`describe-security-profile` を使用する方法を示しています。 **AWS CLI** **セキュリティプロファイルに関する情報を取得するには** 次の `describe-security-profile` の例では、`PossibleIssue.` という名前の AWS IoT Device Defender セキュリティプロファイルに関する情報を取得します。 ``` aws iot describe-security-profile \ --security-profile-name PossibleIssue ``` 出力: ``` { "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 } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[Detect コマンド](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeSecurityProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-security-profile.html)」を参照してください。 ### `describe-stream` 次のコード例は、`describe-stream` を使用する方法を示しています。 **AWS CLI** **ストリームに関する情報を取得するには** 次の `describe-stream` の例は、指定されたストリームの詳細を表示します。 ``` aws iot describe-stream \ --stream-id stream12345 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS IoT API リファレンス*」の「[DescribeStream](https://docs.aws.amazon.com/iot/latest/apireference/API_DescribeStream.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-stream.html)」を参照してください。** ### `describe-thing-group` 次のコード例は、`describe-thing-group` を使用する方法を示しています。 **AWS CLI** **モノのグループに関する情報を取得するには** 次の `describe-thing-group` の例では、`HalogenBulbs` という名前のモノのグループに関する情報を取得します。 ``` aws iot describe-thing-group \ --thing-group-name HalogenBulbs ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[モノのグループ](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeThingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-thing-group.html)」を参照してください。 ### `describe-thing-type` 次のコード例は、`describe-thing-type` を使用する方法を示しています。 **AWS CLI** **モノのタイプに関する情報を取得するには** 次の `describe-thing-type` の例では、AWS アカウントで定義されている指定されたモノのタイプに関する情報を表示します。 ``` aws iot describe-thing-type \ --thing-type-name "LightBulb" ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS IoT デベロッパーガイド*」「[モノのタイプ](https://docs.aws.amazon.com/iot/latest/developerguide/thing-types.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeThingType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-thing-type.html)」を参照してください。 ### `describe-thing` 次のコード例は、`describe-thing` を使用する方法を示しています。 **AWS CLI** **モノに関する詳細情報を表示するには** 次の `describe-thing` 例では、AWS アカウントの AWS IoT レジストリで定義されているモノ (デバイス) に関する情報を表示します。 aws iot describe-thing --thing-name "MyLightBulb" 出力: ``` { "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 } ``` 詳細については、「AWS IoT ディベロッパーガイド」の「[レジストリによるモノの管理方法](https://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/describe-thing.html)」を参照してください。 ### `detach-policy` 次のコード例は、`detach-policy` を使用する方法を示しています。 **AWS CLI** **例 1: AWS IoT ポリシーをモノのグループからデタッチするには** 次の `detach-policy` の例では、指定されたポリシーをモノのグループからデタッチし、さらにそのグループとそのグループの子グループからすべてのモノをデタッチします。 ``` aws iot detach-policy \ --target "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" \ --policy-name "MyFirstGroup_Core-policy" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[モノのグループ](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html)」を参照してください。 **例 2: デバイス証明書から AWS IoT ポリシーをデタッチするには** 次の `detach-policy` の例では、ARN によって識別されるデバイス証明書から TemperatureSensorPolicy ポリシーをデタッチします。 ``` aws iot detach-policy \ --policy-name TemperatureSensorPolicy \ --target arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142 ``` このコマンドでは何も出力されません。 + API の詳細については、AWS CLI コマンドリファレンスの「[DetachPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/detach-policy.html)」を参照してください。** ### `detach-security-profile` 次のコード例は、`detach-security-profile` を使用する方法を示しています。 **AWS CLI** **ターゲットからセキュリティプロファイルの関連付けを解除するには** 次の `detach-security-profile` の例では、`Testprofile` という名前の AWS IoT Device Defender セキュリティプロファイルと、登録されたすべてのモノのターゲットとの関連付けを削除します。 ``` aws iot detach-security-profile \ --security-profile-name Testprofile \ --security-profile-target-arn "arn:aws:iot:us-west-2:123456789012:all/registered-things" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[Detect コマンド](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DetachSecurityProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/detach-security-profile.html)」を参照してください。 ### `detach-thing-principal` 次のコード例は、`detach-thing-principal` を使用する方法を示しています。 **AWS CLI** **モノから証明書/プリンシパルをデタッチするには** 次の `detach-thing-principal` 例では、指定されたモノからプリンシパルを表す証明書を削除します。 ``` aws iot detach-thing-principal \ --thing-name "MyLightBulb" \ --principal "arn:aws:iot:us-west-2:123456789012:cert/604c48437a57b7d5fc5d137c5be75011c6ee67c9a6943683a1acb4b1626bac36" ``` このコマンドでは何も出力されません。 詳細については、「AWS IoT ディベロッパーガイド」の「[レジストリによるモノの管理方法](https://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DetachThingPrincipal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/detach-thing-principal.html)」を参照してください。 ### `disable-topic-rule` 次のコード例は、`disable-topic-rule` を使用する方法を示しています。 **AWS CLI** **トピックルールを無効にするには** 次の `disable-topic-rule` の例では、指定したトピックルールを無効にします。 ``` aws iot disable-topic-rule \ --rule-name "MyPlantPiMoistureAlertRule" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[ルールの表示](https://docs.aws.amazon.com/iot/latest/developerguide/iot-view-rules.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisableTopicRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/disable-topic-rule.html)」を参照してください。 ### `enable-topic-rule` 次のコード例は、`enable-topic-rule` を使用する方法を示しています。 **AWS CLI** **トピックルールを有効にするには** 次の `enable-topic-rule` の例では、指定されたトピックルールを有効化 (または再有効化) します。 ``` aws iot enable-topic-rule \ --rule-name "MyPlantPiMoistureAlertRule" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[ルールの表示](https://docs.aws.amazon.com/iot/latest/developerguide/iot-view-rules.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EnableTopicRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/enable-topic-rule.html)」を参照してください。 ### `get-behavior-model-training-summaries` 次のコード例は、`get-behavior-model-training-summaries` を使用する方法を示しています。 **AWS CLI** **Device Defender の ML Detect Security Profile トレーニングモデルのステータスを一覧表示するには** 次の `get-behavior-model-training-summaries` の例では、選択したセキュリティプロファイルで設定された動作のモデルトレーニングのステータスを一覧表示します。動作ごとに、収集されたデータポイントの名前、モデルステータス、およびパーセンテージが一覧表示されます。 ``` aws iot get-behavior-model-training-summaries \ --security-profile-name MySecuirtyProfileName ``` 出力: ``` { "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 } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[GetBehaviorModelTrainingSummaries (Detect コマンド)](https://docs.aws.amazon.com/iot/latest/developerguide/detect-commands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetBehaviorModelTrainingSummaries](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-behavior-model-training-summaries.html)」を参照してください。 ### `get-cardinality` 次のコード例は、`get-cardinality` を使用する方法を示しています。 **AWS CLI** **クエリに一致する一意の値のおおよその数を返すには** 次のセットアップスクリプトを使用して、10 個の温度センサーを表す 10 個のモノを作成できます。新しいモノにはそれぞれ 3 つの属性があります。 ``` # 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 ``` セットアップスクリプトの出力例: ``` { "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" } ``` 次の `get-cardinality` の例では、セットアップスクリプトによって作成された 10 個のセンサーをクエリし、温度センサーが異常な温度値を報告しているラックの数を返します。温度値が 60 未満または 80 を超過する場合、温度センサーは異常な状態になります。 ``` aws iot get-cardinality \ --aggregation-field "attributes.rackId" \ --query-string "thingName:TempSensor* AND attributes.stateNormal:false" ``` 出力: ``` { "cardinality": 2 } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「集計データのクエリ」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetCardinality](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-cardinality.html)」を参照してください。 ### `get-effective-policies` 次のコード例は、`get-effective-policies` を使用する方法を示しています。 **AWS CLI** **モノに影響するポリシーを一覧表示するには** 次の `get-effective-policies` の例では、指定されたモノに影響するポリシーを一覧表示します。これには、それが属するすべてのグループにアタッチされたポリシーが含まれます。 ``` aws iot get-effective-policies \ --thing-name TemperatureSensor-001 \ --principal arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142 ``` 出力: ``` { "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\" ] } ] }" } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の[「モノで有効なポリシーを取得する](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html#group-get-effective-policies)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetEffectivePolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-effective-policies.html)」を参照してください。 ### `get-indexing-configuration` 次のコード例は、`get-indexing-configuration` を使用する方法を示しています。 **AWS CLI** **モノのインデックス作成設定を取得するには** 次の `get-indexing-configuration` の例では、AWS IoT フリートインデックス作成の現在の設定データを取得します。 ``` aws iot get-indexing-configuration ``` 出力: ``` { "thingIndexingConfiguration": { "thingIndexingMode": "OFF", "thingConnectivityIndexingMode": "OFF" }, "thingGroupIndexingConfiguration": { "thingGroupIndexingMode": "OFF" } } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[モノのインデックス作成の管理](https://docs.aws.amazon.com/iot/latest/developerguide/managing-index.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetIndexingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-indexing-configuration.html)」を参照してください。 ### `get-job-document` 次のコード例は、`get-job-document` を使用する方法を示しています。 **AWS CLI** **ジョブのドキュメントを取得するには** 次の `get-job-document` の例では、ID が `example-job-01` のジョブのドキュメントの詳細を表示します。 ``` aws iot get-job-document \ --job-id "example-job-01" ``` 出力: ``` { "document": "\n{\n \"operation\":\"customJob\",\n \"otherInfo\":\"someValue\"\n}\n" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[ジョブ (CLI) の作成と管理](https://docs.aws.amazon.com/iot/latest/developerguide/manage-job-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetJobDocument](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-job-document.html)」を参照してください。 ### `get-logging-options` 次のコード例は、`get-logging-options` を使用する方法を示しています。 **AWS CLI** **ログ記録オプションを取得するには** 次の `get-logging-options` の例では、AWS アカウントの現在のログ記録オプションを取得します。 ``` aws iot get-logging-options ``` 出力: ``` { "roleArn": "arn:aws:iam::123456789012:role/service-role/iotLoggingRole", "logLevel": "ERROR" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」のタイトルを参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetLoggingOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-logging-options.html)」を参照してください。 ### `get-ota-update` 次のコード例は、`get-ota-update` を使用する方法を示しています。 **AWS CLI** **OTA 更新に関する情報を取得するには** 次の `get-ota-update` の例は、指定された OTA 更新の詳細を表示します。 ``` aws iot get-ota-update \ --ota-update-id ota12345 ``` 出力: ``` { "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": { } } } ``` 詳細については、「*AWS IoT API リファレンス*」の「[GetOTAUpdate](https://docs.aws.amazon.com/iot/latest/apireference/API_GetOTAUpdate.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetOtaUpdate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-ota-update.html)」を参照してください。 ### `get-percentiles` 次のコード例は、`get-percentiles` を使用する方法を示しています。 **AWS CLI** **クエリに一致する集計値をパーセンタイルグループにグループ化するには** 次のセットアップスクリプトを使用して、10 個の温度センサーを表す 10 個のモノを作成できます。新しいモノにはそれぞれ 1 つの属性があります。 ``` # 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 ``` セットアップスクリプトの出力例: ``` { "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" } ``` 次の `get-percentiles` の例では、セットアップスクリプトによって作成された 10 個のセンサーをクエリし、指定されたパーセンタイルグループごとに値を返します。パーセンタイルグループ「10」には、クエリに一致する値の約 10 % に含まれる集計フィールド値が含まれます。次の出力では、\$1"percent": 10.0, "value": 67.7\$1 は、温度値の約 10.0% が 67.7 未満であることを意味します。 ``` aws iot get-percentiles \ --aggregation-field "attributes.temperature" \ --query-string "thingName:TempSensor*" \ --percents 10 25 50 75 90 ``` 出力: ``` { "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 } ] } ``` 詳細については、「*AWSIoT デベロッパーガイド*」の「[「集計データのクエリ](https://docs.aws.amazon.com/iot/latest/developerguide/index-aggregate.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPercentiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-percentiles.html)」を参照してください。 ### `get-policy-version` 次のコード例は、`get-policy-version` を使用する方法を示しています。 **AWS CLI** **ポリシーの特定のバージョンに関する情報を取得するには** 次の `get-policy-version` の例では、指定されたポリシーの最初のバージョンに関する情報を取得します。 ``` aws iot get-policy \ --policy-name UpdateDeviceCertPolicy --policy-version-id "1" ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT ポリシー](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPolicyVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-policy-version.html)」を参照してください。 ### `get-policy` 次のコード例は、`get-policy` を使用する方法を示しています。 **AWS CLI** **ポリシーのデフォルトバージョンに関する情報を取得するには** 次の `get-policy` の例では、指定されたポリシーのデフォルトバージョンに関する情報を取得します。 ``` aws iot get-policy \ --policy-name UpdateDeviceCertPolicy ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT ポリシー](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-policy.html)」を参照してください。 ### `get-registration-code` 次のコード例は、`get-registration-code` を使用する方法を示しています。 **AWS CLI** **AWS アカウント固有の登録コードを取得するには** 次の `get-registration-code` の例では、AWS アカウント固有の登録コードを取得します。 ``` aws iot get-registration-code ``` 出力: ``` { "registrationCode": "15c51ae5e36ba59ba77042df1115862076bea4bd15841c838fcb68d5010a614c" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[独自の証明書を使用する](https://docs.aws.amazon.com/iot/latest/developerguide/device-certs-your-own.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRegistrationCode](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-registration-code.html)」を参照してください。 ### `get-statistics` 次のコード例は、`get-statistics` を使用する方法を示しています。 **AWS CLI** **集計データのデバイスインデックスを検索するには** 次の `get-statistics` の例では、`connectivity.connected` というプロパティがデバイスシャドウで `false` に設定されているモノの数 (つまり、接続されていないデバイスの数) を返します。 ``` aws iot get-statistics \ --index-name AWS_Things \ --query-string "connectivity.connected:false" ``` 出力: ``` { "statistics": { "count": 6 } } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[デバイスフリートに関する統計の取得](https://docs.aws.amazon.com/iot/latest/developerguide/index-aggregate.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetStatistics](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-statistics.html)」を参照してください。 ### `get-topic-rule-destination` 次のコード例は、`get-topic-rule-destination` を使用する方法を示しています。 **AWS CLI** **トピックルールの送信先を取得するには** 次の `get-topic-rule-destination` の例では、トピックルールの送信先に関する情報を取得します。 ``` aws iot get-topic-rule-destination \ --arn "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" ``` 出力: ``` { "topicRuleDestination": { "arn": "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "status": "DISABLED", "httpUrlProperties": { "confirmationUrl": "https://example.com" } } } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[トピックルールの送信先の操作](https://docs.aws.amazon.com/iot/latest/developerguide/rule-destination.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetTopicRuleDestination](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-topic-rule-destination.html)」を参照してください。 ### `get-topic-rule` 次のコード例は、`get-topic-rule` を使用する方法を示しています。 **AWS CLI** **ルールに関する情報を取得するには** 次の `get-topic-rule` の例では、指定されたルールに関する情報を取得します。 ``` aws iot get-topic-rule \ --rule-name MyRPiLowMoistureAlertRule ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[ルールの表示](https://docs.aws.amazon.com/iot/latest/developerguide/iot-managae-rule.html#iot-view-rules)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetTopicRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-topic-rule.html)」を参照してください。 ### `get-v2-logging-options` 次のコード例は、`get-v2-logging-options` を使用する方法を示しています。 **AWS CLI** **現在のログ記録オプションを一覧表示するには** 次の `get-v2-logging-options` の例では、AWS IoT の現在のログ記録オプションを一覧表示します。 ``` aws iot get-v2-logging-options ``` 出力: ``` { "roleArn": "arn:aws:iam::094249569039:role/service-role/iotLoggingRole", "defaultLogLevel": "WARN", "disableAllLogs": false } ``` 詳細については、「*AWS IoT デベロッパーガイド*」のタイトルを参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetV2LoggingOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/get-v2-logging-options.html)」を参照してください。 ### `list-active-violations` 次のコード例は、`list-active-violations` を使用する方法を示しています。 **AWS CLI** **アクティブな違反を一覧表示するには** 次の `list-active-violations` の例では、指定されたセキュリティプロファイルに対するすべての違反を一覧表示します。 ``` aws iot list-active-violations \ --security-profile-name Testprofile ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListActiveViolations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-active-violations.html)」を参照してください。 ### `list-attached-policies` 次のコード例は、`list-attached-policies` を使用する方法を示しています。 **AWS CLI** **例 1: グループにアタッチされるポリシーを一覧表示するには** 次の `list-attached-policies` の例では、指定されたグループにアタッチされているポリシーを一覧表示します。 ``` aws iot list-attached-policies \ --target "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" ``` 出力: ``` { "policies": [ { "policyName": "UpdateDeviceCertPolicy", "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/UpdateDeviceCertPolicy" } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[モノのグループ](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html)」を参照してください。 **例 2: デバイス証明書にアタッチされたポリシーを一覧表示するには** 次の `list-attached-policies` の例では、デバイス証明書にアタッチされた AWS IoT ポリシーを一覧表示します。証明書は ARN によって識別されます。 ``` aws iot list-attached-policies \ --target arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142 ``` 出力: ``` { "policies": [ { "policyName": "TemperatureSensorPolicy", "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TemperatureSensorPolicy" } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[モノのグループ](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAttachedPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-attached-policies.html)」を参照してください。 ### `list-audit-findings` 次のコード例は、`list-audit-findings` を使用する方法を示しています。 **AWS CLI** **例 1: 監査のすべての検出結果を一覧表示するには** 次の `list-audit-findings` の例では、指定されたタスク ID を持つ AWS IoT Device Defender 監査のすべての検出結果を一覧表示します。 ``` aws iot list-audit-findings \ --task-id a3aea009955e501a31b764abe1bebd3d ``` 出力: ``` { "findings": [] } ``` **例 2: 監査チェックタイプの検出結果を一覧表示するには** 次の `list-audit-findings` の例では、デバイスがデバイス証明書を共有している 2019 年 6 月 5 日から 2019 年 6 月 19 日の間に実行された AWS IoT Device Defender 監査の検出結果を示しています。チェック名を指定するときは、開始時刻と終了時刻を指定する必要があります。 ``` aws iot list-audit-findings \ --check-name DEVICE_CERTIFICATE_SHARED_CHECK \ --start-time 1559747125 \ --end-time 1560962028 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[Audit コマンド](https://docs.aws.amazon.com/iot/latest/developerguide/AuditCommands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAuditFindings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-audit-findings.html)」を参照してください。 ### `list-audit-mitigation-actions-executions` 次のコード例は、`list-audit-mitigation-actions-executions` を使用する方法を示しています。 **AWS CLI** **監査緩和アクションの実行の詳細を一覧表示するには** 監査緩和アクションタスクは、AWS IoT Device Defender 監査からの 1 つまたは複数の検出結果に緩和アクションを適用します。次の `list-audit-mitigation-actions-executions` の例では、指定された `taskId` と指定された検出結果の緩和アクションタスクの詳細を一覧表示します。 ``` aws iot list-audit-mitigation-actions-executions \ --task-id myActionsTaskId \ --finding-id 0edbaaec-2fe1-4cf5-abc9-d4c3e51f7464 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWSIoT デベロッパーガイド*」の「[ListAuditMitigationActionsExecutions (緩和アクションコマンド)](https://docs.aws.amazon.com/iot/latest/developerguide/mitigation-action-commands.html#dd-api-iot-ListAuditMitigationActionsExecutions)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAuditMitigationActionsExecutions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-audit-mitigation-actions-executions.html)」を参照してください。 ### `list-audit-mitigation-actions-tasks` 次のコード例は、`list-audit-mitigation-actions-tasks` を使用する方法を示しています。 **AWS CLI** **監査緩和アクションタスクを一覧表示するには** 次の `list-audit-mitigation-actions-tasks` の例では、指定された期間内に検出結果に適用された緩和アクションを一覧表示します。 ``` aws iot list-audit-mitigation-actions-tasks \ --start-time 1594157400 \ --end-time 1594157430 ``` 出力: ``` { "tasks": [ { "taskId": "0062f2d6-3999-488f-88c7-bef005414103", "startTime": "2020-07-07T14:30:15.172000-07:00", "taskStatus": "COMPLETED" } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[ListAuditMitigationActionsTasks (緩和アクションコマンド)](https://docs.aws.amazon.com/iot/latest/developerguide/mitigation-action-commands.html#dd-api-iot-ListAuditMitigationActionsTasks)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAuditMitigationActionsTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-audit-mitigation-actions-tasks.html)」を参照してください。 ### `list-audit-suppressions` 次のコード例は、`list-audit-suppressions` を使用する方法を示しています。 **AWS CLI** **すべての監査検出結果の抑制を一覧表示するには** 次の `list-audit-suppressions` の例では、アクティブな監査検出結果の抑制をすべて一覧表示します。 ``` aws iot list-audit-suppressions ``` 出力: ``` { "suppressions": [ { "checkName": "DEVICE_CERTIFICATE_EXPIRING_CHECK", "resourceIdentifier": { "deviceCertificateId": "c7691e" }, "expirationDate": 1597881600.0, "suppressIndefinitely": false } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[監査の検出結果の抑制](https://docs.aws.amazon.com/iot/latest/developerguide/audit-finding-suppressions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAuditSuppressions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-audit-suppressions.html)」を参照してください。 ### `list-audit-tasks` 次のコード例は、`list-audit-tasks` を使用する方法を示しています。 **AWS CLI** **監査からのすべての検出結果を一覧表示するには** 次の `list-audit-tasks` の例では、2019 年 6 月 5 日から 2019 年 6 月 12 日の間に実行された監査タスクを一覧表示します。 ``` aws iot list-audit-tasks \ --start-time 1559747125 \ --end-time 1560357228 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[Audit コマンド](https://docs.aws.amazon.com/iot/latest/developerguide/AuditCommands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAuditTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-audit-tasks.html)」を参照してください。 ### `list-authorizers` 次のコード例は、`list-authorizers` を使用する方法を示しています。 **AWS CLI** **カスタムオーソライザーを一覧表示するには** 次の `list-authorizers` の例では、AWS アカウントのカスタムオーソライザーを一覧表示します。 ``` aws iot list-authorizers ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IoT API リファレンス*」の「[ListAuthorizers](https://docs.aws.amazon.com/iot/latest/apireference/API_ListAuthorizers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAuthorizers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-authorizers.html)」を参照してください。 ### `list-billing-groups` 次のコード例は、`list-billing-groups` を使用する方法を示しています。 **AWS CLI** **AWS アカウントとリージョンの請求グループを一覧表示するには** 次の `list-billing-groups` の例では、AWS アカウントと AWS リージョンに定義されているすべての請求グループを一覧表示します。 ``` aws iot list-billing-groups ``` 出力: ``` { "billingGroups": [ { "groupName": "GroupOne", "groupArn": "arn:aws:iot:us-west-2:123456789012:billinggroup/GroupOne" } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[請求グループ](https://docs.aws.amazon.com/iot/latest/developerguide/tagging-iot-billing-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListBillingGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-billing-groups.html)」を参照してください。 ### `list-ca-certificates` 次のコード例は、`list-ca-certificates` を使用する方法を示しています。 **AWS CLI** **AWS アカウントに登録済みの CA 証明書を一覧表示するには** 次の `list-ca-certificates` の例では、AWS アカウントに登録されている CA 証明書を一覧表示します。 ``` aws iot list-ca-certificates ``` 出力: ``` { "certificates": [ { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cacert/f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467", "certificateId": "f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467", "status": "INACTIVE", "creationDate": 1569365372.053 } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[独自の証明書を使用する](https://docs.aws.amazon.com/iot/latest/developerguide/device-certs-your-own.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListCaCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-ca-certificates.html)」を参照してください。 ### `list-certificates-by-ca` 次のコード例は、`list-certificates-by-ca` を使用する方法を示しています。 **AWS CLI** **CA 証明書で署名されたすべてのデバイス証明書を一覧表示するには** 次の `list-certificates-by-ca` の例では、指定された CA 証明書で署名された AWS アカウント内のすべてのデバイス証明書を一覧表示します。 ``` aws iot list-certificates-by-ca \ --ca-certificate-id f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467 ``` 出力: ``` { "certificates": [ { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", "certificateId": "488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", "status": "ACTIVE", "creationDate": 1569363250.557 } ] } ``` 詳細については、「*AWS IoT API リファレンス*」の「[ListCertificatesByCA](https://docs.aws.amazon.com/iot/latest/apireference/API_ListCertificatesByCA.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListCertificatesByCa](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-certificates-by-ca.html)」を参照してください。 ### `list-certificates` 次のコード例は、`list-certificates` を使用する方法を示しています。 **AWS CLI** **例 1: AWS アカウントに登録済みの証明書を一覧表示するには** 次の `list-certificates` 例では、アカウントに登録されているすべての証明書を一覧表示します。デフォルトのページング制限数が 25 を超える場合は、このコマンドの `nextMarker` レスポンス値を使用して次のコマンドに指定し、結果の次のバッチを取得できます。`nextMarker` が値なしで返すまで繰り返します。 ``` aws iot list-certificates ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-certificates.html)」を参照してください。 ### `list-custom-metrics` 次のコード例は、`list-custom-metrics` を使用する方法を示しています。 **AWS CLI** **カスタムメトリクスを一覧表示するには** 以下の `list-custom-metrics` 例では、すべてのカスタムメトリクスをリストアップします。 ``` aws iot list-custom-metrics \ --region us-east-1 ``` 出力: ``` { "metricNames": [ "batteryPercentage" ] } ``` 詳細については、「*AWS IoT Core デベロッパーガイド*」の「[カスタムメトリクス](https://docs.aws.amazon.com/iot/latest/developerguide/dd-detect-custom-metrics.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListCustomMetrics](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-custom-metrics.html)」を参照してください。 ### `list-dimensions` 次のコード例は、`list-dimensions` を使用する方法を示しています。 **AWS CLI** **AWS アカウントのディメンションを一覧表示するには** 次の `list-dimensions` の例では、AWS アカウントで定義されているすべての AWS IoT Device Defender ディメンションを一覧表示します。 ``` aws iot list-dimensions ``` 出力: ``` { "dimensionNames": [ "TopicFilterForAuthMessages", "TopicFilterForActivityMessages" ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[Detect コマンド](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDimensions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-dimensions.html)」を参照してください。 ### `list-domain-configurations` 次のコード例は、`list-domain-configurations` を使用する方法を示しています。 **AWS CLI** **ドメイン設定を一覧表示するには** 次の `list-domain-configurations` の例では、指定されたサービスタイプを持つ AWS アカウントのドメイン設定を一覧表示します。 ``` aws iot list-domain-configurations \ --service-type "DATA" ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[設定可能なエンドポイント](https://docs.aws.amazon.com/iot/latest/developerguide/iot-custom-endpoints-configurable-aws.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDomainConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-domain-configurations.html)」を参照してください。 ### `list-indices` 次のコード例は、`list-indices` を使用する方法を示しています。 **AWS CLI** **設定された検索インデックスを一覧表示するには** 次の `list-indices` の例では、AWS アカウントで設定されたすべての検索インデックスを一覧表示します。モノのインデックス作成を有効にしていない場合は、インデックスがない可能性があります。 ``` aws iot list-indices ``` 出力: ``` { "indexNames": [ "AWS_Things" ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[モノのインデックス作成の管理](https://docs.aws.amazon.com/iot/latest/developerguide/managing-index.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListIndices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-indices.html)」を参照してください。 ### `list-job-executions-for-job` 次のコード例は、`list-job-executions-for-job` を使用する方法を示しています。 **AWS CLI** **AWS アカウントのジョブを一覧表示するには** 次の `list-job-executions-for-job` の例では、jobId で指定された AWS アカウント内のジョブのすべてのジョブ実行を一覧表示します。 ``` aws iot list-job-executions-for-job \ --job-id my-ota-job ``` 出力: ``` { "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 } } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[ジョブ (CLI) の作成と管理](https://docs.aws.amazon.com/iot/latest/developerguide/manage-job-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListJobExecutionsForJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-job-executions-for-job.html)」を参照してください。 ### `list-job-executions-for-thing` 次のコード例は、`list-job-executions-for-thing` を使用する方法を示しています。 **AWS CLI** **モノに対して実行されたジョブを一覧表示するには** 次の `list-job-executions-for-thing` の例では、`MyRaspberryPi` という名前のモノに対して実行されたすべてのジョブを一覧表示します。 ``` aws iot list-job-executions-for-thing \ --thing-name "MyRaspberryPi" ``` 出力: ``` { "executionSummaries": [ { "jobId": "example-job-01", "jobExecutionSummary": { "status": "QUEUED", "queuedAt": 1560787023.636, "lastUpdatedAt": 1560787023.636, "executionNumber": 1 } } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[ジョブ (CLI) の作成と管理](https://docs.aws.amazon.com/iot/latest/developerguide/manage-job-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListJobExecutionsForThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-job-executions-for-thing.html)」を参照してください。 ### `list-jobs` 次のコード例は、`list-jobs` を使用する方法を示しています。 **AWS CLI** **AWS アカウントのジョブを一覧表示するには** 次の `list-jobs` の例では、ジョブステータスでソートされた AWS アカウント内のすべてのジョブを一覧表示します。 ``` aws iot list-jobs ``` 出力: ``` { "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 } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[ジョブ (CLI) の作成と管理](https://docs.aws.amazon.com/iot/latest/developerguide/manage-job-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-jobs.html)」を参照してください。 ### `list-mitigation-actions` 次のコード例は、`list-mitigation-actions` を使用する方法を示しています。 **AWS CLI** **定義されたすべての緩和アクションを一覧表示するには** 次の `list-mitigation-actions` の例では、リージョンの AWS アカウントに対して定義されたすべての緩和アクションを一覧表示します。アクションごとに、名前、ARN、作成日が一覧表示されます。 ``` aws iot list-mitigation-actions ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWSIoT デベロッパーガイド*」の「[ListMitigationActions (緩和アクションコマンド)](https://docs.aws.amazon.com/iot/latest/developerguide/mitigation-action-commands.html#dd-api-iot-ListMitigationActions)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListMitigationActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-mitigation-actions.html)」を参照してください。 ### `list-mitigations-actions` 次のコード例は、`list-mitigations-actions` を使用する方法を示しています。 **AWS CLI** **定義されたすべての緩和アクションを一覧表示するには** 次の `list-mitigations-actions` の例では、リージョンの AWS アカウントに対して定義されたすべての緩和アクションを一覧表示します。アクションごとに、名前、ARN、作成日が一覧表示されます。 ``` aws iot list-mitigation-actions ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWSIoT デベロッパーガイド*」の「[ListMitigationActions (緩和アクションコマンド)](https://docs.aws.amazon.com/iot/latest/developerguide/mitigation-action-commands.html#dd-api-iot-ListMitigationActions)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListMitigationsActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-mitigations-actions.html)」を参照してください。 ### `list-ota-updates` 次のコード例は、`list-ota-updates` を使用する方法を示しています。 **AWS CLI** **アカウントの OTA 更新を一覧表示するには** 次の `list-ota-updates` の例では、使用可能な OTA 更新を一覧表示します。 ``` aws iot list-ota-updates ``` 出力: ``` { "otaUpdates": [ { "otaUpdateId": "itsaupdate", "otaUpdateArn": "arn:aws:iot:us-west-2:123456789012:otaupdate/itsaupdate", "creationDate": 1557863215.995 } ] } ``` 詳細については、「*AWS IoT API リファレンス*」の「[ListOTAUpdates](https://docs.aws.amazon.com/iot/latest/apireference/API_ListOTAUpdates.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListOtaUpdates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-ota-updates.html)」を参照してください。 ### `list-outgoing-certificates` 次のコード例は、`list-outgoing-certificates` を使用する方法を示しています。 **AWS CLI** **別の AWS アカウントに転送される証明書を一覧表示するには** 次の `list-outgoing-certificates` の例では、`transfer-certificate` コマンドを使用して別の AWS アカウントに転送されているすべてのデバイス証明書を一覧表示します。 ``` aws iot list-outgoing-certificates ``` 出力: ``` { "outgoingCertificates": [ { "certificateArn": "arn:aws:iot:us-west-2:030714055129:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", "certificateId": "488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", "transferredTo": "030714055129", "transferDate": 1569427780.441, "creationDate": 1569363250.557 } ] } ``` 詳細については、「*AWS IoT API リファレンス*」の「[ListOutgoingCertificates](https://docs.aws.amazon.com/iot/latest/apireference/API_ListOutgoingCertificates.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListOutgoingCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-outgoing-certificates.html)」を参照してください。 ### `list-policies` 次のコード例は、`list-policies` を使用する方法を示しています。 **AWS CLI** **AWS アカウントで定義されているポリシーを一覧表示するには** 次の `list-policies` の例では、AWS アカウントで定義されているすべてのポリシーを一覧表示します。 ``` aws iot list-policies ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT ポリシー](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html)」を参照してください。 + API の詳細については、「AWS CLI Command Reference」の「[ListPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-policies.html)」を参照してください。** ### `list-policy-versions` 次のコード例は、`list-policy-versions` を使用する方法を示しています。 **AWS CLI** **例 1: ポリシーのすべてのバージョンを表示するには** 次の `list-policy-versions` の例では、指定されたポリシーのすべてのバージョンとその作成日を一覧表示します。 ``` aws iot list-policy-versions \ --policy-name LightBulbPolicy ``` 出力: ``` { "policyVersions": [ { "versionId": "2", "isDefaultVersion": true, "createDate": 1559925941.924 }, { "versionId": "1", "isDefaultVersion": false, "createDate": 1559925941.924 } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT ポリシー](https://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPolicyVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-policy-versions.html)」を参照してください。 ### `list-principal-things` 次のコード例は、`list-principal-things` を使用する方法を示しています。 **AWS CLI** **プリンシパルにアタッチされたモノを一覧表示するには** 次の `list-principal-things` の例では、ARN によって指定されたプリンシパルにアタッチされたモノを一覧表示します。 ``` aws iot list-principal-things \ --principal arn:aws:iot:us-west-2:123456789012:cert/2e1eb273792174ec2b9bf4e9b37e6c6c692345499506002a35159767055278e8 ``` 出力: ``` { "things": [ "DeskLamp", "TableLamp" ] } ``` 詳細については、「*AWS IoT API リファレンス*」の「[ListPrincipalThings](https://docs.aws.amazon.com/iot/latest/apireference/API_ListPrincipleThings.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPrincipalThings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-principal-things.html)」を参照してください。 ### `list-provisioning-template-versions` 次のコード例は、`list-provisioning-template-versions` を使用する方法を示しています。 **AWS CLI** **プロビジョニングテンプレートのバージョンを一覧表示するには** 次の `list-provisioning-template-versions` の例では、指定されたプロビジョニングテンプレートの使用可能なバージョンを一覧表示します。 ``` aws iot list-provisioning-template-versions \ --template-name "widget-template" ``` 出力: ``` { "versions": [ { "versionId": 1, "creationDate": 1574800471.339, "isDefaultVersion": true }, { "versionId": 2, "creationDate": 1574801192.317, "isDefaultVersion": false } ] } ``` 詳細については、「*AWS IoT Core デベロッパーガイド*」の「[AWS セキュアトンネリング](https://docs.aws.amazon.com/iot/latest/developerguide/secure-tunneling.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListProvisioningTemplateVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-provisioning-template-versions.html)」を参照してください。 ### `list-provisioning-templates` 次のコード例は、`list-provisioning-templates` を使用する方法を示しています。 **AWS CLI** **プロビジョニングテンプレートを一覧表示するには** 次の `list-provisioning-templates` の例では、AWS アカウント内のすべてのプロビジョニングテンプレートを一覧表示します。 ``` aws iot list-provisioning-templates ``` 出力: ``` { "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 } ] } ``` 詳細については、「*AWS IoT Core デベロッパーガイド*」の「[AWS セキュアトンネリング](https://docs.aws.amazon.com/iot/latest/developerguide/secure-tunneling.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListProvisioningTemplates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-provisioning-templates.html)」を参照してください。 ### `list-role-aliases` 次のコード例は、`list-role-aliases` を使用する方法を示しています。 **AWS CLI** **AWS アカウントの AWS IoT ロールエイリアスを一覧表示するには** 次の `list-role-aliases` 例では、AWS アカウントの AWS IoT ロールエイリアスを一覧表示します。 ``` aws iot list-role-aliases ``` 出力: ``` { "roleAliases": [ "ResidentAlias", "ElectricianAlias" ] } ``` 詳細については、「*AWS IoT API リファレンス*」の「[ListRoleAliases](https://docs.aws.amazon.com/iot/latest/apireference/API_ListRoleAliases.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRoleAliases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-role-aliases.html)」を参照してください。 ### `list-scheduled-audits` 次のコード例は、`list-scheduled-audits` を使用する方法を示しています。 **AWS CLI** **AWS アカウントのスケジュールされた監査を一覧表示するには** 次の `list-scheduled-audits` の例では、AWS アカウントにスケジュールされた監査を一覧表示します。 ``` aws iot list-scheduled-audits ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[Audit コマンド](https://docs.aws.amazon.com/iot/latest/developerguide/AuditCommands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListScheduledAudits](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-scheduled-audits.html)」を参照してください。 ### `list-security-profiles-for-target` 次のコード例は、`list-security-profiles-for-target` を使用する方法を示しています。 **AWS CLI** **ターゲットにアタッチされたセキュリティプロファイルを一覧表示するには** 次の `list-security-profiles-for-target` の例では、未登録のデバイスにアタッチされている AWS IoT Device Defender セキュリティプロファイルを一覧表示します。 ``` aws iot list-security-profiles-for-target \ --security-profile-target-arn "arn:aws:iot:us-west-2:123456789012:all/unregistered-things" ``` 出力: ``` { "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" } } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[Detect コマンド](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListSecurityProfilesForTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-security-profiles-for-target.html)」を参照してください。 ### `list-security-profiles` 次のコード例は、`list-security-profiles` を使用する方法を示しています。 **AWS CLI** **AWS アカウントのセキュリティプロファイルを一覧表示するには** 次の `list-security-profiles` の例では、AWS アカウントで定義されているすべての AWS IoT Device Defender セキュリティプロファイルを一覧表示します。 ``` aws iot list-security-profiles ``` 出力: ``` { "securityProfileIdentifiers": [ { "name": "Testprofile", "arn": "arn:aws:iot:us-west-2:123456789012:securityprofile/Testprofile" } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[Detect コマンド](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListSecurityProfiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-security-profiles.html)」を参照してください。 ### `list-streams` 次のコード例は、`list-streams` を使用する方法を示しています。 **AWS CLI** **アカウントのストリームを一覧表示するには** 次の `list-streams` の例では、AWS アカウント内のすべてのストリームを一覧表示します。 ``` aws iot list-streams ``` 出力: ``` { "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." } ] } ``` 詳細については、「*AWS IoT API リファレンス*」の「[ListStreams](https://docs.aws.amazon.com/iot/latest/apireference/API_ListStreams.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[ListStreams](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-streams.html)」を参照してください。** ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **リソースに関連付けられたタグとその値を表示するには** 次の `list-tags-for-resource` の例では、モノのグループ `LightBulbs` に関連付けられたタグと値を表示します。 ``` aws iot list-tags-for-resource \ --resource-arn "arn:aws:iot:us-west-2:094249569039:thinggroup/LightBulbs" ``` 出力: ``` { "tags": [ { "Key": "Assembly", "Value": "Fact1NW" }, { "Key": "MyTag", "Value": "777" } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT リソースのタグ付け](https://docs.aws.amazon.com/iot/latest/developerguide/tagging-iot.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-tags-for-resource.html)」を参照してください。 ### `list-targets-for-policy` 次のコード例は、`list-targets-for-policy` を使用する方法を示しています。 **AWS CLI** **AWS IoT ポリシーに関連付けられているプリンシパルを一覧表示するには** 次の `list-targets-for-policy` の例では、指定されたポリシーがアタッチされているデバイス証明書を一覧表示します。 ``` aws iot list-targets-for-policy \ --policy-name UpdateDeviceCertPolicy ``` 出力: ``` { "targets": [ "arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", "arn:aws:iot:us-west-2:123456789012:cert/d1eb269fb55a628552143c8f96eb3c258fcd5331ea113e766ba0c82bf225f0be" ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[モノのグループ](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTargetsForPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-targets-for-policy.html)」を参照してください。 ### `list-targets-for-security-profile` 次のコード例は、`list-targets-for-security-profile` を使用する方法を示しています。 **AWS CLI** **セキュリティプロファイルが適用されるターゲットを一覧表示するには** 次の `list-targets-for-security-profile` の例では、`PossibleIssue` という名前の AWS IoT Device Defender セキュリティプロファイルが適用されるターゲットを一覧表示します。 ``` aws iot list-targets-for-security-profile \ --security-profile-name Testprofile ``` 出力: ``` { "securityProfileTargets": [ { "arn": "arn:aws:iot:us-west-2:123456789012:all/unregistered-things" }, { "arn": "arn:aws:iot:us-west-2:123456789012:all/registered-things" } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[Detect コマンド](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTargetsForSecurityProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-targets-for-security-profile.html)」を参照してください。 ### `list-thing-groups-for-thing` 次のコード例は、`list-thing-groups-for-thing` を使用する方法を示しています。 **AWS CLI** **モノが属するモノのグループを一覧表示するには** 次の `list-thing-groups-for-thing` の例では、指定されたモノが属するグループを一覧表示します。 ``` aws iot list-thing-groups-for-thing \ --thing-name MyLightBulb ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[モノのグループ](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListThingGroupsForThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-thing-groups-for-thing.html)」を参照してください。 ### `list-thing-groups` 次のコード例は、`list-thing-groups` を使用する方法を示しています。 **AWS CLI** **AWS アカウントで定義されたモノのグループを一覧表示するには** 次の `describe-thing-group` の例では、AWS アカウントで定義されているすべてのモノのグループを一覧表示します。 ``` aws iot list-thing-groups ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[モノのグループ](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListThingGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-thing-groups.html)」を参照してください。 ### `list-thing-principals` 次のコード例は、`list-thing-principals` を使用する方法を示しています。 **AWS CLI** **モノに関連付けられているプリンシパルを一覧表示するには** 次の `list-thing-principals` の例では、指定されたモノに関連付けられているプリンシパル (X.509 証明書、IAM ユーザー、グループ、ロール、Amazon Cognito ID、またはフェデレーティッド ID) を一覧表示します。 ``` aws iot list-thing-principals \ --thing-name MyRaspberryPi ``` 出力: ``` { "principals": [ "arn:aws:iot:us-west-2:123456789012:cert/33475ac865079a5ffd5ecd44240640349293facc760642d7d8d5dbb6b4c86893" ] } ``` 詳細については、「*AWS IoT API リファレンス*」の「[ListThingPrincipals](https://docs.aws.amazon.com/iot/latest/apireference/API_ListThingPrincipals.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListThingPrincipals](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-thing-principals.html)」を参照してください。 ### `list-thing-types` 次のコード例は、`list-thing-types` を使用する方法を示しています。 **AWS CLI** **定義されたモノのタイプを一覧表示するには** 次の `list-thing-types` の例では、AWS アカウントで定義されているモノのタイプのリストを表示します。 ``` aws iot list-thing-types ``` 出力: ``` { "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 } } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」「[モノのタイプ](https://docs.aws.amazon.com/iot/latest/developerguide/thing-types.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListThingTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-thing-types.html)」を参照してください。 ### `list-things-in-billing-group` 次のコード例は、`list-things-in-billing-group` を使用する方法を示しています。 **AWS CLI** **請求グループ内のモノを一覧表示するには** 次の `list-things-in-billing-group` の例では、指定された請求グループにあるモノを一覧表示します。 ``` aws iot list-things-in-billing-group \ --billing-group-name GroupOne ``` 出力: ``` { "things": [ "MyOtherLightBulb", "MyLightBulb" ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[請求グループ](https://docs.aws.amazon.com/iot/latest/developerguide/tagging-iot-billing-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListThingsInBillingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-things-in-billing-group.html)」を参照してください。 ### `list-things-in-thing-group` 次のコード例は、`list-things-in-thing-group` を使用する方法を示しています。 **AWS CLI** **グループに属するモノを一覧表示するには** 次の `list-things-in-thing-group` の例では、指定されたモノのグループに属するモノを一覧表示します。 ``` aws iot list-things-in-thing-group \ --thing-group-name LightBulbs ``` 出力: ``` { "things": [ "MyLightBulb" ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[モノのグループ](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListThingsInThingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-things-in-thing-group.html)」を参照してください。 ### `list-things` 次のコード例は、`list-things` を使用する方法を示しています。 **AWS CLI** **例 1: レジストリ内のすべてのモノを一覧表示するには** 次の `list-things` の例は、AWS アカウント内の AWS IoT レジストリで定義されているモノ (デバイス) を一覧表示します。 ``` aws iot list-things ``` 出力: ``` { "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 } ] } ``` **例 2: 特定の属性を持つ定義済みのモノを一覧表示するには** 次の `list-things` の例は、`wattage` という名前の属性を持つモノのリストを表示します。 ``` aws iot list-things \ --attribute-name wattage ``` 出力: ``` { "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 } ] } ``` 詳細については、「AWS IoT ディベロッパーガイド」の「[レジストリによるモノの管理方法](https://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[ListThings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-things.html)」を参照してください。** ### `list-topic-rule-destinations` 次のコード例は、`list-topic-rule-destinations` を使用する方法を示しています。 **AWS CLI** **トピックルールの送信先を一覧表示するには** 次の `list-topic-rule-destinations` の例では、現在の AWS リージョンで定義したすべてのトピックルールの送信先を一覧表示します。 ``` aws iot list-topic-rule-destinations ``` 出力: ``` { "destinationSummaries": [ { "arn": "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "status": "ENABLED", "httpUrlSummary": { "confirmationUrl": "https://example.com" } } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[トピックルールの送信先の操作](https://docs.aws.amazon.com/iot/latest/developerguide/rule-destination.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTopicRuleDestinations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-topic-rule-destinations.html)」を参照してください。 ### `list-topic-rules` 次のコード例は、`list-topic-rules` を使用する方法を示しています。 **AWS CLI** **ルールを一覧表示するには** 次の `list-topic-rules` の例では、定義したすべてのルールを一覧表示します。 ``` aws iot list-topic-rules ``` 出力: ``` { "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 } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[ルールの表示](https://docs.aws.amazon.com/iot/latest/developerguide/iot-managae-rule.html#iot-view-rules)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTopicRules](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-topic-rules.html)」を参照してください。 ### `list-v2-logging-levels` 次のコード例は、`list-v2-logging-levels` を使用する方法を示しています。 **AWS CLI** **ログ記録レベルを一覧表示するには** 次の `list-v2-logging-levels` の例では、設定されたログ記録レベルを一覧表示します。ログ記録レベルが設定されていない場合、このコマンドを実行すると `NotConfiguredException` が発生します。 ``` aws iot list-v2-logging-levels ``` 出力: ``` { "logTargetConfigurations": [ { "logTarget": { "targetType": "DEFAULT" }, "logLevel": "ERROR" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListV2LoggingLevels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-v2-logging-levels.html)」を参照してください。 ### `list-violation-events` 次のコード例は、`list-violation-events` を使用する方法を示しています。 **AWS CLI** **期間中のセキュリティプロファイル違反を一覧表示するには** 次の `list-violation-events` の例では、現在の AWS アカウントと AWS リージョンのすべての AWS IoT Device Defender セキュリティプロファイルについて、2019 年 6 月 5 日から 6 月 12 日の間に発生した違反を一覧表示します。 ``` aws iot list-violation-events \ --start-time 1559747125 \ --end-time 1560351925 ``` 出力: ``` { "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 } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[Detect コマンド](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListViolationEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/list-violation-events.html)」を参照してください。 ### `register-ca-certificate` 次のコード例は、`register-ca-certificate` を使用する方法を示しています。 **AWS CLI** **認証局 (CA) 証明書を登録するには** 次の `register-ca-certificate` の例では、CA 証明書を登録します。このコマンドは、CA 証明書と、CA 証明書に関連付けられたプライベートキーを所有していることを証明するキー検証証明書を提供します。 ``` aws iot register-ca-certificate \ --ca-certificate file://rootCA.pem \ --verification-cert file://verificationCert.pem ``` 出力: ``` { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cacert/f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467", "certificateId": "f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467" } ``` 詳細については、「*AWS IoT API リファレンス*」の「[RegisterCACertificate](https://docs.aws.amazon.com/iot/latest/apireference/API_RegisterCACertificate.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegisterCaCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/register-ca-certificate.html)」を参照してください。 ### `register-certificate` 次のコード例は、`register-certificate` を使用する方法を示しています。 **AWS CLI** **自己署名デバイス証明書を登録するには** 次の `register-certificate` の例では、`rootCA.pem` CA 証明書によって署名された `deviceCert.pem` デバイス証明書を登録します。CA 証明書は、自己署名デバイス証明書の登録に使用する前に登録する必要があります。自己署名証明書は、このコマンドに渡すのと同じ CA 証明書で署名する必要があります。 ``` aws iot register-certificate \ --certificate-pem file://deviceCert.pem \ --ca-certificate-pem file://rootCA.pem ``` 出力: ``` { "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", "certificateId": "488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142" } ``` 詳細については、「*AWS IoT API リファレンス*」の「[RegisterCertificate](https://docs.aws.amazon.com/iot/latest/apireference/API_RegisterCertificate.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegisterCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/register-certificate.html)」を参照してください。 ### `register-thing` 次のコード例は、`register-thing` を使用する方法を示しています。 **AWS CLI** **モノを登録するには** 次の `register-thing` の例では、プロビジョニングテンプレートを使用してモノを登録します。 ``` 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"}' ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS IoT Core デベロッパーガイド*」の「[信頼できるユーザーによるプロビジョニング](https://docs.aws.amazon.com/iot/latest/developerguide/provision-wo-cert.html#trusted-user)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegisterThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/register-thing.html)」を参照してください。 ### `reject-certificate-transfer` 次のコード例は、`reject-certificate-transfer` を使用する方法を示しています。 **AWS CLI** **証明書の転送を拒否するには** 次の `reject-certificate-transfer` の例では、別の AWS アカウントからの指定されたデバイス証明書の転送を拒否します。 ``` aws iot reject-certificate-transfer \ --certificate-id f0f33678c7c9a046e5cc87b2b1a58dfa0beec26db78addd5e605d630e05c7fc8 ``` このコマンドでは何も出力されません。 詳細については、「*AWSIoT Core デベロッパーガイド*」の「[証明書を別のアカウントに転送する](https://docs.aws.amazon.com/iot/latest/developerguide/transfer-cert.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RejectCertificateTransfer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/reject-certificate-transfer.html)」を参照してください。 ### `remove-thing-from-billing-group` 次のコード例は、`remove-thing-from-billing-group` を使用する方法を示しています。 **AWS CLI** **請求グループからモノを削除するには** 次の `remove-thing-from-billing-group` の例では、請求グループから指定されたモノを削除します。 ``` aws iot remove-thing-from-billing-group \ --billing-group-name GroupOne \ --thing-name MyOtherLightBulb ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[請求グループ](https://docs.aws.amazon.com/iot/latest/developerguide/tagging-iot-billing-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveThingFromBillingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/remove-thing-from-billing-group.html)」を参照してください。 ### `remove-thing-from-thing-group` 次のコード例は、`remove-thing-from-thing-group` を使用する方法を示しています。 **AWS CLI** **モノのグループからモノを削除するには** 次の `remove-thing-from-thing-group` 例では、モノのグループから指定されたモノを削除します。 ``` aws iot remove-thing-from-thing-group \ --thing-name bulb7 \ --thing-group-name DeadBulbs ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「モノのグループ 」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveThingFromThingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/remove-thing-from-thing-group.html)」を参照してください。 ### `replace-topic-rule` 次のコード例は、`replace-topic-rule` を使用する方法を示しています。 **AWS CLI** **トピックのルール定義を更新するには** 次の `replace-topic-rule` の例では、土壌湿度レベルの読み取り値が低すぎると、指定されたルールを更新して SNS アラートを送信します。 ``` 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\"}" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT ルールの作成](https://docs.aws.amazon.com/iot/latest/developerguide/iot-create-rule.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ReplaceTopicRule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/replace-topic-rule.html)」を参照してください。 ### `search-index` 次のコード例は、`search-index` を使用する方法を示しています。 **AWS CLI** **モノのインデックスをクエリするには** 次の `search-index` 例では、`LightBulb` タイプを持つモノについて `AWS_Things` インデックスをクエリします。 ``` aws iot search-index \ --index-name "AWS_Things" \ --query-string "thingTypeName:LightBulb" ``` 出力: ``` { "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 } } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[モノのインデックス作成の管理](https://docs.aws.amazon.com/iot/latest/developerguide/managing-index.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SearchIndex](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/search-index.html)」を参照してください。 ### `set-default-authorizer` 次のコード例は、`set-default-authorizer` を使用する方法を示しています。 **AWS CLI** **デフォルトのオーソライザーを設定するには** 次の `set-default-authorizer` の例では、`CustomAuthorizer` という名前のカスタムオーソライザーをデフォルトのオーソライザーとして設定します。 ``` aws iot set-default-authorizer \ --authorizer-name CustomAuthorizer ``` 出力: ``` { "authorizerName": "CustomAuthorizer", "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer" } ``` 詳細については、「*AWS IoT API リファレンス*」の「[CreateDefaultAuthorizer](https://docs.aws.amazon.com/iot/latest/apireference/API_CreateDefaultAuthorizer.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetDefaultAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/set-default-authorizer.html)」を参照してください。 ### `set-default-policy-version` 次のコード例は、`set-default-policy-version` を使用する方法を示しています。 **AWS CLI** **ポリシーのデフォルトバージョンを設定するには** 次の `set-default-policy-version` の例では、`UpdateDeviceCertPolicy` という名前のポリシーのデフォルトバージョンを `2` に設定します。 ``` aws iot set-default-policy-version \ --policy-name UpdateDeviceCertPolicy \ --policy-version-id 2 ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetDefaultPolicyVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/set-default-policy-version.html)」を参照してください。 ### `set-v2-logging-level` 次のコード例は、`set-v2-logging-level` を使用する方法を示しています。 **AWS CLI** **モノのグループのログ記録レベルを設定するには** 次の `set-v2-logging-level` の例では、指定されたモノのグループの警告をログに記録するようにログ記録レベルを設定します。 ``` aws iot set-v2-logging-level \ --log-target "{\"targetType\":\"THING_GROUP\",\"targetName\":\"LightBulbs\"}" \ --log-level WARN ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetV2LoggingLevel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/set-v2-logging-level.html)」を参照してください。 ### `set-v2-logging-options` 次のコード例は、`set-v2-logging-options` を使用する方法を示しています。 **AWS CLI** **ログ記録オプションを設定するには** 次の `set-v2-logging-options` の例では、デフォルトのログ詳細レベルを ERROR に設定し、ログ記録に使用する ARN を指定します。 ``` aws iot set-v2-logging-options \ --default-log-level ERROR \ --role-arn "arn:aws:iam::094249569039:role/service-role/iotLoggingRole" ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SetV2LoggingOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/set-v2-logging-options.html)」を参照してください。 ### `start-audit-mitigation-actions-task` 次のコード例は、`start-audit-mitigation-actions-task` を使用する方法を示しています。 **AWS CLI** **監査検出結果に緩和アクションを適用するには** 次の `start-audit-mitigation-actions-task` の例では、`ResetPolicyVersionAction` アクション (ポリシーをクリアする) を指定された単一の検出結果に適用します。 ``` 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" ``` 出力: ``` { "taskId": "myActionsTaskId" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[StartAuditMitigationActionsTask (緩和アクションコマンド)](https://docs.aws.amazon.com/iot/latest/developerguide/mitigation-action-commands.html#dd-api-iot-StartAuditMitigationActionsTask)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartAuditMitigationActionsTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/start-audit-mitigation-actions-task.html)」を参照してください。 ### `start-on-demand-audit-task` 次のコード例は、`start-on-demand-audit-task` を使用する方法を示しています。 **AWS CLI** **監査をすぐに開始するには** 次の `start-on-demand-audit-task` の例では、AWS IoT Device Defender 監査を開始し、3 つの証明書チェックを実行します。 ``` aws iot start-on-demand-audit-task \ --target-check-names CA_CERTIFICATE_EXPIRING_CHECK DEVICE_CERTIFICATE_EXPIRING_CHECK REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK ``` 出力: ``` { "taskId": "a3aea009955e501a31b764abe1bebd3d" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[Audit コマンド](https://docs.aws.amazon.com/iot/latest/developerguide/AuditCommands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartOnDemandAuditTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/start-on-demand-audit-task.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **リソースのタグキーと値を指定するには** 次の `tag-resource` の例では、`Assembly` キーと `Fact1NW` 値を持つタグをモノのグループ `LightBulbs` に適用します。 ``` aws iot tag-resource \ --tags Key=Assembly,Value="Fact1NW" \ --resource-arn "arn:aws:iot:us-west-2:094249569039:thinggroup/LightBulbs" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT リソースのタグ付け](https://docs.aws.amazon.com/iot/latest/developerguide/tagging-iot.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/tag-resource.html)」を参照してください。 ### `test-authorization` 次のコード例は、`test-authorization` を使用する方法を示しています。 **AWS CLI** **AWS IoT ポリシーをテストするには** 次の `test-authorization` の例では、指定されたプリンシパルに関連付けられた AWS IoT ポリシーをテストします。 ``` 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 ``` 出力: ``` { "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": [] } ] } ``` 詳細については、「*AWS IoT API リファレンス*」の「[TestAuthorization](https://docs.aws.amazon.com/iot/latest/apireference/API_TestAuthorization.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TestAuthorization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/test-authorization.html)」を参照してください。 ### `test-invoke-authorizer` 次のコード例は、`test-invoke-authorizer` を使用する方法を示しています。 **AWS CLI** **カスタムオーソライザーをテストするには** 次の `test-invoke-authorizer` の例では、カスタムオーソライザーをテストします。 ``` aws iot test-invoke-authorizer \ --authorizer-name IoTAuthorizer \ --token allow \ --token-signature "mE0GvaHqy9nER/FdgtJX5lXYEJ3b3vE7t1gEszc0TKGgLKWXTnPkb2AbKnOAZ8lGyoN5dVtWDWVmr25m7++zjbYIMk2TBvyGXhOmvKFBPkdgyA43KL6SiZy0cTqlPMcQDsP7VX2rXr7CTowCxSNKphGXdQe0/I5dQ+JO6KUaHwCmupt0/MejKtaNwiia064j6wprOAUwG5S1IYFuRd0X+wfo8pb0DubAIX1Ua705kuhRUcTx4SxUShEYKmN4IDEvLB6FsIr0B2wvB7y4iPmcajxzGl02ExvyCUNctCV9dYlRRGJj0nsGzBIXOI4sGytPfqlA7obdgmN22pkDzYvwjQ==" ``` 出力: ``` { "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 } ``` 詳細については、「*AWS IoT API リファレンス*」の「[TestInvokeAuthorizer](https://docs.aws.amazon.com/iot/latest/apireference/API_TestInvokeAuthorizers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TestInvokeAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/test-invoke-authorizer.html)」を参照してください。 ### `transfer-certificate` 次のコード例は、`transfer-certificate` を使用する方法を示しています。 **AWS CLI** **デバイス証明書を別の AWS アカウントに転送するには** 次の `transfer-certificate` の例では、デバイス証明書を別の AWS アカウントに転送します。証明書と AWS アカウントは ID で識別されます。 ``` aws iot transfer-certificate \ --certificate-id 488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142 \ --target-aws-account 030714055129 ``` 出力: ``` { "transferredCertificateArn": "arn:aws:iot:us-west-2:030714055129:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142" } ``` 詳細については、「*AWSIoT Core デベロッパーガイド*」の「[証明書を別のアカウントに転送する](https://docs.aws.amazon.com/iot/latest/developerguide/transfer-cert.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TransferCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/transfer-certificate.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **リソースからタグキーを削除するには** 次の `untag-resource` の例では、モノのグループ `LightBulbs` からタグ `MyTag` とその値を削除します。 ``` command ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT リソースのタグ付け](https://docs.aws.amazon.com/iot/latest/developerguide/tagging-iot.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/untag-resource.html)」を参照してください。 ### `update-account-audit-configuration` 次のコード例は、`update-account-audit-configuration` を使用する方法を示しています。 **AWS CLI** **例 1: 監査通知の Amazon SNS 通知を有効にするには** 次の `update-account-audit-configuration` の例では、AWS IoT Device Defender 監査通知の Amazon SNS 通知を有効にし、ターゲットとそのターゲットへの書き込みに使用されるロールを指定します。 ``` 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}" ``` このコマンドでは何も出力されません。 **例 2: 監査チェックを有効にするには** 次の `update-account-audit-configuration` の例では、`AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK` という名前の AWS IoT Device Defender 監査チェックを有効にします。AWS アカウントの 1 つまたは複数のスケジュールされた監査の `targetCheckNames` の一部である場合、監査チェックを無効にすることはできません。 ``` aws iot update-account-audit-configuration \ --audit-check-configurations "{\"AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK\":{\"enabled\":true}}" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[Audit コマンド](https://docs.aws.amazon.com/iot/latest/developerguide/AuditCommands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateAccountAuditConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-account-audit-configuration.html)」を参照してください。 ### `update-audit-suppression` 次のコード例は、`update-audit-suppression` を使用する方法を示しています。 **AWS CLI** **監査検出結果の抑制を更新するには** 次の `update-audit-suppression` の例では、監査検出結果の抑制の有効期限を 2020-09-21 に更新します。 ``` aws iot update-audit-suppression \ --check-name DEVICE_CERTIFICATE_EXPIRING_CHECK \ --resource-identifier deviceCertificateId=c7691e \ --no-suppress-indefinitely \ --expiration-date 2020-09-21 ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[監査の検出結果の抑制](https://docs.aws.amazon.com/iot/latest/developerguide/audit-finding-suppressions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateAuditSuppression](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-audit-suppression.html)」を参照してください。 ### `update-authorizer` 次のコード例は、`update-authorizer` を使用する方法を示しています。 **AWS CLI** **カスタムオーソライザーを更新するには** 次の `update-authorizer` の例では、状態を `CustomAuthorizer2` から `INACTIVE` にします。 ``` aws iot update-authorizer \ --authorizer-name CustomAuthorizer2 \ --status INACTIVE ``` 出力: ``` { "authorizerName": "CustomAuthorizer2", "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer2" } ``` 詳細については、「*AWS IoT API リファレンス*」の「[UpdateAuthorizer](https://docs.aws.amazon.com/iot/latest/apireference/API_UpdateAuthorizer.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateAuthorizer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-authorizer.html)」を参照してください。 ### `update-billing-group` 次のコード例は、`update-billing-group` を使用する方法を示しています。 **AWS CLI** **請求グループに関する情報を更新するには** 次の `update-billing-group` の例では、指定された請求グループの説明を更新します。 ``` aws iot update-billing-group \ --billing-group-name GroupOne \ --billing-group-properties "billingGroupDescription=\"Primary bulb billing group\"" ``` 出力: ``` { "version": 2 } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[請求グループ](https://docs.aws.amazon.com/iot/latest/developerguide/tagging-iot-billing-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateBillingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-billing-group.html)」を参照してください。 ### `update-ca-certificate` 次のコード例は、`update-ca-certificate` を使用する方法を示しています。 **AWS CLI** **認証局 (CA) 証明書を更新するには** 次の `update-ca-certificate` の例では、指定された CA 証明書を ACTIVE ステータスに設定します。 ``` aws iot update-ca-certificate \ --certificate-id f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467 \ --new-status ACTIVE ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT API リファレンス*」の「[UpdateCACertificate](https://docs.aws.amazon.com/iot/latest/apireference/API_UpdateCACertificate.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateCaCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-ca-certificate.html)」を参照してください。 ### `update-certificate` 次のコード例は、`update-certificate` を使用する方法を示しています。 **AWS CLI** **デバイス証明書を更新するには** 次の `update-certificate` の例では、指定されたデバイス証明書を INACTIVE ステータスに設定します。 ``` aws iot update-certificate \ --certificate-id d1eb269fb55a628552143c8f96eb3c258fcd5331ea113e766ba0c82bf225f0be \ --new-status INACTIVE ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT API リファレンス*」の「[UpdateCertificate](https://docs.aws.amazon.com/iot/latest/apireference/API_UpdateCertificate.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-certificate.html)」を参照してください。 ### `update-custom-metric` 次のコード例は、`update-custom-metric` を使用する方法を示しています。 **AWS CLI** **カスタムメトリクスを更新するには** 次の `update-custom-metric` の例では、カスタムメトリクスを更新して新しい `display-name` を取得します。 ``` aws iot update-custom-metric \ --metric-name batteryPercentage \ --display-name 'remaining battery percentage on device' \ --region us-east-1 ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT Core デベロッパーガイド*」の「[カスタムメトリクス](https://docs.aws.amazon.com/iot/latest/developerguide/dd-detect-custom-metrics.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateCustomMetric](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-custom-metric.html)」を参照してください。 ### `update-dimension` 次のコード例は、`update-dimension` を使用する方法を示しています。 **AWS CLI** **ディメンションを更新するには** 次の `update-dimension` の例では、ディメンションを更新します。 ``` aws iot update-dimension \ --name TopicFilterForAuthMessages \ --string-values device/${iot:ClientId}/auth ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT Core デベロッパーガイド*」の「[ディメンションを使用したセキュリティプロファイルでのメトリクスの範囲設定](https://docs.aws.amazon.com/iot/latest/developerguide/scoping-security-behavior.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateDimension](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-dimension.html)」を参照してください。 ### `update-domain-configuration` 次のコード例は、`update-domain-configuration` を使用する方法を示しています。 **AWS CLI** **ドメイン設定を更新するには** 次の `update-domain-configuration` の例では、指定されたドメイン設定を無効にします。 ``` aws iot update-domain-configuration \ --domain-configuration-name "additionalDataDomain" \ --domain-configuration-status "DISABLED" ``` 出力: ``` { "domainConfigurationName": "additionalDataDomain", "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/additionalDataDomain/dikMh" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[設定可能なエンドポイント](https://docs.aws.amazon.com/iot/latest/developerguide/iot-custom-endpoints-configurable-aws.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateDomainConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-domain-configuration.html)」を参照してください。 ### `update-dynamic-thing-group` 次のコード例は、`update-dynamic-thing-group` を使用する方法を示しています。 **AWS CLI** **モノの動的グループを更新するには** 次の `update-dynamic-thing-group` の例では、指定されたモノの動的グループを更新します。説明を提供し、クエリ文字列を更新してグループのメンバーシップ条件を変更します。 ``` 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" ``` 出力: ``` { "version": 2 } ``` 詳細については、「*AWS IoT デベロッパーガイド*」「[モノの動的グループ](https://docs.aws.amazon.com/iot/latest/developerguide/dynamic-thing-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateDynamicThingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-dynamic-thing-group.html)」を参照してください。 ### `update-event-configurations` 次のコード例は、`update-event-configurations` を使用する方法を示しています。 **AWS CLI** **公開されるイベントタイプを表示するには** 次の `update-event-configurations` の例では、CA 証明書が追加、更新、または削除されたときにメッセージを有効にするように設定を更新します。 ``` aws iot update-event-configurations \ --event-configurations "{\"CA_CERTIFICATE\":{\"Enabled\":true}}" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[イベントメッセージ](https://docs.aws.amazon.com/iot/latest/developerguide/iot-events.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateEventConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-event-configurations.html)」を参照してください。 ### `update-indexing-configuration` 次のコード例は、`update-indexing-configuration` を使用する方法を示しています。 **AWS CLI** **モノのインデックス作成を有効にするには** 以下の `update-indexing-configuration` 例は、AWS\$1Things インデックスを使用して、モノのインデックス作成に、レジストリーデータ、シャドウデータ、およびモノの接続ステータスの検索サポートをさせます。 ``` aws iot update-indexing-configuration --thing-indexing-configuration thingIndexingMode=REGISTRY_AND_SHADOW,thingConnectivityIndexingMode=STATUS ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[モノのインデックス作成の管理](https://docs.aws.amazon.com/iot/latest/developerguide/managing-index.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateIndexingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-indexing-configuration.html)」を参照してください。 ### `update-job` 次のコード例は、`update-job` を使用する方法を示しています。 **AWS CLI** **ジョブの詳細なステータスを取得するには** 次の `update-job` の例では、ID が `example-job-01` のジョブの詳細なステータスを取得します。 ``` aws iot describe-job \ --job-id "example-job-01" ``` 出力: ``` { "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": {} } } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[ジョブ (CLI) の作成と管理](https://docs.aws.amazon.com/iot/latest/developerguide/manage-job-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-job.html)」を参照してください。 ### `update-mitigation-action` 次のコード例は、`update-mitigation-action` を使用する方法を示しています。 **AWS CLI** **緩和アクションを更新するには** 次の `update-mitigation-action` の例では、`AddThingsToQuarantineGroupAction` という名前の指定された緩和アクションを更新し、モノのグループ名を変更して、`overrideDynamicGroups` を `false` に設定します。変更は `describe-mitigation-action` コマンドを使用して確認できます。 ``` aws iot update-mitigation-action \ --cli-input-json "{ \"actionName\": \"AddThingsToQuarantineGroupAction\", \"actionParams\": { \"addThingsToThingGroupParams\": {\"thingGroupNames\":[\"QuarantineGroup2\"],\"overrideDynamicGroups\": false}}}" ``` 出力: ``` { "actionArn": "arn:aws:iot:us-west-2:123456789012:mitigationaction/AddThingsToQuarantineGroupAction", "actionId": "2fd2726d-98e1-4abf-b10f-09465ccd6bfa" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[UpdateMitigationAction (緩和アクションコマンド)](https://docs.aws.amazon.com/iot/latest/developerguide/mitigation-action-commands.html#dd-api-iot-UpdateMitigationAction)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateMitigationAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-mitigation-action.html)」を参照してください。 ### `update-provisioning-template` 次のコード例は、`update-provisioning-template` を使用する方法を示しています。 **AWS CLI** **プロビジョニングテンプレートを更新するには** 次の `update-provisioning-template` の例では、指定されたプロビジョニングテンプレートの説明とロール ARN を変更し、テンプレートを有効にします。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Core デベロッパーガイド*」の「[AWS セキュアトンネリング](https://docs.aws.amazon.com/iot/latest/developerguide/secure-tunneling.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateProvisioningTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-provisioning-template.html)」を参照してください。 ### `update-role-alias` 次のコード例は、`update-role-alias` を使用する方法を示しています。 **AWS CLI** **ロールエイリアスを更新するには** 次の `update-role-alias` 例では、`LightBulbRole` ロールを更新します。 ``` aws iot update-role-alias \ --role-alias LightBulbRole \ --role-arn arn:aws:iam::123456789012:role/lightbulbrole-001 ``` 出力: ``` { "roleAlias": "LightBulbRole", "roleAliasArn": "arn:aws:iot:us-west-2:123456789012:rolealias/LightBulbRole" } ``` 詳細については、「*AWS IoT API リファレンス*」の「[UpdateRoleAlias](https://docs.aws.amazon.com/iot/latest/apireference/API_UpdateRoleAlias.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateRoleAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-role-alias.html)」を参照してください。 ### `update-scheduled-audit` 次のコード例は、`update-scheduled-audit` を使用する方法を示しています。 **AWS CLI** **スケジュールされた監査定義を更新するには** 次の `update-scheduled-audit` の例では、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 ``` 出力: ``` { "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/WednesdayCertCheck" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[Audit コマンド](https://docs.aws.amazon.com/iot/latest/developerguide/AuditCommands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateScheduledAudit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-scheduled-audit.html)」を参照してください。 ### `update-security-profile` 次のコード例は、`update-security-profile` を使用する方法を示しています。 **AWS CLI** **セキュリティプロファイルを更新するには** 次の `update-security-profile` の例では、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}}]" ``` 出力: ``` { "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 } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[Detect コマンド](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateSecurityProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-security-profile.html)」を参照してください。 ### `update-stream` 次のコード例は、`update-stream` を使用する方法を示しています。 **AWS CLI** **ストリームを更新するには** 次の `update-stream` の例では、既存のストリームを更新します。ストリームのバージョンが 1 ずつ増えていきます。 ``` aws iot update-stream \ --cli-input-json file://update-stream.json ``` `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" } ``` 出力: ``` { "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 } ``` 詳細については、「*AWS IoT API リファレンス*」の「[UpdateStream](https://docs.aws.amazon.com/iot/latest/apireference/API_UpdateStream.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-stream.html)」を参照してください。 ### `update-thing-group` 次のコード例は、`update-thing-group` を使用する方法を示しています。 **AWS CLI** **モノのグループの定義を更新するには** 次の `update-thing-group` の例では、指定されたモノのグループの定義を更新し、説明と 2 つの属性を変更します。 ``` aws iot update-thing-group \ --thing-group-name HalogenBulbs \ --thing-group-properties "thingGroupDescription=\"Halogen bulb group\", attributePayload={attributes={Manufacturer=AnyCompany,wattage=60}}" ``` 出力: ``` { "version": 2 } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[モノのグループ](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateThingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-thing-group.html)」を参照してください。 ### `update-thing-groups-for-thing` 次のコード例は、`update-thing-groups-for-thing` を使用する方法を示しています。 **AWS CLI** **モノが属するグループを変更するには** 次の `update-thing-groups-for-thing` の例では、`MyLightBulb` という名前のモノを `DeadBulbs` という名前のグループから削除し、同時に `replaceableItems` という名前のグループに追加します。 ``` aws iot update-thing-groups-for-thing \ --thing-name MyLightBulb \ --thing-groups-to-add "replaceableItems" \ --thing-groups-to-remove "DeadBulbs" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[モノのグループ](https://docs.aws.amazon.com/iot/latest/developerguide/thing-groups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateThingGroupsForThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-thing-groups-for-thing.html)」を参照してください。 ### `update-thing` 次のコード例は、`update-thing` を使用する方法を示しています。 **AWS CLI** **モノのタイプにモノを関連付けるには** 次の `update-thing` 例では、AWS IoT レジストリ内のモノをモノのタイプに関連付けます。関連付けを行うときは、モノのタイプで定義された属性の値を指定します。 ``` aws iot update-thing \ --thing-name "MyOtherLightBulb" \ --thing-type-name "LightBulb" \ --attribute-payload "{"attributes": {"wattage":"75", "model":"123"}}" ``` このコマンドでは、出力が生成されません。`describe-thing` コマンドを使用して結果を表示します。 詳細については、「*AWS IoT デベロッパーガイド*」「[モノのタイプ](https://docs.aws.amazon.com/iot/latest/developerguide/thing-types.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-thing.html)」を参照してください。 ### `update-topic-rule-destination` 次のコード例は、`update-topic-rule-destination` を使用する方法を示しています。 **AWS CLI** **例 1: トピックルールの送信先を有効にするには** 次の `update-topic-rule-destination` の例では、トピックルールの送信先へのトラフィックを有効にします。 ``` aws iot update-topic-rule-destination \ --arn "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" \ --status ENABLED ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[トピックルールの送信先の有効化](https://docs.aws.amazon.com/iot/latest/developerguide/rule-destination.html#enable-destination)」を参照してください。 **例 2: トピックルールの送信先を無効にするには** 次の `update-topic-rule-destination` の例では、トピックルールの送信先へのトラフィックを無効にします。 ``` aws iot update-topic-rule-destination \ --arn "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" \ --status DISABLED ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[トピックルールの送信先の無効化](https://docs.aws.amazon.com/iot/latest/developerguide/rule-destination.html#disable-destination)」を参照してください。 **例 3: 新しい確認メッセージを送信するには** 次の `update-topic-rule-destination` の例では、トピックルールの送信先に関する新しい確認メッセージを送信します。 ``` aws iot update-topic-rule-destination \ --arn "arn:aws:iot:us-west-2:123456789012:ruledestination/http/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" \ --status IN_PROGRESS ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[新しい確認メッセージの送信](https://docs.aws.amazon.com/iot/latest/developerguide/rule-destination.html#trigger-confirm)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateTopicRuleDestination](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/update-topic-rule-destination.html)」を参照してください。 ### `validate-security-profile-behaviors` 次のコード例は、`validate-security-profile-behaviors` を使用する方法を示しています。 **AWS CLI** **例 1: セキュリティプロファイルの動作パラメータを検証するには** 次の `validate-security-profile-behaviors` の例では、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}}]" ``` 出力: ``` { "valid": true, "validationErrors": [] } ``` **例 2: セキュリティプロファイルの不正な動作パラメータを検証するには** 次の `validate-security-profile-behaviors` の例では、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}}]" ``` 出力: ``` { "valid": false, "validationErrors": [ { "errorMessage": "Behavior Authorization is malformed. consecutiveDatapointsToAlarm 100000 should be in range[1,10]" } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[Detect コマンド](https://docs.aws.amazon.com/iot/latest/developerguide/DetectCommands.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ValidateSecurityProfileBehaviors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot/validate-security-profile-behaviors.html)」を参照してください。 # Device Advisor examples using AWS CLI 次のコード例は、Device Advisor で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-suite-definition` 次のコード例は、`create-suite-definition` を使用する方法を示しています。 **AWS CLI** **例 1: IoT Device Advisor テストスイートを作成するには** 次の `create-suite-definition` の例では、指定されたスイート定義設定を使用して、AWS IoT で Device Advisor テストスイートを作成します。 ``` 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"}' ``` 出力: ``` { "suiteDefinitionId": "0jtsgio7yenu", "suiteDefinitionArn": "arn:aws:iotdeviceadvisor:us-east-1:123456789012:suitedefinition/0jtsgio7yenu", "suiteDefinitionName": "TestSuiteName", "createdAt": "2022-12-02T11:38:13.263000-05:00" } ``` 詳細については、「*AWS IoT Core デベロッパーガイド*」の「[Create a test suite definition](https://docs.aws.amazon.com/iot/latest/developerguide/device-advisor-workflow.html#device-advisor-workflow-create-suite-definition)」を参照してください。 **例 2: IoT Device Advisor 最新認定テストスイートを作成するには** 次の `create-suite-definition` の例では、指定されたスイート定義設定を使用して、AWS IoT で最新バージョンの Device Advisor 認定テストスイートを作成します。 ``` 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"}' ``` 出力: ``` { "suiteDefinitionId": "txgsuolk2myj", "suiteDefinitionArn": "arn:aws:iotdeviceadvisor:us-east-1:123456789012:suitedefinition/txgsuolk2myj", "suiteDefinitionName": "TestSuiteName", "createdAt": "2022-12-02T11:38:13.263000-05:00" } ``` 詳細については、「*AWS IoT Core デベロッパーガイド*」の「[Create a test suite definition](https://docs.aws.amazon.com/iot/latest/developerguide/device-advisor-workflow.html#device-advisor-workflow-create-suite-definition)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateSuiteDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotdeviceadvisor/create-suite-definition.html)」を参照してください。 ### `delete-suite-definition` 次のコード例は、`delete-suite-definition` を使用する方法を示しています。 **AWS CLI** **IoT Device Advisor テストスイートを削除するには** 次の `delete-suite-definition` の例では、指定されたスイート定義 ID を持つ Device Advisor テストスイートを削除します。 ``` aws iotdeviceadvisor delete-suite-definition \ --suite-definition-id 0jtsgio7yenu ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT API リファレンス*」の「[DeleteSuiteDefinition](https://docs.aws.amazon.com/iot/latest/apireference/API_iotdeviceadvisor_DeleteSuiteDefinition.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteSuiteDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotdeviceadvisor/delete-suite-definition.html)」を参照してください。 ### `get-endpoint` 次のコード例は、`get-endpoint` を使用する方法を示しています。 **AWS CLI** **例 1: IoT Device Advisor のアカウントレベルのエンドポイントに関する情報を取得するには** 次の `get-endpoint` の例では、Device Advisor のアカウントレベルのテストエンドポイントに関する情報を取得します。 ``` aws iotdeviceadvisor get-endpoint ``` 出力: ``` { "endpoint": "t6y4c143x9sfo.deviceadvisor.iot.us-east-1.amazonaws.com" } ``` **例 2: IoT Device Advisor のデバイスレベルのエンドポイントに関する情報を取得するには** 次の `get-endpoint` の例では、指定された thing-arn または certificate-arn を持つ、Device Advisor のデバイスレベルのテストエンドポイントに関する情報を取得します。 ``` aws iotdeviceadvisor get-endpoint \ --thing-arn arn:aws:iot:us-east-1:123456789012:thing/MyIotThing ``` 出力: ``` { "endpoint": "tdb7719be5t6y4c143x9sfo.deviceadvisor.iot.us-east-1.amazonaws.com" } ``` 詳細については、「*AWS IoT Core デベロッパーガイド*」の「[Get a test endpoint](https://docs.aws.amazon.com/iot/latest/developerguide/device-advisor-workflow.html#device-advisor-workflow-get-test-endpoint)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotdeviceadvisor/get-endpoint.html)」を参照してください。 ### `get-suite-definition` 次のコード例は、`get-suite-definition` を使用する方法を示しています。 **AWS CLI** **IoT Device Advisor テストスイートに関する情報を取得するには** 次の `get-suite-definition` の例では、指定されたスイート定義 ID を持つ Device Advisor テストスイートに関する情報を取得します。 ``` aws iotdeviceadvisor get-suite-definition \ --suite-definition-id qqcsmtyyjabl ``` 出力: ``` { "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": {} } ``` 詳細については、「*AWS IoT Core デベロッパーガイド*」の「[Get a test suite definition](https://docs.aws.amazon.com/iot/latest/developerguide/device-advisor-workflow.html#device-advisor-workflow-create-suite-definition)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetSuiteDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotdeviceadvisor/get-suite-definition.html)」を参照してください。 ### `get-suite-run-report` 次のコード例は、`get-suite-run-report` を使用する方法を示しています。 **AWS CLI** **IoT Device Advisor 認定テストスイートの実行レポートに関する情報を取得するには** 次の `get-suite-run-report` の例では、指定されたスイート定義 ID とスイート実行 ID を使用して、Device Advisor 認定テストスイートの正常実行に関するレポートダウンロードリンクを取得します。 ``` aws iotdeviceadvisor get-suite-run-report \ --suite-definition-id ztvb5aek4w4x \ --suite-run-id p6awv83nre6v ``` 出力: ``` { "qualificationReportDownloadUrl": "https://senate-apn-reports-us-east-1-prod.s3.amazonaws.com/report.downloadlink" } ``` 詳細については、「*AWS IoT Core デベロッパーガイド*」の「[Get a qualification report for a successful qualification test suite run](https://docs.aws.amazon.com/iot/latest/developerguide/device-advisor-workflow.html#device-advisor-workflow-qualification-report)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetSuiteRunReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotdeviceadvisor/get-suite-run-report.html)」を参照してください。 ### `get-suite-run` 次のコード例は、`get-suite-run` を使用する方法を示しています。 **AWS CLI** **IoT Device Advisor テストスイートの実行ステータスに関する情報を取得するには** 次の `get-suite-run` の例では、指定されたスイート定義 ID とスイート実行 ID を使用して、Device Advisor テストスイートの実行ステータスに関する情報を取得します。 ``` aws iotdeviceadvisor get-suite-run \ --suite-definition-id qqcsmtyyjabl \ --suite-run-id nzlfyhaa18oa ``` 出力: ``` { "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": {} } ``` 詳細については、「*AWS IoT Core デベロッパーガイド*」の「[Get a test suite run](https://docs.aws.amazon.com/iot/latest/developerguide/device-advisor-workflow.html#device-advisor-workflow-describe-suite)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetSuiteRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotdeviceadvisor/get-suite-run.html)」を参照してください。 ### `list-suite-definitions` 次のコード例は、`list-suite-definitions` を使用する方法を示しています。 **AWS CLI** **例 1: 作成した IoT Device Advisor テストスイートを一覧表示するには** 次の `list-suite-definitions` の例では、AWS IoT で作成した最大 25 の Device Advisor テストスイートを一覧表示します。テストスイートの数が 25 を超える場合、出力に "nextToken" が表示されます。この "nextToken" を使用して、作成した残りのテストスイートを表示できます。 ``` aws iotdeviceadvisor list-suite-definitions ``` 出力: ``` { "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" } ``` **例 2: 作成した IoT Device Advisor テストスイートを指定された設定で一覧表示するには** 次の `list-suite-definitions` の例では、AWS IoT で作成した Device Advisor テストスイートを、指定された max-result の数だけ一覧表示します。テストスイートの数が最大数を超える場合、出力に "nextToken" が表示されます。"nextToken" がある場合は、"nextToken" を使用して、作成したテストスイートのうち、表示されていなかったものを表示できます。 ``` aws iotdeviceadvisor list-suite-definitions \ --max-result 1 \ --next-token "nextTokenValue" ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT API リファレンス*」の「[ListSuiteDefinitions](https://docs.aws.amazon.com/iot/latest/apireference/API_iotdeviceadvisor_ListSuiteDefinitions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListSuiteDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotdeviceadvisor/list-suite-definitions.html)」を参照してください。 ### `list-suite-runs` 次のコード例は、`list-suite-runs` を使用する方法を示しています。 **AWS CLI** **例 1: 指定された IoT Device Advisor テストスイートの実行ステータスに関するすべての情報を一覧表示するには** 次の `list-suite-runs` の例では、指定されたスイート定義 ID を使用して、Device Advisor テストスイートの実行ステータスに関するすべての情報を一覧表示します。テストスイートの実行回数が 25 を超える場合、出力に "nextToken" が表示されます。この "nextToken" を使用して、残りのテストスイートの実行を表示できます。 ``` aws iotdeviceadvisor list-suite-runs \ --suite-definition-id ztvb5aew4w4x ``` 出力: ``` { "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 } ] } ``` **例 2: 指定された IoT Device Advisor テストスイートの実行ステータスに関する情報を、指定された設定で一覧表示するには** 次の `list-suite-runs` の例では、指定されたスイート定義 ID と指定された最大結果数を使用して、Device Advisor テストスイートの実行ステータスに関する情報を一覧表示します。テストスイートの実行回数が最大数を超える場合、出力に "nextToken" が表示されます。"nextToken" がある場合は、"nextToken" を使用して、表示されていなかったテストスイートの実行を表示できます。 ``` aws iotdeviceadvisor list-suite-runs \ --suite-definition-id qqcsmtyyjaml \ --max-result 1 \ --next-token "nextTokenValue" ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT API リファレンス*」の「[ListSuiteRuns](https://docs.aws.amazon.com/iot/latest/apireference/API_iotdeviceadvisor_ListSuiteRuns.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListSuiteRuns](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotdeviceadvisor/list-suite-runs.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **IoT Device Advisor リソースにアタッチされたタグを一覧表示するには** 次の `list-tags-for-resource` の例では、Device Advisor リソースにアタッチされたタグを一覧表示します。Device Advisor リソースは、Suitedefinition-Arn または Suiterun-Arn です。 ``` aws iotdeviceadvisor list-tags-for-resource \ --resource-arn arn:aws:iotdeviceadvisor:us-east-1:123456789012:suitedefinition/ba0uyjpg38ny ``` 出力: ``` { "tags": { "TestTagKey": "TestTagValue" } } ``` 詳細については、「*AWS IoT API リファレンス*」の「[ListTagsForResource](https://docs.aws.amazon.com/iot/latest/apireference/API_iotdeviceadvisor_ListTagsForResource.html)」と「*サービス認可リファレンス*」の「[Resource types defined by AWS IoT Core Device Advisor](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotcoredeviceadvisor.html#awsiotcoredeviceadvisor-resources-for-iam-policies)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotdeviceadvisor/list-tags-for-resource.html)」を参照してください。 ### `start-suite-run` 次のコード例は、`start-suite-run` を使用する方法を示しています。 **AWS CLI** **Device Advisor テストスイートの実行を開始するには** 次の `start-suite-run` の例では、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"}}' ``` 出力: ``` { "suiteRunId": "pwmucgw7lt9s", "suiteRunArn": "arn:aws:iotdeviceadvisor:us-east-1:123456789012:suiterun/qqcsmtyyjabl/pwmucgw7lk9s", "createdAt": "2022-12-02T15:43:05.581000-05:00" } ``` 詳細については、「*AWS IoT Core デベロッパーガイド*」の「[Start a test suite run](https://docs.aws.amazon.com/iot/latest/developerguide/device-advisor-workflow.html#device-advisor-workflow-start-suite-run)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartSuiteRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotdeviceadvisor/start-suite-run.html)」を参照してください。 ### `stop-suite-run` 次のコード例は、`stop-suite-run` を使用する方法を示しています。 **AWS CLI** **現在実行中の IoT Device Advisor テストスイートを停止するには** 次の `stop-suite-run` の例では、指定されたスイート定義 ID とスイート実行 ID を使用して、現在実行中の Device Advisor テストスイートを停止します。 ``` aws iotdeviceadvisor stop-suite-run \ --suite-definition-id qqcsmtyyjabl \ --suite-run-id nzlfyhaa18oa ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Core デベロッパーガイド*」の「[Stop a test suite run](https://docs.aws.amazon.com/iot/latest/developerguide/device-advisor-workflow.html#device-advisor-workflow-stop-suite-run)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopSuiteRun](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotdeviceadvisor/stop-suite-run.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **IoT Device Advisor リソースの既存のタグに対する追加と変更を行うには** 次の `tag-resource` の例では、指定されたリソース arn とタグを使用して、Device Advisor リソースの既存のタグに対する追加と変更を行います。Device Advisor リソースは、Suitedefinition-Arn または Suiterun-Arn です。 ``` aws iotdeviceadvisor tag-resource \ --resource-arn arn:aws:iotdeviceadvisor:us-east-1:123456789012:suitedefinition/ba0uyjpg38ny \ --tags '{"TagKey": "TagValue"}' ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT API リファレンス*」の「[TagResource](https://docs.aws.amazon.com/iot/latest/apireference/API_iotdeviceadvisor_TagResource.html)」と「*サービス認可リファレンス*」の「[Resource types defined by AWS IoT Core Device Advisor](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotcoredeviceadvisor.html#awsiotcoredeviceadvisor-resources-for-iam-policies)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotdeviceadvisor/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **IoT Device Advisor リソースから既存のタグを削除するには** 次の `untag-resource` の例では、指定されたリソース arn とタグキーを使用して、Device Advisor リソースから既存のタグを削除します。Device Advisor リソースは、Suitedefinition-Arn または Suiterun-Arn です。 ``` aws iotdeviceadvisor untag-resource \ --resource-arn arn:aws:iotdeviceadvisor:us-east-1:123456789012:suitedefinition/ba0uyjpg38ny \ --tag-keys "TagKey" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT API リファレンス*」の「[UntagResource](https://docs.aws.amazon.com/iot/latest/apireference/API_iotdeviceadvisor_UntagResource.html)」と「*サービス認可リファレンス*」の「[Resource types defined by AWS IoT Core Device Advisor](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotcoredeviceadvisor.html#awsiotcoredeviceadvisor-resources-for-iam-policies)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotdeviceadvisor/untag-resource.html)」を参照してください。 ### `update-suite-definition` 次のコード例は、`update-suite-definition` を使用する方法を示しています。 **AWS CLI** **例 1: IoT Device Advisor テストスイートを更新するには** 次の `update-suite-definition` の例では、指定されたスイート定義 ID とスイート定義設定を使用して、AWS IoT で Device Advisor テストスイートを更新します。 ``` 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"}' ``` 出力: ``` { "suiteDefinitionId": "3hsn88h4p2g5", "suiteDefinitionName": "TestSuiteName", "suiteDefinitionVersion": "v3", "createdAt": "2022-11-17T14:15:56.830000-05:00", "lastUpdatedAt": "2022-12-02T16:02:45.857000-05:00" } ``` **例 2: IoT Device Advisor 認定テストスイートを更新するには** 次の `update-suite-definition` の例では、指定されたスイート定義 ID とスイート定義設定を使用して、AWS IoT で Device Advisor 認定テストスイートを更新します。 ``` 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"}' ``` 出力: ``` { "suiteDefinitionId": "txgsuolk2myj", "suiteDefinitionName": "TestSuiteName", "suiteDefinitionVersion": "v3", "createdAt": "2022-11-17T14:15:56.830000-05:00", "lastUpdatedAt": "2022-12-02T16:02:45.857000-05:00" } ``` 詳細については、「*AWS IoT API リファレンス*」の「[UpdateSuiteDefinition](https://docs.aws.amazon.com/iot/latest/apireference/API_iotdeviceadvisor_UpdateSuiteDefinition.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateSuiteDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotdeviceadvisor/update-suite-definition.html)」を参照してください。 # AWS IoT data examples using AWS CLI 次のコード例では、AWS IoT data で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `delete-thing-shadow` 次のコード例は、`delete-thing-shadow` を使用する方法を示しています。 **AWS CLI** **デバイスのシャドウドキュメントを削除するには** 次の `delete-thing-shadow` の例では、`MyRPi` という名前のデバイスのシャドウドキュメント全体を削除します。 ``` aws iot-data delete-thing-shadow \ --thing-name MyRPi \ "output.txt" ``` このコマンドではディスプレイに何も出力されませんが、`output.txt` には削除したシャドウドキュメントのバージョンとタイムスタンプを確認する情報が含まれています。 ``` {"version":2,"timestamp":1560270384} ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[シャドウの使用](https://docs.aws.amazon.com/iot/latest/developerguide/using-device-shadows.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteThingShadow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot-data/delete-thing-shadow.html)」を参照してください。 ### `get-thing-shadow` 次のコード例は、`get-thing-shadow` を使用する方法を示しています。 **AWS CLI** **モノのシャドウドキュメントを取得するには** 次の `get-thing-shadow` の例では、指定された IoT のモノに関するモノのシャドウドキュメントを取得します。 ``` aws iot-data get-thing-shadow \ --thing-name MyRPi \ output.txt ``` このコマンドではディスプレイに何も出力されませんが、`output.txt` の内容を以下に示します。 ``` { "state":{ "reported":{ "moisture":"low" } }, "metadata":{ "reported":{ "moisture":{ "timestamp":1560269319 } } }, "version":1,"timestamp":1560269405 } ``` 詳細については、「AWS IoT デベロッパーガイド」の「[Device Shadow サービスのデータフロー](https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-data-flow.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetThingShadow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot-data/get-thing-shadow.html)」を参照してください。 ### `update-thing-shadow` 次のコード例は、`update-thing-shadow` を使用する方法を示しています。 **AWS CLI** **モノのシャドウを更新するには** 次の `update-thing-shadow` の例では、指定されたモノのデバイスシャドウの現在の状態を変更して、ファイル `output.txt` に保存します。 ``` aws iot-data update-thing-shadow \ --thing-name MyRPi \ --payload "{"state":{"reported":{"moisture":"okay"}}}" \ "output.txt" ``` このコマンドではディスプレイに何も出力されませんが、`output.txt` の内容を以下に示します。 ``` { "state": { "reported": { "moisture": "okay" } }, "metadata": { "reported": { "moisture": { "timestamp": 1560270036 } } }, "version": 2, "timestamp": 1560270036 } ``` 詳細については、「AWS IoT デベロッパーガイド」の「[Device Shadow サービスのデータフロー](https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-data-flow.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateThingShadow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot-data/update-thing-shadow.html)」を参照してください。 # AWS IoT Events examples using AWS CLI 次のコード例では、AWS IoT Events で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `batch-put-message` 次のコード例は、`batch-put-message` を使用する方法を示しています。 **AWS CLI** **AWS IoT Events にメッセージ (入力) を送信するには** 次の `batch-put-message` の例では、一連のメッセージを AWS IoT Events システムに送信します。各メッセージペイロードは、指定した入力 (`inputName`) に変換され、その入力をモニタリングするディテクターに取り込まれます。複数のメッセージが送信された場合、メッセージが処理される順序は保証されません。順序を保証するには、メッセージを一度に 1 つずつ送信し、成功のレスポンスを待つ必要があります。 ``` aws iotevents-data batch-put-message \ --cli-input-json file://highPressureMessage.json ``` `highPressureMessage.json` の内容: ``` { "messages": [ { "messageId": "00001", "inputName": "PressureInput", "payload": "{\"motorid\": \"Fulton-A32\", \"sensorData\": {\"pressure\": 80, \"temperature\": 39} }" } ] } ``` 出力: ``` { "BatchPutMessageErrorEntries": [] } ``` 詳細については、「*AWS IoT Events API リファレンス*」の「[BatchPutMessage](https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchPutMessage.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchPutMessage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/batch-put-message.html)」を参照してください。 ### `batch-update-detector` 次のコード例は、`batch-update-detector` を使用する方法を示しています。 **AWS CLI** **ディテクター (インスタンス) を更新するには** 次の `batch-update-detector` の例では、指定されたディテクターモデルの 1 つ以上のディテクター (インスタンス) の状態、変数値、タイマー設定を更新します。 ``` aws iotevents-data batch-update-detector \ --cli-input-json file://budFulton-A32.json ``` `budFulton-A32.json` の内容: ``` { "detectors": [ { "messageId": "00001", "detectorModelName": "motorDetectorModel", "keyValue": "Fulton-A32", "state": { "stateName": "Normal", "variables": [ { "name": "pressureThresholdBreached", "value": "0" } ], "timers": [ ] } } ] } ``` 出力: ``` { "batchUpdateDetectorErrorEntries": [] } ``` 詳細については、「*AWS IoT Events API リファレンス*」の「[BatchUpdateDetector](https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchUpdateDetector.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchUpdateDetector](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/batch-update-detector.html)」を参照してください。 ### `create-detector-model` 次のコード例は、`create-detector-model` を使用する方法を示しています。 **AWS CLI** **ディテクターモデルを作成するには** 次の `create-detector-model` の例では、パラメータファイルで指定された設定でディテクターモデルを作成します。 ``` aws iotevents create-detector-model \ --cli-input-json file://motorDetectorModel.json ``` `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" } ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS IoT Events API リファレンス*」の「[CreateDetectorModel](https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateDetectorModel.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDetectorModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/create-detector-model.html)」を参照してください。 ### `create-input` 次のコード例は、`create-input` を使用する方法を示しています。 **AWS CLI** **入力を作成するには** 次の `create-input` の例では、入力を作成します。 ``` aws iotevents create-input \ --cli-input-json file://pressureInput.json ``` `pressureInput.json` の内容: ``` { "inputName": "PressureInput", "inputDescription": "Pressure readings from a motor", "inputDefinition": { "attributes": [ { "jsonPath": "sensorData.pressure" }, { "jsonPath": "motorid" } ] } } ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS IoT Events API リファレンス*」の「[CreateInput](https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateInput)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateInput](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/create-input.html)」を参照してください。 ### `delete-detector-model` 次のコード例は、`delete-detector-model` を使用する方法を示しています。 **AWS CLI** **ディテクターモデルを削除するには** 次の `delete-detector-model` の例では、指定されたディテクターモデルを削除します。ディテクターモデルのアクティブなインスタンスも削除されます。 ``` aws iotevents delete-detector-model \ --detector-model-name motorDetectorModel ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Events API リファレンス*」の「[DeleteDetectorModel](https://docs.aws.amazon.com/iotevents/latest/apireference/API_DeleteDetectorModel)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDetectorModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/delete-detector-model.html)」を参照してください。 ### `delete-input` 次のコード例は、`delete-input` を使用する方法を示しています。 **AWS CLI** **入力を削除するには** 次の `delete-input` の例では、指定された入力を削除します。 ``` aws iotevents delete-input \ --input-name PressureInput ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Events API リファレンス*」の「[DeleteInput](https://docs.aws.amazon.com/iotevents/latest/apireference/API_DeleteInput)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteInput](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/delete-input.html)」を参照してください。 ### `describe-detector-model` 次のコード例は、`describe-detector-model` を使用する方法を示しています。 **AWS CLI** **ディテクターモデルに関する情報を取得するには** 次の `describe-detector-model` の例では、指定されたディテクターモデルの詳細を表示します。`version` パラメータが指定されていないため、最新バージョンに関する情報が返されます。 ``` aws iotevents describe-detector-model \ --detector-model-name motorDetectorModel ``` 出力: ``` { "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" } } } ``` 詳細については、「*AWS IoT Events API リファレンス*」の「[DescribeDetectorModel](https://docs.aws.amazon.com/iotevents/latest/apireference/API_DescribeDetectorModel)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDetectorModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/describe-detector-model.html)」を参照してください。 ### `describe-detector` 次のコード例は、`describe-detector` を使用する方法を示しています。 **AWS CLI** **ディテクター (インスタンス) に関する情報を取得するには** 次の `describe-detector` の例では、指定されたディテクター (インスタンス) の詳細を表示します。 ``` aws iotevents-data describe-detector \ --detector-model-name motorDetectorModel \ --key-value "Fulton-A32" ``` 出力: ``` { "detector": { "lastUpdateTime": 1560797852.776, "creationTime": 1560797852.775, "state": { "variables": [ { "name": "pressureThresholdBreached", "value": "3" } ], "stateName": "Dangerous", "timers": [] }, "keyValue": "Fulton-A32", "detectorModelName": "motorDetectorModel", "detectorModelVersion": "1" } } ``` 詳細については、「*AWS IoT Events API リファレンス*」の「[DescribeDetector](https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_DescribeDetector)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDetector](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/describe-detector.html)」を参照してください。 ### `describe-input` 次のコード例は、`describe-input` を使用する方法を示しています。 **AWS CLI** **入力に関する情報を取得するには** 次の `describe-input` の例では、指定された入力の詳細を表示します。 ``` aws iotevents describe-input \ --input-name PressureInput ``` 出力: ``` { "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" } ] } } } ``` 詳細については、「*AWS IoT Events API リファレンス*」の「[DescribeInput](https://docs.aws.amazon.com/iotevents/latest/apireference/API_DescribeInput)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeInput](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/describe-input.html)」を参照してください。 ### `describe-logging-options` 次のコード例は、`describe-logging-options` を使用する方法を示しています。 **AWS CLI** **ログ記録設定に関する情報を取得するには** 次の `describe-logging-options` の例では、AWS IoT Events ログ記録オプションの現在の設定を取得します。 ``` aws iotevents describe-logging-options ``` 出力: ``` { "loggingOptions": { "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", "enabled": false, "level": "ERROR" } } ``` 詳細については、「*AWS IoT Events API リファレンス*」の「[DescribeLoggingOptions](https://docs.aws.amazon.com/iotevents/latest/apireference/API_DescribeLoggingOptions)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeLoggingOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/describe-logging-options.html)」を参照してください。 ### `list-detector-model-versions` 次のコード例は、`list-detector-model-versions` を使用する方法を示しています。 **AWS CLI** **ディテクターモデルのバージョンに関する情報を取得するには** 次の `list-detector-model-versions` の例では、ディテクターモデルのすべてのバージョンを一覧表示します。各探知器モデルのバージョンに関連付けられているメタデータのみが返されます。 ``` aws iotevents list-detector-model-versions \ --detector-model-name motorDetectorModel ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IoT Events API リファレンス*」の「[ListDetectorModelVersions](https://docs.aws.amazon.com/iotevents/latest/apireference/API_ListDetectorModelVersions)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDetectorModelVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/list-detector-model-versions.html)」を参照してください。 ### `list-detector-models` 次のコード例は、`list-detector-models` を使用する方法を示しています。 **AWS CLI** **ディテクターモデルのリストを取得するには** 次の `list-detector-models` の例では、作成したディテクターモデルを一覧表示します。各探知器モデルに関連付けられているメタデータのみが返されます。 ``` aws iotevents list-detector-models ``` 出力: ``` { "detectorModelSummaries": [ { "detectorModelName": "motorDetectorModel", "creationTime": 1552072424.212 "detectorModelDescription": "Detect overpressure in a motor." } ] } ``` 詳細については、「*AWS IoT Events API リファレンス*」の「[ListDetectorModels](https://docs.aws.amazon.com/iotevents/latest/apireference/API_ListDetectorModels)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDetectorModels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/list-detector-models.html)」を参照してください。 ### `list-detectors` 次のコード例は、`list-detectors` を使用する方法を示しています。 **AWS CLI** **ディテクターモデルのディテクターのリストを取得するには** 次の `list-detectors` の例では、アカウント内のディテクター (ディテクターモデルのインスタンス) を一覧表示します。 ``` aws iotevents-data list-detectors \ --detector-model-name motorDetectorModel ``` 出力: ``` { "detectorSummaries": [ { "lastUpdateTime": 1558129925.2, "creationTime": 1552073155.527, "state": { "stateName": "Normal" }, "keyValue": "Fulton-A32", "detectorModelName": "motorDetectorModel", "detectorModelVersion": "1" } ] } ``` 詳細については、「*AWS IoT Events API リファレンス*」の「[ListDetectors](https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_ListDetectors)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDetectors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/list-detectors.html)」を参照してください。 ### `list-inputs` 次のコード例は、`list-inputs` を使用する方法を示しています。 **AWS CLI** **入力を一覧表示するには** 次の `list-inputs` の例では、アカウントに作成した入力を一覧表示します。 ``` aws iotevents list-inputs ``` このコマンドでは何も出力されません。出力: ``` { { "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" } } ``` 詳細については、「*AWS IoT Events API リファレンス*」の「[ListInputs](https://docs.aws.amazon.com/iotevents/latest/apireference/API_ListInputs)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListInputs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/list-inputs.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **リソースに割り当てられたタグを一覧表示するには。** 次の `list-tags-for-resource` の例では、リソースに割り当てたタグキーの名前と値を一覧表示します。 ``` aws iotevents list-tags-for-resource \ --resource-arn "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput" ``` 出力: ``` { "tags": [ { "value": "motor", "key": "deviceType" } ] } ``` 詳細については、「*AWS IoT Events API リファレンス*」の「[ListTagsForResource](https://docs.aws.amazon.com/iotevents/latest/apireference/API_ListTagsForResource)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/list-tags-for-resource.html)」を参照してください。 ### `put-logging-options` 次のコード例は、`put-logging-options` を使用する方法を示しています。 **AWS CLI** **ログ記録オプションを設定するには** 次の `put-logging-options` の例では、AWS IoT Events ログ記録オプションを設定または更新します。`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` のいずれかのフィールドの値を更新する場合 (無効なポリシーを修正するなど)、その変更が有効になるまでに最大 5 分かかることがあります。 ``` aws iotevents put-logging-options \ --cli-input-json file://logging-options.json ``` `logging-options.json` の内容: ``` { "loggingOptions": { "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", "level": "DEBUG", "enabled": true, "detectorDebugOptions": [ { "detectorModelName": "motorDetectorModel", "keyValue": "Fulton-A32" } ] } } ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Events API リファレンス*」の「[PutLoggingOptions](https://docs.aws.amazon.com/iotevents/latest/apireference/API_PutLoggingOptions)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutLoggingOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/put-logging-options.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **リソースにタグを追加するには** 次の `tag-resource` の例では、指定されたリソースにアタッチされたタグを追加または変更 (キー `deviceType` が既に存在する場合) します。 ``` aws iotevents tag-resource \ --cli-input-json file://pressureInput.tag.json ``` `pressureInput.tag.json` の内容: ``` { "resourceArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", "tags": [ { "key": "deviceType", "value": "motor" } ] } ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Events API リファレンス*」の「[TagResource](https://docs.aws.amazon.com/iotevents/latest/apireference/API_TagResource)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **リソースからタグを削除する** 次の `untag-resource` の例では、指定されたキー名を持つタグを指定されたリソースから削除します。 ``` aws iotevents untag-resource \ --resource-arn arn:aws:iotevents:us-west-2:123456789012:input/PressureInput \ --tagkeys deviceType ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Events API リファレンス*」の「[UntagResource](https://docs.aws.amazon.com/iotevents/latest/apireference/API_UntagResource)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/untag-resource.html)」を参照してください。 ### `update-detector-model` 次のコード例は、`update-detector-model` を使用する方法を示しています。 **AWS CLI** **ディテクターモデルを更新するには** 次の `update-detector-model` の例では、指定されたディテクターモデルを更新します。以前のバージョンによって生成されたディテクター (インスタンス) が削除され、新しい入力が到着すると再作成されます。 ``` aws iotevents update-detector-model \ --cli-input-json file://motorDetectorModel.update.json ``` `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" } ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS IoT Events API リファレンス*」の「[UpdateDetectorModel](https://docs.aws.amazon.com/iotevents/latest/apireference/API_UpdateDetectorModel)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateDetectorModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/update-detector-model.html)」を参照してください。 ### `update-input` 次のコード例は、`update-input` を使用する方法を示しています。 **AWS CLI** **入力を更新するには** 次の `update-input` の例では、指定された入力を新しい説明と定義で更新します。 ``` aws iotevents update-input \ --cli-input-json file://pressureInput.json ``` `pressureInput.json` の内容: ``` { "inputName": "PressureInput", "inputDescription": "Pressure readings from a motor", "inputDefinition": { "attributes": [ { "jsonPath": "sensorData.pressure" }, { "jsonPath": "motorid" } ] } } ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS IoT Events API リファレンス*」の「[UpdateInput](https://docs.aws.amazon.com/iotevents/latest/apireference/API_UpdateInput)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateInput](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents/update-input.html)」を参照してください。 # AWS IoT Events-Data examples using AWS CLI 次のコード例では、AWS IoT Events-Data で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `batch-put-message` 次のコード例は、`batch-put-message` を使用する方法を示しています。 **AWS CLI** **AWS IoT Events にメッセージ (入力) を送信するには** 次の `batch-put-message` の例では、一連のメッセージを AWS IoT Events システムに送信します。各メッセージペイロードは、指定した入力 (`inputName`) に変換され、その入力をモニタリングするディテクターに取り込まれます。複数のメッセージが送信された場合、メッセージが処理される順序は保証されません。順序を保証するには、メッセージを一度に 1 つずつ送信し、成功のレスポンスを待つ必要があります。 ``` aws iotevents-data batch-put-message \ --cli-binary-format raw-in-base64-out \ --cli-input-json file://highPressureMessage.json ``` `highPressureMessage.json` の内容: ``` { "messages": [ { "messageId": "00001", "inputName": "PressureInput", "payload": "{\"motorid\": \"Fulton-A32\", \"sensorData\": {\"pressure\": 80, \"temperature\": 39} }" } ] } ``` 出力: ``` { "BatchPutMessageErrorEntries": [] } ``` 詳細については、「*AWS IoT Events デベロッパーガイド\$1*」の「[BatchPutMessage](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-data-BatchPutMessage)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchPutMessage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/batch-put-message.html)」を参照してください。 ### `batch-update-detector` 次のコード例は、`batch-update-detector` を使用する方法を示しています。 **AWS CLI** **ディテクター (インスタンス) を更新するには** 次の `batch-update-detector` の例では、指定されたディテクターモデルの 1 つ以上のディテクター (インスタンス) の状態、変数値、タイマー設定を更新します。 ``` aws iotevents-data batch-update-detector \ --cli-input-json file://budFulton-A32.json ``` `budFulton-A32.json` の内容: ``` { "detectors": [ { "messageId": "00001", "detectorModelName": "motorDetectorModel", "keyValue": "Fulton-A32", "state": { "stateName": "Normal", "variables": [ { "name": "pressureThresholdBreached", "value": "0" } ], "timers": [ ] } } ] } ``` 出力: ``` { "batchUpdateDetectorErrorEntries": [] } ``` 詳細については、「*AWS IoT Events デベロッパーガイド\$1*」の「[BatchUpdateDetector](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-data-BatchUpdateDetector)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchUpdateDetector](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/batch-update-detector.html)」を参照してください。 ### `create-detector-model` 次のコード例は、`create-detector-model` を使用する方法を示しています。 **AWS CLI** **ディテクターモデルを作成するには** 次の `create-detector-model` の例では、ディテクターモデルを作成します。 ``` aws iotevents create-detector-model \ --cli-input-json file://motorDetectorModel.json ``` `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" } ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS IoT Events デベロッパーガイド\$1*」の「[CreateDetectorModel](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-CreateDetectorModel)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDetectorModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/create-detector-model.html)」を参照してください。 ### `create-input` 次のコード例は、`create-input` を使用する方法を示しています。 **AWS CLI** **入力を作成するには** 次の `create-input` の例では、入力を作成します。 ``` aws iotevents create-input \ --cli-input-json file://pressureInput.json ``` `pressureInput.json` の内容: ``` { "inputName": "PressureInput", "inputDescription": "Pressure readings from a motor", "inputDefinition": { "attributes": [ { "jsonPath": "sensorData.pressure" }, { "jsonPath": "motorid" } ] } } ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS IoT Events デベロッパーガイド\$1*」の「[CreateInput](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-CreateInput)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateInput](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/create-input.html)」を参照してください。 ### `delete-detector-model` 次のコード例は、`delete-detector-model` を使用する方法を示しています。 **AWS CLI** **ディテクターモデルを削除するには** 次の `delete-detector-model` の例では、ディテクターモデルを削除します。ディテクターモデルのアクティブなインスタンスも削除されます。 ``` aws iotevents delete-detector-model \ --detector-model-name motorDetectorModel* ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Events デベロッパーガイド\$1*」の「[DeleteDetectorModel](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-DeleteDetectorModel)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDetectorModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/delete-detector-model.html)」を参照してください。 ### `delete-input` 次のコード例は、`delete-input` を使用する方法を示しています。 **AWS CLI** **入力を削除するには** 次の `delete-input` の例では、入力を削除します。 ``` aws iotevents delete-input \ --input-name PressureInput ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Events デベロッパーガイド\$1*」の「[DeleteInput](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-DeleteInput)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteInput](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/delete-input.html)」を参照してください。 ### `describe-detector-model` 次のコード例は、`describe-detector-model` を使用する方法を示しています。 **AWS CLI** **ディテクターモデルに関する情報を取得するには** 次の `describe-detector-model` の例では、ディテクターモデルの説明を表示します。`version` パラメータが指定されていない場合、コマンドは最新バージョンに関する情報を返します。 ``` aws iotevents describe-detector-model \ --detector-model-name motorDetectorModel ``` 出力: ``` { "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" } } } ``` 詳細については、「*AWS IoT Events ディベロッパーガイド\$1*」の「[DescribeDetectorModel](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-DescribeDetectorModel)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDetectorModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/describe-detector-model.html)」を参照してください。 ### `describe-detector` 次のコード例は、`describe-detector` を使用する方法を示しています。 **AWS CLI** **ディテクター (インスタンス) に関する情報を取得するには** 次の `describe-detector` の例では、指定されたディテクター (インスタンス) に関する情報を返します。 ``` aws iotevents-data describe-detector \ --detector-model-name motorDetectorModel \ --key-value "Fulton-A32" ``` 出力: ``` { "detector": { "lastUpdateTime": 1560797852.776, "creationTime": 1560797852.775, "state": { "variables": [ { "name": "pressureThresholdBreached", "value": "3" } ], "stateName": "Dangerous", "timers": [] }, "keyValue": "Fulton-A32", "detectorModelName": "motorDetectorModel", "detectorModelVersion": "1" } } ``` 詳細については、「*AWS IoT Events ディベロッパーガイド\$1*」の「[DescribeDetector](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-data-DescribeDetector)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDetector](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/describe-detector.html)」を参照してください。 ### `describe-input` 次のコード例は、`describe-input` を使用する方法を示しています。 **AWS CLI** **入力に関する情報を取得するには** 次の `describe-input` の例では、入力の詳細を取得します。 ``` aws iotevents describe-input \ --input-name PressureInput ``` 出力: ``` { "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" } ] } } } ``` 詳細については、「*AWS IoT Events ディベロッパーガイド\$1*」の「[DescribeInput](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-DescribeInput)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeInput](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/describe-input.html)」を参照してください。 ### `describe-logging-options` 次のコード例は、`describe-logging-options` を使用する方法を示しています。 **AWS CLI** **ログ記録設定に関する情報を取得するには** 次の `describe-logging-options` の例では、現在の AWS IoT Events ログ記録オプションを取得します。 ``` aws iotevents describe-logging-options ``` 出力: ``` { "loggingOptions": { "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", "enabled": false, "level": "ERROR" } } ``` 詳細については、「*AWS IoT Events ディベロッパーガイド\$1*」の「[DescribeLoggingOptions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-DescribeLoggingOptions)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeLoggingOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/describe-logging-options.html)」を参照してください。 ### `list-detector-model-versions` 次のコード例は、`list-detector-model-versions` を使用する方法を示しています。 **AWS CLI** **ディテクターモデルのバージョンに関する情報を取得するには** 次の `list-detector-model-versions` の例では、ディテクターモデルのすべてのバージョンを一覧表示します。各探知器モデルのバージョンに関連付けられているメタデータのみが返されます。 ``` aws iotevents list-detector-model-versions \ --detector-model-name motorDetectorModel ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IoT Events デベロッパーガイド\$1*」の「[ListDetectorModelVersions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-ListDetectorModelVersions)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDetectorModelVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/list-detector-model-versions.html)」を参照してください。 ### `list-detector-models` 次のコード例は、`list-detector-models` を使用する方法を示しています。 **AWS CLI** **ディテクターモデルのリストを取得するには** 次の `list-detector-models` の例では、作成したディテクターモデルを一覧表示します。各探知器モデルに関連付けられているメタデータのみが返されます。 ``` aws iotevents list-detector-models ``` 出力: ``` { "detectorModelSummaries": [ { "detectorModelName": "motorDetectorModel", "creationTime": 1552072424.212 "detectorModelDescription": "Detect overpressure in a motor." } ] } ``` 詳細については、「*AWS IoT Events デベロッパーガイド\$1*」の「[ListDetectorModels](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-ListDetectorModels)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDetectorModels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/list-detector-models.html)」を参照してください。 ### `list-detectors` 次のコード例は、`list-detectors` を使用する方法を示しています。 **AWS CLI** **ディテクターモデルのディテクターのリストを取得するには** 次の `list-detectors` の例では、ディテクター (ディテクターモデルのインスタンス) を一覧表示します。 ``` aws iotevents-data list-detectors \ --detector-model-name motorDetectorModel ``` 出力: ``` { "detectorSummaries": [ { "lastUpdateTime": 1558129925.2, "creationTime": 1552073155.527, "state": { "stateName": "Normal" }, "keyValue": "Fulton-A32", "detectorModelName": "motorDetectorModel", "detectorModelVersion": "1" } ] } ``` 詳細については、「*AWS IoT Events デベロッパーガイド\$1*」の「[ListDetectors](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-ListDetectors)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDetectors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/list-detectors.html)」を参照してください。 ### `list-inputs` 次のコード例は、`list-inputs` を使用する方法を示しています。 **AWS CLI** **入力を一覧表示するには** 次の `list-inputs` の例では、作成した入力を一覧表示します。 ``` aws iotevents list-inputs ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT Events デベロッパーガイド\$1*」の「[ListInputs](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-ListInputs)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListInputs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/list-inputs.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **リソースに割り当てられたタグを一覧表示するには** 次の `list-tags-for-resource` の例では、リソースに割り当てたタグ (メタデータ) を一覧表示します。 ``` aws iotevents list-tags-for-resource \ --resource-arn "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput" ``` 出力: ``` { "tags": [ { "value": "motor", "key": "deviceType" } ] } ``` 詳細については、「*AWS IoT Events デベロッパーガイド\$1*」の「[ListTagsForResource](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-ListTagsForResource)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/list-tags-for-resource.html)」を参照してください。 ### `put-logging-options` 次のコード例は、`put-logging-options` を使用する方法を示しています。 **AWS CLI** **ログ記録オプションを設定するには** 次の `list-tags-for-resource` の例では、AWS IoT Events ログ記録オプションを設定または更新します。いずれかの `loggingOptions` フィールドの値を更新する場合、変更が有効になるまでに最大で 1 分かかることに注意してください また、`roleArn` フィールドで指定したロールにアタッチされるポリシーを変更する場合 (たとえば、無効なポリシーを修正するなど)、この変更が有効になるまでには最大で 5 分かかります。 ``` aws iotevents put-logging-options \ --cli-input-json file://logging-options.json ``` `logging-options.json` の内容: ``` { "loggingOptions": { "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", "level": "DEBUG", "enabled": true, "detectorDebugOptions": [ { "detectorModelName": "motorDetectorModel", "keyValue": "Fulton-A32" } ] } } ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Events ディベロッパーガイド\$1*」の「[PutLoggingOptions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-PutLoggingOptions)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutLoggingOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/put-logging-options.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **リソースにタグを追加するには** 次の `tag-resource` の例では、指定されたリソースのタグを追加または変更します。タグは、リソースを管理するために使用できるメタデータです。 ``` aws iotevents tag-resource \ --cli-input-json file://pressureInput.tag.json ``` `pressureInput.tag.json` の内容: ``` { "resourceArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", "tags": [ { "key": "deviceType", "value": "motor" } ] } ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Events デベロッパーガイド\$1*」の「[TagResource](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-TagResource)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **リソースからタグを削除する** 次の `untag-resource` の例では、指定されたタグをリソースから削除します。 ``` aws iotevents untag-resource \ --cli-input-json file://pressureInput.untag.json ``` `pressureInput.untag.json` の内容: ``` { "resourceArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", "tagKeys": [ "deviceType" ] } ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Events デベロッパーガイド\$1*」の「[UntagResource](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-UntagResource)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/untag-resource.html)」を参照してください。 ### `update-detector-model` 次のコード例は、`update-detector-model` を使用する方法を示しています。 **AWS CLI** **ディテクターモデルを更新するには** 次の `update-detector-model` の例では、ディテクターモデルを更新します。以前のバージョンによって生成されたディテクター (インスタンス) が削除され、新しい入力が到着すると再作成されます。 ``` aws iotevents update-detector-model \ --cli-input-json file://motorDetectorModel.update.json ``` Contents of 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" } ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS IoT Events デベロッパーガイド\$1*」の「[UpdateDetectorModel](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-UpdateDetectorModel)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateDetectorModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/update-detector-model.html)」を参照してください。 ### `update-input` 次のコード例は、`update-input` を使用する方法を示しています。 **AWS CLI** **入力を更新するには** 次の `update-input` の例では、入力を更新します。 ``` aws iotevents update-input \ --cli-input-json file://pressureInput.json ``` `pressureInput.json` の内容: ``` { "inputName": "PressureInput", "inputDescription": "Pressure readings from a motor", "inputDefinition": { "attributes": [ { "jsonPath": "sensorData.pressure" }, { "jsonPath": "motorid" } ] } } ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS IoT Events デベロッパーガイド\$1*」の「[UpdateInput](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-commands.html#api-iotevents-UpdateInput)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateInput](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotevents-data/update-input.html)」を参照してください。 # AWS IoT Greengrass examples using AWS CLI 次のコード例では、AWS IoT Greengrass で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `associate-role-to-group` 次のコード例は、`associate-role-to-group` を使用する方法を示しています。 **AWS CLI** **ロールを Greengrass グループに関連付けるには** 次の `associate-role-to-group` の例では、指定された IAM ロールを Greengrass グループに関連付けます。グループロールは、ローカルの Lambda 関数とコネクタが AWS サービスにアクセスするために使用します。例えば、グループロールは 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 ``` 出力: ``` { "AssociatedAt": "2019-09-10T20:03:30Z" } ``` グループの詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[グループロールを設定する](https://docs.aws.amazon.com/greengrass/latest/developerguide/config-iam-roles.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateRoleToGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/associate-role-to-group.html)」を参照してください。 ### `associate-service-role-to-account` 次のコード例は、`associate-service-role-to-account` を使用する方法を示しています。 **AWS CLI** **サービスロールと AWS アカウントを関連付けるには** 次の `associate-service-role-to-account` の例では、ARN で指定された IAM サービスロールを AWS アカウントの AWS IoT Greengrass に関連付けます。IAM でサービスロールを事前に作成し、AWS IoT Greengrass がこのロールを引き受けることができるポリシードキュメントを関連付ける必要があります。 ``` aws greengrass associate-service-role-to-account \ --role-arn "arn:aws:iam::123456789012:role/service-role/Greengrass_ServiceRole" ``` 出力: ``` { "AssociatedAt": "2019-06-25T18:12:45Z" } ``` 詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[Greengrass サービスロール](https://docs.aws.amazon.com/greengrass/latest/developerguide/service-role.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateServiceRoleToAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/associate-service-role-to-account.html)」を参照してください。 ### `create-connector-definition-version` 次のコード例は、`create-connector-definition-version` を使用する方法を示しています。 **AWS CLI** **コネクタ定義バージョンを作成するには** 次の `create-connector-definition-version` の例では、コネクタ定義バージョンを作成し、指定されたコネクタ定義に関連付けます。バージョン内のすべてのコネクタはパラメータの値を定義します。 ``` 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\"}}]" ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateConnectorDefinitionVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-connector-definition-version.html)」を参照してください。 ### `create-connector-definition` 次のコード例は、`create-connector-definition` を使用する方法を示しています。 **AWS CLI** **コネクタ定義を作成するには** 次の `create-connector-definition` の例では、コネクタ定義と初期コネクタ定義バージョンを作成します。初期バージョンにはコネクタが 1 つ含まれています。バージョン内のすべてのコネクタはパラメータの値を定義します。 ``` 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\"}}]}" ``` 出力: ``` { "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" } ``` 詳細については、「**AWS IoT デベロッパーガイド**」の「[Greengrass コネクタの開始方法 (CLI)](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateConnectorDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-connector-definition.html)」を参照してください。 ### `create-core-definition-version` 次のコード例は、`create-core-definition-version` を使用する方法を示しています。 **AWS CLI** **コア定義バージョンを作成するには** 次の `create-core-definition-version` の例では、コア定義バージョンを作成し、指定したコア定義に関連付けます。バージョンに含めることができるのは 1 つのコアのみです。コアを作成する前に、対応する AWS IoT モノを作成してプロビジョニングする必要があります。このプロセスには、`create-core-definition-version` コマンドに必要な `ThingArn` と `CertificateArn` を返す次の `iot` コマンドが含まれます。 コアデバイスに対応する AWS IoT モノを作成します。 ``` aws iot create-thing \ --thing-name "MyCoreDevice" ``` 出力: ``` { "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyCoreDevice", "thingName": "MyCoreDevice", "thingId": "cb419a19-9099-4515-9cec-e9b0e760608a" } ``` パブリックキーとプライベートキー、およびモノのコアデバイス証明書を作成します。この例では `create-keys-and-certificate` コマンドを使用し、現在のディレクトリへの書き込みアクセス許可を必要とします。または、 `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" ``` 出力: ``` { "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" } ``` `iot` および `greengrass` アクションを許可する AWS IoT ポリシーを作成します。簡単にするために、次のポリシーではすべてのリソースに対するアクションが許可されていますが、ポリシーはより制限されている必要があります。 ``` 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\":[\"*\"]}]}" ``` 出力: ``` { "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" } ``` ポリシーを証明書にアタッチします。 ``` aws iot attach-policy \ --policy-name "Core_Devices" \ --target "arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz" ``` このコマンドでは何も出力されません。 モノを証明書にアタッチします。 ``` aws iot attach-thing-principal \ --thing-name "MyCoreDevice" \ --principal "arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz" ``` このコマンドでは何も出力されません。 コア定義バージョンを作成します。 ``` 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}]" ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[AWS IoT Greengrass コアを設定する](https://docs.aws.amazon.com/greengrass/latest/developerguide/gg-core.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCoreDefinitionVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-core-definition-version.html)」を参照してください。 ### `create-core-definition` 次のコード例は、`create-core-definition` を使用する方法を示しています。 **AWS CLI** **例 1: 空のコア定義を作成するには** 次の `create-core-definition` の例では、空の (初期バージョンなし) Greengrass コア定義を作成します。コアを使用する前に、`create-core-definition-version` コマンドを使用してコアの他のパラメータを指定する必要があります。 ``` aws greengrass create-core-definition \ --name cliGroup_Core ``` 出力: ``` { "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" } ``` **例 2: 初期バージョンでコア定義を作成するには** 次の `create-core-definition` の例では、初期コア定義バージョンを含むコアバージョンを作成します。バージョンに含めることができるのは 1 つのコアのみです。コアを作成する前に、対応する AWS IoT モノを作成してプロビジョニングする必要があります。このプロセスには、`create-core-definition` コマンドに必要な `ThingArn` と `CertificateArn` を返す次の `iot` コマンドが含まれます。 コアデバイスに対応する AWS IoT モノを作成します。 ``` aws iot create-thing \ --thing-name "MyCoreDevice" ``` 出力: ``` { "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyCoreDevice", "thingName": "MyCoreDevice", "thingId": "cb419a19-9099-4515-9cec-e9b0e760608a" } ``` パブリックキーとプライベートキー、およびモノのコアデバイス証明書を作成します。この例では `create-keys-and-certificate` コマンドを使用し、現在のディレクトリへの書き込みアクセス許可を必要とします。または、 `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" ``` 出力: ``` { "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" } ``` `iot` および `greengrass` アクションを許可する AWS IoT ポリシーを作成します。簡単にするために、次のポリシーではすべてのリソースに対するアクションが許可されていますが、ポリシーはより制限されている必要があります。 ``` 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\":[\"*\"]}]}" ``` 出力: ``` { "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" } ``` ポリシーを証明書にアタッチします。 ``` aws iot attach-policy \ --policy-name "Core_Devices" \ --target "arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz" ``` このコマンドでは何も出力されません。 モノを証明書にアタッチします。 ``` aws iot attach-thing-principal \ --thing-name "MyCoreDevice" \ --principal "arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz" ``` このコマンドでは何も出力されません。 コア定義を作成します。 ``` 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}]}" ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[AWS IoT Greengrass コアを設定する](https://docs.aws.amazon.com/greengrass/latest/developerguide/gg-core.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCoreDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-core-definition.html)」を参照してください。 ### `create-deployment` 次のコード例は、`create-deployment` を使用する方法を示しています。 **AWS CLI** **Greengrass グループのバージョンのデプロイを作成するには** 次の `create-deployment` の例では、Greengrass グループの指定されたバージョンをデプロイします。 ``` aws greengrass create-deployment \ --deployment-type NewDeployment \ --group-id "ce2e7d01-3240-4c24-b8e6-f6f6e7a9eeca" \ --group-version-id "dc40c1e9-e8c8-4d28-a84d-a9cad5f599c9" ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[コネクタの開始方法 (CLI)](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors-cli.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[CreateDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-deployment.html)」を参照してください。** ### `create-device-definition-version` 次のコード例は、`create-device-definition-version` を使用する方法を示しています。 **AWS CLI** **デバイス定義バージョンを作成するには** 次の `create-device-definition-version` の例では、デバイス定義バージョンを作成し、指定したデバイス定義に関連付けます。バージョンは 2 つのデバイスを定義します。Greengrass デバイスを作成する前に、まず対応する AWS IoT モノを作成してプロビジョニングする必要があります。このプロセスには、Greengrass コマンドに必要な情報を取得するために実行する必要がある次の `iot` コマンドが含まれています。 デバイスに対応する AWS IoT モノを作成します。 ``` aws iot create-thing \ --thing-name "InteriorTherm" ``` 出力: ``` { "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/InteriorTherm", "thingName": "InteriorTherm", "thingId": "01d4763c-78a6-46c6-92be-7add080394bf" } ``` パブリックキーとプライベートキー、およびモノのデバイス証明書を作成します。この例では `create-keys-and-certificate` コマンドを使用し、現在のディレクトリへの書き込みアクセス許可を必要とします。または、`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" ``` 出力: ``` { "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" } ``` `iot` および `greengrass` アクションを許可する AWS IoT ポリシーを作成します。簡単にするために、次のポリシーではすべてのリソースに対するアクションが許可されていますが、ポリシーはより制限的になる可能性があります。 ``` 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\":[\"*\"]}]}" ``` 出力: ``` { "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" } ``` ポリシーを証明書にアタッチします。 ``` aws iot attach-policy \ --policy-name "GG_Devices" \ --target "arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92" ``` モノを証明書にアタッチします ``` aws iot attach-thing-principal \ --thing-name "InteriorTherm" \ --principal "arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92" ``` 上記のように IoT モノを作成して設定したら、次の例の最初の 2 つのコマンドから `ThingArn` と `CertificateArn` を使用します。 ``` 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}]" ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDeviceDefinitionVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-device-definition-version.html)」を参照してください。 ### `create-device-definition` 次のコード例は、`create-device-definition` を使用する方法を示しています。 **AWS CLI** **デバイス定義を作成するには** 次の `create-device-definition` の例では、初期デバイス定義バージョンを含むデバイス定義を作成します。初期バージョンでは、2 つのデバイスを定義します。Greengrass デバイスを作成する前に、まず対応する AWS IoT モノを作成してプロビジョニングする必要があります。このプロセスには、Greengrass コマンドに必要な情報を取得するために実行する必要がある次の `iot` コマンドが含まれています。 デバイスに対応する AWS IoT モノを作成します。 ``` aws iot create-thing \ --thing-name "InteriorTherm" ``` 出力: ``` { "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/InteriorTherm", "thingName": "InteriorTherm", "thingId": "01d4763c-78a6-46c6-92be-7add080394bf" } ``` パブリックキーとプライベートキー、およびモノのデバイス証明書を作成します。この例では `create-keys-and-certificate` コマンドを使用し、現在のディレクトリへの書き込みアクセス許可を必要とします。または、`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" ``` 出力: ``` { "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" } ``` `iot` および `greengrass` アクションを許可する AWS IoT ポリシーを作成します。簡単にするために、次のポリシーではすべてのリソースに対するアクションが許可されていますが、ポリシーはより制限的になる可能性があります。 ``` 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\":[\"*\"]}]}" ``` 出力: ``` { "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" } ``` ポリシーを証明書にアタッチします。 ``` aws iot attach-policy \ --policy-name "GG_Devices" \ --target "arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92" ``` モノを証明書にアタッチします ``` aws iot attach-thing-principal \ --thing-name "InteriorTherm" \ --principal "arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92" ``` 上記のように IoT モノを作成して設定したら、次の例の最初の 2 つのコマンドから `ThingArn` と `CertificateArn` を使用します。 ``` 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}]}" ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDeviceDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-device-definition.html)」を参照してください。 ### `create-function-definition-version` 次のコード例は、`create-function-definition-version` を使用する方法を示しています。 **AWS CLI** **関数定義のバージョンを作成するには** 次の `create-function-definition-version` の例では、指定された関数定義の新しいバージョンを作成します。このバージョンは、ID が `Hello-World-function` の単一の関数を指定し、ファイルシステムへのアクセスを許可し、最大メモリサイズとタイムアウト期間を指定します。 ``` 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}}]}" ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateFunctionDefinitionVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-function-definition-version.html)」を参照してください。 ### `create-function-definition` 次のコード例は、`create-function-definition` を使用する方法を示しています。 **AWS CLI** **Lambda 関数定義を作成するには** 次の `create-function-definition` の例では、Lambda 関数のリスト (この場合は、`TempMonitorFunction` という名前の 1 つの関数のみのリスト) とそれらの設定を指定して、Lambda 関数定義と初期バージョンを作成します。関数定義を作成する前に、Lambda 関数 ARN が必要です。関数とそのエイリアスを作成するには、Lambda の `create-function` コマンドと `publish-version` コマンドを使用します。Lambda の `create-function` コマンドには実行ロールの ARN が必要ですが、アクセス許可は Greengrass グループロールで指定されているため、AWS IoT Greengrass はそのロールを使用しません。IAM `create-role` コマンドを使用して空のロールを作成し、Lambda の `create-function` で使用する ARN を取得するか、既存の実行ロールを使用できます。 ``` 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}}]}" ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[AWS コマンドラインインターフェイスを使用してローカルリソースアクセスを設定する方法](https://docs.aws.amazon.com/greengrass/latest/developerguide/lra-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateFunctionDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-function-definition.html)」を参照してください。 ### `create-group-certificate-authority` 次のコード例は、`create-group-certificate-authority` を使用する方法を示しています。 **AWS CLI** **グループの認証局 (CA) を作成するには** 次の `create-group-certificate-authority` の例では、指定されたグループの CA を作成またはローテーションします。 ``` aws greengrass create-group-certificate-authority \ --group-id "8eaadd72-ce4b-4f15-892a-0cc4f3a343f1" ``` 出力: ``` { "GroupCertificateAuthorityArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/8eaadd72-ce4b-4f15-892a-0cc4f3a343f1/certificateauthorities/d31630d674c4437f6c5dbc0dca56312a902171ce2d086c38e509c8EXAMPLEcc5" } ``` グループの詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[AWS IoT Greengrass セキュリティ](https://docs.aws.amazon.com/greengrass/latest/developerguide/gg-sec.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateGroupCertificateAuthority](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-group-certificate-authority.html)」を参照してください。 ### `create-group-version` 次のコード例は、`create-group-version` を使用する方法を示しています。 **AWS CLI** **Greengrass グループのバージョンを作成するには** 次の `create-group-version` の例では、グループバージョンを作成し、指定したグループに関連付けます。バージョンは、このグループバージョンに含めるエンティティを含むコア、リソース、コネクタ、関数、サブスクリプションバージョンを参照します。グループバージョンを作成する前に、これらのエンティティを作成する必要があります。 初期バージョンでリソース定義を作成するには、`create-resource-definition` コマンドを使用します。初期バージョンでコネクタ定義を作成するには、`create-connector-definition` を使用します。初期バージョンで関数定義を作成するには、`create-function-definition` を使用します。初期バージョンでサブスクリプション定義を作成するには、`create-subscription-definition` を使用します。初期コア定義バージョンの ARN を取得するには、`get-group-version` コマンドを使用し、最新のグループバージョンの ID を指定します。 ``` 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" ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[AWSIoT Greengrass グループオブジェクトモデルの概要](https://docs.aws.amazon.com/greengrass/latest/developerguide/deployments.html#api-overview)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateGroupVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-group-version.html)」を参照してください。 ### `create-group` 次のコード例は、`create-group` を使用する方法を示しています。 **AWS CLI** **Greeengrass グループを作成するには** 次の `create-group` の例では、`cli-created-group` という名前のグループが作成されます。 ``` aws greengrass create-group \ --name cli-created-group ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[AWSIoT Greengrass グループオブジェクトモデルの概要](https://docs.aws.amazon.com/greengrass/latest/developerguide/deployments.html#api-overview)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-group.html)」を参照してください。 ### `create-logger-definition-version` 次のコード例は、`create-logger-definition-version` を使用する方法を示しています。 **AWS CLI** **ロガー定義バージョンを作成するには** 次の `create-logger-definition-version` の例では、ロガー定義バージョンを作成し、ロガー定義に関連付けます。バージョンは、1) コアデバイスのファイルシステム上のシステムコンポーネントログ、2) コアデバイスのファイルシステム上のユーザー定義 Lambda 関数ログ、3) Amazon CloudWatch Logs 内のシステムコンポーネントログ、および 4) Amazon CloudWatch Logs 内のユーザー定義 Lambda 関数ログの 4 つのログ記録設定を定義します。注: CloudWatch Logs 統合の場合、グループロールは適切なアクセス許可を付与する必要があります。 ``` 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\"}]" ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[AWS IoT Greengrass ログでのモニタリング](https://docs.aws.amazon.com/greengrass/latest/developerguide/greengrass-logs-overview.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateLoggerDefinitionVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-logger-definition-version.html)」を参照してください。 ### `create-logger-definition` 次のコード例は、`create-logger-definition` を使用する方法を示しています。 **AWS CLI** **ロガー定義を作成するには** 次の `create-logger-definition` の例では、初期ロガー定義バージョンを含むロガー定義を作成します。初期バージョンは、1) コアデバイスのファイルシステム上のシステムコンポーネントログ、2) コアデバイスのファイルシステム上のユーザー定義の Lambda 関数ログ、および 3) Amazon CloudWatch Logs のユーザー定義の Lambda 関数ログの 3 つのログ記録設定を定義します。注: CloudWatch Logs 統合の場合、グループロールは適切なアクセス許可を付与する必要があります。 ``` 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\"}]}" ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[AWS IoT Greengrass ログでのモニタリング](https://docs.aws.amazon.com/greengrass/latest/developerguide/greengrass-logs-overview.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateLoggerDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-logger-definition.html)」を参照してください。 ### `create-resource-definition-version` 次のコード例は、`create-resource-definition-version` を使用する方法を示しています。 **AWS CLI** **リソース定義のバージョンを作成するには** 次の `create-resource-definition-version` の例では、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\"}}}]" ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateResourceDefinitionVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-resource-definition-version.html)」を参照してください。 ### `create-resource-definition` 次のコード例は、`create-resource-definition` を使用する方法を示しています。 **AWS CLI** **リソース定義を作成するには** 次の `create-resource-definition` の例では、Greengrass グループで使用するリソースのリストを含むリソース定義を作成します。この例では、リソースのリストを提供することで、リソース定義の初期バージョンが含まれます。このリストには、Twilio 認証トークンのリソースが 1 つと AWS Secrets Manager に保存されているシークレットの ARN が含まれます。リソース定義を作成する前に、シークレットを作成する必要があります。 ``` 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\"}}}]}" ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[AWS コマンドラインインターフェイスを使用してローカルリソースアクセスを設定する方法](https://docs.aws.amazon.com/greengrass/latest/developerguide/lra-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateResourceDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-resource-definition.html)」を参照してください。 ### `create-software-update-job` 次のコード例は、`create-software-update-job` を使用する方法を示しています。 **AWS CLI** **コアのソフトウェア更新ジョブを作成するには** 次の `create-software-update-job` の例では、無線通信 (OTA) 更新ジョブを作成し、名前が `MyFirstGroup_Core` のコアで AWS IoT Greengrass Core ソフトウェアを更新します。このコマンドには、Amazon S3 のソフトウェア更新パッケージへのアクセスを許可し、信頼できるエンティティとして `iot.amazonaws.com` を含む IAM ロールが必要です。 ``` 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 ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[AWS IoT Greengrass コアソフトウェアの OTA 更新](https://docs.aws.amazon.com/greengrass/latest/developerguide/core-ota-update.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateSoftwareUpdateJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-software-update-job.html)」を参照してください。 ### `create-subscription-definition-version` 次のコード例は、`create-subscription-definition-version` を使用する方法を示しています。 **AWS CLI** **サブスクリプションの定義の新しいバージョンを作成するには** 次の `create-subscription-definition-version` の例では、トリガー通知、温度入力、出力ステータスの 3 つのサブスクリプションを含むサブスクリプション定義の新しいバージョンを作成します。 ``` 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\"}]" ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateSubscriptionDefinitionVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-subscription-definition-version.html)」を参照してください。 ### `create-subscription-definition` 次のコード例は、`create-subscription-definition` を使用する方法を示しています。 **AWS CLI** **サブスクリプション定義を作成するには** 次の `create-subscription-definition` の例では、サブスクリプション定義を作成し、その初期バージョンを指定します。初期バージョンには 3 つのサブスクリプションが含まれています。1 つはコネクタがサブスクライブする MQTT トピックのサブスクリプション、もう 1 つは関数が AWS IoT から温度測定値を受信できるようにするサブスクリプション、そして残りの 1 つは AWS IoT がコネクタからステータス情報を受信できるようにするサブスクリプションです。この例では、Lambda の `create-alias` コマンドを使用して以前に作成された Lambda 関数エイリアスの ARN を示します。 ``` 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\"}]}" ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[コネクタの開始方法 (CLI)](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateSubscriptionDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/create-subscription-definition.html)」を参照してください。 ### `delete-connector-definition` 次のコード例は、`delete-connector-definition` を使用する方法を示しています。 **AWS CLI** **コネクタ定義を削除するには** 次の `delete-connector-definition` の例では、指定された Greengrass コネクタ定義を削除します。グループが使用するコネクタ定義を削除すると、そのグループは正常にデプロイされません。 ``` aws greengrass delete-connector-definition \ --connector-definition-id "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8" ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteConnectorDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/delete-connector-definition.html)」を参照してください。 ### `delete-core-definition` 次のコード例は、`delete-core-definition` を使用する方法を示しています。 **AWS CLI** **コア定義を削除するには** 次の `delete-core-definition` の例では、すべてのバージョンを含む、指定された Greengrass コア定義を削除します。Greengrass グループに関連付けられているコアを削除すると、そのグループは正常にデプロイされません。 ``` aws greengrass delete-core-definition \ --core-definition-id "ff36cc5f-9f98-4994-b468-9d9b6dc52abd" ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCoreDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/delete-core-definition.html)」を参照してください。 ### `delete-device-definition` 次のコード例は、`delete-device-definition` を使用する方法を示しています。 **AWS CLI** **デバイス定義を削除するには** 次の `delete-device-definition` の例では、すべてのバージョンを含む、指定されたデバイス定義を削除します。グループバージョンで使用されるデバイス定義バージョンを削除すると、グループバージョンが正常にデプロイされません。 ``` aws greengrass delete-device-definition \ --device-definition-id "f9ba083d-5ad4-4534-9f86-026a45df1ccd" ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDeviceDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/delete-device-definition.html)」を参照してください。 ### `delete-function-definition` 次のコード例は、`delete-function-definition` を使用する方法を示しています。 **AWS CLI** **関数定義を削除するには** 次の `delete-function-definition` の例では、指定された Greengrass 関数定義を削除します。グループが使用する関数定義を削除すると、そのグループは正常にデプロイされません。 ``` aws greengrass delete-function-definition \ --function-definition-id "fd4b906a-dff3-4c1b-96eb-52ebfcfac06a" ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteFunctionDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/delete-function-definition.html)」を参照してください。 ### `delete-group` 次のコード例は、`delete-group` を使用する方法を示しています。 **AWS CLI** **グループを削除するには** 次の `delete-group` の例は、指定された Greengrass グループを削除します。 ``` aws greengrass delete-group \ --group-id "4e22bd92-898c-436b-ade5-434d883ff749" ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/delete-group.html)」を参照してください。 ### `delete-logger-definition` 次のコード例は、`delete-logger-definition` を使用する方法を示しています。 **AWS CLI** **ロガー定義を削除するには** 次の `delete-logger-definition` の例では、すべてのロガー定義バージョンを含む、指定されたロガー定義を削除します。グループバージョンで使用されるロガー定義バージョンを削除すると、グループバージョンは正常にデプロイされません。 ``` aws greengrass delete-logger-definition \ --logger-definition-id "a454b62a-5d56-4ca9-bdc4-8254e1662cb0" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[AWS IoT Greengrass ログでのモニタリング](https://docs.aws.amazon.com/greengrass/latest/developerguide/greengrass-logs-overview.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteLoggerDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/delete-logger-definition.html)」を参照してください。 ### `delete-resource-definition` 次のコード例は、`delete-resource-definition` を使用する方法を示しています。 **AWS CLI** **リソース定義を削除するには** 次の `delete-resource-definition` の例では、すべてのリソースバージョンを含む、指定されたリソース定義を削除します。グループが使用するリソース定義を削除すると、そのグループは正常にデプロイされません。 ``` aws greengrass delete-resource-definition \ --resource-definition-id "ad8c101d-8109-4b0e-b97d-9cc5802ab658" ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteResourceDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/delete-resource-definition.html)」を参照してください。 ### `delete-subscription-definition` 次のコード例は、`delete-subscription-definition` を使用する方法を示しています。 **AWS CLI** **サブスクリプション定義を削除するには** 次の `delete-subscription-definition` の例では、指定された Greengrass サブスクリプション定義を削除します。グループで使用されているサブスクリプションを削除すると、そのグループは正常にデプロイされません。 ``` aws greengrass delete-subscription-definition \ --subscription-definition-id "cd6f1c37-d9a4-4e90-be94-01a7404f5967" ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteSubscriptionDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/delete-subscription-definition.html)」を参照してください。 ### `disassociate-role-from-group` 次のコード例は、`disassociate-role-from-group` を使用する方法を示しています。 **AWS CLI** **Greengrass グループからロールの関連付けを解除するには** 次の `disassociate-role-from-group` の例では、指定された Greengrass グループから IAM ロールの関連付けを解除します。 ``` aws greengrass disassociate-role-from-group \ --group-id 2494ee3f-7f8a-4e92-a78b-d205f808b84b ``` 出力: ``` { "DisassociatedAt": "2019-09-10T20:05:49Z" } ``` グループの詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[グループロールを設定する](https://docs.aws.amazon.com/greengrass/latest/developerguide/config-iam-roles.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateRoleFromGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/disassociate-role-from-group.html)」を参照してください。 ### `disassociate-service-role-from-account` 次のコード例は、`disassociate-service-role-from-account` を使用する方法を示しています。 **AWS CLI** **AWS アカウントからサービスロールの関連付けを解除するには** 次の `disassociate-service-role-from-account` の例では、AWS アカウントに関連付けられているサービスロールを削除します。どの AWS リージョンでもサービスロールを使用していない場合は、`delete-role-policy` コマンドを使用してロールから `AWSGreengrassResourceAccessRolePolicy` マネージドポリシーをデタッチし、`delete-role` コマンドを使用してロールを削除します。 ``` aws greengrass disassociate-service-role-from-account ``` 出力: ``` { "DisassociatedAt": "2019-06-25T22:12:55Z" } ``` 詳細については、「**AWS IoT Greengrass デベロッパーガイド**」の「[Greengrass サービスロール](https://docs.aws.amazon.com/greengrass/latest/developerguide/service-role.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateServiceRoleFromAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/disassociate-service-role-from-account.html)」を参照してください。 ### `get-associated-role` 次のコード例は、`get-associated-role` を使用する方法を示しています。 **AWS CLI** **Greengrass グループに関連付けられたロールを取得するには** 次の `get-associated-role` の例では、指定された Greengrass グループに関連付けられている IAM ロールを取得します。グループロールは、ローカルの Lambda 関数とコネクタが AWS サービスにアクセスするために使用します。 ``` aws greengrass get-associated-role \ --group-id 2494ee3f-7f8a-4e92-a78b-d205f808b84b ``` 出力: ``` { "RoleArn": "arn:aws:iam::123456789012:role/GG-Group-Role", "AssociatedAt": "2019-09-10T20:03:30Z" } ``` グループの詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[グループロールを設定する](https://docs.aws.amazon.com/greengrass/latest/developerguide/config-iam-roles.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAssociatedRole](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-associated-role.html)」を参照してください。 ### `get-bulk-deployment-status` 次のコード例は、`get-bulk-deployment-status` を使用する方法を示しています。 **AWS CLI** **一括デプロイのステータスを確認するには** 次の `get-bulk-deployment-status` の例では、指定された一括デプロイオペレーションのステータス情報を取得します。この例では、デプロイするグループを指定したファイルの入力レコードが無効です。 ``` aws greengrass get-bulk-deployment-status \ --bulk-deployment-id "870fb41b-6288-4e0c-bc76-a7ba4b4d3267" ``` 出力: ``` { "BulkDeploymentMetrics": { "InvalidInputRecords": 1, "RecordsProcessed": 1, "RetryAttempts": 0 }, "BulkDeploymentStatus": "Completed", "CreatedAt": "2019-06-25T16:11:33.265Z", "tags": {} } ``` 詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[グループの一括デプロイを作成する](https://docs.aws.amazon.com/greengrass/latest/developerguide/bulk-deploy-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetBulkDeploymentStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-bulk-deployment-status.html)」を参照してください。 ### `get-connectivity-info` 次のコード例は、`get-connectivity-info` を使用する方法を示しています。 **AWS CLI** **Greengrass コアの接続情報を取得するには** 次の `get-connectivity-info` の例は、デバイスが指定された Greengrass コアへの接続に使用できるエンドポイントを示しています。接続情報は、IP アドレスまたはドメイン名のリストで、対応するポート番号とオプションのカスタマー定義メタデータが含まれます。 ``` aws greengrass get-connectivity-info \ --thing-name "MyGroup_Core" ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetConnectivityInfo](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-connectivity-info.html)」を参照してください。 ### `get-connector-definition-version` 次の例は、`get-connector-definition-version` を使用する方法を説明しています。 **AWS CLI** **コネクタ定義の特定のバージョンに関する情報を取得するには** 次の `get-connector-definition-version` の例では、指定されたコネクタ定義の指定されたバージョンに関する情報を取得します。コネクタ定義のすべてのバージョンの ID を取得するには、`list-connector-definition-versions` コマンドを使用します。コネクタ定義に追加された最新バージョンの ID を取得するには、`get-connector-definition` コマンドを使用して `LatestVersion` プロパティを確認します。 ``` aws greengrass get-connector-definition-version \ --connector-definition-id "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8" \ --connector-definition-version-id "63c57963-c7c2-4a26-a7e2-7bf478ea2623" ``` 出力: ``` { "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" } ``` 詳細については、「**AWS IoT Greengrass デベロッパーガイド**」の「[Greengrass コネクタを使用したサービスおよびプロトコルとの統合](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetConnectorDefinitionVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-connector-definition-version.html)」を参照してください。 ### `get-connector-definition` 次のコード例は、`get-connector-definition` を使用する方法を示しています。 **AWS CLI** **コネクタ定義に関する情報を取得するには** 次の `get-connector-definition` の例では、指定されたコネクタ定義に関する情報を取得します。コネクタ定義の ID を取得するには、`list-connector-definitions` コマンドを使用します。 ``` aws greengrass get-connector-definition \ --connector-definition-id "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8" ``` 出力: ``` { "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": {} } ``` 詳細については、「**AWS IoT Greengrass デベロッパーガイド**」の「[Greengrass コネクタを使用したサービスおよびプロトコルとの統合](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetConnectorDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-connector-definition.html)」を参照してください。 ### `get-core-definition-version` 次のコード例は、`get-core-definition-version` を使用する方法を示しています。 **AWS CLI** **Greengrass コア定義の特定のバージョンに関する詳細を取得するには** 次の `get-core-definition-version` の例では、指定されたコア定義の指定されたバージョンに関する情報を取得します。コア定義のすべてのバージョンの ID を取得するには、`list-core-definition-versions` コマンドを使用します。コア定義に追加された最後のバージョンの ID を取得するには、`get-core-definition` コマンドを使用して `LatestVersion` プロパティを確認します。 ``` aws greengrass get-core-definition-version \ --core-definition-id "c906ed39-a1e3-4822-a981-7b9bd57b4b46" \ --core-definition-version-id "42aeeac3-fd9d-4312-a8fd-ffa9404a20e0" ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetCoreDefinitionVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-core-definition-version.html)」を参照してください。 ### `get-core-definition` 次のコード例は、`get-core-definition` を使用する方法を示しています。 **AWS CLI** **Greengrass コア定義の詳細を取得するには** 次の `get-core-definition` の例は、指定されたコア定義に関する情報を取得します。コア定義の ID を取得するには、`list-core-definitions` コマンドを使用します。 ``` aws greengrass get-core-definition \ --core-definition-id "c906ed39-a1e3-4822-a981-7b9bd57b4b46" ``` 出力: ``` { "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": {} } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetCoreDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-core-definition.html)」を参照してください。 ### `get-deployment-status` 次のコード例は、`get-deployment-status` を使用する方法を示しています。 **AWS CLI** **デプロイのステータスを取得するには** 次の `get-deployment-status` の例では、指定された Greengrass グループの指定されたデプロイのステータスを取得します。デプロイ ID を取得するには、`list-deployments` コマンドを使用してグループ ID を指定します。 ``` aws greengrass get-deployment-status \ --group-id "1013db12-8b58-45ff-acc7-704248f66731" \ --deployment-id "1065b8a0-812b-4f21-9d5d-e89b232a530f" ``` 出力: ``` { "DeploymentStatus": "Success", "DeploymentType": "NewDeployment", "UpdatedAt": "2019-06-18T17:04:44.761Z" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDeploymentStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-deployment-status.html)」を参照してください。 ### `get-device-definition-version` 次のコード例は、`get-device-definition-version` を使用する方法を示しています。 **AWS CLI** **デバイス定義バージョンを取得するには** 次の `get-device-definition-version` 例では、指定されたデバイス定義の指定されたバージョンに関する情報を取得します。デバイス定義のすべてのバージョンの ID を取得するには、 `list-device-definition-versions` コマンドを使用します。デバイス定義に追加された最新バージョンの ID を取得するには、`get-device-definition` コマンドを使用して `LatestVersion` プロパティを確認します。 ``` aws greengrass get-device-definition-version \ --device-definition-id "f9ba083d-5ad4-4534-9f86-026a45df1ccd" \ --device-definition-version-id "83c13984-6fed-447e-84d5-5b8aa45d5f71" ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDeviceDefinitionVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-device-definition-version.html)」を参照してください。 ### `get-device-definition` 次のコード例は、`get-device-definition` を使用する方法を示しています。 **AWS CLI** **デバイス定義を取得するには** 次の `get-device-definition` の例は、指定されたデバイス定義に関する情報を取得します。デバイス定義の ID を取得するには、`list-device-definitions` コマンドを使用します。 ``` aws greengrass get-device-definition \ --device-definition-id "f9ba083d-5ad4-4534-9f86-026a45df1ccd" ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDeviceDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-device-definition.html)」を参照してください。 ### `get-function-definition-version` 次のコード例は、`get-function-definition-version` を使用する方法を示しています。 **AWS CLI** **Lambda 関数の特定のバージョンに関する詳細を取得するには** 次の `get-function-definition-version` は、指定された関数定義の指定されたバージョンに関する情報を取得します。関数定義のすべてのバージョンの ID を取得するには、`list-function-definition-versions` コマンドを使用します。関数定義に追加された最新バージョンの ID を取得するには、`get-function-definition` コマンドを使用して `LatestVersion` プロパティを確認します。 ``` aws greengrass get-function-definition-version \ --function-definition-id "063f5d1a-1dd1-40b4-9b51-56f8993d0f85" \ --function-definition-version-id "9748fda7-1589-4fcc-ac94-f5559e88678b" ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetFunctionDefinitionVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-function-definition-version.html)」を参照してください。 ### `get-function-definition` 次のコード例は、`get-function-definition` を使用する方法を示しています。 **AWS CLI** **関数定義を取得するには** 次の `get-function-definition` の例は、指定された関数定義の詳細情報を表示します。関数定義の ID を取得するには、`list-function-definitions` コマンドを使用します。 ``` aws greengrass get-function-definition \ --function-definition-id "063f5d1a-1dd1-40b4-9b51-56f8993d0f85" ``` 出力: ``` { "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": {} } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetFunctionDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-function-definition.html)」を参照してください。 ### `get-group-certificate-authority` 次のコード例は、`get-group-certificate-authority` を使用する方法を示しています。 **AWS CLI** **Greengrass グループに関連付けられている CA を取得するには** 次の `get-group-certificate-authority` の例では、指定された Greengrass グループに関連付けられている認証局 (CA) を取得します。認証機関 ID を取得するには、`list-group-certificate-authorities` コマンドを使用してグループ ID を指定します。 ``` aws greengrass get-group-certificate-authority \ --group-id "1013db12-8b58-45ff-acc7-704248f66731" \ --certificate-authority-id "f0430e1736ea8ed30cc5d5de9af67a7e3586bad9ae4d89c2a44163f65fdd8cf6" ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetGroupCertificateAuthority](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-group-certificate-authority.html)」を参照してください。 ### `get-group-certificate-configuration` 次のコード例は、`get-group-certificate-configuration` を使用する方法を示しています。 **AWS CLI** **Greengrass グループが使用する認証機関の設定を取得するには** 次の `get-group-certificate-configuration` の例では、指定された Greengrass グループで使用される認証局 (CA) の設定を取得します。 ``` aws greengrass get-group-certificate-configuration \ --group-id "1013db12-8b58-45ff-acc7-704248f66731" ``` 出力: ``` { "CertificateAuthorityExpiryInMilliseconds": 2524607999000, "CertificateExpiryInMilliseconds": 604800000, "GroupId": "1013db12-8b58-45ff-acc7-704248f66731" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetGroupCertificateConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-group-certificate-configuration.html)」を参照してください。 ### `get-group-version` 次のコード例は、`get-group-version` を使用する方法を示しています。 **AWS CLI** **Greengrass グループのバージョンに関する情報を取得するには** 次の `get-group-version` の例は、指定されたグループの指定されたバージョンに関する情報を取得します。グループのすべてのバージョンの ID を取得するには、`list-group-versions` コマンドを使用します。グループに最後に追加されたバージョンの ID を取得するには、`get-group` コマンドを使用して `LatestVersion` プロパティを確認します。 ``` aws greengrass get-group-version \ --group-id "1013db12-8b58-45ff-acc7-704248f66731" \ --group-version-id "115136b3-cfd7-4462-b77f-8741a4b00e5e" ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetGroupVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-group-version.html)」を参照してください。 ### `get-group` 次のコード例は、`get-group` を使用する方法を示しています。 **AWS CLI** **Greengrass グループに関する情報を取得するには** 次の `get-group` の例では、指定された Greengrass グループに関する情報を取得します。グループの ID を取得するには、`list-groups` コマンドを使用します。 ``` aws greengrass get-group \ --group-id "1013db12-8b58-45ff-acc7-704248f66731" ``` 出力: ``` { "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": {} } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-group.html)」を参照してください。 ### `get-logger-definition-version` 次のコード例は、`get-logger-definition-version` を使用する方法を示しています。 **AWS CLI** **ロガー定義バージョンに関する情報を取得するには** 次の `get-logger-definition-version` の例では、指定されたロガー定義の指定されたバージョンに関する情報を取得します。ロガー定義のすべてのバージョンの ID を取得するには、`list-logger-definition-versions` コマンドを使用します。ロガー定義に追加された最新バージョンの ID を取得するには、`get-logger-definition` コマンドを使用して `LatestVersion` プロパティを確認します。 ``` aws greengrass get-logger-definition-version \ --logger-definition-id "49eeeb66-f1d3-4e34-86e3-3617262abf23" \ --logger-definition-version-id "5e3f6f64-a565-491e-8de0-3c0d8e0f2073" ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetLoggerDefinitionVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-logger-definition-version.html)」を参照してください。 ### `get-logger-definition` 次のコード例は、`get-logger-definition` を使用する方法を示しています。 **AWS CLI** **ロガー定義に関する情報を取得するには** 次の `get-logger-definition` の例は、指定されたロガー定義に関する情報を取得します。ロガー定義の ID を取得するには、`list-logger-definitions` コマンドを使用します。 ``` aws greengrass get-logger-definition \ --logger-definition-id "49eeeb66-f1d3-4e34-86e3-3617262abf23" ``` 出力: ``` { "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": {} } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetLoggerDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-logger-definition.html)」を参照してください。 ### `get-resource-definition-version` 次のコード例は、`get-resource-definition-version` を使用する方法を示しています。 **AWS CLI** **リソース定義の特定のバージョンに関する情報を取得するには** 次の `get-resource-definition-version` の例では、指定されたリソース定義の指定されたバージョンに関する情報を取得します。リソース定義のすべてのバージョンの ID を取得するには、`list-resource-definition-versions` コマンドを使用します。リソース定義に追加された最新バージョンの ID を取得するには、`get-resource-definition` コマンドを使用して `LatestVersion` プロパティを確認します。 ``` aws greengrass get-resource-definition-version \ --resource-definition-id "ad8c101d-8109-4b0e-b97d-9cc5802ab658" \ --resource-definition-version-id "26e8829a-491a-464d-9c87-664bf6f6f2be" ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetResourceDefinitionVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-resource-definition-version.html)」を参照してください。 ### `get-resource-definition` 次のコード例は、`get-resource-definition` を使用する方法を示しています。 **AWS CLI** **リソース定義に関する情報を取得するには** 次の `get-resource-definition` の例では、指定されたリソース定義に関する情報を取得します。リソース定義の ID を取得するには、`list-resource-definitions` コマンドを使用します。 ``` aws greengrass get-resource-definition \ --resource-definition-id "ad8c101d-8109-4b0e-b97d-9cc5802ab658" ``` 出力: ``` { "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": {} } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetResourceDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-resource-definition.html)」を参照してください。 ### `get-service-role-for-account` 次のコード例は、`get-service-role-for-account` を使用する方法を示しています。 **AWS CLI** **アカウントにアタッチされているサービスロールの詳細を取得するには** 次の `get-service-role-for-account` の例では、AWS アカウントにアタッチされているサービスロールに関する情報を取得します。 ``` aws greengrass get-service-role-for-account ``` 出力: ``` { "AssociatedAt": "2018-10-18T15:59:20Z", "RoleArn": "arn:aws:iam::123456789012:role/service-role/Greengrass_ServiceRole" } ``` 詳細については、「**AWS IoT Greengrass デベロッパーガイド**」の「[Greengrass サービスロール](https://docs.aws.amazon.com/greengrass/latest/developerguide/service-role.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetServiceRoleForAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-service-role-for-account.html)」を参照してください。 ### `get-subscription-definition-version` 次のコード例は、`get-subscription-definition-version` を使用する方法を示しています。 **AWS CLI** **サブスクリプション定義の特定のバージョンに関する情報を取得するには** 次の `get-subscription-definition-version` の例では、指定されたサブスクリプション定義の指定されたバージョンに関する情報を取得します。サブスクリプション定義のすべてのバージョンの ID を取得するには、`list-subscription-definition-versions` コマンドを使用します。サブスクリプション定義に追加された最新バージョンの ID を取得するには、`get-subscription-definition` コマンドを使用して `LatestVersion` プロパティを確認します。 ``` aws greengrass get-subscription-definition-version \ --subscription-definition-id "70e49321-83d5-45d2-bc09-81f4917ae152" \ --subscription-definition-version-id "88ae8699-12ac-4663-ba3f-4d7f0519140b" ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetSubscriptionDefinitionVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-subscription-definition-version.html)」を参照してください。 ### `get-subscription-definition` 次のコード例は、`get-subscription-definition` を使用する方法を示しています。 **AWS CLI** **サブスクリプション定義に関する情報を取得するには** 次の `get-subscription-definition` の例では、指定されたサブスクリプション定義に関する情報を取得します。サブスクリプション定義の ID を取得するには、`list-subscription-definitions` コマンドを使用します。 ``` aws greengrass get-subscription-definition \ --subscription-definition-id "70e49321-83d5-45d2-bc09-81f4917ae152" ``` 出力: ``` { "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": {} } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetSubscriptionDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-subscription-definition.html)」を参照してください。 ### `get-thing-runtime-configuration` 次のコード例は、`get-thing-runtime-configuration` を使用する方法を示しています。 **AWS CLI** **Greengrass コアのランタイム設定を取得するには** 次の `get-thing-runtime-configuration` の例では、Greengrass コアのランタイム設定を取得します。ランタイム設定を取得する前に、`update-thing-runtime-configuration` コマンドを使用してコアのランタイム設定を作成する必要があります。 ``` aws greengrass get-thing-runtime-configuration \ --thing-name SampleGreengrassCore ``` 出力: ``` { "RuntimeConfiguration": { "TelemetryConfiguration": { "ConfigurationSyncStatus": "OutOfSync", "Telemetry": "On" } } } ``` 詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[テレメトリ設定の設定](https://docs.aws.amazon.com/greengrass/latest/developerguide/telemetry.html#configure-telemetry-settings)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetThingRuntimeConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/get-thing-runtime-configuration.html)」を参照してください。 ### `list-bulk-deployment-detailed-reports` 次のコード例は、`list-bulk-deployment-detailed-reports` を使用する方法を示しています。 **AWS CLI** **一括デプロイの個々のデプロイに関する情報を一覧表示するには** 次の `list-bulk-deployment-detailed-reports` の例では、ステータスを含む、一括デプロイオペレーションの個々のデプロイに関する情報を表示します。 ``` aws greengrass list-bulk-deployment-detailed-reports \ --bulk-deployment-id 42ce9c42-489b-4ed4-b905-8996aa50ef9d ``` 出力: ``` { "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" }, ... ] } ``` 詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[グループの一括デプロイを作成する](https://docs.aws.amazon.com/greengrass/latest/developerguide/bulk-deploy-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListBulkDeploymentDetailedReports](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-bulk-deployment-detailed-reports.html)」を参照してください。 ### `list-bulk-deployments` 次のコード例は、`list-bulk-deployments` を使用する方法を示しています。 **AWS CLI** **一括デプロイを一覧表示するには** 次の `list-bulk-deployments` の例では、すべての一括デプロイを一覧表示します。 ``` aws greengrass list-bulk-deployments ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[グループの一括デプロイを作成する](https://docs.aws.amazon.com/greengrass/latest/developerguide/bulk-deploy-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListBulkDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-bulk-deployments.html)」を参照してください。 ### `list-connector-definition-versions` 次のコード例は、`list-connector-definition-versions` を使用する方法を示しています。 **AWS CLI** **コネクタ定義で使用できるバージョンを一覧表示するには** 次の `list-connector-definition-versions` の例では、指定されたコネクタ定義で使用できるバージョンを一覧表示します。`list-connector-definitions` コマンドを使用して、コネクタ定義 ID を取得します。 ``` aws greengrass list-connector-definition-versions \ --connector-definition-id "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8" ``` 出力: ``` { "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" } ] } ``` 詳細については、「**AWS IoT Greengrass デベロッパーガイド**」の「[Greengrass コネクタを使用したサービスおよびプロトコルとの統合](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListConnectorDefinitionVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-connector-definition-versions.html)」を参照してください。 ### `list-connector-definitions` 次のコード例は、`list-connector-definitions` を使用する方法を示しています。 **AWS CLI** **定義されている Greengrass コネクタを一覧表示するには** 次の `list-connector-definitions` の例では、AWS アカウントに定義されているすべての Greengrass コネクタを一覧表示します。 ``` aws greengrass list-connector-definitions ``` 出力: ``` { "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" } ] } ``` 詳細については、「**AWS IoT Greengrass デベロッパーガイド**」の「[Greengrass コネクタを使用したサービスおよびプロトコルとの統合](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListConnectorDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-connector-definitions.html)」を参照してください。 ### `list-core-definition-versions` 次のコード例は、`list-core-definition-versions` を使用する方法を示しています。 **AWS CLI** **Greengrass コア定義のバージョンを一覧表示するには** 次の `list-core-definitions` の例では、指定された Greengrass コア定義のすべてのバージョンを一覧表示します。`list-core-definitions` コマンドを使用してバージョン ID を取得できます。 ``` aws greengrass list-core-definition-versions \ --core-definition-id "eaf280cb-138c-4d15-af36-6f681a1348f7" ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListCoreDefinitionVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-core-definition-versions.html)」を参照してください。 ### `list-core-definitions` 次のコード例は、`list-core-definitions` を使用する方法を示しています。 **AWS CLI** **Greengrass コア定義を一覧表示するには** 次の `list-core-definitions` の例では、AWS アカウントの Greengrass コア定義をすべて一覧表示します。 ``` aws greengrass list-core-definitions ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListCoreDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-core-definitions.html)」を参照してください。 ### `list-deployments` 次のコード例は、`list-deployments` を使用する方法を示しています。 **AWS CLI** **Greengrass グループのデプロイを一覧表示するには** 次の `list-deployments` の例では、指定された Greengrass グループのデプロイを一覧表示します。`list-groups` コマンドを使用して、グループ ID を検索できます。 ``` aws greengrass list-deployments \ --group-id "1013db12-8b58-45ff-acc7-704248f66731" ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-deployments.html)」を参照してください。 ### `list-device-definition-versions` 次のコード例は、`list-device-definition-versions` を使用する方法を示しています。 **AWS CLI** **デバイス定義のバージョンを一覧表示するには** 次の `list-device-definition-versions` の例では、指定されたデバイス定義に関連付けられたデバイス定義バージョンを表示します。 ``` aws greengrass list-device-definition-versions \ --device-definition-id "f9ba083d-5ad4-4534-9f86-026a45df1ccd" ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDeviceDefinitionVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-device-definition-versions.html)」を参照してください。 ### `list-device-definitions` 次のコード例は、`list-device-definitions` を使用する方法を示しています。 **AWS CLI** **デバイス定義を一覧表示するには** 次の `list-device-definitions` の例では、指定された AWS リージョンの AWS アカウント内のデバイス定義の詳細を表示します。 ``` aws greengrass list-device-definitions \ --region us-west-2 ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDeviceDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-device-definitions.html)」を参照してください。 ### `list-function-definition-versions` 次のコード例は、`list-function-definition-versions` を使用する方法を示しています。 **AWS CLI** **Lambda 関数バージョンを一覧表示するには** 次の `list-function-definition-versions` の例では、指定された Lambda 関数のすべてのバージョンを一覧表示します。`list-function-definitions` コマンドを使用して ID を取得できます。 ``` aws greengrass list-function-definition-versions \ --function-definition-id "063f5d1a-1dd1-40b4-9b51-56f8993d0f85" ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListFunctionDefinitionVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-function-definition-versions.html)」を参照してください。 ### `list-function-definitions` 次のコード例は、`list-function-definitions` を使用する方法を示しています。 **AWS CLI** **Lambda 関数を一覧表示するには** 次の `list-function-definitions` の例では、AWS アカウントに定義されているすべての Lambda 関数を一覧表示します。 ``` aws greengrass list-function-definitions ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListFunctionDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-function-definitions.html)」を参照してください。 ### `list-group-certificate-authorities` 次のコード例は、`list-group-certificate-authorities` を使用する方法を示しています。 **AWS CLI** **グループの現在の CA を一覧表示するには** 次の `list-group-certificate-authorities` の例では、指定された Greengrass グループの現在の認証局 (CA) を一覧表示します。 ``` aws greengrass list-group-certificate-authorities \ --group-id "1013db12-8b58-45ff-acc7-704248f66731" ``` 出力: ``` { "GroupCertificateAuthorities": [ { "GroupCertificateAuthorityArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/certificateauthorities/f0430e1736ea8ed30cc5d5de9af67a7e3586bad9ae4d89c2a44163f65fdd8cf6", "GroupCertificateAuthorityId": "f0430e1736ea8ed30cc5d5de9af67a7e3586bad9ae4d89c2a44163f65fdd8cf6" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListGroupCertificateAuthorities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-group-certificate-authorities.html)」を参照してください。 ### `list-group-versions` 次のコード例は、`list-group-versions` を使用する方法を示しています。 **AWS CLI** **Greengrass グループのバージョンを一覧表示するには** 次の `list-group-versions` の例では、指定された Greengrass のすべてのバージョンを一覧表示します。 ``` aws greengrass list-group-versions \ --group-id "1013db12-8b58-45ff-acc7-704248f66731" ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListGroupVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-group-versions.html)」を参照してください。 ### `list-groups` 次のコード例は、`list-groups` を使用する方法を示しています。 **AWS CLI** **Greengrass グループを一覧表示するには** 次の `list-groups` の例では、AWS アカウントで定義されているすべての Greengrass グループを一覧表示します。 ``` aws greengrass list-groups ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-groups.html)」を参照してください。 ### `list-logger-definition-versions` 次のコード例は、`list-logger-definition-versions` を使用する方法を示しています。 **AWS CLI** **ロガー定義のバージョンのリストを取得するには** 次の `list-logger-definition-versions` の例では、指定されたロガー定義のすべてのバージョンのリストを取得します。 ``` aws greengrass list-logger-definition-versions \ --logger-definition-id "49eeeb66-f1d3-4e34-86e3-3617262abf23" ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListLoggerDefinitionVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-logger-definition-versions.html)」を参照してください。 ### `list-logger-definitions` 次のコード例は、`list-logger-definitions` を使用する方法を示しています。 **AWS CLI** **ロガー定義のリストを取得するには** 次の `list-logger-definitions` の例では、AWS アカウントのすべてのロガー定義を一覧表示します。 ``` aws greengrass list-logger-definitions ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListLoggerDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-logger-definitions.html)」を参照してください。 ### `list-resource-definition-versions` 次のコード例は、`list-resource-definition-versions` を使用する方法を示しています。 **AWS CLI** **リソース定義のバージョンを一覧表示するには** 次の `list-resource-definition-versions` の例では、指定された Greengrass リソースのバージョンを一覧表示します。 ``` aws greengrass list-resource-definition-versions \ --resource-definition-id "ad8c101d-8109-4b0e-b97d-9cc5802ab658" ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListResourceDefinitionVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-resource-definition-versions.html)」を参照してください。 ### `list-resource-definitions` 次のコード例は、`list-resource-definitions` を使用する方法を示しています。 **AWS CLI** **定義されているリソースを一覧表示するには** 次の `list-resource-definitions` の例は、AWS IoT Greengrass が使用するために定義されているリソースを一覧表示します。 ``` aws greengrass list-resource-definitions ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListResourceDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-resource-definitions.html)」を参照してください。 ### `list-subscription-definition-versions` 次のコード例は、`list-subscription-definition-versions` を使用する方法を示しています。 **AWS CLI** **サブスクリプション定義のバージョンを一覧表示するには** 次の `list-subscription-definition-versions` の例では、指定されたサブスクリプションのすべてのバージョンを一覧表示します。`list-subscription-definitions` コマンドを使用して、サブスクリプション ID を検索できます。 ``` aws greengrass list-subscription-definition-versions \ --subscription-definition-id "70e49321-83d5-45d2-bc09-81f4917ae152" ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListSubscriptionDefinitionVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-subscription-definition-versions.html)」を参照してください。 ### `list-subscription-definitions` 次のコード例は、`list-subscription-definitions` を使用する方法を示しています。 **AWS CLI** **サブスクリプション定義のリストを取得するには** 次の `list-subscription-definitions` の例では、AWS アカウントで定義されている AWS IoT Greengrass サブスクリプションをすべて一覧表示します。 ``` aws greengrass list-subscription-definitions ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListSubscriptionDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-subscription-definitions.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **リソースにアタッチされたタグを一覧表示するには** 次の `list-tags-for-resource` の例では、指定されたリソースにアタッチされているタグとその値を一覧表示します。 ``` aws greengrass list-tags-for-resource \ --resource-arn "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/ad8c101d-8109-4b0e-b97d-9cc5802ab658" ``` 出力: ``` { "tags": { "ResourceSubType": "USB", "ResourceType": "Device" } } ``` グループの詳細については、「**AWS IoT Greengrass デベロッパーガイド**」の「[Greengrass リソースのタグ付け](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/list-tags-for-resource.html)」を参照してください。 ### `reset-deployments` 次のコード例は、`reset-deployments` を使用する方法を説明しています。 **AWS CLI** **Greengrass グループのデプロイ情報をクリーンアップするには** 次の `reset-deployments` の例では、指定された Greengrass グループのデプロイ情報をクリーンアップします。`--force option` を追加すると、コアデバイスが応答するのを待たずにデプロイ情報がリセットされます。 ``` aws greengrass reset-deployments \ --group-id "1402daf9-71cf-4cfe-8be0-d5e80526d0d8" \ --force ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[デプロイをリセットする](https://docs.aws.amazon.com/greengrass/latest/developerguide/reset-deployments-scenario.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ResetDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/reset-deployments.html)」を参照してください。 ### `start-bulk-deployment` 次のコード例は、`start-bulk-deployment` を使用する方法を示しています。 **AWS CLI** **一括デプロイオペレーションを開始するには** 次の `start-bulk-deployment` の例では、S3 バケットに保存されているファイルを使用して、デプロイするグループを指定して、一括デプロイオペレーションを開始します。 ``` 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\"}" ``` 出力: ``` { "BulkDeploymentArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/bulk/deployments/870fb41b-6288-4e0c-bc76-a7ba4b4d3267", "BulkDeploymentId": "870fb41b-6288-4e0c-bc76-a7ba4b4d3267" } ``` 詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[グループの一括デプロイを作成する](https://docs.aws.amazon.com/greengrass/latest/developerguide/bulk-deploy-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartBulkDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/start-bulk-deployment.html)」を参照してください。 ### `stop-bulk-deployment` 次のコード例は、`stop-bulk-deployment` を使用する方法を示しています。 **AWS CLI** **一括デプロイを停止するには** 次の `stop-bulk-deployment` の例では、指定された一括デプロイを停止します。完了した一括デプロイを停止しようとすると、次のエラーが表示されます: `InvalidInputException: Cannot change state of finished execution.` ``` aws greengrass stop-bulk-deployment \ --bulk-deployment-id "870fb41b-6288-4e0c-bc76-a7ba4b4d3267" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[グループの一括デプロイを作成する](https://docs.aws.amazon.com/greengrass/latest/developerguide/bulk-deploy-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopBulkDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/stop-bulk-deployment.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **リソースにタグを適用するには** 次の `tag-resource` の例では、指定された Greengrass リソースに `ResourceSubType` タグと `ResourceType` タグを適用します。このオペレーションでは、新しいタグと値を追加したり、既存のタグの値を更新したりできます。タグを削除するには、`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" ``` このコマンドでは何も出力されません。 グループの詳細については、「**AWS IoT Greengrass デベロッパーガイド**」の「[Greengrass リソースのタグ付け](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **リソースからタグとその値を削除するには** 次の `untag-resource` の例では、キーが `Category` のタグを指定された Greengrass グループから削除します。指定されたリソースに `Category` キーが存在しない場合、エラーは返されません。 ``` aws greengrass untag-resource \ --resource-arn "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731" \ --tag-keys "Category" ``` このコマンドでは何も出力されません。 グループの詳細については、「**AWS IoT Greengrass デベロッパーガイド**」の「[Greengrass リソースのタグ付け](https://docs.aws.amazon.com/greengrass/latest/developerguide/tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/untag-resource.html)」を参照してください。 ### `update-connectivity-info` 次のコード例は、`update-connectivity-info` を使用する方法を示しています。 **AWS CLI** **Greengrass コアの接続情報を更新するには** 次の `update-connectivity-info` の例では、デバイスが指定された Greengrass コアへの接続に使用できるエンドポイントを変更します。接続情報は、IP アドレスまたはドメイン名のリストで、対応するポート番号とオプションのカスタマー定義メタデータが含まれます。ローカルネットワークが変更されると、接続情報を更新する必要がある場合があります。 ``` 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\"}]" ``` 出力: ``` { "Version": "312de337-59af-4cf9-a278-2a23bd39c300" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateConnectivityInfo](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/update-connectivity-info.html)」を参照してください。 ### `update-connector-definition` 次のコード例は、`update-connector-definition` を使用する方法を示しています。 **AWS CLI** **コネクタ定義の名前を更新するには** 次の `update-connector-definition` の例では、指定されたコネクタ定義の名前を更新します。コネクタの詳細を更新する場合は、`create-connector-definition-version` コマンドを使用して新しいバージョンを作成します。 ``` aws greengrass update-connector-definition \ --connector-definition-id "55d0052b-0d7d-44d6-b56f-21867215e118" \ --name "GreengrassConnectors2019" ``` 詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[コネクタを使用したサービスおよびプロトコルとの統合](https://docs.aws.amazon.com/greengrass/latest/developerguide/connectors.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateConnectorDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/update-connector-definition.html)」を参照してください。 ### `update-core-definition` 次のコード例は、`update-core-definition` を使用する方法を示しています。 **AWS CLI** **コア定義を更新するには** 次の `update-core-definition` の例では、指定されたコア定義の名前を変更します。更新できるのは、コア定義の `name` プロパティのみです。 ``` aws greengrass update-core-definition \ --core-definition-id "582efe12-b05a-409e-9a24-a2ba1bcc4a12" \ --name "MyCoreDevices" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[AWS IoT Greengrass コアを設定する](https://docs.aws.amazon.com/greengrass/latest/developerguide/gg-core.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateCoreDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/update-core-definition.html)」を参照してください。 ### `update-device-definition` 次のコード例は、`update-device-definition` を使用する方法を示しています。 **AWS CLI** **デバイス定義を更新するには** 次の `update-device-definition` の例では、指定されたデバイス定義の名前を変更します。デバイス定義の `name` プロパティのみを更新できます。 ``` aws greengrass update-device-definition \ --device-definition-id "f9ba083d-5ad4-4534-9f86-026a45df1ccd" \ --name "TemperatureSensors" ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateDeviceDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/update-device-definition.html)」を参照してください。 ### `update-function-definition` 次のコード例は、`update-function-definition` を使用する方法を示しています。 **AWS CLI** **関数定義の名前を更新するには** 次の `update-function-definition` の例では、指定された関数定義の名前を更新します。関数の詳細を更新する場合は、`create-function-definition-version` コマンドを使用して新しいバージョンを作成します。 ``` aws greengrass update-function-definition \ --function-definition-id "e47952bd-dea9-4e2c-a7e1-37bbe8807f46" \ --name ObsoleteFunction ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[ローカル Lambda 関数を実行する](https://docs.aws.amazon.com/greengrass/latest/developerguide/lambda-functions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateFunctionDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/update-function-definition.html)」を参照してください。 ### `update-group-certificate-configuration` 次のコード例は、`update-group-certificate-configuration` を使用する方法を示しています。 **AWS CLI** **グループの証明書の有効期限を更新するには** 次の `update-group-certificate-configuration` の例では、指定されたグループに対して生成された証明書に 10 日間の有効期限を設定します。 ``` aws greengrass update-group-certificate-configuration \ --group-id "8eaadd72-ce4b-4f15-892a-0cc4f3a343f1" \ --certificate-expiry-in-milliseconds 864000000 ``` 出力: ``` { "CertificateExpiryInMilliseconds": 864000000, "CertificateAuthorityExpiryInMilliseconds": 2524607999000, "GroupId": "8eaadd72-ce4b-4f15-892a-0cc4f3a343f1" } ``` グループの詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[AWS IoT Greengrass セキュリティ](https://docs.aws.amazon.com/greengrass/latest/developerguide/gg-sec.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateGroupCertificateConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/update-group-certificate-configuration.html)」を参照してください。 ### `update-group` 次のコード例は、`update-group` を使用する方法を示しています。 **AWS CLI** **グループ名を更新するには** 次の `update-group` の例では、指定された Greengrass グループの名前を更新します。グループの詳細を更新する場合は、`create-group-version` コマンドを使用して新しいバージョンを作成します。 ``` aws greengrass update-group \ --group-id "1402daf9-71cf-4cfe-8be0-d5e80526d0d8" \ --name TestGroup4of6 ``` 詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[AWS IoT にAWS IoT を設定する](https://docs.aws.amazon.com/greengrass/latest/developerguide/gg-config.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/update-group.html)」を参照してください。 ### `update-logger-definition` 次のコード例は、`update-logger-definition` を使用する方法を示しています。 **AWS CLI** **ロガー定義を更新するには** 次の `update-logger-definition` の例では、指定されたロガー定義の名前を変更します。更新できるのは、ロガー定義の `name` プロパティのみです。 ``` aws greengrass update-logger-definition \ --logger-definition-id "a454b62a-5d56-4ca9-bdc4-8254e1662cb0" \ --name "LoggingConfigsForSensors" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[AWS IoT Greengrass ログでのモニタリング](https://docs.aws.amazon.com/greengrass/latest/developerguide/greengrass-logs-overview.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateLoggerDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/update-logger-definition.html)」を参照してください。 ### `update-resource-definition` 次のコード例は、`update-resource-definition` を使用する方法を示しています。 **AWS CLI** **リソース定義の名前を更新するには** 次の `update-resource-definition` の例では、指定されたリソース定義の名前を更新します。リソースの詳細を変更する場合は、`create-resource-definition-version` コマンドを使用して新しいバージョンを作成します。 ``` aws greengrass update-resource-definition \ --resource-definition-id "c8bb9ebc-c3fd-40a4-9c6a-568d75569d38" \ --name GreengrassConnectorResources ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[Lambda 関数とコネクタを使用したローカルリソースへのアクセス](https://docs.aws.amazon.com/greengrass/latest/developerguide/access-local-resources.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateResourceDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/update-resource-definition.html)」を参照してください。 ### `update-subscription-definition` 次のコード例は、`update-subscription-definition` を使用する方法を示しています。 **AWS CLI** **サブスクリプション定義の名前を更新するには** 次の `update-subscription-definition` の例では、指定されたサブスクリプション定義の名前を更新します。サブスクリプションの詳細を変更する場合は、`create-subscription-definition-version` コマンドを使用して新しいバージョンを作成します。 ``` aws greengrass update-subscription-definition \ --subscription-definition-id "fa81bc84-3f59-4377-a84b-5d0134da359b" \ --name "ObsoleteSubscription" ``` このコマンドでは何も出力されません。 詳細については、*ガイド*のタイトルを参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateSubscriptionDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/update-subscription-definition.html)」を参照してください。 ### `update-thing-runtime-configuration` 次のコード例は、`update-thing-runtime-configuration` を使用する方法を示しています。 **AWS CLI** **Greengrass コアのランタイム設定でテレメトリを有効にするには** 次の `update-thing-runtime-configuration` の例では、Greengrass コアのランタイム設定を更新してテレメトリを有効にします。 ``` aws greengrass update-thing-runtime-configuration \ --thing-name SampleGreengrassCore \ --telemetry-configuration {\"Telemetry\":\"On\"} ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Greengrass デベロッパーガイド*」の「[テレメトリ設定の設定](https://docs.aws.amazon.com/greengrass/latest/developerguide/telemetry.html#configure-telemetry-settings)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateThingRuntimeConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrass/update-thing-runtime-configuration.html)」を参照してください。 # AWS IoT Greengrass V2 examples using AWS CLI 次のコード例では、AWS IoT Greengrass V2 で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `associate-service-role-to-account` 次のコード例は、`associate-service-role-to-account` を使用する方法を示しています。 **AWS CLI** **Greengrass サービスロールを AWS アカウントに関連付けるには** 次の `associate-service-role-to-account` の例では、サービスロールを AWS アカウントの AWS IoT Greengrass に関連付けます。 ``` aws greengrassv2 associate-service-role-to-account \ --role-arn arn:aws:iam::123456789012:role/service-role/Greengrass_ServiceRole ``` 出力: ``` { "associatedAt": "2022-01-19T19:21:53Z" } ``` 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[Greengrass サービスロール](https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateServiceRoleToAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/associate-service-role-to-account.html)」を参照してください。 ### `batch-associate-client-device-with-core-device` 次のコード例は、`batch-associate-client-device-with-core-device` を使用する方法を示しています。 **AWS CLI** **クライアントデバイスをコアデバイスと関連付けるには** 次の `batch-associate-client-device-with-core-device` の例では、2 つのクライアントデバイスを 1 つのコアデバイスに関連付けます。 ``` aws greengrassv2 batch-associate-client-device-with-core-device \ --core-device-thing-name MyGreengrassCore \ --entries thingName=MyClientDevice1 thingName=MyClientDevice2 ``` 出力: ``` { "errorEntries": [] } ``` 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[ローカル IoT デバイスとやり取りする](https://docs.aws.amazon.com/greengrass/v2/developerguide/interact-with-local-iot-devices.html)」参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchAssociateClientDeviceWithCoreDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/batch-associate-client-device-with-core-device.html)」を参照してください。 ### `batch-disassociate-client-device-from-core-device` 次のコード例は、`batch-disassociate-client-device-from-core-device` を使用する方法を示しています。 **AWS CLI** **クライアントデバイスのコアデバイスとの関連付けを解除するには** 次の `batch-disassociate-client-device-from-core-device` の例では、2 つのクライアントデバイスをコアデバイスから関連付け解除します。 ``` aws greengrassv2 batch-disassociate-client-device-from-core-device \ --core-device-thing-name MyGreengrassCore \ --entries thingName=MyClientDevice1 thingName=MyClientDevice2 ``` 出力: ``` { "errorEntries": [] } ``` 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[ローカル IoT デバイスとやり取りする](https://docs.aws.amazon.com/greengrass/v2/developerguide/interact-with-local-iot-devices.html)」参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchDisassociateClientDeviceFromCoreDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/batch-disassociate-client-device-from-core-device.html)」を参照してください。 ### `cancel-deployment` 次のコード例は、`cancel-deployment` を使用する方法を示しています。 **AWS CLI** **デプロイをキャンセルするには** 次の `cancel-deployment` の例では、モノのグループへの継続的なデプロイを停止します。 ``` aws greengrassv2 cancel-deployment \ --deployment-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` 出力: ``` { "message": "SUCCESS" } ``` 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[デプロイをキャンセルする](https://docs.aws.amazon.com/greengrass/v2/developerguide/cancel-deployments.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス」*の「[CancelDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/cancel-deployment.html)」を参照してください。 ### `create-component-version` 次のコード例は、`create-component-version` を使用する方法を示しています。 **AWS CLI** **例 1: レシピからコンポーネントバージョンを作成するには** 次の `create-component-version` の例では、レシピファイルから Hello World コンポーネントのバージョンを作成します。 ``` aws greengrassv2 create-component-version \ --inline-recipe fileb://com.example.HelloWorld-1.0.0.json ``` `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}'" } } ] } ``` 出力: ``` { "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": {} } } ``` 詳細については、「*AWSIoT Greengrass V2 デベロッパーガイド*」の「[カスタムコンポーネントを作成する](https://docs.aws.amazon.com/greengrass/v2/developerguide/create-components.html)」および「[デプロイするコンポーネントをアップロードする](https://docs.aws.amazon.com/greengrass/v2/developerguide/upload-components.html)」を参照してください。 **例 2: AWS Lambda 関数からコンポーネントバージョンを作成するには** 次の `create-component-version` の例では、AWS Lambda 関数から Hello World コンポーネントのバージョンを作成します。 ``` aws greengrassv2 create-component-version \ --cli-input-json file://lambda-function-component.json ``` `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" } ] } } } ``` 出力: ``` { "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": {} } } ``` 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[AWS Lambda 関数を実行する](https://docs.aws.amazon.com/greengrass/v2/developerguide/run-lambda-functions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateComponentVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/create-component-version.html)」を参照してください。 ### `create-deployment` 次のコード例は、`create-deployment` を使用する方法を示しています。 **AWS CLI** **例 1: デプロイを作成するには** 次の `create-deployment` の例では、AWS IoT Greengrass コマンドラインインターフェイスをコアデバイスにデプロイします。 ``` aws greengrassv2 create-deployment \ --cli-input-json file://cli-deployment.json ``` `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": {} } ``` 出力: ``` { "deploymentId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } ``` 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[デプロイを作成する](https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html)」を参照してください。 **例 2: コンポーネント設定を更新するデプロイを作成するには** 次の `create-deployment` の例では、AWS IoT Greengrass nucleus コンポーネントをコアデバイスのグループにデプロイします。このデプロイでは、nucleus コンポーネントに対して以下の設定更新が適用されます。 ターゲットデバイスのプロキシ設定をデフォルトのプロキシなし設定にリセットします。ターゲットデバイスの MQTT 設定をデフォルトにリセットします。nucleus の JVM オプションを設定します。nucleus のログ記録レベルを設定します。 ``` aws greengrassv2 create-deployment \ --cli-input-json file://nucleus-deployment.json ``` `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": {} } ``` 出力: ``` { "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" } ``` 詳細は、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[デプロイを作成する](https://docs.aws.amazon.com/greengrass/v2/developerguide/create-deployments.html)」と「[コンポーネント設定を更新する](https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[CreateDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/create-deployment.html)」を参照してください。** ### `delete-component` 次のコード例は、`delete-component` を使用する方法を示しています。 **AWS CLI** **コンポーネントバージョンを削除するには** 次の `delete-component` の例では、Hello World コンポーネントを削除します。 ``` aws greengrassv2 delete-component \ --arn arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.0 ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コンポーネントを管理する](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-components.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteComponent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/delete-component.html)」を参照してください。 ### `delete-core-device` 次のコード例は、`delete-core-device` を使用する方法を示しています。 **AWS CLI** **コアデバイスを削除するには** 次の `delete-core-device` の例では、AWS IoT Greengrass コアデバイスを削除します。 ``` aws greengrassv2 delete-core-device \ --core-device-thing-name MyGreengrassCore ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[AWS IoT Greengrass コアソフトウェアをアンインストールする](https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#uninstall-greengrass-core-v2)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCoreDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/delete-core-device.html)」を参照してください。 ### `describe-component` 次のコード例は、`describe-component` を使用する方法を示しています。 **AWS CLI** **コンポーネントバージョンを記述するには** 次の `describe-component` の例では、Hello World コンポーネントを記述します。 ``` aws greengrassv2 describe-component \ --arn arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld:versions:1.0.0 ``` 出力: ``` { "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" } } ] } ``` 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コンポーネントを管理する](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-components.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeComponent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/describe-component.html)」を参照してください。 ### `disassociate-service-role-from-account` 次のコード例は、`disassociate-service-role-from-account` を使用する方法を示しています。 **AWS CLI** **AWS アカウントから Greengrass サービスロールの関連付けを解除するには** 次の `disassociate-service-role-from-account` の例では、AWS アカウントの Greengrass サービスロールと AWS IoT Greengrass の関連付けを解除します。 ``` aws greengrassv2 disassociate-service-role-from-account ``` 出力: ``` { "disassociatedAt": "2022-01-19T19:26:09Z" } ``` 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[Greengrass サービスロール](https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateServiceRoleFromAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/disassociate-service-role-from-account.html)」を参照してください。 ### `get-component-version-artifact` 次のコード例は、`get-component-version-artifact` を使用する方法を示しています。 **AWS CLI** **コンポーネントアーティファクトをダウンロードする URL を取得するには** 次の `get-component-version-artifact` の例では、ローカルデバッグコンソールコンポーネントの JAR ファイルをダウンロードするための URL を取得します。 ``` 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" ``` 出力: ``` { "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..." } ``` 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コンポーネントを管理する](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-components.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetComponentVersionArtifact](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/get-component-version-artifact.html)」を参照してください。 ### `get-component` 次のコード例は、`get-component` を使用する方法を示しています。 **AWS CLI** **例 1: コンポーネントのレシピを YAML 形式でダウンロードするには (Linux、macOS または Unix)** 次の `get-component` の例では、Hello World コンポーネントのレシピを YAML 形式のファイルにダウンロードします。このコマンドは次のことを行います。 `--output` および `--query` パラメータを使用して、コマンドの出力を制御します。これらのパラメータは、コマンドの出力からレシピ BLOB を抽出します。詳細については、「*AWS コマンドラインインターフェイスユーザーガイド*」の「[コマンド出力の制御](https://docs.aws.amazon.com/cli/latest/userguide/controlling-output.html)」を参照してください。`base64` ユーティリティを使用します。このユーティリティは、抽出された BLOB を元のテキストにデコードします。成功した `get-component` コマンドによって返される BLOB は base64 でエンコードされたテキストです。元のテキストを取得するには、この BLOB をデコードする必要があります。デコードされたテキストを ファイルに保存します。コマンド (`> com.example.HelloWorld-1.0.0.json`) の最後のセクションでは、デコードされたテキストがファイルに保存されます。 ``` 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 ``` 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コンポーネントを管理する](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-components.html)」を参照してください。 **例 2: コンポーネントのレシピを YAML 形式でダウンロードするには (Windows CMD)** 次の `get-component` の例では、Hello World コンポーネントのレシピを YAML 形式のファイルにダウンロードします。このコマンドは `certutil` ユーティリティを使用します。 ``` 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 ``` 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コンポーネントを管理する](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-components.html)」を参照してください。 **例 3: コンポーネントのレシピを YAML 形式でダウンロードするには (Windows PowerShell)** 次の `get-component` の例では、Hello World コンポーネントのレシピを YAML 形式のファイルにダウンロードします。このコマンドは `certutil` ユーティリティを使用します。 ``` 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 ``` 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コンポーネントを管理する](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-components.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetComponent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/get-component.html)」を参照してください。 ### `get-connectivity-info` 次のコード例は、`get-connectivity-info` を使用する方法を示しています。 **AWS CLI** **Greengrass コアデバイスの接続情報を取得するには** 次の `get-connectivity-info` の例では、Greengrass コアデバイスの接続情報を取得します。クライアントデバイスはこの情報を使用して、このコアデバイスで実行される MQTT ブローカーに接続します。 ``` aws greengrassv2 get-connectivity-info \ --thing-name MyGreengrassCore ``` 出力: ``` { "connectivityInfo": [ { "id": "localIP_192.0.2.0", "hostAddress": "192.0.2.0", "portNumber": 8883 } ] } ``` 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コアデバイスエンドポイントを管理する](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-core-device-endpoints.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetConnectivityInfo](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/get-connectivity-info.html)」を参照してください。 ### `get-core-device` 次のコード例は、`get-core-device` を使用する方法を示しています。 **AWS CLI** **コアデバイスを取得するには** 次の `get-core-device` の例では、AWS IoT Greengrass コアデバイスに関する情報を取得します。 ``` aws greengrassv2 get-core-device \ --core-device-thing-name MyGreengrassCore ``` 出力: ``` { "coreDeviceThingName": "MyGreengrassCore", "coreVersion": "2.0.3", "platform": "linux", "architecture": "amd64", "status": "HEALTHY", "lastStatusUpdateTimestamp": "2021-01-08T04:57:58.838000-08:00", "tags": {} } ``` 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コアデバイスのステータスを確認する](https://docs.aws.amazon.com/greengrass/v2/developerguide/device-status.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetCoreDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/get-core-device.html)」を参照してください。 ### `get-deployment` 次のコード例は、`get-deployment` を使用する方法を示しています。 **AWS CLI** **デプロイを取得するには** 次の `get-deployment` の例では、AWS IoT Greengrass nucleus コンポーネントのコアデバイスのグループにデプロイする情報を取得します。 ``` aws greengrassv2 get-deployment \ --deployment-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 ``` 出力: ``` { "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": {} } ``` 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コンポーネントをデバイスにデプロイする](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-deployments.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/get-deployment.html)」を参照してください。 ### `get-service-role-for-account` 次のコード例は、`get-service-role-for-account` を使用する方法を示しています。 **AWS CLI** **AWS アカウントの Greengrass サービスロールを取得するには** 次の `get-service-role-for-account` の例では、AWS アカウントの AWS IoT Greengrass に関連付けられているサービスロールを取得します。 ``` aws greengrassv2 get-service-role-for-account ``` 出力: ``` { "associatedAt": "2022-01-19T19:21:53Z", "roleArn": "arn:aws:iam::123456789012:role/service-role/Greengrass_ServiceRole" } ``` 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[Greengrass サービスロール](https://docs.aws.amazon.com/greengrass/v2/developerguide/greengrass-service-role.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetServiceRoleForAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/get-service-role-for-account.html)」を参照してください。 ### `list-client-devices-associated-with-core-device` 次のコード例は、`list-client-devices-associated-with-core-device` を使用する方法を示しています。 **AWS CLI** **コアデバイスに関連付けられたクライアントデバイスを一覧表示するには** 次の `list-client-devices-associated-with-core-device` の例では、コアデバイスに関連付けられているすべてのクライアントデバイスを一覧表示します。 ``` aws greengrassv2 list-client-devices-associated-with-core-device \ --core-device-thing-name MyTestGreengrassCore ``` 出力: ``` { "associatedClientDevices": [ { "thingName": "MyClientDevice2", "associationTimestamp": "2021-07-12T16:33:55.843000-07:00" }, { "thingName": "MyClientDevice1", "associationTimestamp": "2021-07-12T16:33:55.843000-07:00" } ] } ``` 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[ローカル IoT デバイスとやり取りする](https://docs.aws.amazon.com/greengrass/v2/developerguide/interact-with-local-iot-devices.html)」参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListClientDevicesAssociatedWithCoreDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/list-client-devices-associated-with-core-device.html)」を参照してください。 ### `list-component-versions` 次のコード例は、`list-component-versions` を使用する方法を示しています。 **AWS CLI** **コンポーネントのバージョンを一覧表示するには** 次の `list-component-versions` の例では、Hello World コンポーネントのすべてのバージョンを一覧表示します。 ``` aws greengrassv2 list-component-versions \ --arn arn:aws:greengrass:us-west-2:123456789012:components:com.example.HelloWorld ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コンポーネントを管理する](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-components.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListComponentVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/list-component-versions.html)」を参照してください。 ### `list-components` 次のコード例は、`list-components` を使用する方法を示しています。 **AWS CLI** **コンポーネントを一覧表示するには** 次の `list-components` の例では、現在のリージョンの AWS アカウントで定義されている各コンポーネントとその最新バージョンを一覧表示します。 ``` aws greengrassv2 list-components ``` 出力: ``` { "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" } } ] } } ] } ``` 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コンポーネントを管理する](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-components.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListComponents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/list-components.html)」を参照してください。 ### `list-core-devices` 次のコード例は、`list-core-devices` を使用する方法を示しています。 **AWS CLI** **コアデバイスを一覧表示するには** 次の `list-core-devices` の例は、現在のリージョンの AWS アカウントにある AWS IoT Greengrass コアデバイスを一覧表示します。 ``` aws greengrassv2 list-core-devices ``` 出力: ``` { "coreDevices": [ { "coreDeviceThingName": "MyGreengrassCore", "status": "HEALTHY", "lastStatusUpdateTimestamp": "2021-01-08T04:57:58.838000-08:00" } ] } ``` 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コアデバイスのステータスを確認する](https://docs.aws.amazon.com/greengrass/v2/developerguide/device-status.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListCoreDevices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/list-core-devices.html)」を参照してください。 ### `list-deployments` 次のコード例は、`list-deployments` を使用する方法を示しています。 **AWS CLI** **デプロイを一覧表示するには** 次の `list-deployments` の例では、現在のリージョンの AWS アカウントで定義された各デプロイの最新リビジョンを一覧表示します。 ``` aws greengrassv2 list-deployments ``` 出力: ``` { "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 } ] } ``` 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コンポーネントをデバイスにデプロイする](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-deployments.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/list-deployments.html)」を参照してください。 ### `list-effective-deployments` 次のコード例は、`list-effective-deployments` を使用する方法を示しています。 **AWS CLI** **デプロイジョブを一覧表示するには** 次の `list-effective-deployments` の例では、AWS IoT Greengrass コアデバイスに適用されるデプロイを一覧表示します。 ``` aws greengrassv2 list-effective-deployments \ --core-device-thing-name MyGreengrassCore ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コアデバイスのステータスを確認する](https://docs.aws.amazon.com/greengrass/v2/developerguide/device-status.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListEffectiveDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/list-effective-deployments.html)」を参照してください。 ### `list-installed-components` 次のコード例は、`list-installed-components` を使用する方法を示しています。 **AWS CLI** **コアデバイスにインストールされているコンポーネントを一覧表示するには** 次の `list-installed-components` の例では、AWS IoT Greengrass コアデバイスにインストールされているコンポーネントを一覧表示します。 ``` aws greengrassv2 list-installed-components \ --core-device-thing-name MyGreengrassCore ``` 出力: ``` { "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 } ] } ``` 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コアデバイスのステータスを確認する](https://docs.aws.amazon.com/greengrass/v2/developerguide/device-status.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListInstalledComponents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/list-installed-components.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **リソースのタグを一覧表示するには** 次の `list-tags-for-resource` の例では、AWS IoT Greengrass コアデバイスのすべてのタグを一覧表示します。 ``` aws greengrassv2 list-tags-for-resource \ --resource-arn arn:aws:greengrass:us-west-2:123456789012:coreDevices:MyGreengrassCore ``` 出力: ``` { "tags": { "Owner": "richard-roe" } } ``` 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[リソースのタグ付け](https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/list-tags-for-resource.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **リソースにタグを追加する** 次の `tag-resource` の例では、AWS IoT Greengrass コアデバイスに所有者タグを追加します。このタグを使用して、コアデバイスを所有するユーザーに基づいてコアデバイスへのアクセスを制御できます。 ``` aws greengrassv2 tag-resource \ --resource-arn arn:aws:greengrass:us-west-2:123456789012:coreDevices:MyGreengrassCore \ --tags Owner=richard-roe ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[リソースのタグ付け](https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/tag-resource.html)」を参照してください。 ### `untag-resource` 次の例では、`untag-resource` を使用する方法を説明しています。 **AWS CLI** **リソースからタグを削除するには** 次の `untag-resource` の例では、AWS IoT Greengrass コアデバイスから所有者タグを削除します。 ``` aws iotsitewise untag-resource \ --resource-arn arn:aws:greengrass:us-west-2:123456789012:coreDevices:MyGreengrassCore \ --tag-keys Owner ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[リソースのタグ付け](https://docs.aws.amazon.com/greengrass/v2/developerguide/tag-resources.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/untag-resource.html)」を参照してください。 ### `update-connectivity-info` 次のコード例は、`update-connectivity-info` を使用する方法を示しています。 **AWS CLI** **Greengrass コアデバイスの接続情報を更新するには** 次の `update-connectivity-info` の例では、Greengrass コアデバイスの接続情報を取得します。クライアントデバイスはこの情報を使用して、このコアデバイスで実行される MQTT ブローカーに接続します。 ``` aws greengrassv2 update-connectivity-info \ --thing-name MyGreengrassCore \ --cli-input-json file://core-device-connectivity-info.json ``` `core-device-connectivity-info.json` の内容: ``` { "connectivityInfo": [ { "hostAddress": "192.0.2.0", "portNumber": 8883, "id": "localIP_192.0.2.0" } ] } ``` 出力: ``` { "version": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } ``` 詳細については、「*AWS IoT Greengrass V2 デベロッパーガイド*」の「[コアデバイスエンドポイントを管理する](https://docs.aws.amazon.com/greengrass/v2/developerguide/manage-core-device-endpoints.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateConnectivityInfo](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/greengrassv2/update-connectivity-info.html)」を参照してください。 # AWS IoT ジョブ SDK リリース examples using AWS CLI 次のコード例では、AWS IoT ジョブ SDK リリース で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `describe-job-execution` 次のコード例は、`describe-job-execution` を使用する方法を示しています。 **AWS CLI** **ジョブ実行の詳細を取得するには** 次の `describe-job-execution` の例では、指定されたジョブとモノの最新の実行の詳細を取得します。 ``` aws iot-jobs-data describe-job-execution \ --job-id SampleJob \ --thing-name MotionSensor1 \ --endpoint-url https://1234567890abcd.jobs.iot.us-west-2.amazonaws.com ``` 出力: ``` { "execution": { "approximateSecondsBeforeTimedOut": 88, "executionNumber": 2939653338, "jobId": "SampleJob", "lastUpdatedAt": 1567701875.743, "queuedAt": 1567701902.444, "status": "QUEUED", "thingName": "MotionSensor1 ", "versionNumber": 3 } } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[デバイスとジョブ](https://docs.aws.amazon.com/iot/latest/developerguide/jobs-devices.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeJobExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot-jobs-data/describe-job-execution.html)」を参照してください。 ### `get-pending-job-executions` 次のコード例は、`get-pending-job-executions` を使用する方法を示しています。 **AWS CLI** **モノに対する終了ステータスにないすべてのジョブのリストを取得するには** 次の `get-pending-job-executions` の例では、指定されたモノに対する終了状態にないすべてのジョブのリストを表示します。 ``` aws iot-jobs-data get-pending-job-executions \ --thing-name MotionSensor1 --endpoint-url https://1234567890abcd.jobs.iot.us-west-2.amazonaws.com ``` 出力: ``` { "inProgressJobs": [ ], "queuedJobs": [ { "executionNumber": 2939653338, "jobId": "SampleJob", "lastUpdatedAt": 1567701875.743, "queuedAt": 1567701902.444, "versionNumber": 3 } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[デバイスとジョブ](https://docs.aws.amazon.com/iot/latest/developerguide/jobs-devices.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPendingJobExecutions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot-jobs-data/get-pending-job-executions.html)」を参照してください。 ### `start-next-pending-job-execution` 次のコード例は、`start-next-pending-job-execution` を使用する方法を示しています。 **AWS CLI** **モノに対する保留中の次のジョブ実行を取得して開始するには** 次の `start-next-pending-job-execution` の例では、指定されたモノに対する IN\$1PROGRESS または QUEUED ステータスの次のジョブ実行を取得して開始します。 ``` aws iot-jobs-data start-next-pending-job-execution \ --thing-name MotionSensor1 --endpoint-url https://1234567890abcd.jobs.iot.us-west-2.amazonaws.com ``` 出力: ``` { "execution": { "approximateSecondsBeforeTimedOut": 88, "executionNumber": 2939653338, "jobId": "SampleJob", "lastUpdatedAt": 1567714853.743, "queuedAt": 1567701902.444, "startedAt": 1567714871.690, "status": "IN_PROGRESS", "thingName": "MotionSensor1 ", "versionNumber": 3 } } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[デバイスとジョブ](https://docs.aws.amazon.com/iot/latest/developerguide/jobs-devices.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartNextPendingJobExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot-jobs-data/start-next-pending-job-execution.html)」を参照してください。 ### `update-job-execution` 次のコード例は、`update-job-execution` を使用する方法を示しています。 **AWS CLI** **ジョブ実行のステータスを更新するには** 次の `update-job-execution` の例では、指定されたジョブとモノのステータスを更新します。 ``` 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 ``` 出力: ``` { "executionState": { "status": "REMOVED", "versionNumber": 3 }, } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[デバイスとジョブ](https://docs.aws.amazon.com/iot/latest/developerguide/jobs-devices.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateJobExecution](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iot-jobs-data/update-job-execution.html)」を参照してください。 # AWS IoT SiteWise examples using AWS CLI 次のコード例では、AWS IoT SiteWise で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `associate-assets` 次のコード例は、`associate-assets` を使用する方法を示しています。 **AWS CLI** **子アセットを親アセットに関連付けるには** 次の `associate-assets` の例では、風力タービンアセットを風力発電所アセットに関連付けます。風力タービンアセットモデルは、風力発電所アセットモデルに階層として存在します。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Associating assets](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/add-associated-assets.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/associate-assets.html)」を参照してください。 ### `batch-associate-project-assets` 次のコード例は、`batch-associate-project-assets` を使用する方法を示しています。 **AWS CLI** **アセットをプロジェクトに関連付けるには** 次の `batch-associate-project-assets` の例では、風力発電所アセットをプロジェクトに関連付けます。 ``` aws iotsitewise batch-associate-project-assets \ --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE \ --asset-ids a1b2c3d4-5678-90ab-cdef-44444EXAMPLE ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT SiteWise Monitor アプリケーションガイド*」の「[Adding assets to projects](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/add-assets-to-projects-sd.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchAssociateProjectAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/batch-associate-project-assets.html)」を参照してください。 ### `batch-disassociate-project-assets` 次のコード例は、`batch-disassociate-project-assets` を使用する方法を示しています。 **AWS CLI** **プロジェクトからアセットの関連付けを解除するには** 次の `batch-disassociate-project-assets` の例では、プロジェクトから風力発電所アセットの関連付けを解除します。 ``` aws iotsitewise batch-disassociate-project-assets \ --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE \ --asset-ids a1b2c3d4-5678-90ab-cdef-44444EXAMPLE ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT SiteWise Monitor アプリケーションガイド*」の「[Adding assets to projects](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/add-assets-to-projects-sd.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchDisassociateProjectAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/batch-disassociate-project-assets.html)」を参照してください。 ### `batch-put-asset-property-value` 次のコード例は、`batch-put-asset-property-value` を使用する方法を示しています。 **AWS CLI** **アセットプロパティにデータを送信するには** 次の `batch-put-asset-property-value` の例では、プロパティエイリアスによって識別されるアセットプロパティに電力と温度のデータを送信します。 ``` aws iotsitewise batch-put-asset-property-value \ --cli-input-json file://batch-put-asset-property-value.json ``` `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 } } ] } ] } ``` 出力: ``` { "errorEntries": [] } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Ingesting data using the AWS IoT SiteWise API](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/ingest-api.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchPutAssetPropertyValue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/batch-put-asset-property-value.html)」を参照してください。 ### `create-access-policy` 次のコード例は、`create-access-policy` を使用する方法を示しています。 **AWS CLI** **例 1: ポータルへのユーザー管理アクセスを許可するには** 次の `create-access-policy` の例では、風力発電所会社のウェブポータルへの管理者アクセス権をユーザーに付与するアクセスポリシーを作成します。 ``` aws iotsitewise create-access-policy \ --cli-input-json file://create-portal-administrator-access-policy.json ``` `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" } } } ``` 出力: ``` { "accessPolicyId": "a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE", "accessPolicyArn": "arn:aws:iotsitewise:us-west-2:123456789012:access-policy/a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE" } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Adding or removing portal administrators](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins)」を参照してください。 **例 2: プロジェクトへの読み取り専用アクセス権をユーザーに付与するには** 次の `create-access-policy` の例では、風力発電所プロジェクトへの読み取り専用アクセス権をユーザーに付与するアクセスポリシーを作成します。 ``` aws iotsitewise create-access-policy \ --cli-input-json file://create-project-viewer-access-policy.json ``` `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" } } } ``` 出力: ``` { "accessPolicyId": "a1b2c3d4-5678-90ab-cdef-dddddEXAMPLE", "accessPolicyArn": "arn:aws:iotsitewise:us-west-2:123456789012:access-policy/a1b2c3d4-5678-90ab-cdef-dddddEXAMPLE" } ``` 詳細については、「*AWS SiteWise Monitor アプリケーションガイド*」の「[Assigning project viewers](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/assign-project-viewers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-access-policy.html)」を参照してください。 ### `create-asset-model` 次のコード例は、`create-asset-model` を使用する方法を示しています。 **AWS CLI** **アセットモデルを作成するには** 次の `create-asset-model` の例では、次のプロパティを使用して風力タービンを定義するアセットモデルを作成します。 シリアル番号 - 風力タービンのシリアル番号 発電電力 - 風力タービンからの発電電力のデータストリーム 温度 C - 風力タービンからの温度のデータストリーム (摂氏) 温度 F - 摂氏から華氏にマップされた温度のデータポイント ``` aws iotsitewise create-asset-model \ --cli-input-json file://create-wind-turbine-model.json ``` `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" } } } } } ] } ``` 出力: ``` { "assetModelId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "assetModelArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", "assetModelStatus": { "state": "CREATING" } } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Defining asset models](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/define-models.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateAssetModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-asset-model.html)」を参照してください。 ### `create-asset` 次のコード例は、`create-asset` を使用する方法を示しています。 **AWS CLI** **アセットを作成するには** 次の `create-asset` の例では、風力タービンアセットモデルから風力タービンアセットを作成します。 ``` aws iotsitewise create-asset \ --asset-model-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ --asset-name "Wind Turbine 1" ``` 出力: ``` { "assetId": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", "assetArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", "assetStatus": { "state": "CREATING" } } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Creating assets](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-assets.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-asset.html)」を参照してください。 ### `create-dashboard` 次のコード例は、`create-dashboard` を使用する方法を示しています。 **AWS CLI** **ダッシュボードを作成するには** 次の `create-dashboard` の例では、風力発電所の総発電電力が表示される折れ線グラフを含むダッシュボードを作成します。 ``` aws iotsitewise create-dashboard \ --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE \ --dashboard-name "Wind Farm" \ --dashboard-definition file://create-wind-farm-dashboard.json ``` `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" } ] } ] } ``` 出力: ``` { "dashboardId": "a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE", "dashboardArn": "arn:aws:iotsitewise:us-west-2:123456789012:dashboard/a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE" } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Creating dashboards (CLI)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDashboard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-dashboard.html)」を参照してください。 ### `create-gateway` 次のコード例は、`create-gateway` を使用する方法を示しています。 **AWS CLI** **ゲートウェイを作成するには** 次の `create-gateway` の例では、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} ``` 出力: ``` { "gatewayId": "a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE", "gatewayArn": "arn:aws:iotsitewise:us-west-2:123456789012:gateway/a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE" } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Configuring a gateway](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-gateway.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-gateway.html)」を参照してください。 ### `create-portal` 次のコード例は、`create-portal` を使用する方法を示しています。 **AWS CLI** **ポータルを作成するには** 次の `create-portal` の例では、風力発電所会社のウェブポータルを作成します。ポータルは、AWS Single Sign-On が有効になっている同じリージョンにのみ作成できます。 ``` 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 ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Getting started with AWS IoT SiteWise Monitor](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-getting-started.html)」および「*AWS SiteWise ユーザーガイド*」の「[Enabling AWS SSO](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-getting-started.html#monitor-enable-sso)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreatePortal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-portal.html)」を参照してください。 ### `create-project` 次のコード例は、`create-project` を使用する方法を示しています。 **AWS CLI** **プロジェクトを作成するには** 次の `create-project` の例では、風力発電所プロジェクトを作成します。 ``` 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." ``` 出力: ``` { "projectId": "a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE", "projectArn": "arn:aws:iotsitewise:us-west-2:123456789012:project/a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE" } ``` 詳細については、「*AWS IoT SiteWise Monitor アプリケーションガイド*」の「[Creating projects](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/create-projects.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[CreateProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/create-project.html)」を参照してください。** ### `delete-access-policy` 次のコード例は、`delete-access-policy` を使用する方法を示しています。 **AWS CLI** **プロジェクトまたはポータルへのユーザーのアクセス権を取り消すには** 次の `delete-access-policy` の例では、ポータルへの管理者アクセス権をユーザーに付与するアクセスポリシーを削除します。 ``` aws iotsitewise delete-access-policy \ --access-policy-id a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Adding or removing portal administrators](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-access-policy.html)」を参照してください。 ### `delete-asset-model` 次のコード例は、`delete-asset-model` を使用する方法を示しています。 **AWS CLI** **アセットモデルを削除するには** 次の `delete-asset-model` の例では、風力タービンアセットモデルを削除します。 ``` aws iotsitewise delete-asset-model \ --asset-model-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE ``` 出力: ``` { "assetModelStatus": { "state": "DELETING" } } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Deleting asset models](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html#delete-asset-models)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAssetModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-asset-model.html)」を参照してください。 ### `delete-asset` 次のコード例は、`delete-asset` を使用する方法を示しています。 **AWS CLI** **アセットを削除するには** 次の `delete-asset` の例では、風力タービンアセットを削除します。 ``` aws iotsitewise delete-asset \ --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE ``` 出力: ``` { "assetStatus": { "state": "DELETING" } } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Deleting assets](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/delete-assets-and-models.html#delete-assets)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-asset.html)」を参照してください。 ### `delete-dashboard` 次のコード例は、`delete-dashboard` を使用する方法を示しています。 **AWS CLI** **ダッシュボードを削除するには** 次の `delete-dashboard` の例では、風力タービンダッシュボードを削除します。 ``` aws iotsitewise delete-dashboard \ --dashboard-id a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT SiteWise Monitor アプリケーションガイド*」の「[ダッシュボードの削除](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/delete-dashboards.html)を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDashboard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-dashboard.html)」を参照してください。 ### `delete-gateway` 次のコード例は、`delete-gateway` を使用する方法を示しています。 **AWS CLI** **ゲートウェイを削除するには** 次の `delete-gateway` の例では、ゲートウェイを削除します。 ``` aws iotsitewise delete-gateway \ --gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Ingesting data using a gateway](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-gateway.html)」を参照してください。 ### `delete-portal` 次のコード例は、`delete-portal` を使用する方法を示しています。 **AWS CLI** **ポータルを削除するには** 次の `delete-portal` の例では、風力発電所会社のウェブポータルを削除します。 ``` aws iotsitewise delete-portal \ --portal-id a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE ``` 出力: ``` { "portalStatus": { "state": "DELETING" } } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Deleting a portal](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-delete-portal)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeletePortal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-portal.html)」を参照してください。 ### `delete-project` 次のコード例は、`delete-project` を使用する方法を示しています。 **AWS CLI** **プロジェクトを削除するには** 次の `delete-project` の例では、風力発電所プロジェクトを削除します。 ``` aws iotsitewise delete-project \ --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT SiteWise Monitor アプリケーションガイド*」の「[Deleting projects](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/delete-projects.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/delete-project.html)」を参照してください。 ### `describe-access-policy` 次のコード例は、`describe-access-policy` を使用する方法を示しています。 **AWS CLI** **アクセスポリシーの説明を表示するには** 次の `describe-access-policy` の例では、風力発電所会社のウェブポータルへの管理者アクセス権をユーザーに付与するアクセスポリシーの説明を表示します。 ``` aws iotsitewise describe-access-policy \ --access-policy-id a1b2c3d4-5678-90ab-cdef-cccccEXAMPLE ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Adding or removing portal administrators](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html#portal-change-admins)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-access-policy.html)」を参照してください。 ### `describe-asset-model` 次のコード例は、`describe-asset-model` を使用する方法を示しています。 **AWS CLI** **アセットモデルの説明を表示するには** 次の `describe-asset-model` の例では、風力発電所アセットモデルの説明を表示します。 ``` aws iotsitewise describe-asset-model \ --asset-model-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Describing a specific asset model](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#describe-asset-model)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAssetModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-asset-model.html)」を参照してください。 ### `describe-asset-property` 次のコード例は、`describe-asset-property` を使用する方法を示しています。 **AWS CLI** **アセットプロパティの説明を表示するには** 次の `describe-asset-property` の例では、風力発電所アセットの総発電電力プロパティの説明を表示します。 ``` aws iotsitewise describe-asset-property \ --asset-id a1b2c3d4-5678-90ab-cdef-44444EXAMPLE \ --property-id a1b2c3d4-5678-90ab-cdef-99999EXAMPLE ``` 出力: ``` { "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" } } } } } } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Describing a specific asset property](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#describe-asset-property)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAssetProperty](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-asset-property.html)」を参照してください。 ### `describe-asset` 次のコード例は、`describe-asset` を使用する方法を示しています。 **AWS CLI** **アセットの説明を表示するには** 次の `describe-asset` の例では、風力発電所アセットの説明を表示します。 ``` aws iotsitewise describe-asset \ --asset-id a1b2c3d4-5678-90ab-cdef-44444EXAMPLE ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Describing a specific asset](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#describe-asset)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-asset.html)」を参照してください。 ### `describe-dashboard` 次のコード例は、`describe-dashboard` を使用する方法を示しています。 **AWS CLI** **ダッシュボードの説明を表示するには** 次の `describe-dashboard` の例では、指定された風力発電所ダッシュボードの説明を表示します。 ``` aws iotsitewise describe-dashboard \ --dashboard-id a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT SiteWise Monitor アプリケーションガイド*」の「[ダッシュボードの表示](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/view-dashboards.html)を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDashboard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-dashboard.html)」を参照してください。 ### `describe-gateway-capability-configuration` 次のコード例は、`describe-gateway-capability-configuration` を使用する方法を示しています。 **AWS CLI** **ゲートウェイ機能の説明を表示するには** 次の `describe-gateway-capability-configuration` の例では、OPC-UA ソース機能の説明を表示します。 ``` aws iotsitewise describe-gateway-capability-configuration \ --gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE \ --capability-namespace "iotsitewise:opcuacollector:1" ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Configuring data sources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeGatewayCapabilityConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-gateway-capability-configuration.html)」を参照してください。 ### `describe-gateway` 次のコード例は、`describe-gateway` を使用する方法を示しています。 **AWS CLI** **ゲートウェイの説明を表示するには** 次の `describe-gateway` の例では、ゲートウェイの説明を表示します。 ``` aws iotsitewise describe-gateway \ --gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE ``` 出力: ``` { "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 } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Ingesting data using a gateway](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-gateway.html)」を参照してください。 ### `describe-logging-options` 次のコード例は、`describe-logging-options` を使用する方法を示しています。 **AWS CLI** **現在の AWS IoT SiteWise ログ記録オプションを取得するには** 次の `describe-logging-options` の例では、現在のリージョンにおける AWS アカウントの現在の AWS IoT SiteWise ログ記録オプションを取得します。 ``` aws iotsitewise describe-logging-options ``` 出力: ``` { "loggingOptions": { "level": "INFO" } } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Monitoring AWS IoT SiteWise with Amazon CloudWatch Logs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-cloudwatch-logs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeLoggingOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-logging-options.html)」を参照してください。 ### `describe-portal` 次のコード例は、`describe-portal` を使用する方法を示しています。 **AWS CLI** **ポータルの説明を表示するには** 次の `describe-portal` の例では、風力発電所会社のウェブポータルの説明を表示します。 ``` aws iotsitewise describe-portal \ --portal-id a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Administering your portals](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribePortal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-portal.html)」を参照してください。 ### `describe-project` 次のコード例は、`describe-project` を使用する方法を示しています。 **AWS CLI** **プロジェクトの説明を表示するには** 次の `describe-project` の例では、風力発電所プロジェクトの説明を表示します。 ``` aws iotsitewise describe-project \ --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT SiteWise Monitor アプリケーションガイド*」の「[プロジェクト詳細の表示](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/view-project-details.html)を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/describe-project.html)」を参照してください。 ### `disassociate-assets` 次のコード例は、`disassociate-assets` を使用する方法を示しています。 **AWS CLI** **親アセットから子アセットの関連付けを解除するには** 次の `disassociate-assets` の例では、風力発電所アセットから風力タービンアセットの関連付けを解除します。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Associating assets](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/add-associated-assets.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/disassociate-assets.html)」を参照してください。 ### `get-asset-property-aggregates` 次のコード例は、`get-asset-property-aggregates` を使用する方法を示しています。 **AWS CLI** **アセットプロパティの集計された平均とカウントの値を取得するには** 次の `get-asset-property-aggregates` の例では、風力タービンアセットの 1 時間の平均総電力と総電力データポイント数を取得します。 ``` 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 ``` 出力: ``` { "aggregatedValues": [ { "timestamp": 1580850000.0, "quality": "GOOD", "value": { "average": 8723.46538886233, "count": 12.0 } } ] } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Querying asset property aggregates](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#aggregates)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAssetPropertyAggregates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/get-asset-property-aggregates.html)」を参照してください。 ### `get-asset-property-value-history` 次のコード例は、`get-asset-property-value-history` を使用する方法を示しています。 **AWS CLI** **アセットプロパティの過去の値を取得するには** 次の `get-asset-property-value-history` の例では、風力タービンアセットの 20 分間の総電力値を取得します。 ``` 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 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[履歴アセットプロパティ値をクエリする](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#historical-values)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAssetPropertyValueHistory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/get-asset-property-value-history.html)」を参照してください。 ### `get-asset-property-value` 次のコード例は、`get-asset-property-value` を使用する方法を示しています。 **AWS CLI** **アセットプロパティの現在の値を取得するには** 次の `get-asset-property-value` の例では、風力タービンアセットの現在の総電力を取得します。 ``` aws iotsitewise get-asset-property-value \ --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \ --property-id a1b2c3d4-5678-90ab-cdef-66666EXAMPLE ``` 出力: ``` { "propertyValue": { "value": { "doubleValue": 6890.8677520453875 }, "timestamp": { "timeInSeconds": 1580853000, "offsetInNanos": 0 }, "quality": "GOOD" } } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[現在のアセットプロパティ値をクエリする](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/query-industrial-data.html#current-values)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAssetPropertyValue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/get-asset-property-value.html)」を参照してください。 ### `list-access-policies` 次のコード例は、`list-access-policies` を使用する方法を示しています。 **AWS CLI** **すべてのアクセスポリシーを一覧表示するには** 次の `list-access-policies` の例では、ポータル管理者であるユーザーのすべてのアクセスポリシーを一覧表示します。 ``` aws iotsitewise list-access-policies \ --identity-type USER \ --identity-id a1b2c3d4e5-a1b2c3d4-5678-90ab-cdef-bbbbbEXAMPLE ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Administering your portals](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAccessPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-access-policies.html)」を参照してください。 ### `list-asset-models` 次のコード例は、`list-asset-models` を使用する方法を示しています。 **AWS CLI** **すべてのアセットモデルを一覧表示するには** 次の `list-asset-models` の例では、現在のリージョンの AWS アカウントで定義されているすべてのアセットモデルを一覧表示します。 ``` aws iotsitewise list-asset-models ``` 出力: ``` { "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" } } ] } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[すべてのアセットモデルのリスト表示](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#list-asset-models)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAssetModels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-asset-models.html)」を参照してください。 ### `list-assets` 次のコード例は、`list-assets` を使用する方法を示しています。 **AWS CLI** **例 1: すべての最上位アセットを一覧表示するには** 次の `list-assets` の例では、アセット階層ツリーの最上位にあり、現在のリージョンの AWS アカウントで定義されているすべてのアセットを一覧表示します。 ``` aws iotsitewise list-assets \ --filter TOP_LEVEL ``` 出力: ``` { "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" } ] } ] } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[アセットのリスト表示](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#list-assets)」を参照してください。 **例 2: アセットモデルに基づくすべてのアセットを一覧表示するには** 次の `list-assets` の例では、アセットモデルに基づき、現在のリージョンの AWS アカウントで定義されているすべてのアセットを一覧表示します。 ``` aws iotsitewise list-assets \ --asset-model-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE ``` 出力: ``` { "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": [] } ] } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[アセットのリスト表示](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#list-assets)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-assets.html)」を参照してください。 ### `list-associated-assets` 次のコード例は、`list-associated-assets` を使用する方法を示しています。 **AWS CLI** **特定のアセットに関連付けられているすべてのアセットを一覧表示するには** 次の `list-associated-assets` の例では、指定された風力発電所アセットに関連付けられているすべての風力タービンアセットを一覧表示します。 ``` aws iotsitewise list-associated-assets \ --asset-id a1b2c3d4-5678-90ab-cdef-44444EXAMPLE \ --hierarchy-id a1b2c3d4-5678-90ab-cdef-77777EXAMPLE ``` 出力: ``` { "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": [] } ] } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[特定のアセットに関連付けられているアセットのリスト表示](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/discover-asset-resources.html#list-associated-assets)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAssociatedAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-associated-assets.html)」を参照してください。 ### `list-dashboards` 次のコード例は、`list-dashboards` を使用する方法を示しています。 **AWS CLI** **プロジェクト内のすべてのダッシュボードを一覧表示するには** 次の `list-dashboards` の例では、プロジェクトで定義されているすべてのダッシュボードを一覧表示します。 ``` aws iotsitewise list-dashboards \ --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE ``` 出力: ``` { "dashboardSummaries": [ { "id": "a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE", "name": "Wind Farm", "creationDate": "2020-05-01T20:32:12.228476348Z", "lastUpdateDate": "2020-05-01T20:32:12.228476348Z" } ] } ``` 詳細については、「*AWS IoT SiteWise Monitor アプリケーションガイド*」の「[ダッシュボードの表示](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/view-dashboards.html)を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDashboards](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-dashboards.html)」を参照してください。 ### `list-gateways` 次のコード例は、`list-gateways` を使用する方法を示しています。 **AWS CLI** **すべてのゲートウェイを一覧表示するには** 次の `list-gateways` の例では、現在のリージョンの AWS アカウントで定義されているすべてのゲートウェイを一覧表示します。 ``` aws iotsitewise list-gateways ``` 出力: ``` { "gatewaySummaries": [ { "gatewayId": "a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE", "gatewayName": "ExampleCorpGateway", "gatewayCapabilitySummaries": [ { "capabilityNamespace": "iotsitewise:opcuacollector:1", "capabilitySyncStatus": "IN_SYNC" } ], "creationDate": 1588369971.457, "lastUpdateDate": 1588369971.457 } ] } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Ingesting data using a gateway](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-gateways.html)」を参照してください。 ### `list-portals` 次のコード例は、`list-portals` を使用する方法を示しています。 **AWS CLI** **すべてのポータルを一覧表示するには** 次の `list-portals` の例では、現在のリージョンの AWS アカウントで定義されているすべてのポータルを一覧表示します。 ``` aws iotsitewise list-portals ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Administering your portals](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPortals](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-portals.html)」を参照してください。 ### `list-project-assets` 次のコード例は、`list-project-assets` を使用する方法を示しています。 **AWS CLI** **プロジェクトに関連付けられているすべてのアセットを一覧表示するには** 次の `list-project-assets` の例では、風力発電所プロジェクトに関連付けられているすべてのアセットを一覧表示します。 ``` aws iotsitewise list-projects \ --project-id a1b2c3d4-5678-90ab-cdef-eeeeeEXAMPLE ``` 出力: ``` { "assetIds": [ "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE" ] } ``` 詳細については、「*AWS IoT SiteWise Monitor アプリケーションガイド*」の「[Adding assets to projects](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/add-assets-to-projects-sd.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListProjectAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-project-assets.html)」を参照してください。 ### `list-projects` 次のコード例は、`list-projects` を使用する方法を示しています。 **AWS CLI** **ポータル内のすべてのプロジェクトを一覧表示するには** 次の `list-projects` の例では、ポータルで定義されているすべてのプロジェクトを一覧表示します。 ``` aws iotsitewise list-projects \ --portal-id a1b2c3d4-5678-90ab-cdef-aaaaaEXAMPLE ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IoT SiteWise Monitor アプリケーションガイド*」の「[プロジェクト詳細の表示](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/view-project-details.html)を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListProjects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-projects.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **リソースのすべてのタグを一覧表示するには** 次の `list-tags-for-resource` の例では、風力タービンアセットのすべてのタグを一覧表示します。 ``` aws iotsitewise list-tags-for-resource \ --resource-arn arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE ``` 出力: ``` { "tags": { "Owner": "richard-roe" } } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[リソースへのタグ付け](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/list-tags-for-resource.html)」を参照してください。 ### `put-logging-options` 次のコード例は、`put-logging-options` を使用する方法を示しています。 **AWS CLI** **ログ記録のレベルを指定するには** 次の `put-logging-options` の例では、AWS IoT SiteWise で `INFO` レベルのログ記録を有効にします。その他のレベルには、`DEBUG` と `OFF` があります。 ``` aws iotsitewise put-logging-options \ --logging-options level=INFO ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Monitoring AWS IoT SiteWise with Amazon CloudWatch Logs](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/monitor-cloudwatch-logs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutLoggingOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/put-logging-options.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **リソースにタグを追加する** 次の `tag-resource` の例では、風力タービンアセットに所有者タグを追加します。これにより、アセットの所有者に基づいてアセットへのアクセスを制御できます。 ``` aws iotsitewise tag-resource \ --resource-arn arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \ --tags Owner=richard-roe ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[リソースへのタグ付け](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/tag-resource.html)」を参照してください。 ### `untag-resource` 次の例では、`untag-resource` を使用する方法を説明しています。 **AWS CLI** **リソースからタグを削除するには** 次の `untag-resource` の例では、風力タービンアセットから所有者タグを削除します。 ``` aws iotsitewise untag-resource \ --resource-arn arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \ --tag-keys Owner ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[リソースへのタグ付け](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/untag-resource.html)」を参照してください。 ### `update-access-policy` 次のコード例は、`update-access-policy` を使用する方法を示しています。 **AWS CLI** **プロジェクトビューワーにプロジェクトの所有権を付与するには** 次の `update-access-policy` の例では、プロジェクトビューワーにプロジェクトの所有権を付与するアクセスポリシーを更新します。 ``` aws iotsitewise update-access-policy \ --access-policy-id a1b2c3d4-5678-90ab-cdef-dddddEXAMPLE \ --cli-input-json file://update-project-viewer-access-policy.json ``` `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" } } } ``` このコマンドでは何も出力されません。 詳細については、「*AWS SiteWise Monitor アプリケーションガイド*」の「[プロジェクトの所有者を割り当てる](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/assign-project-owners.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateAccessPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-access-policy.html)」を参照してください。 ### `update-asset-model` 次のコード例は、`update-asset-model` を使用する方法を示しています。 **AWS CLI** **アセットモデルを更新するには** 次の `update-asset-model` の例では、風力発電所アセットモデルの説明を更新します。`update-asset-model` は既存のモデルを新しいモデルで上書きするため、この例にはモデルの既存の ID と定義が含まれています。 ``` aws iotsitewise update-asset-model \ --cli-input-json file://update-wind-farm-model.json ``` `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" } ] } ``` 出力: ``` { "assetModelId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "assetModelArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset-model/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", "assetModelStatus": { "state": "CREATING" } } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[アセットモデルの更新](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html#update-asset-models)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateAssetModel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-asset-model.html)」を参照してください。 ### `update-asset-property` 次のコード例は、`update-asset-property` を使用する方法を示しています。 **AWS CLI** **例 1: アセットプロパティのエイリアスを更新するには** 次の `update-asset-property` の例では、風力タービンアセットの電力プロパティエイリアスを更新します。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[アセットプロパティへの産業データストリームのマッピング](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/connect-data-streams.html)」を参照してください 。 **例 2: アセットプロパティの通知を有効にするには** 次の `update-asset-property` の例では、風力タービンアセットの電力プロパティのアセットプロパティ更新通知を有効にします。プロパティ値の更新は MQTT トピック `$aws/sitewise/asset-models//assets//properties/` に発行されます。各 ID はアセットプロパティのプロパティ、アセット、モデル ID に置き換えられます。 ``` 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" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[その他のサービスの操作](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/interact-with-other-services.html)」を参照してください 。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateAssetProperty](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-asset-property.html)」を参照してください。 ### `update-asset` 次のコード例は、`update-asset` を使用する方法を示しています。 **AWS CLI** **アセットの名前を更新するには** 次の `update-asset` の例では、風力タービンアセットの名前を更新します。 ``` aws iotsitewise update-asset \ --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \ --asset-name "Wind Turbine 2" ``` 出力: ``` { "assetStatus": { "state": "UPDATING" } } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[アセットの更新](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/update-assets-and-models.html#update-assets)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-asset.html)」を参照してください。 ### `update-dashboard` 次のコード例は、`update-dashboard` を使用する方法を示しています。 **AWS CLI** **ダッシュボードを更新するには** 次の `update-dashboard` の例では、風力発電所の総発電電力が表示されるダッシュボードの折れ線グラフのタイトルを変更します。 ``` aws iotsitewise update-dashboard \ --project-id a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE \ --dashboard-name "Wind Farm" \ --dashboard-definition file://update-wind-farm-dashboard.json ``` `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" } ] } ] } ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Creating dashboards (CLI)](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateDashboard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-dashboard.html)」を参照してください。 ### `update-gateway-capability-configuration` 次のコード例は、`update-gateway-capability-configuration` を使用する方法を示しています。 **AWS CLI** **ゲートウェイ機能を更新するには** 次の `update-gateway-capability-configuration` の例では、次のプロパティを使用して OPC-UA ソースを設定します。 すべての証明書を信頼する。Basic256 アルゴリズムを使用してメッセージを保護する。SignAndEncrypt モードを使用して接続を保護する。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 ``` `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": "" } ] } ``` 出力: ``` { "capabilityNamespace": "iotsitewise:opcuacollector:1", "capabilitySyncStatus": "OUT_OF_SYNC" } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Configuring data sources](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/configure-sources.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateGatewayCapabilityConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-gateway-capability-configuration.html)」を参照してください。 ### `update-gateway` 次のコード例は、`update-gateway` を使用する方法を示しています。 **AWS CLI** **ゲートウェイの名前を更新するには** 次の `update-gateway` の例では、ゲートウェイの名前を更新します。 ``` aws iotsitewise update-gateway \ --gateway-id a1b2c3d4-5678-90ab-cdef-1a1a1EXAMPLE \ --gateway-name ExampleCorpGateway1 ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Ingesting data using a gateway](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/gateways.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-gateway.html)」を参照してください。 ### `update-portal` 次のコード例は、`update-portal` を使用する方法を示しています。 **AWS CLI** **ポータルの詳細を更新するには** 次の `update-portal` の例では、風力発電所会社のウェブポータルを更新します。 ``` 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 ``` 出力: ``` { "portalStatus": { "state": "UPDATING" } } ``` 詳細については、「*AWS IoT SiteWise ユーザーガイド*」の「[Administering your portals](https://docs.aws.amazon.com/iot-sitewise/latest/userguide/administer-portals.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdatePortal](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-portal.html)」を参照してください。 ### `update-project` 次のコード例は、`update-project` を使用する方法を示しています。 **AWS CLI** **プロジェクトの詳細を更新するには** 次の `update-project` の例では、風力発電所プロジェクトを更新します。 ``` 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." ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT SiteWise Monitor アプリケーションガイド*」の「[プロジェクト詳細の変更](https://docs.aws.amazon.com/iot-sitewise/latest/appguide/edit-project-details.html)を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateProject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotsitewise/update-project.html)」を参照してください。 # AWS IoT Things Graph examples using AWS CLI 次のコード例では、AWS IoT Things Graph で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `associate-entity-to-thing` 次のコード例は、`associate-entity-to-thing` を使用する方法を示しています。 **AWS CLI** **モノをデバイスに関連付けるには** 次の `associate-entity-to-thing` の例では、モノをデバイスに関連付けます。この例では、パブリック名前空間にあるモーションセンサーデバイスを使用しています。 ``` aws iotthingsgraph associate-entity-to-thing \ --thing-name "MotionSensorName" \ --entity-id "urn:tdm:aws/examples:Device:HCSR501MotionSensor" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[モデルの作成とアップロード](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-models-gs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateEntityToThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/associate-entity-to-thing.html)」を参照してください。 ### `create-flow-template` 次のコード例は、`create-flow-template` を使用する方法を示しています。 **AWS CLI** **フローを作成するには** 次の `create-flow-template` の例では、フロー (ワークフロー) を作成します。`MyFlowDefinition` という値は、フローをモデル化する GraphQL です。 ``` aws iotthingsgraph create-flow-template \ --definition language=GRAPHQL,text="MyFlowDefinition" ``` 出力: ``` { "summary": { "createdAt": 1559248067.545, "id": "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow", "revisionNumber": 1 } } ``` 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[フローでの作業](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-workflows.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateFlowTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/create-flow-template.html)」を参照してください。 ### `create-system-instance` 次のコード例は、`create-system-instance` を使用する方法を示しています。 **AWS CLI** **システムインスタンスを作成するには** 次の `create-system-instance` の例では、システムインスタンスを作成します。`MySystemInstanceDefinition` という値は、システムインスタンスをモデル化する GraphQL です。 ``` aws iotthingsgraph create-system-instance -\ -definition language=GRAPHQL,text="MySystemInstanceDefinition" \ --target CLOUD \ --flow-actions-role-arn myRoleARN ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[システムとフロー設定の使用](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-sysdeploy.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateSystemInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/create-system-instance.html)」を参照してください。 ### `create-system-template` 次のコード例は、`create-system-template` を使用する方法を示しています。 **AWS CLI** **システムを作成するには** 次の `create-system-template` の例では、システムを作成します。MySystemDefinition という値は、システムをモデル化する GraphQL です。 ``` aws iotthingsgraph create-system-template \ --definition language=GRAPHQL,text="MySystemDefinition" ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[システムの作成](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-sysdeploy-systems.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateSystemTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/create-system-template.html)」を参照してください。 ### `delete-flow-template` 次のコード例は、`delete-flow-template` を使用する方法を示しています。 **AWS CLI** **フローを削除するには** 次の `delete-flow-template` の例では、フロー (ワークフロー) を削除します。 ``` aws iotthingsgraph delete-flow-template \ --id "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[AWS IoT Things Graph エンティティ、フロー、システム、デプロイのライフサイクル管理](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-lifecycle.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteFlowTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/delete-flow-template.html)」を参照してください。 ### `delete-namespace` 次のコード例は、`delete-namespace` を使用する方法を示しています。 **AWS CLI** **名前空間を削除するには** 次の `delete-namespace` の例では、名前空間を削除します。 ``` aws iotthingsgraph delete-namespace ``` 出力: ``` { "namespaceArn": "arn:aws:iotthingsgraph:us-west-2:123456789012", "namespaceName": "us-west-2/123456789012/default" } ``` 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[AWS IoT Things Graph エンティティ、フロー、システム、デプロイのライフサイクル管理](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-lifecycle.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteNamespace](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/delete-namespace.html)」を参照してください。 ### `delete-system-instance` 次のコード例は、`delete-system-instance` を使用する方法を示しています。 **AWS CLI** **システムインスタンスを削除するには** 次の `delete-system-instance` の例では、システムインスタンスを削除します。 ``` aws iotthingsgraph delete-system-instance \ --id "urn:tdm:us-west-2/123456789012/default:Deployment:Room218" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[AWS IoT Things Graph エンティティ、フロー、システム、デプロイのライフサイクル管理](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-lifecycle.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteSystemInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/delete-system-instance.html)」を参照してください。 ### `delete-system-template` 次のコード例は、`delete-system-template` を使用する方法を示しています。 **AWS CLI** **システムを削除するには** 次の `delete-system-template` の例では、システムを削除します。 ``` aws iotthingsgraph delete-system-template \ --id "urn:tdm:us-west-2/123456789012/default:System:MySystem" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[AWS IoT Things Graph エンティティ、フロー、システム、デプロイのライフサイクル管理](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-lifecycle.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteSystemTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/delete-system-template.html)」を参照してください。 ### `deploy-system-instance` 次のコード例は、`deploy-system-instance` を使用する方法を示しています。 **AWS CLI** **システムインスタンスをデプロイするには** 次の `delete-system-template` の例では、システムインスタンスをデプロイします。 ``` aws iotthingsgraph deploy-system-instance \ --id "urn:tdm:us-west-2/123456789012/default:Deployment:Room218" ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[システムとフロー設定の使用](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-sysdeploy.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeploySystemInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/deploy-system-instance.html)」を参照してください。 ### `deprecate-flow-template` 次のコード例は、`deprecate-flow-template` を使用する方法を示しています。 **AWS CLI** **フローを非推奨にするには** 次の `deprecate-flow-template` の例では、フロー (ワークフロー) を非推奨にします。 ``` aws iotthingsgraph deprecate-flow-template \ --id "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[AWS IoT Things Graph エンティティ、フロー、システム、デプロイのライフサイクル管理](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-lifecycle.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeprecateFlowTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/deprecate-flow-template.html)」を参照してください。 ### `deprecate-system-template` 次のコード例は、`deprecate-system-template` を使用する方法を示しています。 **AWS CLI** **システムを非推奨にするには** 次の `deprecate-system-template` の例では、システムを非推奨にします。 ``` aws iotthingsgraph deprecate-system-template \ --id "urn:tdm:us-west-2/123456789012/default:System:MySystem" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[AWS IoT Things Graph エンティティ、フロー、システム、デプロイのライフサイクル管理](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-lifecycle.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeprecateSystemTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/deprecate-system-template.html)」を参照してください。 ### `describe-namespace` 次のコード例は、`describe-namespace` を使用する方法を示しています。 **AWS CLI** **名前空間の説明を取得するには** 次の `describe-namespace` の例では、名前空間の説明を取得します。 ``` aws iotthingsgraph describe-namespace ``` 出力: ``` { "namespaceName": "us-west-2/123456789012/default", "trackingNamespaceName": "aws", "trackingNamespaceVersion": 1, "namespaceVersion": 5 } ``` 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[名前空間](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-whatis-namespace.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeNamespace](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/describe-namespace.html)」を参照してください。 ### `dissociate-entity-from-thing` 次のコード例は、`dissociate-entity-from-thing` を使用する方法を示しています。 **AWS CLI** **デバイスからモノの関連付けを解除するには** 次の `dissociate-entity-from-thing` の例では、デバイスからモノの関連付けを解除します。 ``` aws iotthingsgraph dissociate-entity-from-thing \ --thing-name "MotionSensorName" \ --entity-type "DEVICE" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[モデルの作成とアップロード](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-models-gs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DissociateEntityFromThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/dissociate-entity-from-thing.html)」を参照してください。 ### `get-entities` 次のコード例は、`get-entities` を使用する方法を示しています。 **AWS CLI** **エンティティの定義を取得するには** 次の `get-entities` の例では、デバイスモデルの定義を取得します。 ``` aws iotthingsgraph get-entities \ --ids "urn:tdm:aws/examples:DeviceModel:MotionSensor" ``` 出力: ``` { "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}" } } ] } ``` 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[モデルの作成とアップロード](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-models-gs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetEntities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/get-entities.html)」を参照してください。 ### `get-flow-template-revisions` 次のコード例は、`get-flow-template-revisions` を使用する方法を示しています。 **AWS CLI** **フローに関するリビジョン情報を取得するには** 次の `get-flow-template-revisions` の例では、フロー (ワークフロー) に関するリビジョン情報を取得します。 ``` aws iotthingsgraph get-flow-template-revisions \ --id urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow ``` 出力: ``` { "summaries": [ { "id": "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow", "revisionNumber": 1, "createdAt": 1559247540.292 } ] } ``` 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[フローでの作業](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-workflows.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetFlowTemplateRevisions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/get-flow-template-revisions.html)」を参照してください。 ### `get-flow-template` 次のコード例は、`get-flow-template` を使用する方法を示しています。 **AWS CLI** **フロー定義を取得するには** 次の `get-flow-template` の例では、フロー (ワークフロー) の定義を取得します。 ``` aws iotthingsgraph get-flow-template \ --id "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow" ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[フローでの作業](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-workflows.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetFlowTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/get-flow-template.html)」を参照してください。 ### `get-namespace-deletion-status` 次のコード例は、`get-namespace-deletion-status` を使用する方法を示しています。 **AWS CLI** **名前空間削除タスクのステータスを取得するには** 次の `get-namespace-deletion-status` の例では、名前空間削除タスクのステータスを取得します。 ``` aws iotthingsgraph get-namespace-deletion-status ``` 出力: ``` { "namespaceArn": "arn:aws:iotthingsgraph:us-west-2:123456789012", "namespaceName": "us-west-2/123456789012/default" "status": "SUCCEEDED " } ``` 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[名前空間](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-whatis-namespace.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetNamespaceDeletionStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/get-namespace-deletion-status.html)」を参照してください。 ### `get-system-instance` 次のコード例は、`get-system-instance` を使用する方法を示しています。 **AWS CLI** **システムインスタンスを取得するには** 次の `get-system-instance` の例では、システムインスタンスの定義を取得します。 ``` aws iotthingsgraph get-system-instance \ --id "urn:tdm:us-west-2/123456789012/default:Deployment:Room218" ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[システムとフロー設定の使用](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-sysdeploy.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetSystemInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/get-system-instance.html)」を参照してください。 ### `get-system-template-revisions` 次のコード例は、`get-system-template-revisions` を使用する方法を示しています。 **AWS CLI** **システムに関するリビジョン情報を取得するには** 次の `get-system-template-revisions` の例では、システムに関するリビジョン情報を取得します。 ``` aws iotthingsgraph get-system-template-revisions \ --id "urn:tdm:us-west-2/123456789012/default:System:MySystem" ``` 出力: ``` { "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 } ] } ``` 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[システムとフロー設定の使用](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-sysdeploy.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetSystemTemplateRevisions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/get-system-template-revisions.html)」を参照してください。 ### `get-system-template` 次のコード例は、`get-system-template` を使用する方法を示しています。 **AWS CLI** **システムを取得するには** 次の `get-system-template` の例では、システムの定義を取得します。 ``` aws iotthingsgraph get-system-template \ --id "urn:tdm:us-west-2/123456789012/default:System:MySystem" ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[システムとフロー設定の使用](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-sysdeploy.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetSystemTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/get-system-template.html)」を参照してください。 ### `get-upload-status` 次のコード例は、`get-upload-status` を使用する方法を示しています。 **AWS CLI** **エンティティアップロードのステータスを取得するには** 次の `get-upload-status` の例では、エンティティアップロードオペレーションのステータスを取得します。`MyUploadId` という値は、`upload-entity-definitions` オペレーションによって返される ID 値です。 ``` aws iotthingsgraph get-upload-status \ --upload-id "MyUploadId" ``` 出力: ``` { "namespaceName": "us-west-2/123456789012/default", "namespaceVersion": 5, "uploadId": "f6294f1e-b109-4bbe-9073-f451a2dda2da", "uploadStatus": "SUCCEEDED" } ``` 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[エンティティのモデリング](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-modelmanagement.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetUploadStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/get-upload-status.html)」を参照してください。 ### `list-flow-execution-messages` 次のコード例は、`list-flow-execution-messages` を使用する方法を示しています。 **AWS CLI** **フロー実行中のイベントに関する情報を取得するには** 次の `list-flow-execution-messages` の例では、フロー実行中のイベントに関する情報を取得します。 ``` 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" ``` 出力: ``` { "messages": [ { "eventType": "EXECUTION_STARTED", "messageId": "f6294f1e-b109-4bbe-9073-f451a2dda2da", "payload": "Flow execution started", "timestamp": 1559247540.656 } ] } ``` 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[フローでの作業](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-workflows.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListFlowExecutionMessages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/list-flow-execution-messages.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **リソースのすべてのタグを一覧表示するには** 次の `list-tags-for-resource` の例では、AWS IoT Things Graph リソースのすべてのタグを一覧表示します。 ``` aws iotthingsgraph list-tags-for-resource \ --resource-arn "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room218" ``` 出力: ``` { "tags": [ { "key": "Type", "value": "Residential" } ] } ``` 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[AWS IoT Things Graph リソースのタグ付け](https://docs.aws.amazon.com/thingsgraph/latest/ug/tagging-tg.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/list-tags-for-resource.html)」を参照してください。 ### `search-entities` 次のコード例は、`search-entities` を使用する方法を示しています。 **AWS CLI** **エンティティを検索するには** 次の `search-entities` の例では、タイプが `EVENT` のすべてのエンティティを検索します。 ``` aws iotthingsgraph search-entities \ --entity-types "EVENT" ``` 出力: ``` { "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" } ``` 詳細については、「AWS IoT Things Graph ユーザーガイド」の「[AWS IoT Things Graph データモデルのリファレンス](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-models.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SearchEntities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/search-entities.html)」を参照してください。 ### `search-flow-executions` 次のコード例は、`search-flow-executions` を使用する方法を示しています。 **AWS CLI** **フロー実行を検索するには** 次の `search-flow-executions` の例では、指定されたシステムインスタンス内のフローのすべての実行を検索します。 ``` aws iotthingsgraph search-flow-executions \ --system-instance-id "urn:tdm:us-west-2/123456789012/default:Deployment:Room218" ``` 出力: ``` { "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 } ] } ``` 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[システムとフロー設定の使用](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-sysdeploy.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SearchFlowExecutions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/search-flow-executions.html)」を参照してください。 ### `search-flow-templates` 次のコード例は、`search-flow-templates` を使用する方法を示しています。 **AWS CLI** **フロー (またはワークフロー) を検索するには** 次の `search-flow-templates` の例では、Camera デバイスモデルを含むすべてのフロー (ワークフロー) を検索します。 ``` aws iotthingsgraph search-flow-templates \ --filters name="DEVICE_MODEL_ID",value="urn:tdm:aws/examples:DeviceModel:Camera" ``` 出力: ``` { "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 } ] } ``` 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[フローでの作業](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-workflows.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SearchFlowTemplates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/search-flow-templates.html)」を参照してください。 ### `search-system-instances` 次のコード例は、`search-system-instances` を使用する方法を示しています。 **AWS CLI** **システムインスタンスを検索するには** 次の `search-system-instances` の例では、指定されたシステムを含むすべてのシステムインスタンスを検索します。 ``` aws iotthingsgraph search-system-instances \ --filters name="SYSTEM_TEMPLATE_ID",value="urn:tdm:us-west-2/123456789012/default:System:SecurityFlow" ``` 出力: ``` { "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 } ] } ``` 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[システムとフロー設定の使用](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-sysdeploy.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SearchSystemInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/search-system-instances.html)」を参照してください。 ### `search-system-templates` 次のコード例は、`search-system-templates` を使用する方法を示しています。 **AWS CLI** **システムを検索するには** 次の `search-system-templates` の例では、指定されたフローを含むすべてのシステムを検索します。 ``` aws iotthingsgraph search-system-templates \ --filters name="FLOW_TEMPLATE_ID",value="urn:tdm:us-west-2/123456789012/default:Workflow:SecurityFlow" ``` 出力: ``` { "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 } ] } ``` 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[フローでの作業](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-workflows.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SearchSystemTemplates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/search-system-templates.html)」を参照してください。 ### `search-things` 次のコード例は、`search-things` を使用する方法を示しています。 **AWS CLI** **デバイスとデバイスモデルに関連付けられているモノを検索するには** 次の `search-things` の例では、HCSR501MotionSensor デバイスに関連付けられているすべてのモノを検索します。 ``` aws iotthingsgraph search-things \ --entity-id "urn:tdm:aws/examples:Device:HCSR501MotionSensor" ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[モデルの作成とアップロード](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-models-gs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SearchThings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/search-things.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **リソースのタグを作成するには** 次の `tag-resource` の例では、指定されたリソースのタグを作成します。 ``` aws iotthingsgraph tag-resource \ --resource-arn "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room218" \ --tags key="Type",value="Residential" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[AWS IoT Things Graph リソースのタグ付け](https://docs.aws.amazon.com/thingsgraph/latest/ug/tagging-tg.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/tag-resource.html)」を参照してください。 ### `undeploy-system-instance` 次のコード例は、`undeploy-system-instance` を使用する方法を示しています。 **AWS CLI** **ターゲットからシステムインスタンスをデプロイ解除するには** 次の `undeploy-system-instance` の例では、ターゲットからシステムインスタンスを削除します。 ``` aws iotthingsgraph undeploy-system-instance \ --id "urn:tdm:us-west-2/123456789012/default:Deployment:Room215" ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[AWS IoT Things Graph エンティティ、フロー、システム、デプロイのライフサイクル管理](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-lifecycle.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UndeploySystemInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/undeploy-system-instance.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **リソースのタグを削除するには** 次の `untag-resource` の例では、指定されたリソースのタグを削除します。 ``` aws iotthingsgraph untag-resource \ --resource-arn "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room218" \ --tag-keys "Type" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[AWS IoT Things Graph リソースのタグ付け](https://docs.aws.amazon.com/thingsgraph/latest/ug/tagging-tg.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/untag-resource.html)」を参照してください。 ### `update-flow-template` 次のコード例は、`update-flow-template` を使用する方法を示しています。 **AWS CLI** **フローを更新するには** 次の `update-flow-template` の例では、フロー (ワークフロー) を更新します。`MyFlowDefinition` という値は、フローをモデル化する GraphQL です。 ``` aws iotthingsgraph update-flow-template \ --id "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow" \ --definition language=GRAPHQL,text="MyFlowDefinition" ``` 出力: ``` { "summary": { "createdAt": 1559248067.545, "id": "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow", "revisionNumber": 2 } } ``` 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[フローでの作業](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-workflows.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateFlowTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/update-flow-template.html)」を参照してください。 ### `update-system-template` 次のコード例は、`update-system-template` を使用する方法を示しています。 **AWS CLI** **システムを更新するには** 次の `update-system-template` の例では、システムを更新します。`MySystemDefinition` という値は、システムをモデル化する GraphQL です。 ``` aws iotthingsgraph update-system-template \ --id "urn:tdm:us-west-2/123456789012/default:System:MySystem" \ --definition language=GRAPHQL,text="MySystemDefinition" ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[システムの作成](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-sysdeploy-systems.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateSystemTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/update-system-template.html)」を参照してください。 ### `upload-entity-definitions` 次のコード例は、`upload-entity-definitions` を使用する方法を示しています。 **AWS CLI** **エンティティ定義をアップロードするには** 次の `upload-entity-definitions` の例では、エンティティ定義を名前空間にアップロードします。`MyEntityDefinitions` という値は、エンティティをモデル化する GraphQL です。 ``` aws iotthingsgraph upload-entity-definitions \ --document language=GRAPHQL,text="MyEntityDefinitions" ``` 出力: ``` { "uploadId": "f6294f1e-b109-4bbe-9073-f451a2dda2da" } ``` 詳細については、「*AWS IoT Things Graph ユーザーガイド*」の「[エンティティのモデリング](https://docs.aws.amazon.com/thingsgraph/latest/ug/iot-tg-modelmanagement.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UploadEntityDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotthingsgraph/upload-entity-definitions.html)」を参照してください。 # AWS IoT Wireless examples using AWS CLI 次のコード例では、AWS IoT Wireless で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `associate-aws-account-with-partner-account` 次のコード例は、`associate-aws-account-with-partner-account` を使用する方法を示しています。 **AWS CLI** **パートナーアカウントを AWS アカウントに関連付けるには** 次の `associate-aws-account-with-partner-account` の例では、次の Sidewalk アカウントの認証情報を AWS アカウントに関連付けます。 ``` aws iotwireless associate-aws-account-with-partner-account \ --sidewalk AmazonId="12345678901234",AppServerPrivateKey="a123b45c6d78e9f012a34cd5e6a7890b12c3d45e6f78a1b234c56d7e890a1234" ``` 出力: ``` { "Sidewalk": { "AmazonId": "12345678901234", "AppServerPrivateKey": "a123b45c6d78e9f012a34cd5e6a7890b12c3d45e6f78a1b234c56d7e890a1234" } } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[Amazon Sidewalk Integration for AWS IoT Core](https://docs.aws.amazon.com/iot/latest/developerguide/iot-sidewalk.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateAwsAccountWithPartnerAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/associate-aws-account-with-partner-account.html)」を参照してください。 ### `associate-wireless-device-with-thing` 次のコード例は、`associate-wireless-device-with-thing` を使用する方法を示しています。 **AWS CLI** **モノをワイヤレスデバイスに関連付けるには** 次の `associate-wireless-device-with-thing` の例では、指定された ID を持つワイヤレスデバイスにモノを関連付けます。 ``` aws iotwireless associate-wireless-device-with-thing \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" \ --thing-arn "arn:aws:iot:us-east-1:123456789012:thing/MyIoTWirelessThing" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN にゲートウェイとワイヤレスデバイスを追加する](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-onboard-devices.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateWirelessDeviceWithThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/associate-wireless-device-with-thing.html)」を参照してください。 ### `associate-wireless-gateway-with-certificate` 次のコード例は、`associate-wireless-gateway-with-certificate` を使用する方法を示しています。 **AWS CLI** **証明書をワイヤレスゲートウェイに関連付けるには** 次の `associate-wireless-gateway-with-certificate` は、ワイヤレスゲートウェイを証明書に関連付けます。 ``` aws iotwireless associate-wireless-gateway-with-certificate \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" \ --iot-certificate-id "a123b45c6d78e9f012a34cd5e6a7890b12c3d45e6f78a1b234c56d7e890a1234" ``` 出力: ``` { "IotCertificateId": "a123b45c6d78e9f012a34cd5e6a7890b12c3d45e6f78a1b234c56d7e890a1234" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN にゲートウェイとワイヤレスデバイスを追加する](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-onboard-devices.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateWirelessGatewayWithCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/associate-wireless-gateway-with-certificate.html)」を参照してください。 ### `associate-wireless-gateway-with-thing` 次のコード例は、`associate-wireless-gateway-with-thing` を使用する方法を示しています。 **AWS CLI** **モノをワイヤレスゲートウェイに関連付けるには** 次の `associate-wireless-gateway-with-thing` の例では、モノをワイヤレスゲートウェイに関連付けます。 ``` aws iotwireless associate-wireless-gateway-with-thing \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" \ --thing-arn "arn:aws:iot:us-east-1:123456789012:thing/MyIoTWirelessThing" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN にゲートウェイとワイヤレスデバイスを追加する](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-onboard-devices.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateWirelessGatewayWithThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/associate-wireless-gateway-with-thing.html)」を参照してください。 ### `create-destination` 次のコード例は、`create-destination` を使用する方法を示しています。 **AWS CLI** **IoT ワイヤレス送信先を作成するには** 次の `create-destination` の例では、デバイスメッセージを AWS IoT ルールにマッピングするための送信先を作成します。このコマンドを実行する前に、AWS IoT ルールへのデータ送信に必要なアクセス許可を AWS IoT Core for LoRaWAN に付与する IAM ロールを作成しておく必要があります。 ``` aws iotwireless create-destination \ --name IoTWirelessDestination \ --expression-type RuleName \ --expression IoTWirelessRule \ --role-arn arn:aws:iam::123456789012:role/IoTWirelessDestinationRole ``` 出力: ``` { "Arn": "arn:aws:iotwireless:us-east-1:123456789012:Destination/IoTWirelessDestination", "Name": "IoTWirelessDestination" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN にデスティネーションを追加する](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-create-destinations.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDestination](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/create-destination.html)」を参照してください。 ### `create-device-profile` 次のコード例は、`create-device-profile` を使用する方法を示しています。 **AWS CLI** **新しいデバイスプロファイルを作成するには** 次の `create-device-profile` の例では、新しい IoT ワイヤレスデバイスプロファイルを作成します。 ``` aws iotwireless create-device-profile ``` 出力: ``` { "Arn": "arn:aws:iotwireless:us-east-1:123456789012:DeviceProfile/12345678-a1b2-3c45-67d8-e90fa1b2c34d", "Id": "12345678-a1b2-3c45-67d8-e90fa1b2c34d" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[プロファイルを AWS IoT Core for LoRaWAN に追加する](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-define-profiles.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDeviceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/create-device-profile.html)」を参照してください。 ### `create-service-profile` 次のコード例は、`create-service-profile` を使用する方法を示しています。 **AWS CLI** **新しいサービスプロファイルを作成するには** 次の `create-service-profile` の例では、新しい IoT ワイヤレスサービスプロファイルを作成します。 ``` aws iotwireless create-service-profile ``` 出力: ``` { "Arn": "arn:aws:iotwireless:us-east-1:123456789012:ServiceProfile/12345678-a1b2-3c45-67d8-e90fa1b2c34d", "Id": "12345678-a1b2-3c45-67d8-e90fa1b2c34d" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[プロファイルを AWS IoT Core for LoRaWAN に追加する](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-define-profiles.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateServiceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/create-service-profile.html)」を参照してください。 ### `create-wireless-device` 次のコード例は、`create-wireless-device` を使用する方法を示しています。 **AWS CLI** **IoT ワイヤレスデバイスを作成するには** 次の `create-wireless-device` の例では、LoRaWAN タイプのワイヤレスデバイスリソースを作成します。 ``` aws iotwireless create-wireless-device \ --cli-input-json file://input.json ``` `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 } ``` 出力: ``` { "Arn": "arn:aws:iotwireless:us-east-1:123456789012:WirelessDevice/1ffd32c8-8130-4194-96df-622f072a315f", "Id": "1ffd32c8-8130-4194-96df-622f072a315f" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN へのゲートウェイとデバイスの接続](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateWirelessDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/create-wireless-device.html)」を参照してください。 ### `create-wireless-gateway-task-definition` 次のコード例は、`create-wireless-gateway-task-definition` を使用する方法を示しています。 **AWS CLI** **ワイヤレスゲートウェイタスク定義を作成するには** 次の `create-wireless-gateway-task-definition` の例では、指定された現在のバージョンを持つすべてのゲートウェイに対して、このタスク定義を使用してタスクを自動的に作成します。 ``` aws iotwireless create-wireless-gateway-task-definition \ --cli-input-json file://input.json ``` `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" } } } } ``` 出力: ``` { "Id": "b7d3baad-25c7-35e7-a4e1-1683a0d61da9" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN へのゲートウェイとデバイスの接続](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateWirelessGatewayTaskDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/create-wireless-gateway-task-definition.html)」を参照してください。 ### `create-wireless-gateway-task` 次のコード例は、`create-wireless-gateway-task` を使用する方法を示しています。 **AWS CLI** **ワイヤレスゲートウェイのタスクを作成するには** 次の `create-wireless-gateway-task` の例では、ワイヤレスゲートウェイのタスクを作成します。 ``` aws iotwireless create-wireless-gateway-task \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" \ --wireless-gateway-task-definition-id "aa000102-0304-b0cd-ef56-a1b23cde456a" ``` 出力: ``` { "WirelessGatewayTaskDefinitionId": "aa204003-0604-30fb-ac82-a4f95aaf450a", "Status": "Success" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN へのゲートウェイとデバイスの接続](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateWirelessGatewayTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/create-wireless-gateway-task.html)」を参照してください。 ### `create-wireless-gateway` 次のコード例は、`create-wireless-gateway` を使用する方法を示しています。 **AWS CLI** **ワイヤレスゲートウェイを作成するには** 次の `create-wireless-gateway` の例では、ワイヤレス LoRaWAN デバイスゲートウェイを作成します。 ``` aws iotwireless create-wireless-gateway \ --lorawan GatewayEui="a1b2c3d4567890ab",RfRegion="US915" \ --name "myFirstLoRaWANGateway" \ --description "Using my first LoRaWAN gateway" ``` 出力: ``` { "Arn": "arn:aws:iotwireless:us-east-1:123456789012:WirelessGateway/12345678-a1b2-3c45-67d8-e90fa1b2c34d", "Id": "12345678-a1b2-3c45-67d8-e90fa1b2c34d" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN へのゲートウェイとデバイスの接続](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateWirelessGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/create-wireless-gateway.html)」を参照してください。 ### `delete-destination` 次のコード例は、`delete-destination` を使用する方法を示しています。 **AWS CLI** **IoT ワイヤレス送信先を削除するには** 次の `delete-destination` の例では、作成した `IoTWirelessDestination` という名前のワイヤレス送信先リソースを削除します。 ``` aws iotwireless delete-destination \ --name "IoTWirelessDestination" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN に送信先を追加する](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-create-destinations.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDestination](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/delete-destination.html)」を参照してください。 ### `delete-device-profile` 次のコード例は、`delete-device-profile` を使用する方法を示しています。 **AWS CLI** **デバイスプロファイルを削除するには** 次の `delete-device-profile` の例では、指定された ID を持つ、自分で作成したデバイスプロファイルを削除します。 ``` aws iotwireless delete-device-profile \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[プロファイルを AWS IoT Core for LoRaWAN に追加する](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-define-profiles.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDeviceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/delete-device-profile.html)」を参照してください。 ### `delete-service-profile` 次のコード例は、`delete-service-profile` を使用する方法を示しています。 **AWS CLI** **サービスプロファイルを削除するには** 次の `delete-service-profile` の例では、指定された ID を持つ、自分で作成したサービスプロファイルを削除します。 ``` aws iotwireless delete-service-profile \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[プロファイルを AWS IoT Core for LoRaWAN に追加する](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-define-profiles.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteServiceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/delete-service-profile.html)」を参照してください。 ### `delete-wireless-device` 次のコード例は、`delete-wireless-device` を使用する方法を示しています。 **AWS CLI** **ワイヤレスデバイスを削除するには** 次の `delete-wireless-device` の例では、指定された ID を持つワイヤレスデバイスを削除します。 ``` aws iotwireless delete-wireless-device \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN へのゲートウェイとデバイスの接続](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteWirelessDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/delete-wireless-device.html)」を参照してください。 ### `delete-wireless-gateway-task-definition` 次のコード例は、`delete-wireless-gateway-task-definition` を使用する方法を示しています。 **AWS CLI** **ワイヤレスゲートウェイタスク定義を削除するには** 次の `delete-wireless-gateway-task-definition` の例では、次の ID で作成したワイヤレスゲートウェイタスク定義を削除します。 ``` aws iotwireless delete-wireless-gateway-task-definition \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN へのゲートウェイとデバイスの接続](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteWirelessGatewayTaskDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/delete-wireless-gateway-task-definition.html)」を参照してください。 ### `delete-wireless-gateway-task` 次のコード例は、`delete-wireless-gateway-task` を使用する方法を示しています。 **AWS CLI** **ワイヤレスゲートウェイタスクを削除するには** 次の `delete-wireless-gateway-task` の例では、指定された ID を持つワイヤレスゲートウェイタスクを削除します。 ``` aws iotwireless delete-wireless-gateway-task \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN へのゲートウェイとデバイスの接続](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteWirelessGatewayTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/delete-wireless-gateway-task.html)」を参照してください。 ### `delete-wireless-gateway` 次のコード例は、`delete-wireless-gateway` を使用する方法を示しています。 **AWS CLI** **ワイヤレスゲートウェイを削除するには** 次の `delete-wireless-gateway` の例では、指定された ID を持つワイヤレスゲートウェイを削除します。 ``` aws iotwireless delete-wireless-gateway \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN へのゲートウェイとデバイスの接続](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteWirelessGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/delete-wireless-gateway.html)」を参照してください。 ### `disassociate-aws-account-from-partner-account` 次のコード例は、`disassociate-aws-account-from-partner-account` を使用する方法を示しています。 **AWS CLI** **AWS アカウントからパートナーアカウントの関連付けを解除するには** 次の `disassociate-aws-account-from-partner-account` の例では、現在関連付けられている AWS アカウントからパートナーアカウントの関連付けを解除します。 ``` aws iotwireless disassociate-aws-account-from-partner-account \ --partner-account-id "12345678901234" \ --partner-type "Sidewalk" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN にゲートウェイとワイヤレスデバイスを追加する](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-onboard-devices.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateAwsAccountFromPartnerAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/disassociate-aws-account-from-partner-account.html)」を参照してください。 ### `disassociate-wireless-device-from-thing` 次のコード例は、`disassociate-wireless-device-from-thing` を使用する方法を示しています。 **AWS CLI** **ワイヤレスデバイスからモノの関連付けを解除するには** 次の `disassociate-wireless-device-from-thing` の例では、現在関連付けられているモノからワイヤレスデバイスの関連付けを解除します。 ``` aws iotwireless disassociate-wireless-device-from-thing \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN にゲートウェイとワイヤレスデバイスを追加する](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-onboard-devices.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateWirelessDeviceFromThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/disassociate-wireless-device-from-thing.html)」を参照してください。 ### `disassociate-wireless-gateway-from-certificate` 次のコード例は、`disassociate-wireless-gateway-from-certificate` を使用する方法を示しています。 **AWS CLI** **ワイヤレスゲートウェイから証明書の関連付けを解除するには** 次の `disassociate-wireless-gateway-from-certificate` は、現在関連付けられている証明書からワイヤレスゲートウェイの関連付けを解除します。 ``` aws iotwireless disassociate-wireless-gateway-from-certificate \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN にゲートウェイとワイヤレスデバイスを追加する](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-onboard-devices.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateWirelessGatewayFromCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/disassociate-wireless-gateway-from-certificate.html)」を参照してください。 ### `disassociate-wireless-gateway-from-thing` 次のコード例は、`disassociate-wireless-gateway-from-thing` を使用する方法を示しています。 **AWS CLI** **ワイヤレスゲートウェイからモノの関連付けを解除するには** 次の `disassociate-wireless-gateway-from-thing` の例では、現在関連付けられているモノからワイヤレスゲートウェイの関連付け解除します。 ``` aws iotwireless disassociate-wireless-gateway-from-thing \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN にゲートウェイとワイヤレスデバイスを追加する](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-onboard-devices.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateWirelessGatewayFromThing](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/disassociate-wireless-gateway-from-thing.html)」を参照してください。 ### `get-destination` 次のコード例は、`get-destination` を使用する方法を示しています。 **AWS CLI** **IoT ワイヤレス送信先に関する情報を取得するには** 次の `get-destination` の例では、作成した `IoTWirelessDestination` という名前の送信先リソースに関する情報を取得します。 ``` aws iotwireless get-destination \ --name "IoTWirelessDestination" ``` 出力: ``` { "Arn": "arn:aws:iotwireless:us-east-1:123456789012:Destination/IoTWirelessDestination", "Name": "IoTWirelessDestination", "Expression": "IoTWirelessRule", "ExpressionType": "RuleName", "RoleArn": "arn:aws:iam::123456789012:role/IoTWirelessDestinationRole" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN に送信先を追加する](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-create-destinations.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDestination](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/get-destination.html)」を参照してください。 ### `get-device-profile` 次のコード例は、`get-device-profile` を使用する方法を示しています。 **AWS CLI** **デバイスプロファイルに関する情報を取得するには** 次の `get-device-profile` の例では、指定された ID を持つ、自分で作成したデバイスプロファイルに関する情報を取得します。 ``` aws iotwireless get-device-profile \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[プロファイルを AWS IoT Core for LoRaWAN に追加する](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-define-profiles.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDeviceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/get-device-profile.html)」を参照してください。 ### `get-partner-account` 次のコード例は、`get-partner-account` を使用する方法を示しています。 **AWS CLI** **パートナーアカウントの情報を取得するには** 次の `get-partner-account` の例では、次の ID を持つ Sidewalk アカウントに関する情報を取得します。 ``` aws iotwireless get-partner-account \ --partner-account-id "12345678901234" \ --partner-type "Sidewalk" ``` 出力: ``` { "Sidewalk": { "AmazonId": "12345678901234", "Fingerprint": "a123b45c6d78e9f012a34cd5e6a7890b12c3d45e6f78a1b234c56d7e890a1234" }, "AccountLinked": false } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[Amazon Sidewalk Integration for AWS IoT Core](https://docs.aws.amazon.com/iot/latest/developerguide/iot-sidewalk.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPartnerAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/get-partner-account.html)」を参照してください。 ### `get-service-endpoint` 次のコード例は、`get-service-endpoint` を使用する方法を示しています。 **AWS CLI** **サービスエンドポイントを取得するには** 次の `get-service-endpoint` の例では、CUPS プロトコルのアカウント固有のエンドポイントを取得します。 ``` aws iotwireless get-service-endpoint ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN へのゲートウェイとデバイスの接続](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetServiceEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/get-service-endpoint.html)」を参照してください。 ### `get-service-profile` 次のコード例は、`get-service-profile` を使用する方法を示しています。 **AWS CLI** **サービスプロファイルに関する情報を取得するには** 次の `get-service-profile` の例では、指定された ID を持つ、自分で作成したサービスプロファイルに関する情報を取得します。 ``` aws iotwireless get-service-profile \ --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[プロファイルを AWS IoT Core for LoRaWAN に追加する](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-define-profiles.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetServiceProfile](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/get-service-profile.html)」を参照してください。 ### `get-wireless-device-statistics` 次のコード例は、`get-wireless-device-statistics` を使用する方法を示しています。 **AWS CLI** **ワイヤレスデバイスに関する運用情報を取得するには** 次の `get-wireless-device-statistics` の例では、ワイヤレスデバイスに関する運用情報を取得します。 ``` aws iotwireless get-wireless-device-statistics \ --wireless-device-id "1ffd32c8-8130-4194-96df-622f072a315f" ``` 出力: ``` { "WirelessDeviceId": "1ffd32c8-8130-4194-96df-622f072a315f" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN へのゲートウェイとデバイスの接続](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetWirelessDeviceStatistics](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/get-wireless-device-statistics.html)」を参照してください。 ### `get-wireless-device` 次のコード例は、`get-wireless-device` を使用する方法を示しています。 **AWS CLI** **ワイヤレスデバイスに関する情報を取得するには** 次の `get-wireless-device` の例では、AWS アカウントで使用可能なウィジェットを一覧表示します。 ``` aws iotwireless get-wireless-device \ --identifier "1ffd32c8-8130-4194-96df-622f072a315f" \ --identifier-type WirelessDeviceID ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN へのゲートウェイとデバイスの接続](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetWirelessDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/get-wireless-device.html)」を参照してください。 ### `get-wireless-gateway-certificate` 次のコード例は、`get-wireless-gateway-certificate` を使用する方法を示しています。 **AWS CLI** **ワイヤレスゲートウェイに関連付けられている証明書の ID を取得するには** 次の `get-wireless-gateway-certificate` の例では、指定された ID を持つワイヤレスゲートウェイに関連付けられている証明書 ID を取得します。 ``` aws iotwireless get-wireless-gateway-certificate \ --id "6c44ab31-8b4d-407a-bed3-19b6c7cda551" ``` 出力: ``` { "IotCertificateId": "8ea4aeae3db34c78cce75d9abd830356869ead6972997e0603e5fd032c804b6f" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN へのゲートウェイとデバイスの接続](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetWirelessGatewayCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/get-wireless-gateway-certificate.html)」を参照してください。 ### `get-wireless-gateway-firmware-information` 次のコード例は、`get-wireless-gateway-firmware-information` を使用する方法を示しています。 **AWS CLI** **ワイヤレスゲートウェイに関するファームウェア情報を取得するには** 次の `get-wireless-gateway-firmware-information` 例では、ワイヤレスゲートウェイに関するファームウェアバージョンとその他の情報を取得します。 ``` aws iotwireless get-wireless-gateway-firmware-information \ --id "3039b406-5cc9-4307-925b-9948c63da25b" ``` 出力: ``` { "LoRaWAN" :{ "CurrentVersion" :{ "PackageVersion" : "1.0.0", "Station" : "2.0.5", "Model" : "linux" } } } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN へのゲートウェイとデバイスの接続](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetWirelessGatewayFirmwareInformation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/get-wireless-gateway-firmware-information.html)」を参照してください。 ### `get-wireless-gateway-statistics` 次のコード例は、`get-wireless-gateway-statistics` を使用する方法を示しています。 **AWS CLI** **ワイヤレスゲートウェイに関する運用情報を取得するには** 次の `get-wireless-gateway-statistics` の例では、ワイヤレスゲートウェイに関する運用情報を取得します。 ``` aws iotwireless get-wireless-gateway-statistics \ --wireless-gateway-id "3039b406-5cc9-4307-925b-9948c63da25b" ``` 出力: ``` { "WirelessGatewayId": "3039b406-5cc9-4307-925b-9948c63da25b" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN へのゲートウェイとデバイスの接続](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetWirelessGatewayStatistics](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/get-wireless-gateway-statistics.html)」を参照してください。 ### `get-wireless-gateway-task-definition` 次のコード例は、`get-wireless-gateway-task-definition` を使用する方法を示しています。 **AWS CLI** **ワイヤレスゲートウェイタスク定義に関する情報を取得するには** 次の `get-wireless-gateway-task-definition` の例では、指定された ID を持つワイヤレスタスク定義に関する情報を取得します。 ``` aws iotwireless get-wireless-gateway-task-definition \ --id "b7d3baad-25c7-35e7-a4e1-1683a0d61da9" ``` 出力: ``` { "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" } } } } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN へのゲートウェイとデバイスの接続](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetWirelessGatewayTaskDefinition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/get-wireless-gateway-task-definition.html)」を参照してください。 ### `get-wireless-gateway-task` 次のコード例は、`get-wireless-gateway-task` を使用する方法を示しています。 **AWS CLI** **ワイヤレスゲートウェイタスクに関する情報を取得するには** 次の `get-wireless-gateway-task` の例では、指定された ID を持つワイヤレスゲートウェイタスク定義に関する情報を取得します。 ``` aws iotwireless get-wireless-gateway-task \ --id "11693a46-6866-47c3-a031-c9a616e7644b" ``` 出力: ``` { "WirelessGatewayId": "6c44ab31-8b4d-407a-bed3-19b6c7cda551", "WirelessGatewayTaskDefinitionId": "b7d3baad-25c7-35e7-a4e1-1683a0d61da9", "Status": "Success" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN へのゲートウェイとデバイスの接続](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetWirelessGatewayTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/get-wireless-gateway-task.html)」を参照してください。 ### `get-wireless-gateway` 次のコード例は、`get-wireless-gateway` を使用する方法を示しています。 **AWS CLI** **ワイヤレスゲートウェイに関する情報を取得するには** 次の `get-wireless-gateway` の例では、ワイヤレスゲートウェイ `myFirstLoRaWANGateway` に関する情報を取得します。 ``` aws iotwireless get-wireless-gateway \ --identifier "12345678-a1b2-3c45-67d8-e90fa1b2c34d" \ --identifier-type WirelessGatewayId ``` 出力: ``` { "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" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN へのゲートウェイとデバイスの接続](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetWirelessGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/get-wireless-gateway.html)」を参照してください。 ### `list-destinations` 次のコード例は、`list-destinations` を使用する方法を示しています。 **AWS CLI** **ワイヤレス送信先を一覧表示するには** 次の `list-destinations` の例では、AWS アカウントに登録されている使用可能な送信先を一覧表示します。 ``` aws iotwireless list-destinations ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN に送信先を追加する](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-create-destinations.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDestinations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/list-destinations.html)」を参照してください。 ### `list-device-profiles` 次のコード例は、`list-device-profiles` を使用する方法を示しています。 **AWS CLI** **デバイスプロファイルを一覧表示するには** 次の `list-device-profiles` の例では、AWS アカウントに登録されている使用可能なデバイスプロファイルを一覧表示します。 ``` aws iotwireless list-device-profiles ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[プロファイルを AWS IoT Core for LoRaWAN に追加する](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-define-profiles.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDeviceProfiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/list-device-profiles.html)」を参照してください。 ### `list-partner-accounts` 次のコード例は、`list-partner-accounts` を使用する方法を示しています。 **AWS CLI** **パートナーアカウントを一覧表示するには** 次の `list-partner-accounts` の例では、AWS アカウントに関連付けられている使用可能なパートナーアカウントを一覧表示します。 ``` aws iotwireless list-partner-accounts ``` 出力: ``` { "Sidewalk": [ { "AmazonId": "78965678771228", "Fingerprint": "bd96d8ef66dbfd2160eb60e156849e82ad7018b8b73c1ba0b4fc65c32498ee35" }, { "AmazonId": "89656787651228", "Fingerprint": "bc5e99e151c07be14be7e6603e4489c53f858b271213a36ebe3370777ba06e9b" } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[Amazon Sidewalk Integration for AWS IoT Core](https://docs.aws.amazon.com/iot/latest/developerguide/iot-sidewalk.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPartnerAccounts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/list-partner-accounts.html)」を参照してください。 ### `list-service-profiles` 次のコード例は、`list-service-profiles` を使用する方法を示しています。 **AWS CLI** **サービスプロファイルを一覧表示するには** 次の `list-service-profiles` の例では、AWS アカウントに登録されている使用可能なサービスプロファイルを一覧表示します。 ``` aws iotwireless list-service-profiles ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[プロファイルを AWS IoT Core for LoRaWAN に追加する](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-define-profiles.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListServiceProfiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/list-service-profiles.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **リソースに割り当てられたタグを一覧表示するには** 次の `list-tags-for-resource` の例では、ワイヤレス送信先リソースに割り当てられたタグを一覧表示します。 ``` aws iotwireless list-tags-for-resource \ --resource-arn "arn:aws:iotwireless:us-east-1:123456789012:Destination/IoTWirelessDestination" ``` 出力: ``` { "Tags": [ { "Value": "MyValue", "Key": "MyTag" } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN リソースを説明する](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-describe-resource.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/list-tags-for-resource.html)」を参照してください。 ### `list-wireless-devices` 次のコード例は、`list-wireless-devices` を使用する方法を示しています。 **AWS CLI** **使用可能なワイヤレスデバイスを一覧表示するには** 次の `list-wireless-devices` の例では、AWS アカウントに登録されている使用可能なワイヤレスデバイスを一覧表示します。 ``` aws iotwireless list-wireless-devices ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN へのゲートウェイとデバイスの接続](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListWirelessDevices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/list-wireless-devices.html)」を参照してください。 ### `list-wireless-gateway-task-definitions` 次のコード例は、`list-wireless-gateway-task-definitions` を使用する方法を示しています。 **AWS CLI** **ワイヤレスゲートウェイタスク定義を一覧表示するには** 次の `list-wireless-gateway-task-definitions` の例では、AWS アカウントに登録されている使用可能なワイヤレスゲートウェイタスク定義を一覧表示します。 ``` aws iotwireless list-wireless-gateway-task-definitions ``` 出力: ``` { "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" } } } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN へのゲートウェイとデバイスの接続](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListWirelessGatewayTaskDefinitions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/list-wireless-gateway-task-definitions.html)」を参照してください。 ### `list-wireless-gateways` 次のコード例は、`list-wireless-gateways` を使用する方法を示しています。 **AWS CLI** **ワイヤレスゲートウェイを一覧表示するには** 次の `list-wireless-gateways` の例では、AWS アカウントで使用可能なワイヤレスゲートウェイを一覧表示します。 ``` aws iotwireless list-wireless-gateways ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN へのゲートウェイとデバイスの接続](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListWirelessGateways](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/list-wireless-gateways.html)」を参照してください。 ### `send-data-to-wireless-device` 次のコード例は、`send-data-to-wireless-device` を使用する方法を示しています。 **AWS CLI** **ワイヤレスデバイスにデータを送信するには** 次の `send-data-to-wireless-device` の例では、復号されたアプリケーションデータフレームをワイヤレスデバイスに送信します。 ``` aws iotwireless send-data-to-wireless-device \ --id "11aa5eae-2f56-4b8e-a023-b28d98494e49" \ --transmit-mode "1" \ --payload-data "SGVsbG8gVG8gRGV2c2lt" \ --wireless-metadata LoRaWAN={FPort=1} ``` 出力: ``` { MessageId: "6011dd36-0043d6eb-0072-0008" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN へのゲートウェイとデバイスの接続](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SendDataToWirelessDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/send-data-to-wireless-device.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **リソースのタグキーと値を指定するには** 次の `tag-resource` の例では、ワイヤレス送信先 `IoTWirelessDestination` にキー `MyTag` と値 `MyValue` でタグ付けします。 ``` aws iotwireless tag-resource \ --resource-arn "arn:aws:iotwireless:us-east-1:651419225604:Destination/IoTWirelessDestination" \ --tags Key="MyTag",Value="MyValue" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN リソースを説明する](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-describe-resource.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/tag-resource.html)」を参照してください。 ### `test-wireless-device` 次のコード例は、`test-wireless-device` を使用する方法を示しています。 **AWS CLI** **ワイヤレスデバイスをテストするには** 次の `test-wireless-device` の例では、`Hello` のアップリンクデータを、指定された ID を持つデバイスに送信します。 ``` aws iotwireless test-wireless-device \ --id "11aa5eae-2f56-4b8e-a023-b28d98494e49" ``` 出力: ``` { Result: "Test succeeded. one message is sent with payload: hello" } ``` 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN へのゲートウェイとデバイスの接続](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TestWirelessDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/test-wireless-device.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **リソースから 1 つ以上のタグを削除するには** 次の `untag-resource` の例では、ワイヤレス送信先 `IoTWirelessDestination` からタグ `MyTag` とその値を削除します。 ``` aws iotwireless untag-resource \ --resource-arn "arn:aws:iotwireless:us-east-1:123456789012:Destination/IoTWirelessDestination" \ --tag-keys "MyTag" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN リソースを説明する](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-describe-resource.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/untag-resource.html)」を参照してください。 ### `update-destination` 次のコード例は、`update-destination` を使用する方法を示しています。 **AWS CLI** **送信先のプロパティを更新するには** 次の `update-destination` の例では、ワイヤレス送信先の説明プロパティを更新します。 ``` aws iotwireless update-destination \ --name "IoTWirelessDestination" \ --description "Destination for messages processed using IoTWirelessRule" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN に送信先を追加する](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan-create-destinations.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateDestination](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/update-destination.html)」を参照してください。 ### `update-partner-account` 次のコード例は、`update-partner-account` を使用する方法を示しています。 **AWS CLI** **パートナーアカウントのプロパティを更新するには** 次の `update-partner-account` は、指定された ID を持つアカウントの `AppServerPrivateKey` を更新します。 ``` aws iotwireless update-partner-account \ --partner-account-id "78965678771228" \ --partner-type "Sidewalk" \ --sidewalk AppServerPrivateKey="f798ab4899346a88599180fee9e14fa1ada7b6df989425b7c6d2146dd6c815bb" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[Amazon Sidewalk Integration for AWS IoT Core](https://docs.aws.amazon.com/iot/latest/developerguide/iot-sidewalk.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdatePartnerAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/update-partner-account.html)」を参照してください。 ### `update-wireless-device` 次のコード例は、`update-wireless-device` を使用する方法を示しています。 **AWS CLI** **ワイヤレスデバイスのプロパティを更新するには** 次の `update-wireless-device` の例では、AWS アカウントに登録されているワイヤレスデバイスのプロパティを更新します。 ``` aws iotwireless update-wireless-device \ --id "1ffd32c8-8130-4194-96df-622f072a315f" \ --destination-name IoTWirelessDestination2 \ --description "Using my first LoRaWAN device" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN へのゲートウェイとデバイスの接続](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateWirelessDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/update-wireless-device.html)」を参照してください。 ### `update-wireless-gateway` 次のコード例は、`update-wireless-gateway` を使用する方法を示しています。 **AWS CLI** **ワイヤレスゲートウェイを更新するには** 次の `update-wireless-gateway` の例では、ワイヤレスゲートウェイの説明を更新します。 ``` aws iotwireless update-wireless-gateway \ --id "3285bdc7-5a12-4991-84ed-dadca65e342e" \ --description "Using my LoRaWAN gateway" ``` このコマンドでは何も出力されません。 詳細については、「*AWS IoT デベロッパーガイド*」の「[AWS IoT Core for LoRaWAN へのゲートウェイとデバイスの接続](https://docs.aws.amazon.com/iot/latest/developerguide/connect-iot-lorawan.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateWirelessGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/iotwireless/update-wireless-gateway.html)」を参照してください。 # Amazon IVS examples using AWS CLI 次のコード例は、Amazon IVS で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `batch-get-channel` 次のコード例は、`batch-get-channel` を使用する方法を示しています。 **AWS CLI** **複数のチャネルに関するチャネル設定情報を取得するには** 次の `batch-get-channel` の例では、指定されたチャネルに関する情報を一覧表示します。 ``` aws ivs batch-get-channel \ --arns arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \ arn:aws:ivs:us-west-2:123456789012:channel/efghEFGHijkl ``` 出力: ``` { "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" } ] } ``` 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[チャネルの作成](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchGetChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/batch-get-channel.html)」を参照してください。 ### `batch-get-stream-key` 次のコード例は、`batch-get-stream-key` を使用する方法を示しています。 **AWS CLI** **複数のストリームキーに関する情報を取得するには** 次の `batch-get-stream-key` の例では、指定されたストリームキーに関する情報を取得します。 ``` 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 ``` 出力: ``` { "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": {} } ] } ``` 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[チャネルの作成](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchGetStreamKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/batch-get-stream-key.html)」を参照してください。 ### `batch-start-viewer-session-revocation` 次のコード例は、`batch-start-viewer-session-revocation` を使用する方法を示しています。 **AWS CLI** **複数の channel-ARN と viewer-ID のペアのビューワーセッションを取り消すには** 次の `batch-start-viewer-session-revocation` の例では、複数のチャネル ARN とビューワー ID のペアに対してセッションの取り消しを同時に実行します。発信者に指定されたセッションを取り消すアクセス許可がない場合は、リクエストは正常に完了しても、エラーフィールドで値が返されることがあります。 ``` 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}]' ``` 出力: ``` { "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", } ] } ``` 詳細については、*Amazon Interactive Video Service ユーザーガイド*の「[プライベートチャネルの設定](https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchStartViewerSessionRevocation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/batch-start-viewer-session-revocation.html)」を参照してください。 ### `create-channel` 次のコード例は、`create-channel` を使用する方法を示しています。 **AWS CLI** **例 1: 録画なしでチャネルを作成するには** 次の `create-channel` の例では、新しいチャネルとストリーミングを開始するための関連ストリームキーを作成します。 ``` aws ivs create-channel \ --name 'test-channel' \ --no-insecure-ingest ``` 出力: ``` { "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": {} } } ``` 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[チャネルの作成](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)」を参照してください。 **例 2: ARN で指定された RecordingConfiguration リソースを使用して、録画を有効にしたチャネルを作成するには** 次の `create-channel` の例では、新しいチャネルとストリーミングを開始するための関連ストリームキーを作成し、チャネルの録画を設定します。 ``` aws ivs create-channel \ --name test-channel-with-recording \ --insecure-ingest \ --recording-configuration-arn 'arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh' ``` 出力: ``` { "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": {} } } ``` 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[Amazon S3 に記録](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html)」を参照してください。 **例 3: ARN で指定された再生制限ポリシーを使用してチャネルを作成するには** 次の `create-channel` の例では、新しいチャネルとストリーミングを開始するための関連ストリームキーを作成し、チャネルの再生制限ポリシーを設定します。 ``` 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' ``` 出力: ``` { "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": {} } } ``` 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[望ましくないコンテンツと視聴者](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html)」を参照してください。 **例 4: マルチトラックを有効にしてチャネルを作成するには** 次の `create-channel` の例では、新しいチャネルと関連ストリームキーを作成してストリーミングを開始し、マルチトラックを有効にします。 ``` aws ivs create-channel \ --name 'test-channel' \ --no-insecure-ingest \ --container-format 'FRAGMENTED_MP4' \ --multitrack-input-configuration '{"enabled": true,"maximumResolution": "FULL_HD","policy": "ALLOW"}' ``` 出力: ``` { "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": {} } } ``` 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[チャネルの作成](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multitrack-video.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/create-channel.html)」を参照してください。 ### `create-playback-restriction-policy` 次のコード例は、`create-playback-restriction-policy` を使用する方法を示しています。 **AWS CLI** **再生制限ポリシーを作成するには** 次の `create-playback-restriction-policy` の例では、新しい再生制限ポリシーを作成します。 ``` 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 ``` 出力: ``` { "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" } } } ``` 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[望ましくないコンテンツと視聴者](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreatePlaybackRestrictionPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/create-playback-restriction-policy.html)」を参照してください。 ### `create-recording-configuration` 次のコード例は、`create-recording-configuration` を使用する方法を示しています。 **AWS CLI** **RecordingConfiguration リソースを作成するには** 次の `create-recording-configuration` の例では、Amazon S3 への録画を有効にする RecordingConfiguration リソースを作成します。 ``` 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} ``` 出力: ``` { "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" ] } } } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon S3 に記録](https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateRecordingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/create-recording-configuration.html)」を参照してください。 ### `create-stream-key` 次のコード例は、`create-stream-key` を使用する方法を示しています。 **AWS CLI** **ストリームキーを作成するには** 次の `create-stream-key` の例では、指定された ARN (Amazon リソースネーム) のストリームキーを作成します。 ``` aws ivs create-stream-key \ --channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh ``` 出力: ``` { "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": {} } } ``` 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[チャネルの作成](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateStreamKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/create-stream-key.html)」を参照してください。 ### `delete-channel` 次のコード例は、`delete-channel` を使用する方法を示しています。 **AWS CLI** **チャネルとその関連ストリームキーを削除するには** 次の `delete-channel` の例では、指定された ARN (Amazon リソースネーム) を持つチャネルを削除します。 ``` aws ivs delete-channel \ --arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh ``` このコマンドは何も出力しません。 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[チャネルの作成](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/delete-channel.html)」を参照してください。 ### `delete-playback-key-pair` 次のコード例は、`delete-playback-key-pair` を使用する方法を示しています。 **AWS CLI** **指定された再生キーペアを削除するには** 次の `delete-playback-key-pair` の例では、指定されたキーペアのフィンガープリントを返します。 ``` aws ivs delete-playback-key-pair \ --arn arn:aws:ivs:us-west-2:123456789012:playback-key/abcd1234efgh ``` このコマンドは何も出力しません。 詳細については、*Amazon Interactive Video Service ユーザーガイド*の「[プライベートチャネルの設定](https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeletePlaybackKeyPair](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/delete-playback-key-pair.html)」を参照してください。 ### `delete-playback-restriction-policy` 次のコード例は、`delete-playback-restriction-policy` を使用する方法を示しています。 **AWS CLI** **再生制限ポリシーを削除するには** 次の `delete-playback-restriction-policy` の例では、指定されたポリシー ARN (Amazon リソースネーム) を持つ再生制限ポリシーを削除します。 ``` aws ivs delete-playback-restriction-policy \ --arn "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ" ``` このコマンドは何も出力しません。 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[望ましくないコンテンツと視聴者](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeletePlaybackRestrictionPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/delete-playback-restriction-policy.html)」を参照してください。 ### `delete-recording-configuration` 次のコード例は、`delete-recording-configuration` を使用する方法を示しています。 **AWS CLI** **ARN で指定された RecordingConfiguration リソースを削除するには** 次の `delete-recording-configuration` の例では、指定された ARN を持つ RecordingConfiguration リソースを削除します。 ``` aws ivs delete-recording-configuration \ --arn "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ" ``` このコマンドは何も出力しません。 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon S3 に記録](https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRecordingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/delete-recording-configuration.html)」を参照してください。 ### `delete-stream-key` 次のコード例は、`delete-stream-key` を使用する方法を示しています。 **AWS CLI** **ストリームキーを削除するには** 次の `delete-stream-key` の例では、指定された ARN (Amazon リソースネーム) のストリームキーを削除して、ストリーミングに使用できないようにします。 ``` aws ivs delete-stream-key \ --arn arn:aws:ivs:us-west-2:123456789012:stream-key/g1H2I3j4k5L6 ``` このコマンドは何も出力しません。 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[チャネルの作成](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteStreamKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/delete-stream-key.html)」を参照してください。 ### `get-channel` 次のコード例は、`get-channel` を使用する方法を示しています。 **AWS CLI** **チャネルの設定情報を取得するには** 次の `get-channel` の例では、指定されたチャネル ARN (Amazon リソースネーム) のチャネル設定を取得します。 ``` aws ivs get-channel \ --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' ``` 出力: ``` { "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", } } ``` 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[チャネルの作成](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/get-channel.html)」を参照してください。 ### `get-playback-key-pair` 次のコード例は、`get-playback-key-pair` を使用する方法を示しています。 **AWS CLI** **指定された再生キーペアを取得するには** 次の `get-playback-key-pair` の例では、指定されたキーペアのフィンガープリントを返します。 ``` aws ivs get-playback-key-pair \ --arn arn:aws:ivs:us-west-2:123456789012:playback-key/abcd1234efgh ``` 出力: ``` { "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": {} } } ``` 詳細については、*Amazon Interactive Video Service ユーザーガイド*の「[プライベートチャネルの設定](https://docs.aws.amazon.com/ivs/latest/userguide//private-channels.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPlaybackKeyPair](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/get-playback-key-pair.html)」を参照してください。 ### `get-playback-restriction-policy` 次のコード例は、`get-playback-restriction-policy` を使用する方法を示しています。 **AWS CLI** **再生制限ポリシーの設定情報を取得するには** 次の `get-playback-restriction-policy` の例では、指定されたポリシー ARN (Amazon リソースネーム) を持つ再生制限ポリシーの設定を取得します。 ``` aws ivs get-playback-restriction-policy \ --arn "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ" ``` 出力: ``` { "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" } } } ``` 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[望ましくないコンテンツと視聴者](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPlaybackRestrictionPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/get-playback-restriction-policy.html)」を参照してください。 ### `get-recording-configuration` 次のコード例は、`get-recording-configuration` を使用する方法を示しています。 **AWS CLI** **RecordingConfiguration リソースに関する情報を取得するには** 次の `get-recording-configuration` の例では、指定された ARN の RecordingConfiguration リソースに関する情報を取得します。 ``` aws ivs get-recording-configuration \ --arn "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABcdef34ghIJ" ``` 出力: ``` { "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" ] } } } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon S3 に記録](https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRecordingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/get-recording-configuration.html)」を参照してください。 ### `get-stream-key` 次のコード例は、`get-stream-key` を使用する方法を示しています。 **AWS CLI** **ストリームに関する情報を取得するには** 次の `get-stream-key` の例では、指定されたストリームキーに関する情報を取得します。 ``` aws ivs get-stream-key \ --arn arn:aws:ivs:us-west-2:123456789012:stream-key/skSKABCDefgh --region=us-west-2 ``` 出力: ``` { "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": {} } } ``` 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[チャネルの作成](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetStreamKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/get-stream-key.html)」を参照してください。 ### `get-stream-session` 次のコード例は、`get-stream-session` を使用する方法を示しています。 **AWS CLI** **指定されたストリームのメタデータを取得するには** 次の `get-stream-session` の例では、指定されたチャネル ARN (Amazon リソースネーム) と指定されたストリームのメタデータ設定を取得します。`streamId` が指定されていない場合、チャネルの最新のストリームが選択されます。 ``` aws ivs get-stream-session \ --channel-arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \ --stream-id 'mystream' ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[チャネルの作成](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetStreamSession](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/get-stream-session.html)」を参照してください。 ### `get-stream` 次のコード例は、`get-stream` を使用する方法を示しています。 **AWS CLI** **ストリームに関する情報を取得するには** 次の `get-stream` の例では、指定されたチャネルのストリームに関する情報を取得します。 ``` aws ivs get-stream \ --channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh ``` 出力: ``` { "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 } } ``` 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[チャネルの作成](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/get-stream.html)」を参照してください。 ### `import-playback-key-pair` 次のコード例は、`import-playback-key-pair` を使用する方法を示しています。 **AWS CLI** **新しいキーペアのパブリック部分をインポートするには** 次の `import-playback-key-pair` の例では、指定されたパブリックキー (PEM 形式の文字列として指定) をインポートし、新しいキーペアの arn とフィンガープリントを返します。 ``` aws ivs import-playback-key-pair \ --name "my-playback-key" \ --public-key-material "G1lbnQxOTA3BgNVBAMMMFdoeSBhcmUgeW91IGRl..." ``` 出力: ``` { "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": {} } } ``` 詳細については、*Amazon Interactive Video Service ユーザーガイド*の「[プライベートチャネルの設定](https://docs.aws.amazon.com/ivs/latest/userguide//private-channels.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ImportPlaybackKeyPair](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/import-playback-key-pair.html)」を参照してください。 ### `list-channels` 次のコード例は、`list-channels` を使用する方法を示しています。 **AWS CLI** **例 1: すべてのチャネルに関する概要情報を取得するには** 次の `list-channels` の例では、AWS アカウントのすべてのチャネルを一覧表示します。 ``` aws ivs list-channels ``` 出力: ``` { "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" } ] } ``` 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[チャネルの作成](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)」を参照してください。 **例 2: すべてのチャネルに関する概要情報を、指定された RecordingConfiguration ARN でフィルタリングして取得するには** 次の `list-channels` の例では、指定された RecordingConfiguration ARN に関連付けられている、AWS アカウントのすべてのチャネルを一覧表示します。 ``` aws ivs list-channels \ --filter-by-recording-configuration-arn "arn:aws:ivs:us-west-2:123456789012:recording-configuration/ABCD12cdEFgh" ``` 出力: ``` { "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" } ] } ``` 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[Amazon S3 に記録](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html)」を参照してください。 **例 3: すべてのチャネルに関する概要情報を、指定された PlaybackRestrictionPolicy ARN でフィルタリングして取得するには** 次の `list-channels` の例では、指定された PlaybackRestrictionPolicy ARN に関連付けられている、AWS アカウントのすべてのチャネルを一覧表示します。 ``` aws ivs list-channels \ --filter-by-playback-restriction-policy-arn "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ" ``` 出力: ``` { "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" } ] } ``` 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[望ましくないコンテンツと視聴者](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[ListChannels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-channels.html)」を参照してください。** ### `list-playback-key-pairs` 次のコード例は、`list-playback-key-pairs` を使用する方法を示しています。 **AWS CLI** **すべての再生キーペアに関する概要情報を取得するには** 次の `list-playback-key-pairs` の例では、すべてのキーペアに関する情報を返します。 ``` aws ivs list-playback-key-pairs ``` 出力: ``` { "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": {} } ] } ``` 詳細については、*Amazon Interactive Video Service ユーザーガイド*の「[プライベートチャネルの設定](https://docs.aws.amazon.com/ivs/latest/userguide//private-channels.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPlaybackKeyPairs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-playback-key-pairs.html)」を参照してください。 ### `list-playback-restriction-policies` 次のコード例は、`list-playback-restriction-policies` を使用する方法を示しています。 **AWS CLI** **すべての再生制限ポリシーに関する概要情報を取得するには** 次の `list-playback-restriction-policies` の例では、AWS アカウントのすべての再生制限ポリシーを一覧表示します。 ``` aws ivs list-playback-restriction-policies ``` 出力: ``` { "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" } } ] } ``` 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[望ましくないコンテンツと視聴者](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPlaybackRestrictionPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-playback-restriction-policies.html)」を参照してください。 ### `list-recording-configurations` 次のコード例は、`list-recording-configurations` を使用する方法を示しています。 **AWS CLI** **このアカウントで作成されたすべての RecordingConfiguration リソースを一覧表示するには** 次の `list-recording-configurations` の例では、アカウント内のすべての RecordingConfiguration リソースに関する情報を取得します。 ``` aws ivs list-recording-configurations ``` 出力: ``` { "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": {} } ] } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon S3 に記録](https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRecordingConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-recording-configurations.html)」を参照してください。 ### `list-stream-keys` 次のコード例は、`list-stream-keys` を使用する方法を示しています。 **AWS CLI** **ストリームキーのリストを取得するには** 次の `list-stream-keys` の例では、指定された ARN (Amazon リソースネーム) のすべてのストリームキーを一覧表示します。 ``` aws ivs list-stream-keys \ --channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh ``` 出力: ``` { "streamKeys": [ { "arn": "arn:aws:ivs:us-west-2:123456789012:stream-key/abcdABCDefgh", "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "tags": {} } ] } ``` 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[チャネルの作成](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListStreamKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-stream-keys.html)」を参照してください。 ### `list-stream-sessions` 次のコード例は、`list-stream-sessions` を使用する方法を示しています。 **AWS CLI** **現在の AWS リージョンにおける指定されたチャネルの現在および以前のストリームの概要を取得するには** 次の `list-stream-sessions` の例では、指定されたチャネル ARN (Amazon リソースネーム) のストリームの概要情報をレポートします。 ``` aws ivs list-stream-sessions \ --channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \ --max-results 25 \ --next-token "" ``` 出力: ``` { "nextToken": "set-2", "streamSessions": [ { "startTime": 1641578182, "endTime": 1641579982, "hasErrorEvent": false, "streamId": "mystream" } ... ] } ``` 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[チャネルの作成](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListStreamSessions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-stream-sessions.html)」を参照してください。 ### `list-streams` 次のコード例は、`list-streams` を使用する方法を示しています。 **AWS CLI** **ライブストリームとその状態のリストを取得するには** 次の `list-streams` の例では、AWS アカウントのすべてのライブストリームを一覧表示します。 ``` aws ivs list-streams ``` 出力: ``` { "streams": [ { "channelArn": "arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh", "state": "LIVE", "health": "HEALTHY", "streamId": "st-ABCDEfghij01234KLMN5678", "viewerCount": 1 } ] } ``` 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[チャネルの作成](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[ListStreams](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-streams.html)」を参照してください。** ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **AWS リソース (チャネル、ストリームキーなど) のすべてのタグを一覧表示するには** 次の `list-tags-for-resource` の例では、指定されたリソース ARN (Amazon リソースネーム) のすべてのタグを一覧表示します。 ``` aws ivs list-tags-for-resource \ --resource-arn arn:aws:ivs:us-west-2:12345689012:channel/abcdABCDefgh ``` 出力: ``` { "tags": { "key1": "value1", "key2": "value2" } } ``` 詳細については、「*Amazon Interactive Video Service API リファレンス*」の「[Tagging](https://docs.aws.amazon.com/ivs/latest/APIReference/Welcome.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/list-tags-for-resource.html)」を参照してください。 ### `put-metadata` 次のコード例は、`put-metadata` を使用する方法を示しています。 **AWS CLI** **指定されたチャネルのアクティブなストリームにメタデータを挿入するには** 次の `put-metadata` の例では、指定されたメタデータを、指定されたチャネルのストリームに挿入します。 ``` aws ivs put-metadata \ --channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \ --metadata '{"my": "metadata"}' ``` このコマンドは何も出力しません。 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[チャネルの作成](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/put-metadata.html)」を参照してください。 ### `start-viewer-session-revocation` 次のコード例は、`start-viewer-session-revocation` を使用する方法を示しています。 **AWS CLI** **特定の複数の channel-ARN と viewer-ID ペアのビューワーセッションを取り消すには** 次の `start-viewer-session-revocation` の例では、指定されたチャネル ARN とビューワー ID に関連付けられたビューワーセッションのうち、指定されたセッションバージョン番号以下のものを取り消すプロセスを開始します。バージョンが指定されていない場合は、デフォルトで 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 ``` このコマンドは何も出力しません。 詳細については、*Amazon Interactive Video Service ユーザーガイド*の「[プライベートチャネルの設定](https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartViewerSessionRevocation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/start-viewer-session-revocation.html)」を参照してください。 ### `stop-stream` 次のコード例は、`stop-stream` を使用する方法を示しています。 **AWS CLI** **指定されたストリームを停止するには** 次の `stop-stream` の例では、指定されたチャネルのストリームを停止します。 ``` aws ivs stop-stream \ --channel-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh ``` このコマンドは何も出力しません。 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[チャネルの作成](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/stop-stream.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **AWS リソース (チャネル、ストリームキーなど) のタグを追加または更新するには** 次の `tag-resource` の例では、指定されたリソース ARN (Amazon リソースネーム) のタグを追加または更新します。 ``` aws ivs tag-resource \ --resource-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \ --tags "tagkey1=tagvalue1, tagkey2=tagvalue2" ``` このコマンドは何も出力しません。 詳細については、「*Amazon Interactive Video Service API リファレンス*」の「[Tagging](https://docs.aws.amazon.com/ivs/latest/APIReference/Welcome.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **AWS リソースのタグ (チャンル、ストリームキーなど) を削除するには** 次の `untag-resource` の例では、指定されたリソース ARN (Amazon リソースネーム) の指定されたタグを削除します。 ``` aws ivs untag-resource \ --resource-arn arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh \ --tag-keys "tagkey1, tagkey2" ``` このコマンドは何も出力しません。 詳細については、「*Amazon Interactive Video Service API リファレンス*」の「[Tagging](https://docs.aws.amazon.com/ivs/latest/APIReference/Welcome.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/untag-resource.html)」を参照してください。 ### `update-channel` 次のコード例は、`update-channel` を使用する方法を示しています。 **AWS CLI** **例 1: チャネルの設定情報を更新するには** 次の `update-channel` の例では、指定されたチャネル ARN のチャネル設定を更新して、チャネル名を変更します。これは、このチャネルの進行中のストリームには影響しません。変更を有効にするには、ストリームを停止して再開する必要があります。 ``` aws ivs update-channel \ --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \ --name 'channel-1' \ --insecure-ingest ``` 出力: ``` { "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": {} } ``` 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[チャネルの作成](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/getting-started-create-channel.html)」を参照してください。 **例 2: チャネルの設定を更新して録画を有効にするには** 次の `update-channel` の例では、指定されたチャネル ARN のチャネル設定を更新して、録画を有効にします。これは、このチャネルの進行中のストリームには影響しません。変更を有効にするには、ストリームを停止して再開する必要があります。 ``` 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' ``` 出力: ``` { "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": {} } } ``` 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[Amazon S3 に記録](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html)」を参照してください。 **例 3: チャネルの設定を更新して録画を無効にするには** 次の `update-channel` の例では、指定されたチャネル ARN のチャネル設定を更新して、録画を無効にします。これは、このチャネルの進行中のストリームには影響しません。変更を有効にするには、ストリームを停止して再開する必要があります。 ``` aws ivs update-channel \ --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \ --recording-configuration-arn '' ``` 出力: ``` { "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": {} } } ``` 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[Amazon S3 に記録](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html)」を参照してください。 **例 4: チャネルの設定を更新して再生制限を有効にするには** 次の `update-channel` の例では、指定されたチャネル ARN のチャネル設定を更新して、再生制限ポリシーを適用します。これは、このチャネルの進行中のストリームには影響しません。変更を有効にするには、ストリームを停止して再開する必要があります。 ``` 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' ``` 出力: ``` { "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": {} } } ``` 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[望ましくないコンテンツと視聴者](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html)」を参照してください。 **例 5: チャネルの設定を更新して再生制限を無効にするには** 次の `update-channel` の例では、指定されたチャネル ARN のチャネル設定を更新して、再生制限を無効にします。これは、このチャネルの進行中のストリームには影響しません。変更を有効にするには、ストリームを停止して再開する必要があります。 ``` aws ivs update-channel \ --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \ --playback-restriction-policy-arn '' ``` 出力: ``` { "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": {} } } ``` 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[望ましくないコンテンツと視聴者](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html)」を参照してください。 **例 6: チャネルの設定を更新してマルチトラックを有効にするには** 次の `update-channel` の例では、指定されたチャネル ARN のチャネル設定を更新して、マルチトラックを有効にします。これは、このチャネルの進行中のストリームには影響しません。変更を有効にするには、ストリームを停止して再開する必要があります。 ``` 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"}' ``` 出力: ``` { "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": {} } } ``` 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[望ましくないコンテンツと視聴者](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multitrack-video.html)」を参照してください。 **例 7: チャネルの設定を更新して再生制限を無効にするには** 次の `update-channel` の例では、指定されたチャネル ARN のチャネル設定を更新して、マルチトラックを無効にします。これは、このチャネルの進行中のストリームには影響しません。変更を有効にするには、ストリームを停止して再開する必要があります。 ``` aws ivs update-channel \ --arn 'arn:aws:ivs:us-west-2:123456789012:channel/abcdABCDefgh' \ --container-format 'TS' \ --multitrack-input-configuration '{"enabled": false}' ``` 出力: ``` { "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": {} } } ``` 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[望ましくないコンテンツと視聴者](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multitrack-video.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/update-channel.html)」を参照してください。 ### `update-playback-restriction-policy` 次のコード例は、`update-playback-restriction-policy` を使用する方法を示しています。 **AWS CLI** **再生制限ポリシーを更新するには** 次の `update-playback-restriction-policy` の例では、指定されたポリシー ARN を持つ再生制限ポリシーを更新して、厳格なオリジン強制を無効にします。これは、関連付けられたチャネルの進行中のストリームには影響しません。変更を有効にするには、ストリームを停止して再開する必要があります。 ``` aws ivs update-playback-restriction-policy \ --arn "arn:aws:ivs:us-west-2:123456789012:playback-restriction-policy/ABcdef34ghIJ" \ --no-enable-strict-origin-enforcement ``` 出力: ``` { "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" } } } ``` 詳細については、「*IVS Low-Latency ユーザーガイド*」の「[望ましくないコンテンツと視聴者](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/undesired-content.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdatePlaybackRestrictionPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs/update-playback-restriction-policy.html)」を参照してください。 # Amazon IVS Chat examples using AWS CLI 次のコード例は、Amazon IVS Chat で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-chat-token` 次のコード例は、`create-chat-token` を使用する方法を示しています。 **AWS CLI** **チャットトークンを作成するには** 次の `create-chat-token` の例では、ルームへの個々の WebSocket 接続の確立に使用される暗号化されたチャットトークンを作成します。トークンは 1 分間有効であり、トークンで確立された接続 (セッション) は指定された期間有効です。 ``` aws ivschat create-chat-token \ --roomIdentifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6", \ --userId" "11231234" \ --capabilities "SEND_MESSAGE", \ --sessionDurationInMinutes" 30 ``` 出力: ``` { "token": "ACEGmnoq#1rstu2...BDFH3vxwy!4hlm!#5", "sessionExpirationTime": "2022-03-16T04:44:09+00:00" "state": "CREATING", "tokenExpirationTime": "2022-03-16T03:45:09+00:00" } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[ステップ 3: チャットクライアントの認証と認可](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateChatToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/create-chat-token.html)」を参照してください。 ### `create-logging-configuration` 次のコード例は、`create-logging-configuration` を使用する方法を示しています。 **AWS CLI** **チャットの LoggingConfiguration リソースを作成するには** 次の `create-logging-configuration` の例では、クライアントが送信されたメッセージを保存および記録できるようにする LoggingConfiguration リソースを作成します。 ``` aws ivschat create-logging-configuration \ --destination-configuration s3={bucketName=demo-logging-bucket} \ --name "test-logging-config" \ --tags "key1=value1, key2=value2" ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon IVS Chat の開始方法](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateLoggingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/create-logging-configuration.html)」を参照してください。 ### `create-room` 次のコード例は、`create-room` を使用する方法を示しています。 **AWS CLI** **ルームを作成するには** 次の `create-room` の例では、新しいルームを作成します。 ``` 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 ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[ステップ 2: チャットルームを作成する](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateRoom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/create-room.html)」を参照してください。 ### `delete-logging-configuration` 次のコード例は、`delete-logging-configuration` を使用する方法を示しています。 **AWS CLI** **チャットの LoggingConfiguration リソースを削除するには** 次の `delete-logging-configuration` の例では、指定された ARN の LoggingConfiguration リソースを削除します。 ``` aws ivschat delete-logging-configuration \ --identifier "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ" ``` このコマンドは何も出力しません。 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon IVS Chat の開始方法](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteLoggingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/delete-logging-configuration.html)」を参照してください。 ### `delete-message` 次のコード例は、`delete-message` を使用する方法を示しています。 **AWS CLI** **指定されたルームからメッセージを削除するには** 次の `delete-message` の例では、指定されたルームにイベントを送信し、指定されたメッセージを削除するようにクライアントに指示します。つまり、メッセージのレンダリング内容をビューから削除し、クライアントのチャット履歴からメッセージを削除します。 ``` aws ivschat delete-message \ --roomIdentifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \ --id "ABC123def456" \ --reason "Message contains profanity" ``` 出力: ``` { "id": "12345689012" } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon IVS Chat の開始方法](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[DeleteMessage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/delete-message.html)」を参照してください。** ### `delete-room` 次のコード例は、`delete-room` を使用する方法を示しています。 **AWS CLI** **ルームを削除するには** 次の `delete-room` の例では、指定されたルームを削除します。接続されているクライアントは切断されます。成功すると、レスポンスの本文が空の HTTP 204 が返されます。 ``` aws ivschat delete-room \ --identifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" ``` このコマンドは何も出力しません。 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon IVS Chat の開始方法](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRoom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/delete-room.html)」を参照してください。 ### `disconnect-user` 次のコード例は、`disconnect-user` を使用する方法を示しています。 **AWS CLI** **ルームからユーザーを切断するには** 次の `disconnect-user` の例では、指定されたユーザーのすべての接続を指定されたルームから切断します。成功すると、レスポンスの本文が空の HTTP 200 が返されます。 ``` aws ivschat disconnect-user \ --roomIdentifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" \ --userId "ABC123def456" \ --reason "Violated terms of service" ``` このコマンドは何も出力しません。 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon IVS Chat の開始方法](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisconnectUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/disconnect-user.html)」を参照してください。 ### `get-logging-configuration` 次のコード例は、`get-logging-configuration` を使用する方法を示しています。 **AWS CLI** **LoggingConfiguration リソースに関する情報を取得するには** 次の `get-logging-configuration` の例では、指定された ARN の LoggingConfiguration リソースに関する情報を取得します。 ``` aws ivschat get-logging-configuration \ --identifier "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ" ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon IVS Chat の開始方法](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetLoggingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/get-logging-configuration.html)」を参照してください。 ### `get-room` 次のコード例は、`get-room` を使用する方法を示しています。 **AWS CLI** **指定されたルームを取得するには** 次の `get-room` の例では、指定されたルームに関する情報を取得します。 ``` aws ivschat get-room \ --identifier "arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6" ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon IVS Chat の開始方法](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRoom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/get-room.html)」を参照してください。 ### `list-logging-configurations` 次のコード例は、`list-logging-configurations` を使用する方法を示しています。 **AWS CLI** **API リクエストが処理される AWS リージョン内のユーザーのすべてのログ記録設定に関する概要情報を取得するには** 次の `list-logging-configurations` の例では、API リクエストが処理される AWS リージョン内のユーザーのすべての LoggingConfiguration リソースに関する情報を一覧表示します。 ``` aws ivschat list-logging-configurations \ --max-results 2 \ --next-token "" ``` 出力: ``` { "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" } ... ] } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon IVS Chat の開始方法](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListLoggingConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/list-logging-configurations.html)」を参照してください。 ### `list-rooms` 次のコード例は、`list-rooms` を使用する方法を示しています。 **AWS CLI** **現在のリージョンのすべてのルームに関する概要情報を取得するには** 次の `list-rooms` の例では、リクエストが処理される AWS リージョン内のすべてのルームに関する概要情報を取得します。結果は updateTime の降順でソートされます。 ``` aws ivschat list-rooms \ --logging-configuration-identifier "arn:aws:ivschat:us-west-2:123456789012:logging-configuration/ABcdef34ghIJ" \ --max-results 10 \ --next-token "" ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon IVS Chat の開始方法](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRooms](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/list-rooms.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **AWS リソース (ルームなど) のすべてのタグを一覧表示するには** 次の `list-tags-for-resource` の例では、指定されたリソース ARN (Amazon リソースネーム) のすべてのタグを一覧表示します。 ``` aws ivschat list-tags-for-resource \ --resource-arn arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6 ``` 出力: ``` { "tags": { "key1": "value1", "key2": "value2" } } ``` 詳細については、「*Amazon Interactive Video Service API リファレンス*」の「[Tagging](https://docs.aws.amazon.com/ivs/latest/APIReference/Welcome.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/list-tags-for-resource.html)」を参照してください。 ### `send-event` 次のコード例は、`send-event` を使用する方法を示しています。 **AWS CLI** **イベントをルームに送信するには** 次の `send-event` の例では、指定されたイベントを指定されたルームに送信します。 ``` 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." ``` 出力: ``` { "id": "12345689012" } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon IVS Chat の開始方法](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SendEvent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/send-event.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **AWS リソース (ルームなど) のタグを追加または更新するには** 次の `tag-resource` の例では、指定されたリソース ARN (Amazon リソースネーム) のタグを追加または更新します。成功すると、レスポンスの本文が空の HTTP 200 が返されます。 ``` aws ivschat tag-resource \ --resource-arn arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6 \ --tags "tagkey1=tagkeyvalue1, tagkey2=tagkeyvalue2" ``` このコマンドは何も出力しません。 詳細については、「*Amazon Interactive Video Service API リファレンス*」の「[Tagging](https://docs.aws.amazon.com/ivs/latest/APIReference/Welcome.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **AWS リソース (ルームなど) のタグを削除するには** 次の `untag-resource` の例では、指定されたリソース ARN (Amazon リソースネーム) の指定されたタグを削除します。成功すると、レスポンスの本文が空の HTTP 200 が返されます。 ``` aws ivschat untag-resource \ --resource-arn arn:aws:ivschat:us-west-2:12345689012:room/g1H2I3j4k5L6 \ --tag-keys "tagkey1, tagkey2" ``` このコマンドは何も出力しません。 詳細については、「*Amazon Interactive Video Service API リファレンス*」の「[Tagging](https://docs.aws.amazon.com/ivs/latest/APIReference/Welcome.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/untag-resource.html)」を参照してください。 ### `update-logging-configuration` 次のコード例は、`update-logging-configuration` を使用する方法を示しています。 **AWS CLI** **ルームのログ記録設定を更新するには** 次の `update-logging-configuration` の例では、指定されたデータを使用して LoggingConfiguration リソースを更新します。 ``` 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" ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon IVS Chat の開始方法](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[UpdateLoggingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/update-logging-configuration.html)」を参照してください。 ### `update-room` 次のコード例は、`update-room` を使用する方法を示しています。 **AWS CLI** **ルームの設定を更新するには** 次の `update-room` の例では、指定されたデータを使用して、指定されたルームの設定を更新します。 ``` 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 ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon IVS Chat の開始方法](https://docs.aws.amazon.com/ivs/latest/userguide/getting-started-chat.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateRoom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivschat/update-room.html)」を参照してください。 # Amazon IVS Real-Time Streaming examples using AWS CLI 次のコード例は、Amazon IVS Real-Time Streaming で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-encoder-configuration` 次のコード例は、`create-encoder-configuration` を使用する方法を示しています。 **AWS CLI** **コンポジションエンコーダー設定を作成するには** 次の `create-encoder-configuration` の例では、指定されたプロパティを使用してコンポジションエンコーダー設定を作成します。 ``` aws ivs-realtime create-encoder-configuration \ --name test-ec --video bitrate=3500000,framerate=30.0,height=1080,width=1920 ``` 出力: ``` { "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 } } } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateEncoderConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/create-encoder-configuration.html)」を参照してください。 ### `create-ingest-configuration` 次のコード例は、`create-ingest-configuration` を使用する方法を示しています。 **AWS CLI** **取り込み設定を作成するには** 次の `create-ingest-configuration` の例では、RTMPS プロトコルを使用して取り込み設定を作成します。 ``` aws ivs-realtime create-ingest-configuration \ --name ingest1 \ --ingest-protocol rtmps ``` 出力: ``` { "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": {} } } ``` 詳細については、*Amazon Interactive Video Service ユーザーガイド*の「[IVS ストリーム取り込み \$1 リアルタイムストリーミング](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[CreateIngestConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/create-ingest-configuration.html)」を参照してください。 ### `create-participant-token` 次のコード例は、`create-participant-token` を使用する方法を示しています。 **AWS CLI** **ステージ参加者トークンを作成するには** 次の `create-participant-token` の例では、指定されたステージの参加者トークンを作成します。 ``` aws ivs-realtime create-participant-token \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --user-id bob ``` 出力: ``` { "participantToken": { "expirationTime": "2023-03-07T09:47:43+00:00", "participantId": "ABCDEfghij01234KLMN6789", "token": "abcd1234defg5678" } } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/userguide/multiple-hosts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateParticipantToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/create-participant-token.html)」を参照してください。 ### `create-stage` 次のコード例は、`create-stage` を使用する方法を示しています。 **AWS CLI** **例 1: ステージを作成するには** 次の `create-stage` の例では、指定されたユーザーのステージとステージ参加者トークンを作成します。 ``` aws ivs-realtime create-stage \ --name stage1 \ --participant-token-configurations userId=alice ``` 出力: ``` { "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": {} } } ``` 詳細については、「*Amazon IVS Low-Latency Streaming ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)」を参照してください。 **例 2: ステージを作成し、個々の参加者の録画を設定するには** 次の `create-stage` の例では、ステージを作成し、個々の参加者の録画を設定します。 ``` 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}}' ``` 出力: ``` { "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": {} } } ``` 詳細については、「*Amazon IVS Low-Latency Streaming ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)」を参照してください。 **例 3: ステージを作成し、サムネイルの記録が有効になっている個々の参加者の録画を設定するには** 次の `create-stage` の例では、ステージを作成し、サムネイルの記録が有効になっている個々の参加者の録画を設定します。 ``` 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}}' ``` 出力: ``` { "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": {} } } ``` 詳細については、「*Amazon IVS Low-Latency Streaming ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/create-stage.html)」を参照してください。 ### `create-storage-configuration` 次のコード例は、`create-storage-configuration` を使用する方法を示しています。 **AWS CLI** **コンポジションストレージ設定を作成するには** 次の `create-storage-configuration` の例では、指定されたプロパティを使用してコンポジションストレージ設定を作成します。 ``` aws ivs-realtime create-storage-configuration \ --name "test-sc" --s3 "bucketName=amzn-s3-demo-bucket" ``` 出力: ``` { "storageConfiguration": { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABabCDcdEFef", "name": "test-sc", "s3": { "bucketName": "amzn-s3-demo-bucket" }, "tags": {} } } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateStorageConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/create-storage-configuration.html)」を参照してください。 ### `delete-encoder-configuration` 次のコード例は、`delete-encoder-configuration` を使用する方法を示しています。 **AWS CLI** **コンポジションエンコーダー設定を削除するには** 次の `delete-encoder-configuration` は、指定の ARN (Amazon リソースネーム) で指定されたコンポジションエンコーダー設定を削除します。 ``` aws ivs-realtime delete-encoder-configuration \ --arn "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef" ``` このコマンドは何も出力しません。 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteEncoderConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/delete-encoder-configuration.html)」を参照してください。 ### `delete-ingest-configuration` 次のコード例は、`delete-ingest-configuration` を使用する方法を示しています。 **AWS CLI** **例 1: 非アクティブな取り込み設定を削除するには** 次の `delete-ingest-configuration` の例では、指定した取り込み設定 ARN (Amazon リソースネーム) の非アクティブな取り込み設定を削除します。 ``` aws ivs-realtime delete-ingest-configuration \ --arn arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234 ``` このコマンドでは何も出力されません。 詳細については、*Amazon Interactive Video Service ユーザーガイド*の「[IVS ストリーム取り込み \$1 リアルタイムストリーミング](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html)」を参照してください。 **例 2: アクティブな取り込み設定を強制的に削除するには** 次の `delete-ingest-configuration` の例では、指定した取り込み設定 ARN (Amazon リソースネーム) のアクティブな取り込み設定を強制的に削除します。 ``` aws ivs-realtime delete-ingest-configuration \ --arn arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234 \ --force ``` このコマンドでは何も出力されません。 詳細については、*Amazon Interactive Video Service ユーザーガイド*の「[IVS ストリーム取り込み \$1 リアルタイムストリーミング](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DeleteIngestConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/delete-ingest-configuration.html)」を参照してください。 ### `delete-public-key` 次のコード例は、`delete-public-key` を使用する方法を示しています。 **AWS CLI** **パブリックキーを削除するには** 次の `delete-public-key` は、指定されたパブリックキーを削除します。 ``` aws ivs-realtime delete-public-key \ --arn arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2 ``` このコマンドは何も出力しません。 詳細については、「*Amazon IVS Real-Time Streaming ユーザーガイド*」の「[参加者トークンを配布する](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeletePublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/delete-public-key.html)」を参照してください。 ### `delete-stage` 次のコード例は、`delete-stage` を使用する方法を示しています。 **AWS CLI** **ステージを削除するには** 次の `delete-stage` の例では、指定されたステージを削除します。 ``` aws ivs-realtime delete-stage \ --arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh ``` このコマンドは何も出力しません。 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/userguide/multiple-hosts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/delete-stage.html)」を参照してください。 ### `delete-storage-configuration` 次のコード例は、`delete-storage-configuration` を使用する方法を示しています。 **AWS CLI** **コンポジションストレージ設定を削除するには** 次の `delete-storage-configuration` は、指定の ARN (Amazon リソースネーム) で指定されたコンポジションストレージ設定を削除します。 ``` aws ivs-realtime delete-storage-configuration \ --arn "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABabCDcdEFef" ``` このコマンドは何も出力しません。 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteStorageConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/delete-storage-configuration.html)」を参照してください。 ### `disconnect-participant` 次のコード例は、`disconnect-participant` を使用する方法を示しています。 **AWS CLI** **ステージ参加者を切断するには** 次の `disconnect-participant` の例では、指定された参加者を指定されたステージから切断します。 ``` aws ivs-realtime disconnect-participant \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --participant-id ABCDEfghij01234KLMN5678 ``` このコマンドは何も出力しません。 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/userguide/multiple-hosts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisconnectParticipant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/disconnect-participant.html)」を参照してください。 ### `get-composition` 次のコード例は、`get-composition` を使用する方法を示しています。 **AWS CLI** **例 1: デフォルトのレイアウト設定でコンポジションを取得するには** 次の `get-composition` の例では、指定された ARN (Amazon リソースネーム) のコンポジションを取得します。 ``` aws ivs-realtime get-composition \ --arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh" ``` 出力: ``` { "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": {} } } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[IVS Composite Recording \$1 リアルタイムストリーミング](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html)」を参照してください。 **例 2: PiP レイアウトのコンポジションを取得するには** 次の `get-composition` の例では、PiP レイアウトを使用している、指定された ARN (Amazon リソースネーム) のコンポジションを取得します。 ``` aws ivs-realtime get-composition \ --arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/wxyzWXYZpqrs" ``` 出力: ``` { "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": {} } } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[IVS Composite Recording \$1 リアルタイムストリーミング](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html)」を参照してください。 **例 3: サムネイルの記録が有効になっているコンポジションを取得するには** 次の `get-composition` の例では、デフォルト設定でサムネイルの記録が有効になっている、指定された ARN (Amazon リソースネーム) のコンポジションを取得します。 ``` aws ivs-realtime get-composition \ --arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh" ``` 出力: ``` { "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": {} } } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[IVS Composite Recording \$1 リアルタイムストリーミング](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetComposition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-composition.html)」を参照してください。 ### `get-encoder-configuration` 次のコード例は、`get-encoder-configuration` を使用する方法を示しています。 **AWS CLI** **コンポジションエンコーダー設定を取得するには** 次の `get-encoder-configuration` の例では、指定の ARN (Amazon リソースネーム) で指定されたコンポジションエンコーダー設定を取得します。 ``` aws ivs-realtime get-encoder-configuration \ --arn "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/abcdABCDefgh" ``` 出力: ``` { "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 } } } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetEncoderConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-encoder-configuration.html)」を参照してください。 ### `get-ingest-configuration` 次のコード例は、`get-ingest-configuration` を使用する方法を示しています。 **AWS CLI** **取り込み設定情報を取得するには** 次の `get-ingest-configuration` の例では、指定した取り込み設定 ARN (Amazon リソースネーム) の取り込み設定を取得します。 ``` aws ivs-realtime get-ingest-configuration \ --arn arn:aws:ivs:us-west-2:123456789012:ingest-configuration/AbCdEfGh1234 ``` 出力: ``` { "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": {} } } ``` 詳細については、*Amazon Interactive Video Service ユーザーガイド*の「[IVS ストリーム取り込み \$1 リアルタイムストリーミング](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[GetIngestConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-ingest-configuration.html)」を参照してください。 ### `get-participant` 次のコード例は、`get-participant` を使用する方法を示しています。 **AWS CLI** **例 1: ステージ参加者を取得するには** 次の `get-participant` の例では、指定されたステージ ARN (Amazon リソースネーム) で、指定された参加者 ID とセッション ID のステージ参加者を取得します。 ``` aws ivs-realtime get-participant \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --session-id st-a1b2c3d4e5f6g \ --participant-id abCDEf12GHIj ``` 出力: ``` { "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": "" } } ``` 詳細については、「*Amazon IVS Low-Latency Streaming ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)」を参照してください。 **例 2: 別のステージにレプリケートされたステージ参加者を取得するには** 次の `get-participant` の例では、参加者が別のステージにも複製されている場合に、指定されたステージ ARN (Amazon リソースネーム) で、指定された参加者 ID とセッション ID のステージ参加者を取得します。 ``` aws ivs-realtime get-participant \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --session-id st-a1b2c3d4e5f6g \ --participant-id abCDEf12GHIj ``` 出力: ``` { "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": "" } } ``` 詳細については、「*Amazon IVS Low-Latency Streaming ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)」を参照してください。 **例 3: 別のステージからレプリケートされたステージ参加者を取得するには** 次の `get-participant` の例では、参加者が別のステージから複製されている場合に、指定されたステージ ARN (Amazon リソースネーム) で、指定された参加者 ID とセッション ID のステージ参加者を取得します。 ``` aws ivs-realtime get-participant \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --session-id st-a1b2c3d4e5f6g \ --participant-id abCDEf12GHIj ``` 出力: ``` { "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": "" } } ``` 詳細については、「*Amazon IVS Low-Latency Streaming ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetParticipant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-participant.html)」を参照してください。 ### `get-public-key` 次のコード例は、`get-public-key` を使用する方法を示しています。 **AWS CLI** **ステージ参加者トークンの署名に使用される既存のパブリックキーを取得するには** 次の `get-public-key` の例では、ステージ参加者トークンの署名用に、指定の ARN で指定されたパブリックキーを取得します。 ``` aws ivs-realtime get-public-key \ --arn arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2 ``` 出力: ``` { "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": {} } } ``` 詳細については、「*Amazon IVS Real-Time Streaming ユーザーガイド*」の「[参加者トークンを配布する](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-public-key.html)」を参照してください。 ### `get-stage-session` 次のコード例は、`get-stage-session` を使用する方法を示しています。 **AWS CLI** **ステージセッションを取得するには** 次の `get-stage-session` の例では、指定されたステージ ARN (Amazon リソースネーム) の指定されたセッション ID に対するステージセッションを取得します。 ``` aws ivs-realtime get-stage-session \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --session-id st-a1b2c3d4e5f6g ``` 出力: ``` { "stageSession": { "endTime": "2023-04-26T20:36:29+00:00", "sessionId": "st-a1b2c3d4e5f6g", "startTime": "2023-04-26T20:30:29.602000+00:00" } } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/userguide/multiple-hosts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetStageSession](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-stage-session.html)」を参照してください。 ### `get-stage` 次のコード例は、`get-stage` を使用する方法を示しています。 **AWS CLI** **ステージの設定情報を取得するには** 次の `get-stage` の例では、指定されたステージ ARN (Amazon リソースネーム) のステージ設定を取得します。 ``` aws ivs-realtime get-stage \ --arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh ``` 出力: ``` { "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": {} } } ``` 詳細については、「*Amazon IVS Low-Latency Streaming ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-stage.html)」を参照してください。 ### `get-storage-configuration` 次のコード例は、`get-storage-configuration` を使用する方法を示しています。 **AWS CLI** **コンポジションストレージ設定を取得するには** 次の `get-storage-configuration` の例では、指定の ARN (Amazon リソースネーム) で指定されたコンポジションストレージ設定を取得します。 ``` aws ivs-realtime get-storage-configuration \ --name arn "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh" ``` 出力: ``` { "storageConfiguration": { "arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh", "name": "test-sc", "s3": { "bucketName": "amzn-s3-demo-bucket" }, "tags": {} } } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetStorageConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/get-storage-configuration.html)」を参照してください。 ### `import-public-key` 次のコード例は、`import-public-key` を使用する方法を示しています。 **AWS CLI** **ステージ参加者トークンの署名に使用される既存のパブリックキーをインポートするには** 次の `import-public-key` の例では、ステージ参加者トークンの署名に使用されるパブリックキーをマテリアルファイルからインポートします。 ``` aws ivs-realtime import-public-key \ --public-key-material="`cat public.pem`" ``` 出力: ``` { "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": {} } } ``` 詳細については、「*Amazon IVS Real-Time Streaming ユーザーガイド*」の「[参加者トークンを配布する](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ImportPublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/import-public-key.html)」を参照してください。 ### `list-compositions` 次のコード例は、`list-compositions` を使用する方法を示しています。 **AWS CLI** **コンポジションのリストを取得するには** 次の `list-compositions` は、API リクエストが処理される AWS リージョンにおける AWS アカウントのすべてのコンポジションを一覧表示します。 ``` aws ivs-realtime list-compositions ``` 出力: ``` { "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": {} } ] } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListCompositions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-compositions.html)」を参照してください。 ### `list-encoder-configurations` 次のコード例は、`list-encoder-configurations` を使用する方法を示しています。 **AWS CLI** **コンポジションエンコーダー設定を一覧表示するには** 次の `list-encoder-configurations` は、API リクエストが処理される AWS リージョンにおける AWS アカウントのすべてのコンポジションエンコーダー設定を一覧表示します。 ``` aws ivs-realtime list-encoder-configurations ``` 出力: ``` { "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": {} } ] } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListEncoderConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-encoder-configurations.html)」を参照してください。 ### `list-ingest-configurations` 次のコード例は、`list-ingest-configurations` を使用する方法を示しています。 **AWS CLI** **すべての取り込み設定に関する概要情報を取得するには** 次の `list-ingest-configurations` の例では、API リクエストが処理される AWS リージョン内の AWS アカウントのすべての取り込み設定を一覧表示します。 ``` aws ivs-realtime list-ingest-configurations ``` 出力: ``` { "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": "", } ] } ``` 詳細については、*Amazon Interactive Video Service ユーザーガイド*の「[IVS ストリーム取り込み \$1 リアルタイムストリーミング](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[ListIngestConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-ingest-configurations.html)」を参照してください。 ### `list-participant-events` 次のコード例は、`list-participant-events` を使用する方法を示しています。 **AWS CLI** **例 1: ステージ参加者イベントのリストを取得するには** 次の `list-participant-events` の例では、指定されたステージ ARN (Amazon リソースネーム) の指定された参加者 ID とセッション ID に対するすべての参加者イベントを一覧表示します。 ``` aws ivs-realtime list-participant-events \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --session-id st-a1b2c3d4e5f6g \ --participant-id abCDEf12GHIj ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon IVS Low-Latency Streaming ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)」を参照してください。 **例 2: 参加者のレプリケーションの停止と開始を含むステージ参加者のイベントのリストを取得するには** 次の `list-participant-events` の例では、参加者が別のステージにレプリケートされている、指定されたステージ ARN (Amazon リソースネーム) の指定された参加者 ID とセッション ID に対するすべての参加者イベントを一覧表示します。 ``` aws ivs-realtime list-participant-events \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --session-id st-a1b2c3d4e5f6g \ --participant-id abCDEf12GHIj ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon IVS Low-Latency Streaming ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListParticipantEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-participant-events.html)」を参照してください。 ### `list-participant-replicas` 次のコード例は、`list-participant-replicas` を使用する方法を示しています。 **AWS CLI** **ステージ参加者のレプリカのリストを取得するには** 次の `list-participant-replicas` の例では、指定されたソースステージ ARN (Amazon リソースネーム) から別のステージにレプリケートされたすべてのステージ参加者を一覧表示します。 ``` aws ivs-realtime list-participant-replicas \ --source-stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --participant-id abCDEf12GHIj ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon IVS Real-Time Streaming ユーザーガイド*」の「[IVS 参加者のレプリケーション](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-participant-replication.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListParticipantReplicas](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-participant-replicas.html)」を参照してください。 ### `list-participants` 次のコード例は、`list-participants` を使用する方法を示しています。 **AWS CLI** **例 1: ステージ参加者のリストを取得するには** 次の `list-participants` の例では、指定されたステージ ARN (Amazon リソースネーム) の指定されたセッション ID に対するすべての参加者を一覧表示します。 ``` aws ivs-realtime list-participants \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --session-id st-a1b2c3d4e5f6g ``` 出力: ``` { "participants": [ { "firstJoinTime": "2023-04-26T20:30:34+00:00", "participantId": "abCDEf12GHIj", "published": true, "recordingState": "STOPPED", "state": "DISCONNECTED", "userId": "" } ] } ``` 詳細については、「*Amazon IVS Low-Latency Streaming ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)」を参照してください。 **例 2: 参加者が別のステージにレプリケートされたときにステージ参加者のリストを取得するには** 次の `list-participants` の例では、参加者が別のステージにレプリケートされている場合に、指定されたステージ ARN (Amazon リソースネーム) の指定されたセッション ID のすべての参加者を一覧表示します。 ``` aws ivs-realtime list-participants \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --session-id st-a1b2c3d4e5f6g ``` 出力: ``` { "participants": [ { "firstJoinTime": "2023-04-26T20:30:34+00:00", "participantId": "abCDEf12GHIj", "published": true, "recordingState": "STOPPED", "state": "DISCONNECTED", "userId": "", "replicationState": "ACTIVE", "replicationType": "SOURCE", "sourceStageArn": "", "sourceSessionId": "" } ] } ``` 詳細については、「*Amazon IVS Low-Latency Streaming ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)」を参照してください。 **例 3: 参加者が別のステージからレプリケートされた場合にステージ参加者のリストを取得するには** 次の `list-participants` の例では、参加者が別のステージからレプリケートされている場合に、指定されたステージ ARN (Amazon リソースネーム) の指定されたセッション ID のすべての参加者を一覧表示します。 ``` aws ivs-realtime list-participants \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \ --session-id st-a1b2c3d4e5f6g ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon IVS Low-Latency Streaming ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListParticipants](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-participants.html)」を参照してください。 ### `list-public-keys` 次のコード例は、`list-public-keys` を使用する方法を示しています。 **AWS CLI** **ステージ参加者トークンの署名に使用できる既存のパブリックキーを一覧表示するには** 次の `list-public-keys` の例では、API リクエストが処理される AWS リージョンで、ステージ参加者トークンの署名に使用できるすべてのパブリックキーを一覧表示します。 ``` aws ivs-realtime list-public-keys ``` 出力: ``` { "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": {} } ] } ``` 詳細については、「*Amazon IVS Real-Time Streaming ユーザーガイド*」の「[参加者トークンを配布する](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/getting-started-distribute-tokens.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPublicKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-public-keys.html)」を参照してください。 ### `list-stage-sessions` 次のコード例は、`list-stage-sessions` を使用する方法を示しています。 **AWS CLI** **ステージセッションのリストを取得するには** 次の `list-stage-sessions` の例では、指定されたステージ ARN (Amazon リソースネーム) のすべてのセッションを一覧表示します。 ``` aws ivs-realtime list-stage-sessions \ --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh ``` 出力: ``` { "stageSessions": [ { "endTime": "2023-04-26T20:36:29+00:00", "sessionId": "st-a1b2c3d4e5f6g", "startTime": "2023-04-26T20:30:29.602000+00:00" } ] } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/userguide/multiple-hosts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListStageSessions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-stage-sessions.html)」を参照してください。 ### `list-stages` 次のコード例は、`list-stages` を使用する方法を示しています。 **AWS CLI** **すべてのステージに関する概要情報を取得するには** 次の `list-stages` の例では、API リクエストが処理される AWS リージョンにおける AWS アカウントのすべてのステージを一覧表示します。 ``` aws ivs-realtime list-stages ``` 出力: ``` { "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": {} } ] } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListStages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-stages.html)」を参照してください。 ### `list-storage-configurations` 次のコード例は、`list-storage-configurations` を使用する方法を示しています。 **AWS CLI** **コンポジションストレージ設定を一覧表示するには** 次の `list-storage-configurations` は、API リクエストが処理される AWS リージョンにおける AWS アカウントのすべてのコンポジションストレージ設定を一覧表示します。 ``` aws ivs-realtime list-storage-configurations ``` 出力: ``` { "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": {} } ] } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListStorageConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/list-storage-configurations.html)」を参照してください。 ### `start-composition` 次のコード例は、`start-composition` を使用する方法を示しています。 **AWS CLI** **例 1: デフォルトのレイアウト設定でコンポジションを開始するには** 次の `start-composition` の例では、指定された場所にストリーミングされるコンポジションを指定されたステージに対して開始します。 ``` 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"}}]' ``` 出力: ``` { "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": {} } } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[IVS Composite Recording \$1 リアルタイムストリーミング](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html)」を参照してください。 **例 2: PiP レイアウトのコンポジションを開始するには** 次の `start-composition` の例では、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"}' ``` 出力: ``` { "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": {} } } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[IVS Composite Recording \$1 リアルタイムストリーミング](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html)」を参照してください。 **例 3: サムネイルの記録が有効になっているコンポジションを開始するには** 次の `start-composition` の例では、サムネイルの記録が有効になっており、指定された場所にストリーミングされるコンポジションを、指定されたステージに対して開始します。 ``` 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}]}}]' ``` 出力: ``` { "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": {} } } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Composite Recording (リアルタイムストリーミング)](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html)」を参照してください。 **例 4: カスタム参加者の順序でグリッドレイアウトを使用してコンポジションを開始するには** 次の `start-composition` の例では、カスタム参加者の順序でグリッドレイアウトを使用して、指定された場所にストリーミングされるコンポジションを指定されたステージに対して開始します。 ``` 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"}' ``` 出力: ``` { "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": {} } } ``` 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[IVS Composite Recording \$1 リアルタイムストリーミング](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-composite-recording.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartComposition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/start-composition.html)」を参照してください。 ### `start-participant-replication` 次のコード例は、`start-participant-replication` を使用する方法を示しています。 **AWS CLI** **あるステージから別のステージへの参加者のレプリケートを開始するには** 次の `start-participant-replication` の例では、参加者をソースステージから宛先ステージにレプリケートし、各ステージを ARN (Amazon リソースネーム) で指定します。 ``` 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 ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon IVS Real-Time Streaming ユーザーガイド*」の「[IVS 参加者のレプリケーション](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-participant-replication.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartParticipantReplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/start-participant-replication.html)」を参照してください。 ### `stop-composition` 次のコード例は、`stop-composition` を使用する方法を示しています。 **AWS CLI** **コンポジションを停止するには** 次の `stop-composition` は、指定の ARN (Amazon リソースネーム) で指定されたコンポジションを停止します。 ``` aws ivs-realtime stop-composition \ --arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh" ``` このコマンドは何も出力しません。 詳細については、「*Amazon Interactive Video Service ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopComposition](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/stop-composition.html)」を参照してください。 ### `stop-participant-replication` 次のコード例は、`stop-participant-replication` を使用する方法を示しています。 **AWS CLI** **あるステージから別のステージへの参加者のレプリケートを停止するには** 次の `stop-participant-replication` の例では、ARN (Amazon リソースネーム) で指定された各ステージを使用して、送信元ステージから送信先ステージへの参加者のレプリケートを停止します。 ``` 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 ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon IVS Real-Time Streaming ユーザーガイド*」の「[IVS 参加者のレプリケーション](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-participant-replication.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopParticipantReplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/stop-participant-replication.html)」を参照してください。 ### `update-ingest-configuration` 次のコード例は、`update-ingest-configuration` を使用する方法を示しています。 **AWS CLI** **取り込み設定を更新するには** 次の `update-inegst-configuration` の例では、取り込み設定を更新してステージにアタッチします。 ``` 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 ``` 出力: ``` { "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": {} } } ``` 詳細については、*Amazon Interactive Video Service ユーザーガイド*の「[IVS ストリーム取り込み \$1 リアルタイムストリーミング](https://docs.aws.amazon.com/ivs/latest/RealTimeUserGuide/rt-stream-ingest.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[UpdateIngestConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/update-ingest-configuration.html)」を参照してください。 ### `update-stage` 次のコード例は、`update-stage` を使用する方法を示しています。 **AWS CLI** **例 1: ステージの設定を更新するには** 次の `update-stage` の例では、指定されたステージ ARN のステージを更新して、ステージ名を更新し、サムネイルの記録が有効になっている個々の参加者の録画を設定します。 ``` 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 ``` 出力: ``` { "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": {} } } ``` 詳細については、「*Amazon IVS Low-Latency Streaming ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)」を参照してください。 **例 2: 参加者のレプリカ記録の無効化を含むステージの設定を更新するには** 次の `update-stage` の例では、指定されたステージ ARN のステージを更新してステージ名を更新し、個々の参加者の記録を、サムネイルの記録を有効にし、参加者のレプリカ記録を無効にして設定します。 ``` 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 ``` 出力: ``` { "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": {} } } ``` 詳細については、「*Amazon IVS Low-Latency Streaming ユーザーガイド*」の「[Amazon IVS ストリームで複数ホストを有効にする](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/multiple-hosts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateStage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ivs-realtime/update-stage.html)」を参照してください。 # Amazon Kendra examples using AWS CLI 次のコード例は、Amazon Kendra で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-data-source` 次のコード例は、`create-data-source` を使用する方法を示しています。 **AWS CLI** **Amazon Kendra データソースコネクタを作成するには** 次の `create-data-source` は、Amazon Kendra データソースコネクタを作成して設定します。`describe-data-source` を使用してデータソースコネクタのステータスを表示し、ステータスが、データソースコネクタが完全に作成されなかったことを示す "FAILED" の場合は、エラーメッセージを確認することができます。 ``` 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"]}' ``` 出力: ``` { "Id": "exampledatasource1" } ``` 詳細については、「**Amazon Kendra デベロッパーガイド」の「[Getting started with an Amazon Kendra index and data source connector](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDataSource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/create-data-source.html)」を参照してください。 ### `create-index` 次のコード例は、`create-index` を使用する方法を示しています。 **AWS CLI** **Amazon Kendra インデックスを作成するには** 次の `create-index` は、Amazon Kendra インデックスを作成して設定します。`describe-index` を使用してインデックスのステータスを表示し、ステータスが、インデックスが完全に作成されなかったことを示す "FAILED" の場合は、エラーメッセージを確認することができます。 ``` 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"}}' ``` 出力: ``` { "Id": index1 } ``` 詳細については、「**Amazon Kendra デベロッパーガイド」の「[Getting started with an Amazon Kendra index and data source connector](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateIndex](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/create-index.html)」を参照してください。 ### `describe-data-source` 次のコード例は、`describe-data-source` を使用する方法を示しています。 **AWS CLI** **Amazon Kendra データソースコネクタに関する情報を取得するには** 次の `describe-data-source` は、Amazon Kendra データソースコネクタに関する情報を取得します。データソースコネクタの設定を表示し、ステータスが、データソースコネクタが完全に作成されなかったことを示す "FAILED" の場合は、エラーメッセージを確認することができます。 ``` aws kendra describe-data-source \ --id exampledatasource1 \ --index-id exampleindex1 ``` 出力: ``` { "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"] } } ``` 詳細については、「**Amazon Kendra デベロッパーガイド」の「[Getting started with an Amazon Kendra index and data source connector](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDataSource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/describe-data-source.html)」を参照してください。 ### `describe-index` 次のコード例は、`describe-index` を使用する方法を示しています。 **AWS CLI** **Amazon Kendra インデックスに関する情報を取得するには** 次の `describe-index` は、Amazon Kendra インデックスに関する情報を取得します。インデックスの設定を表示し、ステータスが、インデックスが完全に作成されなかったことを示す "FAILED" の場合は、エラーメッセージを確認することができます。 ``` aws kendra describe-index \ --id exampleindex1 ``` 出力: ``` { "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" } } ] } ``` 詳細については、「**Amazon Kendra デベロッパーガイド」の「[Getting started with an Amazon Kendra index and data source connector](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeIndex](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/describe-index.html)」を参照してください。 ### `update-data-source` 次のコード例は、`update-data-source` を使用する方法を示しています。 **AWS CLI** **Amazon Kendra データソースコネクタを更新するには** 次の `update-data-source` は、Amazon Kendra データソースコネクタの設定を更新します。アクションが成功すると、出力は返されないか、HTTP ステータスコード 200 または AWS CLI リターンコード 0 が返されます。`describe-data-source` を使用して、データソースコネクタの設定とステータスを表示できます。 ``` 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"]}' ``` このコマンドは何も出力しません。 詳細については、「**Amazon Kendra デベロッパーガイド」の「[Getting started with an Amazon Kendra index and data source connector](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateDataSource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/update-data-source.html)」を参照してください。 ### `update-index` 次のコード例は、`update-index` を使用する方法を示しています。 **AWS CLI** **Amazon Kendra インデックスを更新するには** 次の `update-index` は、Amazon Kendra インデックスの設定を更新します。アクションが成功すると、出力は返されないか、HTTP ステータスコード 200 または AWS CLI リターンコード 0 が返されます。`describe-index` を使用して、インデックスの設定とステータスを表示できます。 ``` 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"}}' ``` このコマンドは何も出力しません。 詳細については、「**Amazon Kendra デベロッパーガイド」の「[Getting started with an Amazon Kendra index and data source connector](https://docs.aws.amazon.com/kendra/latest/dg/getting-started.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateIndex](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kendra/update-index.html)」を参照してください。 # AWS CLI を使用する Kinesis の例 次のコード例は、Kinesis で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `add-tags-to-stream` 次のコード例は、`add-tags-to-stream` を使用する方法を示しています。 **AWS CLI** **データストリームにタグを追加するには** 次の `add-tags-to-stream` の例では、キー `samplekey` と値 `example` を持つタグを指定されたストリームに割り当てます。 ``` aws kinesis add-tags-to-stream \ --stream-name samplestream \ --tags samplekey=example ``` このコマンドは何も出力しません。 詳細については、「*Amazon Kinesis Data Streams Developer Guide*」の「[Tagging Your Streams](https://docs.aws.amazon.com/streams/latest/dev/tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddTagsToStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/add-tags-to-stream.html)」を参照してください。 ### `create-stream` 次のコード例は、`create-stream` を使用する方法を示しています。 **AWS CLI** **データストリームを作成するには** 次の `create-stream` の例は、3 つのシャードを含む samplestream という名前のデータストリームを作成します。 ``` aws kinesis create-stream \ --stream-name samplestream \ --shard-count 3 ``` このコマンドは何も出力しません。 詳細については、「Amazon Kinesis Data Streams ディベロッパーガイド」の「[API を使用したストリームの作成](https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-create-stream.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[CreateStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/create-stream.html)」を参照してください。** ### `decrease-stream-retention-period` 次のコード例は、`decrease-stream-retention-period` を使用する方法を示しています。 **AWS CLI** **データストリームの保持期間を短縮するには** 次の `decrease-stream-retention-period` の例では、samplestream という名前のストリームの保持期間 (データレコードがストリームに追加された後、アクセス可能な期間) を 48 時間に短縮します。 ``` aws kinesis decrease-stream-retention-period \ --stream-name samplestream \ --retention-period-hours 48 ``` このコマンドは何も出力しません。 詳細については、「*Amazon Kinesis Data Streams デベロッパーガイド*」の「[データ保持期間の変更](https://docs.aws.amazon.com/streams/latest/dev/kinesis-extended-retention.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DecreaseStreamRetentionPeriod](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/decrease-stream-retention-period.html)」を参照してください。 ### `delete-stream` 次のコード例は、`delete-stream` を使用する方法を示しています。 **AWS CLI** **データストリームを削除するには** 次の `delete-stream` の例は、指定されたデータストリームを削除します。 ``` aws kinesis delete-stream \ --stream-name samplestream ``` このコマンドは何も出力しません。 詳細については、「*Amazon Kinesis Data Streams ディベロッパーガイド*」の「[ストリームを削除する](https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-delete-stream.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/delete-stream.html)」を参照してください。 ### `deregister-stream-consumer` 次のコード例は、`deregister-stream-consumer` を使用する方法を示しています。 **AWS CLI** **データストリームコンシューマーの登録を解除するには** 次の `deregister-stream-consumer` 例では、指定されたコンシューマーを指定されたデータストリームから登録解除します。 ``` aws kinesis deregister-stream-consumer \ --stream-arn arn:aws:kinesis:us-west-2:123456789012:stream/samplestream \ --consumer-name KinesisConsumerApplication ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Kinesis Data Streams Developer Guide*」の「[Developing Consumers with Enhanced Fan-Out Using the Kinesis Data Streams API](https://docs.aws.amazon.com/streams/latest/dev/building-enhanced-consumers-api.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeregisterStreamConsumer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/deregister-stream-consumer.html)」を参照してください。 ### `describe-limits` 次のコード例は、`describe-limits` を使用する方法を示しています。 **AWS CLI** **シャード制限の説明を表示には** 次の `describe-limits` の例では、現在の AWS アカウントのシャード制限と使用状況を表示します。 ``` aws kinesis describe-limits ``` 出力: ``` { "ShardLimit": 500, "OpenShardCount": 29 } ``` 詳細については、「*Amazon Kinesis Data Streams デベロッパーガイド*」の「[ストリームをリシャーディングする](https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-resharding.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeLimits](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/describe-limits.html)」を参照してください。 ### `describe-stream-consumer` 次のコード例は、`describe-stream-consumer` を使用する方法を示しています。 **AWS CLI** **データストリームコンシューマーの説明を表示するには** 次の `describe-stream-consumer` の例では、指定されたデータストリームに登録された、指定されたコンシューマーの説明を返します。 ``` aws kinesis describe-stream-consumer \ --stream-arn arn:aws:kinesis:us-west-2:012345678912:stream/samplestream \ --consumer-name KinesisConsumerApplication ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Kinesis Data Streams デベロッパーガイド*」の「[Reading Data from Amazon Kinesis Data Streams](https://docs.aws.amazon.com/streams/latest/dev/building-consumers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeStreamConsumer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/describe-stream-consumer.html)」を参照してください。 ### `describe-stream-summary` 次のコード例は、`describe-stream-summary` を使用する方法を示しています。 **AWS CLI** **データストリームの概要説明を表示するには** 次の `describe-stream-summary` の例では、指定されたデータストリームの概要説明 (シャードリストなし) を提供します。 ``` aws kinesis describe-stream-summary \ --stream-name samplestream ``` 出力: ``` { "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 } } ``` 詳細については、「Amazon Kinesis Data Streams ディベロッパーガイド」の「[ストリームの作成と管理](https://docs.aws.amazon.com/streams/latest/dev/working-with-streams.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeStreamSummary](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/describe-stream-summary.html)」を参照してください。 ### `describe-stream` 次のコード例は、`describe-stream` を使用する方法を示しています。 **AWS CLI** **データストリームを記述するには** 次の `describe-stream` の例は、指定されたデータストリームの詳細を返します。 ``` aws kinesis describe-stream \ --stream-name samplestream ``` 出力: ``` { "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 } } ``` 詳細については、「Amazon Kinesis Data Streams ディベロッパーガイド」の「[ストリームの作成と管理](https://docs.aws.amazon.com/streams/latest/dev/working-with-streams.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/describe-stream.html)」を参照してください。** ### `disable-enhanced-monitoring` 次のコード例は、`disable-enhanced-monitoring` を使用する方法を示しています。 **AWS CLI** **シャードレベルメトリクスの拡張モニタリングを無効にするには** 次の `disable-enhanced-monitoring` の例では、シャードレベルメトリクスの拡張 Kinesis データストリームモニタリングを無効にします。 ``` aws kinesis disable-enhanced-monitoring \ --stream-name samplestream --shard-level-metrics ALL ``` 出力: ``` { "StreamName": "samplestream", "CurrentShardLevelMetrics": [ "IncomingBytes", "OutgoingRecords", "IteratorAgeMilliseconds", "IncomingRecords", "ReadProvisionedThroughputExceeded", "WriteProvisionedThroughputExceeded", "OutgoingBytes" ], "DesiredShardLevelMetrics": [] } ``` 詳細については、「*Amazon Kinesis Data Streams デベロッパーガイド*」の「[Monitoring Streams in Amazon Kinesis Data Streams](https://docs.aws.amazon.com/streams/latest/dev/monitoring.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisableEnhancedMonitoring](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/disable-enhanced-monitoring.html)」を参照してください。 ### `enable-enhanced-monitoring` 次のコード例は、`enable-enhanced-monitoring` を使用する方法を示しています。 **AWS CLI** **シャードレベルメトリクスの拡張モニタリングを有効にするには** 次の `enable-enhanced-monitoring` の例では、シャードレベルメトリクスの拡張 Kinesis データストリームモニタリングを有効にします。 ``` aws kinesis enable-enhanced-monitoring \ --stream-name samplestream \ --shard-level-metrics ALL ``` 出力: ``` { "StreamName": "samplestream", "CurrentShardLevelMetrics": [], "DesiredShardLevelMetrics": [ "IncomingBytes", "OutgoingRecords", "IteratorAgeMilliseconds", "IncomingRecords", "ReadProvisionedThroughputExceeded", "WriteProvisionedThroughputExceeded", "OutgoingBytes" ] } ``` 詳細については、「*Amazon Kinesis Data Streams デベロッパーガイド*」の「[Monitoring Streams in Amazon Kinesis Data Streams](https://docs.aws.amazon.com/streams/latest/dev/monitoring.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EnableEnhancedMonitoring](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/enable-enhanced-monitoring.html)」を参照してください。 ### `get-records` 次のコード例は、`get-records` を使用する方法を示しています。 **AWS CLI** **シャードからレコードを取得するには** 次の `get-records` の例は、指定されたシャードイテレーターを使用して Kinesis データストリームのシャードからデータレコードを取得します。 ``` aws kinesis get-records \ --shard-iterator AAAAAAAAAAF7/0mWD7IuHj1yGv/TKuNgx2ukD5xipCY4cy4gU96orWwZwcSXh3K9tAmGYeOZyLZrvzzeOFVf9iN99hUPw/w/b0YWYeehfNvnf1DYt5XpDJghLKr3DzgznkTmMymDP3R+3wRKeuEw6/kdxY2yKJH0veaiekaVc4N2VwK/GvaGP2Hh9Fg7N++q0Adg6fIDQPt4p8RpavDbk+A4sL9SWGE1 ``` 出力: ``` { "Records": [], "MillisBehindLatest": 80742000 } ``` 詳細については、「Amazon Kinesis Data Streams ディベロッパーガイド」の「[AWS SDK for Java を使用した共有スループットでのカスタムコンシューマーの開発](https://docs.aws.amazon.com/streams/latest/dev/developing-consumers-with-sdk.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRecords](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/get-records.html)」を参照してください。 ### `get-shard-iterator` 次のコード例は、`get-shard-iterator` を使用する方法を示しています。 **AWS CLI** **シャードイテレータを取得するには** 次の `get-shard-iterator` の例では、`AT_SEQUENCE_NUMBER` シャードイテレータタイプを使用してシャードイテレータを生成し、指定されたシーケンス番号で示される位置からデータレコードの読み取りを正確に開始します。 ``` aws kinesis get-shard-iterator \ --stream-name samplestream \ --shard-id shardId-000000000001 \ --shard-iterator-type LATEST ``` 出力: ``` { "ShardIterator": "AAAAAAAAAAFEvJjIYI+3jw/4aqgH9FifJ+n48XWTh/IFIsbILP6o5eDueD39NXNBfpZ10WL5K6ADXk8w+5H+Qhd9cFA9k268CPXCz/kebq1TGYI7Vy+lUkA9BuN3xvATxMBGxRY3zYK05gqgvaIRn94O8SqeEqwhigwZxNWxID3Ej7YYYcxQi8Q/fIrCjGAy/n2r5Z9G864YpWDfN9upNNQAR/iiOWKs" } ``` 詳細については、「Amazon Kinesis Data Streams ディベロッパーガイド」の「[AWS SDK for Java を使用した共有スループットでのカスタムコンシューマーの開発](https://docs.aws.amazon.com/streams/latest/dev/developing-consumers-with-sdk.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetShardIterator](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/get-shard-iterator.html)」を参照してください。 ### `increase-stream-retention-period` 次のコード例は、`increase-stream-retention-period` を使用する方法を示しています。 **AWS CLI** **データストリームの保持期間を延長するには** 次の `increase-stream-retention-period` の例では、指定されたストリームの保持期間 (データレコードがストリームに追加された後、アクセス可能な期間) を 168 時間に延長します。 ``` aws kinesis increase-stream-retention-period \ --stream-name samplestream \ --retention-period-hours 168 ``` このコマンドは何も出力しません。 詳細については、「*Amazon Kinesis Data Streams デベロッパーガイド*」の「[データ保持期間の変更](https://docs.aws.amazon.com/streams/latest/dev/kinesis-extended-retention.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[IncreaseStreamRetentionPeriod](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/increase-stream-retention-period.html)」を参照してください。 ### `list-shards` 次のコード例は、`list-shards` を使用する方法を示しています。 **AWS CLI** **データストリーム内のシャードを一覧表示するには** 次の `list-shards` の例では、指定されたストリーム内のシャードのうち、ID が指定された `exclusive-start-shard-id` (`shardId-000000000000`) 以降のものをすべて一覧表示します。 ``` aws kinesis list-shards \ --stream-name samplestream \ --exclusive-start-shard-id shardId-000000000000 ``` 出力: ``` { "Shards": [ { "ShardId": "shardId-000000000001", "HashKeyRange": { "StartingHashKey": "113427455640312821154458202477256070485", "EndingHashKey": "226854911280625642308916404954512140969" }, "SequenceNumberRange": { "StartingSequenceNumber": "49600871682979337187563555549332609155523708941634633746" } }, { "ShardId": "shardId-000000000002", "HashKeyRange": { "StartingHashKey": "226854911280625642308916404954512140970", "EndingHashKey": "340282366920938463463374607431768211455" }, "SequenceNumberRange": { "StartingSequenceNumber": "49600871683001637932762086172474144873796357303140614178" } } ] } ``` 詳細については、「*Amazon Kinesis Data Streams デベロッパーガイド*」の「[シャードの一覧表示](https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-list-shards.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListShards](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/list-shards.html)」を参照してください。 ### `list-streams` 次のコード例は、`list-streams` を使用する方法を示しています。 **AWS CLI** **データストリームを一覧表示するには** 次の `list-streams` の例は、現在のアカウントとリージョンのすべてのアクティブなデータストリームを一覧表示します。 ``` aws kinesis list-streams ``` 出力: ``` { "StreamNames": [ "samplestream", "samplestream1" ] } ``` 詳細については、「Amazon Kinesis Data Streams ディベロッパーガイド」の「[ストリームのリスト](https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-list-streams.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[ListStreams](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/list-streams.html)」を参照してください。** ### `list-tags-for-stream` 次のコード例は、`list-tags-for-stream` を使用する方法を示しています。 **AWS CLI** **データストリームのタグを一覧表示するには** 次の `list-tags-for-stream` の例では、指定されたデータストリームにアタッチされたタグを一覧表示します。 ``` aws kinesis list-tags-for-stream \ --stream-name samplestream ``` 出力: ``` { "Tags": [ { "Key": "samplekey", "Value": "example" } ], "HasMoreTags": false } ``` 詳細については、「*Amazon Kinesis Data Streams デベロッパーガイド*」の「[ストリームのタグ付け](https://docs.aws.amazon.com/streams/latest/dev/tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/list-tags-for-stream.html)」を参照してください。 ### `merge-shards` 次のコード例は、`merge-shards` を使用する方法を示しています。 **AWS CLI** **シャードをマージするには** 次の `merge-shards` の例では、指定されたデータストリーム内の 2 つの隣接するシャード (ID が shardId-000000000000 と shardId-000000000001) をマージし、1 つのシャードに結合します。 ``` aws kinesis merge-shards \ --stream-name samplestream \ --shard-to-merge shardId-000000000000 \ --adjacent-shard-to-merge shardId-000000000001 ``` このコマンドは何も出力しません。 詳細については、「*Amazon Kinesis Data Streams デベロッパーガイド*」の「[2 つのシャードを結合する](https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-resharding-merge.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[MergeShards](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/merge-shards.html)」を参照してください。 ### `put-record` 次のコード例は、`put-record` を使用する方法を示しています。 **AWS CLI** **データストリームにデータレコードを書き込むには** 次の `put-record` の例は、指定されたパーティションキーを使用して、指定されたデータストリームに単一のデータレコードを書き込みます。 ``` aws kinesis put-record \ --stream-name samplestream \ --data sampledatarecord \ --partition-key samplepartitionkey ``` 出力: ``` { "ShardId": "shardId-000000000009", "SequenceNumber": "49600902273357540915989931256901506243878407835297513618", "EncryptionType": "KMS" } ``` 詳細については、「Amazon Kinesis Data Streams ディベロッパーガイド」の「[Amazon Kinesis Data Streams API と AWS SDK for Java を使用したプロデューサーの開発](https://docs.aws.amazon.com/streams/latest/dev/developing-producers-with-sdk.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[PutRecord](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/put-record.html)」を参照してください。** ### `put-records` 次のコード例は、`put-records` を使用する方法を示しています。 **AWS CLI** **複数のレコードをデータストリームに書き込むには** 次の `put-records` の例では、指定されたパーティションキーを使用してデータレコードを書き込み、1 回の呼び出しで別のパーティションキーを使用して別のデータレコードを書き込みます。 ``` aws kinesis put-records \ --stream-name samplestream \ --records Data=blob1,PartitionKey=partitionkey1 Data=blob2,PartitionKey=partitionkey2 ``` 出力: ``` { "FailedRecordCount": 0, "Records": [ { "SequenceNumber": "49600883331171471519674795588238531498465399900093808706", "ShardId": "shardId-000000000004" }, { "SequenceNumber": "49600902273357540915989931256902715169698037101720764562", "ShardId": "shardId-000000000009" } ], "EncryptionType": "KMS" } ``` 詳細については、「Amazon Kinesis Data Streams ディベロッパーガイド」の「[Amazon Kinesis Data Streams API と AWS SDK for Java を使用したプロデューサーの開発](https://docs.aws.amazon.com/streams/latest/dev/developing-producers-with-sdk.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutRecords](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/put-records.html)」を参照してください。 ### `register-stream-consumer` 次のコード例は、`register-stream-consumer` を使用する方法を示しています。 **AWS CLI** **データストリームコンシューマーを登録するには** 次の `register-stream-consumer` の例では、`KinesisConsumerApplication` というコンシューマーを指定されたデータストリームに登録します。 ``` aws kinesis register-stream-consumer \ --stream-arn arn:aws:kinesis:us-west-2:012345678912:stream/samplestream \ --consumer-name KinesisConsumerApplication ``` 出力: ``` { "Consumer": { "ConsumerName": "KinesisConsumerApplication", "ConsumerARN": "arn:aws:kinesis:us-west-2: 123456789012:stream/samplestream/consumer/KinesisConsumerApplication:1572383852", "ConsumerStatus": "CREATING", "ConsumerCreationTimestamp": 1572383852.0 } } ``` 詳細については、「*Amazon Kinesis Data Streams ディベロッパーガイド*」の「[Kinesis Data Streams API を使用して拡張ファンアウトコンシューマーを開発する](https://docs.aws.amazon.com/streams/latest/dev/building-enhanced-consumers-api.html)」を参照してください。 + API の詳細については、「*AWS CLI API リファレンス*」の「[RegisterStreamConsumer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/register-stream-consumer.html)」を参照してください。 ### `remove-tags-from-stream` 次のコード例は、`remove-tags-from-stream` を使用する方法を示しています。 **AWS CLI** **データストリームからタグを削除するには** 次の `remove-tags-from-stream` の例では、指定されたキーを持つタグを指定されたデータストリームから削除します。 ``` aws kinesis remove-tags-from-stream \ --stream-name samplestream \ --tag-keys samplekey ``` このコマンドは何も出力しません。 詳細については、「*Amazon Kinesis Data Streams デベロッパーガイド*」の「[ストリームのタグ付け](https://docs.aws.amazon.com/streams/latest/dev/tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveTagsFromStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/remove-tags-from-stream.html)」を参照してください。 ### `split-shard` 次のコード例は、`split-shard` を使用する方法を示しています。 **AWS CLI** **シャードを分割するには** 次の `split-shard` の例では、新しい開始ハッシュキー 10 を使用して、指定されたシャードを 2 つの新しいシャードに分割します。 ``` aws kinesis split-shard \ --stream-name samplestream \ --shard-to-split shardId-000000000000 \ --new-starting-hash-key 10 ``` このコマンドは何も出力しません。 詳細については、「*Amazon Kinesis Data Streams デベロッパーガイド*」の「[シャードの分割](https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-resharding-split.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SplitShard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/split-shard.html)」を参照してください。 ### `start-stream-encryption` 次のコード例は、`start-stream-encryption` を使用する方法を示しています。 **AWS CLI** **データストリームの暗号化を有効にするには** 次の `start-stream-encryption` の例では、指定された AWS KMS キーを使用して、指定されたストリームのサーバー側の暗号化を有効にします。 ``` 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 ``` このコマンドは何も出力しません。 詳細については、「*Amazon Kinesis Data Streams Developer Guide*」の「[Amazon Kinesis Data Streams のデータ保護](https://docs.aws.amazon.com/streams/latest/dev/server-side-encryption.html)」をご参照ください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartStreamEncryption](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/start-stream-encryption.html)」を参照してください。 ### `stop-stream-encryption` 次のコード例は、`stop-stream-encryption` を使用する方法を示しています。 **AWS CLI** **データストリームの暗号化を無効にするには** 次の `stop-stream-encryption` の例では、指定された AWS KMS キーを使用して、指定されたストリームのサーバー側の暗号化を無効にします。 ``` 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 ``` このコマンドは何も出力しません。 詳細については、「*Amazon Kinesis Data Streams Developer Guide*」の「[Amazon Kinesis Data Streams のデータ保護](https://docs.aws.amazon.com/streams/latest/dev/server-side-encryption.html)」をご参照ください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopStreamEncryption](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/stop-stream-encryption.html)」を参照してください。 ### `update-shard-count` 次のコード例は、`update-shard-count` を使用する方法を示しています。 **AWS CLI** **データストリームのシャード数を更新するには** 次の `update-shard-count` の例では、指定されたデータストリームのシャード数を 6 に更新します。この例では、同じサイズのシャードが作成される均一なスケーリングを使用します。 ``` aws kinesis update-shard-count \ --stream-name samplestream \ --scaling-type UNIFORM_SCALING \ --target-shard-count 6 ``` 出力: ``` { "StreamName": "samplestream", "CurrentShardCount": 3, "TargetShardCount": 6 } ``` 詳細については、「*Amazon Kinesis Data Streams デベロッパーガイド*」の「[ストリームをリシャーディングする](https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-resharding.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateShardCount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kinesis/update-shard-count.html)」を参照してください。 # AWS KMS examples using AWS CLI 次のコード例では、AWS KMS で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `cancel-key-deletion` 次のコード例は、`cancel-key-deletion` を使用する方法を示しています。 **AWS CLI** **カスタマーマネージド KMS キーのスケジュールされた削除をキャンセルするには** 次の `cancel-key-deletion` の例では、カスタマーマネージド KMS キーのスケジュールされた削除をキャンセルします。 ``` aws kms cancel-key-deletion \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` 出力: ``` { "KeyId": "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab" } ``` `cancel-key-deletion` コマンドが成功すると、スケジュールされた削除はキャンセルされます。ただし、KMS キーのキー状態は `Disabled` であるため、暗号化オペレーションで KMS キーを使用することはできません。機能を復元するには、`enable-key` コマンドを使用します。 詳細については、「*AWS Key Management Service デベロッパーガイド*」の「[キーの削除のスケジュールとキャンセル](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html#deleting-keys-scheduling-key-deletion)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelKeyDeletion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/cancel-key-deletion.html)」を参照してください。 ### `connect-custom-key-store` 次のコード例は、`connect-custom-key-store` を使用する方法を示しています。 **AWS CLI** **カスタムキーストアを接続するには** 次の `connect-custom-key-store` の例では、指定されたカスタムキーストアを再接続します。このようなコマンドを使用すると、カスタムキーストアを初めて接続したり、切断されたキーストアを再接続したりできます。 このコマンドは、AWS CloudHSM キーストアまたは外部キーストアの接続に使用できます。 ``` aws kms connect-custom-key-store \ --custom-key-store-id cks-1234567890abcdef0 ``` このコマンドは出力を返しません。コマンドが有効であることを確認するには、`describe-custom-key-stores` コマンドを使用します。 AWS CloudHSM キーストアの接続については、「*AWS Key Management Service デベロッパーガイド*」の「[Connecting and disconnecting an AWS CloudHSM key store](https://docs.aws.amazon.com/kms/latest/developerguide/disconnect-keystore.html)」を参照してください。 外部キーストアの接続については、「*AWS Key Management Service デベロッパーガイド*」の「[外部キーストアの接続と切断](https://docs.aws.amazon.com/kms/latest/developerguide/xks-connect-disconnect.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ConnectCustomKeyStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/connect-custom-key-store.html)」を参照してください。 ### `create-alias` 次のコード例は、`create-alias` を使用する方法を示しています。 **AWS CLI** **KMS キーのエイリアスを作成するには** 次の `create-alias` コマンドは、キー ID `1234abcd-12ab-34cd-56ef-1234567890ab` で識別される KMS キーの `example-alias` という名前のエイリアスを作成します。 エイリアス名は `alias/` で始める必要があります。`alias/aws` で始まるエイリアス名は使用しないでください。これらは AWS 用に予約されています。 ``` aws kms create-alias \ --alias-name alias/example-alias \ --target-key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` このコマンドは出力を返しません。新しいエイリアスを確認するには、`list-aliases` コマンドを使用します。 詳細については、「AWS Key Management Service デベロッパーガイド」の「[エイリアスの使用](https://docs.aws.amazon.com/kms/latest/developerguide/kms-alias.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[CreateAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/create-alias.html)」を参照してください。** ### `create-custom-key-store` 次のコード例は、`create-custom-key-store` を使用する方法を示しています。 **AWS CLI** **例 1: AWS CloudHSM キーストアを作成するには** 次の `create-custom-key-store` の例では、必須パラメータを使用して、AWS CloudHSM クラスターによってサポートされる AWS CloudHSM キーストアを作成します。また、`custom-key-store-type``parameter with the default value: ``AWS_CLOUDHSM` を追加することもできます AWS CLI で `trust-anchor-certificate` コマンドのファイル入力を指定するには、`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 ``` 出力: ``` { "CustomKeyStoreId": cks-1234567890abcdef0 } ``` 詳細については、「*AWS Key Management Service デベロッパーガイド*」の「[Creating an AWS CloudHSM key store](https://docs.aws.amazon.com/kms/latest/developerguide/create-keystore.html)」を参照してください。 **例 2: パブリックエンドポイント接続を使用する外部キーストアを作成するには** 次の `create-custom-key-store` の例では、インターネット経由で AWS KMS と通信する外部キーストア (XKS) を作成します。 この例では、`XksProxyUriPath` はオプションのプレフィックス `example-prefix` を使用します。 注: AWS CLI バージョン 1.0 を使用している場合は、次のコマンドを実行してから HTTP または HTTPS 値を持つパラメータ (XksProxyUriEndpoint パラメータなど) を指定します。 ``` aws configure set cli_follow_urlparam false ``` そうしないと、AWS CLI バージョン 1.0 が、パラメータ値をその 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=" ``` 出力: ``` { "CustomKeyStoreId": cks-2234567890abcdef0 } ``` 詳細については、「AWS Key Management Service デベロッパーガイド」の「[外部キーストアの作成](https://docs.aws.amazon.com/kms/latest/developerguide/create-keystorecreate-xks-keystore.html)」を参照してください。** **例 3: VPC エンドポイントサービス接続を使用する外部キーストアを作成するには** 次の `create-custom-key-store` の例では、Amazon VPC エンドポイントサービスを使用して AWS KMS と通信する外部キーストア (XKS) を作成します。 注: AWS CLI バージョン 1.0 を使用している場合は、次のコマンドを実行してから HTTP または HTTPS 値を持つパラメータ (XksProxyUriEndpoint パラメータなど) を指定します。 ``` aws configure set cli_follow_urlparam false ``` そうしないと、AWS CLI バージョン 1.0 が、パラメータ値をその 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=" ``` 出力: ``` { "CustomKeyStoreId": cks-3234567890abcdef0 } ``` 詳細については、「AWS Key Management Service デベロッパーガイド」の「[外部キーストアの作成](https://docs.aws.amazon.com/kms/latest/developerguide/create-keystorecreate-xks-keystore.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCustomKeyStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/create-custom-key-store.html)」を参照してください。 ### `create-grant` 次のコード例は、`create-grant` を使用する方法を示しています。 **AWS CLI** **権限を作成するには** 次の `create-grant` の例は、`exampleUser` ユーザーが `1234abcd-12ab-34cd-56ef-1234567890ab` の KMS キーで `decrypt` コマンドを使用する権限を作成します。廃止するプリンシパルは `adminRole` ロールです。この権限は `EncryptionContextSubset` 権限の制約を使用して `"Department": "IT"` キー値ペアを含む `decrypt` リクエストでの暗号化のみを許可します。 ``` 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 ``` 出力: ``` { "GrantId": "1a2b3c4d2f5e69f440bae30eaec9570bb1fb7358824f9ddfa1aa5a0dab1a59b2", "GrantToken": "" } ``` 権限に関する詳細情報を表示するには、`list-grants` コマンドを使用します。 詳細については、「AWS Key Management Service デベロッパーガイド」の「[AWS KMS でのグラント](https://docs.aws.amazon.com/kms/latest/developerguide/grants.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[CreateGrant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/create-grant.html)」を参照してください。** ### `create-key` 次のコード例は、`create-key` を使用する方法を示しています。 **AWS CLI** **例 1: AWS KMS でカスタマーマネージドキーを作成するには** 次の `create-key` の例は、対称暗号化 KMS キーを作成します。 基本的な KMS キー (対称暗号化キー) を作成するには、パラメータを指定する必要はありません。対称暗号化キーは、これらのパラメータのデフォルト値によって作成されます。 このコマンドはキーポリシーを指定しないため、KMS キーにはプログラムで作成された KMS キーの[デフォルトキーポリシー](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default)が適用されます。キーポリシーを表示するには、`get-key-policy` コマンドを使用します。キーポリシーを変更するには、`put-key-policy` コマンドを使用します。 ``` aws kms create-key ``` この `create-key` コマンドは、新しい KMS キーのキー ID と ARN を含むキーメタデータを返します。これらの値を使用して、他の AWS KMS オペレーションで KMS キーを識別できます。出力にはタグは含まれません。KMS キーのタグを表示するには、`list-resource-tags command` を使用します。 出力: ``` { "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" ] } } ``` 注: この `create-key` コマンドではエイリアスを指定できません。新しい KMS キーのエイリアスを作成するには、`create-alias` コマンドを使用してください。 詳細については、「AWS Key Management Service デベロッパーガイド」の「[キーの作成](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html)」を参照してください。** **例 2: 暗号化と復号用の非対称 RSA KMS キーを作成するには** 次の `create-key` の例は、暗号化と復号用の非対称 RSA キーペアを含む KMS キーを作成します。キーの作成後は、キー仕様とキーの使用方法を変更することはできません。 ``` aws kms create-key \ --key-spec RSA_4096 \ --key-usage ENCRYPT_DECRYPT ``` 出力: ``` { "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" } } ``` 詳細については、「AWS Key Management Service デベロッパーガイド」の「[AWS KMS の非対称キー](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html)」を参照してください。** **例 3: 署名と検証用に非対称楕円曲線 KMS キーを作成するには** 署名と検証用に非対称楕円曲線 (ECC) キーペアを持つ非対称 KMS キーを作成します。`SIGN_VERIFY` は ECC KMS キーの唯一の有効な値ですが、`--key-usage` パラメータは必須です。キーの作成後は、キー仕様とキーの使用方法を変更することはできません。 ``` aws kms create-key \ --key-spec ECC_NIST_P521 \ --key-usage SIGN_VERIFY ``` 出力: ``` { "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" ] } } ``` 詳細については、「AWS Key Management Service デベロッパーガイド」の「[AWS KMS の非対称キー](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html)」を参照してください。** **例 4: 署名と検証用に非対称 ML-DSA KMS キーを作成するには** この例では、署名と検証用の Module-Lattice Digital Signature Algorithm (ML-DSA) キーを作成します。`SIGN_VERIFY` は ML-DSA キーの唯一の有効な値ですが、key-usage パラメータは必須です。 ``` aws kms create-key \ --key-spec ML_DSA_65 \ --key-usage SIGN_VERIFY ``` 出力: ``` { "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" ] } } ``` 詳細については、「AWS Key Management Service デベロッパーガイド」の「[AWS KMS の非対称キー](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html)」を参照してください。** **例 5: HMAC KMS キーを作成するには** 次の `create-key` の例は、384-bit HMAC KMS キーを作成します。`--key-usage` パラメータの値 `GENERATE_VERIFY_MAC` は HMAC KMS キーの唯一の有効な値ですが、この値は必須です。 ``` aws kms create-key \ --key-spec HMAC_384 \ --key-usage GENERATE_VERIFY_MAC ``` 出力: ``` { "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" } } ``` 詳細については、「AWS Key Management Service デベロッパーガイド」の「[AWS KMS での HMAC キー](https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html)」を参照してください。** **例 6: マルチリージョンのプライマリ KMS キーを作成するには** 次の `create-key` の例は、マルチリージョンのプライマリ対称暗号化キーを作成します。すべてのパラメータのデフォルト値によって対称暗号化キーが作成されるため、この KMS キーに必要なのは `--multi-region` パラメータだけです。AWS CLI で Boolean パラメータが true であることを示すには、パラメータ名を指定します。 ``` aws kms create-key \ --multi-region ``` 出力: ``` { "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" } } ``` 詳細については、「AWS Key Management Service デベロッパーガイド」の「[AWS KMS の非対称キー](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html)」を参照してください。** **例 7: インポートされたキーマテリアルの KMS キーを作成するには** 次の `create-key` の例は、キーマテリアルなしで KMS キーを作成します。操作が完了すると、独自のキーマテリアルを KMS キーにインポートできます。この KMS キーを作成するには、`--origin` パラメータを `EXTERNAL` に設定します。 ``` aws kms create-key \ --origin EXTERNAL ``` 出力: ``` { "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" } } ``` 詳細については、「AWS Key Management Service デベロッパーガイド」の「[AWS KMS キーのキーマテリアルのインポート](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html)」を参照してください。** **例 6: AWS CloudHSM キーストアに KMS キーを作成するには** 次の `create-key` の例は、指定された AWS CloudHSM キーストアに KMS キーを作成します。この操作は、KMS キーとそのメタデータを AWS KMS に作成し、カスタムキーストアに関連付けられた AWS CloudHSM クラスターにキーマテリアルを作成します。`--custom-key-store-id` および `--origin` パラメータが必要です。 ``` aws kms create-key \ --origin AWS_CLOUDHSM \ --custom-key-store-id cks-1234567890abcdef0 ``` 出力: ``` { "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" } } ``` 詳細については、「AWS Key Management Service デベロッパーガイド」の「[AWS CloudHSM キーストア](https://docs.aws.amazon.com/kms/latest/developerguide/keystore-cloudhsm.html)」を参照してください。** **例 8: 外部キーストアに KMS キーを作成するには** 次の `create-key` の例は、指定された外部キーストアに KMS キーを作成します。このコマンドでは、`--custom-key-store-id`、`--origin`、および `--xks-key-id` パラメータが必須です。 `--xks-key-id` パラメータは、外部キーマネージャーにある既存の対称暗号化キーの ID を指定します。このキーは KMS キーの外部キーマテリアルとして機能します。`--origin` パラメータの値は、`EXTERNAL_KEY_STORE` である必要があります。`custom-key-store-id` パラメータは、外部キーストアプロキシに接続されている外部キーストアを識別する必要があります。 ``` aws kms create-key \ --origin EXTERNAL_KEY_STORE \ --custom-key-store-id cks-9876543210fedcba9 \ --xks-key-id bb8562717f809024 ``` 出力: ``` { "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" } } } ``` 詳細については、「AWS Key Management Service デベロッパーガイド」の「[外部キーストア](https://docs.aws.amazon.com/kms/latest/developerguide/keystore-external.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[CreateKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/create-key.html)」を参照してください。** ### `decrypt` 次のコード例は、`decrypt` を使用する方法を示しています。 **AWS CLI** **例 1: 対称 KMS キーを使用して暗号化されたメッセージを復号するには (Linux および macOS)** 次の `decrypt` コマンドの例は、AWS CLI を使用してデータを復号する推奨方法を示します。このバージョンは、対称 KMS キーを使用してデータを復号する方法を示しています。 ファイルに暗号文を指定します。`--ciphertext-blob` パラメータの値には、バイナリファイルからデータを読み取るように CLI に指示する `fileb://` プレフィックスを使用します。ファイルが現在のディレクトリにない場合は、ファイルへのフルパスを入力します。ファイルから AWS CLI パラメータ値を読み取る方法の詳細については、「AWS Command Line Interface ユーザーガイド」の「ファイルから AWS CLI パラメータをロードする」、「AWS Command Line Tool Blog」の「Best Practices for Local File Parameters」 を参照してください****。暗号文を復号するには KMS キーを指定します。`--key-id` パラメータは対称 KMS キーを復号する際は必要ありません。AWSKMS は、データの暗号化に使用された KMS キーのキー ID を暗号文のメタデータから取得できます。ただし、ベストプラクティスは常に、使用している KMS キーを指定することです。この方法により、意図した KMS キーを使用することができ、信頼できない KMS キーを使用して誤って暗号文を復号するのを防ぐことができます。プレーンテキストの出力をテキスト値としてリクエストします。`--query` パラメータは、出力から `Plaintext` フィールドの値のみを取得するように CLI に指示します。`--output` パラメータは出力を text.Base64 でデコードしたプレーンテキストとして返し、ファイルに保存します。次の例では、`Plaintext` パラメータの値を Base64 ユーティリティにパイプ (\$1) して、Base64 ユーティリティでデコードします。次に、デコードされた出力を `ExamplePlaintext` ファイルにリダイレクト (>) します。 このコマンドを実行する前に、サンプルキー ID を AWS アカウントの有効なキー ID に置き換えます。 ``` aws kms decrypt \ --ciphertext-blob fileb://ExampleEncryptedFile \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --output text \ --query Plaintext | base64 \ --decode > ExamplePlaintextFile ``` このコマンドは何も出力しません。`decrypt` コマンドからの出力は base64 でデコードされ、ファイルに保存されます。 詳細については、「AWS Key Management Service API リファレンス」の「[Decrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html)」を参照してください。** **例 2: 対称 KMS キーを使用して暗号化されたメッセージを復号するには (Windows コマンドプロンプト)** 次の例は、`certutil` ユーティリティを使用してプレーンテキストデータを Base64 でデコードする点を除いて、前の例と同じです。この手順には、次の例に示すように 2 つのコマンドが必要です。 このコマンドを実行する前に、サンプルキー ID を AWS アカウントの有効なキー ID に置き換えます。 ``` aws kms decrypt ^ --ciphertext-blob fileb://ExampleEncryptedFile ^ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ^ --output text ^ --query Plaintext > ExamplePlaintextFile.base64 ``` `certutil` コマンドを実行します。 ``` certutil -decode ExamplePlaintextFile.base64 ExamplePlaintextFile ``` 出力: ``` Input Length = 18 Output Length = 12 CertUtil: -decode command completed successfully. ``` 詳細については、「AWS Key Management Service API リファレンス」の「[Decrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html)」を参照してください。** **例 3: 非対称 KMS キーを使用して暗号化されたメッセージを復号するには (Linux および macOS)** 次の `decrypt` コマンドの例は、RSA 非対称 KMS キーで暗号化されたデータを復号する方法を示します。 非対称 KMS キーを使用する場合は、プレーンテキストの暗号化に使用するアルゴリズムを指定する `encryption-algorithm` パラメータが必要です。 このコマンドを実行する前に、サンプルキー ID を AWS アカウントの有効なキー ID に置き換えます。 ``` 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 ``` このコマンドは何も出力しません。`decrypt` コマンドからの出力は base64 でデコードされ、ファイルに保存されます。 詳細については、「AWS Key Management Service デベロッパーガイド」の「[AWS KMS の非対称キー](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[Decrypt](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/decrypt.html)」を参照してください。** ### `delete-alias` 次のコード例は、`delete-alias` を使用する方法を示しています。 **AWS CLI** **AWS KMS エイリアスを削除するには** 次の `delete-alias` の例は、エイリアス `alias/example-alias` を削除します。エイリアス名は alias/ で始まる必要があります。 ``` aws kms delete-alias \ --alias-name alias/example-alias ``` このコマンドは何も出力しません。エイリアスを見つけるには、`list-aliases` コマンドを使用します。 詳細については、「AWS Key Management Service デベロッパーガイド」の「[エイリアスの削除](https://docs.aws.amazon.com/kms/latest/developerguide/alias-manage.html#alias-delete)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[DeleteAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/delete-alias.html)」を参照してください。** ### `delete-custom-key-store` 次のコード例は、`delete-custom-key-store` を使用する方法を示しています。 **AWS CLI** **カスタムキーストアを削除するには** 次の `delete-custom-key-store` の例では、指定されたカスタムキーストアを削除します。 AWS CloudHSM キーストアを削除しても、関連付けられた CloudHSM クラスターには影響しません。外部キーストアを削除しても、関連付けられた外部キーストアプロキシ、外部キーマネージャー、または外部キーには影響しません。 **注:** カスタムキーストアを削除する前に、カスタムキーストア内のすべての KMS キーの削除をスケジュールし、それらの KMS キーが削除されるまで待つ必要があります。その後、カスタムキーストアを切断する必要があります。カスタムキーストアで KMS キーを検索する方法については、「*AWS Key Management Service デベロッパーガイド*」の「[Delete an AWS CloudHSM key store (API)](https://docs.aws.amazon.com/kms/latest/developerguide/delete-keystore.html#delete-keystore-api)」を参照してください。 ``` delete-custom-key-store \ --custom-key-store-id cks-1234567890abcdef0 ``` このコマンドは出力を返しません。カスタムキーストアが削除されたことを確認するには、`describe-custom-key-stores` コマンドを使用します。 AWS CloudHSM キーストアの削除については、「*AWS Key Management Service デベロッパーガイド*」の「[Deleting an AWS CloudHSM key store](https://docs.aws.amazon.com/kms/latest/developerguide/delete-keystore.html)」を参照してください。 外部キーストアの削除については、「*AWS Key Management Service デベロッパーガイド*」の「[外部キーストアの削除](https://docs.aws.amazon.com/kms/latest/developerguide/delete-xks.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCustomKeyStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/delete-custom-key-store.html)」を参照してください。 ### `delete-imported-key-material` 次のコード例は、`delete-imported-key-material` を使用する方法を示しています。 **AWS CLI** **KMS キーからインポートされたキーマテリアルを削除するには** 次の `delete-imported-key-material` の例では、KMS キーにインポートされたキーマテリアルを削除します。 ``` aws kms delete-imported-key-material \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` 出力: ``` { "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", "KeyMaterialId": "0b7fd7ddbac6eef27907413567cad8c810e2883dc8a7534067a82ee1142fc1e6" } ``` 詳細については、「*AWS Key Management Service デベロッパーガイド*」の「[Deleting imported key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-delete-key-material.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteImportedKeyMaterial](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/delete-imported-key-material.html)」を参照してください。 ### `derive-shared-secret` 次のコード例は、`derive-shared-secret` を使用する方法を示しています。 **AWS CLI** **共有シークレットを取得するには** 次の `derive-shared-secret` の例では、キーアグリーメントアルゴリズムを使用して共有シークレットを取得します。 DeriveSharedSecret を呼び出すには、NIST 推奨楕円曲線 (ECC) または SM2 (中国リージョンのみ) の非対称 KMS キーペアを使用し、`KeyUsage`の値として `KEY_AGREEMENT` を指定する必要があります。 ``` aws kms derive-shared-secret \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --key-agreement-algorithm ECDH \ --public-key "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAvH3Yj0wbkLEpUl95Cv1cJVjsVNSjwGq3tCLnzXfhVwVvmzGN8pYj3U8nKwgouaHbBWNJYjP5VutbbkKS4Kv4GojwZBJyHN17kmxo8yTjRmjR15SKIQ8cqRA2uaERMLnpztIXdZp232PQPbWGxDyXYJ0aJ5EFSag" ``` 出力: ``` { "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", "SharedSecret": "MEYCIQCKZLWyTk5runarx6XiAkU9gv3lbwPO/pHa+DXFehzdDwIhANwpsIV2g/9SPWLLsF6p/hiSskuIXMTRwqrMdVKWTMHG", "KeyAgreementAlgorithm": "ECDH", "KeyOrigin": "AWS_KMS" } ``` 詳細については、「*AWS Key Management Service API リファレンス*」の「[DeriveSharedSecret](https://docs.aws.amazon.com/kms/latest/APIReference/API_DeriveSharedSecret.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeriveSharedSecret](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/derive-shared-secret.html)」を参照してください。 ### `describe-custom-key-stores` 次のコード例は、`describe-custom-key-stores` を使用する方法を示しています。 **AWS CLI** **例 1: AWS CloudHSM キーストアの詳細を取得するには** 次の `describe-custom-key-store` の例では、指定された AWS CloudHSM キーストアの詳細を表示します。コマンドはどのタイプのカスタムキーストアでも同じですが、出力はキーストアのタイプと接続オプション (外部キーストアの場合) によって異なります。 デフォルトでは、このコマンドはアカウントとリージョン内のすべてのカスタムキーストアに関する情報を表示します。特定のカスタムキーストアに関する情報を表示するには、`custom-key-store-name` または `custom-key-store-id` パラメータを使用します。 ``` aws kms describe-custom-key-stores \ --custom-key-store-name ExampleCloudHSMKeyStore ``` このコマンドの出力には、接続状態 (`ConnectionState`) など、AWS CloudHSM キーストアに関する有益な詳細が含まれています。接続状態が `FAILED` の場合、出力には問題を説明する `ConnectionErrorCode` が含まれています。 出力: ``` { "CustomKeyStores": [ { "CloudHsmClusterId": "cluster-1a23b4cdefg", "ConnectionState": "CONNECTED", "CreationDate": "2022-04-05T14:04:55-07:00", "CustomKeyStoreId": "cks-1234567890abcdef0", "CustomKeyStoreName": "ExampleExternalKeyStore", "TrustAnchorCertificate": "" } ] } ``` 詳細については、「*AWS Key Management Service デベロッパーガイド*」の「[Viewing an AWS CloudHSM key store](https://docs.aws.amazon.com/kms/latest/developerguide/view-keystore.html)」を参照してください。 **例 2: パブリックエンドポイント接続を使用する外部キーストアの詳細を取得するには** 次の `describe-custom-key-store` の例では、指定された外部キーストアの詳細を表示します。コマンドはどのタイプのカスタムキーストアでも同じですが、出力はキーストアのタイプと接続オプション (外部キーストアの場合) によって異なります。 デフォルトでは、このコマンドはアカウントとリージョン内のすべてのカスタムキーストアに関する情報を表示します。特定のカスタムキーストアに関する情報を表示するには、`custom-key-store-name` または `custom-key-store-id` パラメータを使用します。 ``` aws kms describe-custom-key-stores \ --custom-key-store-id cks-9876543210fedcba9 ``` このコマンドの出力には、接続状態 (`ConnectionState`) など、外部キーストアに関する有益な詳細が含まれています。接続状態が `FAILED` の場合、出力には問題を説明する `ConnectionErrorCode` が含まれています。 出力: ``` { "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" } } ] } ``` 詳細については、「AWS Key Management Service デベロッパーガイド」の「[外部キーストアを表示する](https://docs.aws.amazon.com/kms/latest/developerguide/view-xks-keystore.html)」を参照してください。** **例 3: VPC エンドポイントサービス接続を使用する外部キーストアの詳細を取得するには** 次の `describe-custom-key-store` の例では、指定された外部キーストアの詳細を表示します。コマンドはどのタイプのカスタムキーストアでも同じですが、出力はキーストアのタイプと接続オプション (外部キーストアの場合) によって異なります。 デフォルトでは、このコマンドはアカウントとリージョン内のすべてのカスタムキーストアに関する情報を表示します。特定のカスタムキーストアに関する情報を表示するには、`custom-key-store-name` または `custom-key-store-id` パラメータを使用します。 ``` aws kms describe-custom-key-stores \ --custom-key-store-id cks-2234567890abcdef0 ``` このコマンドの出力には、接続状態 (`ConnectionState`) など、外部キーストアに関する有益な詳細が含まれています。接続状態が `FAILED` の場合、出力には問題を説明する `ConnectionErrorCode` が含まれています。 出力: ``` { "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" } } ] } ``` 詳細については、「AWS Key Management Service デベロッパーガイド」の「[外部キーストアを表示する](https://docs.aws.amazon.com/kms/latest/developerguide/view-xks-keystore.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeCustomKeyStores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/describe-custom-key-stores.html)」を参照してください。 ### `describe-key` 次のコード例は、`describe-key` を使用する方法を示しています。 **AWS CLI** **例 1: KMS キーの詳細情報を取得するには** 次の `describe-key` の例は、サンプルアカウントとリージョン内にある Amazon S3 の AWS マネージドキーに関する詳細情報を取得します。このコマンドを使用して、AWS マネージドキーとカスタマーマネージドキーに関する詳細を取得できます。 KMS キーを指定するには、`key-id` パラメータを使用します。この例では、エイリアス名値を使用していますが、このコマンドでは、キー ID、キー ARN、エイリアス名、またはエイリアス ARN を使用できます。 ``` aws kms describe-key \ --key-id alias/aws/s3 ``` 出力: ``` { "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" ] } } ``` 詳細については、「AWS Key Management Service デベロッパーガイド」の「[キーの表示](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html)」を参照してください。** **例 2: RSA 非対称 KMS キーの詳細を取得するには** 次の `describe-key` の例は、署名と検証に使用される非対称 RSA KMS キーに関する詳細情報を取得します。 ``` aws kms describe-key \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` 出力: ``` { "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" ] } } ``` **例 3: マルチリージョンのレプリカキーに関する詳細を取得するには** 次の `describe-key` の例は、マルチリージョンのレプリカキーのメタデータを取得します。このマルチリージョンキーは対称暗号化キーです。マルチリージョンキーの `describe-key` コマンドの出力は、プライマリキーとそのすべてのレプリカに関する情報を返します。 ``` aws kms describe-key \ --key-id arn:aws:kms:ap-northeast-1:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab ``` 出力: ``` { "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" } ] } } } ``` **例 4: HMAC KMS キーの詳細を取得するには** 次の `describe-key` の例は、HMAC KMS キーの詳細情報を取得します。 ``` aws kms describe-key \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` 出力: ``` { "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 } } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/describe-key.html)」を参照してください。** ### `disable-key-rotation` 次のコード例は、`disable-key-rotation` を使用する方法を示しています。 **AWS CLI** **KMS キーの自動ローテーションを無効にするには** 次の `disable-key-rotation` の例では、カスタマーマネージド KMS キーの自動ローテーションを無効にします。自動ローテーションを再度有効にするには、`enable-key-rotation` コマンドを使用します。 ``` aws kms disable-key-rotation \ --key-id arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab ``` このコマンドは何も出力しません。KMS キーの自動ローテーションが無効になったことを確認するには、`get-key-rotation-status` コマンドを使用します。 詳細については、「*AWS Key Management Service Developer Guide*」の「[Rotating keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisableKeyRotation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/disable-key-rotation.html)」を参照してください。 ### `disable-key` 次のコード例は、`disable-key` を使用する方法を示しています。 **AWS CLI** **KMS キーを一時的に無効にするには** 次の `disable-key` コマンドは、カスタマーマネージド KMS キーを無効にします。KMS キーを再度有効にするには、`enable-key` コマンドを使用します。 ``` aws kms disable-key \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` このコマンドは何も出力しません。 詳細については、「AWS Key Management Service デベロッパーガイド」の「[キーの有効化と無効化](https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンス**の「[DisableKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/disable-key.html)」を参照してください。 ### `disconnect-custom-key-store` 次のコード例は、`disconnect-custom-key-store` を使用する方法を示しています。 **AWS CLI** **カスタムキーストアを切断するには** 次の `disconnect-custom-key-store` の例では、カスタムキーストアを AWS CloudHSM クラスターから切断します。キーストアを切断するのは、問題をトラブルシューティングする場合、キーストアの設定を更新する場合、キーストアの KMS キーが暗号化オペレーションで使用されないようにする場合です。 このコマンドは、AWS CloudHSM キーストアや外部キーストアなど、どのカスタムキーストアでも同じです。 このコマンドを実行する前に、例のカスタムキーストア ID を有効な ID に置き換えます。 ``` $ aws kms disconnect-custom-key-store \ --custom-key-store-id cks-1234567890abcdef0 ``` このコマンドでは何も出力されません。コマンドが有効であることを確認するには、`describe-custom-key-stores` コマンドを使用します。 AWS CloudHSM キーストアの切断については、「*AWS Key Management Service デベロッパーガイド*」の「[Connecting and disconnecting an AWS CloudHSM key store](https://docs.aws.amazon.com/kms/latest/developerguide/disconnect-keystore.html)」を参照してください。 外部キーストアの切断については、「*AWS Key Management Service デベロッパーガイド*」の「[外部キーストアの接続と切断](https://docs.aws.amazon.com/kms/latest/developerguide/xks-connect-disconnect.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisconnectCustomKeyStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/disconnect-custom-key-store.html)」を参照してください。 ### `enable-key-rotation` 次のコード例は、`enable-key-rotation` を使用する方法を示しています。 **AWS CLI** **KMS キーの自動ローテーションを有効化するには** 次の`enable-key-rotation` 例では、カスタマーマネージド KMS キーの自動ローテーションを、ローテーション期間が 180 日となるよう有効化します。KMS キーは、このコマンドの完了日から 1 年後 (約 365 日後) にローテーションされ、その後も毎年自動ローテーションされます。 `--key-id` パラメータは KMS キーを識別します。この例ではキーの ARN 値を使用していますが、KMS キーのキー ID または ARN のどちらでも使用可能です。`--rotation-period-in-days` パラメータで次のローテーション日までの日数を指定します。90 日から 2560 日までの範囲で値を指定してください。値を指定しない場合、デフォルトは 365 日になります。 ``` 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 ``` このコマンドは何も出力しません。KMS キーが有効になっていることを確認するには、`get-key-rotation-status` コマンドを使用します。 詳細については、「*AWS Key Management Service Developer Guide*」の「[Rotating keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EnableKeyRotation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/enable-key-rotation.html)」を参照してください。 ### `enable-key` 次のコード例は、`enable-key` を使用する方法を示しています。 **AWS CLI** **KMS キーを有効にするには** 次の `enable-key` の例は、カスタマーマネージドキーを有効にします。このようなコマンドでは、`disable-key` コマンドを使用して一時的に無効にした KMS キーを有効にできます。また、削除が予定されていて削除がキャンセルされたために無効になっている KMS キーを有効にすることもできます。 KMS キーを指定するには、`key-id` パラメータを使用します。この例では、キー ID 値を使用していますが、このコマンドでは、キー ID またはキー ARN 値を使用できます。 このコマンドを実行する前に、サンプルキー ID を有効なキー ID に置き換えます。 ``` aws kms enable-key \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` このコマンドは何も出力しません。KMS キーが有効になっていることを確認するには、`describe-key` コマンドを使用します。`describe-key` 出力の `KeyState` および `Enabled` フィールドの値を参照してください。 詳細については、「AWS Key Management Service デベロッパーガイド」の「[キーの有効化と無効化](https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンス**の「[EnableKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/enable-key.html)」を参照してください。 ### `encrypt` 次のコード例は、`encrypt` を使用する方法を示しています。 **AWS CLI** **例 1: Linux または MacOS でファイルの内容を暗号化するには** 次の `encrypt` コマンドは、AWS CLI を使用してデータを暗号化する推奨方法を示します。 ``` aws kms encrypt \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --plaintext fileb://ExamplePlaintextFile \ --output text \ --query CiphertextBlob | base64 \ --decode > ExampleEncryptedFile ``` このコマンドは、以下の操作を行います。 `--plaintext` パラメータを使用して暗号化するデータを指定します。このパラメータ値は base64 でエンコードされている必要があります。`plaintext` パラメータの値は base64 でエンコードされているか、AWS CLI にファイルからバイナリデータを読み取るように命令する `fileb://` プレフィックスを使用する必要があります。ファイルが現在のディレクトリにない場合は、ファイルへのフルパスを入力します。例えば、`fileb:///var/tmp/ExamplePlaintextFile` や `fileb://C:\Temp\ExamplePlaintextFile` などです。ファイルからの AWS CLI パラメータの読み取りの詳細については、「*AWS Command Line Interface ユーザーガイド*」の「[AWS CLI でのパラメータ値の指定](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-file)」および「AWS Command Line Tool Blog」の「[ローカルファイルパラメータのベストプラクティス](https://blogs.aws.amazon.com/cli/post/TxLWWN1O25V1HE/Best-Practices-for-Local-File-Parameters)」を参照してください。`--output` パラメータと `--query` パラメータを使用して、コマンドの出力を制御します。これらのパラメータは、コマンドの出力から「*暗号文*」と呼ばれる暗号化データを抽出します。出力の制御の詳細については、「*AWS Command Line Interface ユーザーガイド*」の「[AWS CLI でのコマンド出力の制御](https://docs.aws.amazon.com/cli/latest/userguide/controlling-output.html)」を参照してください。抽出された出力をバイナリデータにデコードするには `base64` ユーティリティを使用します。`encrypt` コマンドが正常に処理された場合に返される暗号文は、base64 でエンコードされたテキストです。AWS CLI を使用して復号する前に、このテキストをデコードする必要があります。バイナリ暗号文をファイルに保存します。コマンド (`> ExampleEncryptedFile`) の最後の部分では、復号を容易にするためにバイナリ暗号文をファイルに保存します。AWS CLI を使用してデータを復号するコマンドの例については、復号の例を参照してください。 **例 2: AWS CLI を使用して Windows のデータを暗号化する** この例は前の例と同じですが、`base64` の代わりに `certutil` ツールを使用します。この手順には、次の例に示すように 2 つのコマンドが必要です。 ``` 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 ``` **例 3: 非対称 KMS キーを使用して暗号化する** 次の `encrypt` コマンドは、プレーンテキストを非対称 KMS キーで暗号化する方法を示しています。`--encryption-algorithm` パラメータは必須です。すべての `encrypt` CLI コマンドと同様に、`plaintext` パラメータは base64 でエンコードされているか、ファイルからバイナリデータを読み取るように AWS CLI に指示する `fileb://` プレフィックスを使用する必要があります。 ``` 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 ``` このコマンドは何も出力しません。 + API の詳細については、AWS CLI コマンドリファレンスの「[Encrypt](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/encrypt.html)」を参照してください。** ### `generate-data-key-pair-without-plaintext` 次のコード例は、`generate-data-key-pair-without-plaintext` を使用する方法を示しています。 **AWS CLI** **ECC NIST P384 非対称データキーペアを生成するには** 次の `generate-data-key-pair-without-plaintext` 例では、ECC NIST P384 キーペアを AWS の外部で使用することをリクエストしています。 このコマンドは、プレーンテキストのパブリックキーとおよび指定された KMS キーで暗号化されたプライベートキーのコピーを返します。プレーンテキストのプライベートキーは返されません。暗号化されたプライベートキーを暗号化されたデータに安全に保存し、使用する必要がある場合は AWS KMS を呼び出してプライベートキーを復号できます。 ECC NIST P384 非同期データキーペアをリクエストするには、値 `ECC_NIST_P384` を含む `key-pair-spec` パラメータを使用します。 指定する KMS キーは、対称暗号化 KMS キー、つまり `KeySpec` が `SYMMETRIC_DEFAULT` の KMS キーである必要があります。 注: この例の出力の値は、表示のために一部が切り捨てられています。 ``` aws kms generate-data-key-pair-without-plaintext \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --key-pair-spec ECC_NIST_P384 ``` 出力: ``` { "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" } ``` `PublicKey` と `PrivateKeyCiphertextBlob` は base64 でエンコードされた形式で返されます。 詳細については、「AWS Key Management Service デベロッパーガイド」の「[データキーペア](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-key-pairs)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GenerateDataKeyPairWithoutPlaintext](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/generate-data-key-pair-without-plaintext.html)」を参照してください。 ### `generate-data-key-pair` 次のコード例は、`generate-data-key-pair` を使用する方法を示しています。 **AWS CLI** **ビット RSA 非対称データキーペアを生成するには** 次の `generate-data-key-pair` の例では、2048 ビットの RSA 非対称データキーペアを AWS の外部で使用するようにリクエストします。このコマンドは、すぐに使用および削除できるプレーンテキストのパブリックキーとプレーンテキストのプライベートキー、および指定された KMS キーで暗号化されたプライベートキーのコピーを返します。暗号化されたデータとともに、暗号化されたプライベートキーを安全に保存できます。 2048 ビットの RSA 非同期データキーペアをリクエストするには、値 `RSA_2048` を含む `key-pair-spec` パラメータを使用します。 指定する KMS キーは、対称暗号化 KMS キー、つまり `KeySpec` が `SYMMETRIC_DEFAULT` の KMS キーである必要があります。 注: この例の出力の値は、表示のために一部が切り捨てられています。 ``` aws kms generate-data-key-pair \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --key-pair-spec RSA_2048 ``` 出力: ``` { "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" } ``` `PublicKey`、`PrivateKeyPlaintext`、`PrivateKeyCiphertextBlob` が base64 エンコード形式で返されます。 詳細については、「AWS Key Management Service デベロッパーガイド」の「[データキーペア](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-key-pairs)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GenerateDataKeyPair](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/generate-data-key-pair.html)」を参照してください。 ### `generate-data-key-without-plaintext` 次のコード例は、`generate-data-key-without-plaintext` を使用する方法を示しています。 **AWS CLI** **プレーンテキストキーを使用せずに 256 ビットの対称データキーを生成するには** 次の `generate-data-key-without-plaintext` の例は、256 ビットの対称データキーの暗号化コピーを AWS の外部で使用するようにリクエストします。データキーを使用する準備ができたら、AWS KMS を呼び出してデータキーを復号できます。 256 ビットのデータキーをリクエストするには、値 `AES_256` を含む `key-spec` パラメータを使用します。128 ビットのデータキーをリクエストするには、値 `AES_128` を含む `key-spec` パラメータを使用します。その他のすべてのデータキー長には、`number-of-bytes` パラメーターを使用します。 指定する KMS キーは、対称暗号化 KMS キー、つまりキースペック値が SYMMETRIC\$1DEFAULT の KMS キーである必要があります。 ``` 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 ``` 出力: ``` { "CiphertextBlob": "AQEDAHjRYf5WytIc0C857tFSnBaPn2F8DgfmThbJlGfR8P3WlwAAAH4wfAYJKoZIhvcNAQcGoG8wbQIBADBoBgkqhkiG9w0BBwEwHgYJYIZIAWUDBAEuMBEEDEFogL", "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", "KeyMaterialId": "0b7fd7ddbac6eef27907413567cad8c810e2883dc8a7534067a82ee1142fc1e6" } ``` `CiphertextBlob` (暗号化されたデータキー) は base64 でエンコードされた形式で返されます。 詳細については、「AWS Key Management Service デベロッパーガイド」の「[データキー](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[GenerateDataKeyWithoutPlaintext](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/generate-data-key-without-plaintext.html)」を参照してください。** ### `generate-data-key` 次のコード例は、`generate-data-key` を使用する方法を示しています。 **AWS CLI** **例 1: 256 ビットの対称データキーを生成するには** 次の `generate-data-key` の例は、256 ビットの対称データキーを AWS の外部で使用するようにリクエストします。このコマンドは、すぐに使用および削除できるプレーンテキストのデータキーと、指定された KMS キーで暗号化されたデータキーのコピーを返します。暗号化されたデータとともに、暗号化されたデータキーを安全に保存できます。 256 ビットのデータキーをリクエストするには、値 `AES_256` を含む `key-spec` パラメータを使用します。128 ビットのデータキーをリクエストするには、値 `AES_128` を含む `key-spec` パラメータを使用します。その他のすべてのデータキー長には、`number-of-bytes` パラメーターを使用します。 指定する KMS キーは、対称暗号化 KMS キー、つまりキースペック値が SYMMETRIC\$1DEFAULT の KMS キーである必要があります。 ``` aws kms generate-data-key \ --key-id alias/ExampleAlias \ --key-spec AES_256 ``` 出力: ``` { "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=" } ``` `Plaintext` (プレーンテキストデータキー) と `CiphertextBlob` (暗号化データキー) は base64 でエンコードされた形式で返されます。 詳細については、「AWS Key Management Service デベロッパーガイド」の「[データキー](https://docs.aws.amazon.com/kms/latest/developerguide/data-keys.html)」を参照してください。****例 2: 512 ビットの対称データキーを生成するには** 次の `generate-data-key` の例は、暗号化と復号用の 512 ビットの対称データキーを要求します。このコマンドは、すぐに使用および削除できるプレーンテキストのデータキーと、指定された KMS キーで暗号化されたデータキーのコピーを返します。暗号化されたデータとともに、暗号化されたデータキーを安全に保存できます。 128 ビットまたは 256 ビット以外のキー長をリクエストするには、`number-of-bytes` パラメーターを使用します。512 ビットのデータキーをリクエストするために、次の例では値が 64 (バイト) の `number-of-bytes` パラメータを使用します。 指定する KMS キーは、対称暗号化 KMS キー、つまりキースペック値が SYMMETRIC\$1DEFAULT の KMS キーである必要があります。 注: この例の出力の値は、表示のために一部が切り捨てられています。 ``` aws kms generate-data-key \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --number-of-bytes 64 ``` 出力: ``` { "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` (プレーンテキストデータキー) と `CiphertextBlob` (暗号化データキー) は base64 でエンコードされた形式で返されます。 詳細については、「AWS Key Management Service デベロッパーガイド」の「[データキー](https://docs.aws.amazon.com/kms/latest/developerguide/data-keys.html)」を参照してください。** + API の詳細については、*AWS CLI コマンドリファレンス*の「[GenerateDataKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/generate-data-key.html)」を参照してください。 ### `generate-mac` 次のコード例は、`generate-mac` を使用する方法を示しています。 **AWS CLI** **例 1: メッセージの HMAC を生成するには** 次の `generate-mac` コマンドは、メッセージの HMAC、HMAC KMS キー、および MAC アルゴリズムを生成します。アルゴリズムは、指定された HMAC KMS キーでサポートされる必要があります。 AWS CLI v2 では、`message` パラメータの値は Base64 でエンコードされている必要があります。または、メッセージをファイルに保存し、`fileb://` プレフィックスを使用することも可能です。このプレフィックスは、ファイルからバイナリデータを読み取るように AWS CLI に指示します。 このコマンドを実行する前に、サンプルキー ID を AWS アカウントの有効なキー ID に置き換えます。キー ID は、キー用途が `GENERATE_VERIFY_MAC` の HMAC KMS キーを表す必要があります。 ``` msg=(echo 'Hello World' | base64) aws kms generate-mac \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --message fileb://Message \ --mac-algorithm HMAC_SHA_384 ``` 出力: ``` { "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", "Mac": "", "MacAlgorithm": "HMAC_SHA_384" } ``` AWS KMS での HMAC KMS キー使用の詳細については、「*AWS Key Management Service デベロッパーガイド*」の「[HMAC keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html)」を参照してください。 **例 2: HMAC をファイルに保存するには (Linux および macOS)** 次の `generate-mac` の例では、ローカルファイルに保存されている短いメッセージ向けの HMAC を生成します。コマンドはレスポンスから `Mac` プロパティも取得し、これを Base64 デコードして ExampleMac ファイルに保存します。この MAC ファイルを、MAC を検証する `verify-mac` コマンドで使用できます。 `generate-mac` コマンドには、Base64 エンコードされたメッセージと、HMAC KMS キーがサポートする MAC アルゴリズムが必要です。KMS キーがサポートする MAC アルゴリズムを取得するには、`describe-key` コマンドを使用します。 このコマンドを実行する前に、サンプルキー ID を AWS アカウントの有効なキー ID に置き換えます。キー ID は、キー用途が GENERATE\$1VERIFY\$1MAC である非対称 KMS キーを表している必要があります。 ``` 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 ``` このコマンドでは何も出力されません。この例では、出力の `Mac` プロパティを抽出し、ファイルに保存します。 AWS KMS での HMAC KMS キー使用の詳細については、「*AWS Key Management Service デベロッパーガイド*」の「[HMAC keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GenerateMac](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/generate-mac.html)」を参照してください。 ### `generate-random` 次のコード例は、`generate-random` を使用する方法を示しています。 **AWS CLI** **例 1: 256 ビットのランダムバイト文字列を生成するには (Linux または macOs)** 次の `generate-random` の例は、256 ビット (32 バイト) の base64 でエンコードされたランダムバイト文字列を生成します。この例は、バイト文字列をデコードしてランダムファイルに保存します。 このコマンドを実行する際は、`number-of-bytes` パラメーターを使用してランダム値の長さをバイト単位で指定する必要があります。 このコマンドを実行する際は、KMS キーは指定しません。ランダムバイト文字列は KMS キーとは関係ありません。 デフォルトでは、AWS KMS は乱数を生成します。ただし、[カスタムキーストア](https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html)を指定すると、カスタムキーストアに関連付けられた AWS CloudHSM クラスターにランダムなバイト文字列が生成されます。 この例は以下のパラメータと値を使用します。 32 バイト (256 ビット) の文字列をリクエストするには、`32` の値を持つ必須の `--number-of-bytes` パラメータを使用します。JSON の代わりにテキスト出力を AWS CLI が返すようにするには、`text` の値を持つ `--output` パラメータを使用します。レスポンスから `Plaintext` プロパティの値を抽出するには `--query parameter` を使用します。`base64` ユーティリティへのコマンドの出力をパイプ ( \$1 ) します。これは、抽出された出力を復号します。リダイレクト演算子 ( > ) を使用して、バイト文字列を `ExampleRandom` ファイルに保存します。リダイレクト演算子 ( > ) を使用して、バイナリ暗号文をファイルに保存します。 ``` aws kms generate-random \ --number-of-bytes 32 \ --output text \ --query Plaintext | base64 --decode > ExampleRandom ``` このコマンドは何も出力しません。 詳細については、「AWS Key Management Service API リファレンス」の「[GenerateRandom](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateRandom.html)」を参照してください。** **例 2: 256 ビットの乱数を生成するには (Windows コマンドプロンプト)** 次の例は、`generate-random` コマンドを使用して、base64 でエンコードされた 256 ビット (32 バイト) のランダムバイト文字列を生成します。この例は、バイト文字列をデコードしてランダムファイルに保存します。この例は前の例と同じですが、Windows の `certutil` のユーティリティを使用して、ランダムバイト文字列を base64 でデコードしてからファイルに保存する点が異なります。 最初に base64 でエンコードされたランダムバイト文字列を生成し、テンポラリファイル (`ExampleRandom.base64`) に保存します。 ``` aws kms generate-random \ --number-of-bytes 32 \ --output text \ --query Plaintext > ExampleRandom.base64 ``` `generate-random` コマンドの出力はファイルに保存されるため、この例では何も出力されません。 次に、`certutil -decode` コマンドを使用して、`ExampleRandom.base64` ファイル内の base64 でエンコードされたバイト文字列をデコードします。その後、デコードされたバイト文字列を `ExampleRandom` ファイルに保存します。 ``` certutil -decode ExampleRandom.base64 ExampleRandom ``` 出力: ``` Input Length = 18 Output Length = 12 CertUtil: -decode command completed successfully. ``` 詳細については、「AWS Key Management Service API リファレンス」の「[GenerateRandom](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateRandom.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[GenerateRandom](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/generate-random.html)」を参照してください。** ### `get-key-policy` 次のコード例は、`get-key-policy` を使用する方法を示しています。 **AWS CLI** **ある KMS キーから別の KMS キーにキーポリシーをコピーするには** 次の `get-key-policy` の例は、ある KMS キーからキーポリシーを取得し、テキストファイルに保存します。その後、テキストファイルをポリシー入力として使用して、別の KMS キーのポリシーを置き換えます。 `put-key-policy` の `--policy` パラメータには文字列が必要なため、JSON ではなくテキスト文字列として出力を返す `--output text` オプションを使用する必要があります。 ``` 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 ``` このコマンドは何も出力しません。 詳細については、「AWS KMS API リファレンス」の「[PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[GetKeyPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/get-key-policy.html)」を参照してください。** ### `get-key-rotation-status` 次のコード例は、`get-key-rotation-status` を使用する方法を示しています。 **AWS CLI** **KMS キーのローテーションステータスを取得するには** 次の `get-key-rotation-status` の例では、自動ローテーションが有効になっているかどうか、ローテーション期間、次にスケジュールされているローテーション日など、指定された KMS キーのローテーションステータスに関する情報を返します。このコマンドは、カスタマーマネージド KMS キーと AWS マネージド KMS キーに対して使用できます。ただし、すべての AWS マネージド KMS キーは毎年自動的にローテーションされます。 ``` aws kms get-key-rotation-status \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` 出力: ``` { "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", "KeyRotationEnabled": true, "NextRotationDate": "2024-02-14T18:14:33.587000+00:00", "RotationPeriodInDays": 365 } ``` 詳細については、「*AWS Key Management Service Developer Guide*」の「[Rotating keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetKeyRotationStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/get-key-rotation-status.html)」を参照してください。 ### `get-parameters-for-import` 次のコード例は、`get-parameters-for-import` を使用する方法を示しています。 **AWS CLI** **キーマテリアルを KMS キーにインポートするために必要な項目を取得するには** 次の `get-parameters-for-import` の例では、キーマテリアルを KMS キーにインポートするために必要なパブリックキーとインポートトークンを取得します。`import-key-material` コマンドを使用する際には、同じ `get-parameters-for-import` コマンドで返されたパブリックキーによって暗号化されたインポートトークンとキーマテリアルを必ず使用してください。また、このコマンドで指定するラップアルゴリズムは、キーマテリアルをパブリックキーで暗号化するために使用するアルゴリズムである必要があります。 KMS キーを指定するには、`key-id` パラメータを使用します。この例ではキー ID を使用していますが、このコマンドでは、キー ID またはキー ARN を使用できます。 ``` aws kms get-parameters-for-import \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --wrapping-algorithm RSAES_OAEP_SHA_256 \ --wrapping-key-spec RSA_2048 ``` 出力: ``` { "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", "PublicKey": "", "ImportToken": "", "ParametersValidTo": 1593893322.32 } ``` 詳細については、「*AWS Key Management Service デベロッパーガイド*」の「[パブリックキーおよびインポートトークンのダウンロード](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-get-public-key-and-token.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetParametersForImport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/get-parameters-for-import.html)」を参照してください。 ### `get-public-key` 次のコード例は、`get-public-key` を使用する方法を示しています。 **AWS CLI** **例 1: 非対称 KMS キーのパブリックキーをダウンロードするには** 次の `get-public-key` の例では、非対称 KMS キーのパブリックキーをダウンロードします。 パブリックキーが返されるだけでなく、出力には、キーの使用状況やサポートされている暗号化アルゴリズムなど、AWS KMS の外部でパブリックキーを安全に使用するために必要な情報が含まれます。 ``` aws kms get-public-key \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` 出力: ``` { "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" ] } ``` AWS KMS での非対称 KMS キー使用の詳細については、「*AWS Key Management Service Developer Guide*」の「[Asymmetric keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html)」を参照してください。**例 2: パブリックキーを DER 形式に変換するには (Linux および macOS)** 次の `get-public-key` の例では、非対称 KMS キーのパブリックキーをダウンロードして DER ファイルに保存します。 AWS CLI で `get-public-key` コマンドを使用すると、Base64 でエンコードされた DER エンコードの X.509 パブリックキーが返されます。この例では、`PublicKey` プロパティの値をテキストとして取得します。この `PublicKey` を Base64 でエンコードして `public_key.der` ファイルに保存します。`output` パラメータは、JSON ではなくテキストとして出力を返します。`--query` パラメータは、`PublicKey` プロパティのみを取得し、AWS KMS の外部でパブリックキーを安全に使用するために必要なプロパティは取得しません。 このコマンドを実行する前に、サンプルキー ID を AWS アカウントの有効なキー ID に置き換えます。 ``` aws kms get-public-key \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --output text \ --query PublicKey | base64 --decode > public_key.der ``` このコマンドでは何も出力されません。 AWS KMS での非対称 KMS キー使用の詳細については、「*AWS Key Management Service Developer Guide*」の「[Asymmetric keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPublicKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/get-public-key.html)」を参照してください。 ### `import-key-material` 次のコード例は、`import-key-material` を使用する方法を示しています。 **AWS CLI** **キーマテリアルを KMS キーにインポートするには** 次の `import-key-material` の例では、キーマテリアルなしで作成された KMS キーにキーマテリアルをアップロードします。KMS キーのキーストアは `PendingImport` である必要があります。 このコマンドは、`get-parameters-for-import` コマンドが返したパブリックキーで暗号化したキーマテリアルを使用します。また、同じ `get-parameters-for-import` コマンドからのインポートトークンも使用します。 `expiration-model` パラメータは、キーマテリアルが `valid-to` パラメータで指定された日時に自動的に期限切れになることを示します。キーマテリアルが期限切れになると、AWS KMS はキーマテリアルを削除し、KMS キーのキー状態は `Pending import` に変わり、KMS キーは使用できなくなります。KMS キーを復元するには、同じキーマテリアルを再インポートする必要があります。別のキーマテリアルを使用するには、新しい KMS キーを作成する必要があります。 このコマンドを実行する前に、サンプルキー ID を AWS アカウントの有効なキー ID またはキー ARN に置き換えます。 ``` 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 ``` 出力: ``` { "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", "KeyMaterialId": "0b7fd7ddbac6eef27907413567cad8c810e2883dc8a7534067a82ee1142fc1e6" } ``` AWS KMS へのキーマテリアルのインポートの詳細については、「*AWS Key Management Service デベロッパーガイド*」の「[キーマテリアルのインポート](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ImportKeyMaterial](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/import-key-material.html)」を参照してください。 ### `list-aliases` 次のコード例は、`list-aliases` を使用する方法を示しています。 **AWS CLI** **例 1: AWS アカウントおよびリージョン内のすべてのエイリアスを一覧表示するには** 次の例では、`list-aliases` コマンドを使用して、AWS アカウントのデフォルトリージョンにあるすべてのエイリアスを一覧表示します。出力には、AWS マネージド KMS キーとカスタマーマネージド KMS キーに関連するエイリアスが含まれます。 ``` aws kms list-aliases ``` 出力: ``` { "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" }, ... ] } ``` **例 2: 特定の KMS キーのすべてのエイリアスを一覧表示するには** 次の例では、`list-aliases` コマンドとその `key-id` パラメータを使用して、特定の KMS キーに関連するすべてのエイリアスを一覧表示します。 各エイリアスは 1 つの KMS のみに関連付けられますが、1 つの KMS キーには複数のエイリアスを設定することができます。AWS KMS コンソールには KMS キーごとに 1 つのエイリアスしか表示されないため、このコマンドは非常に便利です。KMS キーのすべてのエイリアスを検索するには、`list-aliases` コマンドを使用する必要があります。 この例では、KMS キーのキー ID を `--key-id` パラメータに使用しますが、キー ID、キー ARN、エイリアス名、またはエイリアス ARN を使用することもできます。 ``` aws kms list-aliases --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` 出力: ``` { "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" } ] } ``` 詳細については、「AWS Key Management Service デベロッパーガイド」の「[エイリアスの使用](https://docs.aws.amazon.com/kms/latest/developerguide/programming-aliases.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[ListAliases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/list-aliases.html)」を参照してください。** ### `list-grants` 次のコード例は、`list-grants` を使用する方法を示しています。 **AWS CLI** **AWS KMS キーの権限を表示するには** 次の `list-grants` の例は、アカウント内の Amazon DynamoDB の指定された AWS マネージド KMS キーのすべての権限を表示します。この権限により、DynamoDB はユーザーに代わって KMS キーを使用して、DynamoDB テーブルをディスクに書き込む前に暗号化できます。このようなコマンドを使用すると、AWS アカウントとリージョンのAWS マネージド KMS キーとカスタマーマネージド KMS キーに対する権限を表示できます。 このコマンドは、キー ID を含む `key-id` パラメータを使用して KMS キーを識別します。ユーザーは、キー ID またはキー ARN を使用して KMS キーを識別できます。AWS マネージド KMS キーのキー ID またはキー ARN を取得するには、`list-keys` コマンドまたは `list-aliases` コマンドを使用します。 ``` aws kms list-grants \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` これにより、暗号化操作において Amazon DynamoDB に KMS キーを使用する権限が付与され、KMS キーに関する詳細情報を表示する権限 (`DescribeKey`) と権限を廃止する権限 (`RetireGrant`) が付与されていることが出力に表示されます。`EncryptionContextSubset` の制約により、これらの権限は指定された暗号化コンテキストペアを含むリクエストに限定されます。そのため、この権限のアクセス許可は指定されたアカウントと 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" } ] } ``` 詳細については、「AWS Key Management Service デベロッパーガイド」の「[AWS KMS でのグラント](https://docs.aws.amazon.com/kms/latest/developerguide/grants.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[ListGrants](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/list-grants.html)」を参照してください。** ### `list-key-policies` 次のコード例は、`list-key-policies` を使用する方法を示しています。 **AWS CLI** **KMS キーのキーポリシーの名前を取得するには** 次の `list-key-policies` の例は、サンプルアカウントとリージョンのカスタマーマネージドキーのキーポリシーの名前を取得します。このコマンドを使用して、AWS マネージドキーとカスタマーマネージドキーのキーポリシーの名前を取得できます。 有効なキーポリシー名は `default` のみであるため、このコマンドは有用ではありません。 KMS キーを指定するには、`key-id` パラメータを使用します。この例では、キー ID 値を使用していますが、このコマンドでは、キー ID またはキー ARN を使用できます。 ``` aws kms list-key-policies \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` 出力: ``` { "PolicyNames": [ "default" ] } ``` AWS KMS キーポリシーの詳細については、「AWS Key Management Service デベロッパーガイド」の「[AWS KMS のキーポリシー](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[ListKeyPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/list-key-policies.html)」を参照してください。** ### `list-key-rotations` 次のコード例は、`list-key-rotations` を使用する方法を示しています。 **AWS CLI** **完了したすべてのキーマテリアルローテーションに関する情報を取得するには** 次の `list-key-rotations` の例では、指定された KMS キーに対して完了したすべてのキーマテリアルローテーションに関する情報を一覧表示します。 ``` aws kms list-key-rotations \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` 出力: ``` { "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 } ``` 詳細については、「*AWS Key Management Service Developer Guide*」の「[Rotating keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListKeyRotations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/list-key-rotations.html)」を参照してください。 ### `list-keys` 次のコード例は、`list-keys` を使用する方法を示しています。 **AWS CLI** **アカウントとリージョンの KMS キーを取得するには** 次の `list-keys` の例は、アカウントとリージョンの KMS キーを取得します。このコマンドは、AWS マネージドキーとカスタマーマネージドキーの両方を返します。 ``` aws kms list-keys ``` 出力: ``` { "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" } ] } ``` 詳細については、「AWS Key Management Service デベロッパーガイド」の「[キーの表示](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[ListKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/list-keys.html)」を参照してください。** ### `list-resource-tags` 次のコード例は、`list-resource-tags` を使用する方法を示しています。 **AWS CLI** **KMS キーのタグを取得するには** 次の `list-resource-tags` の例では、KMS キーのタグを取得します。KMS キーのリソースタグを追加または置換するには、`tag-resource` コマンドを使用します。出力は、この KMS キーに 2 つのリソースタグがあり、それぞれにキーと値があることを示しています。 KMS キーを指定するには、`key-id` パラメータを使用します。この例では、キー ID 値を使用していますが、このコマンドでは、キー ID またはキー ARN を使用できます。 ``` aws kms list-resource-tags \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` 出力: ``` { "Tags": [ { "TagKey": "Dept", "TagValue": "IT" }, { "TagKey": "Purpose", "TagValue": "Test" } ], "Truncated": false } ``` AWS KMS でのタグ使用の詳細については、「*AWS Key Management Service Developer Guide*」の「[Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListResourceTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/list-resource-tags.html)」を参照してください。 ### `list-retirable-grants` 次のコード例は、`list-retirable-grants` を使用する方法を示しています。 **AWS CLI** **プリンシパルが廃止できる許可を表示するには** 次の `list-retirable-grants` の例では、`ExampleAdmin` ユーザーが AWS アカウントとリージョンの KMS キーに対して廃止できるすべての許可を表示します。このようなコマンドを使用すると、アカウントのプリンシパルが AWS アカウントとリージョンの KMS キーに対して廃止できる権限を表示できます。 必須の `retiring-principal` パラメータの値は、アカウント、ユーザー、またはロールの Amazon リソースネーム (ARN) である必要があります。 このコマンドで `retiring-principal` の値としてサービスを指定することはできません。ただし、サービスが廃止プリンシパルである場合があります。特定のサービスが廃止プリンシパルである許可を見つけるには、`list-grants` コマンドを使用します。 出力は、`ExampleAdmin` ユーザーがアカウントとリージョン内の 2 つの異なる KMS キーに対する許可を廃止するアクセス許可を持っていることを示しています。廃止プリンシパルに加えて、アカウントには、アカウント内の許可を廃止するアクセス許可があります。 ``` aws kms list-retirable-grants \ --retiring-principal arn:aws:iam::111122223333:user/ExampleAdmin ``` 出力: ``` { "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 } ``` 詳細については、「AWS Key Management Service デベロッパーガイド」の「[AWS KMS でのグラント](https://docs.aws.amazon.com/kms/latest/developerguide/grants.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRetirableGrants](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/list-retirable-grants.html)」を参照してください。 ### `put-key-policy` 次のコード例は、`put-key-policy` を使用する方法を示しています。 **AWS CLI** **KMS キーのキーポリシーを変更するには** 次の `put-key-policy` の例は、カスタマーマネージドキーのキーポリシーを変更します。 まず、キーポリシーを作成して、ローカルの JSON ファイルに保存します。この例では、`key_policy.json` がこのファイルです。また、キーポリシーを `policy` パラメータの文字列値として指定することもできます。 このキーポリシーの最初のステートメントは、IAM ポリシーを使用して KMS キーへのアクセスを制御するためのアクセス許可を AWS アカウントに付与します。2 番目のステートメントは、KMS キーで `describe-key` コマンドおよび `list-keys` コマンドを実行する権限を `test-user` ユーザーに付与します。 `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" : "*" } ] } ``` この例では KMS キーの識別にキー ID を使用しますが、キー ARN を使用することもできます。キーポリシーを指定するために、このコマンドは `policy` パラメータを使用します。ポリシーがファイル内にあることを示すには、必要な `file://` プレフィックスを使用します。このプレフィックスは、サポートされているすべてのオペレーティングシステムでファイルを識別するために必要です。最後に、コマンドは値が `default` の `policy-name` パラメーターを使用します。ポリシー名を指定しない場合、デフォルト値は `default` となります。唯一の有効な値は `default` です。 ``` aws kms put-key-policy \ --policy-name default \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --policy file://key_policy.json ``` このコマンドでは、出力が生成されません。コマンドが有効であることを確認するには、`get-key-policy` コマンドを使用します。次のコマンド例は、同じ KMS キーのキーポリシーを取得します。値が `text` の `output` パラメータは、読みやすいテキスト形式を返します。 ``` aws kms get-key-policy \ --policy-name default \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --output text ``` 出力: ``` { "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" : "*" } ] } ``` 詳細については、「AWS Key Management Service デベロッパーガイド」の「[キーポリシーの変更](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-modifying.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[PutKeyPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/put-key-policy.html)」を参照してください。** ### `re-encrypt` 次のコード例は、`re-encrypt` を使用する方法を示しています。 **AWS CLI** **例 1: 異なる対称 KMS キーで暗号化されたメッセージを再暗号化するには (Linux と macOS)** 次の `re-encrypt` コマンド例は、AWS CLI を使用してデータを再暗号化する推奨方法を示します。 ファイルに暗号文を指定します。`--ciphertext-blob` パラメータの値には、バイナリファイルからデータを読み取るように CLI に指示する `fileb://` プレフィックスを使用します。ファイルが現在のディレクトリにない場合は、ファイルへのフルパスを入力します。ファイルから AWS CLI パラメータ値を読み取る方法の詳細については、「*AWS コマンドラインインターフェイスユーザーガイド*」の「[ファイルからの AWS CLI パラメータのロード](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-file.html)」および「*AWS コマンドラインツールブログ*」の「[Best Practices for Local File Parameters](https://aws.amazon.com/blogs/developer/best-practices-for-local-file-parameters/)」を参照してください。暗号化テキストを復号するソース KMS キーを指定します。対称暗号化 KMS キーで復号する場合、`--source-key-id` パラメータは必要ありません。AWSKMS は、暗号文 BLOB のメタデータからデータを暗号化するために使用された KMS キーを取得できます。ただし、ベストプラクティスは常に、使用している KMS キーを指定することです。この方法により、意図した KMS キーを使用することができ、信頼できない KMS キーを使用して誤って暗号文を復号するのを防ぐことができます。送信先の KMS キーを指定して、データを再暗号化します。`--destination-key-id` パラメータは常に必須です。この例ではキー ARN を使用していますが、有効である限り任意のキー識別子を使用できます。プレーンテキストの出力をテキスト値としてリクエストします。`--query` パラメータは、出力から `Plaintext` フィールドの値のみを取得するよう CLI に命令します。`--output` パラメータは出力を text.Base64 でデコードしたプレーンテキストとして返し、ファイルに保存します。次の例では、`Plaintext` パラメータの値を Base64 ユーティリティにパイプ (\$1) して、Base64 ユーティリティでデコードします。次に、デコードされた出力を `ExamplePlaintext` ファイルにリダイレクト (>) します。 このコマンドを実行する前に、サンプルキー ID を AWS アカウントの有効なキー ID に置き換えます。 ``` 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 ``` このコマンドは何も出力しません。`re-encrypt` コマンドからの出力は base64 でデコードされ、ファイルに保存されます。 詳細については、「*AWS Key Management Service API リファレンス*」の「[ReEncrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_ReEncrypt.html)」を参照してください。 **例 2: 異なる対称 KMS キーで暗号化されたメッセージを再暗号化するには (Windows コマンドプロンプト)** 次の `re-encrypt` の例は、`certutil` ユーティリティを使用してプレーンテキストデータを Base64 でデコードする点を除いて、前の例と同じです。この手順には、次の例に示すように 2 つのコマンドが必要です。 このコマンドを実行する前に、サンプルキー ID を AWS アカウントの有効なキー ID に置き換えます。 ``` 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 ``` その後、`certutil` ユーティリティーを使用します。 ``` certutil -decode ExamplePlaintextFile.base64 ExamplePlaintextFile ``` 出力: ``` Input Length = 18 Output Length = 12 CertUtil: -decode command completed successfully. ``` 詳細については、「*AWS Key Management Service API リファレンス*」の「[ReEncrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_ReEncrypt.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[ReEncrypt](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/re-encrypt.html)」を参照してください。** ### `retire-grant` 次のコード例は、`retire-grant` を使用する方法を示しています。 **AWS CLI** **カスタマーマスターキーの権限を廃止するには** 次の `retire-grant` の例は、KMS キーから権限を削除します。 次のコマンド例は、`grant-id` パラメータと `key-id` パラメータを指定します。`key-id` パラメータの値は、KMS キーのキー ARN である必要があります。 ``` aws kms retire-grant \ --grant-id 1234a2345b8a4e350500d432bccf8ecd6506710e1391880c4f7f7140160c9af3 \ --key-id arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab ``` このコマンドは何も出力しません。権限が廃止されたことを確認するには、`list-grants` コマンドを使用します。 詳細については、「AWS Key Management Service デベロッパーガイド」の「[グラントの使用停止と取り消し](https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[RetireGrant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/retire-grant.html)」を参照してください。** ### `revoke-grant` 次のコード例は、`revoke-grant` を使用する方法を示しています。 **AWS CLI** **カスタマーマスターキーの権限を取り消すには** 次の `revoke-grant` の例は、KMS キーから権限を削除します。次のコマンド例は、`grant-id` パラメータと `key-id` パラメータを指定します。`key-id` パラメータの値には、KMS キーのキー ID またはキー ARN を使用できます。 ``` aws kms revoke-grant \ --grant-id 1234a2345b8a4e350500d432bccf8ecd6506710e1391880c4f7f7140160c9af3 \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` このコマンドは何も出力しません。権限が取り消されたことを確認するには、`list-grants` コマンドを使用します。 詳細については、「AWS Key Management Service デベロッパーガイド」の「[グラントの使用停止と取り消し](https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#grant-delete)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[RevokeGrant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/revoke-grant.html)」を参照してください。** ### `rotate-key-on-demand` 次のコード例は、`rotate-key-on-demand` を使用する方法を示しています。 **AWS CLI** **KMS キーのオンデマンドローテーションを実行するには** 次の `rotate-key-on-demand` の例では、指定された KMS キーのキーマテリアルのローテーションをすぐに開始します。 ``` aws kms rotate-key-on-demand \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` 出力: ``` { "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" } ``` 詳細については、「*AWS Key Management Service デベロッパーガイド*」の「[How to perform on-demand key rotation](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html#rotating-keys-on-demand)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RotateKeyOnDemand](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/rotate-key-on-demand.html)」を参照してください。 ### `schedule-key-deletion` 次のコード例は、`schedule-key-deletion` を使用する方法を示しています。 **AWS CLI** **カスタマーマネージド KMS キーの削除をスケジュールするには** 次の `schedule-key-deletion` の例は、指定されたカスタマーマネージド KMS キーを 15 日後に削除するようにスケジュールします。 `--key-id` パラメータは KMS キーを識別します。この例では、キーの ARN 値を使用していますが、キー ID または KMS キー ARN のいずれかを使用できます。`--pending-window-in-days` パラメータは 7 ～ 30 日の待機期間の長さを指定します。デフォルトでは、待機時間は 30 日です。この例では値に 15 を指定しているため、AWS はコマンドが完了してから 15 日後に KMS キーを完全に削除します。 ``` 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 ``` レスポンスには、キー ARN、キーの状態、待機期間 (`PendingWindowInDays`)、および UNIX 時間の削除日が含まれます。削除日をローカルタイムで表示するには、AWS KMS コンソールを使用します。`PendingDeletion` キー状態の KMS キーを暗号化処理で使用することはできません。 ``` { "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 } ``` 詳細については、「**AWS Key Management Service デベロッパーガイド」の「[Deleting keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[ScheduleKeyDeletion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/schedule-key-deletion.html)」を参照してください。** ### `sign` 次のコード例は、`sign` を使用する方法を示しています。 **AWS CLI** **例 1: メッセージ向けデジタル署名を生成するには** 次の `sign` 例では、短いメッセージ向けの暗号化署名を生成します。コマンドの出力には、`verify` コマンドを使用して検証できる、Base64 エンコードされた `Signature` フィールドが含まれています。 署名するメッセージと、非対称 KMS キーがサポートする署名アルゴリズムを指定する必要があります。KMS キー向け署名アルゴリズムを取得するには、`describe-key` コマンドを使用します。 AWS CLI v2 では、`message` パラメータの値は Base64 でエンコードされている必要があります。または、メッセージをファイルに保存し、`fileb://` プレフィックスを使用することも可能です。このプレフィックスは、ファイルからバイナリデータを読み取るように AWS CLI に指示します。 このコマンドを実行する前に、サンプルキー ID を AWS アカウントの有効なキー ID に置き換えます。キー ID は、キー用途が SIGN\$1VERIFY である非対称 KMS キーを表している必要があります。 ``` 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 ``` 出力: ``` { "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", "Signature": "ABCDEFhpyVYyTxbafE74ccSvEJLJr3zuoV1Hfymz4qv+/fxmxNLA7SE1SiF8lHw80fKZZ3bJ...", "SigningAlgorithm": "RSASSA_PKCS1_V1_5_SHA_256" } ``` AWS KMS での非対称 KMS キー使用の詳細については、「*AWS Key Management Service Developer Guide*」の「[Asymmetric keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html)」を参照してください。 **例 2: デジタル署名をファイルに保存するには (Linux および macOs)** 次の `sign` 例では、ローカルファイルに保存されている短いメッセージ向けの暗号化署名を生成します。コマンドはレスポンスから `Signature` プロパティも取得し、これを Base64 デコードして ExampleSignature ファイルに保存します。この署名ファイルを、署名検証用の `verify` コマンドで使用できます。 `sign` コマンドには、Base64 エンコードされたメッセージと、非対称 KMS キーがサポートする署名アルゴリズムが必要です。KMS キーがサポートする署名アルゴリズムを取得するには、`describe-key` コマンドを使用します。 このコマンドを実行する前に、サンプルキー ID を AWS アカウントの有効なキー ID に置き換えます。キー ID は、キー用途が SIGN\$1VERIFY である非対称 KMS キーを表している必要があります。 ``` 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 ``` このコマンドは何も出力しません。この例では、出力の `Signature` プロパティを抽出し、ファイルに保存します。 AWS KMS での非対称 KMS キー使用の詳細については、「*AWS Key Management Service Developer Guide*」の「[Asymmetric keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[Sign](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/sign.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **KMS キーにタグを追加するには** 次の `tag-resource` 例では、カスタマーマネージド KMS キーに `"Purpose":"Test"` タグと `"Dept":"IT"` タグを追加します。これらのタグを使用して KMS キーにラベルを付け、アクセス許可用と監査用の KMS キーカテゴリを作成できます。 KMS キーを指定するには、`key-id` パラメータを使用します。この例では、キー ID 値を使用していますが、このコマンドでは、キー ID またはキー ARN を使用できます。 ``` aws kms tag-resource \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --tags TagKey='Purpose',TagValue='Test' TagKey='Dept',TagValue='IT' ``` このコマンドは何も出力しません。AWS KMS KMS キーのタグを表示するには、`list-resource-tags` コマンドを使用します。 AWS KMS でのタグ使用の詳細については、「*AWS Key Management Service Developer Guide*」の「[Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **KMS キーからタグを削除するには** 次の `untag-resource` の例では、カスタマーマネージド KMS キーから `"Purpose"` キーを持つタグを削除します。 KMS キーを指定するには、`key-id` パラメータを使用します。この例では、キー ID 値を使用していますが、このコマンドでは、キー ID またはキー ARN を使用できます。このコマンドを実行する前に、サンプルキー ID を AWS アカウントの有効なキー ID に置き換えます。 ``` aws kms untag-resource \ --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ --tag-key 'Purpose' ``` このコマンドは何も出力しません。AWS KMS KMS キーのタグを表示するには、`list-resource-tags` コマンドを使用します。 AWS KMS でのタグ使用の詳細については、「*AWS Key Management Service Developer Guide*」の「[Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/untag-resource.html)」を参照してください。 ### `update-alias` 次のコード例は、`update-alias` を使用する方法を示しています。 **AWS CLI** **エイリアスを別の KMS キーに関連付けるには** 次の `update-alias` の例は、エイリアス `alias/test-key` を別の KMS キーに関連付けます。 `--alias-name` パラメータはエイリアス名を指定します。エイリアス名の値は `alias/` で始まる必要があります。`--target-key-id` パラメータは、エイリアスに関連付ける KMS キーを指定します。エイリアスの現在の KMS キーを指定する必要はありません。 ``` aws kms update-alias \ --alias-name alias/test-key \ --target-key-id 1234abcd-12ab-34cd-56ef-1234567890ab ``` このコマンドは何も出力しません。エイリアスを見つけるには、`list-aliases` コマンドを使用します。 詳細については、「AWS Key Management Service デベロッパーガイド」の「[エイリアスの更新](https://docs.aws.amazon.com/kms/latest/developerguide/alias-manage.html#alias-update)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[UpdateAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/update-alias.html)」を参照してください。** ### `update-custom-key-store` 次のコード例は、`update-custom-key-store` を使用する方法を示しています。 **AWS CLI** **例 1: カスタムキーストアのわかりやすい名前を編集するには** 次の `update-custom-key-store` の例では、カスタムキーストアの名前を変更します。この例は、AWS CloudHSM キーストアまたは外部キーストアに対して機能します。 `custom-key-store-id` を使用して、キーストアを識別します。`new-custom-key-store-name` パラメータを使用して、新しいフレンドリ名を指定します。 AWS CloudHSM キーストアのわかりやすい名前を更新するには、`disconnect-custom-key-store` コマンドを使用するなどの方法で、まずキーストアを切断する必要があります。外部キーストアのわかりやすい名前は、外部キーストアが接続されていても切断されていても更新できます。カスタムキーストアの接続状態を確認するには、`describe-custom-key-store` コマンドを使用します。 ``` aws kms update-custom-key-store \ --custom-key-store-id cks-1234567890abcdef0 \ --new-custom-key-store-name ExampleKeyStore ``` このコマンドはデータを返しません。コマンドが機能したことを確認するには、`describe-custom-key-stores` コマンドを使用します。 AWS CloudHSM キーストアの更新の詳細については、「*AWS Key Management Service デベロッパーガイド*」の「[Editing AWS CloudHSM key store settings](https://docs.aws.amazon.com/kms/latest/developerguide/update-keystore.html)」を参照してください。 外部キーストアの更新の詳細については、「*AWS Key Management Service デベロッパーガイド*」の「[外部キーストアのプロパティの編集](https://docs.aws.amazon.com/kms/latest/developerguide/update-xks-keystore.html)」を参照してください。 **例 2: AWS CloudHSM キーストアの kmsuser パスワードを編集するには** 次の `update-custom-key-store` 例では、`kmsuser` パスワードの値を、指定されたキーストアに関連付けられた CloudHSM クラスター内の `kmsuser` の現在のパスワードに更新します。このコマンドは、クラスターの `kmsuser` パスワードを変更しません。現在のパスワードを AWS KMS に伝えるだけです。KMS に現在の `kmsuser` パスワードがない場合は、AWS CloudHSM キーストアに接続できません。 **注:** AWS CloudHSM キーストアを更新する前に、そのキーストアを切断する必要があります。`disconnect-custom-key-store` コマンドを使用します。コマンドが完了したら、AWS CloudHSM キーストアを再接続できます。`connect-custom-key-store` コマンドを使用します。 ``` aws kms update-custom-key-store \ --custom-key-store-id cks-1234567890abcdef0 \ --key-store-password ExamplePassword ``` このコマンドは出力を返しません。変更が有効であることを確認するには、`describe-custom-key-stores` コマンドを使用します。 AWS CloudHSM キーストアの更新の詳細については、「*AWS Key Management Service デベロッパーガイド*」の「[Editing AWS CloudHSM key store settings](https://docs.aws.amazon.com/kms/latest/developerguide/update-keystore.html)」を参照してください。 **例 3: AWS CloudHSM キーストアの AWS CloudHSM クラスターを編集するには** 次の例では、AWS CloudHSM キーストアに関連付けられている AWS CloudHSM クラスターを、同じクラスターの別のバックアップなど、関連するクラスターに変更します。 **注:** AWS CloudHSM キーストアを更新する前に、そのキーストアを切断する必要があります。`disconnect-custom-key-store` コマンドを使用します。コマンドが完了したら、AWS CloudHSM キーストアを再接続できます。`connect-custom-key-store` コマンドを使用します。 ``` aws kms update-custom-key-store \ --custom-key-store-id cks-1234567890abcdef0 \ --cloud-hsm-cluster-id cluster-1a23b4cdefg ``` このコマンドは出力を返しません。変更が有効であることを確認するには、`describe-custom-key-stores` コマンドを使用します。 AWS CloudHSM キーストアの更新の詳細については、「*AWS Key Management Service デベロッパーガイド*」の「[Editing AWS CloudHSM key store settings](https://docs.aws.amazon.com/kms/latest/developerguide/update-keystore.html)」を参照してください。 **例 4: 外部キーストアのプロキシ認証情報を編集するには** 次の例では、外部キーストアのプロキシ認証の認証情報を更新を更新します。値のうち 1 つを変更する場合でも、`raw-secret-access-key` と `access-key-id` の両方を指定する必要があります。この機能を使用して、無効な認証情報を修正したり、外部キーストアプロキシが認証情報をローテーションしたときに認証情報を変更したりできます。 外部キーストアで AWS KMS のプロキシ認証の認証情報を確立します。次に、このコマンドを使用して認証情報を AWS KMS に提供します。AWSKMS はこの認証情報を使用して、外部キーストアプロキシへのリクエストに署名します。 外部キーストアの接続または切断中にプロキシ認証情報を更新できます。カスタムキーストアの接続状態を確認するには、`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=" ``` このコマンドは出力を返しません。変更が有効であることを確認するには、`describe-custom-key-stores` コマンドを使用します。 外部キーストアの更新の詳細については、「*AWS Key Management Service デベロッパーガイド*」の「[外部キーストアのプロパティの編集](https://docs.aws.amazon.com/kms/latest/developerguide/update-xks-keystore.html)」を参照してください。 **例 5: 外部キーストアのプロキシ接続を編集するには** 次の例では、外部キーストアのプロキシ接続オプションをパブリックエンドポイント接続から VPC エンドポイントサービス接続に変更します。`xks-proxy-connectivity` 値を変更するだけでなく、VPC エンドポイントサービスに関連付けられたプライベート DNS 名を反映するように `xks-proxy-uri-endpoint` 値を変更する必要があります。また、`xks-proxy-vpc-endpoint-service-name` 値を追加する必要があります。 **注:** 外部ストアのプロキシ接続を更新する前に、プロキシ接続を切断する必要があります。`disconnect-custom-key-store` コマンドを使用します。コマンドが完了したら、`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" ``` このコマンドは出力を返しません。変更が有効であることを確認するには、`describe-custom-key-stores` コマンドを使用します。 外部キーストアの更新の詳細については、「*AWS Key Management Service デベロッパーガイド*」の「[外部キーストアのプロパティの編集](https://docs.aws.amazon.com/kms/latest/developerguide/update-xks-keystore.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateCustomKeyStore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/update-custom-key-store.html)」を参照してください。 ### `update-key-description` 次のコード例は、`update-key-description` を使用する方法を示しています。 **AWS CLI** **例 1: カスタマーマネージド KMS キーに説明を追加または変更するには** 次の `update-key-description` 例では、カスタマーマネージド KMS キーに説明を追加します。同じコマンドを使用して、既存の説明を変更できます。 `--key-id` パラメータは、コマンドの KMS キーを識別します。この例では、キーの ARN 値を使用していますが、キー ID または KMS キー ARN のいずれかを使用できます。`--description` パラメータは新しい説明を指定します。このパラメータの値は、KMS キーの現在の説明 (ある場合) を置き換えます。 ``` 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" ``` このコマンドは何も出力しません。KMS キーの説明を表示するには、`describe-key` コマンドを使用します。 詳細については、「AWS Key Management Service API リファレンス」の「[UpdateKeyDescription](https://docs.aws.amazon.com/cli/latest/reference/kms/update-key-description.html)」を参照してください。** **例 2: カスタマーマネージド KMS キーの説明を削除するには** 次の `update-key-description` の例では、カスタマーマネージド KMS キーの説明を削除します。 `--key-id` パラメータは、コマンドの KMS キーを識別します。この例ではキー ID 値を使用しますが、KMS キーのキー ID またはキー ARN を使用できます。空の文字列値 ('') を持つ `--description` パラメータは、既存の説明を削除します。 ``` aws kms update-key-description \ --key-id 0987dcba-09fe-87dc-65ba-ab0987654321 \ --description '' ``` このコマンドは何も出力しません。KMS キーの説明を表示するには、describe-key コマンドを使用します。 詳細については、「AWS Key Management Service API リファレンス」の「[UpdateKeyDescription](https://docs.aws.amazon.com/cli/latest/reference/kms/update-key-description.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateKeyDescription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/update-key-description.html)」を参照してください。 ### `verify-mac` 次のコード例は、`verify-mac` を使用する方法を示しています。 **AWS CLI** **例 1: HMAC を検証するには** 次の `verify-mac` コマンドは、特定のメッセージの HMAC、HMAC KMS キー、および MAC アルゴリズムを検証します。レスポンスの MacValid 値が「true」の場合、HMAC は有効であることを示します。 AWS CLI v2 では、`message` パラメータの値は Base64 でエンコードされている必要があります。または、メッセージをファイルに保存し、`fileb://` プレフィックスを使用することも可能です。このプレフィックスは、ファイルからバイナリデータを読み取るように AWS CLI に指示します。 指定する MAC は Base64 でエンコードされているものであってはなりません。`generate-mac` コマンドが返す MAC のデコードについては、`generate-mac` コマンドの例を参照してください。 このコマンドを実行する前に、サンプルキー ID を AWS アカウントの有効なキー ID に置き換えます。キー ID は、キー用途が `GENERATE_VERIFY_MAC` の HMAC KMS キーを表す必要があります。 ``` 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 ``` 出力: ``` { "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", "MacValid": true, "MacAlgorithm": "HMAC_SHA_384" } ``` AWS KMS での HMAC KMS キー使用の詳細については、「*AWS Key Management Service デベロッパーガイド*」の「[HMAC keys in AWS KMS](https://docs.aws.amazon.com/kms/latest/developerguide/hmac.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[VerifyMac](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/verify-mac.html)」を参照してください。 ### `verify` 次のコード例は、`verify` を使用する方法を示しています。 **AWS CLI** **デジタル署名を検証するには** 次の `verify` は、短い Base64 でエンコードされたメッセージの暗号化署名を検証します。キー ID、メッセージ、メッセージタイプ、署名アルゴリズムは、メッセージの署名に使用されたものと同じである必要があります。 AWS CLI v2 では、`message` パラメータの値は Base64 でエンコードされている必要があります。または、メッセージをファイルに保存し、`fileb://` プレフィックスを使用することも可能です。このプレフィックスは、ファイルからバイナリデータを読み取るように AWS CLI に指示します。 指定する署名は Base64 エンコードされているものであってはなりません。`sign` コマンドが返す署名のデコードについては、`sign` コマンドの例を参照してください。 コマンドの出力には、署名が検証済みであることを示すブール値 `SignatureValid` フィールドが含まれます。署名の検証が失敗した場合、`verify` コマンドの実行結果も失敗となります。 このコマンドを実行する前に、サンプルキー ID を AWS アカウントの有効なキー ID に置き換えます。 ``` 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 ``` 出力: ``` { "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", "SignatureValid": true, "SigningAlgorithm": "RSASSA_PKCS1_V1_5_SHA_256" } ``` AWS KMS での非対称 KMS キー使用の詳細については、「*AWS Key Management Service Developer Guide*」の「[Using asymmetric keys](https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[Verify](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/verify.html)」を参照してください。 # AWS CLI を使用した Lake Formation の例 次のコード例は、Lake Formation で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `add-lf-tags-to-resource` 次のコード例は、`add-lf-tags-to-resource` を使用する方法を示しています。 **AWS CLI** **1 つまたは複数の LF タグを既存のリソースにアタッチするには** 次の `add-lf-tags-to-resource` の例では、特定の LF タグをテーブルリソースにアタッチします。 ``` aws lakeformation add-lf-tags-to-resource \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "CatalogId": "123456789111", "Resource": { "Table": { "CatalogId": "123456789111", "DatabaseName": "tpc", "Name": "dl_tpc_promotion" } }, "LFTags": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "analyst" ] }] } ``` 出力: ``` { "Failures": [] } ``` 詳細については、「*AWS Lake Formation Developer Guide*」の「[Assigning LF-Tags to Data Catalog resources](https://docs.aws.amazon.com/lake-formation/latest/dg/TBAC-assigning-tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddLfTagsToResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/add-lf-tags-to-resource.html)」を参照してください。 ### `batch-grant-permissions` 次のコード例は、`batch-grant-permissions` を使用する方法を示しています。 **AWS CLI** **リソースに対するアクセス許可をプリンシパルに一括で付与するには** 次の `batch-grant-permissions` の例では、指定されたリソースに対するアクセス許可をプリンシパルに一括で付与します。 ``` aws lakeformation batch-grant-permissions \ --cli-input-json file://input.json ``` `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": [] } ] } ``` 出力: ``` { "Failures": [] } ``` 詳細については、「*AWS Lake Formation Developer Guide*」の「[Granting and revoking permissions on Data Catalog resources](https://docs.aws.amazon.com/lake-formation/latest/dg/granting-catalog-permissions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchGrantPermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/batch-grant-permissions.html)」を参照してください。 ### `batch-revoke-permissions` 次のコード例は、`batch-revoke-permissions` を使用する方法を示しています。 **AWS CLI** **リソースに対するアクセス許可をプリンシパルから一括で取り消すには** 次の `batch-revoke-permissions` の例では、指定されたリソースに対するアクセス許可をプリンシパルから一括で取り消します。 ``` aws lakeformation batch-revoke-permissions \ --cli-input-json file://input.json ``` `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" ] } ] } ``` 出力: ``` { "Failures": [] } ``` 詳細については、「*AWS Lake Formation Developer Guide*」の「[Granting and revoking permissions on Data Catalog resources](https://docs.aws.amazon.com/lake-formation/latest/dg/granting-catalog-permissions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchRevokePermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/batch-revoke-permissions.html)」を参照してください。 ### `cancel-transaction` 次のコード例は、`cancel-transaction` を使用する方法を示しています。 **AWS CLI** **トランザクションをキャンセルするには** 次の `cancel-transaction` の例では、トランザクションをキャンセルします。 ``` aws lakeformation cancel-transaction \ --transaction-id='b014d972ca8347b89825e33c5774aec4' ``` このコマンドは何も出力しません。 詳細については、「*AWS Lake Formation Developer Guide*」の「[Reading from and writing to the data lake within transactions](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelTransaction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/cancel-transaction.html)」を参照してください。 ### `commit-transaction` 次のコード例は、`commit-transaction` を使用する方法を示しています。 **AWS CLI** **トランザクションをコミットするには** 次の `commit-transaction` の例では、トランザクションをコミットします。 ``` aws lakeformation commit-transaction \ --transaction-id='b014d972ca8347b89825e33c5774aec4' ``` 出力: ``` { "TransactionStatus": "committed" } ``` 詳細については、「*AWS Lake Formation Developer Guide*」の「[Reading from and writing to the data lake within transactions](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CommitTransaction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/commit-transaction.html)」を参照してください。 ### `create-data-cells-filter` 次のコード例は、`create-data-cells-filter` を使用する方法を示しています。 **AWS CLI** **例 1: データセルフィルターを作成するには** 次の `create-data-cells-filter` の例では、データセルフィルターを作成し、行の条件に基づいて特定の列へのアクセス許可を付与できるようにします。 ``` aws lakeformation create-data-cells-filter \ --cli-input-json file://input.json ``` `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" } } ``` このコマンドは何も出力しません。 詳細については、「*AWS Lake Formation Developer Guide*」の「[Data filtering and cell-level security in Lake Formation](https://docs.aws.amazon.com/lake-formation/latest/dg/data-filtering.html)」を参照してください。 **例 2: 列フィルターを作成するには** 次の `create-data-cells-filter` の例では、データフィルターを作成し、特定の列へのアクセス許可を付与できるようにします。 ``` aws lakeformation create-data-cells-filter \ --cli-input-json file://input.json ``` `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" } } ``` このコマンドは何も出力しません。 詳細については、「*AWS Lake Formation Developer Guide*」の「[Data filtering and cell-level security in Lake Formation](https://docs.aws.amazon.com/lake-formation/latest/dg/data-filtering.html)」を参照してください。 **例 3: 列を除外するデータフィルターを作成するには** 次の `create-data-cells-filter` の例では、データフィルターを作成し、指定された列を除くすべてへのアクセス許可を付与できるようにします。 ``` aws lakeformation create-data-cells-filter \ --cli-input-json file://input.json ``` `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" } } ``` このコマンドは何も出力しません。 詳細については、「*AWS Lake Formation Developer Guide*」の「[Data filtering and cell-level security in Lake Formation](https://docs.aws.amazon.com/lake-formation/latest/dg/data-filtering.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDataCellsFilter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/create-data-cells-filter.html)」を参照してください。 ### `create-lf-tag` 次のコード例は、`create-lf-tag` を使用する方法を示しています。 **AWS CLI** **LF タグを作成するには** 次の `create-lf-tag` の例では、指定された名前とキーを持つ LF タグを作成します。 ``` aws lakeformation create-lf-tag \ --catalog-id '123456789111' \ --tag-key 'usergroup' \ --tag-values '["developer","analyst","campaign"]' ``` このコマンドは何も出力しません。 詳細については、「*AWS Lake Formation Developer Guide*」の「[Managing LF-Tags for metadata access control](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateLfTag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/create-lf-tag.html)」を参照してください。 ### `delete-data-cells-filter` 次のコード例は、`delete-data-cells-filter` を使用する方法を示しています。 **AWS CLI** **データセルフィルターを削除するには** 次の `delete-data-cells-filter` の例では、指定されたデータセルフィルターを削除します。 ``` aws lakeformation delete-data-cells-filter \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "TableCatalogId": "123456789111", "DatabaseName": "tpc", "TableName": "dl_tpc_promotion", "Name": "developer_promotion" } ``` このコマンドは何も出力しません。 詳細については、「*AWS Lake Formation Developer Guide*」の「[Data filtering and cell-level security in Lake Formation](https://docs.aws.amazon.com/lake-formation/latest/dg/data-filtering.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDataCellsFilter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/delete-data-cells-filter.html)」を参照してください。 ### `delete-lf-tag` 次のコード例は、`delete-lf-tag` を使用する方法を示しています。 **AWS CLI** **LF タグ定義を削除するには** 次の `delete-lf-tag` の例では、LF タグ定義を削除します。 ``` aws lakeformation delete-lf-tag \ --catalog-id '123456789111' \ --tag-key 'usergroup' ``` このコマンドは何も出力しません。 詳細については、「*AWS Lake Formation Developer Guide*」の「[Managing LF-Tags for metadata access control](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteLfTag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/delete-lf-tag.html)」を参照してください。 ### `delete-objects-on-cancel` 次のコード例は、`delete-objects-on-cancel` を使用する方法を示しています。 **AWS CLI** **トランザクションがキャンセルされたときにオブジェクトを削除するには** 次の `delete-objects-on-cancel` の例では、トランザクションがキャンセルされたときに、一覧表示されている S3 オブジェクトを削除します。 ``` aws lakeformation delete-objects-on-cancel \ --cli-input-json file://input.json ``` `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" }] } ``` このコマンドは何も出力しません。 詳細については、「*AWS Lake Formation Developer Guide*」の「[Reading from and writing to the data lake within transactions](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteObjectsOnCancel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/delete-objects-on-cancel.html)」を参照してください。 ### `deregister-resource` 次のコード例は、`deregister-resource` を使用する方法を示しています。 **AWS CLI** **データレイクストレージの登録を解除するには** 次の `deregister-resource` の例では、Lake Formation によって管理されるリソースの登録を解除します。 ``` aws lakeformation deregister-resource \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "ResourceArn": "arn:aws:s3:::lf-emr-athena-result-123" } ``` このコマンドは何も出力しません。 詳細については、「*AWS Lake Formation Developer Guide*」の「[Adding an Amazon S3 location to your data lake](https://docs.aws.amazon.com/lake-formation/latest/dg/register-data-lake.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeregisterResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/deregister-resource.html)」を参照してください。 ### `describe-transaction` 次のコード例は、`describe-transaction` を使用する方法を示しています。 **AWS CLI** **トランザクションの詳細を取得するには** 次の `describe-transaction` の例では、単一のトランザクションの詳細を返します。 ``` aws lakeformation describe-transaction \ --transaction-id='8cb4b1a7cc8d486fbaca9a64e7d9f5ce' ``` 出力: ``` { "TransactionDescription": { "TransactionId": "12345972ca8347b89825e33c5774aec4", "TransactionStatus": "committed", "TransactionStartTime": "2022-08-10T14:29:04.046000+00:00", "TransactionEndTime": "2022-08-10T14:29:09.681000+00:00" } } ``` 詳細については、「*AWS Lake Formation Developer Guide*」の「[Reading from and writing to the data lake within transactions](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeTransaction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/describe-transaction.html)」を参照してください。 ### `extend-transaction` 次のコード例は、`extend-transaction` を使用する方法を示しています。 **AWS CLI** **トランザクションを拡張するには** 次の `extend-transaction` の例では、トランザクションを拡張します。 ``` aws lakeformation extend-transaction \ --transaction-id='8cb4b1a7cc8d486fbaca9a64e7d9f5ce' ``` このコマンドは何も出力しません。 詳細については、「*AWS Lake Formation Developer Guide*」の「[Reading from and writing to the data lake within transactions](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ExtendTransaction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/extend-transaction.html)」を参照してください。 ### `get-data-lake-settings` 次のコード例は、`get-data-lake-settings` を使用する方法を示しています。 **AWS CLI** **AWS Lake Formation が管理するデータレイク設定を取得するには** 次の `get-data-lake-settings` の例では、データレイク管理者およびその他のデータレイク設定のリストを取得します。 ``` aws lakeformation get-data-lake-settings \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "CatalogId": "123456789111" } ``` 出力: ``` { "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" ] } } ``` 詳細については、「*AWS Lake Formation Developer Guide*」の「[Changing the default security settings for your data lake](https://docs.aws.amazon.com/lake-formation/latest/dg/change-settings.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDataLakeSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/get-data-lake-settings.html)」を参照してください。 ### `get-effective-permissions-for-path` 次のコード例は、`get-effective-permissions-for-path` を使用する方法を示しています。 **AWS CLI** **特定のパスにあるリソースに対するアクセス許可を取得するには** 次の `get-effective-permissions-for-path` の例では、Amazon S3 のパスにある指定されたテーブルまたはデータベースリソースに対する Lake Formation アクセス許可を返します。 ``` aws lakeformation get-effective-permissions-for-path \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "CatalogId": "123456789111", "ResourceArn": "arn:aws:s3:::lf-data-lake-123456789111" } ``` 出力: ``` { "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==" } ``` 詳細については、「*AWS Lake Formation Developer Guide*」の「[Lake Formation アクセス許可の管理](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-permissions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetEffectivePermissionsForPath](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/get-effective-permissions-for-path.html)」を参照してください。 ### `get-lf-tag` 次のコード例は、`get-lf-tag` を使用する方法を示しています。 **AWS CLI** **LF タグ定義を取得するには** 次の `get-lf-tag` の例では、LF タグ定義を取得します。 ``` aws lakeformation get-lf-tag \ --catalog-id '123456789111' \ --tag-key 'usergroup' ``` 出力: ``` { "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "analyst", "campaign", "developer" ] } ``` 詳細については、「*AWS Lake Formation Developer Guide*」の「[Managing LF-Tags for metadata access control](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetLfTag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/get-lf-tag.html)」を参照してください。 ### `get-query-state` 次のコード例は、`get-query-state` を使用する方法を示しています。 **AWS CLI** **送信されたクエリの状態を取得するには** 次の `get-query-state` の例では、以前に送信されたクエリの状態を返します。 ``` aws lakeformation get-query-state \ --query-id='1234273f-4a62-4cda-8d98-69615ee8be9b' ``` 出力: ``` { "State": "FINISHED" } ``` 詳細については、「*AWS Developer Guide*」の「[Transactional data operations](https://docs.aws.amazon.com/lake-formation/latest/dg/transactions-data-operations.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetQueryState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/get-query-state.html)」を参照してください。 ### `get-query-statistics` 次のコード例は、`get-query-statistics` を使用する方法を示しています。 **AWS CLI** **クエリ統計を取得するには** 次の `get-query-statistics` の例では、クエリの計画と実行に関する統計を取得します。 ``` aws lakeformation get-query-statistics \ --query-id='1234273f-4a62-4cda-8d98-69615ee8be9b' ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Developer Guide*」の「[Transactional data operations](https://docs.aws.amazon.com/lake-formation/latest/dg/transactions-data-operations.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetQueryStatistics](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/get-query-statistics.html)」を参照してください。 ### `get-resource-lf-tags` 次のコード例は、`get-resource-lf-tags` を使用する方法を示しています。 **AWS CLI** **LF タグを一覧表示するには** 次の `list-lf-tags` の例では、リクエストしたユーザーが閲覧アクセス許可を持っている LF タグのリストを返します。 ``` aws lakeformation list-lf-tags \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "CatalogId": "123456789111", "ResourceShareType": "ALL", "MaxResults": 2 } ``` 出力: ``` { "LFTags": [{ "CatalogId": "123456789111", "TagKey": "category", "TagValues": [ "private", "public" ] }, { "CatalogId": "123456789111", "TagKey": "group", "TagValues": [ "analyst", "campaign", "developer" ] }], "NextToken": "kIiwiZXhwaXJhdGlvbiI6eyJzZWNvbmRzIjoxNjYwMDY4dCI6ZmFsc2V9" } ``` 詳細については、「*AWS Lake Formation Developer Guide*」の「[Managing LF-Tags for metadata access control](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetResourceLfTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/get-resource-lf-tags.html)」を参照してください。 ### `get-table-objects` 次のコード例は、`get-table-objects` を使用する方法を示しています。 **AWS CLI** **管理対象テーブルのオブジェクトを一覧表示するには** 次の `get-table-objects` の例では、指定された管理対象テーブルを構成する Amazon S3 オブジェクトのセットを返します。 ``` aws lakeformation get-table-objects \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "CatalogId": "012345678901", "DatabaseName": "tpc", "TableName": "dl_tpc_household_demographics_gov", "QueryAsOfTime": "2022-08-10T15:00:00" } ``` 出力: ``` { "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 }] }] } ``` 詳細については、「*AWS Lake Formation Developer Guide*」の「[Reading from and writing to the data lake within transactions](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetTableObjects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/get-table-objects.html)」を参照してください。 ### `get-work-unit-results` 次のコード例は、`get-work-unit-results` を使用する方法を示しています。 **AWS CLI** **特定のクエリの作業単位を取得するには** 次の `get-work-unit-results` の例では、クエリから得られた作業単位を返します。 ``` aws lakeformation get-work-units \ --query-id='1234273f-4a62-4cda-8d98-69615ee8be9b' \ --work-unit-id '0' \ --work-unit-token 'B2fMSdmQXe9umX8Ux8XCo4=' outfile ``` 出力: ``` outfile with Blob content. ``` 詳細については、「*AWS Developer Guide*」の「[Transactional data operations](https://docs.aws.amazon.com/lake-formation/latest/dg/transactions-data-operations.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetWorkUnitResults](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/get-work-unit-results.html)」を参照してください。 ### `get-work-units` 次のコード例は、`get-work-units` を使用する方法を示しています。 **AWS CLI** **作業単位を取得するには** 次の `get-work-units` の例では、StartQueryPlanning オペレーションによって生成された作業単位を取得します。 ``` aws lakeformation get-work-units \ --query-id='1234273f-4a62-4cda-8d98-69615ee8be9b' ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Developer Guide*」の「[Transactional data operations](https://docs.aws.amazon.com/lake-formation/latest/dg/transactions-data-operations.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetWorkUnits](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/get-work-units.html)」を参照してください。 ### `grant-permissions` 次のコード例は、`grant-permissions` を使用する方法を示しています。 **AWS CLI** **例 1: LF タグを使用してリソースに対するアクセス許可をプリンシパルに付与するには** 次の `grant-permissions` の例では、LF タグポリシーに一致するデータベースリソースに対する ALL アクセス許可をプリンシパルに付与します。 ``` aws lakeformation grant-permissions \ --cli-input-json file://input.json ``` `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" ] } ``` このコマンドは何も出力しません。 詳細については、「*AWS Lake Formation Developer Guide*」の「[Granting and revoking permissions on Data Catalog resources](https://docs.aws.amazon.com/lake-formation/latest/dg/granting-catalog-permissions.html)」を参照してください。 **例 2: 列レベルのアクセス許可をプリンシパルに付与するには** 次の `grant-permissions` の例では、特定の列を選択するアクセス許可をプリンシパルに付与します。 ``` aws lakeformation grant-permissions \ --cli-input-json file://input.json ``` `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": [] } ``` このコマンドは何も出力しません。 詳細については、「*AWS Lake Formation Developer Guide*」の「[Granting and revoking permissions on Data Catalog resources](https://docs.aws.amazon.com/lake-formation/latest/dg/granting-catalog-permissions.html)」を参照してください。 **例 3: テーブルのアクセス許可をプリンシパルに付与するには** 次の `grant-permissions` の例では、特定のデータベースのすべてのテーブルに対する選択アクセス許可をプリンシパルに付与します。 ``` aws lakeformation grant-permissions \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "CatalogId": "123456789111", "Principal": { "DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-developer" }, "Resource": { "Table": { "CatalogId": "123456789111", "DatabaseName": "tpc", "TableWildcard": {} } }, "Permissions": [ "SELECT" ], "PermissionsWithGrantOption": [] } ``` このコマンドは何も出力しません。 詳細については、「*AWS Lake Formation Developer Guide*」の「[Granting and revoking permissions on Data Catalog resources](https://docs.aws.amazon.com/lake-formation/latest/dg/granting-catalog-permissions.html)」を参照してください。 **例 4: LF タグに対するアクセス許可をプリンシパルに付与するには** 次の `grant-permissions` の例では、LF タグに対する関連付けアクセス許可をプリンシパルに付与します。 ``` aws lakeformation grant-permissions \ --cli-input-json file://input.json ``` `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": [] } ``` このコマンドは何も出力しません。 詳細については、「*AWS Lake Formation Developer Guide*」の「[Granting and revoking permissions on Data Catalog resources](https://docs.aws.amazon.com/lake-formation/latest/dg/granting-catalog-permissions.html)」を参照してください。 **例 5: データロケーションに対するアクセス許可をプリンシパルに付与するには** 次の `grant-permissions` の例では、データロケーションに対するアクセス許可をプリンシパルに付与します。 ``` aws lakeformation grant-permissions \ --cli-input-json file://input.json ``` `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": [] } ``` このコマンドは何も出力しません。 詳細については、「*AWS Lake Formation Developer Guide*」の「[Granting and revoking permissions on Data Catalog resources](https://docs.aws.amazon.com/lake-formation/latest/dg/granting-catalog-permissions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GrantPermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/grant-permissions.html)」を参照してください。 ### `list-data-cells-filter` 次のコード例は、`list-data-cells-filter` を使用する方法を示しています。 **AWS CLI** **データセルフィルターを一覧表示するには** 次の `list-data-cells-filter` の例では、特定のテーブルのデータセルフィルターを一覧表示します。 ``` aws lakeformation list-data-cells-filter \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "MaxResults": 2, "Table": { "CatalogId": "123456789111", "DatabaseName": "tpc", "Name": "dl_tpc_promotion" } } ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Lake Formation Developer Guide*」の「[Data filtering and cell-level security in Lake Formation](https://docs.aws.amazon.com/lake-formation/latest/dg/data-filtering.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDataCellsFilter](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/list-data-cells-filter.html)」を参照してください。 ### `list-permissions` 次のコード例は、`list-permissions` を使用する方法を示しています。 **AWS CLI** **例 1: リソースに対するプリンシパルアクセス許可のリストを取得するには** 次の `list-permissions` の例では、データベースリソースに対するプリンシパルアクセス許可のリストを返します。 ``` aws lakeformation list-permissions \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "CatalogId": "123456789111", "ResourceType": "DATABASE", "MaxResults": 2 } ``` 出力: ``` { "PrincipalResourcePermissions": [{ "Principal": { "DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-campaign-manager" }, "Resource": { "Database": { "CatalogId": "123456789111", "Name": "tpc" } }, "Permissions": [ "DESCRIBE" ], "PermissionsWithGrantOption": [] }], "NextToken": "E5SlJDSTZleUp6SWpvaU9UQTNORE0zTXpFeE5Ua3pJbjE5TENKbGVIQnBjbUYwYVc5dUlqcDdJbk5sWTI5dVpITWlPakUyTm" } ``` 詳細については、「*AWS Lake Formation Developer Guide*」の「[Lake Formation アクセス許可の管理](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-permissions.html)」を参照してください。 **例 2: データフィルターを使用してテーブルに対するプリンシパルアクセス許可のリストを取得するには** 次の `list-permissions` の例では、プリンシパルに付与された関連するデータフィルターを使用して、テーブルに対するアクセス許可を一覧表示します。 ``` aws lakeformation list-permissions \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "CatalogId": "123456789111", "Resource": { "Table": { "CatalogId": "123456789111", "DatabaseName": "tpc", "Name": "dl_tpc_customer" } }, "IncludeRelated": "TRUE", "MaxResults": 10 } ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Lake Formation Developer Guide*」の「[Lake Formation アクセス許可の管理](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-permissions.html)」を参照してください。 **例 3: LF タグに対するプリンシパルアクセス許可のリストを取得するには** 次の `list-permissions` の例では、プリンシパルに付与された LF タグに対するアクセス許可を一覧表示します。 ``` aws lakeformation list-permissions \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "CatalogId": "123456789111", "Resource": { "LFTag": { "CatalogId": "123456789111", "TagKey": "category", "TagValues": [ "private" ] } }, "MaxResults": 10 } ``` 出力: ``` { "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=" } ``` 詳細については、「*AWS Lake Formation Developer Guide*」の「[Lake Formation アクセス許可の管理](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-permissions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/list-permissions.html)」を参照してください。 ### `list-resources` 次のコード例は、`list-resources` を使用する方法を示しています。 **AWS CLI** **Lake Formation によって管理されるリソースを一覧表示するには** 次の `list-resources` の例では、Lake Formation によって管理される条件に一致するリソースを一覧表示します。 ``` aws lakeformation list-resources \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "FilterConditionList": [{ "Field": "ROLE_ARN", "ComparisonOperator": "CONTAINS", "StringValueList": [ "123456789111" ] }], "MaxResults": 10 } ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS Lake Formation Developer Guide*」の「[Lake Formation アクセス許可の管理](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-permissions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListResources](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/list-resources.html)」を参照してください。 ### `list-transactions` 次のコード例は、`list-transactions` を使用する方法を示しています。 **AWS CLI** **すべてのトランザクションの詳細を一覧表示するには** 次の `list-transactions` の例では、トランザクションとそのステータスに関するメタデータを返します。 ``` aws lakeformation list-transactions \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "CatalogId": "123456789111", "StatusFilter": "ALL", "MaxResults": 3 } ``` 出力: ``` { "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==" } ``` 詳細については、「*AWS Lake Formation Developer Guide*」の「[Reading from and writing to the data lake within transactions](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTransactions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/list-transactions.html)」を参照してください。 ### `put-data-lake-settings` 次のコード例は、`put-data-lake-settings` を使用する方法を示しています。 **AWS CLI** **AWS Lake Formation 管理のデータレイクの設定を行うには** 次の `put-data-lake-settings` の例では、データレイク管理者およびその他のデータレイク設定のリストを設定します。 ``` aws lakeformation put-data-lake-settings \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "DataLakeSettings": { "DataLakeAdmins": [{ "DataLakePrincipalIdentifier": "arn:aws:iam::123456789111:user/lf-admin" } ], "CreateDatabaseDefaultPermissions": [], "CreateTableDefaultPermissions": [], "TrustedResourceOwners": [], "AllowExternalDataFiltering": true, "ExternalDataFilteringAllowList": [{ "DataLakePrincipalIdentifier ": "123456789111" }], "AuthorizedSessionTagValueList": ["Amazon EMR"] } } ``` このコマンドは何も出力しません。 詳細については、「*AWS Lake Formation Developer Guide*」の「[Changing the default security settings for your data lake](https://docs.aws.amazon.com/lake-formation/latest/dg/change-settings.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutDataLakeSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/put-data-lake-settings.html)」を参照してください。 ### `register-resource` 次のコード例は、`register-resource` を使用する方法を示しています。 **AWS CLI** **例 1: サービスリンクロールを使用してデータレイクストレージを登録するには** 次の `register-resource` の例では、サービスリンクロールを使用して Lake Formation によって管理されるリソースを登録します。 ``` aws lakeformation register-resource \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "ResourceArn": "arn:aws:s3:::lf-emr-athena-result-123", "UseServiceLinkedRole": true } ``` このコマンドは何も出力しません。 詳細については、「*AWS Lake Formation Developer Guide*」の「[Adding an Amazon S3 location to your data lake](https://docs.aws.amazon.com/lake-formation/latest/dg/register-data-lake.html)」を参照してください。 **例 2: カスタムロールを使用してデータレイクストレージを登録するには** 次の `register-resource` の例では、カスタムロールを使用して Lake Formation によって管理されるリソースを登録します。 ``` aws lakeformation register-resource \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "ResourceArn": "arn:aws:s3:::lf-emr-athena-result-123", "UseServiceLinkedRole": false, "RoleArn": "arn:aws:iam::123456789111:role/LF-GlueServiceRole" } ``` このコマンドは何も出力しません。 詳細については、「*AWS Lake Formation Developer Guide*」の「[Adding an Amazon S3 location to your data lake](https://docs.aws.amazon.com/lake-formation/latest/dg/register-data-lake.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegisterResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/register-resource.html)」を参照してください。 ### `remove-lf-tags-from-resource` 次のコード例は、`remove-lf-tags-from-resource` を使用する方法を示しています。 **AWS CLI** **リソースから LF タグを削除するには** 次の `remove-lf-tags-from-resource` の例では、LF タグとテーブルリソースとの関連付けを削除します。 ``` aws lakeformation remove-lf-tags-from-resource \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "CatalogId": "123456789111", "Resource": { "Table": { "CatalogId": "123456789111", "DatabaseName": "tpc", "Name": "dl_tpc_promotion" } }, "LFTags": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "developer" ] }] } ``` 出力: ``` { "Failures": [] } ``` 詳細については、「*AWS Lake Formation Developer Guide*」の「[Assigning LF-Tags to Data Catalog resources](https://docs.aws.amazon.com/lake-formation/latest/dg/TBAC-assigning-tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveLfTagsFromResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/remove-lf-tags-from-resource.html)」を参照してください。 ### `revoke-permissions` 次のコード例は、`revoke-permissions` を使用する方法を示しています。 **AWS CLI** **リソースに対するアクセス許可をプリンシパルから取り消すには** 次の `revoke-permissions` の例では、指定されたデータベースの特定のテーブルへのプリンシパルアクセス許可を取り消します。 ``` aws lakeformation revoke-permissions \ --cli-input-json file://input.json ``` `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": [] } ``` このコマンドは何も出力しません。 詳細については、「*AWS Lake Formation Developer Guide*」の「[Granting and revoking permissions on Data Catalog resources](https://docs.aws.amazon.com/lake-formation/latest/dg/granting-catalog-permissions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RevokePermissions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/revoke-permissions.html)」を参照してください。 ### `search-databases-by-lf-tags` 次のコード例は、`search-databases-by-lf-tags` を使用する方法を示しています。 **AWS CLI** **LFTags でデータベースリソースの検索を行うには** 次の `search-databases-by-lf-tags` の例では、LFTag 式に一致するデータベースリソースの検索を行います。 ``` aws lakeformation search-databases-by-lf-tags \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "MaxResults": 1, "CatalogId": "123456789111", "Expression": [{ "TagKey": "usergroup", "TagValues": [ "developer" ] }] } ``` 出力: ``` { "DatabaseList": [{ "Database": { "CatalogId": "123456789111", "Name": "tpc" }, "LFTags": [{ "CatalogId": "123456789111", "TagKey": "usergroup", "TagValues": [ "developer" ] }] }] } ``` 詳細については、「*AWS Lake Formation Developer Guide*」の「[Viewing the resources that a LF-Tag is assigned to](https://docs.aws.amazon.com/lake-formation/latest/dg/TBAC-view-tag-resources.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SearchDatabasesByLfTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/search-databases-by-lf-tags.html)」を参照してください。 ### `search-tables-by-lf-tags` 次のコード例は、`search-tables-by-lf-tags` を使用する方法を示しています。 **AWS CLI** **LFTags でテーブルリソースの検索を行うには** 次の `search-tables-by-lf-tags` の例では、LFTag 式に一致するテーブルリソースの検索を行います。 ``` aws lakeformation search-tables-by-lf-tags \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "MaxResults": 2, "CatalogId": "123456789111", "Expression": [{ "TagKey": "usergroup", "TagValues": [ "developer" ] }] } ``` 出力: ``` { "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" ] }] } ] }] } ``` 詳細については、「*AWS Lake Formation Developer Guide*」の「[Viewing the resources that a LF-Tag is assigned to](https://docs.aws.amazon.com/lake-formation/latest/dg/TBAC-view-tag-resources.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SearchTablesByLfTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/search-tables-by-lf-tags.html)」を参照してください。 ### `start-query-planning` 次のコード例は、`start-query-planning` を使用する方法を示しています。 **AWS CLI** **クエリステートメントを処理するには** 次の `start-query-planning` の例では、クエリステートメントを処理するリクエストを送信します。 ``` aws lakeformation start-query-planning \ --cli-input-json file://input.json ``` `input.json` の内容: ``` { "QueryPlanningContext": { "CatalogId": "012345678901", "DatabaseName": "tpc" }, "QueryString": "select * from dl_tpc_household_demographics_gov where hd_income_band_sk=9" } ``` 出力: ``` { "QueryId": "772a273f-4a62-4cda-8d98-69615ee8be9b" } ``` 詳細については、「*AWS Lake Formation Developer Guide*」の「[Reading from and writing to the data lake within transactions](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartQueryPlanning](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/start-query-planning.html)」を参照してください。 ### `start-transaction` 次のコード例は、`start-transaction` を使用する方法を示しています。 **AWS CLI** **新しいトランザクションを開始するには** 次の `start-transaction` の例では、新しいトランザクションを開始し、そのトランザクション ID を返します。 ``` aws lakeformation start-transaction \ --transaction-type = 'READ_AND_WRITE' ``` 出力: ``` { "TransactionId": "b014d972ca8347b89825e33c5774aec4" } ``` 詳細については、「*AWS Lake Formation Developer Guide*」の「[Reading from and writing to the data lake within transactions](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartTransaction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/start-transaction.html)」を参照してください。 ### `update-lf-tag` 次のコード例は、`update-lf-tag` を使用する方法を示しています。 **AWS CLI** **LF タグ定義を更新するには** 次の `update-lf-tag` の例では、LF タグ定義を更新します。 ``` aws lakeformation update-lf-tag \ --catalog-id '123456789111' \ --tag-key 'usergroup' \ --tag-values-to-add '["admin"]' ``` このコマンドは何も出力しません。 詳細については、「*AWS Lake Formation Developer Guide*」の「[Managing LF-Tags for metadata access control](https://docs.aws.amazon.com/lake-formation/latest/dg/managing-tags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateLfTag](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/update-lf-tag.html)」を参照してください。 ### `update-table-objects` 次のコード例は、`update-table-objects` を使用する方法を示しています。 **AWS CLI** **管理対象テーブルのオブジェクトを変更するには** 次の `update-table-objects` の例では、指定された管理対象テーブルに、提供された S3 オブジェクトを追加します。 ``` aws lakeformation update-table-objects \ --cli-input-json file://input.json ``` `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 } }] } ``` このコマンドは何も出力しません。 詳細については、「*AWS Lake Formation Developer Guide*」の「[Reading from and writing to the data lake within transactions](https://docs.aws.amazon.com/lake-formation/latest/dg/transaction-ops.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateTableObjects](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lakeformation/update-table-objects.html)」を参照してください。 # AWS CLI を使った Lambda の例 次のコード例は、Lambda で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `add-layer-version-permission` 次のコード例は、`add-layer-version-permission` を使用する方法を示しています。 **AWS CLI** **レイヤーバージョンに対するアクセス許可を追加するには** 次の `add-layer-version-permission` の例では、指定されたアカウントがレイヤー `my-layer` のバージョン 1 を使用するアクセス許可を付与します。 ``` aws lambda add-layer-version-permission \ --layer-name my-layer \ --statement-id xaccount \ --action lambda:GetLayerVersion \ --principal 123456789012 \ --version-number 1 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Lambda Developer Guide*」の「[AWS Lambda Layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddLayerVersionPermission](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/add-layer-version-permission.html)」を参照してください。 ### `add-permission` 次のコード例は、`add-permission` を使用する方法を示しています。 **AWS CLI** **既存の Lambda 関数に対するアクセス許可を追加するには** 次の `add-permission` の例では、`my-function` という名前の関数を呼び出すためのアクセス許可を Amazon SNS サービスに付与します。 ``` aws lambda add-permission \ --function-name my-function \ --action lambda:InvokeFunction \ --statement-id sns \ --principal sns.amazonaws.com ``` 出力: ``` { "Statement": { "Sid":"sns", "Effect":"Allow", "Principal":{ "Service":"sns.amazonaws.com" }, "Action":"lambda:InvokeFunction", "Resource":"arn:aws:lambda:us-east-2:123456789012:function:my-function" } } ``` 詳細については、「*AWS Lambda デベロッパー ガイド*」の「[AWS Lambda のリソースベースのポリシーを使用する](https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddPermission](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/add-permission.html)」を参照してください。 ### `create-alias` 次のコード例は、`create-alias` を使用する方法を示しています。 **AWS CLI** **Lambda 関数のエイリアスを作成する方法** 次の `create-alias` の例では、`my-function` Lambda 関数のバージョン 1 を参照する `LIVE` という名前のエイリアスを作成します。 ``` aws lambda create-alias \ --function-name my-function \ --description "alias for live version of function" \ --function-version 1 \ --name LIVE ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Lambda デベロッパーガイド*」の「[AWS Lambda 関数のエイリアスの設定](https://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[CreateAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/create-alias.html)」を参照してください。** ### `create-event-source-mapping` 次のコード例は、`create-event-source-mapping` を使用する方法を示しています。 **AWS CLI** **イベントソースと AWS Lambda 関数間のマッピングを作成するには** 次の `create-event-source-mapping` の例では、SQS キューと `my-function` Lambda 関数間のマッピングを作成します。 ``` aws lambda create-event-source-mapping \ --function-name my-function \ --batch-size 5 \ --event-source-arn arn:aws:sqs:us-west-2:123456789012:mySQSqueue ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Developer Guide*」の「[AWS Lambda Event Source Mapping](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateEventSourceMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/create-event-source-mapping.html)」を参照してください。 ### `create-function` 次のコード例は、`create-function` を使用する方法を示しています。 **AWS CLI** **Lambda 関数を作成するには** 次の `create-function` の例では、`my-function` という名前の Lambda 関数を作成します。 ``` 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 ``` `my-function.zip` の内容: ``` This file is a deployment package that contains your function code and any dependencies. ``` 出力: ``` { "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": "" } ``` 詳細については、「*AWS Lambda デベロッパーガイド*」の「[Lambda 関数のメモリを設定する](https://docs.aws.amazon.com/lambda/latest/dg/configuration-memory.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateFunction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/create-function.html)」を参照してください。 ### `delete-alias` 次のコード例は、`delete-alias` を使用する方法を示しています。 **AWS CLI** **Lambda 関数のエイリアスを削除する方法** 次の `delete-alias` の例では、`my-function` Lambda 関数から `LIVE` という名前のエイリアスを削除します。 ``` aws lambda delete-alias \ --function-name my-function \ --name LIVE ``` このコマンドは何も出力しません。 詳細については、「*AWS Lambda デベロッパーガイド*」の「[AWS Lambda 関数のエイリアスの設定](https://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[DeleteAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/delete-alias.html)」を参照してください。** ### `delete-event-source-mapping` 次のコード例は、`delete-event-source-mapping` を使用する方法を示しています。 **AWS CLI** **イベントソースと AWS Lambda 関数間のマッピングを削除するには** 次の `delete-event-source-mapping` の例では、SQS キューと `my-function` Lambda 関数間のマッピングを削除します。 ``` aws lambda delete-event-source-mapping \ --uuid a1b2c3d4-5678-90ab-cdef-11111EXAMPLE ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Developer Guide*」の「[AWS Lambda Event Source Mapping](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteEventSourceMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/delete-event-source-mapping.html)」を参照してください。 ### `delete-function-concurrency` 次のコード例は、`delete-function-concurrency` を使用する方法を示しています。 **AWS CLI** **関数から同時実行制限を削除する方法** 次の `delete-function-concurrency` の例では、予約済みの同時実行制限を `my-function` 関数から削除します。 ``` aws lambda delete-function-concurrency \ --function-name my-function ``` このコマンドは何も出力しません。 詳細については、「*AWS Lambda デベロッパーガイド*」の「[Lambda 関数の同時実行の予約](https://docs.aws.amazon.com/lambda/latest/dg/per-function-concurrency.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteFunctionConcurrency](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/delete-function-concurrency.html)」を参照してください。 ### `delete-function-event-invoke-config` 次のコード例は、`delete-function-event-invoke-config` を使用する方法を示しています。 **AWS CLI** **非同期呼び出し設定を削除するには** 次の `delete-function-event-invoke-config` の例では、指定された関数の `GREEN` エイリアスの非同期呼び出し設定を削除します。 ``` aws lambda delete-function-event-invoke-config --function-name my-function:GREEN ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteFunctionEventInvokeConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/delete-function-event-invoke-config.html)」を参照してください。 ### `delete-function` 次のコード例は、`delete-function` を使用する方法を示しています。 **AWS CLI** **例 1: Lambda 関数を関数名で削除するには** 次の `delete-function` の例では、関数名を指定して `my-function` という Lambda 関数を削除します。 ``` aws lambda delete-function \ --function-name my-function ``` このコマンドは何も出力しません。 **例 2: Lambda 関数を関数 ARN で削除するには** 次の `delete-function` の例では、関数 ARN を指定して `my-function` という Lambda 関数を削除します。 ``` aws lambda delete-function \ --function-name arn:aws:lambda:us-west-2:123456789012:function:my-function ``` このコマンドは何も出力しません。 **例 3: Lambda 関数を関数 ARN の一部で削除するには** 次の `delete-function` の例では、関数 ARN の一部を指定して `my-function` という Lambda 関数を削除します。 ``` aws lambda delete-function \ --function-name 123456789012:function:my-function ``` このコマンドは何も出力しません。 詳細については、「*AWS Lambda デベロッパーガイド*」の「[AWS Lambda 関数の設定](https://docs.aws.amazon.com/lambda/latest/dg/resource-model.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteFunction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/delete-function.html)」を参照してください。 ### `delete-layer-version` 次のコード例は、`delete-layer-version` を使用する方法を示しています。 **AWS CLI** **Lambda レイヤーのバージョンを削除するには** 次の `delete-layer-version` の例では、`my-layer` という名前のレイヤーのバージョン 2 を削除します。 ``` aws lambda delete-layer-version \ --layer-name my-layer \ --version-number 2 ``` このコマンドは何も出力しません。 詳細については、「*AWS Lambda Developer Guide*」の「[AWS Lambda Layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteLayerVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/delete-layer-version.html)」を参照してください。 ### `delete-provisioned-concurrency-config` 次のコード例は、`delete-provisioned-concurrency-config` を使用する方法を示しています。 **AWS CLI** **プロビジョニングされた同時実行数の設定を削除する方法** 次の `delete-provisioned-concurrency-config` の例では、指定した関数の `GREEN` エイリアスのプロビジョニングされた同時実行設定を削除します。 ``` aws lambda delete-provisioned-concurrency-config \ --function-name my-function \ --qualifier GREEN ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteProvisionedConcurrencyConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/delete-provisioned-concurrency-config.html)」を参照してください。 ### `get-account-settings` 次のコード例は、`get-account-settings` を使用する方法を示しています。 **AWS CLI** **AWS リージョンでアカウントに関する詳細を取得する方法** 次の `get-account-settings` の例では、アカウントの Lambda 制限および使用情報を表示します。 ``` aws lambda get-account-settings ``` 出力: ``` { "AccountLimit": { "CodeSizeUnzipped": 262144000, "UnreservedConcurrentExecutions": 1000, "ConcurrentExecutions": 1000, "CodeSizeZipped": 52428800, "TotalCodeSize": 80530636800 }, "AccountUsage": { "FunctionCount": 4, "TotalCodeSize": 9426 } } ``` 詳細については、「*AWS Lambda デベロッパーガイド*」の「[AWS Lambda の制限](https://docs.aws.amazon.com/lambda/latest/dg/limits.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAccountSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/get-account-settings.html)」を参照してください。 ### `get-alias` 次のコード例は、`get-alias` を使用する方法を示しています。 **AWS CLI** **関数エイリアスに関する詳細を取得する方法** 次の `get-alias` の例では、`my-function` Lambda 関数に `LIVE` という名前のエイリアスの詳細が表示されます。 ``` aws lambda get-alias \ --function-name my-function \ --name LIVE ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Lambda デベロッパーガイド*」の「[AWS Lambda 関数のエイリアスの設定](https://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/get-alias.html)」を参照してください。 ### `get-event-source-mapping` 次のコード例は、`get-event-source-mapping` を使用する方法を示しています。 **AWS CLI** **イベントソースマッピングの詳細を取得するには** 次の `get-event-source-mapping` の例では、SQS キューと `my-function` Lambda 関数間のマッピングの詳細を表示します。 ``` aws lambda get-event-source-mapping \ --uuid "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Developer Guide*」の「[AWS Lambda Event Source Mapping](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetEventSourceMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/get-event-source-mapping.html)」を参照してください。 ### `get-function-concurrency` 次のコード例は、`get-function-concurrency` を使用する方法を示しています。 **AWS CLI** **関数の予約済み同時実行設定を表示する方法** 次の `get-function-concurrency` の例では、指定した関数の予約済み同時実行設定を取得します。 ``` aws lambda get-function-concurrency \ --function-name my-function ``` 出力: ``` { "ReservedConcurrentExecutions": 250 } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetFunctionConcurrency](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/get-function-concurrency.html)」を参照してください。 ### `get-function-configuration` 次のコード例は、`get-function-configuration` を使用する方法を示しています。 **AWS CLI** **Lambda 関数のバージョン固有設定を取得する方法** 次の `get-function-configuration` の例では、`my-function` 関数のバージョン 2 の設定が表示されます。 ``` aws lambda get-function-configuration \ --function-name my-function:2 ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Lambda デベロッパーガイド*」の「[AWS Lambda 関数の設定](https://docs.aws.amazon.com/lambda/latest/dg/resource-model.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetFunctionConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/get-function-configuration.html)」を参照してください。 ### `get-function-event-invoke-config` 次のコード例は、`get-function-event-invoke-config` を使用する方法を示しています。 **AWS CLI** **非同期呼び出し設定を表示するには** 次の `get-function-event-invoke-config` の例では、指定された関数の `BLUE` エイリアスの非同期呼び出し設定を取得します。 ``` aws lambda get-function-event-invoke-config \ --function-name my-function:BLUE ``` 出力: ``` { "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" } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetFunctionEventInvokeConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/get-function-event-invoke-config.html)」を参照してください。 ### `get-function` 次のコード例は、`get-function` を使用する方法を示しています。 **AWS CLI** **関数に関する情報を取得するには** 次の例 `get-function` では、`my-function` 関数の情報が表示されます。 ``` aws lambda get-function \ --function-name my-function ``` 出力: ``` { "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": "" } } ``` 詳細については、「*AWS Lambda デベロッパーガイド*」の「[Lambda 関数のメモリを設定する](https://docs.aws.amazon.com/lambda/latest/dg/configuration-memory.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetFunction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/get-function.html)」を参照してください。 ### `get-layer-version-by-arn` 次のコード例は、`get-layer-version-by-arn` を使用する方法を示しています。 **AWS CLI** **Lambda レイヤーバージョンに関する情報を取得するには** 次の `get-layer-version-by-arn` の例では、指定された Amazon リソースネーム (ARN) を持つレイヤーバージョンに関する情報を表示します。 ``` aws lambda get-layer-version-by-arn \ --arn "arn:aws:lambda:us-west-2:123456789012:layer:AWSLambda-Python311-SciPy1x:2" ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Lambda Developer Guide*」の「[AWS Lambda Layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetLayerVersionByArn](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/get-layer-version-by-arn.html)」を参照してください。 ### `get-layer-version-policy` 次のコード例は、`get-layer-version-policy` を使用する方法を示しています。 **AWS CLI** **Lambda レイヤーバージョンのアクセス許可ポリシーを取得するには** 次の `get-layer-version-policy` の例では、`my-layer` という名前のレイヤーのバージョン 1 に関するポリシー情報を表示します。 ``` aws lambda get-layer-version-policy \ --layer-name my-layer \ --version-number 1 ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Lambda Developer Guide*」の「[AWS Lambda Layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetLayerVersionPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/get-layer-version-policy.html)」を参照してください。 ### `get-layer-version` 次のコード例は、`get-layer-version` を使用する方法を示しています。 **AWS CLI** **Lambda レイヤーバージョンに関する情報を取得するには** 次の `get-layer-version` の例では、`my-layer` という名前のレイヤーのバージョン 1 の情報を表示します。 ``` aws lambda get-layer-version \ --layer-name my-layer \ --version-number 1 ``` 出力: ``` { "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" ] } ``` 詳細については、「*AWS Lambda Developer Guide*」の「[AWS Lambda Layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetLayerVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/get-layer-version.html)」を参照してください。 ### `get-policy` 次のコード例は、`get-policy` を使用する方法を示しています。 **AWS CLI** **関数、バージョン、エイリアスのリソースベースの IAM ポリシーを取得する方法** 次の `get-policy` の例では、`my-function` Lambda 関数に関する情報が表示されます。 ``` aws lambda get-policy \ --function-name my-function ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Lambda デベロッパー ガイド*」の「[AWS Lambda のリソースベースポリシーの使用](https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/get-policy.html)」を参照してください。 ### `get-provisioned-concurrency-config` 次のコード例は、`get-provisioned-concurrency-config` を使用する方法を示しています。 **AWS CLI** **プロビジョニングされた同時実行設定を表示する方法** 次の `get-provisioned-concurrency-config` の例では、指定した関数の `BLUE` エイリアスにプロビジョニングされた同時実行設定の詳細が表示されます。 ``` aws lambda get-provisioned-concurrency-config \ --function-name my-function \ --qualifier BLUE ``` 出力: ``` { "RequestedProvisionedConcurrentExecutions": 100, "AvailableProvisionedConcurrentExecutions": 100, "AllocatedProvisionedConcurrentExecutions": 100, "Status": "READY", "LastModified": "2019-12-31T20:28:49+0000" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetProvisionedConcurrencyConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/get-provisioned-concurrency-config.html)」を参照してください。 ### `invoke` 次のコード例は、`invoke` を使用する方法を示しています。 **AWS CLI** **例 1: Lambda 関数を同期的に呼び出すには** 次の例 `invoke` では、`my-function` 関数を同期的に呼び出します。AWS CLI バージョン 2 を使用している場合、`cli-binary-format` オプションは必須です。詳細については、「*AWS コマンドラインインターフェイスのユーザーガイド*」の「[AWS CLI でサポートされているグローバルコマンドラインオプション](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html#cli-configure-options-list)」を参照してください。 ``` aws lambda invoke \ --function-name my-function \ --cli-binary-format raw-in-base64-out \ --payload '{ "name": "Bob" }' \ response.json ``` 出力: ``` { "ExecutedVersion": "$LATEST", "StatusCode": 200 } ``` 詳細については、「*AWS Lambda デベロッパーガイド*」の「[Lambda 関数を同期的に呼び出す](https://docs.aws.amazon.com/lambda/latest/dg/invocation-sync.html)」を参照してください。 **例 2: Lambda 関数を非同期で呼び出すには** 次の例 `invoke` では、`my-function` 関数を非同期で呼び出します。AWS CLI バージョン 2 を使用している場合、`cli-binary-format` オプションは必須です。詳細については、「*AWS コマンドラインインターフェイスのユーザーガイド*」の「[AWS CLI でサポートされているグローバルコマンドラインオプション](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html#cli-configure-options-list)」を参照してください。 ``` aws lambda invoke \ --function-name my-function \ --invocation-type Event \ --cli-binary-format raw-in-base64-out \ --payload '{ "name": "Bob" }' \ response.json ``` 出力: ``` { "StatusCode": 202 } ``` 詳細については、「*AWS Lambda デベロッパーガイド*」の「[Lambda 関数を非同期的に呼び出す](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[Invoke](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/invoke.html)」を参照してください。 ### `list-aliases` 次のコード例は、`list-aliases` を使用する方法を示しています。 **AWS CLI** **Lambda 関数のエイリアスのリストを取得するには** 次の `list-aliases` の例では、`my-function` Lambda 関数のエイリアスのリストを表示します。 ``` aws lambda list-aliases \ --function-name my-function ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS Lambda デベロッパーガイド*」の「[AWS Lambda 関数のエイリアスを設定する](https://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[ListAliases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/list-aliases.html)」を参照してください。** ### `list-event-source-mappings` 次のコード例は、`list-event-source-mappings` を使用する方法を示しています。 **AWS CLI** **関数のイベントソースマッピングを一覧表示するには** 次の `list-event-source-mappings` の例では、`my-function` Lambda 関数のイベントソースマッピングのリストを表示します。 ``` aws lambda list-event-source-mappings \ --function-name my-function ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS Developer Guide*」の「[AWS Lambda Event Source Mapping](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListEventSourceMappings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/list-event-source-mappings.html)」を参照してください。 ### `list-function-event-invoke-configs` 次のコード例は、`list-function-event-invoke-configs` を使用する方法を示しています。 **AWS CLI** **非同期呼び出し設定のリストを表示するには** 次の `list-function-event-invoke-configs` の例では、指定された関数の非同期呼び出し設定を一覧表示します。 ``` aws lambda list-function-event-invoke-configs \ --function-name my-function ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListFunctionEventInvokeConfigs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/list-function-event-invoke-configs.html)」を参照してください。 ### `list-functions` 次のコード例は、`list-functions` を使用する方法を示しています。 **AWS CLI** **Lambda 関数の一覧を取得するには** 次の例 `list-functions` では、現在のユーザーのすべての関数を一覧表示します。 ``` aws lambda list-functions ``` 出力: ``` { "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": "" } ] } ``` 詳細については、「*AWS Lambda デベロッパーガイド*」の「[Lambda 関数のメモリを設定する](https://docs.aws.amazon.com/lambda/latest/dg/configuration-memory.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListFunctions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/list-functions.html)」を参照してください。 ### `list-layer-versions` 次のコード例は、`list-layer-versions` を使用する方法を示しています。 **AWS CLI** **AWS Lambda レイヤーのバージョンを一覧表示するには** 次の `list-layers-versions` の例では、`my-layer` という名前のレイヤーのバージョンに関する情報を表示します。 ``` aws lambda list-layer-versions \ --layer-name my-layer ``` 出力: ``` { "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" ] } ] } ``` 詳細については、「*AWS Lambda Developer Guide*」の「[AWS Lambda Layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListLayerVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/list-layer-versions.html)」を参照してください。 ### `list-layers` 次のコード例は、`list-layers` を使用する方法を示しています。 **AWS CLI** **関数のランタイムと互換性のあるレイヤーを一覧表示するには** 次の `list-layers` の例では、Python 3.11 ランタイムと互換性のあるレイヤーに関する情報を表示します。 ``` aws lambda list-layers \ --compatible-runtime python3.11 ``` 出力: ``` { "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" ] } } ] } ``` 詳細については、「*AWS Lambda Developer Guide*」の「[AWS Lambda Layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListLayers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/list-layers.html)」を参照してください。 ### `list-provisioned-concurrency-configs` 次のコード例は、`list-provisioned-concurrency-configs` を使用する方法を示しています。 **AWS CLI** **プロビジョニングされた同時実行設定のリストを取得する方法** 次の `list-provisioned-concurrency-configs` の例では、指定された関数にプロビジョニングされた同時実行設定がリストされます。 ``` aws lambda list-provisioned-concurrency-configs \ --function-name my-function ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListProvisionedConcurrencyConfigs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/list-provisioned-concurrency-configs.html)」を参照してください。 ### `list-tags` 次のコード例は、`list-tags` を使用する方法を示しています。 **AWS CLI** **Lambda 関数のタグのリストを取得する方法** 次の `list-tags` の例では、`my-function` Lambda 関数にアタッチされたタグが表示されます。 ``` aws lambda list-tags \ --resource arn:aws:lambda:us-west-2:123456789012:function:my-function ``` 出力: ``` { "Tags": { "Category": "Web Tools", "Department": "Sales" } } ``` 詳細については、「*AWS Lambda デベロッパーガイド*」の「[ Lambda 関数のタグ付け](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/list-tags.html)」を参照してください。 ### `list-versions-by-function` 次のコード例は、`list-versions-by-function` を使用する方法を示しています。 **AWS CLI** **関数のバージョンのリストを取得する方法** 次の `list-versions-by-function` の例は、`my-function` Lambda 関数のバージョンのリストが表示されます。 ``` aws lambda list-versions-by-function \ --function-name my-function ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS Lambda デベロッパーガイド*」の「[AWS Lambda 関数のエイリアスの設定](https://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListVersionsByFunction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/list-versions-by-function.html)」を参照してください。 ### `publish-layer-version` 次のコード例は、`publish-layer-version` を使用する方法を示しています。 **AWS CLI** **Lambda レイヤーバージョンを作成するには** 次の `publish-layer-version` の例では、新しい Python ライブラリレイヤーバージョンを作成します。このコマンドは、指定された S3 バケット内の `layer.zip` という名前のファイルのレイヤーコンテンツを取得します。 ``` 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 ``` 出力: ``` { "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" ] } ``` 詳細については、「*AWS Lambda Developer Guide*」の「[AWS Lambda Layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PublishLayerVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/publish-layer-version.html)」を参照してください。 ### `publish-version` 次のコード例は、`publish-version` を使用する方法を示しています。 **AWS CLI** **関数の新しいバージョンを発行する方法** 次の `publish-version` の例では、`my-function` Lambda 関数の新しいバージョンを発行します。 ``` aws lambda publish-version \ --function-name my-function ``` 出力: ``` { "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": "" } ``` 詳細については、「*AWS Lambda デベロッパーガイド*」の「[AWS Lambda 関数のエイリアスの設定](https://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PublishVersion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/publish-version.html)」を参照してください。 ### `put-function-concurrency` 次のコード例は、`put-function-concurrency` を使用する方法を示しています。 **AWS CLI** **関数に予約済み同時実行制限を設定する方法** 次の `put-function-concurrency` の例では、`my-function` 関数に 100 個の予約済み同時実行数を設定します。 ``` aws lambda put-function-concurrency \ --function-name my-function \ --reserved-concurrent-executions 100 ``` 出力: ``` { "ReservedConcurrentExecutions": 100 } ``` 詳細については、「*AWS Lambda デベロッパーガイド*」の「[Lambda 関数の同時実行の予約](https://docs.aws.amazon.com/lambda/latest/dg/per-function-concurrency.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutFunctionConcurrency](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/put-function-concurrency.html)」を参照してください。 ### `put-function-event-invoke-config` 次のコード例は、`put-function-event-invoke-config` を使用する方法を示しています。 **AWS CLI** **非同期呼び出しのエラー処理を設定するには** 次の `put-function-event-invoke-config` の例では、最大イベント期間を 1 時間に設定し、指定された関数の再試行を無効にします。 ``` aws lambda put-function-event-invoke-config \ --function-name my-function \ --maximum-event-age-in-seconds 3600 \ --maximum-retry-attempts 0 ``` 出力: ``` { "LastModified": 1573686021.479, "FunctionArn": "arn:aws:lambda:us-east-2:123456789012:function:my-function:$LATEST", "MaximumRetryAttempts": 0, "MaximumEventAgeInSeconds": 3600, "DestinationConfig": { "OnSuccess": {}, "OnFailure": {} } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutFunctionEventInvokeConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/put-function-event-invoke-config.html)」を参照してください。 ### `put-provisioned-concurrency-config` 次のコード例は、`put-provisioned-concurrency-config` を使用する方法を示しています。 **AWS CLI** **プロビジョニングされた同時実行数を配分する方法** 次の `put-provisioned-concurrency-config` の例では、指定した関数の `BLUE` エイリアスに 100 個のプロビジョニングされた同時実行数を割り当てます。 ``` aws lambda put-provisioned-concurrency-config \ --function-name my-function \ --qualifier BLUE \ --provisioned-concurrent-executions 100 ``` 出力: ``` { "Requested ProvisionedConcurrentExecutions": 100, "Allocated ProvisionedConcurrentExecutions": 0, "Status": "IN_PROGRESS", "LastModified": "2019-11-21T19:32:12+0000" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutProvisionedConcurrencyConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/put-provisioned-concurrency-config.html)」を参照してください。 ### `remove-layer-version-permission` 次のコード例は、`remove-layer-version-permission` を使用する方法を示しています。 **AWS CLI** **レイヤーバージョンのアクセス許可を削除するには** 次の `remove-layer-version-permission` の例では、アカウントがレイヤーバージョンを設定するアクセス許可を削除します。 ``` aws lambda remove-layer-version-permission \ --layer-name my-layer \ --statement-id xaccount \ --version-number 1 ``` このコマンドは何も出力しません。 詳細については、「*AWS Lambda Developer Guide*」の「[AWS Lambda Layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveLayerVersionPermission](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/remove-layer-version-permission.html)」を参照してください。 ### `remove-permission` 次のコード例は、`remove-permission` を使用する方法を示しています。 **AWS CLI** **既存の Lambda 関数から許可を削除する方法** 次の `remove-permission` の例では、`my-function` という名前の関数を呼び出す許可を削除します。 ``` aws lambda remove-permission \ --function-name my-function \ --statement-id sns ``` このコマンドは何も出力しません。 詳細については、「*AWS Lambda デベロッパー ガイド*」の「[AWS Lambda のリソースベースポリシーの使用](https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemovePermission](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/remove-permission.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **既存の Lambda 関数にタグを追加する方法** 次の `tag-resource` の例では、指定した Lambda 関数に `DEPARTMENT` のキー名と `Department A` の値を持つタグを追加します。 ``` aws lambda tag-resource \ --resource arn:aws:lambda:us-west-2:123456789012:function:my-function \ --tags "DEPARTMENT=Department A" ``` このコマンドは何も出力しません。 詳細については、「*AWS Lambda デベロッパーガイド*」の「[ Lambda 関数のタグ付け](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **既存の Lambda 関数からタグを削除する方法** 次の `untag-resource` の例では、`DEPARTMENT` タグというキー名のタグを `my-function` Lambda 関数から削除します。 ``` aws lambda untag-resource \ --resource arn:aws:lambda:us-west-2:123456789012:function:my-function \ --tag-keys DEPARTMENT ``` このコマンドは何も出力しません。 詳細については、「*AWS Lambda デベロッパーガイド*」の「[ Lambda 関数のタグ付け](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/untag-resource.html)」を参照してください。 ### `update-alias` 次のコード例は、`update-alias` を使用する方法を示しています。 **AWS CLI** **関数エイリアスを更新する方法** 次の `update-alias` の例では、`my-function` Lambda 関数のバージョン 3 を参照するように、`LIVE` という名前のエイリアスを更新します。 ``` aws lambda update-alias \ --function-name my-function \ --function-version 3 \ --name LIVE ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Lambda デベロッパーガイド*」の「[AWS Lambda 関数のエイリアスの設定](https://docs.aws.amazon.com/lambda/latest/dg/aliases-intro.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[UpdateAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/update-alias.html)」を参照してください。** ### `update-event-source-mapping` 次のコード例は、`update-event-source-mapping` を使用する方法を示しています。 **AWS CLI** **イベントソースと AWS Lambda 関数間のマッピングを更新するには** 次の `update-event-source-mapping` の例では、指定したマッピングでバッチサイズを 8 に更新します。 ``` aws lambda update-event-source-mapping \ --uuid "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" \ --batch-size 8 ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Developer Guide*」の「[AWS Lambda Event Source Mapping](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventsourcemapping.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateEventSourceMapping](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/update-event-source-mapping.html)」を参照してください。 ### `update-function-code` 次のコード例は、`update-function-code` を使用する方法を示しています。 **AWS CLI** **Lambda 関数のコードを更新するには** 次の例 `update-function-code` では、未公開 (\$1LATEST) バージョンの `my-function` 関数のコードを、指定した zip ファイルの内容に置き換えます。 ``` aws lambda update-function-code \ --function-name my-function \ --zip-file fileb://my-function.zip ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Lambda デベロッパーガイド*」の「[AWS Lambda 関数の設定](https://docs.aws.amazon.com/lambda/latest/dg/resource-model.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateFunctionCode](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/update-function-code.html)」を参照してください。 ### `update-function-configuration` 次のコード例は、`update-function-configuration` を使用する方法を示しています。 **AWS CLI** **関数の設定を変更するには** 次の`update-function-configuration` の例では、未公開 (\$1LATEST) バージョンの `my-function` 関数のメモリサイズを 256 MB に変更しています。 ``` aws lambda update-function-configuration \ --function-name my-function \ --memory-size 256 ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Lambda デベロッパーガイド*」の「[AWS Lambda 関数の設定](https://docs.aws.amazon.com/lambda/latest/dg/resource-model.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateFunctionConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/update-function-configuration.html)」を参照してください。 ### `update-function-event-invoke-config` 次のコード例は、`update-function-event-invoke-config` を使用する方法を示しています。 **AWS CLI** **非同期呼び出し設定を更新するには** 次の `update-function-event-invoke-config` の例では、指定された関数の既存の非同期呼び出し設定に障害発生時の送信先を追加します。 ``` aws lambda update-function-event-invoke-config \ --function-name my-function \ --destination-config '{"OnFailure":{"Destination": "arn:aws:sqs:us-east-2:123456789012:destination"}}' ``` 出力: ``` { "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" } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateFunctionEventInvokeConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lambda/update-function-event-invoke-config.html)」を参照してください。 # AWS CLI を使用した License Manager の例 次のコード例は、License Manager で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-license-configuration` 次のコード例は、`create-license-configuration` を使用する方法を示しています。 **AWS CLI** **例 1: ライセンス設定を作成するには** 次の `create-license-configuration` の例では、ハード制限が 10 コアのライセンス設定を作成します。 ``` aws license-manager create-license-configuration --name my-license-configuration \ --license-counting-type Core \ --license-count 10 \ --license-count-hard-limit ``` 出力: ``` { "LicenseConfigurationArn": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba41EXAMPLE1111" } ``` **例 2: ライセンス設定を作成するには** 次の `create-license-configuration` の例では、ソフト制限が 100 vCPU のライセンス設定を作成します。ルールを使用して vCPU 最適化を有効にします。 ``` aws license-manager create-license-configuration --name my-license-configuration --license-counting-type vCPU \ --license-count 100 \ --license-rules "#honorVcpuOptimization=true" ``` 出力: ``` { "LicenseConfigurationArn": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba41EXAMPLE2222" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateLicenseConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/create-license-configuration.html)」を参照してください。 ### `delete-license-configuration` 次のコード例は、`delete-license-configuration` を使用する方法を示しています。 **AWS CLI** **ライセンス設定を削除するには** 次の `delete-license-configuration` の例では、指定されたライセンス設定を削除します。 ``` aws license-manager delete-license-configuration \ --license-configuration-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE ``` このコマンドは何も出力しません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteLicenseConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/delete-license-configuration.html)」を参照してください。 ### `get-license-configuration` 次のコード例は、`get-license-configuration` を使用する方法を示しています。 **AWS CLI** **ライセンス設定情報を取得するには** 次の `get-license-configuration` の例では、指定されたライセンス設定の詳細を表示します。 ``` aws license-manager get-license-configuration \ --license-configuration-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetLicenseConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/get-license-configuration.html)」を参照してください。 ### `get-service-settings` 次のコード例は、`get-service-settings` を使用する方法を示しています。 **AWS CLI** **License Manager の設定を取得するには** 次の `get-service-settings` の例では、現在のリージョンの License Manager のサービス設定を表示します。 ``` aws license-manager get-service-settings ``` クロスアカウントリソース検出が無効になっている場合の出力例を次に示します。 ``` { "OrganizationConfiguration": { "EnableIntegration": false }, "EnableCrossAccountsDiscovery": false } ``` クロスアカウントリソース検出が有効になっている場合の出力例を次に示します。 ``` { "S3BucketArn": "arn:aws:s3:::aws-license-manager-service-c22d6279-35c4-47c4-bb", "OrganizationConfiguration": { "EnableIntegration": true }, "EnableCrossAccountsDiscovery": true } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetServiceSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/get-service-settings.html)」を参照してください。 ### `list-associations-for-license-configuration` 次のコード例は、`list-associations-for-license-configuration` を使用する方法を示しています。 **AWS CLI** **ライセンス設定の関連付けを取得するには** 次の `list-associations-for-license-configuration` の例では、指定されたライセンス設定の関連付けに関する詳細情報を表示します。 ``` aws license-manager list-associations-for-license-configuration \ --license-configuration-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAssociationsForLicenseConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/list-associations-for-license-configuration.html)」を参照してください。 ### `list-license-configurations` 次のコード例は、`list-license-configurations` を使用する方法を示しています。 **AWS CLI** **例 1: すべてのライセンス設定を一覧表示するには** 次の `list-license-configurations` の例では、すべてのライセンス設定を一覧表示します。 ``` aws license-manager list-license-configurations ``` 出力: ``` { "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 } ] }, { ... } ] } ``` **例 2: 特定のライセンス設定を一覧表示するには** 次の `list-license-configurations` の例では、指定されたライセンス設定のみを一覧表示します。 ``` aws license-manager list-license-configurations \ --license-configuration-arns arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListLicenseConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/list-license-configurations.html)」を参照してください。 ### `list-license-specifications-for-resource` 次のコード例は、`list-license-specifications-for-resource` を使用する方法を示しています。 **AWS CLI** **リソースのライセンス設定を一覧表示するには** 次の `list-license-specifications-for-resource` の例では、指定された Amazon マシンイメージ (AMI) に関連付けられたライセンス設定を一覧表示します。 ``` aws license-manager list-license-specifications-for-resource \ --resource-arn arn:aws:ec2:us-west-2::image/ami-1234567890abcdef0 ``` 出力: ``` { "LicenseConfigurationArn": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListLicenseSpecificationsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/list-license-specifications-for-resource.html)」を参照してください。 ### `list-resource-inventory` 次のコード例は、`list-resource-inventory` を使用する方法を示しています。 **AWS CLI** **リソースインベントリ内のリソースを一覧表示するには** 次の `list-resource-inventory` の例では、Systems Manager インベントリを使用して管理されるリソースを一覧表示します。 ``` aws license-manager list-resource-inventory ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListResourceInventory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/list-resource-inventory.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **ライセンス設定のタグを一覧表示するには** 次の `list-tags-for-resource` の例では、指定されたライセンス設定のタグを一覧表示します。 ``` aws license-manager list-tags-for-resource \ --resource-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE ``` 出力: ``` { "Tags": [ { "Key": "project", "Value": "lima" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/list-tags-for-resource.html)」を参照してください。 ### `list-usage-for-license-configuration` 次のコード例は、`list-usage-for-license-configuration` を使用する方法を示しています。 **AWS CLI** **ライセンス設定で使用されているライセンスを一覧表示するには** 次の `list-usage-for-license-configuration` の例では、指定されたライセンス設定のライセンスを使用するリソースに関する情報を示します。例えば、ライセンスタイプが vCPU の場合、インスタンスは vCPU ごとに 1 つのライセンスを使用します。 ``` aws license-manager list-usage-for-license-configuration \ --license-configuration-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE ``` 出力: ``` { "LicenseConfigurationUsageList": [ { "ResourceArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-04a636d18e83cfacb", "ResourceType": "EC2_INSTANCE", "ResourceStatus": "running", "ResourceOwnerId": "123456789012", "AssociationTime": 1570892850.519, "ConsumedLicenses": 2 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListUsageForLicenseConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/list-usage-for-license-configuration.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **ライセンス設定にタグを追加するには** 次の `tag-resource` の例では、指定されたタグ (キー名と値) を、指定されたライセンス設定に追加します。 ``` aws license-manager tag-resource \ --tags Key=project,Value=lima \ --resource-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE ``` このコマンドは何も出力しません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **ライセンス設定からタグを削除するには** 次の `untag-resource` の例では、指定されたライセンス設定から、指定されたタグ (キー名とリソース) を削除します。 ``` aws license-manager untag-resource \ --tag-keys project \ --resource-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE ``` このコマンドは何も出力しません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/untag-resource.html)」を参照してください。 ### `update-license-configuration` 次のコード例は、`update-license-configuration` を使用する方法を示しています。 **AWS CLI** **ライセンス設定を更新するには** 次の `update-license-configuration` の例では、指定されたライセンス設定を更新して、ハード制限を削除します。 ``` 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 ``` このコマンドは何も出力しません。 次の `update-license-configuration` の例では、指定されたライセンス設定を更新して、ステータスを `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 ``` このコマンドは何も出力しません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateLicenseConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/update-license-configuration.html)」を参照してください。 ### `update-license-specifications-for-resource` 次のコード例は、`update-license-specifications-for-resource` を使用する方法を示しています。 **AWS CLI** **リソースのライセンス設定を更新するには** 次の `update-license-specifications-for-resource` の例では、1 つのライセンス設定を削除して別のライセンス設定を追加することにより、指定された Amazon マシンイメージ (AMI) に関連付けられたライセンス設定を置き換えます。 ``` 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 ``` このコマンドは何も出力しません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateLicenseSpecificationsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/update-license-specifications-for-resource.html)」を参照してください。 ### `update-service-settings` 次のコード例は、`update-service-settings` を使用する方法を示しています。 **AWS CLI** **License Manager の設定を更新するには** 次の `update-service-settings` の例では、現在の AWS リージョンで License Manager のクロスアカウントリソース検出を有効にします。Amazon S3 バケットは、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 ``` このコマンドは何も出力しません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateServiceSettings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/license-manager/update-service-settings.html)」を参照してください。 # Lightsail examples using AWS CLI 次のコード例では、Lightsail で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `allocate-static-ip` 次のコード例は、`allocate-static-ip` を使用する方法を示しています。 **AWS CLI** **静的 IP を作成するには** 次の `allocate-static-ip` の例では、インスタンスにアタッチできる指定された静的 IP を作成します。 ``` aws lightsail allocate-static-ip \ --static-ip-name StaticIp-1 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AllocateStaticIp](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/allocate-static-ip.html)」を参照してください。 ### `attach-disk` 次のコード例は、`attach-disk` を使用する方法を示しています。 **AWS CLI** **ブロックストレージディスクをインスタンスにアタッチするには** 次の `attach-disk` の例では、ディスクパス `/dev/xvdf` を使用してディスク `Disk-1` をインスタンス `WordPress_Multisite-1` にアタッチします。 ``` aws lightsail attach-disk \ --disk-name Disk-1 \ --disk-path /dev/xvdf \ --instance-name WordPress_Multisite-1 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AttachDisk](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/attach-disk.html)」を参照してください。 ### `attach-instances-to-load-balancer` 次のコード例は、`attach-instances-to-load-balancer` を使用する方法を示しています。 **AWS CLI** **インスタンスをロードバランサーにアタッチするには** 次の `attach-instances-to-load-balancer` の例では、インスタンス `MEAN-1`、`MEAN-2`、および `MEAN-3` をロードバランサー `LoadBalancer-1` にアタッチします。 ``` aws lightsail attach-instances-to-load-balancer \ --instance-names {"MEAN-1","MEAN-2","MEAN-3"} \ --load-balancer-name LoadBalancer-1 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AttachInstancesToLoadBalancer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/attach-instances-to-load-balancer.html)」を参照してください。 ### `attach-load-balancer-tls-certificate` 次のコード例は、`attach-load-balancer-tls-certificate` を使用する方法を示しています。 **AWS CLI** **ロードバランサーに TLS 証明書をアタッチするには** 次の `attach-load-balancer-tls-certificate` の例では、ロードバランサー TLS 証明書 `Certificate2` をロードバランサー `LoadBalancer-1` にアタッチします。 ``` aws lightsail attach-load-balancer-tls-certificate \ --certificate-name Certificate2 \ --load-balancer-name LoadBalancer-1 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AttachLoadBalancerTlsCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/attach-load-balancer-tls-certificate.html)」を参照してください。 ### `attach-static-ip` 次のコード例は、`attach-static-ip` を使用する方法を示しています。 **AWS CLI** **インスタンスに静的 IP をアタッチするには** 次の `attach-static-ip` の例では、静的 IP `StaticIp-1` をインスタンス `MEAN-1` にアタッチします。 ``` aws lightsail attach-static-ip \ --static-ip-name StaticIp-1 \ --instance-name MEAN-1 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AttachStaticIp](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/attach-static-ip.html)」を参照してください。 ### `close-instance-public-ports` 次のコード例は、`close-instance-public-ports` を使用する方法を示しています。 **AWS CLI** **インスタンスのファイアウォールポートを閉じるには** 次の `close-instance-public-ports` の例では、インスタンス `MEAN-2` の TCP ポート `22` を閉じます。 ``` aws lightsail close-instance-public-ports \ --instance-name MEAN-2 \ --port-info fromPort=22,protocol=TCP,toPort=22 ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CloseInstancePublicPorts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/close-instance-public-ports.html)」を参照してください。 ### `copy-snapshot` 次のコード例は、`copy-snapshot` を使用する方法を示しています。 **AWS CLI** **例 1: 同一の AWS リージョン内でスナップショットをコピーするには** 次の `copy-snapshot` の例では、インスタンススナップショット `MEAN-1-1571075291` を同じ AWS リージョン `us-west-2` 内のインスタンススナップショット `MEAN-1-Copy` としてコピーします。 ``` aws lightsail copy-snapshot \ --source-snapshot-name MEAN-1-1571075291 \ --target-snapshot-name MEAN-1-Copy \ --source-region us-west-2 ``` 出力: ``` { "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 } ] } ``` 詳細については、「*Lightsail Dev Guide*」の「[Copying snapshots from one AWS Region to another in Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-copying-snapshots-from-one-region-to-another)」を参照してください。 **例 2: ある AWS リージョンから別のリージョンにスナップショットをコピーするには** 次の `copy-snapshot` の例では、AWS リージョン `us-west-2` から `us-east-1` にインスタンススナップショット `MEAN-1-1571075291` をインスタンススナップショット `MEAN-1-1571075291-Copy` としてコピーします。 ``` 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 ``` 出力: ``` { "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 } ] } ``` 詳細については、「*Lightsail Dev Guide*」の「[Copying snapshots from one AWS Region to another in Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-copying-snapshots-from-one-region-to-another)」を参照してください。 **例 3: 自動スナップショットを同じ AWS リージョンにコピーするには** 次の `copy-snapshot` の例では、AWS リージョン `us-west-2` で、インスタンス `WordPress-1` の自動スナップショット `2019-10-14` を手動スナップショット `WordPress-1-10142019` としてコピーします。 ``` 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 ``` 出力: ``` { "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 } ] } ``` 詳細については、「*Lightsail Dev Guide*」の「[Keeping automatic snapshots of instances or disks in Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots)」を参照してください。 **例 4: ある AWS リージョンから別のリージョンに自動スナップショットをコピーするには** 次の `copy-snapshot` の例では、AWS リージョン `us-west-2` から `us-east-1` に、インスタンス `WordPress-1` の自動スナップショット `2019-10-14` を手動スナップショット `WordPress-1-10142019` としてコピーします。 ``` 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 ``` 出力: ``` { "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 } ] } ``` 詳細については、「*Lightsail Dev Guide*」の「[Keeping automatic snapshots of instances or disks in Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CopySnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/copy-snapshot.html)」を参照してください。 ### `create-disk-from-snapshot` 次のコード例は、`create-disk-from-snapshot` を使用する方法を示しています。 **AWS CLI** **ディスクスナップショットからディスクを作成するには** 次の `create-disk-from-snapshot` の例では、指定されたブロックストレージディスクスナップショットから `Disk-2` という名前のブロックストレージディスクを作成します。ディスクは、指定された AWS リージョンとアベイラビリティーゾーンに 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 ``` 出力: ``` { "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 } ] } ``` 詳細については、「*Lightsail Developer Guide*」の「[Creating a block storage disk from a snapshot in Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/create-new-block-storage-disk-from-snapshot)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDiskFromSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/create-disk-from-snapshot.html)」を参照してください。 ### `create-disk-snapshot` 次のコード例は、`create-disk-snapshot` を使用する方法を示しています。 **AWS CLI** **例 1: ディスクのスナップショットを作成するには** 次の `create-disk-snapshot` の例では、指定されたブロックストレージディスクの `DiskSnapshot-1` という名前のスナップショットを作成します。 ``` aws lightsail create-disk-snapshot \ --disk-name Disk-1 \ --disk-snapshot-name DiskSnapshot-1 ``` 出力: ``` { "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 } ] } ``` **例 2: インスタンスのシステムディスクのスナップショットを作成するには** 次の `create-disk-snapshot` の例では、指定されたインスタンスのシステムディスクのスナップショットを作成します。 ``` aws lightsail create-disk-snapshot \ --instance-name WordPress-1 \ --disk-snapshot-name SystemDiskSnapshot-1 ``` 出力: ``` { "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 } ] } ``` 詳細については、「*Lightsail Developer Guide*」の「[Snapshots in Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/understanding-instance-snapshots-in-amazon-lightsail)」および「[Creating a snapshot of an instance root volume in Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-create-an-instance-root-volume-snapshot)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDiskSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/create-disk-snapshot.html)」を参照してください。 ### `create-disk` 次のコード例は、`create-disk` を使用する方法を示しています。 **AWS CLI** **ブロックストレージディスクを作成するには** 次の `create-disk` の例では、指定された AWS リージョンとアベイラビリティーゾーンに 32 GB のストレージ容量を持つブロックストレージディスク `Disk-1` を作成します。 ``` aws lightsail create-disk \ --disk-name Disk-1 \ --availability-zone us-west-2a \ --size-in-gb 32 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDisk](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/create-disk.html)」を参照してください。 ### `create-domain-entry` 次のコード例は、`create-domain-entry` を使用する方法を示しています。 **AWS CLI** **ドメインエントリを作成するには (DNS レコード)** 次の `create-domain-entry` の例では、インスタンスの IP アドレスを指す指定されたドメインの Apex の DNS レコード (A) を作成します。 **注:** Lightsail のドメイン関連の API オペレーションは、`us-east-1` リージョンでのみ使用できます。CLI プロファイルが別のリージョンを使用するように設定されている場合は、`--region us-east-1` パラメータを含める必要があります。そうしないと、コマンドは失敗します。 ``` 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 ``` 出力: ``` { "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 } } ``` 詳細については、「*Lightsail Developer Guide*」の「[DNS in Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/understanding-dns-in-amazon-lightsail)」および「[Creating a DNS zone to manage your domain's DNS records in Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/lightsail-how-to-create-dns-entry)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDomainEntry](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/create-domain-entry.html)」を参照してください。 ### `create-domain` 次のコード例は、`create-domain` を使用する方法を示しています。 **AWS CLI** **ドメインを作成するには (DNS ゾーン)** 次の `create-domain` の例では、指定されたドメインの DNS ゾーンを作成します。 **注:** Lightsail のドメイン関連の API オペレーションは、`us-east-1` リージョンでのみ使用できます。CLI プロファイルが別のリージョンを使用するように設定されている場合は、`--region us-east-1` パラメータを含める必要があります。そうしないと、コマンドは失敗します。 ``` aws lightsail create-domain \ --region us-east-1 \ --domain-name example.com ``` 出力: ``` { "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 } } ``` 詳細については、「*Lightsail Developer Guide*」の「[DNS in Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/understanding-dns-in-amazon-lightsail)」および「[Creating a DNS zone to manage your domain's DNS records in Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/lightsail-how-to-create-dns-entry)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/create-domain.html)」を参照してください。 ### `create-instance-snapshot` 次のコード例は、`create-instance-snapshot` を使用する方法を示しています。 **AWS CLI** **インスタンスのスナップショットを作成するには** 次の `create-instance-snapshot` の例では、指定されたインスタンスからスナップショットを作成します。 ``` aws lightsail create-instance-snapshot \ --instance-name WordPress-1 \ --instance-snapshot-name WordPress-Snapshot-1 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateInstanceSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/create-instance-snapshot.html)」を参照してください。 ### `create-instances-from-snapshot` 次のコード例は、`create-instances-from-snapshot` を使用する方法を示しています。 **AWS CLI** **スナップショットからインスタンスを作成するには** 次の `create-instances-from-snapshot` の例では、12 USD のバンドルを使用して、指定された AWS リージョンとアベイラビリティーゾーンの指定されたインスタンススナップショットからインスタンスを作成します。 **注:** 指定するバンドルは、スナップショットの作成に使用される元のソースインスタンスのバンドルと同等の仕様か、それ以上である必要があります。 ``` 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 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateInstancesFromSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/create-instances-from-snapshot.html)」を参照してください。 ### `create-instances` 次のコード例は、`create-instances` を使用する方法を示しています。 **AWS CLI** **例 1: 単一のインスタンスを作成するには** 次の `create-instances` の例では、WordPress ブループリントと 5.00 USD バンドルを使用して、指定された AWS リージョンとアベイラビリティーゾーンにインスタンスを作成します。 ``` aws lightsail create-instances \ --instance-names Instance-1 \ --availability-zone us-west-2a \ --blueprint-id wordpress \ --bundle-id nano_3_0 ``` 出力: ``` { "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 } ] } ``` **例 2: 一度に複数のインスタンスを作成するには** 次の `create-instances` の例では、WordPress ブループリントと 5.00 USD バンドルを使用して、指定された AWS リージョンとアベイラビリティーゾーンに 3 つのインスタンスを作成します。 ``` aws lightsail create-instances \ --instance-names {"Instance1","Instance2","Instance3"} \ --availability-zone us-west-2a \ --blueprint-id wordpress \ --bundle-id nano_3_0 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/create-instances.html)」を参照してください。 ### `create-key-pair` 次のコード例は、`create-key-pair` を使用する方法を示しています。 **AWS CLI** **キーペアを作成するには** 次の `create-key-pair` の例では、インスタンスの認証と接続に使用できるキーペアを作成します。 ``` aws lightsail create-key-pair \ --key-pair-name MyPersonalKeyPair ``` 出力はプライベートキー base64 値を提供します。この値は、作成したキーペアを使用するインスタンスへの認証に使用できます。**注:** プライベートキー base64 値は後で取得できないため、コピーして安全な場所に貼り付けます。 ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateKeyPair](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/create-key-pair.html)」を参照してください。 ### `create-load-balancer-tls-certificate` 次のコード例は、`create-load-balancer-tls-certificate` を使用する方法を示しています。 **AWS CLI** **ロードバランサーの TLS 証明書を作成するには** 次の `create-load-balancer-tls-certificate` の例では、指定されたロードバランサーにアタッチされた TLS 証明書を作成します。作成された証明書は、指定されたドメインに適用されます。**注:** ロードバランサーに対して作成できる証明書は 2 つだけです。 ``` 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 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateLoadBalancerTlsCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/create-load-balancer-tls-certificate.html)」を参照してください。 ### `create-load-balancer` 次のコード例は、`create-load-balancer` を使用する方法を示しています。 **AWS CLI** **ロードバランサーを作成するには** 次の `create-load-balancer` の例では、TLS 証明書を使用してロードバランサーを作成します。TLS 証明書は、指定されたドメインに適用され、トラフィックをポート 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 ``` 出力: ``` { "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 } ] } ``` 詳細については、「*Lightsail Developer Guide*」の「[Lightsail load balancers](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/understanding-lightsail-load-balancers)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[CreateLoadBalancer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/create-load-balancer.html)」を参照してください。** ### `create-relational-database-from-snapshot` 次のコード例は、`create-relational-database-from-snapshot` を使用する方法を示しています。 **AWS CLI** **スナップショットからマネージドデータベースを作成するには** 次の `create-relational-database-from-snapshot` の例では、15 USD の標準データベースバンドルを使用して、指定された AWS リージョンとアベイラビリティーゾーンの指定されたスナップショットからマネージドデータベースを作成します。**注:** 指定するバンドルは、スナップショットの作成に使用される元のソースデータベースのバンドルと同等の仕様か、それ以上である必要があります。 ``` 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 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateRelationalDatabaseFromSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/create-relational-database-from-snapshot.html)」を参照してください。 ### `create-relational-database-snapshot` 次のコード例は、`create-relational-database-snapshot` を使用する方法を示しています。 **AWS CLI** **マネージドデータベースのスナップショットを作成するには** 次の `create-relational-database-snapshot` の例では、指定されたマネージドデータベースのスナップショットを作成します。 ``` aws lightsail create-relational-database-snapshot \ --relational-database-name Database1 \ --relational-database-snapshot-name RelationalDatabaseSnapshot1 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateRelationalDatabaseSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/create-relational-database-snapshot.html)」を参照してください。 ### `create-relational-database` 次のコード例は、`create-relational-database` を使用する方法を示しています。 **AWS CLI** **マネージドデータベースを作成するには** 次の `create-relational-database` の例では、MySQL 5.6 データベースエンジン (mysql\$15\$16) と 15 USD の標準データベースバンドル (micro\$11\$10) を使用して、指定された AWS リージョンとアベイラビリティーゾーンにマネージドデータベースを作成します。マネージドデータベースにはマスターユーザー名があらかじめ入力されており、パブリックにアクセスすることはできません。 ``` 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 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateRelationalDatabase](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/create-relational-database.html)」を参照してください。 ### `delete-auto-snapshot` 次のコード例は、`delete-auto-snapshot` を使用する方法を示しています。 **AWS CLI** **自動スナップショットは削除するには** 次の `delete-auto-snapshot` の例では、インスタンス `WordPress-1` の自動スナップショット `2019-10-10` を削除します。 ``` aws lightsail delete-auto-snapshot \ --resource-name WordPress-1 \ --date 2019-10-10 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Lightsail Dev Guide*」の「[Deleting automatic snapshots of instances or disks in Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-deleting-automatic-snapshots)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAutoSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/delete-auto-snapshot.html)」を参照してください。 ### `delete-disk-snapshot` 次のコード例は、`delete-disk-snapshot` を使用する方法を示しています。 **AWS CLI** **ブロックストレージディスクのスナップショットを削除するには** 次の `delete-disk-snapshot` の例では、ブロックストレージディスクの指定されたスナップショットを削除します。 ``` aws lightsail delete-disk-snapshot \ --disk-snapshot-name DiskSnapshot-1 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDiskSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/delete-disk-snapshot.html)」を参照してください。 ### `delete-disk` 次のコード例は、`delete-disk` を使用する方法を示しています。 **AWS CLI** **ブロックストレージディスクを削除するには** 次の `delete-disk` の例では、指定されたブロックストレージディスクを削除します。 ``` aws lightsail delete-disk \ --disk-name Disk-1 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDisk](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/delete-disk.html)」を参照してください。 ### `delete-domain-entry` 次のコード例は、`delete-domain-entry` を使用する方法を示しています。 **AWS CLI** **ドメインエントリを削除するには (DNS レコード)** 次の `delete-domain-entry` の例では、既存のドメインから、指定されたドメインエントリを削除します。 **注:** Lightsail のドメイン関連の API オペレーションは、`us-east-1` リージョンでのみ使用できます。CLI プロファイルが別のリージョンを使用するように設定されている場合は、`--region us-east-1` パラメータを含める必要があります。そうしないと、コマンドは失敗します。 ``` 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 ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDomainEntry](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/delete-domain-entry.html)」を参照してください。 ### `delete-domain` 次のコード例は、`delete-domain` を使用する方法を示しています。 **AWS CLI** **ドメインを削除するには (DNS ゾーン)** 次の `delete-domain` の例では、指定されたドメインとドメイン内のすべてのエントリ (DNS レコード) を削除します。 **注:** Lightsail のドメイン関連の API オペレーションは、`us-east-1` リージョンでのみ使用できます。CLI プロファイルが別のリージョンを使用するように設定されている場合は、`--region us-east-1` パラメータを含める必要があります。そうしないと、コマンドは失敗します。 ``` aws lightsail delete-domain \ --region us-east-1 \ --domain-name example.com ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/delete-domain.html)」を参照してください。 ### `delete-instance-snapshot` 次のコード例は、`delete-instance-snapshot` を使用する方法を示しています。 **AWS CLI** **title** 次の `delete-instance-snapshot` の例では、インスタンスの指定されたスナップショットを削除します。 ``` aws lightsail delete-instance-snapshot \ --instance-snapshot-name WordPress-1-Snapshot-1 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteInstanceSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/delete-instance-snapshot.html)」を参照してください。 ### `delete-instance` 次のコード例は、`delete-instance` を使用する方法を示しています。 **AWS CLI** **インスタンスを削除するには** 次の `delete-instance` の例では、指定されたインスタンスを削除します。 ``` aws lightsail delete-instance \ --instance-name WordPress-1 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/delete-instance.html)」を参照してください。 ### `delete-key-pair` 次のコード例は、`delete-key-pair` を使用する方法を示しています。 **AWS CLI** **キーペアを削除するには** 次の `delete-key-pair` の例では、指定されたキーペアを削除します。 ``` aws lightsail delete-key-pair \ --key-pair-name MyPersonalKeyPair ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteKeyPair](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/delete-key-pair.html)」を参照してください。 ### `delete-known-host-keys` 次のコード例は、`delete-known-host-keys` を使用する方法を示しています。 **AWS CLI** **インスタンスから既知のホストキーを削除するには** 次の `delete-known-host-keys` の例では、指定されたインスタンスから既知のホストキーを削除します。 ``` aws lightsail delete-known-host-keys \ --instance-name Instance-1 ``` 出力: ``` { "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 } ] } ``` 詳細については、「*Lightsail Dev Guide*」の「[Troubleshooting connection issues with the Amazon Lightsail browser-based SSH or RDP client](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-troubleshooting-browser-based-ssh-rdp-client-connection)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteKnownHostKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/delete-known-host-keys.html)」を参照してください。 ### `delete-load-balancer-tls-certificate` 次のコード例は、`delete-load-balancer-tls-certificate` を使用する方法を示しています。 **AWS CLI** **ロードバランサーの TLS 証明書を削除するには** 次の `delete-load-balancer-tls-certificate` の例では、指定されたロードバランサーから、指定された TLS 証明書を削除します。 ``` aws lightsail delete-load-balancer-tls-certificate \ --load-balancer-name MyFirstLoadBalancer \ --certificate-name MyFirstCertificate ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteLoadBalancerTlsCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/delete-load-balancer-tls-certificate.html)」を参照してください。 ### `delete-load-balancer` 次のコード例は、`delete-load-balancer` を使用する方法を示しています。 **AWS CLI** **ロードバランサーを削除するには** 次の `delete-load-balancer` の例では、指定されたロードバランサーと関連する TLS 証明書を削除します。 ``` aws lightsail delete-load-balancer \ --load-balancer-name MyFirstLoadBalancer ``` 出力: ``` { "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 } ] } ``` 詳細については、*ガイド*のタイトルを参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[DeleteLoadBalancer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/delete-load-balancer.html)」を参照してください。** ### `delete-relational-database-snapshot` 次のコード例は、`delete-relational-database-snapshot` を使用する方法を示しています。 **AWS CLI** **マネージドデータベースのスナップショットを削除するには** 次の `delete-relational-database-snapshot` の例では、マネージドデータベースの指定されたスナップショットを削除します。 ``` aws lightsail delete-relational-database-snapshot \ --relational-database-snapshot-name Database-Oregon-1-1566839359 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRelationalDatabaseSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/delete-relational-database-snapshot.html)」を参照してください。 ### `delete-relational-database` 次のコード例は、`delete-relational-database` を使用する方法を示しています。 **AWS CLI** **マネージドデータベースを削除するには** 次の `delete-relational-database` の例では、指定されたマネージドデータベースを削除します。 ``` aws lightsail delete-relational-database \ --relational-database-name Database-1 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteRelationalDatabase](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/delete-relational-database.html)」を参照してください。 ### `detach-static-ip` 次のコード例は、`detach-static-ip` を使用する方法を示しています。 **AWS CLI** **インスタンスから静的 IP をデタッチするには** 次の `detach-static-ip` の例では、アタッチされたインスタンスから静的 IP `StaticIp-1` をデタッチします。 ``` aws lightsail detach-static-ip \ --static-ip-name StaticIp-1 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DetachStaticIp](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/detach-static-ip.html)」を参照してください。 ### `get-active-names` 次のコード例は、`get-active-names` を使用する方法を示しています。 **AWS CLI** **アクティブなリソース名を取得するには** 次の `get-active-names` の例では、設定された AWS リージョンのアクティブなリソース名を返します。 ``` aws lightsail get-active-names ``` 出力: ``` { "activeNames": [ "WordPress-1", "StaticIp-1", "MEAN-1", "Plesk_Hosting_Stack_on_Ubuntu-1" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetActiveNames](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-active-names.html)」を参照してください。 ### `get-auto-snapshots` 次のコード例は、`get-auto-snapshots` を使用する方法を示しています。 **AWS CLI** **インスタンスで使用可能な自動スナップショットを取得するには** 次の `get-auto-snapshots` の例では、インスタンス `WordPress-1` で使用可能な自動スナップショットを返します。 ``` aws lightsail get-auto-snapshots \ --resource-name WordPress-1 ``` 出力: ``` { "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": [] } ] } ``` 詳細については、「*Lightsail Dev Guide*」の「[Keeping automatic snapshots of instances or disks in Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-keeping-automatic-snapshots)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAutoSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-auto-snapshots.html)」を参照してください。 ### `get-blueprints` 次のコード例は、`get-blueprints` を使用する方法を示しています。 **AWS CLI** **新しいインスタンスのブループリントを取得するには** 次の `get-blueprints` の例では、Amazon Lightsail で新しいインスタンスを作成するために使用できるすべてのブループリントの詳細を表示します。 ``` aws lightsail get-blueprints ``` 出力: ``` { "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" }, ... } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetBlueprints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-blueprints.html)」を参照してください。 ### `get-bundles` 次のコード例は、`get-bundles` を使用する方法を示しています。 **AWS CLI** **新しいインスタンスのバンドルを取得するには** 次の `get-bundles` の例では、Amazon Lightsail で新しいインスタンスを作成するために使用できるすべてのバンドルの詳細を表示します。 ``` aws lightsail get-bundles ``` 出力: ``` { "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" ] }, ... } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetBundles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-bundles.html)」を参照してください。 ### `get-cloud-formation-stack-records` 次のコード例は、`get-cloud-formation-stack-records` を使用する方法を示しています。 **AWS CLI** **CloudFormation スタックレコードと関連するスタックを取得するには** 次の `get-cloud-formation-stack-records` の例では、エクスポートされた Amazon Lightsail スナップショットから Amazon EC2 リソースを作成するために使用される CloudFormation スタックレコードと、それらに関連するスタックの詳細を示します。 ``` aws lightsail get-cloud-formation-stack-records ``` 出力: ``` { "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" } } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetCloudFormationStackRecords](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-cloud-formation-stack-records.html)」を参照してください。 ### `get-disk-snapshot` 次のコード例は、`get-disk-snapshot` を使用する方法を示しています。 **AWS CLI** **ディスクスナップショットに関する情報を取得するには** 次の `get-disk-snapshot` の例では、ディスクスナップショット `Disk-1-1566839161` の詳細を表示します。 ``` aws lightsail get-disk-snapshot \ --disk-snapshot-name Disk-1-1566839161 ``` 出力: ``` { "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 } } ``` 詳細については、*ガイド*のタイトルを参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDiskSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-disk-snapshot.html)」を参照してください。 ### `get-disk-snapshots` 次のコード例は、`get-disk-snapshots` を使用する方法を示しています。 **AWS CLI** **すべてのディスクスナップショットに関する情報を取得するには** 次の `get-disk-snapshots` の例では、設定された AWS リージョン内のすべてのディスクスナップショットの詳細を表示します。 ``` aws lightsail get-disk-snapshots ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDiskSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-disk-snapshots.html)」を参照してください。 ### `get-disk` 次のコード例は、`get-disk` を使用する方法を示しています。 **AWS CLI** **ブロックストレージディスクに関する情報を取得するには** 次の `get-disk` の例では、ディスク `Disk-1` に関する詳細を表示します。 ``` aws lightsail get-disk \ --disk-name Disk-1 ``` 出力: ``` { "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" } } ``` 詳細については、*ガイド*のタイトルを参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDisk](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-disk.html)」を参照してください。 ### `get-disks` 次のコード例は、`get-disks` を使用する方法を示しています。 **AWS CLI** **すべてのブロックストレージディスクに関する情報を取得するには** 次の `get-disks` の例では、設定された AWS リージョン内のすべてのディスクの詳細を表示します。 ``` aws lightsail get-disks ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDisks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-disks.html)」を参照してください。 ### `get-domain` 次のコード例は、`get-domain` を使用する方法を示しています。 **AWS CLI** **ドメインに関する情報を取得するには** 次の `get-domain` の例では、ドメイン `example.com` の詳細を表示します。 **注:** Lightsail のドメイン関連の API オペレーションは、`us-east-1` AWS リージョンでのみ使用できます。CLI プロファイルが別のリージョンを使用するように設定されている場合は、`` --region us-east-1`` パラメータを含める必要があります。そうしないと、コマンドは失敗します。 ``` aws lightsail get-domain \ --domain-name example.com \ --region us-east-1 ``` 出力: ``` { "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" } ] } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-domain.html)」を参照してください。 ### `get-domains` 次のコード例は、`get-domains` を使用する方法を示しています。 **AWS CLI** **すべてのドメインに関する情報を取得するには** 次の `get-domains` の例では、設定された AWS リージョン内のすべてのドメインの詳細を表示します。 **注:** Lightsail のドメイン関連の API オペレーションは、`us-east-1` AWS リージョンでのみ使用できます。CLI プロファイルが別のリージョンを使用するように設定されている場合は、`--region us-east-1` パラメータを含める必要があります。そうしないと、コマンドは失敗します。 ``` aws lightsail get-domains \ --region us-east-1 ``` 出力: ``` { "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" } ] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDomains](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-domains.html)」を参照してください。 ### `get-export-snapshot-record` 次のコード例は、`get-export-snapshot-record` を使用する方法を示しています。 **AWS CLI** **Amazon EC2 にエクスポートされたスナップショットのレコードを取得するには** 次の `get-export-snapshot-record` の例では、Amazon EC2 にエクスポートされた Amazon Lightsail インスタンスまたはディスクスナップショットの詳細を表示します。 ``` aws lightsail get-export-snapshot-records ``` 出力: ``` { "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" } } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetExportSnapshotRecord](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-export-snapshot-record.html)」を参照してください。 ### `get-instance-access-details` 次のコード例は、`get-instance-access-details` を使用する方法を示しています。 **AWS CLI** **インスタンスのホストキー情報を取得するには** 次の `get-instance-access-details` の例では、インスタンス `WordPress_Multisite-1` のホストキー情報を表示します。 ``` aws lightsail get-instance-access-details \ --instance-name WordPress_Multisite-1 ``` 出力: ``` { "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" } ] } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetInstanceAccessDetails](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-instance-access-details.html)」を参照してください。 ### `get-instance-metric-data` 次のコード例は、`get-instance-metric-data` を使用する方法を示しています。 **AWS CLI** **インスタンスのメトリクスデータを取得するには** 次の `get-instance-metric-data` の例では、インスタンス `MEAN-1` の `1571342400` と `1571428800` の間の `7200` 秒 (2 時間) ごとの `CPUUtilization` の平均パーセントを返します。 Unix タイムコンバーターを使用して、開始時刻と終了時刻を特定することをお勧めします。 ``` 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 ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetInstanceMetricData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-instance-metric-data.html)」を参照してください。 ### `get-instance-port-states` 次のコード例は、`get-instance-port-states` を使用する方法を示しています。 **AWS CLI** **インスタンスのファイアウォール情報を取得するには** 次の `get-instance-port-states` の例では、インスタンス `MEAN-1` 用に設定されたファイアウォールポートを返します。 ``` aws lightsail get-instance-port-states \ --instance-name MEAN-1 ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetInstancePortStates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-instance-port-states.html)」を参照してください。 ### `get-instance-snapshot` 次のコード例は、`get-instance-snapshot` を使用する方法を示しています。 **AWS CLI** **指定されたインスタンススナップショットに関する情報を取得するには** 次の `get-instance-snapshot` の例では、指定されたインスタンススナップショットの詳細を表示します。 ``` aws lightsail get-instance-snapshot \ --instance-snapshot-name MEAN-1-1571419854 ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetInstanceSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-instance-snapshot.html)」を参照してください。 ### `get-instance-snapshots` 次のコード例は、`get-instance-snapshots` を使用する方法を示しています。 **AWS CLI** **すべてのインスタンススナップショットに関する情報を取得するには** 次の `get-instance-snapshots` の例では、設定された AWS リージョン内のすべてのインスタンススナップショットの詳細を表示します。 ``` aws lightsail get-instance-snapshots ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetInstanceSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-instance-snapshots.html)」を参照してください。 ### `get-instance-state` 次のコード例は、`get-instance-state` を使用する方法を示しています。 **AWS CLI** **インスタンスの状態に関する情報を取得するには** 次の `get-instance-state` の例では、指定されたインスタンスの状態を返します。 ``` aws lightsail get-instance-state \ --instance-name MEAN-1 ``` 出力: ``` { "state": { "code": 16, "name": "running" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetInstanceState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-instance-state.html)」を参照してください。 ### `get-instance` 次のコード例は、`get-instance` を使用する方法を示しています。 **AWS CLI** **インスタンスの情報を取得するには** 次の `get-instance` の例では、指定されたインスタンス `MEAN-1` の詳細を表示します。 ``` aws lightsail get-instance \ --instance-name MEAN-1 ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-instance.html)」を参照してください。 ### `get-instances` 次のコード例は、`get-instances` を使用する方法を示しています。 **AWS CLI** **すべてのインスタンスに関する情報を取得するには** 次の `get-instances` の例では、設定された AWS リージョン内のすべてのインスタンスの詳細を表示します。 ``` aws lightsail get-instances ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-instances.html)」を参照してください。 ### `get-key-pair` 次のコード例は、`get-key-pair` を使用する方法を示しています。 **AWS CLI** **キーペアに関する情報を取得するには** 次の `get-key-pair` の例では、指定されたキーペアの詳細を表示します。 ``` aws lightsail get-key-pair \ --key-pair-name MyKey1 ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetKeyPair](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-key-pair.html)」を参照してください。 ### `get-key-pairs` 次のコード例は、`get-key-pairs` を使用する方法を示しています。 **AWS CLI** **すべてのキーペアに関する情報を取得するには** 次の `get-key-pairs` の例では、設定された AWS リージョン内のすべてのキーペアの詳細を表示します。 ``` aws lightsail get-key-pairs ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetKeyPairs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-key-pairs.html)」を参照してください。 ### `get-load-balancer-tls-certificates` 次のコード例は、`get-load-balancer-tls-certificates` を使用する方法を示しています。 **AWS CLI** **ロードバランサーの TLS 証明書に関する情報を取得するには** 次の `get-load-balancer-tls-certificates` の例では、指定されたロードバランサーの TLS 証明書の詳細を表示します。 ``` aws lightsail get-load-balancer-tls-certificates \ --load-balancer-name LoadBalancer-1 ``` 出力: ``` { "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" ] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetLoadBalancerTlsCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-load-balancer-tls-certificates.html)」を参照してください。 ### `get-load-balancer` 次のコード例は、`get-load-balancer` を使用する方法を示しています。 **AWS CLI** **ロードバランサーに関する情報を取得するには** 次の `get-load-balancer` の例では、指定されたロードバランサーの詳細を表示します。 ``` aws lightsail get-load-balancer \ --load-balancer-name LoadBalancer-1 ``` 出力: ``` { "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" } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetLoadBalancer](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-load-balancer.html)」を参照してください。 ### `get-load-balancers` 次のコード例は、`get-load-balancers` を使用する方法を示しています。 **AWS CLI** **すべてのロードバランサーに関する情報を取得するには** 次の `get-load-balancers` の例では、設定された AWS リージョン内のすべてのロードバランサーの詳細を表示します。 ``` aws lightsail get-load-balancers ``` 出力: ``` { "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" } } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetLoadBalancers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-load-balancers.html)」を参照してください。 ### `get-operation` 次のコード例は、`get-operation` を使用する方法を示しています。 **AWS CLI** **単一のオペレーションに関する情報を取得するには** 次の `get-operation` の例では、指定されたオペレーションの詳細を表示します。 ``` aws lightsail get-operation \ --operation-id e5700e8a-daf2-4b49-bc01-3EXAMPLE910a ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetOperation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-operation.html)」を参照してください。 ### `get-operations-for-resource` 次のコード例は、`get-operations-for-resource` を使用する方法を示しています。 **AWS CLI** **リソースのすべてのオペレーションを取得するには** 次の `get-operations-for-resource` の例では、指定されたリソースのすべてのオペレーションの詳細を表示します。 ``` aws lightsail get-operations-for-resource \ --resource-name LoadBalancer-1 ``` 出力: ``` { "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 }, ... } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetOperationsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-operations-for-resource.html)」を参照してください。 ### `get-operations` 次のコード例は、`get-operations` を使用する方法を示しています。 **AWS CLI** **すべてのオペレーションに関する情報を取得するには** 次の `get-operations` の例では、設定された AWS リージョン内のすべてのオペレーションの詳細を表示します。 ``` aws lightsail get-operations ``` 出力: ``` { "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 }, ... } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetOperations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-operations.html)」を参照してください。 ### `get-regions` 次のコード例は、`get-regions` を使用する方法を示しています。 **AWS CLI** **Amazon Lightsail のすべての AWS リージョンを取得するには** 次の `get-regions` の例では、Amazon Lightsail のすべての AWS リージョンの詳細を表示します。 ``` aws lightsail get-regions ``` 出力: ``` { "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": [] }, ... } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRegions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-regions.html)」を参照してください。 ### `get-relational-database-blueprints` 次のコード例は、`get-relational-database-blueprints` を使用する方法を示しています。 **AWS CLI** **新しいリレーショナルデータベースのブループリントを取得するには** 次の `get-relational-database-blueprints` の例では、Amazon Lightsail で新しいリレーショナルデータベースを作成するために使用できる、すべての使用可能なリレーショナルデータベースブループリントの詳細を表示します。 ``` aws lightsail get-relational-database-blueprints ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRelationalDatabaseBlueprints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-relational-database-blueprints.html)」を参照してください。 ### `get-relational-database-bundles` 次のコード例は、`get-relational-database-bundles` を使用する方法を示しています。 **AWS CLI** **新しいリレーショナルデータベースのバンドルを取得するには** 次の `get-relational-database-bundles` の例では、Amazon Lightsail で新しいリレーショナルデータベースを作成するために使用できる、すべての使用可能なリレーショナルデータベースバンドルの詳細を表示します。コマンドで `--include-inactive` フラグが指定されていないため、レスポンスには非アクティブなバンドルが含まれていないことに注意してください。非アクティブなバンドルを使用して新しいリレーショナルデータベースを作成することはできません。 ``` aws lightsail get-relational-database-bundles ``` 出力: ``` { "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 } ] } ``` 詳細については、「*Amazon Lightsail Developer Guide*」の「[Creating a database in Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-creating-a-database)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRelationalDatabaseBundles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-relational-database-bundles.html)」を参照してください。 ### `get-relational-database-events` 次のコード例は、`get-relational-database-events` を使用する方法を示しています。 **AWS CLI** **リレーショナルデータベースのイベントを取得するには** 次の `get-relational-database-events` の例では、指定されたリレーショナルデータベースの過去 17 時間 (1020 分) のイベントの詳細を表示します。 ``` aws lightsail get-relational-database-events \ --relational-database-name Database-1 \ --duration-in-minutes 1020 ``` 出力: ``` { "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" ] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRelationalDatabaseEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-relational-database-events.html)」を参照してください。 ### `get-relational-database-log-events` 次のコード例は、`get-relational-database-log-events` を使用する方法を示しています。 **AWS CLI** **リレーショナルデータベースのログイベントを取得するには** 次の `get-relational-database-log-events` の例では、リレーショナルデータベース `Database1` の `1570733176` と `1571597176` の間の指定されたログの詳細を表示します。返される情報は、`head` から開始するように設定されています。 Unix タイムコンバーターを使用して、開始時刻と終了時刻を特定することをお勧めします。 ``` aws lightsail get-relational-database-log-events \ --relational-database-name Database1 \ --log-stream-name error \ --start-from-head \ --start-time 1570733176 \ --end-time 1571597176 ``` 出力: ``` { "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==" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRelationalDatabaseLogEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-relational-database-log-events.html)」を参照してください。 ### `get-relational-database-log-streams` 次のコード例は、`get-relational-database-log-streams` を使用する方法を示しています。 **AWS CLI** **リレーショナルデータベースのログストリームを取得するには** 次の `get-relational-database-log-streams` の例では、指定されたリレーショナルデータベースで使用できるすべてのログストリームを返します。 ``` aws lightsail get-relational-database-log-streams \ --relational-database-name Database1 ``` 出力: ``` { "logStreams": [ "audit", "error", "general", "slowquery" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRelationalDatabaseLogStreams](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-relational-database-log-streams.html)」を参照してください。 ### `get-relational-database-master-user-password` 次のコード例は、`get-relational-database-master-user-password` を使用する方法を示しています。 **AWS CLI** **リレーショナルデータベースのマスターユーザーパスワードを取得するには** 次の `get-relational-database-master-user-password` の例では、指定されたリレーショナルデータベースのマスターユーザーパスワードに関する情報を返します。 ``` aws lightsail get-relational-database-master-user-password \ --relational-database-name Database-1 ``` 出力: ``` { "masterUserPassword": "VEXAMPLEec.9qvx,_t<)Wkf)kwboM,>2", "createdAt": 1571259453.959 } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRelationalDatabaseMasterUserPassword](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-relational-database-master-user-password.html)」を参照してください。 ### `get-relational-database-metric-data` 次のコード例は、`get-relational-database-metric-data` を使用する方法を示しています。 **AWS CLI** **リレーショナルデータベースのメトリクスデータを取得するには** 次の `get-relational-database-metric-data` の例では、リレーショナルデータベース `Database1` の `1570733176` と `1571597176` の間の 24 時間 (`86400` 秒) にわたるメトリクス `DatabaseConnections` のカウント合計を返します。 Unix タイムコンバーターを使用して、開始時刻と終了時刻を特定することをお勧めします。 ``` 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 ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRelationalDatabaseMetricData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-relational-database-metric-data.html)」を参照してください。 ### `get-relational-database-parameters` 次のコード例は、`get-relational-database-parameters` を使用する方法を示しています。 **AWS CLI** **リレーショナルデータベースのパラメータを取得するには** 次の `get-relational-database-parameters` の例では、指定されたリレーショナルデータベースで使用可能なすべてのパラメータに関する情報を返します。 ``` aws lightsail get-relational-database-parameters \ --relational-database-name Database-1 ``` 出力: ``` { "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" }, ... } ] } ``` 詳細については、「*Lightsail Dev Guide*」の「[Updating database parameters in Amazon Lightsail](https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-updating-database-parameters)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRelationalDatabaseParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-relational-database-parameters.html)」を参照してください。 ### `get-relational-database-snapshot` 次のコード例は、`get-relational-database-snapshot` を使用する方法を示しています。 **AWS CLI** **リレーショナルデータベースのスナップショットに関する情報を取得するには** 次の `get-relational-database-snapshot` の例では、指定されたリレーショナルデータベーススナップショットの詳細を表示します。 ``` aws lightsail get-relational-database-snapshot \ --relational-database-snapshot-name Database-1-1571350042 ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRelationalDatabaseSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-relational-database-snapshot.html)」を参照してください。 ### `get-relational-database-snapshots` 次のコード例は、`get-relational-database-snapshots` を使用する方法を示しています。 **AWS CLI** **すべてのリレーショナルデータベースのスナップショットに関する情報を取得するには** 次の `get-relational-database-snapshots` の例では、設定された AWS リージョン内のすべてのリレーショナルデータベーススナップショットの詳細を表示します。 ``` aws lightsail get-relational-database-snapshots ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRelationalDatabaseSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-relational-database-snapshots.html)」を参照してください。 ### `get-relational-database` 次のコード例は、`get-relational-database` を使用する方法を示しています。 **AWS CLI** **リレーショナルデータベースに関する情報を取得するには** 次の `get-relational-database` の例では、指定されたリレーショナルデータベースの詳細を表示します。 ``` aws lightsail get-relational-database \ --relational-database-name Database-1 ``` 出力: ``` { "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": [] } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRelationalDatabase](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-relational-database.html)」を参照してください。 ### `get-relational-databases` 次のコード例は、`get-relational-databases` を使用する方法を示しています。 **AWS CLI** **すべてのリレーショナルデータベースに関する情報を取得するには** 次の `get-relational-databases` の例では、設定された AWS リージョン内のすべてのリレーショナルデータベースの詳細を表示します。 ``` aws lightsail get-relational-databases ``` 出力: ``` { "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": [] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetRelationalDatabases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-relational-databases.html)」を参照してください。 ### `get-static-ip` 次のコード例は、`get-static-ip` を使用する方法を示しています。 **AWS CLI** **静的 IP に関する情報を取得するには** 次の `get-static-ip` の例では、指定された静的 IP の詳細を表示します。 ``` aws lightsail get-static-ip \ --static-ip-name StaticIp-1 ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetStaticIp](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-static-ip.html)」を参照してください。 ### `get-static-ips` 次のコード例は、`get-static-ips` を使用する方法を示しています。 **AWS CLI** **すべての静的 IP に関する情報を取得するには** 次の `get-static-ips` の例では、設定された AWS リージョン内のすべての静的 IP の詳細を表示します。 ``` aws lightsail get-static-ips ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetStaticIps](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/get-static-ips.html)」を参照してください。 ### `is-vpc-peered` 次のコード例は、`is-vpc-peered` を使用する方法を示しています。 **AWS CLI** **Amazon Lightsail 仮想プライベートクラウドがピアリングされているかどうかを確認するには** 次の `is-vpc-peered` の例では、指定した AWS リージョンの Amazon Lightsail 仮想プライベートクラウド (VPC) のピアリングステータスを返します。 ``` aws lightsail is-vpc-peered \ --region us-west-2 ``` 出力: ``` { "isPeered": true } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[IsVpcPeered](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/is-vpc-peered.html)」を参照してください。 ### `open-instance-public-ports` 次のコード例は、`open-instance-public-ports` を使用する方法を示しています。 **AWS CLI** **インスタンスのファイアウォールポートを開くには** 次の `open-instance-public-ports` の例では、指定されたインスタンスで TCP ポート 22 を開きます。 ``` aws lightsail open-instance-public-ports \ --instance-name MEAN-2 \ --port-info fromPort=22,protocol=TCP,toPort=22 ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[OpenInstancePublicPorts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/open-instance-public-ports.html)」を参照してください。 ### `peer-vpc` 次のコード例は、`peer-vpc` を使用する方法を示しています。 **AWS CLI** **Amazon Lightsail 仮想プライベートクラウドをピアリングするには** 次の `peer-vpc` の例では、指定した AWS リージョンの Amazon Lightsail 仮想プライベートクラウド (VPC) をピアリングします。 ``` aws lightsail peer-vpc \ --region us-west-2 ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PeerVpc](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/peer-vpc.html)」を参照してください。 ### `reboot-instance` 次のコード例は、`reboot-instance` を使用する方法を示しています。 **AWS CLI** **インスタンスを再起動するには** 次の `reboot-instance` の例では、指定されたインスタンスを再起動します。 ``` aws lightsail reboot-instance \ --instance-name MEAN-1 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RebootInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/reboot-instance.html)」を参照してください。 ### `reboot-relational-database` 次のコード例は、`reboot-relational-database` を使用する方法を示しています。 **AWS CLI** **リレーショナルデータベースを再起動するには** 次の `reboot-relational-database` の例では、指定されたリレーショナルデータベースを再起動します。 ``` aws lightsail reboot-relational-database \ --relational-database-name Database-1 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RebootRelationalDatabase](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/reboot-relational-database.html)」を参照してください。 ### `release-static-ip` 次のコード例は、`release-static-ip` を使用する方法を示しています。 **AWS CLI** **静的 IP を削除するには** 次の `release-static-ip` の例では、指定された静的 IP を削除します。 ``` aws lightsail release-static-ip \ --static-ip-name StaticIp-1 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ReleaseStaticIp](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/release-static-ip.html)」を参照してください。 ### `start-instance` 次のコード例は、`start-instance` を使用する方法を示しています。 **AWS CLI** **インスタンスを開始するには** 次の `start-instance` の例では、指定されたインスタンスを起動します。 ``` aws lightsail start-instance \ --instance-name WordPress-1 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/start-instance.html)」を参照してください。 ### `start-relational-database` 次のコード例は、`start-relational-database` を使用する方法を示しています。 **AWS CLI** **リレーショナルデータベースを開始するには** 次の `start-relational-database` の例では、指定されたリレーショナルデータベースを開始します。 ``` aws lightsail start-relational-database \ --relational-database-name Database-1 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartRelationalDatabase](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/start-relational-database.html)」を参照してください。 ### `stop-instance` 次のコード例は、`stop-instance` を使用する方法を示しています。 **AWS CLI** **インスタンスを停止するには** 次の `stop-instance` の例では、指定されたインスタンスを停止します。 ``` aws lightsail stop-instance \ --instance-name WordPress-1 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/stop-instance.html)」を参照してください。 ### `stop-relational-database` 次のコード例は、`stop-relational-database` を使用する方法を示しています。 **AWS CLI** **リレーショナルデータベースを停止するには** 次の `stop-relational-database` の例では、指定されたリレーショナルデータベースを停止します。 ``` aws lightsail stop-relational-database \ --relational-database-name Database-1 ``` 出力: ``` { "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 } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopRelationalDatabase](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/stop-relational-database.html)」を参照してください。 ### `unpeer-vpc` 次のコード例は、`unpeer-vpc` を使用する方法を示しています。 **AWS CLI** **Amazon Lightsail 仮想プライベートクラウドをピアリングするには** 次の `unpeer-vpc` の例では、指定した AWS リージョンの Amazon Lightsail 仮想プライベートクラウド (VPC) のピアリングを解除します。 ``` aws lightsail unpeer-vpc \ --region us-west-2 ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UnpeerVpc](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/lightsail/unpeer-vpc.html)」を参照してください。 # AWS CLI を使用した Macie の例 次のコード例は、Macie で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `describe-buckets` 次のコード例は、`describe-buckets` を使用する方法を示しています。 **AWS CLI** **Amazon Macie がアカウントのモニタリングおよび分析を行う 1 つ以上の S3 バケットに関するデータのクエリを実行するには** 次の `describe-buckets` の例では、名前が amzn-s3-demo-bucket で始まり、現在の AWS リージョンにあるすべての S3 バケットのメタデータのクエリを実行します。 ``` aws macie2 describe-buckets \ --criteria '{"bucketName":{"prefix":"amzn-s3-demo-bucket"}}' ``` 出力: ``` { "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 } ] } ``` 詳細については、「*Amazon Macie User Guide*」の「[Filtering your S3 bucket inventory](https://docs.aws.amazon.com/macie/latest/user/monitoring-s3-inventory-filter.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeBuckets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/macie2/describe-buckets.html)」を参照してください。 # AWS CLI を使用した Amazon Managed Grafana の例 次のコード例は、Amazon Managed Grafana で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `list-workspaces` 次のコード例は、`list-workspaces` を使用する方法を示しています。 **AWS CLI** **ユーザー認証情報で指定されたリージョン内のアカウントのワークスペースを一覧表示するには** 次の `list-workspaces` の例では、アカウントのリージョンの Grafana ワークスペースを一覧表示します。 ``` aws grafana list-workspaces ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListWorkspaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/grafana/list-workspaces.html)」を参照してください。 # AWS CLI を使用した MediaConnect の例 次のコード例は、MediaConnect で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `add-flow-outputs` 次のコード例は、`add-flow-outputs` を使用する方法を示しています。 **AWS CLI** **出力をフローに追加するには** 次の `add-flow-outputs` の例では、指定されたフローに出力を追加します。 ``` 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 ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Elemental MediaConnect User Guide*」の「[Adding Outputs to a Flow](https://docs.aws.amazon.com/mediaconnect/latest/ug/outputs-add.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddFlowOutputs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/add-flow-outputs.html)」を参照してください。 ### `create-flow` 次のコード例は、`create-flow` を使用する方法を示しています。 **AWS CLI** **フローを作成するには** 次の `create-flow` の例では、指定された設定でフローを作成します。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Elemental MediaConnect User Guide*」の「[Creating a Flow](https://docs.aws.amazon.com/mediaconnect/latest/ug/flows-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateFlow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/create-flow.html)」を参照してください。 ### `delete-flow` 次のコード例は、`delete-flow` を使用する方法を示しています。 **AWS CLI** **フローを削除するには** 次の `delete-flow` の例では、指定されたフローを削除します。 ``` aws mediaconnect delete-flow \ --flow-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow ``` 出力: ``` { "FlowArn": "arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow", "Status": "DELETING" } ``` 詳細については、「*AWS Elemental MediaConnect User Guide*」の「[Deleting a Flow](https://docs.aws.amazon.com/mediaconnect/latest/ug/flows-delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteFlow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/delete-flow.html)」を参照してください。 ### `describe-flow` 次のコード例は、`describe-flow` を使用する方法を示しています。 **AWS CLI** **フローの詳細を表示するには** 次の `describe-flow` の例では、ARN、アベイラビリティーゾーン、ステータス、ソース、権限、出力など、指定されたフローの詳細を表示します。 ``` aws mediaconnect describe-flow \ --flow-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow ``` 出力: ``` { "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" } } } ``` 詳細については、「*AWS Elemental MediaConnect User Guide*」の「[Viewing the Details of a Flow](https://docs.aws.amazon.com/mediaconnect/latest/ug/flows-view-details.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeFlow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/describe-flow.html)」を参照してください。 ### `grant-flow-entitlements` 次のコード例は、`grant-flow-entitlements` を使用する方法を示しています。 **AWS CLI** **フローに権限を付与するには** 次の `grant-flow-entitlements` の例では、指定された既存のフローに、コンテンツを別の 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 ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Elemental MediaConnect User Guide*」の「[Granting an Entitlement on a Flow](https://docs.aws.amazon.com/mediaconnect/latest/ug/entitlements-grant.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GrantFlowEntitlements](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/grant-flow-entitlements.html)」を参照してください。 ### `list-entitlements` 次のコード例は、`list-entitlements` を使用する方法を示しています。 **AWS CLI** **権限のリストを表示するには** 次の `list-entitlements` の例では、アカウントに付与されたすべての権限のリストを表示します。 ``` aws mediaconnect list-entitlements ``` 出力: ``` { "Entitlements": [ { "EntitlementArn": "arn:aws:mediaconnect:us-west-2:111122223333:entitlement:1-11aa22bb11aa22bb-3333cccc4444:MyEntitlement", "EntitlementName": "MyEntitlement" } ] } ``` 詳細については、「*AWS Elemental MediaConnect API Reference*」の「[ListEntitlements](https://docs.aws.amazon.com/mediaconnect/latest/api/v1-entitlements.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListEntitlements](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/list-entitlements.html)」を参照してください。 ### `list-flows` 次のコード例は、`list-flows` を使用する方法を示しています。 **AWS CLI** **フローのリストを表示するには** 次の `list-flows` の例では、フローのリストを表示します。 ``` aws mediaconnect list-flows ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS Elemental MediaConnect User Guide*」の「[Viewing a List of Flows](https://docs.aws.amazon.com/mediaconnect/latest/ug/flows-view-list.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListFlows](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/list-flows.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **MediaConnect リソースのタグを一覧表示するには** 次の `list-tags-for-resource` の例では、指定された MediaConnect に関連付けられたタグキーと値を表示します。 ``` aws mediaconnect list-tags-for-resource \ --resource-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BasketballGame ``` 出力: ``` { "Tags": { "region": "west", "stage": "prod" } } ``` 詳細については、「*AWS Elemental MediaConnect API Reference*」の「[ListTagsForResource, TagResource, UntagResource](https://docs.aws.amazon.com/mediaconnect/latest/api/tags-resourcearn.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/list-tags-for-resource.html)」を参照してください。 ### `remove-flow-output` 次のコード例は、`remove-flow-output` を使用する方法を示しています。 **AWS CLI** **フローから出力を削除するには** 次の `remove-flow-output` の例では、指定されたフローから出力を削除します。 ``` 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 ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Elemental MediaConnect User Guide*」の「[Removing Outputs from a Flow](https://docs.aws.amazon.com/mediaconnect/latest/ug/outputs-remove.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveFlowOutput](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/remove-flow-output.html)」を参照してください。 ### `revoke-flow-entitlement` 次のコード例は、`revoke-flow-entitlement` を使用する方法を示しています。 **AWS CLI** **権限を取り消すには** 次の `revoke-flow-entitlement` の例では、指定されたフローの権限を取り消します。 ``` 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 ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Elemental MediaConnect User Guide*」の「[Revoking an Entitlement](https://docs.aws.amazon.com/mediaconnect/latest/ug/entitlements-revoke.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RevokeFlowEntitlement](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/revoke-flow-entitlement.html)」を参照してください。 ### `start-flow` 次のコード例は、`start-flow` を使用する方法を示しています。 **AWS CLI** **フローを開始するには** 次の `start-flow` の例では、指定されたフローを起動します。 ``` aws mediaconnect start-flow \ --flow-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow ``` このコマンドは何も出力しません。出力: ``` { "FlowArn": "arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow", "Status": "STARTING" } ``` 詳細については、「*AWS Elemental MediaConnect User Guide*」の「[Starting a Flow](https://docs.aws.amazon.com/mediaconnect/latest/ug/flows-start.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartFlow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/start-flow.html)」を参照してください。 ### `stop-flow` 次のコード例は、`stop-flow` を使用する方法を示しています。 **AWS CLI** **フローを停止するには** 次の `stop-flow` の例では、指定されたフローを停止します。 ``` aws mediaconnect stop-flow \ --flow-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow ``` 出力: ``` { "Status": "STOPPING", "FlowArn": "arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow" } ``` 詳細については、「*AWS Elemental MediaConnect User Guide*」の「[Stopping a Flow](https://docs.aws.amazon.com/mediaconnect/latest/ug/flows-stop.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopFlow](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/stop-flow.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **MediaConnect リソースにタグを追加するには** 次の `tag-resource` の例では、指定された MediaConnect リソースにキー名と値を持つタグを追加します。 ``` aws mediaconnect tag-resource \ --resource-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BasketballGame --tags region=west ``` このコマンドは何も出力しません。 詳細については、「*AWS Elemental MediaConnect API Reference*」の「[ListTagsForResource, TagResource, UntagResource](https://docs.aws.amazon.com/mediaconnect/latest/api/tags-resourcearn.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **MediaConnect リソースからタグを削除するには** 次の `untag-resource` の例では、MediaConnect リソースから、指定されたキー名と関連付けられた値のタグを削除します。 ``` aws mediaconnect untag-resource \ --resource-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BasketballGame \ --tag-keys region ``` このコマンドは何も出力しません。 詳細については、「*AWS Elemental MediaConnect API Reference*」の「[ListTagsForResource, TagResource, UntagResource](https://docs.aws.amazon.com/mediaconnect/latest/api/tags-resourcearn.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/untag-resource.html)」を参照してください。 ### `update-flow-entitlement` 次のコード例は、`update-flow-entitlement` を使用する方法を示しています。 **AWS CLI** **権限を更新するには** 次の `update-flow-entitlement` の例では、指定された権限を新しい説明とサブスクライバーで更新します。 ``` 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 ``` 出力: ``` { "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" ] } } ``` 詳細については、「*AWS Elemental MediaConnect User Guide*」の「[Updating an Entitlement](https://docs.aws.amazon.com/mediaconnect/latest/ug/entitlements-update.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateFlowEntitlement](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/update-flow-entitlement.html)」を参照してください。 ### `update-flow-output` 次のコード例は、`update-flow-output` を使用する方法を示しています。 **AWS CLI** **フローの出力を更新するには** 次の `update-flow-output` の例では、指定されたフローの出力を更新します。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Elemental MediaConnect User Guide*」の「[Updating Outputs on a Flow](https://docs.aws.amazon.com/mediaconnect/latest/ug/outputs-update.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateFlowOutput](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/update-flow-output.html)」を参照してください。 ### `update-flow-source` 次のコード例は、`update-flow-source` を使用する方法を示しています。 **AWS CLI** **既存のフローのソースを更新するには** 次の `update-flow-source` の例では、既存のフローのソースを更新します。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Elemental MediaConnect User Guide*」の「[Updating the Source of a Flow](https://docs.aws.amazon.com/mediaconnect/latest/ug/source-update.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateFlowSource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconnect/update-flow-source.html)」を参照してください。 # AWS CLI を使用する MediaConvertの例 次のコード例は、MediaConvert で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `cancel-job` 次のコード例は、`cancel-job` を使用する方法を示しています。 **AWS CLI** **キューにあるジョブをキャンセルするには** 次の `cancel-job` の例では、ID `1234567891234-abc123` のジョブをキャンセルします。サービスが処理を開始したジョブはキャンセルできません。 ``` aws mediaconvert cancel-job \ --endpoint-url https://abcd1234.mediaconvert.region-name-1.amazonaws.com \ --region region-name-1 \ --id 1234567891234-abc123 ``` アカウント固有のエンドポイントを取得するには、`describe-endpoints` を使用するか、エンドポイントを指定せずにコマンドを送信します。このサービスは、エラーとエンドポイントを返します。 詳細については、「AWS Elemental MediaConvert ユーザーガイド」の「[AWS Elemental MediaConvert ジョブの使用](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-jobs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/cancel-job.html)」を参照してください。 ### `create-job-template` 次のコード例は、`create-job-template` を使用する方法を示しています。 **AWS CLI** **ジョブテンプレートを作成するには** 次の `create-job-template` の例では、システムにあるファイル `job-template.json` に指定されているトランスコーディング設定を使用してジョブテンプレートを作成します。 ``` 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 ``` `get-job-template` を使用してジョブテンプレートの JSON ファイルを作成し、ファイルを変更した場合、`JobTemplate` オブジェクトを削除しますが、設定の子オブジェクトはその中に保持します。また、`LastUpdated`、`Arn`、`Type`、および `CreatedAt` のキーと値のペアも必ず削除してください。カテゴリ、説明、名前、およびキューは、JSON ファイルまたはコマンドラインで指定できます。 アカウント固有のエンドポイントを取得するには、`describe-endpoints` を使用するか、エンドポイントを指定せずにコマンドを送信します。このサービスは、エラーとエンドポイントを返します。 リクエストが正常に処理されると、サービスは作成したジョブテンプレートの JSON 仕様を返します。 詳細については、「*AWS Elemental MediaConvert User Guide*」の「[Working with AWS Elemental MediaConvert Job Templates](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-job-templates.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateJobTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/create-job-template.html)」を参照してください。 ### `create-job` 次のコード例は、`create-job` を使用する方法を示しています。 **AWS CLI** **ジョブを作成するには** 次の `create-job` の例では、コマンドの送信元となるシステム上のファイル `job.json` に指定されている設定を使用してトランスコーディングジョブを作成します。この JSON ジョブ仕様では、各設定を個別に指定したり、ジョブテンプレートを参照したり、出力プリセットを参照したりできます。 ``` aws mediaconvert create-job \ --endpoint-url https://abcd1234.mediaconvert.region-name-1.amazonaws.com \ --region region-name-1 \ --cli-input-json file://~/job.json ``` AWS Elemental MediaConvert コンソールを使用して JSON ジョブ仕様を生成できます。これを行うには、ジョブ設定を選択し、**[ジョブ]** セクションの下部にある **[ジョブの JSON を表示]** を選択します。 アカウント固有のエンドポイントを取得するには、`describe-endpoints` を使用するか、エンドポイントを指定せずにコマンドを送信します。このサービスは、エラーとエンドポイントを返します。 リクエストが正常に処理されると、サービスはリクエストとともに送信した JSON ジョブ仕様を返します。 詳細については、「AWS Elemental MediaConvert ユーザーガイド」の「[AWS Elemental MediaConvert ジョブの使用](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-jobs.html)」を参照してください。 + API の詳細については、「AWS CLI Command Reference」の「[CreateJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/create-job.html)」を参照してください。** ### `create-preset` 次のコード例は、`create-preset` を使用する方法を示しています。 **AWS CLI** **カスタム出力プリセットを作成するには** 次の `create-preset` の例では、ファイル `preset.json` で指定された出力設定に基づいてカスタム出力プリセットを作成します。カテゴリ、説明、および名前は、JSON ファイルまたはコマンドラインで指定できます。 ``` aws mediaconvert create-preset \ --endpoint-url https://abcd1234.mediaconvert.region-name-1.amazonaws.com --region region-name-1 \ --cli-input-json file://~/preset.json ``` `get-preset` を使用してプリセット JSON ファイルを作成し、出力ファイルを変更する場合は、`LastUpdated`、`Arn`、`Type` および `CreatedAt` のキーと値のペアを必ず削除してください。 アカウント固有のエンドポイントを取得するには、`describe-endpoints` を使用するか、エンドポイントを指定せずにコマンドを送信します。このサービスは、エラーとエンドポイントを返します。 詳細については、「*AWS Elemental MediaConvert User Guide*」の「[Working with AWS Elemental MediaConvert Output Presets](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-presets.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreatePreset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/create-preset.html)」を参照してください。 ### `create-queue` 次のコード例は、`create-queue` を使用する方法を示しています。 **AWS CLI** **カスタムキューを作成するには** 次の `create-queue` の例では、カスタムトランスコーディングキューを作成します。 ``` 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." ``` アカウント固有のエンドポイントを取得するには、`describe-endpoints` を使用するか、エンドポイントを指定せずにコマンドを送信します。このサービスは、エラーとエンドポイントを返します。 出力: ``` { "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." } } ``` 詳細については、「*AWS Elemental MediaConvert User Guide*」の「[Working with AWS Elemental MediaConvert Queues](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[CreateQueue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/create-queue.html)」を参照してください。** ### `delete-job-template` 次のコード例は、`delete-job-template` を使用する方法を示しています。 **AWS CLI** **ジョブテンプレートを削除するには** 次の `delete-job-template` の例では、指定されたカスタムジョブテンプレートを削除します。 ``` aws mediaconvert delete-job-template \ --name "DASH Streaming" \ --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com ``` このコマンドは何も出力しません。`aws mediaconvert list-job-templates` を実行して、テンプレートが削除されたことを確認します。 詳細については、「*AWS Elemental MediaConvert User Guide*」の「[Working with AWS Elemental MediaConvert Job Templates](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-job-templates.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteJobTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/delete-job-template.html)」を参照してください。 ### `delete-preset` 次のコード例は、`delete-preset` を使用する方法を示しています。 **AWS CLI** **カスタムオンデマンドキューを削除するには** 次の `delete-preset` の例では、指定されたカスタムプリセットを削除します。 ``` aws mediaconvert delete-preset \ --name SimpleMP4 \ --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com ``` このコマンドは何も出力しません。`aws mediaconvert list-presets` を実行して、プリセットが削除されたことを確認します。 詳細については、「*AWS Elemental MediaConvert User Guide*」の「[Working with AWS Elemental MediaConvert Output Presets](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-presets.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeletePreset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/delete-preset.html)」を参照してください。 ### `delete-queue` 次のコード例は、`delete-queue` を使用する方法を示しています。 **AWS CLI** **カスタムオンデマンドキューを削除するには** 次の `delete-queue` の例では、指定されたカスタムオンデマンドキューを削除します。 デフォルトのキューを削除することはできません。有効な料金プランがある、または未処理のジョブを含む予約済みのキューを削除することはできません。 ``` aws mediaconvert delete-queue \ --name Customer1 \ --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com ``` このコマンドは何も出力しません。`aws mediaconvert list-queues` を実行して、キューが削除されたことを確認します。 詳細については、「*AWS Elemental MediaConvert User Guide*」の「[Working with AWS Elemental MediaConvert Queues](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンス**の「[DeleteQueue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/delete-queue.html)」を参照してください。 ### `describe-endpoints` 次のコード例は、`describe-endpoints` を使用する方法を示しています。 **AWS CLI** **アカウント固有のエンドポイントを取得するには** 次の `describe-endpoints` の例では、他のリクエストをサービスに送信する必要があるエンドポイントを取得します。 ``` aws mediaconvert describe-endpoints ``` 出力: ``` { "Endpoints": [ { "Url": "https://abcd1234.mediaconvert.region-name-1.amazonaws.com" } ] } ``` 詳細については、「*AWS Elemental MediaConvert API Reference*」の「[Getting Started with MediaConvert Using the API](https://docs.aws.amazon.com/mediaconvert/latest/apireference/getting-started.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/describe-endpoints.html)」を参照してください。 ### `get-job-template` 次のコード例は、`get-job-template` を使用する方法を示しています。 **AWS CLI** **ジョブテンプレートの詳細を取得するには** 次の `get-job-template` の例では、指定されたカスタムジョブテンプレートの JSON 定義を表示します。 ``` aws mediaconvert get-job-template \ --name "DASH Streaming" \ --endpoint-url https://abcd1234.mediaconvert.us-east-1.amazonaws.com ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Elemental MediaConvert User Guide*」の「[Working with AWS Elemental MediaConvert Job Templates](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-job-templates.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetJobTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/get-job-template.html)」を参照してください。 ### `get-job` 次のコード例は、`get-job` を使用する方法を示しています。 **AWS CLI** **特定のジョブの詳細を取得するには** 次の例は、ID `1234567890987-1ab2c3` のジョブの情報をリクエストしていますが、エラーで終了します。 ``` aws mediaconvert get-job \ --endpoint-url https://abcd1234.mediaconvert.region-name-1.amazonaws.com \ --region region-name-1 \ --id 1234567890987-1ab2c3 ``` アカウント固有のエンドポイントを取得するには、`describe-endpoints` を使用するか、エンドポイントを指定せずにコマンドを送信します。このサービスは、エラーとエンドポイントを返します。 リクエストが正常に処理されると、サービスは次のようなジョブ設定、返されたエラー、その他のジョブデータなどのジョブ情報を含む JSON ファイルを返します。 ``` { "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 } } ``` 詳細については、「AWS Elemental MediaConvert ユーザーガイド」の「[AWS Elemental MediaConvert ジョブの使用](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-jobs.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス* の「[GetJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/get-job.html)」を参照してください。 ### `get-preset` 次のコード例は、`get-preset` を使用する方法を示しています。 **AWS CLI** **特定のプリセットの詳細を取得するには** 次の `get-preset` の例では、指定されたカスタムプリセットの JSON 定義をリクエストします。 ``` aws mediaconvert get-preset \ --name SimpleMP4 \ --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com ``` 出力: ``` { "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 } } ``` 詳細については、「*AWS Elemental MediaConvert User Guide*」の「[Working with AWS Elemental MediaConvert Output Presets](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-presets.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPreset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/get-preset.html)」を参照してください。 ### `get-queue` 次のコード例は、`get-queue` を使用する方法を示しています。 **AWS CLI** **キューの詳細を取得するには** 次の `get-queue` の例では、指定されたカスタムキューの詳細を取得します。 ``` aws mediaconvert get-queue \ --name Customer1 \ --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Elemental MediaConvert User Guide*」の「[Working with AWS Elemental MediaConvert Queues](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetQueue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/get-queue.html)」を参照してください。 ### `list-job-templates` 次のコード例は、`list-job-templates` を使用する方法を示しています。 **AWS CLI** **例 1: カスタムジョブテンプレートを一覧表示するには** 次の `list-job-templates` の例では、現在のリージョンのすべてのカスタムジョブテンプレートを一覧表示します。システムジョブテンプレートを一覧表示するには、次の例を参照してください。 ``` aws mediaconvert list-job-templates \ --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com ``` 出力: ``` { "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 } ] } ``` **例 2: MediaConvert システムジョブテンプレートを一覧表示するには** 次の `list-job-templates` の例では、すべてのシステムジョブテンプレートを一覧表示します。 ``` aws mediaconvert list-job-templates \ --endpoint-url https://abcd1234.mediaconvert.us-east-1.amazonaws.com \ --list-by SYSTEM ``` 出力: ``` { "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 }, ...... ] } ``` 詳細については、「*AWS Elemental MediaConvert User Guide*」の「[Working with AWS Elemental MediaConvert Job Templates](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-job-templates.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListJobTemplates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/list-job-templates.html)」を参照してください。 ### `list-jobs` 次のコード例は、`list-jobs` を使用する方法を示しています。 **AWS CLI** **リージョン内のすべてのジョブの詳細を取得するには** 次の例は、指定されたリージョンのすべてのジョブの情報をリクエストします。 ``` aws mediaconvert list-jobs \ --endpoint-url https://abcd1234.mediaconvert.region-name-1.amazonaws.com \ --region region-name-1 ``` アカウント固有のエンドポイントを取得するには、`describe-endpoints` を使用するか、エンドポイントを指定せずにコマンドを送信します。このサービスは、エラーとエンドポイントを返します。 詳細については、「AWS Elemental MediaConvert ユーザーガイド」の「[AWS Elemental MediaConvert ジョブの使用](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-jobs.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/list-jobs.html)」を参照してください。 ### `list-presets` 次のコード例は、`list-presets` を使用する方法を示しています。 **AWS CLI** **例 1: カスタム出力プリセットを一覧表示するには** 次の `list-presets` の例では、カスタム出力プリセットを一覧表示します。システムプリセットを一覧表示するには、次の例を参照してください。 ``` aws mediaconvert list-presets \ --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com ``` 出力: ``` { "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." } ] } ``` **例 2: システム出力プリセットを一覧表示するには** 次の `list-presets` の例では、使用可能な MediaConvert システムプリセットを一覧表示します。カスタムプリセットを一覧表示するには、前の例を参照してください。 ``` aws mediaconvert list-presets \ --list-by SYSTEM \ --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com ``` 出力: ``` { "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": { ...... } } ] } ``` 詳細については、「*AWS Elemental MediaConvert User Guide*」の「[Working with AWS Elemental MediaConvert Output Presets](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-presets.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPresets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/list-presets.html)」を参照してください。 ### `list-queues` 次のコード例は、`list-queues` を使用する方法を示しています。 **AWS CLI** **キューを一覧表示するには** 次の `list-queues` の例では、すべての MediaConvert キューを一覧表示します。 ``` aws mediaconvert list-queues \ --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com ``` 出力: ``` { "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 } ] } ``` 詳細については、「*AWS Elemental MediaConvert User Guide*」の「[Working with AWS Elemental MediaConvert Queues](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[ListQueues](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/list-queues.html)」を参照してください。** ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **MediaConvert キュー、ジョブテンプレート、または出力プリセットのタグを一覧表示するには** 次の `list-tags-for-resource` の例では、指定された出力プリセットのタグを一覧表示します。 ``` 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 ``` 出力: ``` { "ResourceTags": { "Tags": { "customer": "zippyVideo" }, "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:presets/SimpleMP4" } } ``` 詳細については、「*AWS Elemental MediaConvert User Guide*」の「[Tagging AWS Elemental MediaConvert Queues, Job Templates, and Output Presets](https://docs.aws.amazon.com/mediaconvert/latest/ug/tagging-queues-templates-presets.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/list-tags-for-resource.html)」を参照してください。 ### `update-job-template` 次のコード例は、`update-job-template` を使用する方法を示しています。 **AWS CLI** **ジョブテンプレートを変更するには** 次の `update-job-template` の例では、指定されたカスタムジョブテンプレートの JSON 定義を、指定されたファイルの JSON 定義に置き換えます。 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 `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 } ``` リクエストでエラーが発生した場合でも、システムはリクエストで送信した JSON ペイロードを返します。したがって、返される JSON は必ずしもジョブテンプレートの新しい定義ではありません。 JSON ペイロードが長くなる可能性があるため、上にスクロールしてエラーメッセージを表示しなければならない場合があります。 詳細については、「*AWS Elemental MediaConvert User Guide*」の「[Working with AWS Elemental MediaConvert Job Templates](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-job-templates.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateJobTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/update-job-template.html)」を参照してください。 ### `update-preset` 次のコード例は、`update-preset` を使用する方法を示しています。 **AWS CLI** **プリセットを変更するには** 次の `update-preset` の例では、指定されたプリセットの説明を置き換えます。 ``` aws mediaconvert update-preset \ --name Customer1 \ --description "New description text." --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com ``` このコマンドは何も出力しません。出力: ``` { "Preset": { "Arn": "arn:aws:mediaconvert:us-east-1:003235472598:presets/SimpleMP4", "Settings": { ...... }, "Type": "CUSTOM", "LastUpdated": 1568938411, "Description": "New description text.", "Name": "SimpleMP4", "CreatedAt": 1568938240 } } ``` 詳細については、「*AWS Elemental MediaConvert User Guide*」の「[Working with AWS Elemental MediaConvert Output Presets](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-presets.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdatePreset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/update-preset.html)」を参照してください。 ### `update-queue` 次のコード例は、`update-queue` を使用する方法を示しています。 **AWS CLI** **キューを変更するには** 次の `update-queue` の例では、ステータスを `PAUSED` に変更することで、指定されたキューを一時停止します。 ``` aws mediaconvert update-queue \ --name Customer1 \ --status PAUSED --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Elemental MediaConvert User Guide*」の「[Working with AWS Elemental MediaConvert Queues](https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateQueue](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediaconvert/update-queue.html)」を参照してください。 # AWS CLI を使用した MediaLive の例 次のコード例は、MediaLive で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-channel` 次のコード例は、`create-channel` を使用する方法を示しています。 **AWS CLI** **チャネルを作成するには** 次の `create-channel` の例では、指定したいパラメータを含む JSON ファイルを渡すことでチャネルを作成します。 この例のチャネルは、ビデオ、オーディオ、埋め込みキャプションを含むソースに接続する HLS PULL 入力を取り込みます。チャネルは、Akamai サーバーを送信先として 1 つの HLS 出力グループを作成します。出力グループには、H.265 ビデオと AAC オーディオ用の出力と、Web-VTT キャプション用の出力の 2 つの出力があります (英語のみ)。 このサンプルチャネルの JSON には、HLS PULL 入力を使用し、Akamai を送信先とする HLS 出力グループを生成するチャネルに必要な最小パラメータが含まれています。JSON には、次の主要なセクションが含まれています。 `InputAttachments`。オーディオのソースを 1 つ、キャプションのソースを 1 つ指定します。ビデオセレクタは指定しません。つまり、MediaLive はソースで見つけた最初のビデオを抽出します。`Destinations` には、このチャネル内の単一の出力グループの 2 つの IP アドレス (URL) が含まれます。これらのアドレスにはパスワードが必要です。`EncoderSettings` にはサブセクションが含まれています。`AudioDescriptions` は、チャネルに InputAttachments のソースを使用する 1 つのオーディオ出力アセットが含まれ、AAC 形式でオーディオを生成することを指定します。`CaptionDescriptions` は、チャネルに InputAttachments のソースを使用する 1 つのキャプション出力アセットが含まれ、Web-VTT 形式でキャプションを生成することを指定します。`VideoDescriptions` は、指定した解像度の 1 つのビデオ出力アセットが、チャネルに含まれていることを指定します。`OutputGroups` は、出力グループを指定します。この例では、`Akamai` という名前の 1 つのグループがあります。接続は HLS PUT を使用して行われます。出力グループには 2 つの出力が含まれます。1 つの出力は、ビデオアセット (`Video_high` という名前) とオーディオアセット (`Audio_EN` という名前) 用です。1 つの出力は、キャプションアセット (`WebVTT_EN` という名前) 用です。 この例では、一部のパラメータに値が含まれないか、ネストされた空のパラメータが含まれています。例えば、`Video_and_audio` 出力の OutputSettings には、空のパラメータ M3u8Settings で終わるいくつかのネストされたパラメータが含まれています。このパラメータを含める必要がありますが、1 つ、複数、またはすべての子を省略できます。つまり、子はデフォルト値を使用するか null になります。 このサンプルチャネルに適用されるが、このファイルで指定されていないすべてのパラメータは、デフォルト値を使用するか、null に設定されるか、MediaLive によって生成された一意の値を取得します。 ``` aws medialive create-channel \ --cli-input-json file://channel-in-hls-out-hls-akamai.json ``` `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" } } } ``` **出力:** 出力は、JSON ファイルの内容と次の値を反復して返します。すべてのパラメータはアルファベット順に並べられます。 チャネルの `ARN`。ARN の最後の部分は一意のチャネル ID です。`EgressEndpoints` は PUSH 入力にのみ使用されるため、このサンプルチャネルでは空白です。適用すると、コンテンツがプッシュされる MediaLive のアドレスが表示されます。`OutputGroups`、`Outputs`。これらは、含めなかったけれどもこのチャネルに関連するものなど、出力グループと出力のすべてのパラメータを表示します。パラメータは空であるか (おそらく、このチャネル設定でパラメータまたは機能が無効化されていることを示す)、適用されるデフォルト値を示す場合があります。`LogLevel` はデフォルト (DISABLED) に設定されます。`Tags` はデフォルト (null) に設定されます。`PipelinesRunningCount` および `State` はチャネルの現在のステータスを表示します。 詳細については、「*AWS Elemental MediaLive User Guide*」の「[Creating a Channel from Scratch](https://docs.aws.amazon.com/medialive/latest/ug/creating-channel-scratch.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medialive/create-channel.html)」を参照してください。 ### `create-input` 次のコード例は、`create-input` を使用する方法を示しています。 **AWS CLI** **入力を作成するには** 次の `create-input` の例では、このタイプの入力に適用されるパラメータを含む JSON ファイルで渡して `HLS PULL` 入力を作成します。この入力例の JSON は、取り込みの冗長性をサポートするために、入力への 2 つのソース (アドレス) を指定します。これらのアドレスにはパスワードが必要です。 ``` aws medialive create-input \ --cli-input-json file://input-hls-pull-news.json ``` `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" } ``` **出力:** 出力は、JSON ファイルの内容と次の値を反復して返します。すべてのパラメータはアルファベット順に並べられます。 入力の `Arn`。ARN の最後の部分は一意の入力 ID です。`Attached Channels` は、新しく作成された入力では常に空です。`Destinations` は、PUSH 入力でのみ使用されるためにこの例では空です。`Id` は、入力用で ARN の ID と同じです。`MediaConnectFlows` は、MediaConnect タイプの入力でのみ使用されるためにこの例では空です。`SecurityGroups` は、PUSH 入力でのみ使用されるためにこの例では空です。この入力の `State`。`Tags` は空です (このパラメータのデフォルト)。 詳細については、「*AWS Elemental MediaLive User Guide*」の「[Creating an Input](https://docs.aws.amazon.com/medialive/latest/ug/create-input.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateInput](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medialive/create-input.html)」を参照してください。 # AWS CLI を使用した MediaPackage の例 次のコード例は、MediaPackage で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-channel` 次のコード例は、`create-channel` を使用する方法を示しています。 **AWS CLI** **チャネルを作成するには** 次の `create-channel` コマンドは、現在のアカウントに `sportschannel` という名前のチャネルを作成します。 ``` aws mediapackage create-channel --id sportschannel ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Elemental MediaPackage ユーザーガイド*」の「[チャネルの作成](https://docs.aws.amazon.com/mediapackage/latest/ug/channels-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage/create-channel.html)」を参照してください。 ### `create-origin-endpoint` 次のコード例は、`create-origin-endpoint` を使用する方法を示しています。 **AWS CLI** **オリジンエンドポイントを作成するには** 次の `create-origin-endpoint` コマンドは、JSON ファイルで提供されるパッケージ設定と指定されたエンドポイント設定を使用して、`cmafsports` という名前のオリジンエンドポイントを作成します。 ``` 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 ``` 出力: ``` { "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": [] } ``` 詳細については、「*AWS Elemental MediaPackage ユーザーガイド*」の「[エンドポイントの作成](https://docs.aws.amazon.com/mediapackage/latest/ug/endpoints-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateOriginEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage/create-origin-endpoint.html)」を参照してください。 ### `delete-channel` 次のコード例は、`delete-channel` を使用する方法を示しています。 **AWS CLI** **チャンネルを削除するには** 次の `delete-channel` コマンドは、`test` という名前のチャネルを削除します。 ``` aws mediapackage delete-channel \ --id test ``` このコマンドは何も出力しません。 詳細については、「*AWS Elemental MediaPackage ユーザーガイド*」の「[チャネルの削除](https://docs.aws.amazon.com/mediapackage/latest/ug/channels-delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage/delete-channel.html)」を参照してください。 ### `delete-origin-endpoint` 次のコード例は、`delete-origin-endpoint` を使用する方法を示しています。 **AWS CLI** **オリジンエンドポイントを削除するには** 次の `delete-origin-endpoint` コマンドは、`tester2` という名前のオリジンエンドポイントを削除します。 ``` aws mediapackage delete-origin-endpoint \ --id tester2 ``` 詳細については、「*AWS Elemental MediaPackage ユーザーガイド*」の「[エンドポイントの削除](https://docs.aws.amazon.com/mediapackage/latest/ug/endpoints-delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteOriginEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage/delete-origin-endpoint.html)」を参照してください。 ### `describe-channel` 次のコード例は、`describe-channel` を使用する方法を示しています。 **AWS CLI** **チャンネルについて説明するには** 次の `describe-channel` コマンドは、`test` という名前のチャンネルの詳細をすべて表示します。 ``` aws mediapackage describe-channel \ --id test ``` 出力: ``` { "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": {} } ``` 詳細については、「*AWS Elemental MediaPackage ユーザーガイド*」の「チャネルの詳細の表示 」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage/describe-channel.html)」を参照してください。 ### `describe-origin-endpoint` 次のコード例は、`describe-origin-endpoint` を使用する方法を示しています。 **AWS CLI** **オリジンエンドポイントについて説明するには** 次の `describe-origin-endpoint` コマンドは、`cmaf_sports` という名前のオリジンエンドポイントのすべての詳細を表示します。 ``` aws mediapackage describe-origin-endpoint \ --id cmaf_sports ``` 出力: ``` { "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": [] } ``` 詳細については、「*AWS Elemental MediaPackage ユーザーガイド*」の「[単一のエンドポイントの表示](https://docs.aws.amazon.com/mediapackage/latest/ug/endpoints-view-one.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeOriginEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage/describe-origin-endpoint.html)」を参照してください。 ### `list-channels` 次のコード例は、`list-channels` を使用する方法を示しています。 **AWS CLI** **すべてのチャネルを一覧表示するには** 次の `list-channels` コマンドは、現在の AWS アカウントに設定されているすべてのチャネルを一覧表示します。 ``` aws mediapackage list-channels ``` 出力: ``` { "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": {} } ] } ``` 詳細については、「AWS Elemental MediaPackage ユーザーガイド」の「[チャネルの詳細の表示](https://docs.aws.amazon.com/mediapackage/latest/ug/channels-view.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[ListChannels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage/list-channels.html)」を参照してください。** ### `list-origin-endpoints` 次のコード例は、`list-origin-endpoints` を使用する方法を示しています。 **AWS CLI** **チャネルのすべてのオリジンエンドポイントを一覧表示するには** 次の `list-origin-endpoints` コマンドは、`test` という名前のチャネルに設定されているすべてのオリジンエンドポイントを一覧表示します。 ``` aws mediapackage list-origin-endpoints \ --channel-id test ``` 出力: ``` { "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": [] } ] } ``` 詳細については、「AWS Elemental MediaPackage ユーザーガイド」の「[チャネルに関連付けられたすべてのエンドポイントの表示](https://docs.aws.amazon.com/mediapackage/latest/ug/endpoints-view-all.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[ListOriginEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage/list-origin-endpoints.html)」を参照してください。** ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **リソースに割り当てられたタグを一覧表示するには** 次の `list-tags-for-resource` コマンドは、指定されたリソースに割り当てられたタグを一覧表示します。 ``` aws mediapackage list-tags-for-resource \ --resource-arn arn:aws:mediapackage:us-west-2:111222333:channels/6d345804ec3f46c9b454a91d4a80d0e0 ``` 出力: ``` { "Tags": { "region": "west" } } ``` 詳細については、「*AWS Elemental MediaPackage ユーザーガイド*」の「[AWS Elemental MediaPackage リソースのタグ付け](https://docs.aws.amazon.com/mediapackage/latest/ug/tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage/list-tags-for-resource.html)」を参照してください。 ### `rotate-ingest-endpoint-credentials` 次のコード例は、`rotate-ingest-endpoint-credentials` を使用する方法を示しています。 **AWS CLI** **取り込み認証情報をローテーションするには** 次の `rotate-ingest-endpoint-credentials` コマンドは、指定された取り込みエンドポイントの WebDAV ユーザー名とパスワードを更新します。 ``` aws mediapackage rotate-ingest-endpoint-credentials \ --id test \ --ingest-endpoint-id 584797f1740548c389a273585dd22a63 ``` 出力: ``` { "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": {} } ``` 詳細については、「*AWS Elemental MediaPackage ユーザーガイド*」の「[入力 URL での認証情報の更新](https://docs.aws.amazon.com/mediapackage/latest/ug/channels-rotate-creds)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RotateIngestEndpointCredentials](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage/rotate-ingest-endpoint-credentials.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **リソースにタグを追加する** 次の `tag-resource` コマンドは、指定されたリソースに `region=west` キーと値のペアを追加します。 ``` aws mediapackage tag-resource \ --resource-arn arn:aws:mediapackage:us-west-2:111222333:channels/6d345804ec3f46c9b454a91d4a80d0e0 \ --tags region=west ``` このコマンドは何も出力しません。 詳細については、「*AWS Elemental MediaPackage ユーザーガイド*」の「[AWS Elemental MediaPackage リソースのタグ付け](https://docs.aws.amazon.com/mediapackage/latest/ug/tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage/tag-resource.html)」を参照してください。 ### `untag-resource` 次の例では、`untag-resource` を使用する方法を説明しています。 **AWS CLI** **リソースからタグを削除するには** 次の `untag-resource` コマンドは、指定されたチャネルからキー `region` を持つタグを削除します。 ``` aws mediapackage untag-resource \ --resource-arn arn:aws:mediapackage:us-west-2:111222333:channels/6d345804ec3f46c9b454a91d4a80d0e0 \ --tag-keys region ``` 詳細については、「*AWS Elemental MediaPackage ユーザーガイド*」の「[AWS Elemental MediaPackage リソースのタグ付け](https://docs.aws.amazon.com/mediapackage/latest/ug/tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage/untag-resource.html)」を参照してください。 ### `update-channel` 次のコード例は、`update-channel` を使用する方法を示しています。 **AWS CLI** **チャネルを更新するには** 次の `update-channel` コマンドは、`sportschannel` という名前のチャンネルを更新して、`24x7 sports` という説明を含めます。 ``` aws mediapackage update-channel \ --id sportschannel \ --description "24x7 sports" ``` 出力: ``` { "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": {} } ``` 詳細については、「*AWS Elemental MediaPackage ユーザーガイド*」の「[チャネルの編集](https://docs.aws.amazon.com/mediapackage/latest/ug/channels-edit.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage/update-channel.html)」を参照してください。 ### `update-origin-endpoint` 次のコード例は、`update-origin-endpoint` を使用する方法を示しています。 **AWS CLI** **オリジンエンドポイントを更新するには** 次の `update-origin-endpoint` コマンドは、`cmaf_sports` という名前のオリジンエンドポイントを更新します。これにより、遅延時間が `0` 秒に変更されます。 ``` aws mediapackage update-origin-endpoint \ --id cmaf_sports \ --time-delay-seconds 0 ``` 出力: ``` { "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": [] } ``` 詳細については、「*AWS Elemental MediaPackage ユーザーガイド*」の「[エンドポイントの編集](https://docs.aws.amazon.com/mediapackage/latest/ug/endpoints-edit.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateOriginEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage/update-origin-endpoint.html)」を参照してください。 # AWS CLI を使用した MediaPackage VOD の例 次のコード例は、MediaPackage VOD で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-asset` 次のコード例は、`create-asset` を使用する方法を示しています。 **AWS CLI** **アセットを作成するには** 次の `create-asset` の例では、現在の AWS アカウントに `Chicken_Asset` という名前のアセットを作成します。アセットはファイル `30sec_chicken.smil` を 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 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS Elemental MediaPackage ユーザーガイド*」の「[アセットの取り込み](https://docs.aws.amazon.com/mediapackage/latest/ug/asset-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage-vod/create-asset.html)」を参照してください。 ### `create-packaging-configuration` 次のコード例は、`create-packaging-configuration` を使用する方法を示しています。 **AWS CLI** **パッケージング設定を作成するには** 次の `create-packaging-configuration` の例では、`hls_chicken` という名前のパッケージンググループに `new_hls` という名前のパッケージング設定を作成します。この例では、`hls_pc.json` という名前のディスク上のファイルを使用して詳細を提供します。 ``` aws mediapackage-vod create-packaging-configuration \ --id new_hls \ --packaging-group-id hls_chicken \ --hls-package file://hls_pc.json ``` `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 } ``` 出力: ``` { "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" } } ] } } ``` 詳細については、「*AWS Elemental MediaPackage ユーザーガイド*」の「[パッケージ設定の作成](https://docs.aws.amazon.com/mediapackage/latest/ug/pkg-cfig-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreatePackagingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage-vod/create-packaging-configuration.html)」を参照してください。 ### `create-packaging-group` 次のコード例は、`create-packaging-group` を使用する方法を示しています。 **AWS CLI** **パッケージンググループを作成するには** 次の `create-packaging-group` の例では、現在の AWS アカウントで設定されているすべてのパッケージンググループを一覧表示します。 ``` aws mediapackage-vod create-packaging-group \ --id hls_chicken ``` 出力: ``` { "Arn": "arn:aws:mediapackage-vod:us-west-2:111122223333:packaging-groups/hls_chicken", "Id": "hls_chicken" } ``` 詳細については、「*AWS Elemental MediaPackage ユーザーガイド*」の「[パッケージンググループの作成](https://docs.aws.amazon.com/mediapackage/latest/ug/pkg-group-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreatePackagingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage-vod/create-packaging-group.html)」を参照してください。 ### `delete-asset` 次のコード例は、`delete-asset` を使用する方法を示しています。 **AWS CLI** **アセットを削除するには** 次の `delete-asset` の例では、`30sec_chicken` という名前のアセットを削除します。 ``` aws mediapackage-vod delete-asset \ --id 30sec_chicken ``` このコマンドは何も出力しません。 詳細については、「*AWS Elemental MediaPackage ユーザーガイド*」の「[アセットの削除](https://docs.aws.amazon.com/mediapackage/latest/ug/asset-delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage-vod/delete-asset.html)」を参照してください。 ### `delete-packaging-configuration` 次のコード例は、`delete-packaging-configuration` を使用する方法を示しています。 **AWS CLI** **パッケージング設定を削除するには** 次の `delete-packaging-configuration` の例では、`CMAF` という名前のパッケージング設定を削除します。 ``` aws mediapackage-vod delete-packaging-configuration \ --id CMAF ``` このコマンドは何も出力しません。 詳細については、「*AWS Elemental MediaPackage ユーザーガイド*」の「[パッケージング設定の削除](https://docs.aws.amazon.com/mediapackage/latest/ug/pkg-cfig-delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeletePackagingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage-vod/delete-packaging-configuration.html)」を参照してください。 ### `delete-packaging-group` 次のコード例は、`delete-packaging-group` を使用する方法を示しています。 **AWS CLI** **パッケージンググループを削除するには** 次の `delete-packaging-group` の例では、`Dash_widevine` という名前のパッケージンググループを削除します。 ``` aws mediapackage-vod delete-packaging-group \ --id Dash_widevine ``` このコマンドは何も出力しません。 詳細については、「*AWS Elemental MediaPackage ユーザーガイド*」の「[パッケージンググループの削除](https://docs.aws.amazon.com/mediapackage/latest/ug/pkg-group-delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeletePackagingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage-vod/delete-packaging-group.html)」を参照してください。 ### `describe-asset` 次のコード例は、`describe-asset` を使用する方法を示しています。 **AWS CLI** **アセットについて説明するには** 次の `describe-asset` の例では、`30sec_chicken` という名前のアセットの詳細をすべて表示します。 ``` aws mediapackage-vod describe-asset \ --id 30sec_chicken ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS Elemental MediaPackage ユーザーガイド*」の「[アセットの詳細の表示](https://docs.aws.amazon.com/mediapackage/latest/ug/asset-view.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAsset](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage-vod/describe-asset.html)」を参照してください。 ### `describe-packaging-configuration` 次のコード例は、`describe-packaging-configuration` を使用する方法を示しています。 **AWS CLI** **パッケージング設定について説明するには** 次の `describe-packaging-configuration` の例では、`DASH` という名前のパッケージング設定の詳細をすべて表示します。 ``` aws mediapackage-vod describe-packaging-configuration \ --id DASH ``` 出力: ``` { "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" } } ] } ``` 詳細については、「*AWS Elemental MediaPackage ユーザーガイド*」の「[Viewing Packaging Configuration Details](https://docs.aws.amazon.com/mediapackage/latest/ug/pkg-cfig-view.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribePackagingConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage-vod/describe-packaging-configuration.html)」を参照してください。 ### `describe-packaging-group` 次のコード例は、`describe-packaging-group` を使用する方法を示しています。 **AWS CLI** **パッケージンググループについて説明するには** 次の `describe-packaging-group` の例では、`Packaging_group_1` という名前のパッケージンググループの詳細をすべて表示します。 ``` aws mediapackage-vod describe-packaging-group \ --id Packaging_group_1 ``` 出力: ``` { "Arn": "arn:aws:mediapackage-vod:us-west-2:111122223333:packaging-groups/Packaging_group_1", "Id": "Packaging_group_1" } ``` 詳細については、「*AWS Elemental MediaPackage ユーザーガイド*」の「[Viewing Packaging Group Details](https://docs.aws.amazon.com/mediapackage/latest/ug/pkg-group-view.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribePackagingGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage-vod/describe-packaging-group.html)」を参照してください。 ### `list-assets` 次のコード例は、`list-assets` を使用する方法を示しています。 **AWS CLI** **すべてのアセットを一覧表示するには** 次の `list-assets` の例では、現在の AWS アカウントで設定されているすべてのアセットを一覧表示します。 ``` aws mediapackage-vod list-assets ``` 出力: ``` { "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" ] } ``` 詳細については、「*AWS Elemental MediaPackage ユーザーガイド*」の「[アセットの詳細の表示](https://docs.aws.amazon.com/mediapackage/latest/ug/asset-view.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAssets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage-vod/list-assets.html)」を参照してください。 ### `list-packaging-configurations` 次のコード例は、`list-packaging-configurations` を使用する方法を示しています。 **AWS CLI** **すべてのパッケージング設定を一覧表示するには** 次の `list-packaging-configurations` の例では、`Packaging_group_1` という名前のパッケージンググループで設定されているすべてのパッケージング設定を一覧表示します。 ``` aws mediapackage-vod list-packaging-configurations \ --packaging-group-id Packaging_group_1 ``` 出力: ``` { "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" } } ] } ] } ``` 詳細については、「*AWS Elemental MediaPackage ユーザーガイド*」の「[Viewing Packaging Configuration Details](https://docs.aws.amazon.com/mediapackage/latest/ug/pkg-cfig-view.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPackagingConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage-vod/list-packaging-configurations.html)」を参照してください。 ### `list-packaging-groups` 次のコード例は、`list-packaging-groups` を使用する方法を示しています。 **AWS CLI** **すべてのパッケージンググループを一覧表示するには** 次の `list-packaging-groups` の例では、現在の AWS アカウントで設定されているすべてのパッケージンググループを一覧表示します。 ``` aws mediapackage-vod list-packaging-groups ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS Elemental MediaPackage ユーザーガイド*」の「[Viewing Packaging Group Details](https://docs.aws.amazon.com/mediapackage/latest/ug/pkg-group-view.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPackagingGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediapackage-vod/list-packaging-groups.html)」を参照してください。 # AWS CLI を使用した MediaStore Data Plane の例 次のコード例は、MediaStore Data Plane で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `delete-object` 次のコード例は、`delete-object` を使用する方法を示しています。 **AWS CLI** **オブジェクトを削除するには** 次の `delete-object` の例では、指定されたオブジェクトを削除します。 ``` aws mediastore-data delete-object \ --endpoint=https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ --path=/folder_name/README.md ``` このコマンドは何も出力しません。 詳細については、「*AWS Elemental MediaStore User Guide*」の「[Deleting an Object](https://docs.aws.amazon.com/mediastore/latest/ug/objects-delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteObject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore-data/delete-object.html)」を参照してください。 ### `describe-object` 次のコード例は、`describe-object` を使用する方法を示しています。 **AWS CLI** **オブジェクトのヘッダーを表示するには** 次の `describe-object` の例では、指定されたパスにあるオブジェクトのヘッダーを表示します。 ``` aws mediastore-data describe-object \ --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ --path events/baseball/setup.jpg ``` 出力: ``` { "LastModified": "Fri, 19 Jul 2019 21:50:31 GMT", "ContentType": "image/jpeg", "ContentLength": "3860266", "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3" } ``` 詳細については、「*AWS Elemental MediaStore User Guide*」の「[Viewing the Details of an Object](https://docs.aws.amazon.com/mediastore/latest/ug/objects-view-details.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeObject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore-data/describe-object.html)」を参照してください。 ### `get-object` 次のコード例は、`get-object` を使用する方法を示しています。 **AWS CLI** **例 1: オブジェクト全体をダウンロードするには** 次の `get-object` の例では、指定されたオブジェクトをダウンロードします。 ``` aws mediastore-data get-object \ --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ --path events/baseball/setup.jpg setup.jpg ``` 出力: ``` { "ContentType": "image/jpeg", "StatusCode": 200, "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3", "ContentLength": "3860266", "LastModified": "Fri, 19 Jul 2019 21:50:31 GMT" } ``` **例 2: オブジェクトの一部をダウンロードするには** 次の `get-object` の例では、オブジェクトの指定された部分をダウンロードします。 ``` 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" ``` 出力: ``` { "StatusCode": 206, "LastModified": "Fri, 19 Jul 2019 21:50:31 GMT", "ContentType": "image/jpeg", "ContentRange": "bytes 0-100/3860266", "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3", "ContentLength": "101" } ``` 詳細については、「*AWS Elemental MediaStore User Guide*」の「[Downloading an Object](https://docs.aws.amazon.com/mediastore/latest/ug/objects-download.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[GetObject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore-data/get-object.html)」を参照してください。** ### `list-items` 次のコード例は、`list-items` を使用する方法を示しています。 **AWS CLI** **例 1: コンテナに保存されている項目 (オブジェクトとフォルダ) のリストを表示するには** 次の `list-items` の例では、指定されたコンテナに保存されている項目 (オブジェクトとフォルダ) のリストを表示します。 ``` aws mediastore-data list-items \ --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com ``` 出力: ``` { "Items": [ { "Type": "OBJECT", "ContentLength": 3784, "Name": "setup.jpg", "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3", "ContentType": "image/jpeg", "LastModified": 1563571859.379 }, { "Type": "FOLDER", "Name": "events" } ] } ``` **例 2: フォルダに保存されている項目 (オブジェクトとフォルダ) のリストを表示するには** 次の `list-items` の例では、指定されたフォルダに保存されている項目 (オブジェクトとフォルダ) のリストを表示します。 ``` aws mediastore-data list-items \ --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ --path events/baseball ``` 出力: ``` { "Items": [ { "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3", "ContentType": "image/jpeg", "Type": "OBJECT", "ContentLength": 3860266, "LastModified": 1563573031.872, "Name": "setup.jpg" } ] } ``` 詳細については、「*AWS Elemental MediaStore User Guide*」の「[Viewing a List of Objects](https://docs.aws.amazon.com/mediastore/latest/ug/objects-view-list.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListItems](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore-data/list-items.html)」を参照してください。 ### `put-object` 次のコード例は、`put-object` を使用する方法を示しています。 **AWS CLI** **例 1: オブジェクトをコンテナにアップロードするには** 次の `put-object` の例では、指定されたコンテナにオブジェクトをアップロードします。 ``` 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 ``` 出力: ``` { "ContentSHA256": "f29bc64a9d3732b4b9035125fdb3285f5b6455778edca72414671e0ca3b2e0de", "StorageClass": "TEMPORAL", "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3" } ``` **例 2: オブジェクトをコンテナ内のフォルダにアップロードするには** 次の `put-object` の例では、コンテナ内の指定されたフォルダにオブジェクトをアップロードします。 ``` 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 ``` 出力: ``` { "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3", "ContentSHA256": "f29bc64a9d3732b4b9035125fdb3285f5b6455778edca72414671e0ca3b2e0de", "StorageClass": "TEMPORAL" } ``` 詳細については、「*AWS Elemental MediaStore User Guide*」の「[Uploading an Object](https://docs.aws.amazon.com/mediastore/latest/ug/objects-upload.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutObject](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediastore-data/put-object.html)」を参照してください。 # AWS CLI を使用した MediaTailor の例 次のコード例は、MediaTailor で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `delete-playback-configuration` 次のコード例は、`delete-playback-configuration` を使用する方法を示しています。 **AWS CLI** **設定を削除する** 次の `delete-playback-configuration` では、`campaign_short` という名前の設定を削除します。 ``` aws mediatailor delete-playback-configuration \ --name campaign_short ``` このコマンドでは何も出力されません。 詳細については、「*AWS Elemental MediaTailor User Guide*」の「[Deleting a Configuration](https://docs.aws.amazon.com/mediatailor/latest/ug/configurations-delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeletePlaybackConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediatailor/delete-playback-configuration.html)」を参照してください。 ### `get-playback-configuration` 次のコード例は、`get-playback-configuration` を使用する方法を示しています。 **AWS CLI** **設定について説明するには** 次の `get-playback-configuration` は、`west_campaign` という名前の設定の詳細をすべて表示します。 ``` aws mediatailor get-playback-configuration \ --name west_campaign ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Elemental MediaTailor User Guide*」の「[Viewing a Configuration](https://docs.aws.amazon.com/mediatailor/latest/ug/configurations-view.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPlaybackConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediatailor/get-playback-configuration.html)」を参照してください。 ### `list-playback-configurations` 次のコード例は、`list-playback-configurations` を使用する方法を示しています。 **AWS CLI** **すべての設定を一覧表示するには** 次の `list-playback-configurations` は、現在の AWS アカウントでの設定の詳細をすべて表示します。 ``` aws mediatailor list-playback-configurations ``` 出力: ``` { "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" } ] } ``` 詳細については、*「AWS Elemental MediaTailor User Guide*」の「Viewing a Configuration 」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPlaybackConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediatailor/list-playback-configurations.html)」を参照してください。 ### `put-playback-configuration` 次のコード例は、`put-playback-configuration` を使用する方法を示しています。 **AWS CLI** **設定を作成するには** 次の `put-playback-configuration` では、`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 ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Elemental MediaTailor User Guide*」の「[Creating a Configuration](https://docs.aws.amazon.com/mediatailor/latest/ug/configurations-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutPlaybackConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/mediatailor/put-playback-configuration.html)」を参照してください。 # AWS CLI を使用した MemoryDB の例 次のコード例は、MemoryDB で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `copy-snapshot` 次のコード例は、`copy-snapshot` を使用する方法を示しています。 **AWS CLI** **スナップショットをコピーするには** 次の `copy-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 } } } ``` 詳細については、「*MemoryDB User Guide*」の「[Copying a snapshot](https://docs.aws.amazon.com/memorydb/latest/devguide/snapshots-copying.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CopySnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/copy-snapshot.html)」を参照してください。 ### `create-acl` 次のコード例は、`create-acl` を使用する方法を示しています。 **AWS CLI** **ACL を作成するには** 次の `create-acl` の例では、新しいアクセスコントロールリストを作成します。 ``` aws memorydb create-acl \ --acl-name "new-acl-1" \ --user-names "my-user" ``` 出力: ``` { "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" } } ``` 詳細については、「*MemoryDB User Guide*」の「[Authenticating users with Access Control Lists](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.acls.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateAcl](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/create-acl.html)」を参照してください。 ### `create-cluster` 次のコード例は、`create-cluster` を使用する方法を示しています。 **AWS CLI** **クラスターを作成するには** 次の `create-cluster` の例では、新しいクラスターを作成します。 ``` aws memorydb create-cluster \ --cluster-name my-new-cluster \ --node-type db.r6g.large \ --acl-name my-acl \ --subnet-group my-sg ``` 出力: ``` { "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 } } ``` 詳細については、「*MemoryDB User Guide*」の「[Managing Clusters](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/create-cluster.html)」を参照してください。 ### `create-parameter-group` 次のコード例は、`create-parameter-group` を使用する方法を示しています。 **AWS CLI** **パラメータグループを作成するには** 次の `create-parameter-group` の例では、パラメータグループを作成します。 ``` aws memorydb create-parameter-group \ --parameter-group-name myRedis6x \ --family memorydb_redis6 \ --description "my-parameter-group" ``` 出力: ``` { "ParameterGroup": { "Name": "myredis6x", "Family": "memorydb_redis6", "Description": "my-parameter-group", "ARN": "arn:aws:memorydb:us-east-1:49165xxxxxx:parametergroup/myredis6x" } } ``` 詳細については、「*MemoryDB User Guide*」の「[Creating a parameter group](https://docs.aws.amazon.com/memorydb/latest/devguide/parametergroups.creating.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/create-parameter-group.html)」を参照してください。 ### `create-snapshot` 次のコード例は、`create-snapshot` を使用する方法を示しています。 **AWS CLI** **スナップショットを作成するには** 次の `create-snapshot` の例では、スナップショットを作成します。 ``` aws memorydb create-snapshot \ --cluster-name my-cluster \ --snapshot-name my-cluster-snapshot ``` 出力: ``` { "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 } } } ``` 詳細については、「*MemoryDB User Guide*」の「[Making manual snapshots](https://docs.aws.amazon.com/memorydb/latest/devguide/snapshots-manual.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/create-snapshot.html)」を参照してください。 ### `create-subnet-group` 次のコード例は、`create-subnet-group` を使用する方法を示しています。 **AWS CLI** **サブネットグループを作成するには** 次の `create-subnet-group` の例では、サブネットグループを作成します。 ``` aws memorydb create-subnet-group \ --subnet-group-name mysubnetgroup \ --description "my subnet group" \ --subnet-ids subnet-5623xxxx ``` 出力: ``` { "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" } } ``` 詳細については、「*MemoryDB User Guide*」の「[Creating a subnet group](https://docs.aws.amazon.com/memorydb/latest/devguide/subnetgroups.creating.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/create-subnet-group.html)」を参照してください。 ### `create-user` 次のコード例は、`create-user` を使用する方法を示しています。 **AWS CLI** **ユーザーを作成するには** 次の `create-user` の例では、新しいユーザーを作成します。 ``` aws memorydb create-user \ --user-name user-name-1 \ --access-string "~objects:* ~items:* ~public:*" \ --authentication-mode \ Passwords="enterapasswordhere",Type=password ``` 出力: ``` { "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" } } ``` 詳細については、「*MemoryDB User Guide*」の「[Authenticating users with Access Control Lists](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.acls.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[CreateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/create-user.html)」を参照してください。 ### `delete-acl` 次のコード例は、`delete-acl` を使用する方法を示しています。 **AWS CLI** **ACL を削除するには** 次の `delete-acl` の例では、アクセスコントロールリストを削除します。 ``` aws memorydb delete-acl \ --acl-name "new-acl-1" ``` 出力: ``` { "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" } } ``` 詳細については、「*MemoryDB User Guide*」の「[Authenticating users with Access Control Lists](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.acls.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAcl](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/delete-acl.html)」を参照してください。 ### `delete-cluster` 次のコード例は、`delete-cluster` を使用する方法を示しています。 **AWS CLI** **クラスターを削除するには** () 次の `delete-cluster` の例では、クラスターを削除します。 ``` aws memorydb delete-cluster \ --cluster-name my-new-cluster ``` 出力: ``` { "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 } } ``` 詳細については、「*MemoryDB User Guide*」の「[Deleting a cluster](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/delete-cluster.html)」を参照してください。 ### `delete-parameter-group` 次のコード例は、`delete-parameter-group` を使用する方法を示しています。 **AWS CLI** **パラメータグループを削除するには** 次の `delete-parameter-group` の例では、パラメータグループを削除します。 ``` aws memorydb delete-parameter-group \ --parameter-group-name myRedis6x ``` 出力: ``` { "ParameterGroup": { "Name": "myredis6x", "Family": "memorydb_redis6", "Description": "my-parameter-group", "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:parametergroup/myredis6x" } } ``` 詳細については、「*MemoryDB User Guide*」の「[Deleting a parameter group](https://docs.aws.amazon.com/memorydb/latest/devguide/parametergroups.deleting.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/delete-parameter-group.html)」を参照してください。 ### `delete-snapshot` 次のコード例は、`delete-snapshot` を使用する方法を示しています。 **AWS CLI** **スナップショットを削除するには** 次の `delete-snapshot` の例では、スナップショットを削除します。 ``` aws memorydb delete-snapshot \ --snapshot-name my-cluster-snapshot ``` 出力: ``` { "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 } } } ``` 詳細については、「*MemoryDB User Guide*」の「[Deleting a snapshot](https://docs.aws.amazon.com/memorydb/latest/devguide/snapshots-deleting.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/delete-snapshot.html)」を参照してください。 ### `delete-subnet-group` 次のコード例は、`delete-subnet-group` を使用する方法を示しています。 **AWS CLI** **サブネットグループを削除するには** 次の `delete-subnet-group` の例では、サブネットを削除します。 ``` aws memorydb delete-subnet-group \ --subnet-group-name mysubnetgroup ``` 出力: ``` { "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" } } ``` 詳細については、「*MemoryDB User Guide*」の「[Deleting a subnet group](https://docs.aws.amazon.com/memorydb/latest/devguide/subnetgroups.deleting.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/delete-subnet-group.html)」を参照してください。 ### `delete-user` 次のコード例は、`delete-user` を使用する方法を示しています。 **AWS CLI** **ユーザーを削除するには** 次の `delete-user` の例では、ユーザーを削除します。 ``` aws memorydb delete-user \ --user-name my-user ``` 出力: ``` { "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" } } ``` 詳細については、「*MemoryDB User Guide*」の「[Authenticating users with Access Control Lists](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.acls.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/delete-user.html)」を参照してください。 ### `describe-acls` 次のコード例は、`describe-acls` を使用する方法を示しています。 **AWS CLI** **ACL のリストを返すには** 次の describe-acls` は、ACL のリストを返します。 ``` aws memorydb describe-acls ``` 出力: ``` { "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" } ] } ``` 詳細については、「*MemoryDB User Guide*」の「[Authenticating users with Access Control Lists](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.acls.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAcls](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/describe-acls.html)」を参照してください。 ### `describe-clusters` 次のコード例は、`describe-clusters` を使用する方法を示しています。 **AWS CLI** **クラスターのリストを返すには** 次の describe-clusters` は、クラスターのリストを返します。 ``` aws memorydb describe-clusters ``` 出力: ``` { "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 } ] } ``` 詳細については、「*MemoryDB User Guide*」の「[Managing clusters](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/describe-clusters.html)」を参照してください。 ### `describe-engine-versions` 次のコード例は、`describe-engine-versions` を使用する方法を示しています。 **AWS CLI** **エンジンバージョンのリストを返すには** 次の describe-engine-versions は、エンジンバージョンのリストを返します。 ``` aws memorydb describe-engine-versions ``` 出力: ``` { "EngineVersions": [ { "EngineVersion": "6.2", "EnginePatchVersion": "6.2.6", "ParameterGroupFamily": "memorydb_redis6" } ] } ``` 詳細については、「*MemoryDB User Guide*」の「[Engine versions and upgrading](https://docs.aws.amazon.com/memorydb/latest/devguide/engine-versions.htmll)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEngineVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/describe-engine-versions.html)」を参照してください。 ### `describe-events` 次のコード例は、`describe-events` を使用する方法を示しています。 **AWS CLI** **イベントのリストを返すには** 次の describe-events` はイベントのリストを返します。 ``` aws memorydb describe-events ``` 出力: ``` { "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" } ] } ``` 詳細については、「*MemoryDB User Guide*」の「[Monitoring events](https://docs.aws.amazon.com/memorydb/latest/devguide/monitoring-events.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/describe-events.html)」を参照してください。 ### `describe-parameter-groups` 次のコード例は、`describe-parameter-groups` を使用する方法を示しています。 **AWS CLI** **パラメータグループのリストを返すには** 次の describe-parameter-groups` は、パラメータグループのリストを返します。 ``` aws memorydb describe-parameter-groups ``` 出力: ``` { "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" } ] } ``` 詳細については、「*MemoryDB User Guide*」の「[Configuring engine parameters using parameter groups](https://docs.aws.amazon.com/memorydb/latest/devguide/parametergroups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeParameterGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/describe-parameter-groups.html)」を参照してください。 ### `describe-parameters` 次のコード例は、`describe-parameters` を使用する方法を示しています。 **AWS CLI** **パラメータのリストを返すには** 次の describe-parameters` はパラメータのリストを返します。 ``` aws memorydb describe-parameters ``` 出力: ``` { "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" } ] } ``` 詳細については、「*MemoryDB User Guide*」の「[Configuring engine parameters using parameter groups](https://docs.aws.amazon.com/memorydb/latest/devguide/parametergroups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/describe-parameters.html)」を参照してください。 ### `describe-snapshots` 次のコード例は、`describe-snapshots` を使用する方法を示しています。 **AWS CLI** **スナップショットのリストを返すには** 次の describe-snapshots` はスナップショットのリストを返します。 ``` aws memorydb describe-snapshots ``` 出力: ``` { "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 } } } ``` 詳細については、「*MemoryDB User Guide*」の「[Snapshot and restore](https://docs.aws.amazon.com/memorydb/latest/devguide/snapshots.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/describe-snapshots.html)」を参照してください。 ### `describe-subnet-groups` 次のコード例は、`describe-subnet-groups` を使用する方法を示しています。 **AWS CLI** **サブネットグループのリストを返すには** 次の describe-subnet-groups は、サブネットグループのリストを返します。 ``` 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" } ] } ``` 詳細については、「*MemoryDB User Guide*」の「[Subnets and subnet groups](https://docs.aws.amazon.com/memorydb/latest/devguide/subnetgroups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeSubnetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/describe-subnet-groups.html)」を参照してください。 ### `describe-users` 次のコード例は、`describe-users` を使用する方法を示しています。 **AWS CLI** **ユーザーのリストを返すには** 次の describe-users` は、ユーザーのリストを返します。 ``` 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" } ] } ``` 詳細については、「*MemoryDB User Guide*」の「[Authenticating users with Access Control Lists](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.acls.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeUsers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/describe-users.html)」を参照してください。 ### `failover-shard` 次のコード例は、`failover-shard` を使用する方法を示しています。 **AWS CLI** **シャードをフェイルオーバーするには** 次の failover-shard` はシャードをフェイルオーバーします。 ``` aws memorydb failover-shard \ --cluster-name my-cluster --shard-name 0001 ``` 出力: ``` { "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 } } ``` 詳細については、「*MemoryDB User Guide*」の「[Minimizing downtime with MultiAZ](https://docs.aws.amazon.com/memorydb/latest/devguide/autofailover.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[FailoverShard](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/failover-shard.html)」を参照してください。 ### `list-allowed-node-type-updates` 次のコード例は、`list-allowed-node-type-updates` を使用する方法を示しています。 **AWS CLI** **許可されたノードタイプの更新のリストを返すには** 次の list-allowed-node-type-updates は、使用可能なノードタイプの更新のリストを返します。 ``` aws memorydb list-allowed-node-type-updates ``` 出力: ``` { "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 } } ``` 詳細については、「*MemoryDB User Guide*」の「[Scaling](https://docs.aws.amazon.com/memorydb/latest/devguide/scaling.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAllowedNodeTypeUpdates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/list-allowed-node-type-updates.html)」を参照してください。 ### `list-tags` 次のコード例は、`list-tags` を使用する方法を示しています。 **AWS CLI** **タグのリストを返すには** 次の list-tags は、タグのリストを返します。 ``` aws memorydb list-tags \ --resource-arn arn:aws:memorydb:us-east-1:491658xxxxxx:cluster/my-cluster ``` 出力: ``` { "TagList": [ { "Key": "mytag", "Value": "myvalue" } ] } ``` 詳細については、「*MemoryDB User Guide*」の「[Tagging resources](https://docs.aws.amazon.com/memorydb/latest/devguide/tagging-resources.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/list-tags.html)」を参照してください。 ### `reset-parameter-group` 次のコード例は、`reset-parameter-group` を使用する方法を示しています。 **AWS CLI** **パラメータグループをリセットするには** 次の reset-parameter-group` は、パラメータグループをリセットします。 ``` aws memorydb reset-parameter-group \ --parameter-group-name my-parameter-group \ --all-parameters ``` 出力: ``` { "ParameterGroup": { "Name": "my-parameter-group", "Family": "memorydb_redis6", "Description": "my parameter group", "ARN": "arn:aws:memorydb:us-east-1:491658xxxxxx:parametergroup/my-parameter-group" } } ``` 詳細については、「*MemoryDB User Guide*」の「[Configuring engine parameters using parameter groups](https://docs.aws.amazon.com/memorydb/latest/devguide/parametergroups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ResetParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/reset-parameter-group.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **リソースにタグを付けるには** 次の tag-resource` は、リソースにタグを追加します。 ``` aws memorydb tag-resource \ --resource-arn arn:aws:memorydb:us-east-1:491658xxxxxx:cluster/my-cluster \ --tags Key="mykey",Value="myvalue" ``` 出力: ``` { "TagList": [ { "Key": "mytag", "Value": "myvalue" }, { "Key": "mykey", "Value": "myvalue" } ] } ``` 詳細については、「*MemoryDB User Guide*」の「[Tagging resources](https://docs.aws.amazon.com/memorydb/latest/devguide/tagging-resources.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **ACL を更新するには** 次の update-acl` は、ユーザーを追加することにより ACL を更新します。 ``` aws memorydb untag-resource \ --resource-arn arn:aws:memorydb:us-east-1:491658xxxxx:cluster/my-cluster \ --tag-keys mykey ``` 出力: ``` { "TagList": [ { "Key": "mytag", "Value": "myvalue" } ] } ``` 詳細については、「*MemoryDB User Guide*」の「[Tagging resources](https://docs.aws.amazon.com/memorydb/latest/devguide/tagging-resources.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/untag-resource.html)」を参照してください。 ### `update-cluster` 次のコード例は、`update-cluster` を使用する方法を示しています。 **AWS CLI** **クラスターを更新するには** 次の update-cluster`` は、クラスターのパラメータグループを my-parameter-group に更新します。 ``` aws memorydb update-cluster \ --cluster-name my-cluster \ --parameter-group-name my-parameter-group ``` 出力: ``` { "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 } } ``` 詳細については、「*MemoryDB User Guide*」の「[Modifying a cluster](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.modify.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/update-cluster.html)」を参照してください。 ### `update-parameter-group` 次のコード例は、`update-parameter-group` を使用する方法を示しています。 **AWS CLI** **パラメータグループを更新するには** 次の update-parameter-group`` は、パラメータグループを更新します。 ``` aws memorydb update-parameter-group \ --parameter-group-name my-parameter-group \ --parameter-name-values "ParameterName=activedefrag, ParameterValue=no" ``` 出力: ``` { "ParameterGroup": { "Name": "my-parameter-group", "Family": "memorydb_redis6", "Description": "my parameter group", "ARN": "arn:aws:memorydb:us-east-1:49165xxxxxx:parametergroup/my-parameter-group" } } ``` 詳細については、「*MemoryDB User Guide*」の「[Modifying a parameter group](https://docs.aws.amazon.com/memorydb/latest/devguide/parametergroups.modifying.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/update-parameter-group.html)」を参照してください。 ### `update-subnet-group` 次のコード例は、`update-subnet-group` を使用する方法を示しています。 **AWS CLI** **サブネットグループを更新するには** 次の update-subnet-group` は、サブネットグループのサブネット ID を更新します。 ``` aws memorydb update-subnet-group \ --subnet-group-name my-sg \ --subnet-ids subnet-01f29d458f3xxxxx ``` 出力: ``` { "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" } } ``` 詳細については、「*MemoryDB User Guide*」の「[Subnets and subnet groups](https://docs.aws.amazon.com/memorydb/latest/devguide/subnetgroups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/update-subnet-group.html)」を参照してください。 ### `update-user` 次のコード例は、`update-user` を使用する方法を示しています。 **AWS CLI** **ユーザーを更新するには** 次の `update-user` は、ユーザーのアクセス文字列を変更します。 ``` aws memorydb update-user \ --user-name my-user \ --access-string "off ~objects:* ~items:* ~public:* resetchannels -@all" ``` 出力: ``` { "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" } } ``` 詳細については、「*MemoryDB User Guide*」の「[Authenticating users with Access Control Lists](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.acls.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateUser](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/memorydb/update-user.html)」を参照してください。 # Amazon MSK examples using AWS CLI 次のコード例は、Amazon MSK で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-cluster` 次のコード例は、`create-cluster` を使用する方法を示しています。 **AWS CLI** **Amazon MSK クラスターを作成するには** 次の `create-cluster` の例では、`MessagingCluster` という名前の MSK クラスターを 3 つのブローカーノードで作成します。`brokernodegroupinfo.json` という名前の JSON ファイルでは、Amazon MSK がブローカーノードを分散する 3 つのサブネットを指定します。この例ではモニタリングレベルを指定しないため、クラスターのレベルは `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 ``` `brokernodegroupinfo.json` の内容: ``` { "InstanceType": "kafka.m5.xlarge", "BrokerAZDistribution": "DEFAULT", "ClientSubnets": [ "subnet-0123456789111abcd", "subnet-0123456789222abcd", "subnet-0123456789333abcd" ] } ``` 出力: ``` { "ClusterArn": "arn:aws:kafka:us-west-2:123456789012:cluster/MessagingCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2", "ClusterName": "MessagingCluster", "State": "CREATING" } ``` 詳細については、「*Amazon Managed Streaming for Apache Kafka*」の「[Amazon MSK クラスターを作成する](https://docs.aws.amazon.com/msk/latest/developerguide/msk-create-cluster.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kafka/create-cluster.html)」を参照してください。 ### `create-configuration` 次のコード例は、`create-configuration` を使用する方法を示しています。 **AWS CLI** **カスタム Amazon MSK 設定を作成するには** 次の `create-configuration` の例では、入力ファイルで指定されたサーバープロパティを使用してカスタム MSK 設定を作成します。 ``` 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 ``` `configuration.txt` の内容: ``` auto.create.topics.enable = true zookeeper.connection.timeout.ms = 2000 log.roll.ms = 604800000 ``` このコマンドは何も出力しません。出力: ``` { "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" } ``` 詳細については、「*Amazon Managed Streaming for Apache Kafka デベロッパーガイド*」の「[Amazon MSK 設定オペレーション](https://docs.aws.amazon.com/msk/latest/developerguide/msk-configuration-operations.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kafka/create-configuration.html)」を参照してください。 ### `describe-cluster` 次のコード例は、`describe-cluster` を使用する方法を示しています。 **AWS CLI** **クラスターの説明を表示するには** 次の `describe-cluster` の例では、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 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Managed Streaming for Apache Kafka デベロッパーガイド*」の「[Amazon MSK クラスターを一覧表示する](https://docs.aws.amazon.com/msk/latest/developerguide/msk-list-clusters.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kafka/describe-cluster.html)」を参照してください。** ### `get-bootstrap-brokers` 次のコード例は、`get-bootstrap-brokers` を使用する方法を示しています。 **AWS CLI** **ブートストラップブローカーを取得するには** 次の `get-bootstrap-brokers` の例では、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 ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Managed Streaming for Apache Kafka デベロッパーガイド*」の「[ブートストラップブローカーをの取得](https://docs.aws.amazon.com/msk/latest/developerguide/msk-get-bootstrap-brokers.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetBootstrapBrokers](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kafka/get-bootstrap-brokers.html)」を参照してください。 ### `list-clusters` 次のコード例は、`list-clusters` を使用する方法を示しています。 **AWS CLI** **使用可能なクラスターを一覧表示するには** 次の `list-clusters` の例では、AWS アカウントの Amazon MSK クラスターを一覧表示します。 ``` aws kafka list-clusters ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Managed Streaming for Apache Kafka デベロッパーガイド*」の「[Amazon MSK クラスターを一覧表示する](https://docs.aws.amazon.com/msk/latest/developerguide/msk-list-clusters.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[ListClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kafka/list-clusters.html)」を参照してください。** ### `update-broker-storage` 次のコード例は、`update-broker-storage` を使用する方法を示しています。 **AWS CLI** **ブローカーの EBS ストレージを更新するには** 次の `update-broker-storage` の例では、クラスター内のすべてのブローカーの EBS ストレージの量を更新します。Amazon MSK は、各ブローカーのターゲットストレージ量を、例で指定された量に設定します。クラスターの現在のバージョンは、クラスターの説明を表示するか、すべてのクラスターを一覧表示することで取得できます。 ``` 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" ``` 出力は、この `update-broker-storage` オペレーションの ARN を返します。このオペレーションが完了したかどうかを判断するには、この ARN を入力として指定した `describe-cluster-operation` コマンドを使用します。 ``` { "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" } ``` 詳細については、「*Amazon Managed Streaming for Apache Kafka デベロッパーガイド*」の「[ブローカー用 EBS ストレージを更新する](https://docs.aws.amazon.com/msk/latest/developerguide/msk-update-storage.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateBrokerStorage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kafka/update-broker-storage.html)」を参照してください。 ### `update-cluster-configuration` 次のコード例は、`update-cluster-configuration` を使用する方法を示しています。 **AWS CLI** **Amazon MSK クラスターの設定を更新するには** 次の `update-cluster-configuration` の例では、指定された既存の MSK クラスターの設定を更新します。ここでは、カスタム MSK 設定を使用します。 ``` 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" ``` `configuration-info.json` の内容: ``` { "Arn": "arn:aws:kafka:us-west-2:123456789012:configuration/CustomConfiguration/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2", "Revision": 1 } ``` 出力は、この `update-cluster-configuration` オペレーションの ARN を返します。このオペレーションが完了したかどうかを判断するには、この ARN を入力として指定した `describe-cluster-operation` コマンドを使用します。 ``` { "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" } ``` 詳細については、「*Amazon Managed Streaming for Apache Kafka デベロッパーガイド*」の「[Amazon MSK クラスターの設定を更新する](https://docs.aws.amazon.com/msk/latest/developerguide/msk-update-cluster-cofig.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateClusterConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kafka/update-cluster-configuration.html)」を参照してください。 # AWS CLI を使用した Network Flow Monitor の例 次のコード例は、Network Flow Monitor で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-monitor` 次のコード例は、`create-monitor` を使用する方法を示しています。 **AWS CLI** **モニターを作成するには** 次の `create-monitor` の例では、指定したアカウントに `demo` という名前のモニターを作成します。 ``` 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 ``` 出力: ``` { "monitorArn": "arn:aws:networkflowmonitor:us-east-1:123456789012:monitor/demo", "monitorName": "demo", "monitorStatus": "ACTIVE", "tags": {} } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[Network Flow Monitor でモニターを作成する](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-configure-monitors-create.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateMonitor](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/create-monitor.html)」を参照してください。 ### `create-scope` 次のコード例は、`create-scope` を使用する方法を示しています。 **AWS CLI** **スコープを作成するには** 次の `create-scope` の例では、Network Flow Monitor によってネットワークトラフィックメトリクスが生成される対象となるリソースのセットを含むスコープを作成します。 ``` aws networkflowmonitor create-scope \ --targets '[{"targetIdentifier":{"targetId":{"accountId":"123456789012"},"targetType":"ACCOUNT"},"region":"us-east-1"}]' ``` 出力: ``` { "scopeId": "97626f8d-8a21-4b5d-813a-1a0962dd4615", "status": "IN_PROGRESS", "tags": {} } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[Network Flow Monitor のコンポーネントと機能](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-components.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[CreateScope](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/create-scope.html)」を参照してください。 ### `delete-monitor` 次のコード例は、`delete-monitor` を使用する方法を示しています。 **AWS CLI** **モニターを削除するには** 次の `delete-monitor` の例では、指定したアカウントから `demo` という名前のモニターを削除します。 ``` aws networkflowmonitor delete-monitor \ --monitor-name demo ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[Network Flow Monitor でモニターを削除する](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-configure-monitors-delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteMonitor](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/delete-monitor.html)」を参照してください。 ### `delete-scope` 次のコード例は、`delete-scope` を使用する方法を示しています。 **AWS CLI** **スコープを削除するには** 次の `delete-scope` の例では、指定したスコープを削除します。 ``` aws networkflowmonitor delete-scope \ --scope-id fdc20616-6bb4-4242-a24e-a748e65ca7ac ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[Network Flow Monitor のコンポーネントと機能](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-components.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[DeleteScope](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/delete-scope.html)」を参照してください。 ### `get-monitor` 次のコード例は、`get-monitor` を使用する方法を示しています。 **AWS CLI** **モニターに関する情報を取得するには** 次の `get-monitor` の例では、指定されたアカウントの `demo` という名前のモニターに関する情報が表示されます。 ``` aws networkflowmonitor get-monitor \ --monitor-name Demo ``` 出力: ``` { "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": {} } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[Network Flow Monitor のコンポーネントと機能](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-components.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetMonitor](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/get-monitor.html)」を参照してください。 ### `get-query-results-workload-insights-top-contributors-data` 次のコード例は、`get-query-results-workload-insights-top-contributors-data` を使用する方法を示しています。 **AWS CLI** **ワークロードインサイトでトップコントリビューターデータを取得するには** 次の `get-query-results-workload-insights-top-contributors-data` の例では、指定したクエリのデータを返します。 ``` aws networkflowmonitor get-query-results-workload-insights-top-contributors-data \ --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \ --query-id cc4f4ab3-3103-33b8-80ff-d6597a0c6cea ``` 出力: ``` { "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" } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[ワークロードインサイトを使用してネットワークフローを評価する](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-configure-evaluate-flows.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[GetQueryResultsWorkloadInsightsTopContributorsData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/get-query-results-workload-insights-top-contributors-data.html)」を参照してください。 ### `get-query-results-workload-insights-top-contributors` 次のコード例は、`get-query-results-workload-insights-top-contributors` を使用する方法を示しています。 **AWS CLI** **ワークロードインサイトでトップコントリビューターを取得するには** 次の `get-query-results-workload-insights-top-contributors` の例では、指定したクエリのデータを返します。 ``` aws networkflowmonitor get-query-results-workload-insights-top-contributors \ --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \ --query-id 1fc423d3-b144-37a6-80e6-e2c7d26eea0c ``` 出力: ``` { "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" } ] } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[ワークロードインサイトを使用してネットワークフローを評価する](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-configure-evaluate-flows.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[GetQueryResultsWorkloadInsightsTopContributors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/get-query-results-workload-insights-top-contributors.html)」を参照してください。 ### `get-query-status-monitor-top-contributors` 次のコード例は、`get-query-status-monitor-top-contributors` を使用する方法を示しています。 **AWS CLI** **クエリのステータスを取得するには** 次の `get-query-status-monitor-top-contributors` の例では、指定したアカウントのクエリの現在のステータスを表示します。 ``` aws networkflowmonitor get-query-status-monitor-top-contributors \ --monitor-name Demo \ --query-id 5398eabd-bc40-3f5f-aba3-bcb639d3c7ca ``` 出力: ``` { "status": "SUCCEEDED" } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[ワークロードインサイトを使用してネットワークフローを評価する](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-configure-evaluate-flows.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[GetQueryStatusMonitorTopContributors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/get-query-status-monitor-top-contributors.html)」を参照してください。 ### `get-query-status-workload-insights-top-contributors-data` 次のコード例は、`get-query-status-workload-insights-top-contributors-data` を使用する方法を示しています。 **AWS CLI** **クエリのステータスを取得するには** 次の `get-query-status-workload-insights-top-contributors-data` の例では、指定したアカウントのクエリの現在のステータスを表示します。 ``` aws networkflowmonitor get-query-status-workload-insights-top-contributors-data \ --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \ --query-id 4333754d-8ae1-3f29-b6b7-c36db2e7f8ac ``` 出力: ``` { "status": "SUCCEEDED" } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[ワークロードインサイトを使用してネットワークフローを評価する](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-configure-evaluate-flows.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[GetQueryStatusWorkloadInsightsTopContributorsData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/get-query-status-workload-insights-top-contributors-data.html)」を参照してください。 ### `get-query-status-workload-insights-top-contributors` 次のコード例は、`get-query-status-workload-insights-top-contributors` を使用する方法を示しています。 **AWS CLI** **クエリのステータスを取得するには** 次の `get-query-status-workload-insights-top-contributors` の例では、指定したアカウントのクエリの現在のステータスを表示します。 ``` aws networkflowmonitor get-query-status-workload-insights-top-contributors \ --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \ --query-id f2a87c70-3e5a-362e-8beb-4747d13d8419 ``` 出力: ``` { "status": "SUCCEEDED" } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[ワークロードインサイトを使用してネットワークフローを評価する](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-configure-evaluate-flows.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[GetQueryStatusWorkloadInsightsTopContributors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/get-query-status-workload-insights-top-contributors.html)」を参照してください。 ### `get-scope` 次のコード例は、`get-scope` を使用する方法を示しています。 **AWS CLI** **スコープに関する情報を取得するには** 次の `get-scope` の例では、ステータス、タグ、名前、ターゲットの詳細など、スコープに関する情報を表示します。 ``` aws networkflowmonitor get-scope \ --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf ``` 出力: ``` { "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": {} } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[Network Flow Monitor のコンポーネントと機能](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-components.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[GetScope](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/get-scope.html)」を参照してください。 ### `list-monitors` 次のコード例は、`list-monitors` を使用する方法を示しています。 **AWS CLI** **モニターのリストを取得するには** 次の `list-monitors` の例では、指定したアカウントのすべてのモニターを返します。 ``` aws networkflowmonitor list-monitors ``` 出力: ``` { "monitors": [ { "monitorArn": "arn:aws:networkflowmonitor:us-east-1:123456789012:monitor/Demo", "monitorName": "Demo", "monitorStatus": "ACTIVE" } ] } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[Network Flow Monitor のコンポーネントと機能](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-components.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListMonitors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/list-monitors.html)」を参照してください。 ### `list-scopes` 次のコード例は、`list-scopes` を使用する方法を示しています。 **AWS CLI** **スコープのリストを取得するには** 次の `list-scopes` の例では、指定したアカウントのすべてのスコープを一覧表示します。 ``` aws networkflowmonitor list-scopes ``` 出力: ``` { "scopes": [ { "scopeId": "fdc20616-6bb4-4242-a24e-a748e65ca7ac", "status": "SUCCEEDED", "scopeArn": "arn:aws:networkflowmonitor:us-east-1:123456789012:scope/fdc20616-6bb4-4242-a24e-a748e65ca7ac" } ] } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[Network Flow Monitor のコンポーネントと機能](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-components.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[ListScopes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/list-scopes.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **タグを一覧表示するには** 次の `list-tags-for-resource` の例では、指定したリソースに関連付けられているすべてのタグを返します。 ``` aws networkflowmonitor list-tags-for-resource \ --resource-arn arn:aws:networkflowmonitor:us-east-1:123456789012:monitor/Demo ``` 出力: ``` { "tags": { "Value": "Production", "Key": "stack" } } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[Amazon CloudWatch リソースのタグ付け](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/list-tags-for-resource.html)」を参照してください。 ### `start-query-monitor-top-contributors` 次のコード例は、`start-query-monitor-top-contributors` を使用する方法を示しています。 **AWS CLI** **クエリを開始するには** 次の `start-query-monitor-top-contributors` の例では、トップコントリビューターを取得するためのクエリ ID を返すクエリを開始します。 ``` 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 ``` 出力: ``` { "queryId": "aecd3a88-0283-35b0-a17d-6e944dc8531d" } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[ワークロードインサイトを使用してネットワークフローを評価する](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-configure-evaluate-flows.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[StartQueryWorkloadInsightsTopContributorsData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/start-query-monitor-top-contributors.html)」を参照してください。 ### `start-query-workload-insights-top-contributors-data` 次のコード例は、`start-query-workload-insights-top-contributors-data` を使用する方法を示しています。 **AWS CLI** **クエリを開始するには** 次の `start-query-workload-insights-top-contributors-data` の例では、トップコントリビューターを取得するためのクエリ ID を返すクエリを開始します。 ``` 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 ``` 出力: ``` { "queryId": "cc4f4ab3-3103-33b8-80ff-d6597a0c6cea" } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[ワークロードインサイトを使用してネットワークフローを評価する](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-configure-evaluate-flows.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[StartQueryWorkloadInsightsTopContributorsData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/start-query-workload-insights-top-contributors-data.html)」を参照してください。 ### `start-query-workload-insights-top-contributors` 次のコード例は、`start-query-workload-insights-top-contributors` を使用する方法を示しています。 **AWS CLI** **クエリを開始するには** 次の `start-query-workload-insights-top-contributors` の例では、トップコントリビューターを取得するためのクエリ ID を返すクエリを開始します。 ``` 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 ``` 出力: ``` { "queryId": "1fc423d3-b144-37a6-80e6-e2c7d26eea0c" } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[ワークロードインサイトを使用してネットワークフローを評価する](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-configure-evaluate-flows.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[StartQueryWorkloadInsightsTopContributors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/start-query-workload-insights-top-contributors.html)」を参照してください。 ### `stop-query-monitor-top-contributors` 次のコード例は、`stop-query-monitor-top-contributors` を使用する方法を示しています。 **AWS CLI** **クエリを停止するには** 次の `stop-query-monitor-top-contributors` の例では、指定したアカウントのクエリを停止します。 ``` aws networkflowmonitor stop-query-monitor-top-contributors \ --monitor-name Demo \ --query-id aecd3a88-0283-35b0-a17d-6e944dc8531d ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[ワークロードインサイトを使用してネットワークフローを評価する](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-configure-evaluate-flows.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[StopQueryMonitorTopContributors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/stop-query-monitor-top-contributors.html)」を参照してください。 ### `stop-query-workload-insights-top-contributors-data` 次のコード例は、`stop-query-workload-insights-top-contributors-data` を使用する方法を示しています。 **AWS CLI** **クエリを停止するには** 次の `stop-query-workload-insights-top-contributors-data` の例では、指定したアカウントのクエリを停止します。 ``` aws networkflowmonitor stop-query-workload-insights-top-contributors-data \ --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \ --query-id cc4f4ab3-3103-33b8-80ff-d6597a0c6cea ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[ワークロードインサイトを使用してネットワークフローを評価する](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-configure-evaluate-flows.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[StopQueryWorkloadInsightsTopContributorsData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/stop-query-workload-insights-top-contributors-data.html)」を参照してください。 ### `stop-query-workload-insights-top-contributors` 次のコード例は、`stop-query-workload-insights-top-contributors` を使用する方法を示しています。 **AWS CLI** **クエリを停止するには** 次の `stop-query-workload-insights-top-contributors` の例では、指定したアカウントのクエリを停止します。 ``` aws networkflowmonitor stop-query-workload-insights-top-contributors \ --scope-id e21cda79-30a0-4c12-9299-d8629d76d8cf \ --query-id 1fc423d3-b144-37a6-80e6-e2c7d26eea0c ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[ワークロードインサイトを使用してネットワークフローを評価する](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-configure-evaluate-flows.html)」を参照してください。 + API の詳細については、*AWS CLI コマンドリファレンス*の「[StopQueryWorkloadInsightsTopContributors](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/stop-query-workload-insights-top-contributors.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **指定されたリソースにタグを追加する方法** 次の `tag-resource` の例では、指定したアカウントのモニターにタグを追加します。 ``` aws networkflowmonitor tag-resource \ --resource-arn arn:aws:networkflowmonitor:us-east-1:123456789012:monitor/Demo \ --tags Key=stack,Value=Production ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[Amazon CloudWatch リソースのタグ付け](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **指定したリソースからタグを削除するには** 次の `untag-resource` の例では、指定したアカウントのモニターからタグを削除します。 ``` aws networkflowmonitor untag-resource \ --resource-arn arn:aws:networkflowmonitor:us-east-1:123456789012:monitor/Demo \ --tag-keys stack ``` このコマンドでは何も出力されません。 詳細については、*Amazon CloudWatch ユーザーガイド*の「[Amazon CloudWatch リソースのタグ付け](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/untag-resource.html)」を参照してください。 ### `update-monitor` 次のコード例は、`update-monitor` を使用する方法を示しています。 **AWS CLI** **既存のモニターを更新するには** 次の `update-monitor` の例では、指定したアカウントの `Demo` という名前のモニターを更新します。 ``` 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" ``` 出力: ``` { "monitorArn": "arn:aws:networkflowmonitor:us-east-1:123456789012:monitor/Demo", "monitorName": "Demo", "monitorStatus": "ACTIVE", "tags": { "Value": "Production", "Key": "stack" } } ``` 詳細については、*Amazon CloudWatch ユーザーガイド*の「[Network Flow Monitor のコンポーネントと機能](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor-components.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateMonitor](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkflowmonitor/update-monitor.html)」を参照してください。 # AWS CLI を使用した Network Manager の例 次のコード例は、Network Manager で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `associate-customer-gateway` 次のコード例は、`associate-customer-gateway` を使用する方法を示しています。 **AWS CLI** **カスタマーゲートウェイを関連付けるには** 次の `associate-customer-gateway` の例では、指定されたグローバルネットワーク内のカスタマーゲートウェイ `cgw-11223344556677889` をデバイス `device-07f6fd08867abc123` に関連付けます。 ``` aws networkmanager associate-customer-gateway \ --customer-gateway-arn arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-11223344556677889 \ --global-network-id global-network-01231231231231231 \ --device-id device-07f6fd08867abc123 \ --region us-west-2 ``` 出力: ``` { "CustomerGatewayAssociation": { "CustomerGatewayArn": "arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-11223344556677889", "GlobalNetworkId": "global-network-01231231231231231", "DeviceId": "device-07f6fd08867abc123", "State": "PENDING" } } ``` 詳細については、「*Transit Gateway Network Manager Guide*」の「[Customer Gateway Associations](https://docs.aws.amazon.com/vpc/latest/tgw/on-premises-networks.html#cgw-association)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateCustomerGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/associate-customer-gateway.html)」を参照してください。 ### `associate-link` 次のコード例は、`associate-link` を使用する方法を示しています。 **AWS CLI** **リンクを関連付けるには** 次の `associate-link` の例では、リンク `link-11112222aaaabbbb1` をデバイス `device-07f6fd08867abc123` に関連付けます。リンクとデバイスは、指定されたグローバルネットワークにあります。 ``` aws networkmanager associate-link \ --global-network-id global-network-01231231231231231 \ --device-id device-07f6fd08867abc123 \ --link-id link-11112222aaaabbbb1 \ --region us-west-2 ``` 出力: ``` { "LinkAssociation": { "GlobalNetworkId": "global-network-01231231231231231", "DeviceId": "device-07f6fd08867abc123", "LinkId": "link-11112222aaaabbbb1", "LinkAssociationState": "PENDING" } } ``` 詳細については、「*Transit Gateway Network Manager Guide*」の「[Device and Link Associations](https://docs.aws.amazon.com/vpc/latest/tgw/on-premises-networks.html#device-link-association)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AssociateLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/associate-link.html)」を参照してください。 ### `create-core-network` 次のコード例は、`create-core-network` を使用する方法を示しています。 **AWS CLI** **コアネットワークを作成するには** 次の `create-core-network` の例では、AWS Cloud WAN グローバルネットワーク内でオプションの説明とタグを使用してコアネットワークを作成します。 ``` aws networkmanager create-core-network \ --global-network-id global-network-cdef-EXAMPLE22222 \ --description "Main headquarters location" \ --tags Key=Name,Value="New York City office" ``` 出力: ``` { "CoreNetwork": { "GlobalNetworkId": "global-network-cdef-EXAMPLE22222", "CoreNetworkId": "core-network-cdef-EXAMPLE33333", "CoreNetworkArn": "arn:aws:networkmanager::987654321012:core-network/core-network-cdef-EXAMPLE33333", "Description": "Main headquarters location", "CreatedAt": "2022-01-10T19:53:59+00:00", "State": "AVAILABLE", "Tags": [ { "Key": "Name", "Value": "New York City office" } ] } } ``` 詳細については、「*AWS Cloud WAN User Guide*」の「[Global and core networks](https://docs.aws.amazon.com/network-manager/latest/cloudwan/cloudwan-core-network-policy.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCoreNetwork](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/create-core-network.html)」を参照してください。 ### `create-device` 次のコード例は、`create-device` を使用する方法を示しています。 **AWS CLI** **デバイスを作成するには** 次の `create-device` の例では、指定されたグローバルネットワークにデバイスを作成します。デバイスの詳細には、説明、タイプ、ベンダー、モデル、およびシリアル番号が含まれます。 ``` aws networkmanager create-device --global-network-id global-network-01231231231231231 \ --description "New York office device" \ --type "office device" \ --vendor "anycompany" \ --model "abcabc" \ --serial-number "1234" \ --region us-west-2 ``` 出力: ``` { "Device": { "DeviceId": "device-07f6fd08867abc123", "DeviceArn": "arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123", "GlobalNetworkId": "global-network-01231231231231231", "Description": "New York office device", "Type": "office device", "Vendor": "anycompany", "Model": "abcabc", "SerialNumber": "1234", "CreatedAt": 1575554005.0, "State": "PENDING" } } ``` 詳細については、「*Transit Gateway Network Manager Guide*」の「[Working with Devices](https://docs.aws.amazon.com/vpc/latest/tgw/on-premises-networks.html#working-with-devices)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/create-device.html)」を参照してください。 ### `create-global-network` 次のコード例は、`create-global-network` を使用する方法を示しています。 **AWS CLI** **グローバルネットワークを作成するには** 次の `create-global-network` の例では、新しいグローバルネットワークを作成します。作成時の初期状態は `PENDING` です。 ``` aws networkmanager create-global-network ``` 出力: ``` { "GlobalNetwork": { "GlobalNetworkId": "global-network-00a77fc0f722dae74", "GlobalNetworkArn": "arn:aws:networkmanager::987654321012:global-network/global-network-00a77fc0f722dae74", "CreatedAt": "2022-03-14T20:31:56+00:00", "State": "PENDING" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateGlobalNetwork](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/create-global-network.html)」を参照してください。 ### `create-link` 次のコード例は、`create-link` を使用する方法を示しています。 **AWS CLI** **リンクを作成するには** 次の `create-link` の例では、指定されたグローバルネットワークにリンクを作成します。リンクには、リンクタイプ、帯域幅、プロバイダーの説明と詳細が含まれます。サイト ID は、リンクが関連付けられているサイトを示します。 ``` aws networkmanager create-link \ --global-network-id global-network-01231231231231231 \ --description "VPN Link" \ --type "broadband" \ --bandwidth UploadSpeed=10,DownloadSpeed=20 \ --provider "AnyCompany" \ --site-id site-444555aaabbb11223 \ --region us-west-2 ``` 出力: ``` { "Link": { "LinkId": "link-11112222aaaabbbb1", "LinkArn": "arn:aws:networkmanager::123456789012:link/global-network-01231231231231231/link-11112222aaaabbbb1", "GlobalNetworkId": "global-network-01231231231231231", "SiteId": "site-444555aaabbb11223", "Description": "VPN Link", "Type": "broadband", "Bandwidth": { "UploadSpeed": 10, "DownloadSpeed": 20 }, "Provider": "AnyCompany", "CreatedAt": 1575555811.0, "State": "PENDING" } } ``` 詳細については、「*Transit Gateway Network Manager Guide*」の「[Working with Links](https://docs.aws.amazon.com/vpc/latest/tgw/on-premises-networks.html#working-with-links)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/create-link.html)」を参照してください。 ### `create-site` 次のコード例は、`create-site` を使用する方法を示しています。 **AWS CLI** **サイトを作成するには** 次の `create-site` の例では、指定されたグローバルネットワークにサイトを作成します。サイトの詳細には、説明と位置情報が含まれます。 ``` aws networkmanager create-site \ --global-network-id global-network-01231231231231231 \ --description "New York head office" \ --location Latitude=40.7128,Longitude=-74.0060 \ --region us-west-2 ``` 出力: ``` { "Site": { "SiteId": "site-444555aaabbb11223", "SiteArn": "arn:aws:networkmanager::123456789012:site/global-network-01231231231231231/site-444555aaabbb11223", "GlobalNetworkId": "global-network-01231231231231231", "Description": "New York head office", "Location": { "Latitude": "40.7128", "Longitude": "-74.0060" }, "CreatedAt": 1575554300.0, "State": "PENDING" } } ``` 詳細については、「*Transit Gateway Network Manager Guide*」の「[Working with Sites](https://docs.aws.amazon.com/vpc/latest/tgw/on-premises-networks.html#working-with-sites)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateSite](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/create-site.html)」を参照してください。 ### `create-vpc-attachment` 次のコード例は、`create-vpc-attachment` を使用する方法を示しています。 **AWS CLI** **VPC アタッチメントを作成するには** 次の `create-vpc-attachment` の例では、コアネットワークで IPv6 をサポートする VPC アタッチメントを作成します。 ``` aws networkmanager create-vpc-attachment \ --core-network-id core-network-0fab62fe438d94db6 \ --vpc-arn arn:aws:ec2:us-east-1:987654321012:vpc/vpc-09f37f69e2786eeb8 \ --subnet-arns arn:aws:ec2:us-east-1:987654321012:subnet/subnet-04ca4e010857e7bb7 \ --Ipv6Support=true ``` 出力: ``` { "VpcAttachment": { "Attachment": { "CoreNetworkId": "core-network-0fab62fe438d94db6", "AttachmentId": "attachment-05e1da6eba87a06e6", "OwnerAccountId": "987654321012", "AttachmentType": "VPC", "State": "CREATING", "EdgeLocation": "us-east-1", "ResourceArn": "arn:aws:ec2:us-east-1:987654321012:vpc/vpc-09f37f69e2786eeb8", "Tags": [], "CreatedAt": "2022-03-10T20:59:14+00:00", "UpdatedAt": "2022-03-10T20:59:14+00:00" }, "SubnetArns": [ "arn:aws:ec2:us-east-1:987654321012:subnet/subnet-04ca4e010857e7bb7" ], "Options": { "Ipv6Support": true } } } ``` 詳細については、「*Cloud WAN User Guide*」の「[Create an attachment](https://docs.aws.amazon.com/vpc/latest/cloudwan/cloudwan-create-attachment.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateVpcAttachment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/create-vpc-attachment.html)」を参照してください。 ### `delete-attachment` 次のコード例は、`delete-attachment` を使用する方法を示しています。 **AWS CLI** **アタッチメントを削除するには** 次の `delete-attachment` の例では、Connect アタッチメントを削除します。 ``` aws networkmanager delete-attachment \ --attachment-id attachment-01feddaeae26ab68c ``` 出力: ``` { "Attachment": { "CoreNetworkId": "core-network-0f4b0a9d5ee7761d1", "AttachmentId": "attachment-01feddaeae26ab68c", "OwnerAccountId": "987654321012", "AttachmentType": "CONNECT", "State": "DELETING", "EdgeLocation": "us-east-1", "ResourceArn": "arn:aws:networkmanager::987654321012:attachment/attachment-02c3964448fedf5aa", "CreatedAt": "2022-03-15T19:18:41+00:00", "UpdatedAt": "2022-03-15T19:28:59+00:00" } } ``` 詳細については、「*Cloud WAN User Guide*」の「[Delete attachments](https://docs.aws.amazon.com/vpc/latest/cloudwan/cloudwan-attachments-working-with.html#cloudwan-attachments-deleting)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteAttachment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/delete-attachment.html)」を参照してください。 ### `delete-bucket-analytics-configuration` 次のコード例は、`delete-bucket-analytics-configuration` を使用する方法を示しています。 **AWS CLI** **バケットの分析設定を削除するには** 次の `delete-bucket-analytics-configuration` の例では、指定されたバケットと ID の分析設定を削除します。 ``` aws s3api delete-bucket-analytics-configuration \ --bucket amzn-s3-demo-bucket \ --id 1 ``` このコマンドでは何も出力されません。 + API の詳細については、「**AWS CLI コマンドリファレンス」の「[DeleteBucketAnalyticsConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/delete-bucket-analytics-configuration.html)」を参照してください。 ### `delete-bucket-metrics-configuration` 次のコード例は、`delete-bucket-metrics-configuration` を使用する方法を示しています。 **AWS CLI** **バケットのメトリクス設定を削除するには** 次の `delete-bucket-metrics-configuration` の例では、指定したバケットと ID のメトリクス設定を削除します。 ``` aws s3api delete-bucket-metrics-configuration \ --bucket amzn-s3-demo-bucket \ --id 123 ``` このコマンドでは何も出力されません。 + API の詳細については、「**AWS CLI コマンドリファレンス」の「[DeleteBucketMetricsConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/delete-bucket-metrics-configuration.html)」を参照してください。 ### `delete-core-network` 次のコード例は、`delete-core-network` を使用する方法を示しています。 **AWS CLI** **コアネットワークを削除するには** 次の `delete-core-network` の例では、Cloud WAN グローバルネットワークからコアネットワークを削除します。 ``` aws networkmanager delete-core-network \ --core-network-id core-network-0fab62fe438d94db6 ``` 出力: ``` { "CoreNetwork": { "GlobalNetworkId": "global-network-0d59060f16a73bc41", "CoreNetworkId": "core-network-0fab62fe438d94db6", "Description": "Main headquarters location", "CreatedAt": "2021-12-09T18:31:11+00:00", "State": "DELETING", "Segments": [ { "Name": "dev", "EdgeLocations": [ "us-east-1" ], "SharedSegments": [] } ], "Edges": [ { "EdgeLocation": "us-east-1", "Asn": 64512, "InsideCidrBlocks": [] } ] } } ``` 詳細については、「*Cloud WAN User Guide*」の「[Core networks](https://docs.aws.amazon.com/vpc/latest/cloudwan/cloudwan-networks-working-with.html#cloudwan-core-networks)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCoreNetwork](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/delete-core-network.html)」を参照してください。 ### `delete-device` 次のコード例は、`delete-device` を使用する方法を示しています。 **AWS CLI** **デバイスを削除するには** 次の `delete-device` の例では、指定されたグローバルネットワークから、指定されたデバイスを削除します。 ``` aws networkmanager delete-device \ --global-network-id global-network-01231231231231231 \ --device-id device-07f6fd08867abc123 \ --region us-west-2 ``` 出力: ``` { "Device": { "DeviceId": "device-07f6fd08867abc123", "DeviceArn": "arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123", "GlobalNetworkId": "global-network-01231231231231231", "Description": "New York office device", "Type": "office device", "Vendor": "anycompany", "Model": "abcabc", "SerialNumber": "1234", "SiteId": "site-444555aaabbb11223", "CreatedAt": 1575554005.0, "State": "DELETING" } } ``` 詳細については、「*Transit Gateway Network Manager Guide*」の「[Working with Devices](https://docs.aws.amazon.com/vpc/latest/tgw/on-premises-networks.html#working-with-devices)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/delete-device.html)」を参照してください。 ### `delete-global-network` 次のコード例は、`delete-global-network` を使用する方法を示しています。 **AWS CLI** **グローバルネットワークを削除するには** 次の `delete-global-network` の例では、グローバルネットワークを削除します。 ``` aws networkmanager delete-global-network \ --global-network-id global-network-052bedddccb193b6b ``` 出力: ``` { "GlobalNetwork": { "GlobalNetworkId": "global-network-052bedddccb193b6b", "GlobalNetworkArn": "arn:aws:networkmanager::987654321012:global-network/global-network-052bedddccb193b6b", "CreatedAt": "2021-12-09T18:19:12+00:00", "State": "DELETING" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteGlobalNetwork](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/delete-global-network.html)」を参照してください。 ### `delete-link` 次のコード例は、`delete-link` を使用する方法を示しています。 **AWS CLI** **リンクを削除するには** 次の `delete-link` の例では、指定されたグローバルネットワークから、指定されたリンクを削除します。 ``` aws networkmanager delete-link \ --global-network-id global-network-01231231231231231 \ --link-id link-11112222aaaabbbb1 \ --region us-west-2 ``` 出力: ``` { "Link": { "LinkId": "link-11112222aaaabbbb1", "LinkArn": "arn:aws:networkmanager::123456789012:link/global-network-01231231231231231/link-11112222aaaabbbb1", "GlobalNetworkId": "global-network-01231231231231231", "SiteId": "site-444555aaabbb11223", "Description": "VPN Link", "Type": "broadband", "Bandwidth": { "UploadSpeed": 20, "DownloadSpeed": 20 }, "Provider": "AnyCompany", "CreatedAt": 1575555811.0, "State": "DELETING" } } ``` 詳細については、「*Transit Gateway Network Manager Guide*」の「[Working with Links](https://docs.aws.amazon.com/vpc/latest/tgw/on-premises-networks.html#working-with-links)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/delete-link.html)」を参照してください。 ### `delete-public-access-block` 次のコード例は、`delete-public-access-block` を使用する方法を示しています。 **AWS CLI** **バケットのブロックパブリックアクセス設定を削除するには** 次の `delete-public-access-block` の例では、指定したバケットのブロックパブリックアクセス設定を削除します。 ``` aws s3api delete-public-access-block \ --bucket amzn-s3-demo-bucket ``` このコマンドでは何も出力されません。 + API の詳細については、「**AWS CLI コマンドリファレンス」の「[DeletePublicAccessBlock](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/delete-public-access-block.html)」を参照してください。 ### `delete-site` 次のコード例は、`delete-site` を使用する方法を示しています。 **AWS CLI** **サイトを削除するには** 次の `delete-site` の例では、指定されたグローバルネットワークで、指定されたサイト (`site-444555aaabbb11223`) を削除します。 ``` aws networkmanager delete-site \ --global-network-id global-network-01231231231231231 \ --site-id site-444555aaabbb11223 \ --region us-west-2 ``` 出力: ``` { "Site": { "SiteId": "site-444555aaabbb11223", "SiteArn": "arn:aws:networkmanager::123456789012:site/global-network-01231231231231231/site-444555aaabbb11223", "GlobalNetworkId": "global-network-01231231231231231", "Description": "New York head office", "Location": { "Latitude": "40.7128", "Longitude": "-74.0060" }, "CreatedAt": 1575554300.0, "State": "DELETING" } } ``` 詳細については、「*Transit Gateway Network Manager Guide*」の「[Working with Sites](https://docs.aws.amazon.com/vpc/latest/tgw/on-premises-networks.html#working-with-sites)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteSite](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/delete-site.html)」を参照してください。 ### `deregister-transit-gateway` 次のコード例は、`deregister-transit-gateway` を使用する方法を示しています。 **AWS CLI** **グローバルネットワークからトランジットゲートウェイを登録解除するには** 次の `deregister-transit-gateway` の例では、指定されたグローバルネットワークから、指定されたトランジットゲートウェイの登録を解除します。 ``` aws networkmanager deregister-transit-gateway \ --global-network-id global-network-01231231231231231 \ --transit-gateway-arn arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc \ --region us-west-2 ``` 出力: ``` { "TransitGatewayRegistration": { "GlobalNetworkId": "global-network-01231231231231231", "TransitGatewayArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc", "State": { "Code": "DELETING" } } } ``` 詳細については、「*Transit Gateway Network Manager Guide*」の「[Transit Gateway Registrations](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-registrations.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeregisterTransitGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/deregister-transit-gateway.html)」を参照してください。 ### `describe-global-networks` 次のコード例は、`describe-global-networks` を使用する方法を示しています。 **AWS CLI** **グローバルネットワークについて説明するには** 次の `describe-global-networks` の例では、アカウント内のすべてのグローバルネットワークについて説明します。 ``` aws networkmanager describe-global-networks \ --region us-west-2 ``` 出力: ``` { "GlobalNetworks": [ { "GlobalNetworkId": "global-network-01231231231231231", "GlobalNetworkArn": "arn:aws:networkmanager::123456789012:global-network/global-network-01231231231231231", "Description": "Company 1 global network", "CreatedAt": 1575553525.0, "State": "AVAILABLE" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeGlobalNetworks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/describe-global-networks.html)」を参照してください。 ### `disassociate-customer-gateway` 次のコード例は、`disassociate-customer-gateway` を使用する方法を示しています。 **AWS CLI** **カスタマーゲートウェイの関連付けを解除するには** 次の `disassociate-customer-gateway` の例では、指定されたカスタマーゲートウェイ (`cgw-11223344556677889`) の関連付けを、指定されたグローバルネットワークから解除します。 ``` aws networkmanager disassociate-customer-gateway \ --global-network-id global-network-01231231231231231 \ --customer-gateway-arn arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-11223344556677889 \ --region us-west-2 ``` 出力: ``` { "CustomerGatewayAssociation": { "CustomerGatewayArn": "arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-11223344556677889", "GlobalNetworkId": "global-network-01231231231231231", "DeviceId": "device-07f6fd08867abc123", "State": "DELETING" } } ``` 詳細については、「*Transit Gateway Network Manager Guide*」の「[Customer Gateway Associations](https://docs.aws.amazon.com/vpc/latest/tgw/on-premises-networks.html#cgw-association)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateCustomerGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/disassociate-customer-gateway.html)」を参照してください。 ### `disassociate-link` 次のコード例は、`disassociate-link` を使用する方法を示しています。 **AWS CLI** **リンクの関連付けを解除するには** 次の `disassociate-link` の例では、指定されたグローバルネットワークのデバイス `device-07f6fd08867abc123` から、指定されたリンクの関連付けを解除します。 ``` aws networkmanager disassociate-link \ --global-network-id global-network-01231231231231231 \ --device-id device-07f6fd08867abc123 \ --link-id link-11112222aaaabbbb1 \ --region us-west-2 ``` 出力: ``` { "LinkAssociation": { "GlobalNetworkId": "global-network-01231231231231231", "DeviceId": "device-07f6fd08867abc123", "LinkId": "link-11112222aaaabbbb1", "LinkAssociationState": "DELETING" } } ``` 詳細については、「*Transit Gateway Network Manager Guide*」の「[Device and Link Associations](https://docs.aws.amazon.com/vpc/latest/tgw/on-premises-networks.html#device-link-association)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisassociateLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/disassociate-link.html)」を参照してください。 ### `get-bucket-analytics-configuration` 次のコード例は、`get-bucket-analytics-configuration` を使用する方法を示しています。 **AWS CLI** **特定の ID を持つバケットの分析設定を取得するには** 次の `get-bucket-analytics-configuration` の例では、指定されたバケットと ID の分析設定を表示します。 ``` aws s3api get-bucket-analytics-configuration \ --bucket amzn-s3-demo-bucket \ --id 1 ``` 出力: ``` { "AnalyticsConfiguration": { "StorageClassAnalysis": {}, "Id": "1" } } ``` + API の詳細については、「**AWS CLI コマンドリファレンス」の「[GetBucketAnalyticsConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/get-bucket-analytics-configuration.html)」を参照してください。 ### `get-bucket-metrics-configuration` 次のコード例は、`get-bucket-metrics-configuration` を使用する方法を示しています。 **AWS CLI** **特定の ID を持つバケットのメトリクス設定を取得するには** 次の `get-bucket-metrics-configuration` の例では、指定したバケットと ID のメトリクス設定を表示します。 ``` aws s3api get-bucket-metrics-configuration \ --bucket amzn-s3-demo-bucket \ --id 123 ``` 出力: ``` { "MetricsConfiguration": { "Filter": { "Prefix": "logs" }, "Id": "123" } } ``` + API の詳細については、「**AWS CLI コマンドリファレンス」の「[GetBucketMetricsConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/get-bucket-metrics-configuration.html)」を参照してください。 ### `get-customer-gateway-associations` 次のコード例は、`get-customer-gateway-associations` を使用する方法を示しています。 **AWS CLI** **カスタマーゲートウェイの関連付けを取得するには** 次の `get-customer-gateway-associations` の例では、指定されたグローバルネットワークのカスタマーゲートウェイの関連付けを取得します。 ``` aws networkmanager get-customer-gateway-associations \ --global-network-id global-network-01231231231231231 \ --region us-west-2 ``` 出力: ``` { "CustomerGatewayAssociations": [ { "CustomerGatewayArn": "arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-11223344556677889", "GlobalNetworkId": "global-network-01231231231231231", "DeviceId": "device-07f6fd08867abc123", "State": "AVAILABLE" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetCustomerGatewayAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/get-customer-gateway-associations.html)」を参照してください。 ### `get-devices` 次のコード例は、`get-devices` を使用する方法を示しています。 **AWS CLI** **デバイスを取得するには** 次の `get-devices` の例では、指定されたグローバルネットワークでデバイスを取得します。 ``` aws networkmanager get-devices \ --global-network-id global-network-01231231231231231 \ --region us-west-2 ``` 出力: ``` { "Devices": [ { "DeviceId": "device-07f6fd08867abc123", "DeviceArn": "arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123", "GlobalNetworkId": "global-network-01231231231231231", "Description": "NY office device", "Type": "office device", "Vendor": "anycompany", "Model": "abcabc", "SerialNumber": "1234", "CreatedAt": 1575554005.0, "State": "AVAILABLE" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDevices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/get-devices.html)」を参照してください。 ### `get-link-associations` 次のコード例は、`get-link-associations` を使用する方法を示しています。 **AWS CLI** **リンクの関連付けを取得するには** 次の `get-link-associations` の例では、指定されたグローバルネットワークでリンクの関連付けを取得します。 ``` aws networkmanager get-link-associations \ --global-network-id global-network-01231231231231231 \ --region us-west-2 ``` 出力: ``` { "LinkAssociations": [ { "GlobalNetworkId": "global-network-01231231231231231", "DeviceId": "device-07f6fd08867abc123", "LinkId": "link-11112222aaaabbbb1", "LinkAssociationState": "AVAILABLE" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetLinkAssociations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/get-link-associations.html)」を参照してください。 ### `get-links` 次のコード例は、`get-links` を使用する方法を示しています。 **AWS CLI** **リンクを取得するには** 次の `get-links` の例では、指定されたグローバルネットワークでリンクを取得します。 ``` aws networkmanager get-links \ --global-network-id global-network-01231231231231231 \ --region us-west-2 ``` 出力: ``` { "Links": [ { "LinkId": "link-11112222aaaabbbb1", "LinkArn": "arn:aws:networkmanager::123456789012:link/global-network-01231231231231231/link-11112222aaaabbbb1", "GlobalNetworkId": "global-network-01231231231231231", "SiteId": "site-444555aaabbb11223", "Description": "VPN Link", "Type": "broadband", "Bandwidth": { "UploadSpeed": 10, "DownloadSpeed": 20 }, "Provider": "AnyCompany", "CreatedAt": 1575555811.0, "State": "AVAILABLE" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetLinks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/get-links.html)」を参照してください。 ### `get-object-retention` 次のコード例は、`get-object-retention` を使用する方法を示しています。 **AWS CLI** **オブジェクトのオブジェクト保持設定を取得するには** 次の `get-object-retention` の例では、指定されたオブジェクトの保持設定を取得します。 ``` aws s3api get-object-retention \ --bucket amzn-s3-demo-bucket-with-object-lock \ --key doc1.rtf ``` 出力: ``` { "Retention": { "Mode": "GOVERNANCE", "RetainUntilDate": "2025-01-01T00:00:00.000Z" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetObjectRetention](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/get-object-retention.html)」を参照してください。 ### `get-public-access-block` 次のコード例は、`get-public-access-block` を使用する方法を示しています。 **AWS CLI** **バケットのブロックパブリックアクセス設定を指定または削除するには** 次の `get-public-access-block` の例では、指定したバケットのブロックパブリックアクセス設定を表示します。 ``` aws s3api get-public-access-block --bucket amzn-s3-demo-bucket ``` 出力: ``` { "PublicAccessBlockConfiguration": { "IgnorePublicAcls": true, "BlockPublicPolicy": true, "BlockPublicAcls": true, "RestrictPublicBuckets": true } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPublicAccessBlock](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/get-public-access-block.html)」を参照してください。 ### `get-sites` 次のコード例は、`get-sites` を使用する方法を示しています。 **AWS CLI** **サイトを取得するには** 次の `get-sites` の例では、指定されたグローバルネットワークでサイトを取得します。 ``` aws networkmanager get-sites \ --global-network-id global-network-01231231231231231 \ --region us-west-2 ``` 出力: ``` { "Sites": [ { "SiteId": "site-444555aaabbb11223", "SiteArn": "arn:aws:networkmanager::123456789012:site/global-network-01231231231231231/site-444555aaabbb11223", "GlobalNetworkId": "global-network-01231231231231231", "Description": "NY head office", "Location": { "Latitude": "40.7128", "Longitude": "-74.0060" }, "CreatedAt": 1575554528.0, "State": "AVAILABLE" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetSites](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/get-sites.html)」を参照してください。 ### `get-transit-gateway-registrations` 次のコード例は、`get-transit-gateway-registrations` を使用する方法を示しています。 **AWS CLI** **トランジットゲートウェイの登録を取得するには** 次の `get-transit-gateway-registrations` の例では、指定されたグローバルネットワークに登録されているトランジットゲートウェイを取得します。 ``` aws networkmanager get-transit-gateway-registrations \ --global-network-id global-network-01231231231231231 \ --region us-west-2 ``` 出力: ``` { "TransitGatewayRegistrations": [ { "GlobalNetworkId": "global-network-01231231231231231", "TransitGatewayArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc", "State": { "Code": "AVAILABLE" } } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetTransitGatewayRegistrations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/get-transit-gateway-registrations.html)」を参照してください。 ### `get-vpc-attachment` 次の例は、`get-vpc-attachment` を使用する方法を説明しています。 **AWS CLI** **VPC アタッチメントを取得するには** 次の `get-vpc-attachment` の例では、VPC アタッチメントに関する情報を返します。　 ``` aws networkmanager get-vpc-attachment \ --attachment-id attachment-03b7ea450134787da ``` 出力: ``` { "VpcAttachment": { "Attachment": { "CoreNetworkId": "core-network-0522de1b226a5d7b3", "AttachmentId": "attachment-03b7ea450134787da", "OwnerAccountId": "987654321012", "AttachmentType": "VPC", "State": "CREATING", "EdgeLocation": "us-east-1", "ResourceArn": "arn:aws:ec2:us-east-1:987654321012:vpc/vpc-a7c4bbda", "Tags": [ { "Key": "Name", "Value": "DevVPC" } ], "CreatedAt": "2022-03-11T17:48:58+00:00", "UpdatedAt": "2022-03-11T17:48:58+00:00" }, "SubnetArns": [ "arn:aws:ec2:us-east-1:987654321012:subnet/subnet-202cde6c", "arn:aws:ec2:us-east-1:987654321012:subnet/subnet-e5022dba", "arn:aws:ec2:us-east-1:987654321012:subnet/subnet-2387ae02", "arn:aws:ec2:us-east-1:987654321012:subnet/subnet-cda9dffc" ], "Options": { "Ipv6Support": false } } } ``` 詳細については、「*Cloud WAN User Guide*」の「[Attachments](https://docs.aws.amazon.com/vpc/latest/cloudwan/cloudwan-attachments-working-with.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetVpcAttachment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/get-vpc-attachment.html)」を参照してください。 ### `list-bucket-analytics-configurations` 次のコード例は、`list-bucket-analytics-configurations` を使用する方法を示しています。 **AWS CLI** **バケットの分析設定のリストを取得するには** 次の `list-bucket-analytics-configurations` の例では、指定したバケットの分析設定のリストを取得します。 ``` aws s3api list-bucket-analytics-configurations \ --bucket amzn-s3-demo-bucket ``` 出力: ``` { "AnalyticsConfigurationList": [ { "StorageClassAnalysis": {}, "Id": "1" } ], "IsTruncated": false } ``` + API の詳細については、「**AWS CLI コマンドリファレンス」の「[ListBucketAnalyticsConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/list-bucket-analytics-configurations.html)」を参照してください。 ### `list-bucket-metrics-configurations` 次のコード例は、`list-bucket-metrics-configurations` を使用する方法を示しています。 **AWS CLI** **バケットのメトリクス設定のリストを取得するには** 次の `list-bucket-metrics-configurations` の例では、指定されたバケットのメトリクス設定のリストを取得します。 ``` aws s3api list-bucket-metrics-configurations \ --bucket amzn-s3-demo-bucket ``` 出力: ``` { "IsTruncated": false, "MetricsConfigurationList": [ { "Filter": { "Prefix": "logs" }, "Id": "123" }, { "Filter": { "Prefix": "tmp" }, "Id": "234" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListBucketMetricsConfigurations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/list-bucket-metrics-configurations.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **リソースのタグを一覧表示するには** 次の `list-tags-for-resource` の例では、指定されたデバイスリソース (`device-07f6fd08867abc123`) のタグを一覧表示します。 ``` aws networkmanager list-tags-for-resource \ --resource-arn arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123 \ --region us-west-2 ``` 出力: ``` { "TagList": [ { "Key": "Network", "Value": "Northeast" } ] } ``` + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/list-tags-for-resource.html)」を参照してください。 ### `put-bucket-metrics-configuration` 次のコード例は、`put-bucket-metrics-configuration` を使用する方法を示しています。 **AWS CLI** **バケットのメトリクス設定を指定するには** 次の `put-bucket-metrics-configuration` の例では、指定されたバケットに対して ID 123 のメトリクス設定を指定します。 ``` aws s3api put-bucket-metrics-configuration \ --bucket amzn-s3-demo-bucket \ --id 123 \ --metrics-configuration '{"Id": "123", "Filter": {"Prefix": "logs"}}' ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutBucketMetricsConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/put-bucket-metrics-configuration.html)」を参照してください。 ### `put-object-retention` 次のコード例は、`put-object-retention` を使用する方法を示しています。 **AWS CLI** **オブジェクトのオブジェクト保持設定を指定するには** 次の `put-object-retention` の例では、指定されたオブジェクトのオブジェクト保持設定を 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" }' ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutObjectRetention](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/put-object-retention.html)」を参照してください。 ### `put-public-access-block` 次のコード例は、`put-public-access-block` を使用する方法を示しています。 **AWS CLI** **バケットのブロックパブリックアクセス設定を指定するには** 次の `put-public-access-block` の例では、指定されたバケットの制限ブロックパブリックアクセス設定を指定します。 ``` aws s3api put-public-access-block \ --bucket amzn-s3-demo-bucket \ --public-access-block-configuration "BlockPublicAcls=true,IgnorePublicAcls=true,BlockPublicPolicy=true,RestrictPublicBuckets=true" ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PutPublicAccessBlock](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/put-public-access-block.html)」を参照してください。 ### `register-transit-gateway` 次のコード例は、`register-transit-gateway` を使用する方法を示しています。 **AWS CLI** **トランジットゲートウェイをグローバルネットワークに登録するには** 次の `register-transit-gateway` の例では、指定されたグローバルネットワークにトランジットゲートウェイ `tgw-123abc05e04123abc` を登録します。 ``` aws networkmanager register-transit-gateway \ --global-network-id global-network-01231231231231231 \ --transit-gateway-arn arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc \ --region us-west-2 ``` 出力: ``` { "TransitGatewayRegistration": { "GlobalNetworkId": "global-network-01231231231231231", "TransitGatewayArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc", "State": { "Code": "PENDING" } } } ``` 詳細については、「*Transit Gateway Network Manager Guide*」の「[Transit Gateway Registrations](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-registrations.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegisterTransitGateway](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/register-transit-gateway.html)」を参照してください。 ### `reject-attachment` 次のコード例は、`reject-attachment` を使用する方法を示しています。 **AWS CLI** **アタッチメントを拒否するには** 次の `reject-attachment` の例では、VPC アタッチメントリクエストを拒否します。 ``` aws networkmanager reject-attachment \ --attachment-id attachment-03b7ea450134787da ``` 出力: ``` { "Attachment": { "CoreNetworkId": "core-network-0522de1b226a5d7b3", "AttachmentId": "attachment-03b7ea450134787da", "OwnerAccountId": "987654321012", "AttachmentType": "VPC", "State": "AVAILABLE", "EdgeLocation": "us-east-1", "ResourceArn": "arn:aws:ec2:us-east-1:987654321012:vpc/vpc-a7c4bbda", "CreatedAt": "2022-03-11T17:48:58+00:00", "UpdatedAt": "2022-03-11T17:51:25+00:00" } } ``` 詳細については、「*Cloud WAN User Guide*」の「[Attachment acceptance](https://docs.aws.amazon.com/vpc/latest/cloudwan/cloudwan-attachments-working-with.html#cloudwan-attachments-acceptance)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RejectAttachment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/reject-attachment.html)」を参照してください。 ### `start-route-analysis` 次のコード例は、`start-route-analysis` を使用する方法を示しています。 **AWS CLI** **ルート分析を開始するには** 次の `start-route-analysis` の例では、オプションの `include-return-path` など、ソースと宛先間の分析を開始します。 ``` aws networkmanager start-route-analysis \ --global-network-id global-network-00aa0aaa0b0aaa000 \ --source TransitGatewayAttachmentArn=arn:aws:ec2:us-east-1:503089527312:transit-gateway-attachment/tgw-attach-0d4a2d491bf68c093,IpAddress=10.0.0.0 \ --destination TransitGatewayAttachmentArn=arn:aws:ec2:us-west-1:503089527312:transit-gateway-attachment/tgw-attach-002577f30bb181742,IpAddress=11.0.0.0 \ --include-return-path ``` 出力: ``` { "RouteAnalysis": { "GlobalNetworkId": "global-network-00aa0aaa0b0aaa000 "OwnerAccountId": "1111222233333", "RouteAnalysisId": "a1873de1-273c-470c-1a2bc2345678", "StartTimestamp": 1695760154.0, "Status": "RUNNING", "Source": { "TransitGatewayAttachmentArn": "arn:aws:ec2:us-east-1:111122223333:transit-gateway-attachment/tgw-attach-1234567890abcdef0, "TransitGatewayArn": "arn:aws:ec2:us-east-1:111122223333:transit-gateway/tgw-abcdef01234567890", "IpAddress": "10.0.0.0" }, "Destination": { "TransitGatewayAttachmentArn": "arn:aws:ec2:us-west-1:555555555555:transit-gateway-attachment/tgw-attach-021345abcdef6789", "TransitGatewayArn": "arn:aws:ec2:us-west-1:111122223333:transit-gateway/tgw-09876543210fedcba0", "IpAddress": "11.0.0.0" }, "IncludeReturnPath": true, "UseMiddleboxes": false } } ``` 詳細については、「*AWS Global Networks for Transit Gateways User Guide*」の「[Route Analyzer](https://docs.aws.amazon.com/network-manager/latest/tgwnm/route-analyzer.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartRouteAnalysis](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/start-route-analysis.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **リソースにタグを適用するには** 次の `tag-resource` の例では、タグ `Network=Northeast` をデバイス `device-07f6fd08867abc123` に適用します。 ``` aws networkmanager tag-resource \ --resource-arn arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123 \ --tags Key=Network,Value=Northeast \ --region us-west-2 ``` このコマンドでは何も出力されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **リソースからタグを削除する** 次の `untag-resource` の例では、キー `Network` のタグをデバイス `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 ``` このコマンドでは何も出力されません。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/untag-resource.html)」を参照してください。 ### `update-device` 次のコード例は、`update-device` を使用する方法を示しています。 **AWS CLI** **デバイスを更新するには** 次の `update-device` の例では、デバイスのサイト ID を指定してデバイス `device-07f6fd08867abc123` を更新します。 ``` aws networkmanager update-device \ --global-network-id global-network-01231231231231231 \ --device-id device-07f6fd08867abc123 \ --site-id site-444555aaabbb11223 \ --region us-west-2 ``` 出力: ``` { "Device": { "DeviceId": "device-07f6fd08867abc123", "DeviceArn": "arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123", "GlobalNetworkId": "global-network-01231231231231231", "Description": "NY office device", "Type": "Office device", "Vendor": "anycompany", "Model": "abcabc", "SerialNumber": "1234", "SiteId": "site-444555aaabbb11223", "CreatedAt": 1575554005.0, "State": "UPDATING" } } ``` 詳細については、「*Transit Gateway Network Manager Guide*」の「[Working with Devices](https://docs.aws.amazon.com/vpc/latest/tgw/on-premises-networks.html#working-with-devices)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateDevice](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/update-device.html)」を参照してください。 ### `update-global-network` 次のコード例は、`update-global-network` を使用する方法を示しています。 **AWS CLI** **グローバルネットワークを更新するには** 次の `update-global-network` の例では、グローバルネットワーク `global-network-01231231231231231` の説明を更新します。 ``` aws networkmanager update-global-network \ --global-network-id global-network-01231231231231231 \ --description "Head offices" \ --region us-west-2 ``` 出力: ``` { "GlobalNetwork": { "GlobalNetworkId": "global-network-01231231231231231", "GlobalNetworkArn": "arn:aws:networkmanager::123456789012:global-network/global-network-01231231231231231", "Description": "Head offices", "CreatedAt": 1575553525.0, "State": "UPDATING" } } ``` 詳細については、「*Transit Gateway Network Manager Guide*」の「[Global Networks](https://docs.aws.amazon.com/vpc/latest/tgw/global-networks.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateGlobalNetwork](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/update-global-network.html)」を参照してください。 ### `update-link` 次のコード例は、`update-link` を使用する方法を示しています。 **AWS CLI** **リンクを更新するには** 次の `update-link` の例では、リンク `link-11112222aaaabbbb1` の帯域幅情報を更新します。 ``` aws networkmanager update-link \ --global-network-id global-network-01231231231231231 \ --link-id link-11112222aaaabbbb1 \ --bandwidth UploadSpeed=20,DownloadSpeed=20 \ --region us-west-2 ``` 出力: ``` { "Link": { "LinkId": "link-11112222aaaabbbb1", "LinkArn": "arn:aws:networkmanager::123456789012:link/global-network-01231231231231231/link-11112222aaaabbbb1", "GlobalNetworkId": "global-network-01231231231231231", "SiteId": "site-444555aaabbb11223", "Description": "VPN Link", "Type": "broadband", "Bandwidth": { "UploadSpeed": 20, "DownloadSpeed": 20 }, "Provider": "AnyCompany", "CreatedAt": 1575555811.0, "State": "UPDATING" } } ``` 詳細については、「*Transit Gateway Network Manager Guide*」の「[Working with Links](https://docs.aws.amazon.com/vpc/latest/tgw/on-premises-networks.html#working-with-links)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateLink](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/update-link.html)」を参照してください。 ### `update-site` 次のコード例は、`update-site` を使用する方法を示しています。 **AWS CLI** **サイトを更新するには** 次の `update-site` の例では、指定されたグローバルネットワークのサイト `site-444555aaabbb11223` の説明を更新します。 ``` aws networkmanager update-site \ --global-network-id global-network-01231231231231231 \ --site-id site-444555aaabbb11223 \ --description "New York Office site" \ --region us-west-2 ``` 出力: ``` { "Site": { "SiteId": "site-444555aaabbb11223", "SiteArn": "arn:aws:networkmanager::123456789012:site/global-network-01231231231231231/site-444555aaabbb11223", "GlobalNetworkId": "global-network-01231231231231231", "Description": "New York Office site", "Location": { "Latitude": "40.7128", "Longitude": "-74.0060" }, "CreatedAt": 1575554528.0, "State": "UPDATING" } } ``` 詳細については、「*Transit Gateway Network Manager Guide*」の「[Working with Sites](https://docs.aws.amazon.com/vpc/latest/tgw/on-premises-networks.html#working-with-sites)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateSite](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/networkmanager/update-site.html)」を参照してください。 # AWS CLI を使用した OpenSearch Service の例 次のコード例は、OpenSearch Service で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-elasticsearch-domain` 次のコード例は、`create-elasticsearch-domain` を使用する方法を示しています。 **AWS CLI** **Amazon Elasticsearch Service ドメインを作成するには** 次の `create-elasticsearch-domain` コマンドは、VPC 内に新しい Amazon Elasticsearch Service ドメインを作成し、1 人のユーザーへのアクセスを制限します。Amazon ES は、指定されたサブネットとセキュリティグループ ID から VPC ID を推測します。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Elasticsearch Service デベロッパーガイド*」の「[Creating and Managing Amazon Elasticsearch Service Domains](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateElasticsearchDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/create-elasticsearch-domain.html)」を参照してください。 ### `describe-elasticsearch-domain-config` 次のコード例は、`describe-elasticsearch-domain-config` を使用する方法を示しています。 **AWS CLI** **ドメイン設定の詳細を取得するには** 次の `describe-elasticsearch-domain-config` の例では、特定のドメインの設定の詳細と、各ドメインコンポーネントのステータス情報を示します。 ``` aws es describe-elasticsearch-domain-config \ --domain-name cli-example ``` 出力: ``` { "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 } } } } ``` 詳細については、「*Amazon Elasticsearch Service デベロッパーガイド*」の「[Creating and Managing Amazon Elasticsearch Service Domains](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeElasticsearchDomainConfig](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/describe-elasticsearch-domain-config.html)」を参照してください。 ### `describe-elasticsearch-domain` 次のコード例は、`describe-elasticsearch-domain` を使用する方法を示しています。 **AWS CLI** **単一ドメインの詳細を取得するには** 次の `describe-elasticsearch-domain` の例では、特定のドメインの設定の詳細を示します。 ``` aws es describe-elasticsearch-domain \ --domain-name cli-example ``` 出力: ``` { "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 } } } ``` 詳細については、「*Amazon Elasticsearch Service デベロッパーガイド*」の「[Creating and Managing Amazon Elasticsearch Service Domains](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeElasticsearchDomain](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/describe-elasticsearch-domain.html)」を参照してください。 ### `describe-elasticsearch-domains` 次のコード例は、`describe-elasticsearch-domains` を使用する方法を示しています。 **AWS CLI** **1 つ以上のドメインの詳細を取得するには** 次の `describe-elasticsearch-domains` の例では、1 つ以上のドメインの設定の詳細を示します。 ``` aws es describe-elasticsearch-domains \ --domain-names cli-example-1 cli-example-2 ``` 出力: ``` { "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 } } ] } ``` 詳細については、「*Amazon Elasticsearch Service デベロッパーガイド*」の「[Creating and Managing Amazon Elasticsearch Service Domains](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeElasticsearchDomains](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/describe-elasticsearch-domains.html)」を参照してください。 ### `describe-reserved-elasticsearch-instances` 次のコード例は、`describe-reserved-elasticsearch-instances` を使用する方法を示しています。 **AWS CLI** **すべての予約済みインスタンスを表示するには** 次の `describe-elasticsearch-domains` の例は、リージョンで予約したすべてのインスタンスの概要を示しています。 ``` aws es describe-reserved-elasticsearch-instances ``` 出力: ``` { "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" }] } ``` 詳細については、「Amazon Elasticsearch Service デベロッパーガイド」の「[Reserved Instances](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/aes-ri.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeReservedElasticsearchInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/describe-reserved-elasticsearch-instances.html)」を参照してください。 ### `list-domain-names` 次のコード例は、`list-domain-names` を使用する方法を示しています。 **AWS CLI** **すべてのドメインを一覧表示するには** 次の `list-domain-names` の例は、リージョン内のすべてのドメインの簡単な概要を示します。 ``` aws es list-domain-names ``` 出力: ``` { "DomainNames": [{ "DomainName": "cli-example-1" }, { "DomainName": "cli-example-2" } ] } ``` 詳細については、「*Amazon Elasticsearch Service デベロッパーガイド*」の「[Creating and Managing Amazon Elasticsearch Service Domains](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListDomainNames](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/es/list-domain-names.html)」を参照してください。 # AWS CLI を使用する組織の例 次のコード例は、組織で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `accept-handshake` 次のコード例は、`accept-handshake` を使用する方法を示しています。 **AWS CLI** **別のアカウントからハンドシェイクを受け入れるには** 組織の所有者である Bill は、以前に Juan のアカウントを組織に参加するよう招待しました。次の例は、Juan のアカウントがハンドシェイクを受け入れ、招待に同意したことを示しています。 ``` aws organizations accept-handshake --handshake-id h-examplehandshakeid111 ``` 出力は、次のように表示されます。 ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AcceptHandshake](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/accept-handshake.html)」を参照してください。 ### `attach-policy` 次のコード例は、`attach-policy` を使用する方法を示しています。 **AWS CLI** **root、OU、またはアカウントにポリシーをアタッチするには** **例 1** 次の例は、サービスコントロールポリシーを OU にアタッチする方法を示しています。 ``` aws organizations attach-policy --policy-id p-examplepolicyid111 --target-id ou-examplerootid111-exampleouid111 ``` **例 2** 次の例は、サービスコントロールポリシーをアカウントに直接アタッチする方法を示しています。 ``` aws organizations attach-policy --policy-id p-examplepolicyid111 --target-id 333333333333 ``` + API の詳細については、AWS CLI コマンドリファレンスの「[AttachPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/attach-policy.html)」を参照してください。** ### `cancel-handshake` 次のコード例は、`cancel-handshake` を使用する方法を示しています。 **AWS CLI** **別のアカウントから送信されたハンドシェイクをキャンセルするには** Bill は以前に、Susan のアカウントに組織に参加する招待を送信しました。Susan が承諾する前に、Bill は考えを変え、招待をキャンセルすることにしました。次の例は、Bill のキャンセルを示しています。 ``` aws organizations cancel-handshake --handshake-id h-examplehandshakeid111 ``` 出力には、現在の状態が `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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelHandshake](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/cancel-handshake.html)」を参照してください。 ### `create-account` 次のコード例は、`create-account` を使用する方法を示しています。 **AWS CLI** **自動的に組織の一部となるメンバーアカウントを作成するには** 次の例は、組織のメンバーアカウントを作成する方法を示しています。メンバーアカウントは、「プロダクションアカウント」という名前と E メールアドレス (susan@example.com) で構成されます。roleName パラメータが指定されていないため、Organizations では OrganizationAccountAccessRole というデフォルト名を使用して IAM ロールが自動的に作成されます。また、IamUserAccessToBilling パラメータが指定されていないため、必要な権限を持つ IAM ユーザーまたはロールにアカウントの請求データへのアクセスを許可する設定には、デフォルト値 ALLOW が使用されます。Organizations は、Susan に「Welcome to AWS」の E メールを自動的に送信します。 ``` aws organizations create-account --email susan@example.com --account-name "Production Account" ``` 出力には、ステータスが現在の `IN_PROGRESS` 状態であることを示すリクエストオブジェクトが含まれます。 ``` { "CreateAccountStatus": { "State": "IN_PROGRESS", "Id": "car-examplecreateaccountrequestid111" } } ``` describe-create-account-status コマンドに Id レスポンス値を create-account-request-id parameter の値として指定することで、後でリクエストの現在のステータスをクエリすることができます。 詳細については、「AWS Organizations ユーザーガイド」の「Creating an AWS Account in Your Organization」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[CreateAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/create-account.html)」を参照してください。** ### `create-organization` 次のコード例は、`create-organization` を使用する方法を示しています。 **AWS CLI** **例 1: 新しい組織を作成するには** Bill は、アカウント 111111111111 の認証情報を使用して組織を作成したいと考えています。次の例は、このアカウントが新しい組織のマスターアカウントになることを示しています。Bill は機能セットを指定していないため、新しい組織ではデフォルトですべての機能が有効になり、サービスコントロールポリシーがルート上で有効になります。 ``` aws organizations create-organization ``` 出力には、新しい組織に関する詳細を含む組織オブジェクトが含まれます。 ``` { "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" } } ``` **例 2: 一括決済機能のみを有効にした新しい組織を作成するには** 次の例では、一括決済機能のみをサポートする組織を作成します。 ``` aws organizations create-organization --feature-set CONSOLIDATED_BILLING ``` 出力には、新しい組織に関する詳細を含む組織オブジェクトが含まれます。 ``` { "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" } } ``` 詳細については、「AWS Organizations ユーザーガイド」の「Creating an Organization」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[CreateOrganization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/create-organization.html)」を参照してください。** ### `create-organizational-unit` 次のコード例は、`create-organizational-unit` を使用する方法を示しています。 **AWS CLI** **ルート OU または親 OU に OU を作成するには** 次の例は、AccountingOU という名前の OU を作成する方法を示しています。 ``` aws organizations create-organizational-unit --parent-id r-examplerootid111 --name AccountingOU ``` 出力には、新しい OU に関する詳細を含む organizationalUnit オブジェクトが含まれます。 ``` { "OrganizationalUnit": { "Id": "ou-examplerootid111-exampleouid111", "Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111", "Name": "AccountingOU" } } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[CreateOrganizationalUnit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/create-organizational-unit.html)」を参照してください。** ### `create-policy` 次のコード例は、`create-policy` を使用する方法を示しています。 **AWS CLI** **例 1: JSON ポリシーのテキストソースファイルを使用してポリシーを作成するには** 次の例は、`AllowAllS3Actions` という名前のサービスコントロールポリシーを作成する方法を示しています。ポリシーの内容は、`policy.json` というローカルコンピューター上のファイルから取得されます。 ``` aws organizations create-policy --content file://policy.json --name AllowAllS3Actions, --type SERVICE_CONTROL_POLICY --description "Allows delegation of all S3 actions" ``` 出力には、新しいポリシーの詳細を含むポリシーオブジェクトが含まれます。 ``` { "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" } } } ``` **例 2: JSON ポリシーをパラメータとしてポリシーを作成するには** 次の例は、ポリシーの内容を JSON 文字列としてパラメータに埋め込むことで、同じ SCP を作成する方法を示しています。文字列は、パラメータ内でリテラルとして扱われるように、二重引用符の前にバックスラッシュを付けてエスケープする必要があります。パラメータ自体も二重引用符で囲みます。 ``` 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" ``` Organizations でのポリシーの作成と使用の詳細については、「*AWS Organizations ユーザーガイド*」の「Organizations のポリシーの管理」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreatePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/create-policy.html)」を参照してください。 ### `decline-handshake` 次のコード例は、`decline-handshake` を使用する方法を示しています。 **AWS CLI** **別のアカウントから送信されたハンドシェイクを拒否するには** 次の例は、アカウント 222222222222 の所有者である管理者である Susan が、Bill の組織への招待を拒否したことを示しています。DeclineHandshake オペレーションはハンドシェイクオブジェクトを返し、状態が DECLINED になったことを示します。 ``` aws organizations decline-handshake --handshake-id h-examplehandshakeid111 ``` 出力には、新しい状態 `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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeclineHandshake](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/decline-handshake.html)」を参照してください。 ### `delete-organization` 次のコード例は、`delete-organization` を使用する方法を示しています。 **AWS CLI** **組織を削除するには** 次の例は、組織を削除する方法を示しています。この操作を実行するには、組織のマスターアカウントの管理者である必要があります。この例では、組織からメンバーアカウント、OU、ポリシーをすべて削除済みであることを前提としています。 ``` aws organizations delete-organization ``` + API の詳細については、AWS CLI コマンドリファレンスの「[DeleteOrganization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/delete-organization.html)」を参照してください。** ### `delete-organizational-unit` 次のコード例は、`delete-organizational-unit` を使用する方法を示しています。 **AWS CLI** **OU を削除するには** 次の例は、OU を削除する方法を示しています。この例では、OU からすべてのアカウントと他の OU を削除済みであることを前提としています。 ``` aws organizations delete-organizational-unit --organizational-unit-id ou-examplerootid111-exampleouid111 ``` + API の詳細については、AWS CLI コマンドリファレンスの「[DeleteOrganizationalUnit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/delete-organizational-unit.html)」を参照してください。** ### `delete-policy` 次のコード例は、`delete-policy` を使用する方法を示しています。 **AWS CLI** **ポリシーを削除するには** 次の例は、組織からポリシーを削除する方法を示しています。この例では、ポリシーをすべてのエンティティから事前にデタッチしたことを前提としています。 ``` aws organizations delete-policy --policy-id p-examplepolicyid111 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeletePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/delete-policy.html)」を参照してください。 ### `describe-account` 次のコード例は、`describe-account` を使用する方法を示しています。 **AWS CLI** **アカウントの詳細を取得するには** 次の例は、アカウントの詳細をリクエストする方法を示しています。 ``` aws organizations describe-account --account-id 555555555555 ``` 出力には、アカウントに関する詳細を含むアカウントオブジェクトが表示されます。 ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/describe-account.html)」を参照してください。 ### `describe-create-account-status` 次のコード例は、`describe-create-account-status` を使用する方法を示しています。 **AWS CLI** **アカウントの作成リクエストに関する最新のステータスを取得するには** 次の例は、以前のリクエストの最新ステータスを依頼して組織内にアカウントを作成する方法を示しています。指定された --request-id は、create-account への元の呼び出しのレスポンスから得られたものです。アカウント作成リクエストは、Organizations がアカウントの作成を正常に完了したことをステータスフィールドで表示します。 コマンド: ``` aws organizations describe-create-account-status --create-account-request-id car-examplecreateaccountrequestid111 ``` 出力: ``` { "CreateAccountStatus": { "State": "SUCCEEDED", "AccountId": "555555555555", "AccountName": "Beta account", "RequestedTimestamp": 1470684478.687, "CompletedTimestamp": 1470684532.472, "Id": "car-examplecreateaccountrequestid111" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeCreateAccountStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/describe-create-account-status.html)」を参照してください。 ### `describe-handshake` 次のコード例は、`describe-handshake` を使用する方法を示しています。 **AWS CLI** **ハンドシェイクに関する情報を取得するには** 次の例は、ハンドシェイクの詳細をリクエストする方法を示しています。ハンドシェイク ID は、`InviteAccountToOrganization` への元の呼び出しか、`ListHandshakesForAccount` または `ListHandshakesForOrganization` への呼び出しから得られたものです。 ``` aws organizations describe-handshake --handshake-id h-examplehandshakeid111 ``` 出力には、リクエストされたハンドシェイクに関するすべての詳細を含むハンドシェイクオブジェクトが含まれます。 ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeHandshake](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/describe-handshake.html)」を参照してください。 ### `describe-organization` 次のコード例は、`describe-organization` を使用する方法を示しています。 **AWS CLI** **現在の組織に関する情報を取得するには** 次の例は、組織の詳細をリクエストする方法を示しています。 ``` aws organizations describe-organization ``` 出力には、組織に関する詳細を含む組織オブジェクトが含まれます。 ``` { "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" } ] } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeOrganization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/describe-organization.html)」を参照してください。 ### `describe-organizational-unit` 次のコード例は、`describe-organizational-unit` を使用する方法を示しています。 **AWS CLI** **OU に関する情報を取得するには** 次の `describe-organizational-unit` の例では、OU の詳細をリクエストします。 ``` aws organizations describe-organizational-unit \ --organizational-unit-id ou-examplerootid111-exampleouid111 ``` 出力: ``` { "OrganizationalUnit": { "Name": "Accounting Group", "Arn": "arn:aws:organizations::123456789012:ou/o-exampleorgid/ou-examplerootid111-exampleouid111", "Id": "ou-examplerootid111-exampleouid111" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeOrganizationalUnit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/describe-organizational-unit.html)」を参照してください。 ### `describe-policy` 次のコード例は、`describe-policy` を使用する方法を示しています。 **AWS CLI** **ポリシーに関する情報を取得するには** 次の例は、ポリシーに関する情報をリクエストする方法を示しています。 ``` aws organizations describe-policy --policy-id p-examplepolicyid111 ``` 出力には、ポリシーの詳細を含むポリシーオブジェクトが含まれます。 ``` { "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" } } } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[DescribePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/describe-policy.html)」を参照してください。** ### `detach-policy` 次のコード例は、`detach-policy` を使用する方法を示しています。 **AWS CLI** **root、OU、またはアカウントからポリシーをデタッチするには** 次のコード例は、OU からポリシーをデタッチする方法を示しています。 ``` aws organizations detach-policy --target-id ou-examplerootid111-exampleouid111 --policy-id p-examplepolicyid111 ``` + API の詳細については、AWS CLI コマンドリファレンスの「[DetachPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/detach-policy.html)」を参照してください。** ### `disable-policy-type` 次のコード例は、`disable-policy-type` を使用する方法を示しています。 **AWS CLI** **ルートのポリシータイプを無効にするには** 次の例は、ルートでサービスコントロールポリシー (SCP) ポリシータイプを無効にする方法を示しています。 ``` aws organizations disable-policy-type --root-id r-examplerootid111 --policy-type SERVICE_CONTROL_POLICY ``` 出力は、PolicyTypes レスポンス要素に SERVICE\$1CONTROL\$1POLICY が含まれなくなったことを示します。 ``` { "Root": { "PolicyTypes": [], "Name": "Root", "Id": "r-examplerootid111", "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DisablePolicyType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/disable-policy-type.html)」を参照してください。 ### `enable-all-features` 次のコード例は、`enable-all-features` を使用する方法を示しています。 **AWS CLI** **組織内のすべての機能を有効にするには** この例では、管理者が組織内のすべての招待アカウントに対して、組織内の有効なすべての機能を承認するように求めています。AWSOrganizations は、招待されたすべてのメンバーアカウントに登録されているアドレスに E メールを送信し、送信されたハンドシェイクを受け入れることで、すべての機能に対する変更を承認するよう所有者に依頼します。招待されたすべてのメンバーアカウントがハンドシェイクを受け入れると、組織管理者はすべての機能の変更を確定し、適切なアクセス許可を持つメンバーアカウントがポリシーを作成し、ルート、OU、およびアカウントに適用できるようになります。 ``` aws organizations enable-all-features ``` 出力はハンドシェイクオブジェクトであり、招待されたすべてのメンバーアカウントに送信され、承認されます。 ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EnableAllFeatures](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/enable-all-features.html)」を参照してください。 ### `enable-policy-type` 次のコード例は、`enable-policy-type` を使用する方法を示しています。 **AWS CLI** **ルートでポリシータイプの使用を有効にするには** 次の例は、ルートでサービスコントロールポリシー (SCP) ポリシータイプを有効にする方法を示しています。 ``` aws organizations enable-policy-type --root-id r-examplerootid111 --policy-type SERVICE_CONTROL_POLICY ``` 出力には、SCP が有効になったことを示す policyTypes レスポンス要素を持つルートオブジェクトが表示されます。 ``` { "Root": { "PolicyTypes": [ { "Status":"ENABLED", "Type":"SERVICE_CONTROL_POLICY" } ], "Id": "r-examplerootid111", "Name": "Root", "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EnablePolicyType](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/enable-policy-type.html)」を参照してください。 ### `invite-account-to-organization` 次のコード例は、`invite-account-to-organization` を使用する方法を示しています。 **AWS CLI** **組織に参加するようアカウントを招待するには** 次の例は、bill@example.com が所有するマスターアカウントで、juan@example.com が所有するアカウントを組織に参加するよう招待しています。 ``` 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." ``` 出力には、招待されたアカウントに送信される内容を示すハンドシェイク構造が含まれます。 ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[InviteAccountToOrganization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/invite-account-to-organization.html)」を参照してください。 ### `leave-organization` 次のコード例は、`leave-organization` を使用する方法を示しています。 **AWS CLI** **メンバーアカウントとして組織を離れるには** 次の例は、現在メンバーである組織を離れることをリクエストしているメンバーアカウントの管理者を示しています。 ``` aws organizations leave-organization ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[LeaveOrganization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/leave-organization.html)」を参照してください。 ### `list-accounts-for-parent` 次のコード例は、`list-accounts-for-parent` を使用する方法を示しています。 **AWS CLI** **指定された親ルートまたは OU 内のすべてのアカウントのリストを取得するには** 次の例は、OU 内のアカウントのリストをリクエストする方法を示しています。 ``` aws organizations list-accounts-for-parent --parent-id ou-examplerootid111-exampleouid111 ``` 出力には、アカウントサマリーオブジェクトのリストが含まれます。 ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAccountsForParent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/list-accounts-for-parent.html)」を参照してください。 ### `list-accounts` 次のコード例は、`list-accounts` を使用する方法を示しています。 **AWS CLI** **組織内のすべてのアカウントのリストを取得するには** 次の例は、組織内のアカウントのリストをリクエストする方法を示しています。 ``` aws organizations list-accounts ``` 出力には、アカウントサマリーオブジェクトのリストが含まれます。 ``` { "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" } ] } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[ListAccounts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/list-accounts.html)」を参照してください。** ### `list-children` 次のコード例は、`list-children` を使用する方法を示しています。 **AWS CLI** **親 OU またはルートの子アカウントと OU を取得するには** 次の例は、そのアカウント 444444444444 を含むルートまたは OU を一覧表示する方法を示しています。 ``` aws organizations list-children --child-type ORGANIZATIONAL_UNIT --parent-id ou-examplerootid111-exampleouid111 ``` 出力には、親に含まれる 2 つの子 OU が表示されます。 ``` { "Children": [ { "Id": "ou-examplerootid111-exampleouid111", "Type":"ORGANIZATIONAL_UNIT" }, { "Id":"ou-examplerootid111-exampleouid222", "Type":"ORGANIZATIONAL_UNIT" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListChildren](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/list-children.html)」を参照してください。 ### `list-create-account-status` 次のコード例は、`list-create-account-status` を使用する方法を示しています。 **AWS CLI** **例 1: 現在の組織で行われたアカウント作成リクエストのリストを取得するには** 次の例は、正常に完了した組織のアカウント作成リクエストのリストを依頼する方法を示しています。 ``` aws organizations list-create-account-status --states SUCCEEDED ``` 出力には、各リクエストに関する情報を含むオブジェクトの配列が含まれます。 ``` { "CreateAccountStatuses": [ { "AccountId": "444444444444", "AccountName": "Developer Test Account", "CompletedTimeStamp": 1481835812.143, "Id": "car-examplecreateaccountrequestid111", "RequestedTimeStamp": 1481829432.531, "State": "SUCCEEDED" } ] } ``` **例 2: 現在の組織で行われた進行中のアカウント作成リクエストのリストを取得するには** 次の例では、組織の進行中のアカウント作成リクエストのリストを取得します。 ``` aws organizations list-create-account-status --states IN_PROGRESS ``` 出力には、各リクエストに関する情報を含むオブジェクトの配列が含まれます。 ``` { "CreateAccountStatuses": [ { "State": "IN_PROGRESS", "Id": "car-examplecreateaccountrequestid111", "RequestedTimeStamp": 1481829432.531, "AccountName": "Production Account" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListCreateAccountStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/list-create-account-status.html)」を参照してください。 ### `list-handshakes-for-account` 次のコード例は、`list-handshakes-for-account` を使用する方法を示しています。 **AWS CLI** **アカウントに送信されたハンドシェイクのリストを取得するには** 次の例は、オペレーションの呼び出しに使用された認証情報のアカウントに関連付けられているすべてのハンドシェイクのリストを取得する方法を示しています。 ``` aws organizations list-handshakes-for-account ``` 出力には、現在の状態を含む各ハンドシェイクに関する情報と共にハンドシェイク構造のリストが含まれます。 ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListHandshakesForAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/list-handshakes-for-account.html)」を参照してください。 ### `list-handshakes-for-organization` 次のコード例は、`list-handshakes-for-organization` を使用する方法を示しています。 **AWS CLI** **組織に関連付けられているハンドシェイクのリストを取得するには** 次の例は、現在の組織に関連付けられているハンドシェイクのリストを取得する方法を示しています。 ``` aws organizations list-handshakes-for-organization ``` 出力には 2 つのハンドシェイクが表示されます。1 つ目は Juan のアカウントへの招待で、OPEN 状態を示します。2 つ目は Anika のアカウントへの招待で、ACCEPTED 状態を示します。 ``` { "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." } ] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListHandshakesForOrganization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/list-handshakes-for-organization.html)」を参照してください。 ### `list-organizational-units-for-parent` 次のコード例は、`list-organizational-units-for-parent` を使用する方法を示しています。 **AWS CLI** **親 OU またはルートの OU のリストを取得するには** 次の例は、指定されたルート内の OU のリストを取得する方法を示しています。 ``` aws organizations list-organizational-units-for-parent --parent-id r-examplerootid111 ``` 出力は、指定されたルートに 2 つの OU が含まれていることを示し、それぞれの詳細を示します。 ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListOrganizationalUnitsForParent](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/list-organizational-units-for-parent.html)」を参照してください。 ### `list-parents` 次のコード例は、`list-parents` を使用する方法を示しています。 **AWS CLI** **アカウントまたは子 OU の親 OU またはルートを一覧表示するには** 次の例は、そのアカウント 444444444444 を含むルートまたは親 OU を一覧表示する方法を示しています。 ``` aws organizations list-parents --child-id 444444444444 ``` 出力は、指定されたアカウントが、指定された ID を持つ OU にあることを示します。 ``` { "Parents": [ { "Id": "ou-examplerootid111-exampleouid111", "Type": "ORGANIZATIONAL_UNIT" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListParents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/list-parents.html)」を参照してください。 ### `list-policies-for-target` 次のコード例は、`list-policies-for-target` を使用する方法を示しています。 **AWS CLI** **アカウントに直接アタッチされた SCP のリストを取得するには** 次の例は、アカウントに直接アタッチされた Filter パラメータで指定されたすべてのサービスコントロールポリシー (SCP) のリストを取得する方法を示しています。 ``` aws organizations list-policies-for-target --filter SERVICE_CONTROL_POLICY --target-id 444444444444 ``` 出力には、ポリシーに関するポリシー構造のリストと概要情報が含まれます。このリストには、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." } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPoliciesForTarget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/list-policies-for-target.html)」を参照してください。 ### `list-policies` 次のコード例は、`list-policies` を使用する方法を示しています。 **AWS CLI** **特定のタイプの組織のすべてのポリシーのリストを取得するには** 次の例は、フィルターパラメータで指定された SCP のリストを取得する方法を示しています。 ``` aws organizations list-policies --filter SERVICE_CONTROL_POLICY ``` 出力には、ポリシーのリストと概要情報が含まれます。 ``` { "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" } ] } ``` + API の詳細については、「AWS CLI Command Reference」の「[ListPolicies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/list-policies.html)」を参照してください。** ### `list-roots` 次のコード例は、`list-roots` を使用する方法を示しています。 **AWS CLI** **組織内のルートのリストを取得するには** この例では、組織のルートのリストを取得する方法を示します。 ``` aws organizations list-roots ``` 出力には、ルート構造のリストと概要情報が含まれます。 ``` { "Roots": [ { "Name": "Root", "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111", "Id": "r-examplerootid111", "PolicyTypes": [ { "Status":"ENABLED", "Type":"SERVICE_CONTROL_POLICY" } ] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListRoots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/list-roots.html)」を参照してください。 ### `list-targets-for-policy` 次のコード例は、`list-targets-for-policy` を使用する方法を示しています。 **AWS CLI** **ポリシーがアタッチされているすべてのルート、OU、およびアカウントのリストを取得するには** 次の例は、指定されたポリシーがアタッチされているルート、OU、およびアカウントのリストを取得する方法を示しています。 ``` aws organizations list-targets-for-policy --policy-id p-FullAWSAccess ``` 出力には、ルート、OU、およびポリシーがアタッチされているアカウントに関する概要情報と共にアタッチメントオブジェクトのリストが含まれます。 ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTargetsForPolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/list-targets-for-policy.html)」を参照してください。 ### `move-account` 次のコード例は、`move-account` を使用する方法を示しています。 **AWS CLI** **ルートまたは OU 間でアカウントを移動するには** 次の例は、組織内のマスターアカウントをルートから OU に移動する方法を示しています。 ``` aws organizations move-account --account-id 333333333333 --source-parent-id r-examplerootid111 --destination-parent-id ou-examplerootid111-exampleouid111 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[MoveAccount](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/move-account.html)」を参照してください。 ### `remove-account-from-organization` 次のコード例は、`remove-account-from-organization` を使用する方法を示しています。 **AWS CLI** **マスターアカウントとして組織からアカウントを削除するには** 次の例は、組織からアカウントを削除する方法を示しています。 ``` aws organizations remove-account-from-organization --account-id 333333333333 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveAccountFromOrganization](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/remove-account-from-organization.html)」を参照してください。 ### `update-organizational-unit` 次のコード例は、`update-organizational-unit` を使用する方法を示しています。 **AWS CLI** **OU の名前を変更するには** この例では、OU の名前を変更する方法を示します。この例では、OU の名前は「AccountingOU」に変更されます。 ``` aws organizations update-organizational-unit --organizational-unit-id ou-examplerootid111-exampleouid111 --name AccountingOU ``` 出力には新しい名前が表示されます。 ``` { "OrganizationalUnit": { "Id": "ou-examplerootid111-exampleouid111" "Name": "AccountingOU", "Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111"" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateOrganizationalUnit](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/update-organizational-unit.html)」を参照してください。 ### `update-policy` 次のコード例は、`update-policy` を使用する方法を示しています。 **AWS CLI** **例 1: ポリシーの名前を変更するには** 次の `update-policy` の例では、ポリシーの名前を変更し、新しい説明を提供します。 ``` aws organizations update-policy \ --policy-id p-examplepolicyid111 \ --name Renamed-Policy \ --description "This description replaces the original." ``` 出力には新しい名前と説明が表示されます。 ``` { "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" } } } ``` **例 2: ポリシーの JSON テキストコンテンツを置き換えるには** 次の例は、前の例の SCP の JSON テキストを、EC2 の代わりに S3 を許可する新しい JSON ポリシーテキスト文字列に置き換える方法を示しています。 ``` aws organizations update-policy \ --policy-id p-examplepolicyid111 \ --content "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"s3:*\",\"Resource\":\"*\"}}" ``` 出力には新しいコンテンツが表示されます。 ``` { "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" } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdatePolicy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/organizations/update-policy.html)」を参照してください。 # AWS Outposts examples using AWS CLI 次のコード例では、AWS Outposts で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `get-outpost-instance-types` 次のコード例は、`get-outpost-instance-types` を使用する方法を示しています。 **AWS CLI** **Outpost のインスタンスタイプを取得するには** 次の `get-outpost-instance-types` の例では、指定された Outpost のインスタンスタイプを取得します。 ``` aws outposts get-outpost-instance-types \ --outpost-id op-0ab23c4567EXAMPLE ``` 出力: ``` { "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" } ``` 詳細については、「*AWS Outposts User Guide*」の「[Launch an instance on your Outpost](https://docs.aws.amazon.com/outposts/latest/userguide/launch-instance.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetOutpostInstanceTypes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/outposts/get-outpost-instance-types.html)」を参照してください。 ### `get-outpost` 次のコード例は、`get-outpost` を使用する方法を示しています。 **AWS CLI** **Outpost の詳細を取得するには** 次の `get-outpost` の例では、指定された Outpost の詳細を表示します。 ``` aws outposts get-outpost \ --outpost-id op-0ab23c4567EXAMPLE ``` 出力: ``` { "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": {} } } ``` 詳細については、「*AWS Outposts User Guide*」の「[Working with Outposts](https://docs.aws.amazon.com/outposts/latest/userguide/work-with-outposts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetOutpost](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/outposts/get-outpost.html)」を参照してください。 ### `list-outposts` 次のコード例は、`list-outposts` を使用する方法を示しています。 **AWS CLI** **Outpost を一覧表示するには** 次の `list-outposts` の例では、AWS アカウント内の Outpost を一覧表示します。 ``` aws outposts list-outposts ``` 出力: ``` { "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": {} } ] } ``` 詳細については、「*AWS Outposts User Guide*」の「[Working with Outposts](https://docs.aws.amazon.com/outposts/latest/userguide/work-with-outposts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListOutposts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/outposts/list-outposts.html)」を参照してください。 ### `list-sites` 次のコード例は、`list-sites` を使用する方法を示しています。 **AWS CLI** **サイトを一覧表示するには** 次の `list-sites` の例では、AWS アカウントで使用可能な Outpost サイトを一覧表示します。 ``` aws outposts list-sites ``` 出力: ``` { "Sites": [ { "SiteId": "os-0ab12c3456EXAMPLE", "AccountId": "123456789012", "Name": "EXAMPLE", "Description": "example", "Tags": {} } ] } ``` 詳細については、「*AWS Outposts User Guide*」の「[Working with Outposts](https://docs.aws.amazon.com/outposts/latest/userguide/work-with-outposts.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListSites](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/outposts/list-sites.html)」を参照してください。 # AWS Payment Cryptography examples using AWS CLI 次のコード例では、AWS Payment Cryptography で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-alias` 次のコード例は、`create-alias` を使用する方法を示しています。 **AWS CLI** **キーのエイリアスを作成するには** 次の `create-alias` の例では、キーのエイリアスを作成します。 ``` aws payment-cryptography create-alias \ --alias-name alias/sampleAlias1 \ --key-arn arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h ``` 出力: ``` { "Alias": { "AliasName": "alias/sampleAlias1", "KeyArn": "arn:aws:payment-cryptography:us-west-2:123456789012:key/kwapwa6qaifllw2h" } } ``` 詳細については、「*AWS Payment Cryptography ユーザーガイド*」の「[エイリアスについて](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/alias-about.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[CreateAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/create-alias.html)」を参照してください。** ### `create-key` 次のコード例は、`create-key` を使用する方法を示しています。 **AWS CLI** **キーを作成するには** 次の `create-key` の例では、CVV/CVV2 値の生成と検証に使用できる 2KEY TDES キーを生成します。 ``` 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} ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Payment Cryptography User Guide*」の「[Generating keys](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/create-keys.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[CreateKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/create-key.html)」を参照してください。** ### `delete-alias` 次のコード例は、`delete-alias` を使用する方法を示しています。 **AWS CLI** **エイリアスを削除するには** 次の `delete-alias` の例では、エイリアスを削除します。これによるキーへの影響はありません。 ``` aws payment-cryptography delete-alias \ --alias-name alias/sampleAlias1 ``` このコマンドでは何も出力されません。 詳細については、「*AWS Payment Cryptography ユーザーガイド*」の「[エイリアスについて](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/alias-about.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[DeleteAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/delete-alias.html)」を参照してください。** ### `delete-key` 次のコード例は、`delete-key` を使用する方法を示しています。 **AWS CLI** **キーを削除するには** 次の `delete-key` の例では、デフォルトの待機期間である 7 日後にキーの削除をスケジュールします。 ``` aws payment-cryptography delete-key \ --key-identifier arn:aws:payment-cryptography:us-west-2:123456789012:key/kwapwa6qaifllw2h ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Payment Cryptography ユーザーガイド*」の「[キーの削除](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-deleting.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/delete-key.html)」を参照してください。 ### `export-key` 次のコード例は、`export-key` を使用する方法を示しています。 **AWS CLI** **キーをエクスポートするには** 次の `export-key` の例では、キーをエクスポートします。 ``` 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 }}' ``` `wrapping-key-certificate.pem` の内容: ``` LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUV2VENDQXFXZ0F3SUJBZ0lSQU1ZZS8xMXFUK2svVzlRUDJQOElVdWd3RFFZSktvWklodmNOQVFFTkJRQXcKZ1lreEN6QUpCZ05WQkFZVEFsVlRNUmt3RndZRFZRUUtEQkJCVjFNZ1EzSjVjSFJ2WjNKaGNHaDVNU0V3SHdZRApWUVFMREJoQlYxTWdVR0Y1YldWdWRDQkRjbmx3ZEc5bmNtRndhSGt4RVRBUEJnTlZCQWdNQ0ZacGNtZHBibWxoCk1SVXdFd1lEVlFRRERBd3dOelUxTlRZNU5UTTNOVEF4RWpBUUJnTlZCQWNNQ1VGeWJHbHVaM1J2YmpBZUZ3MHkKTXpBMk1UTXhOelV6TVROYUZ3MHlNekEyTWpBeE9EVXpNVEphTUN3eEZUQVRCZ05WQkFNTUREQTNOVFUxTmprMQpNemMxTURFVE1CRUdBMVVFQlJNS09URTFNRGMzTnpRMk9EQ0NBU0l3RFFZSktvWklodmNOQVFFQkJRQURnZ0VQCkFEQ0NBUW9DZ2dFQkFNUjZsVTZ0SFJwcWtCQmI1Z2FFa0FrbVRxNEgwNUQ2UXR2MS9WemhSaThtNVBFMjVtMFIKVnRtZmsxcUEySi94TEROTEl3dHFDR3BIVldOM0JMdFhuSmh2Y1dNNkI0QlRRVXNicENMbG9PYW1jMGF0UXRmeQo0ZUhoWHJoT2lDMFVpR05zeTc5ZlltTkZ3Q3RrSDhvZzJXTEdYNldXNSszRzlTaFZKR3dhbWpNamtlOVo1a0FhCnJKZHk4Y2tsMTFBTS8wQjVZRFR2TU5KVTcyZnVUMlJ5KzVoRmdFTE14aS8vbGE1TnFCQWp5VTY0cmV3eGdVSjAKZ1pVM3lJU2F2UjFwMElNOFNvZzdXUHlkVlNNTitZeTdLMG1OL3lFa3FZTWQxZWxvS1I0OVV3V0hvdzFMcHVzcwpzMDh5a0diWGxsMnBvZ3NvSmZZaFFGWTc4UmRsTU9vY2dOc0NBd0VBQWFOOE1Ib3dDUVlEVlIwVEJBSXdBREFmCkJnTlZIU01FR0RBV2dCU2tDVlVEZzJGZDdPZWpVSUlVRnBvbUpxWG9FREFkQmdOVkhRNEVGZ1FVZU1sRzJ5dkgKamxsQzM2OUV2U3hIcXBBODVkMHdEZ1lEVlIwUEFRSC9CQVFEQWdXZ01CMEdBMVVkSlFRV01CUUdDQ3NHQVFVRgpCd01CQmdnckJnRUZCUWNEQWpBTkJna3Foa2lHOXcwQkFRMEZBQU9DQWdFQURNS2gxbnhYWWtncVkwYmMwVjA1ClNCUTBlcm5vMmsxbXdRQnhpUDBpcUpMdWNFUnF6b0RzOTBJWTN5SjhjMkMzU2kzU1JrVzBmQUhKR0VucTlzblgKbGdGWnRBZmtNbzR4Wllpb1JGZmY1TWdSOUdNaUZNQnVQS2tIeGxKc0R2NllSbnp1Zmkza1lDT1NzeWE4U2tTMQp2M2l2UEpLcTk3aDBBaThoNFQ3clBtN0NNSnYxZ0JTUEF4UVdtdndES2RrTjFsd0VudmtGdzlLZjhqeVpaNjhGCjlmUFV4Z1RvYm1MSmNialZxaFdsQ3U1VE9mSGNPR2RLRURwZE54RE12ODNZZ1ZaWUszclc4UHVxWWIyWFdMR2IKdmFISXh2RGVnOVJwNDByVVpETGVyalptb0gwUWpEZmxCV1RYK0JqU3ZLMm5yUGpzZzJIUC91S1VncVIwQWM5eAo0UjF5YjU2cHh3eU54TUU2NmFTVWNVQ3F1WTloY1Q3eWxWNjc3REVhRHpLTG1abnpMcWdWZU5PaUtzQTMvTi9hCnI2UW56VjNabEtJbCs5aWZwNTVPaTVLMXFyWFkyeVlPL1V2SXBXZjAxcFNFUERHN0hXSllnaGorbXpDRFVkM24KdldBeHBjUXlYRGlybS8wSkRZTWtuYzhjK2Z4QmxQR3ZiT2cwWldOeVUwSVpqRmx3aDVwUnIrMnRkT3lhRkZrNApWNytmMkpRWXdKZWgzWDdQL0N6WldKMlQvbnVzaVZXd0Y2K0hueDQ2ZHVGTzhXSWJZTnJUU1hTQnFEV04vdWpZCjBwYUhwS1poUTJOVnV1M0t3a2JaTDUzRjBRM09EVjcydGtiTHJyajZvOUNGd3JGUFluV0owSWtsemN0d1VtQ24KNjd5TzlSVjVzcC83YlNxTkhYNFRuNmc9Ci0tLS0tRU5EIENFUlRJRklDQVRFEXAMPLE= ``` 出力: ``` { "WrappedKey": { "KeyMaterial": "308205A106092A864886F70D010702A08205923082058E020101310D300B06096086480165030402013082031F06092A864886F70D010703A08203100482030C020100318201F4308201F002010030819F308189310B300906035504061302555331193017060355040A0C104157532043727970746F6772617068793121301F060355040B0C18415753205061796D656E742043727970746F6772617068793111300F06035504080C0856697267696E69613115301306035504030C0C3037353535363935333735303112301006035504070C0941726C696E67746F6E021100C61EFF5D6A4FE93F5BD40FD8FF0852E8304506092A864886F70D0101073038300D06096086480165030402010500301806092A864886F70D010108300B0609608648016503040201300D06092A864886F70D0101090400048201008B09AFE9DFF1EA4E97F8651B6B3B51A3BFF68B0365F3956AD34A64B015185BB3FFB3DC7D5812B0D21D58436EAEC131F8110389E2A9F22DA146805A4D818BDCD6AA0387284188CEF5691565A849659C117AAD0042DF5D2C290386710B58A8C63A298C99280EB75861B793302F78299DE64853433227F23DBB383A605DA23620546DCA92B2D3CD8B486339D303844D807C2D6AF17CF1ABF191F63ACFF0E0F8A91AA5B22C1A0D9EE663854D1D76CEE37FE3A0113C8577B57F173ECD69FA752A8A1AEF49AB2A62D39F091FF9AA0FD4CB695D084637DBA7EF7DA2E657BBBF0C5FCC355DB37866B7BBD5AE065DC0FD399A8E0FC19C10943D5059507DC822DED6AFA67A3082010D06092A864886F70D0107013081FF06082A864886F70D030704085050B8007C2CE5608081E8DC683EECE2BF1FC1D209D5F6642E01E58DC76FF7926B576CB6884B6723C63DDE91D8E6C75DFC4E94F1CDDA8A3E863BE8A7E1DFCD2115E251675F73388D022A28247ED66D7892AA57800750A5F84313ACC3616449A703D7DFC770F50C816F224FB038E675FB1751916699FD00585C1B2EA19FECEE696611FA65B4E8516210D884E351201A888A47D874B1ACDDF4AE7F6F59D0780A5BE3E788DD6FB4E6AC1B9D966443881E9998A625CFB10A35D943B21A3ABB902CF68AD6F7FE7B0C18FF05B94C10E254017203541AFF71E440A42C8B915A84B341F923EF657280DB7B19F769E29725FF7E5999859C318202553082025102010130819E308189310B300906035504061302555331193017060355040A0C104157532043727970746F6772617068793121301F060355040B0C18415753205061796D656E742043727970746F6772617068793111300F06035504080C0856697267696E69613115301306035504030C0C3037353535363935333735303112301006035504070C0941726C696E67746F6E02106BD452CE836B7D2A717B69DB8FAF3679300B0609608648016503040201A0818A301806092A864886F70D010903310B06092A864886F70D010703301C06092A864886F70D010905310F170D3233303631333139303234305A301F06092A864886F70D0107013112041044303131324B30544230304530303030302F06092A864886F70D010904312204209AD3A76A89E2F58433DF669174A6F4D4B6B3D60A8A7341712CB666CA6AE4125E300D06092A864886F70D0101010500048201009BA48B242A227AD05243DBB99ACF6249D626CEF086DAFD8B064592EFF1205CFE6713D5FC373D8CD53AF9A88292E143A4B9C1887792E8E7F6310503B1FD8F0F89F735DFF11CC55114859B902841E4D163D64E19DFAE0151B93590C8D770E47E939DF08242897F9319DC6AB272C26DE2ACC539BF055CE528B139D61B45542FF35D2ABDE34EEF5BE19D1C48679187B455864EDD3D976CDC80070A6A6635DF5A00AF08CBBF309C4D59A4710A531A719562D390394A736E9F2DED502B2F766BA56727DFB0C6A92FD4D2BABC69BDDBD6B17EB376FA9ADD83C2974292447E63F26D168E66A4558ED97E417BDE97837188DB4F414A2219BAC50A8D726CD54C3C1EXAMPLE", "WrappedKeyMaterialFormat": "TR34_KEY_BLOCK" } } ``` 詳細については、「*AWS Payment Cryptography User Guide*」の「[Export keys](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-export.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ExportKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/export-key.html)」を参照してください。 ### `get-alias` 次のコード例は、`get-alias` を使用する方法を示しています。 **AWS CLI** **エイリアスを取得するには** 次の `get-alias` の例では、エイリアスに関連付けられたキーの ARN を返します。 ``` aws payment-cryptography get-alias \ --alias-name alias/sampleAlias1 ``` 出力: ``` { "Alias": { "AliasName": "alias/sampleAlias1", "KeyArn": "arn:aws:payment-cryptography:us-west-2:123456789012:key/kwapwa6qaifllw2h" } } ``` 詳細については、「*AWS Payment Cryptography ユーザーガイド*」の「[エイリアスについて](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/alias-about.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/get-alias.html)」を参照してください。 ### `get-key` 次のコード例は、`get-key` を使用する方法を示しています。 **AWS CLI** **キーのメタデータを取得するには** 次の `get-key` の例では、エイリアスに関連付けられたキーのメタデータを返します。このオペレーションは暗号化マテリアルを返しません。 ``` aws payment-cryptography get-key \ --key-identifier alias/sampleAlias1 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Payment Cryptography User Guide*」の「[Get keys](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/getkeys.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/get-key.html)」を参照してください。 ### `get-parameters-for-export` 次のコード例は、`get-parameters-for-export` を使用する方法を示しています。 **AWS CLI** **エクスポートプロセスを初期化するには** 次の `get-parameters-for-export` の例では、キーペアを生成し、キーに署名してから、証明書と証明書ルートを返します。 ``` aws payment-cryptography get-parameters-for-export \ --signing-key-algorithm RSA_2048 \ --key-material-type TR34_KEY_BLOCK ``` 出力: ``` { "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=" } ``` 詳細については、「*AWS Payment Cryptography User Guide*」の「[Export keys](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-export.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetParametersForExport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/get-parameters-for-export.html)」を参照してください。 ### `get-parameters-for-import` 次のコード例は、`get-parameters-for-import` を使用する方法を示しています。 **AWS CLI** **インポートプロセスを初期化するには** 次の `get-parameters-for-import` の例では、キーペアを生成し、キーに署名してから、証明書と証明書ルートを返します。 ``` aws payment-cryptography get-parameters-for-import \ --key-material-type TR34_KEY_BLOCK \ --wrapping-key-algorithm RSA_2048 ``` 出力: ``` { "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=" } ``` 詳細については、「*AWS Payment Cryptography User Guide*」の「[Import keys](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-import.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetParametersForImport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/get-parameters-for-import.html)」を参照してください。 ### `get-public-key-certificate` 次のコード例は、`get-public-key-certificate` を使用する方法を示しています。 **AWS CLI** **パブリックキーを返すには** 次の `get-public-key-certificate` の例では、キーペアのパブリックキー部分を返します。 ``` aws payment-cryptography get-public-key-certificate \ --key-identifier arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h ``` 出力: ``` { "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=" } ``` 詳細については、「*AWS Payment Cryptography User Guide*」の「[Get the public key/certificate associated with a key pair](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys.getpubliccertificate-example.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPublicKeyCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/get-public-key-certificate.html)」を参照してください。 ### `import-key` 次のコード例は、`import-key` を使用する方法を示しています。 **AWS CLI** **TR-34 キーをインポートするには** 次の `import-key` の例では、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 }}' ``` `signing-key-certificate.pem` の内容: ``` LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUV2RENDQXFTZ0F3SUJBZ0lRYWVCK25IbE1WZU1PR1ZiNjU1Q2JzREFOQmdrcWhraUc5dzBCQVEwRkFEQ0IKaVRFTE1Ba0dBMVVFQmhNQ1ZWTXhHVEFYQmdOVkJBb01FRUZYVXlCRGNubHdkRzluY21Gd2FIa3hJVEFmQmdOVgpCQXNNR0VGWFV5QlFZWGx0Wlc1MElFTnllWEIwYjJkeVlYQm9lVEVSTUE4R0ExVUVDQXdJVm1seVoybHVhV0V4CkZUQVRCZ05WQkFNTUREVXlPVEF5TnpRMU5UUTVOVEVTTUJBR0ExVUVCd3dKUVhKc2FXNW5kRzl1TUI0WERUSXoKTURZd09USXlNVEkxTUZvWERUSXpNRFl4TmpJek1USTFNRm93TERFVk1CTUdBMVVFQXd3TU5USTVNREkzTkRVMQpORGsxTVJNd0VRWURWUVFGRXdvek1EVTRNVGszTkRjNE1JSUJJakFOQmdrcWhraUc5dzBCQVFFRkFBT0NBUThBCk1JSUJDZ0tDQVFFQXdMc0dGb0pqOTVJY0UxL1p1OGZxak40SDVHTFJHVGZQSkFyWWJLbjA4WXVrQTE0SjRBSHEKWGR6ZlY5MjcvVTJZTWN2S3FsNlk5SVQwejZhTVBGbDVYemZWNU1YVW5YMlJxYTladU1ndDhGSDJJYWxsMEQ3bgo0V0RjUkg3TERQdEhXZTRaVmh3aExRVEFQa1I2dUxTWC84UDhSN2lrSWpkVkI4SytjVitnbHh0clB1Vkh5TzNxCjhXRUl3a1lYVTFDVjJybHptNklzWjcycjhPcXJWcHNiZEhERENBelJ2YUtPN3hMNU1RUGVFMFcvdkxmRGdrYmoKb2h4VHl6Z3dRSlJFK21tUXdCRmlIeXdaY2F5Y1FZdXdzTktoK0xPWXJpN0ZGM2lRRTJlYlY5Mm4zZER5NDRtcQpUSjFHUWJENndFM3ZHS0xnYXNqMVl0WVNSTk9xNld1UTV3SURBUUFCbzN3d2VqQUpCZ05WSFJNRUFqQUFNQjhHCkExVWRJd1FZTUJhQUZHMVBsWElaUGdETVU0WjVwRTc3dE8xYmV2eDVNQjBHQTFVZERnUVdCQlFwanByQXFoZGMKVmF2dElTRnBBNkswVzJMcmJUQU9CZ05WSFE4QkFmOEVCQU1DQmFBd0hRWURWUjBsQkJZd0ZBWUlLd1lCQlFVSApBd0VHQ0NzR0FRVUZCd01DTUEwR0NTcUdTSWIzRFFFQkRRVUFBNElDQVFCOXVxcFVadU1oK1kzQXhXSklNUkx5Cmlob2gvR0xIanh1aVhxK1IvdFRxbTBNYTA3R2dvbGxhRkdIZzZMei9ELy9ZRDB2UHdYc1dVOE5qY0Vib095aGcKc0hmay9hVGxjRnovZm51MVlkRUpvYUpFdW15bDkwSTBMNyswUmJNYXJScWU0bC9yQlQ4YTM3R0JyQ0x0ZUlyRgorcnp1cmovU1BDM1FiUWkvOVBzWmlieTFKMlFxTzVVRUJncEYreklaVk84dzgwMzVEK1YrUXhsY2RaUGVLS2JnCmI5WHNSeHF3cUZIVUVRM2tybXdVZUZveERlbm91QmxKMVFzOTVXUHBpVk9zYUFvbkJkYUtEbFBaRTlqdG1zZkwKMER3b1lRRy92bHdWN0pIVnNNd0dleml2VGJXaWFNdmZTTkxIMmVZMG9rblhFcHlHcmlWMjczSVFqVU1QTXBMNgpjODh3OUYzcTJnY0x6Nk0ycEFHUTZ0SVBrZ2c3aUZjbk9haGp4Ty9ORFZrS0xxbXZ0eFFlcUk2VDRveWRuWkVWCkdOMjBISStZcFVud09Eem1GL1k5TXZQQXFtdGJka2dZZGRJWExtbU9ORlF1dm4wenp0Tm01NzNTN0NSYWxCNTgKeFhyNm1iak1MQU1tcmZGQmNrU0NYaUZ6Y3gvNHJTRGJtbU9INWM0dGxiNEM3SzF5QU96NWo3OHhWOWNQOTM3SQpwczcrZUFZRkFpYTdzZGpuS3hNUDN4ZVVTM0tNS2FGMzg2TGRYbkRwdTFyczhVRWhPeDhqakt6RWplWU9qV3hLClo5Mjd1Yzd0b2kwZlcvT2tzT3NnWVlybmttSEhyd3p0NXRBc2llcjFyWXFGK2lYa1Y4TzRxSzI0bHc4cXFPanUKS3htVHMzY0NlTmdGNUZhVmhCV1Zjdz09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0= ``` `wrapped-key-block.pem` の内容: ``` 3082059806092A864886F70D010702A082058930820585020101310D300B06096086480165030402013082031606092A864886F70D010703A082030704820303020100318201F3308201EF02010030819E308189310B300906035504061302555331193017060355040A0C104157532043727970746F6772617068793121301F060355040B0C18415753205061796D656E742043727970746F6772617068793111300F06035504080C0856697267696E69613115301306035504030C0C3532393032373435353439353112301006035504070C0941726C696E67746F6E021026C5E52507841B72C59D9F0065548DC1304506092A864886F70D0101073038300D06096086480165030402010500301806092A864886F70D010108300B0609608648016503040201300D06092A864886F70D01010904000482010013D3C2E9405CA45A947BA6EA098DD5A83A7E6CFF4E140B141634EBFF9E0F78057B5C22013574BA8C8D8D64B43C391E1D9CDF081B33D15CDE3AB2DB21CAE7380E64B0A09A8C45B8A0F87659638E6E30D4351E9B941EDD384183DA169ADDF71FC64E06487F8750B74B2CD3AB4F8534C024AE04BD7C070CB685A250EB2A8C1EEDEBFA387935466D152E063D3EBEDD6231216EEE5145983C74D755C050D191E6E41DC2BDB09E78CDA203C2767270E3E56C6E24EB1090904462743B054098DE278A18C71577CAE1EC13CF776055224F299DBF1BC96C11F339DEE1A2CD130A275959820FBE5C34C0CB21DB6404F868B348D5A6F8ED8E5DC5BC681F6115BA278879FF8F3082010506092A864886F70D0107013081F706082A864886F70D0307040857F8BFE99B4493AD8081E05DEE59D9E60520DB8A15869BB840F1CC908DAE6CC6F6BE79DDF72DD8EA84F881D7DFB4A186CDC622B29E3F97AEB7C00872D1BB47FE235D9204F80A4D3EF502309ECD967F8F70A2F741738ACE7B7CA0AA2EBB0DACD3126F7831F79AF6DC3C74CEBF7D0947301245F42C59508FBC0318C03F02E37EDF014C4D0170ACC4E992EC7E9B85D95BF87F75FD2E0B938E2D8E807872DE4017F8530D59A48C9F68AF5BEC1B2115D7555C248F980DF28C69619E508317F0C20461AE26CD0D55896FEE71E1EA89F7F9B5DC047F9BD063210E1F09D9566EF2AF6472AD44A8ACC0180AC1995CDE318202553082025102010130819E308189310B300906035504061302555331193017060355040A0C104157532043727970746F6772617068793121301F060355040B0C18415753205061796D656E742043727970746F6772617068793111300F06035504080C0856697267696E69613115301306035504030C0C3532393032373435353439353112301006035504070C0941726C696E67746F6E021069E07E9C794C55E30E1956FAE7909BB0300B0609608648016503040201A0818A301806092A864886F70D010903310B06092A864886F70D010703301C06092A864886F70D010905310F170D3233303630393233333934365A301F06092A864886F70D0107013112041044303131324330544330304530303030302F06092A864886F70D01090431220420D6413C502DC4552B495B9A8449F9A3BF9E6DCB31AD56A1D158DB482BDF06EEAD300D06092A864886F70D010101050004820100313BA7BCDFE6C55F3544A8E7D9973A346DDAD17CC5C506DE72B8B7E490891702E753C445FED78D5477C5E5A2BF63378B2F12CE6C22C1A543BCC41FA978568F65C0171DBF3E438E70FD68DAB52BA1DEB294C4ED92CD6EAA684B4352AF6C53924048931595FC7F1FF642E82B12DBD8B8578DA200DC0CCE2FA075897CDA6D5257C78DC2B515015CC414E78B49075AFF333C7CEAFF81F5EEC44C5C9F6BD32898E6983A7CEA40DD5C0CF9CD51DB3E712ED1C755E0A9DA38286872B46D7119088A76728DC08AECB0F624B34E15349E5B2334900E57885A6461AC6E74B35A3FFF5C010ACE5F15DE9D867A5160D30217997E7DE6319A74F5D55D44A934908A3BC1602D22 ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Payment Cryptography User Guide*」の「[Import keys](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-import.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ImportKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/import-key.html)」を参照してください。 ### `list-aliases` 次のコード例は、`list-aliases` を使用する方法を示しています。 **AWS CLI** **エイリアスのリストを取得するには** 次の `list-aliases` の例では、このリージョンのアカウント内のすべてのエイリアスを表示します。 ``` aws payment-cryptography list-aliases ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS Payment Cryptography ユーザーガイド*」の「[エイリアスについて](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/alias-about.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[ListAliases](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/list-aliases.html)」を参照してください。** ### `list-keys` 次のコード例は、`list-keys` を使用する方法を示しています。 **AWS CLI** **キーのリストを取得するには** 次の `list-keys` の例では、このリージョンのアカウントのすべてのキーを表示します。 ``` aws payment-cryptography list-keys ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS Payment Cryptography User Guide*」の「[List keys](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/alias-about.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[ListKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/list-keys.html)」を参照してください。** ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **キーのタグのリストを取得するには** 次の `list-tags-for-resource` の例では、キーのタグを取得します。 ``` aws payment-cryptography list-tags-for-resource \ --resource-arn arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h ``` 出力: ``` { "Tags": [ { "Key": "BIN", "Value": "20151120" }, { "Key": "Project", "Value": "Production" } ] } ``` 詳細については、「*AWS Payment Cryptography User Guide*」の「[Managing key tags with API operations](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/manage-tags-api.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/list-tags-for-resource.html)」を参照してください。 ### `restore-key` 次のコード例は、`restore-key` を使用する方法を示しています。 **AWS CLI** **削除予定のキーを復元するには** 次の `restore-key` の例では、キーの削除をキャンセルします。 ``` aws payment-cryptography restore-key \ --key-identifier arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Payment Cryptography ユーザーガイド*」の「[キーの削除](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-deleting.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RestoreKey](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/restore-key.html)」を参照してください。 ### `start-key-usage` 次のコード例は、`start-key-usage` を使用する方法を示しています。 **AWS CLI** **キーを有効にするには** 次の `start-key-usage` の例では、キーの使用を有効にします。 ``` aws payment-cryptography start-key-usage \ --key-identifier arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Payment Cryptography User Guide*」の「[Enabling and disabling keys](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-enable-disable.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartKeyUsage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/start-key-usage.html)」を参照してください。 ### `stop-key-usage` 次のコード例は、`stop-key-usage` を使用する方法を示しています。 **AWS CLI** **キーを無効にするには** 次の `stop-key-usage` の例では、キーを無効にします。 ``` aws payment-cryptography stop-key-usage \ --key-identifier arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Payment Cryptography User Guide*」の「[Enabling and disabling keys](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-enable-disable.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopKeyUsage](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/stop-key-usage.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **キーにタグを付けるには** 次の `tag-resource` の例では、キーにタグを付けます。 ``` aws payment-cryptography tag-resource \ --resource-arn arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h \ --tags Key=sampleTag,Value=sampleValue ``` このコマンドでは何も出力されません。 詳細については、「*AWS Payment Cryptography User Guide*」の「[Managing key tags](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/manage-tags-api.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **キーからタグを削除するには** 次の `untag-resource` の例では、タグをキーから削除します。 ``` aws payment-cryptography untag-resource \ --resource-arn arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h \ --tag-keys sampleTag ``` このコマンドでは何も出力されません。 詳細については、「*AWS Payment Cryptography User Guide*」の「[Managing key tags](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/manage-tags-api.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/untag-resource.html)」を参照してください。 ### `update-alias` 次のコード例は、`update-alias` を使用する方法を示しています。 **AWS CLI** **エイリアスを更新するには** 次の `update-alias` の例では、エイリアスを別のキーに関連付けます。 ``` aws payment-cryptography update-alias \ --alias-name alias/sampleAlias1 \ --key-arn arn:aws:payment-cryptography:us-east-2:123456789012:key/tqv5yij6wtxx64pi ``` 出力: ``` { "Alias": { "AliasName": "alias/sampleAlias1", "KeyArn": "arn:aws:payment-cryptography:us-west-2:123456789012:key/tqv5yij6wtxx64pi " } } ``` 詳細については、「*AWS Payment Cryptography ユーザーガイド*」の「[エイリアスについて](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/alias-about.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[UpdateAlias](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography/update-alias.html)」を参照してください。** # AWS CLI を使用した AWS Payment Cryptography Data Plane の例 次のコードサンプルは、AWS Payment Cryptography Data Plane で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `decrypt-data` 次のコード例は、`decrypt-data` を使用する方法を示しています。 **AWS CLI** **暗号文を復号するには** 次の `decrypt-data` の例では、対称キーを使用して暗号文データを復号します。このオペレーションでは、キーの `KeyModesOfUse` が `Decrypt` に設定され、`KeyUsage` が `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}' ``` 出力: ``` { "KeyArn": "arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h", "KeyCheckValue": "71D7AE", "PlainText": "31323334313233343132333431323334" } ``` 詳細については、「*AWS Payment Cryptography User Guide*」の「[Decrypt data](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/decrypt-data.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DecryptData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography-data/decrypt-data.html)」を参照してください。 ### `encrypt-data` 次のコード例は、`encrypt-data` を使用する方法を示しています。 **AWS CLI** **データを暗号化するには** 次の `encrypt-data` の例では、対称キーを使用してプレーンテキストデータを暗号化します。このオペレーションでは、キーの `KeyModesOfUse` が `Encrypt` に設定され、`KeyUsage` が `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}' ``` 出力: ``` { "KeyArn": "arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h", "KeyCheckValue": "71D7AE", "CipherText": "33612AB9D6929C3A828EB6030082B2BD" } ``` 詳細については、「*AWS Payment Cryptography User Guide*」の「[Encrypt data](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/encrypt-data.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[EncryptData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography-data/encrypt-data.html)」を参照してください。 ### `generate-card-validation-data` 次のコード例は、`generate-card-validation-data` を使用する方法を示しています。 **AWS CLI** **CVV を生成するには** 次の `generate-card-validation-data` の例では、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} ``` 出力: ``` { "KeyArn": "arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h", "KeyCheckValue": "CADDA1", "ValidationData": "801" } ``` 詳細については、「*AWS Payment Cryptography User Guide*」の「[Generate card data](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/generate-card-data.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GenerateCardValidationData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography-data/generate-card-validation-data.html)」を参照してください。 ### `generate-mac` 次のコード例は、`generate-mac` を使用する方法を示しています。 **AWS CLI** **MAC を生成するには** 次の `generate-card-validation-data` の例では、HMAC\$1SHA256 アルゴリズムと HMAC 暗号化キーを使用してカードデータ認証用の Hash-based Message Authentication Code (HMAC) を生成します。キーでは `KeyUsage` が `TR31_M7_HMAC_KEY` に設定され、`KeyModesOfUse` が `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 ``` 出力: ``` { "KeyArn": "arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h, "KeyCheckValue": "2976E7", "Mac": "ED87F26E961C6D0DDB78DA5038AA2BDDEA0DCE03E5B5E96BDDD494F4A7AA470C" } ``` 詳細については、「*AWS Payment Cryptography User Guide*」の「[Generate MAC](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/generate-mac.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GenerateMac](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography-data/generate-mac.html)」を参照してください。 ### `generate-pin-data` 次のコード例は、`generate-pin-data` を使用する方法を示しています。 **AWS CLI** **PIN を生成するには** 次の `generate-card-validation-data` の例では、Visa PIN スキームを使用して新しいランダム PIN を生成します。 ``` 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} ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Payment Cryptography User Guide*」の「[Generate PIN data](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/generate-pin-data.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GeneratePinData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography-data/generate-pin-data.html)」を参照してください。 ### `re-encrypt-data` 次のコード例は、`re-encrypt-data` を使用する方法を示しています。 **AWS CLI** **別のキーを使用してデータを再暗号化するには** 次の `re-encrypt-data` の例では、AES 対称キーを使用して暗号化された暗号文を復号し、トランザクション単位の派生ユニークキー (DUKPT) を使用して再暗号化します。 ``` 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"}}' ``` 出力: ``` { "CipherText": "F94959DA30EEFF0C035483C6067667CF6796E3C1AD28C2B61F9CFEB772A8DD41C0D6822931E0D3B1", "KeyArn": "arn:aws:payment-cryptography:us-west-2:111122223333:key/jl6ythkcvzesbxen", "KeyCheckValue": "2E8CD9" } ``` 詳細については、「*AWS Payment Cryptography User Guide*」の「[Encrypt and decrypt data](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops.encryptdecrypt.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ReEncryptData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography-data/re-encrypt-data.html)」を参照してください。 ### `translate-pin-data` 次のコード例は、`translate-pin-data` を使用する方法を示しています。 **AWS CLI** **PIN データを変換するには** 次の `translate-pin-data` の例では、ISO 0 PIN ブロックを使用する PEK TDES 暗号化から、DUKPT アルゴリズムを使用する AES ISO 4 PIN ブロックに PIN を変換します。 ``` 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" ``` 出力: ``` { "PinBlock": "1F4209C670E49F83E75CC72E81B787D9", "KeyArn": "arn:aws:payment-cryptography:us-east-2:111122223333:key/ivi5ksfsuplneuyt "KeyCheckValue": "7CC9E2" } ``` 詳細については、「*AWS Payment Cryptography User Guide*」の「[Translate PIN data](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/translate-pin-data.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TranslatePinData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography-data/translate-pin-data.html)」を参照してください。 ### `verify-auth-request-cryptogram` 次のコード例は、`verify-auth-request-cryptogram` を使用する方法を示しています。 **AWS CLI** **認証リクエストを検証するには** 次の `verify-auth-request-cryptogram` の例では、Authorization Request Cryptogram (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" ``` 出力: ``` { "AuthResponseValue": "D899B8C6FBF971AA", "KeyArn": "arn:aws:payment-cryptography:us-west-2:111122223333:key/pboipdfzd4mdklya", "KeyCheckValue": "985792" } ``` 詳細については、「*AWS Payment Cryptography User Guide*」の「[Verify auth request (ARQC) cryptogram](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/data-operations.verifyauthrequestcryptogram.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[VerifyAuthRequestCryptogram](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography-data/verify-auth-request-cryptogram.html)」を参照してください。 ### `verify-card-validation-data` 次のコード例は、`verify-card-validation-data` を使用する方法を示しています。 **AWS CLI** **CVV を検証するには** 次の `verify-card-validation-data` の例では、PAN の CVV/CVV2 を検証します。 ``` 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 ``` 出力: ``` { "KeyArn": "arn:aws:payment-cryptography:us-east-2:111122223333:key/tqv5yij6wtxx64pi", "KeyCheckValue": "CADDA1" } ``` 詳細については、「*AWS Payment Cryptography User Guide*」の「[Verify card data](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/verify-card-data.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[VerifyCardValidationData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography-data/verify-card-validation-data.html)」を参照してください。 ### `verify-mac` 次のコード例は、`verify-mac` を使用する方法を示しています。 **AWS CLI** **MAC を検証するには** 次の `verify-mac` の例では、HMAC\$1SHA256 アルゴリズムと HMAC 暗号化キーを使用してカードデータ認証用の Hash-based Message Authentication Code (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 ``` 出力: ``` { "KeyArn": "arn:aws:payment-cryptography:us-east-2:111122223333:key/qnobl5lghrzunce6, "KeyCheckValue": "2976E7", } ``` 詳細については、「*AWS Payment Cryptography User Guide*」の「[Verify MAC](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/verify-mac.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[VerifyMac](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography-data/verify-mac.html)」を参照してください。 ### `verify-pin-data` 次のコード例は、`verify-pin-data` を使用する方法を示しています。 **AWS CLI** **PIN を検証するには** 次の `verify-pin-data` の例では、PAN の PIN を検証します。 ``` 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 ``` 出力: ``` { "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", } ``` 詳細については、「*AWS Payment Cryptography User Guide*」の「[Verify PIN data](https://docs.aws.amazon.com/payment-cryptography/latest/userguide/verify-pin-data.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[VerifyPinData](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/payment-cryptography-data/verify-pin-data.html)」を参照してください。 # AWS CLI を使用した Amazon Pinpoint の例 次のコード例は、Amazon Pinpoint で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-app` 次のコード例は、`create-app` を使用する方法を示しています。 **AWS CLI** **例 1: アプリケーションを作成するには** 次の `create-app` の例は、新しいアプリケーション (プロジェクト) を作成します。 ``` aws pinpoint create-app \ --create-application-request Name=ExampleCorp ``` 出力: ``` { "ApplicationResponse": { "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example", "Id": "810c7aab86d42fb2b56c8c966example", "Name": "ExampleCorp", "tags": {} } } ``` **例 2: タグが付けられたアプリケーションを作成するには** 次の `create-app` の例は、新しいアプリケーション (プロジェクト) を作成し、タグ (キーと値) をアプリケーションに関連付けます。 ``` aws pinpoint create-app \ --create-application-request Name=ExampleCorp,tags={"Stack"="Test"} ``` 出力: ``` { "ApplicationResponse": { "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example", "Id": "810c7aab86d42fb2b56c8c966example", "Name": "ExampleCorp", "tags": { "Stack": "Test" } } } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[CreateApp](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/create-app.html)」を参照してください。** ### `create-sms-template` 次のコード例は、`create-sms-template` を使用する方法を示しています。 **AWS CLI** **SMS チャンネルを介して送信されるメッセージのメッセージテンプレートを作成します** 次の `create-sms-template` の例では、SMS メッセージテンプレートを作成します。 ``` aws pinpoint create-sms-template \ --template-name TestTemplate \ --sms-template-request file://myfile.json \ --region us-east-1 ``` `myfile.json` の内容: ``` { "Body": "hello\n how are you?\n food is good", "TemplateDescription": "Test SMS Template" } ``` 出力: ``` { "CreateTemplateMessageBody": { "Arn": "arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:templates/TestTemplate/SMS", "Message": "Created", "RequestID": "8c36b17f-a0b0-400f-ac21-29e9b62a975d" } } ``` 詳細については、「*Amazon Pinpoint User Guide*」の「[Amazon Pinpoint message templates](https://docs.aws.amazon.com/pinpoint/latest/userguide/messages-templates.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateSmsTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/create-sms-template.html)」を参照してください。 ### `delete-app` 次のコード例は、`delete-app` を使用する方法を示しています。 **AWS CLI** **アプリケーションを削除するには** 次の `delete-app` の例は、アプリケーション (プロジェクト) を削除します。 ``` aws pinpoint delete-app \ --application-id 810c7aab86d42fb2b56c8c966example ``` 出力: ``` { "ApplicationResponse": { "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example", "Id": "810c7aab86d42fb2b56c8c966example", "Name": "ExampleCorp", "tags": {} } } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[DeleteApp](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/delete-app.html)」を参照してください。** ### `get-apns-channel` 次のコード例は、`get-apns-channel` を使用する方法を示しています。 **AWS CLI** **アプリケーションの APN チャネルのステータスと設定に関する情報を取得するには** 次の `get-apns-channel` の例では、アプリケーションの APN チャネルのステータスと設定に関する情報を取得します。 ``` aws pinpoint get-apns-channel \ --application-id 9ab1068eb0a6461c86cce7f27ce0efd7 \ --region us-east-1 ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetApnsChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-apns-channel.html)」を参照してください。 ### `get-app` 次のコード例は、`get-app` を使用する方法を示しています。 **AWS CLI** **アプリケーション (プロジェクト) に関する情報を取得するには** 次の `get-app` の例では、アプリケーション (プロジェクト) に関する情報を取得します。 ``` aws pinpoint get-app \ --application-id 810c7aab86d42fb2b56c8c966example \ --region us-east-1 ``` 出力: ``` { "ApplicationResponse": { "Arn": "arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example", "Id": "810c7aab86d42fb2b56c8c966example", "Name": "ExampleCorp", "tags": { "Year": "2019", "Stack": "Production" } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetApp](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-app.html)」を参照してください。 ### `get-apps` 次のコード例は、`get-apps` を使用する方法を示しています。 **AWS CLI** **すべてのアプリケーションに関する情報を取得するには** 次の `get-apps` の例では、すべてのアプリケーション (プロジェクト) に関する情報を取得します。 ``` aws pinpoint get-apps ``` 出力: ``` { "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" } } ``` `NextToken` レスポンス値の存在は、使用可能な出力がさらにあることを示します。コマンドを再度呼び出し、その値を `NextToken` 入力パラメータとして指定します。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetApps](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-apps.html)」を参照してください。 ### `get-campaign` 次のコード例は、`get-campaign` を使用する方法を示しています。 **AWS CLI** **キャンペーンのステータス、構成、およびその他の設定に関する情報を取得するには** 次の `get-campaign` の例では、キャンペーンのステータス、構成、およびその他の設定に関する情報を取得します。 ``` aws pinpoint get-campaign \ --application-id 6e0b7591a90841d2b5d93fa11143e5a7 \ --campaign-id a1e63c6cc0eb43ed826ffcc3cc90b30d \ --region us-east-1 ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetCampaign](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-campaign.html)」を参照してください。 ### `get-campaigns` 次のコード例は、`get-campaigns` を使用する方法を示しています。 **AWS CLI** **アプリケーションに関連付けられているすべてのキャンペーンのステータス、構成、およびその他の設定に関する情報を取得するには** 次の `get-campaigns` の例では、アプリケーションに関連付けられているすべてのキャンペーンのステータス、構成、およびその他の設定に関する情報を取得します。 ``` aws pinpoint get-campaigns \ --application-id 6e0b7591a90841d2b5d93fa11143e5a7 \ --region us-east-1 ``` 出力: ``` { "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 } ] } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetCampaigns](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-campaigns.html)」を参照してください。 ### `get-channels` 次のコード例は、`get-channels` を使用する方法を示しています。 **AWS CLI** **アプリケーションの各チャンネルの履歴とステータスに関する情報を取得するには** 次の `get-channels` の例では、アプリケーションの各チャンネルの履歴とステータスに関する情報を取得します。 ``` aws pinpoint get-channels \ --application-id 6e0b7591a90841d2b5d93fa11143e5a7 \ --region us-east-1 ``` 出力: ``` { "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 } } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetChannels](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-channels.html)」を参照してください。 ### `get-email-channel` 次のコード例は、`get-email-channel` を使用する方法を示しています。 **AWS CLI** **アプリケーションの E メールチャネルのステータスと設定に関する情報を取得するには** 次の `get-email-channel` の例では、アプリケーションの E メールチャネルのステータスと設定を取得します。 ``` aws pinpoint get-email-channel \ --application-id 6e0b7591a90841d2b5d93fa11143e5a7 \ --region us-east-1 ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetEmailChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-email-channel.html)」を参照してください。 ### `get-endpoint` 次のコード例は、`get-endpoint` を使用する方法を示しています。 **AWS CLI** **アプリケーションの特定のエンドポイントの設定と属性に関する情報を取得するには** 次の `get-endpoint` の例は、アプリケーションの指定されたエンドポイントの設定と属性に関する情報を取得します。 ``` aws pinpoint get-endpoint \ --application-id 611e3e3cdd47474c9c1399a505665b91 \ --endpoint-id testendpoint \ --region us-east-1 ``` 出力: ``` { "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" } } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-endpoint.html)」を参照してください。 ### `get-gcm-channel` 次のコード例は、`get-gcm-channel` を使用する方法を示しています。 **AWS CLI** **アプリケーションの GCM チャネルのステータスと設定に関する情報を取得するには** 次の `get-gcm-channel` の例では、アプリケーションの GCM チャネルのステータスと設定に関する情報を取得します。 ``` aws pinpoint get-gcm-channel \ --application-id 6e0b7591a90841d2b5d93fa11143e5a7 \ --region us-east-1 ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetGcmChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-gcm-channel.html)」を参照してください。 ### `get-sms-channel` 次のコード例は、`get-sms-channel` を使用する方法を示しています。 **AWS CLI** **アプリケーションの SMS チャネルのステータスおよび設定に関する情報を取得するには** 次の `get-sms-channel` の例は、アプリケーションの SMS チャネルのステータスと設定を取得します。 ``` aws pinpoint get-sms-channel \ --application-id 6e0b7591a90841d2b5d93fa11143e5a7 \ --region us-east-1 ``` 出力: ``` { "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 } } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[GetSmsChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-sms-channel.html)」を参照してください。** ### `get-sms-template` 次のコード例は、`get-sms-template` を使用する方法を示しています。 **AWS CLI** **SMS チャネルを介して送信されるメッセージのメッセージテンプレートの内容と設定を取得します** 次の `get-sms-template` の例では、SMS メッセージテンプレートの内容と設定を取得します。 ``` aws pinpoint get-sms-template \ --template-name TestTemplate \ --region us-east-1 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Pinpoint User Guide*」の「[Amazon Pinpoint message templates](https://docs.aws.amazon.com/pinpoint/latest/userguide/messages-templates.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetSmsTemplate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-sms-template.html)」を参照してください。 ### `get-voice-channel` 次のコード例は、`get-voice-channel` を使用する方法を示しています。 **AWS CLI** **アプリケーションの音声チャンネルのステータスと設定に関する情報を取得するには** 次の `get-voice-channel` の例では、アプリケーションの音声チャネルのステータスと設定を取得します。 ``` aws pinpoint get-voice-channel \ --application-id 6e0b7591a90841d2b5d93fa11143e5a7 \ --region us-east-1 ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetVoiceChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/get-voice-channel.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **リソースのタグの一覧を取得するには** 次の `list-tags-for-resource` の例では、指定されたリソースに関連付けられているすべてのタグ (キー名と値) を取得します。 ``` aws pinpoint list-tags-for-resource \ --resource-arn arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example ``` 出力: ``` { "TagsModel": { "tags": { "Year": "2019", "Stack": "Production" } } } ``` 詳細については、「*Amazon Pinpoint Developer Guide*」の「Tagging Amazon Pinpoint Resources 」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/list-tags-for-resource.html)」を参照してください。 ### `phone-number-validate` 次のコード例は、`phone-number-validate` を使用する方法を示しています。 **AWS CLI** **電話番号に関する情報を取得します** 次の `phone-number-validate` では、電話番号に関する情報を取得します。　 ``` aws pinpoint phone-number-validate \ --number-validate-request PhoneNumber="+12065550142" \ --region us-east-1 ``` 出力: ``` { "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" } } ``` 詳細については、「Amazon Pinpoint ユーザーガイド」の「[Amazon Pinpoint SMS チャンネル](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PhoneNumberValidate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/phone-number-validate.html)」を参照してください。 ### `send-messages` 次のコード例は、`send-messages` を使用する方法を示しています。 **AWS CLI** **アプリケーションのエンドポイントを使用して SMS メッセージを送信するには** 次の `send-messages` の例は、エンドポイントを使用してアプリケーションにダイレクトメッセージを送信します。 ``` aws pinpoint send-messages \ --application-id 611e3e3cdd47474c9c1399a505665b91 \ --message-request file://myfile.json \ --region us-west-2 ``` `myfile.json` の内容: ``` { "MessageConfiguration": { "SMSMessage": { "Body": "hello, how are you?" } }, "Endpoints": { "testendpoint": {} } } ``` 出力: ``` { "MessageResponse": { "ApplicationId": "611e3e3cdd47474c9c1399a505665b91", "EndpointResult": { "testendpoint": { "Address": "+12345678900", "DeliveryStatus": "SUCCESSFUL", "MessageId": "itnuqhai5alf1n6ahv3udc05n7hhddr6gb3lq6g0", "StatusCode": 200, "StatusMessage": "MessageId: itnuqhai5alf1n6ahv3udc05n7hhddr6gb3lq6g0" } }, "RequestId": "c7e23264-04b2-4a46-b800-d24923f74753" } } ``` 詳細については、「Amazon Pinpoint ユーザーガイド」の「[Amazon Pinpoint SMS チャンネル](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンス**の「[SendMessages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/send-messages.html)」を参照してください。 ### `send-users-messages` 次のコード例は、`send-users-messages` を使用する方法を示しています。 **AWS CLI** **アプリケーションのユーザーに SMS メッセージを送信するには** 次の `send-users-messages` の例では、アプリケーションのユーザー向けのダイレクトメッセージを送信します。 ``` aws pinpoint send-users-messages \ --application-id 611e3e3cdd47474c9c1399a505665b91 \ --send-users-message-request file://myfile.json \ --region us-west-2 ``` `myfile.json` の内容: ``` { "MessageConfiguration": { "SMSMessage": { "Body": "hello, how are you?" } }, "Users": { "testuser": {} } } ``` 出力: ``` { "SendUsersMessageResponse": { "ApplicationId": "611e3e3cdd47474c9c1399a505665b91", "RequestId": "e0b12cf5-2359-11e9-bb0b-d5fb91876b25", "Result": { "testuser": { "testuserendpoint": { "DeliveryStatus": "SUCCESSFUL", "MessageId": "7qu4hk5bqhda3i7i2n4pjf98qcuh8b7p45ifsmo0", "StatusCode": 200, "StatusMessage": "MessageId: 7qu4hk5bqhda3i7i2n4pjf98qcuh8b7p45ifsmo0", "Address": "+12345678900" } } } } } ``` 詳細については、「Amazon Pinpoint ユーザーガイド」の「[Amazon Pinpoint SMS チャンネル](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SendUsersMessages](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/send-users-messages.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **リソースにタグを追加するには** 次の例では、リソースに 2 つのタグ (キー名と値) を追加します。 ``` aws pinpoint list-tags-for-resource \ --resource-arn arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example \ --tags-model tags={Stack=Production,Year=2019} ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Pinpoint Developer Guide*」の「Tagging Amazon Pinpoint Resources 」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **例 1: リソースからタグを削除するには** 次の `untag-resource` の例では、指定されたタグ (キー名と値) をリソースから削除します。 ``` aws pinpoint untag-resource \ --resource-arn arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example \ --tag-keys Year ``` このコマンドでは何も出力されません。 **例 2: リソースから複数のタグを削除するには** 次の `untag-resource` の例では、指定されたタグ (キー名と値) をリソースから削除します。 ``` aws pinpoint untag-resource \ --resource-arn arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example \ --tag-keys Year Stack ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Pinpoint Developer Guide*」の「Tagging Amazon Pinpoint Resources 」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/untag-resource.html)」を参照してください。 ### `update-sms-channel` 次のコード例は、`update-sms-channel` を使用する方法を示しています。 **AWS CLI** **SMS チャネルを有効にするか、アプリケーションの SMS チャネルのステータスと設定を更新するには** 次の `update-sms-channel` の例では、アプリケーションの SMS チャネルの SMS チャネルを有効にします。 ``` aws pinpoint update-sms-channel \ --application-id 611e3e3cdd47474c9c1399a505665b91 \ --sms-channel-request Enabled=true \ --region us-west-2 ``` 出力: ``` { "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 } } ``` 詳細については、「Amazon Pinpoint ユーザーガイド」の「[Amazon Pinpoint SMS チャンネル](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateSmsChannel](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pinpoint/update-sms-channel.html)」を参照してください。 # AWS CLI を使用する Amazon Polly の例 次のコード例は、Amazon Polly で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `delete-lexicon` 次のコード例は、`delete-lexicon` を使用する方法を示しています。 **AWS CLI** **レキシコンを削除するには** 次の `delete-lexicon` の例は、指定されたレキシコンを削除します。 ``` aws polly delete-lexicon \ --name w3c ``` このコマンドでは何も出力されません。 詳細については、「Amazon Polly ディベロッパーガイド」の「[DeleteLexicon オペレーションの使用](https://docs.aws.amazon.com/polly/latest/dg/gs-delete-lexicon.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[DeleteLexicon](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/polly/delete-lexicon.html)」を参照してください。** ### `get-lexicon` 次のコード例は、`get-lexicon` を使用する方法を示しています。 **AWS CLI** **レキシコンの内容を取得するには** 次の `get-lexicon` の例は、指定された発音レキシコンの内容を取得します。 ``` aws polly get-lexicon \ --name w3c ``` 出力: ``` { "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 } } ``` 詳細については、「Amazon Polly ディベロッパーガイド」の「[GetLexicon オペレーションの使用](https://docs.aws.amazon.com/polly/latest/dg/gs-get-lexicon.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[GetLexicon](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/polly/get-lexicon.html)」を参照してください。** ### `get-speech-synthesis-task` 次のコード例は、`get-speech-synthesis-task` を使用する方法を示しています。 **AWS CLI** **音声合成タスクに関する情報を取得するには** 次の `get-speech-synthesis-task` の例は、指定された音声合成タスクに関する情報を取得します。 ``` aws polly get-speech-synthesis-task \ --task-id 70b61c0f-57ce-4715-a247-cae8729dcce9 ``` 出力: ``` { "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" } } ``` 詳細については、「Amazon Polly ディベロッパーガイド」の「[長いオーディオファイルの作成 (CLI)](https://docs.aws.amazon.com/polly/latest/dg/longer-cli.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[GetSpeechSynthesisTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/polly/get-speech-synthesis-task.html)」を参照してください。** ### `list-lexicons` 次のコード例は、`list-lexicons` を使用する方法を示しています。 **AWS CLI** **レキシコンを一覧表示するには** 次の `list-lexicons` の例は、発音レキシコンを一覧表示します。 ``` aws polly list-lexicons ``` 出力: ``` { "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 } } ] } ``` 詳細については、「Amazon Polly ディベロッパーガイド」の「[ListLexicons オペレーションの使用](https://docs.aws.amazon.com/polly/latest/dg/gs-list-lexicons.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[ListLexicons](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/polly/list-lexicons.html)」を参照してください。** ### `list-speech-synthesis-tasks` 次のコード例は、`list-speech-synthesis-tasks` を使用する方法を示しています。 **AWS CLI** **音声合成タスクを一覧表示するには** 次の `list-speech-synthesis-tasks` の例では、音声合成タスクを一覧表示します。 ``` aws polly list-speech-synthesis-tasks ``` 出力: ``` { "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" } ] } ``` 詳細については、「Amazon Polly ディベロッパーガイド」の「[長いオーディオファイルの作成 (CLI)](https://docs.aws.amazon.com/polly/latest/dg/longer-cli.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListSpeechSynthesisTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/polly/list-speech-synthesis-tasks.html)」を参照してください。 ### `put-lexicon` 次のコード例は、`put-lexicon` を使用する方法を示しています。 **AWS CLI** **レキシコンを保存するには** 次の `put-lexicon` の例は、指定された発音レキシコンを保存します。`example.pls` ファイルは W3C PLS 準拠のレキシコンを指定します。 ``` aws polly put-lexicon \ --name w3c \ --content file://example.pls ``` `example.pls` の内容 ``` { W3C World Wide Web Consortium } ``` このコマンドでは何も出力されません。 詳細については、「Amazon Polly ディベロッパーガイド」の「[PutLexicon オペレーションの使用](https://docs.aws.amazon.com/polly/latest/dg/gs-put-lexicon.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[PutLexicon](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/polly/put-lexicon.html)」を参照してください。** ### `start-speech-synthesis-task` 次のコード例は、`start-speech-synthesis-task` を使用する方法を示しています。 **AWS CLI** **テキストを合成するには** 次の `start-speech-synthesis-task` の例は、`text_file.txt` 内のテキストを合成し、生成された MP3 ファイルを指定されたバケットに保存します。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、「Amazon Polly ディベロッパーガイド」の「[長いオーディオファイルの作成 (CLI)](https://docs.aws.amazon.com/polly/latest/dg/longer-cli.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[StartSpeechSynthesisTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/polly/start-speech-synthesis-task.html)」を参照してください。** # AWS の料金表 examples using AWS CLI 次のコード例では、AWS の料金表 で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `describe-services` 次のコード例は、`describe-services` を使用する方法を示しています。 **AWS CLI** **サービスメタデータを取得するには** この例では、Amazon EC2 サービスコードのメタデータを取得します。 コマンド: ``` aws pricing describe-services --service-code AmazonEC2 --format-version aws_v1 --max-items 1 ``` 出力: ``` { "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" } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeServices](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pricing/describe-services.html)」を参照してください。 ### `get-attribute-values` 次のコード例は、`get-attribute-values` を使用する方法を示しています。 **AWS CLI** **属性値のリストを取得するには** 次の `get-attribute-values` の例では、特定の属性で使用できる値のリストを取得します。 ``` aws pricing get-attribute-values \ --service-code AmazonEC2 \ --attribute-name volumeType \ --max-items 2 ``` 出力: ``` { "NextToken": "eyJOZXh0VG9rZW4iOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ==", "AttributeValues": [ { "Value": "Cold HDD" }, { "Value": "General Purpose" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetAttributeValues](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pricing/get-attribute-values.html)」を参照してください。 ### `get-products` 次のコード例は、`get-products` を使用する方法を示しています。 **AWS CLI** **製品のリストを取得するには** この例では、指定された条件に一致する製品のリストを取得します。 コマンド: ``` 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" } ] ``` 出力: ``` { "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\"}" ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetProducts](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pricing/get-products.html)」を参照してください。 # AWS Private CA examples using AWS CLI 次のコード例では、AWS Private CA で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-certificate-authority-audit-report` 次のコード例では、`create-certificate-authority-audit-report` を使用する方法を示しています。 **AWS CLI** **認証機関監査レポートを作成する方法** 次の `create-certificate-authority-audit-report` のコマンドは、ARN によって識別されるプライベート CA の監査レポートを作成します。 ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCertificateAuthorityAuditReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/create-certificate-authority-audit-report.html)」を参照してください。 ### `create-certificate-authority` 次のコード例では、`create-certificate-authority` を使用する方法を示しています。 **AWS CLI** **プライベート認証局を作成する方法** 次の `create-certificate-authority` のコマンドは、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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCertificateAuthority](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/create-certificate-authority.html)」を参照してください。 ### `delete-certificate-authority` 次のコード例では、`delete-certificate-authority` を使用する方法を示しています。 **AWS CLI** **プライベート認証局を削除する方法** 次の `delete-certificate-authority` のコマンドは、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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCertificateAuthority](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/delete-certificate-authority.html)」を参照してください。 ### `describe-certificate-authority-audit-report` 次のコード例では、`describe-certificate-authority-audit-report` を使用する方法を示しています。 **AWS CLI** **認証機関監査レポートを作成する方法** 次の `describe-certificate-authority-audit-report` のコマンドは、ARN によって識別される CA の指定された監査レポートに関する情報を一覧表示します。 ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeCertificateAuthorityAuditReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/describe-certificate-authority-audit-report.html)」を参照してください。 ### `describe-certificate-authority` 次のコード例では、`describe-certificate-authority` を使用する方法を示しています。 **AWS CLI** **プライベート認証局を作成する方法** 次の `describe-certificate-authority` のコマンドは、ARN によって識別されるプライベート CA に関する情報を一覧表示します。 ``` aws acm-pca describe-certificate-authority --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeCertificateAuthority](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/describe-certificate-authority.html)」を参照してください。 ### `get-certificate-authority-certificate` 次のコード例では、`get-certificate-authority-certificate` を使用する方法を示しています。 **AWS CLI** **認証局 (CA) 証明書を取得する方法** 次の `get-certificate-authority-certificate` のコマンドは、ARN によって指定されたプライベート CA の認証と認証チェーンの証明書を取得します。 ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetCertificateAuthorityCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/get-certificate-authority-certificate.html)」を参照してください。 ### `get-certificate-authority-csr` 次のコード例では、`get-certificate-authority-csr` を使用する方法を示しています。 **AWS CLI** **認証機関の証明書署名リクエストを取得する方法** 次の `get-certificate-authority-csr` のコマンドは、ARN によって指定されたプライベート CA の CSR を取得します。 ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetCertificateAuthorityCsr](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/get-certificate-authority-csr.html)」を参照してください。 ### `get-certificate` 次のコード例では、`get-certificate` を使用する方法を示しています。 **AWS CLI** **発行された証明書を取得する方法** 次の `get-certificate` の例では、指定されたプライベート CA から証明書を取得します。 ``` 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 ``` 出力: ``` -----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----- ``` 出力の最初のパートは証明書それ自体です。2 番目のパートは、ルート CA 証明書に連鎖する証明書チェーンです。`--output text` オプションを使用すると、2 つの証明書部分の間に `TAB` 文字が挿入されることに注意してください (これによってテキストがインデントされます）。この出力を取得し、証明書を他のツールで解析する場合は、`TAB` 文字を削除して正しく処理する必要が生じる場合があります。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/get-certificate.html)」を参照してください。 ### `import-certificate-authority-certificate` 次のコード例では、`import-certificate-authority-certificate` を使用する方法を示しています。 **AWS CLI** **認証局証明書を ACM PCA にインポートする方法** 次の `import-certificate-authority-certificate` のコマンドは、ARN によって指定された CA の署名付きプライベート CA 証明書を 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ImportCertificateAuthorityCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/import-certificate-authority-certificate.html)」を参照してください。 ### `issue-certificate` 次のコード例では、`issue-certificate` を使用する方法を示しています。 **AWS CLI** **プライベート証明書を発行する方法** 次の `issue-certificate` のコマンドは、ARN で指定されたプライベート CA を使用してプライベート証明書を発行します。 ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[IssueCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/issue-certificate.html)」を参照してください。 ### `list-certificate-authorities` 次のコード例では、`list-certificate-authorities` を使用する方法を示しています。 **AWS CLI** **プライベート認証機関を一覧表示する方法** 次の `list-certificate-authorities` のコマンドは、アカウントのすべてのプライベート CA に関する情報を一覧表示します。 ``` aws acm-pca list-certificate-authorities --max-results 10 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListCertificateAuthorities](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/list-certificate-authorities.html)」を参照してください。 ### `list-tags` 次のコード例では、`list-tags` を使用する方法を示しています。 **AWS CLI** **認証機関のタグを一覧表示する方法** 次の `list-tags` のコマンドは、ARN で指定されたプライベート CA に関連付けられたタグを一覧表示します。 ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/list-tags.html)」を参照してください。 ### `revoke-certificate` 次のコード例では、`revoke-certificate` を使用する方法を示しています。 **AWS CLI** **プライベート証明書を取り消す方法** 次の `revoke-certificate` のコマンドは、ARN によって識別された CA からプライベート証明書を取り消します。 ``` 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" ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RevokeCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/revoke-certificate.html)」を参照してください。 ### `tag-certificate-authority` 次のコード例では、`tag-certificate-authority` を使用する方法を示しています。 **AWS CLI** **プライベート認証機関にタグを追加する方法** 次の `tag-certificate-authority` のコマンドは、プライベート CA に 1 つ以上のタグを追加します。 ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagCertificateAuthority](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/tag-certificate-authority.html)」を参照してください。 ### `untag-certificate-authority` 次のコード例では、`untag-certificate-authority` を使用する方法を示しています。 **AWS CLI** **プライベート認証局から 1 つ以上のタグを削除する方法** 次の `untag-certificate-authority` のコマンドは、ARN によって識別されるプライベート CA からタグを削除します。 ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagCertificateAuthority](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/untag-certificate-authority.html)」を参照してください。 ### `update-certificate-authority` 次のコード例では、`update-certificate-authority` を使用する方法を示しています。 **AWS CLI** **プライベート認証局の構成を更新する方法** 次の `update-certificate-authority` のコマンドは、ARN によって識別されるプライベート CA のステータスと構成を更新します。 ``` 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" ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateCertificateAuthority](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/acm-pca/update-certificate-authority.html)」を参照してください。 # AWS Proton examples using AWS CLI 次のコード例では、AWS Proton で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `cancel-service-instance-deployment` 次のコード例は、`cancel-service-instance-deployment` を使用する方法を示しています。 **AWS CLI** **サービスインスタンスのデプロイをキャンセルするには** 次の `cancel-service-instance-deployment` の例では、サービスインスタンスのデプロイをキャンセルします。 ``` aws proton cancel-service-instance-deployment \ --service-instance-name "instance-one" \ --service-name "simple-svc" ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Proton Administrator Guide*」の「[Update a service instance](https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-instance-update.html)」または「*AWS Proton User Guide*」の「[Update a service instance](https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-instance-update.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelServiceInstanceDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/proton/cancel-service-instance-deployment.html)」を参照してください。 ### `cancel-service-pipeline-deployment` 次のコード例は、`cancel-service-pipeline-deployment` を使用する方法を示しています。 **AWS CLI** **サービスパイプラインのデプロイをキャンセルするには** 次の `cancel-service-pipeline-deployment` の例では、サービスパイプラインのデプロイをキャンセルします。 ``` aws proton cancel-service-pipeline-deployment \ --service-name "simple-svc" ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Proton Administrator Guide*」の「[Update a service pipeline](https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-pipeline-update.html)」または「*AWS Proton User Guide*」の「[Update a service pipeline](https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-pipeline-update.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelServicePipelineDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/proton/cancel-service-pipeline-deployment.html)」を参照してください。 ### `create-service` 次のコード例は、`create-service` を使用する方法を示しています。 **AWS CLI** **サービスを作成するには** 次の `create-service` の例では、サービスパイプラインを使用してサービスを作成します。 ``` 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 ``` `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" ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Proton Administrator Guide*」の「[Create a service](https://docs.aws.amazon.com/proton/latest/adminguide/ag-create-svc.html)」および「*AWS Proton User Guide*」の「[Create a service](https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-create.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[CreateService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/proton/create-service.html)」を参照してください。** ### `delete-service` 次のコード例は、`delete-service` を使用する方法を示しています。 **AWS CLI** **サービスを削除する方法** 次の `delete-service` の例では、サービスを削除します。 ``` aws proton delete-service \ --name "simple-svc" ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Proton Administrator Guide*」の「[Delete a service](https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-delete.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/proton/delete-service.html)」を参照してください。 ### `get-service-instance` 次のコード例は、`get-service-instance` を使用する方法を示しています。 **AWS CLI** **サービスインスタンスの詳細を取得するには** 次の `get-service-instance` の例では、サービスインスタンスの詳細データを取得します。 ``` aws proton get-service-instance \ --name "instance-one" \ --service-name "simple-svc" ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Proton Administrator Guide*」の「[View service data](https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-view.html)」または「*AWS Proton User Guide*」の「[View service data](https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-view.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetServiceInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/proton/get-service-instance.html)」を参照してください。 ### `get-service` 次のコード例は、`get-service` を使用する方法を示しています。 **AWS CLI** **サービスの詳細を取得するには** 次の `get-service` の例では、サービスの詳細データを取得します。 ``` aws proton get-service \ --name "simple-svc" ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Proton Administrator Guide*」の「[View service data](https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-view.html)」または「*AWS Proton User Guide*」の「[View service data](https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-view.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/proton/get-service.html)」を参照してください。 ### `list-service-instances` 次のコード例は、`list-service-instances` を使用する方法を示しています。 **AWS CLI** **例 1: すべてのサービスインスタンスを一覧表示するには** 次の `list-service-instances` の例では、サービスインスタンスを一覧表示します。 ``` aws proton list-service-instances ``` 出力: ``` { "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" } ] } ``` 詳細については、「*AWS Proton Administrator Guide*」の「[View service instance data](https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-instance-view.html)」または「*AWS Proton User Guide*」の「[View service instance data](https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-instance-view.html)」を参照してください。 **例 2: 指定されたサービスインスタンスを一覧表示するには** 次の `get-service-instance` の例では、サービスインスタンスを取得します。 ``` aws proton get-service-instance \ --name "instance-one" \ --service-name "simple-svc" ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Proton Administrator Guide*」の「[View service instance data](https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-instance-view.html)」または「*AWS Proton User Guide*」の「[View service instance data](https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-instance-view.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListServiceInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/proton/list-service-instances.html)」を参照してください。 ### `update-service-instance` 次のコード例は、`update-service-instance` を使用する方法を示しています。 **AWS CLI** **サービスインスタンスを新しいマイナーバージョンに更新するには** 次の `update-service-instance` の例では、サービスインスタンスをサービステンプレートの新しいマイナーバージョンに更新し、「my-other-instance」という名前の新しいインスタンスを新しい必須の入力に追加します。 ``` 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" ``` `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" ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Proton Administrator Guide*」の「[Update a service instance](https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-instance-update.html)」または「*AWS Proton User Guide*」の「[Update a service instance](https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-instance-update.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateServiceInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/proton/update-service-instance.html)」を参照してください。 ### `update-service-pipeline` 次のコード例は、`update-service-pipeline` を使用する方法を示しています。 **AWS CLI** **サービスパイプラインを更新するには** 次の `update-service-pipeline` の例では、サービスパイプラインをサービステンプレートの新しいマイナーバージョンに更新します。 ``` 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" ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Proton Administrator Guide*」の「[Update a service pipeline](https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-pipeline-update.html)」または「*AWS Proton User Guide*」の「[Update a service pipeline](https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-pipeline-update.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UpdateServicePipeline](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/proton/update-service-pipeline.html)」を参照してください。 ### `update-service` 次のコード例は、`update-service` を使用する方法を示しています。 **AWS CLI** **サービスを更新するには** 次の `update-service` の例では、サービスの説明を編集します。 ``` aws proton update-service \ --name "MySimpleService" \ --description "Edit by updating description" ``` 出力: ``` { "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" } } ``` 詳細については、「*AWS Proton Administrator Guide*」の「[Edit a service](https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-update.html)」または「*AWS Proton User Guide*」の「[Edit a service](https://docs.aws.amazon.com/proton/latest/userguide/ug-svc-update.html)」を参照してください。 + API の詳細については、AWS CLI コマンドリファレンスの「[UpdateService](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/proton/update-service.html)」を参照してください。** # AWS CLI を使用する Amazon RDS の例 次のコード例は、Amazon RDS で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `add-option-to-option-group` 次のコード例は、`add-option-to-option-group` を使用する方法を示しています。 **AWS CLI** **オプショングループにオプションを追加するには** 次の `add-option-to-option-group` の例では、オプションを指定したオプショングループに追加します。 ``` aws rds add-option-to-option-group \ --option-group-name myoptiongroup \ --options OptionName=OEM,Port=5500,DBSecurityGroupMemberships=default \ --apply-immediately ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[オプショングループにオプションを追加する](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithOptionGroups.html#USER_WorkingWithOptionGroups.AddOption)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddOptionToOptionGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/add-option-to-option-group.html)」を参照してください。 ### `add-role-to-db-cluster` 次のコード例は、`add-role-to-db-cluster` を使用する方法を示しています。 **AWS CLI** ** AWS Identity and Access Management (IAM) ロールを DB クラスターに関連付けるには** 次の `add-role-to-db-cluster` の例では、DB クラスターにロールを関連付けます。 ``` aws rds add-role-to-db-cluster \ --db-cluster-identifier mydbcluster \ --role-arn arn:aws:iam::123456789012:role/RDSLoadFromS3 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Aurora ユーザーガイド*」の「[IAM ロールと Amazon Aurora MySQL DB クラスターの関連付け](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Integrating.Authorizing.IAM.AddRoleToDBCluster.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddRoleToDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/add-role-to-db-cluster.html)」を参照してください。 ### `add-role-to-db-instance` 次のコード例は、`add-role-to-db-instance` を使用する方法を示しています。 **AWS CLI** **AWS Identity and Access Management (IAM) ロールを DB インスタンスに関連付けるには** 次の `add-role-to-db-instance` の例では、`test-instance` という名前の Oracle DB インスタンスにこのロールを追加します。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon RDS ユーザーガイド*」の「[Amazon RDS Oracle と Amazon S3 を統合する前提条件](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.html#oracle-s3-integration.preparing)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddRoleToDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/add-role-to-db-instance.html)」を参照してください。 ### `add-source-identifier-to-subscription` 次のコード例は、`add-source-identifier-to-subscription` を使用する方法を示しています。 **AWS CLI** **ソース識別子をサブスクリプションに追加するには** 次の `add-source-identifier` の例では、別のソース識別子を既存のサブスクリプションに追加します。 ``` aws rds add-source-identifier-to-subscription \ --subscription-name my-instance-events \ --source-identifier test-instance-repl ``` 出力: ``` { "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" ] } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AddSourceIdentifierToSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/add-source-identifier-to-subscription.html)」を参照してください。 ### `add-tags-to-resource` 次のコード例は、`add-tags-to-resource` を使用する方法を示しています。 **AWS CLI** **リソースにタグを追加するには** 次の `add-tags-to-resource` の例では、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\"}]" ``` このコマンドでは何も出力されません。 詳細については、「*Amazon RDS ユーザーガイド*」の「[Amazon RDS リソースのタグ付け](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[AddTagsToResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/add-tags-to-resource.html)」を参照してください。 ### `apply-pending-maintenance-action` 次のコード例は、`apply-pending-maintenance-action` を使用する方法を示しています。 **AWS CLI** **保留中のメンテナンスアクションを適用するには** 次の `apply-pending-maintenance-action` の例では、DB クラスターの保留中のメンテナンスアクションを適用します。 ``` 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 ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[DB インスタンスのメンテナンス](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html)」および「*Amazon Aurora ユーザーガイド*」の「[Amazon Aurora DB インスタンスのメンテナンス](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ApplyPendingMaintenanceAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/apply-pending-maintenance-action.html)」を参照してください。 ### `authorize-db-security-group-ingress` 次のコード例は、`authorize-db-security-group-ingress` を使用する方法を示しています。 **AWS CLI** **AWS Identity and Access Management (IAM) ロールを DB インスタンスに関連付けるには** 次の `authorize-db-security-group-ingress` の例では、CIDR IP 範囲 192.0.2.0/24 の進入ルールを使用してデフォルトのセキュリティグループを設定します。 ``` aws rds authorize-db-security-group-ingress \ --db-security-group-name default \ --cidrip 192.0.2.0/24 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[IP 範囲からのネットワークアクセスを DB セキュリティグループに許可する](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithSecurityGroups.html#USER_WorkingWithSecurityGroups.Authorizing)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AuthorizeDbSecurityGroupIngress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/authorize-db-security-group-ingress.html)」を参照してください。 ### `backtrack-db-cluster` 次のコード例は、`backtrack-db-cluster` を使用する方法を示しています。 **AWS CLI** **Aurora DB クラスターをバックトラックするには** 次の `backtrack-db-cluster` の例では、指定された DB クラスター sample-cluster を 2018 年 3 月 19 日午前 10 時までバックトラックします。 ``` aws rds backtrack-db-cluster --db-cluster-identifier sample-cluster --backtrack-to 2018-03-19T10:00:00+00:00 ``` このコマンドは、RDS リソースの変更を承認する JSON ブロックを出力します。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BacktrackDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/backtrack-db-cluster.html)」を参照してください。 ### `cancel-export-task` 次のコード例は、`cancel-export-task` を使用する方法を示しています。 **AWS CLI** **Amazon S3 に対するスナップショットのエクスポートをキャンセルするには** 次の `cancel-export-task` の例では、スナップショットを Amazon S3 にエクスポートする進行中のエクスポートタスクをキャンセルします。 ``` aws rds cancel-export-task \ --export-task-identifier my-s3-export-1 ``` 出力: ``` { "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 } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[スナップショットエクスポートタスクのキャンセル](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ExportSnapshot.html#USER_ExportSnapshot.Canceling)」または「*Amazon Aurora ユーザーガイド*」の「[スナップショットエクスポートタスクのキャンセル](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_ExportSnapshot.html#USER_ExportSnapshot.Canceling)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CancelExportTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/cancel-export-task.html)」を参照してください。 ### `copy-db-cluster-parameter-group` 次のコード例は、`copy-db-cluster-parameter-group` を使用する方法を示しています。 **AWS CLI** **DB クラスターパラメータグループをコピーするには** 次の `copy-db-cluster-parameter-group` の例では、DB クラスターパラメータグループのコピーを作成します。 ``` 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" ``` 出力: ``` { "DBClusterParameterGroup": { "DBClusterParameterGroupName": "mydbclusterpgcopy", "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpgcopy", "DBParameterGroupFamily": "aurora-mysql5.7", "Description": "Copy of mydbclusterpg parameter group" } } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[DB クラスターパラメータグループのコピー](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html#USER_WorkingWithParamGroups.CopyingCluster)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CopyDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/copy-db-cluster-parameter-group.html)」を参照してください。 ### `copy-db-cluster-snapshot` 次のコード例は、`copy-db-cluster-snapshot` を使用する方法を示しています。 **AWS CLI** **DB クラスタースナップショットをコピーするには** 次の `copy-db-cluster-snapshot` の例では、タグを含む DB クラスタースナップショットのコピーを作成します。 ``` 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 ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon Aurora ユーザーガイド*の「[スナップショットのコピー](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CopyDbClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/copy-db-cluster-snapshot.html)」を参照してください。 ### `copy-db-parameter-group` 次のコード例は、`copy-db-parameter-group` を使用する方法を示しています。 **AWS CLI** **DB クラスターパラメータグループをコピーするには** 次の `copy-db-parameter-group` の例では、DB パラメータグループのコピーを作成します。 ``` 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" ``` 出力: ``` { "DBParameterGroup": { "DBParameterGroupName": "mydbpgcopy", "DBParameterGroupArn": "arn:aws:rds:us-east-1:814387698303:pg:mydbpgcopy", "DBParameterGroupFamily": "mysql5.7", "Description": "Copy of mydbpg parameter group" } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[DB パラメータグループをコピーする](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html#USER_WorkingWithParamGroups.Copying)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CopyDbParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/copy-db-parameter-group.html)」を参照してください。 ### `copy-db-snapshot` 次のコード例は、`copy-db-snapshot` を使用する方法を示しています。 **AWS CLI** **DB スナップショットをコピーするには** 次の `copy-db-snapshot` の例では、DB スナップショットのコピーを作成します。 ``` aws rds copy-db-snapshot \ --source-db-snapshot-identifier rds:database-mysql-2019-06-06-08-38 --target-db-snapshot-identifier mydbsnapshotcopy ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon RDS ユーザーガイド*の「[スナップショットのコピー](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CopyDbSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/copy-db-snapshot.html)」を参照してください。 ### `copy-option-group` 次のコード例は、`copy-option-group` を使用する方法を示しています。 **AWS CLI** **オプショングループをコピーするには** 次の `copy-option-group` の例では、オプショングループのコピーを作成します。 ``` 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" ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[オプショングループのコピーの作成](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithOptionGroups.html#USER_WorkingWithOptionGroups.Copy)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CopyOptionGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/copy-option-group.html)」を参照してください。 ### `create-blue-green-deployment` 次のコード例は、`create-blue-green-deployment` を使用する方法を示しています。 **AWS CLI** **例 1: RDS for MySQL DB インスタンス用にブルー/グリーンデプロイを作成するには** 次の `create-blue-green-deployment` の例では、MySQL DB インスタンスのブルー/グリーンデプロイを作成します。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[ブルー/グリーンデプロイの作成](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments-creating.html)」を参照してください。 **例 2: Aurora MySQL DB クラスター用にブルー/グリーンデプロイを作成するには** 次の `create-blue-green-deployment` の例では、Aurora MySQL DB クラスターのブルー/グリーンデプロイを作成します。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[ブルー/グリーンデプロイの作成](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments-creating.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateBlueGreenDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-blue-green-deployment.html)」を参照してください。 ### `create-db-cluster-endpoint` 次のコード例は、`create-db-cluster-endpoint` を使用する方法を示しています。 **AWS CLI** **カスタム DB クラスターエンドポイントを作成するには** 次の `create-db-cluster-endpoint` の例では、カスタム DB クラスターエンドポイントを作成し、指定された Aurora DB クラスターに関連付けます。 ``` aws rds create-db-cluster-endpoint \ --db-cluster-endpoint-identifier mycustomendpoint \ --endpoint-type reader \ --db-cluster-identifier mydbcluster \ --static-members dbinstance1 dbinstance2 ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[Amazon Aurora 接続管理](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.Endpoints.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDbClusterEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-cluster-endpoint.html)」を参照してください。 ### `create-db-cluster-parameter-group` 次のコード例は、`create-db-cluster-parameter-group` を使用する方法を示しています。 **AWS CLI** **DB クラスターパラメータグループを作成するには** 次の `create-db-cluster-parameter-group` の例は、DB クラスターパラメータグループを作成します。 ``` 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" ``` 出力: ``` { "DBClusterParameterGroup": { "DBClusterParameterGroupName": "mydbclusterparametergroup", "DBParameterGroupFamily": "aurora5.6", "Description": "My new cluster parameter group", "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterparametergroup" } } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[DB クラスターパラメータグループの作成](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html#USER_WorkingWithParamGroups.CreatingCluster)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-cluster-parameter-group.html)」を参照してください。 ### `create-db-cluster-snapshot` 次のコード例は、`create-db-cluster-snapshot` を使用する方法を示しています。 **AWS CLI** **DB クラスタースナップショットを作成するには** 次の `create-db-cluster-snapshot` の例は、DB クラスタースナップショットを作成します。 ``` aws rds create-db-cluster-snapshot \ --db-cluster-identifier mydbcluster \ --db-cluster-snapshot-identifier mydbclustersnapshot ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[DB クラスタースナップショットの作成](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CreateSnapshotCluster.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDbClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-cluster-snapshot.html)」を参照してください。 ### `create-db-cluster` 次のコード例は、`create-db-cluster` を使用する方法を示しています。 **AWS CLI** **例 1: MySQL 5.7 互換 DB クラスターを作成するには** 次の `create-db-cluster` の例は、デフォルトのエンジンバージョンを使用して MySQL 5.7 互換 DB クラスターを作成します。サンプルパスワード `secret99` を安全なパスワードに置き換えます。コンソールを使用して DB クラスターを作成する場合、Amazon RDS は DB クラスターのライター DB インスタンスを自動作成します。ただし、AWS CLI を使用して DB クラスターを作成する場合は、`create-db-instance` AWS CLI コマンドを使用して DB クラスターのライター DB インスタンスを明示的に作成する必要があります。 ``` 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 ``` 出力: ``` { "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 } } ``` **例 2: PostgreSQL 互換 DB クラスターを作成するには** 次の `create-db-cluster` の例では、デフォルトのエンジンバージョンを使用して PostgreSQL 互換 DB クラスターを作成します。例のパスワード `secret99` を安全なパスワードに置き換えます。コンソールを使用して DB クラスターを作成する場合、Amazon RDS は DB クラスターのライター DB インスタンスを自動作成します。ただし、AWS CLI を使用して DB クラスターを作成する場合は、`create-db-instance` AWS CLI コマンドを使用して DB クラスターのライター DB インスタンスを明示的に作成する必要があります。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[Amazon Aurora DB クラスターの作成](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-cluster.html)」を参照してください。 ### `create-db-instance-read-replica` 次のコード例は、`create-db-instance-read-replica` を使用する方法を示しています。 **AWS CLI** **DB インスタンスのリードレプリカを作成するには** この例では、`test-instance` という名前の既存の DB インスタンスのリードレプリカを作成します。リードレプリカの名前は `test-instance-repl` です。 ``` aws rds create-db-instance-read-replica \ --db-instance-identifier test-instance-repl \ --source-db-instance-identifier test-instance ``` 出力: ``` { "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... } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDbInstanceReadReplica](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-instance-read-replica.html)」を参照してください。 ### `create-db-instance` 次のコード例は、`create-db-instance` を使用する方法を示しています。 **AWS CLI** **DB インスタンスを作成するには** 次の `create-db-instance` の例は、必須のオプションを使用して新しい DB インスタンスを起動します。 ``` 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 ``` 出力: ``` { "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": [] } } ``` 詳細については、「Amazon RDS ユーザーガイド」の「[Amazon RDS DB インスタンスの作成](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDBInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-instance.html)」を参照してください。 ### `create-db-parameter-group` 次のコード例は、`create-db-parameter-group` を使用する方法を示しています。 **AWS CLI** **DB パラメータグループを作成するには** 次の `create-db-parameter-group` の例は、DB パラメータグループを作成します。 ``` aws rds create-db-parameter-group \ --db-parameter-group-name mydbparametergroup \ --db-parameter-group-family MySQL5.6 \ --description "My new parameter group" ``` 出力: ``` { "DBParameterGroup": { "DBParameterGroupName": "mydbparametergroup", "DBParameterGroupFamily": "mysql5.6", "Description": "My new parameter group", "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:mydbparametergroup" } } ``` 詳細については、「Amazon RDS ユーザーガイド」の「[DB パラメータグループを作成する](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html#USER_WorkingWithParamGroups.Creating)」を参照してください。** + API の詳細については、「AWS CLI コマンドリファレンス」の「[CreateDBParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-parameter-group.html)」を参照してください。 ### `create-db-proxy-endpoint` 次のコード例は、`create-db-proxy-endpoint` を使用する方法を示しています。 **AWS CLI** **RDS データベースの DB プロキシエンドポイントを作成するには** 次の `create-db-proxy-endpoint` の例では、DB プロキシエンドポイントを作成します。 ``` aws rds create-db-proxy-endpoint \ --db-proxy-name proxyExample \ --db-proxy-endpoint-name "proxyep1" \ --vpc-subnet-ids subnetgroup1 subnetgroup2 ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[プロキシエンドポイントの作成](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-endpoints.html#rds-proxy-endpoints.CreatingEndpoint)」および「*Amazon Aurora ユーザーガイド*」の「[プロキシエンドポイントの作成](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-endpoints.html#rds-proxy-endpoints.CreatingEndpoint)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDbProxyEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-proxy-endpoint.html)」を参照してください。 ### `create-db-proxy` 次のコード例は、`create-db-proxy` を使用する方法を示しています。 **AWS CLI** **RDS データベースの DB プロキシを作成するには** 次の `create-db-proxy` の例では、DB プロキシを作成します。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[RDS プロキシの作成](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-setup.html#rds-proxy-creating)」および「*Amazon Aurora ユーザーガイド*」の「[RDS プロキシの作成](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-setup.html#rds-proxy-creating)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDbProxy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-proxy.html)」を参照してください。 ### `create-db-security-group` 次のコード例は、`create-db-security-group` を使用する方法を示しています。 **AWS CLI** **Amazon RDS セキュリティグループを作成するには** 次の `create-db-security-group` コマンドは、新しい Amazon RDS DB セキュリティグループを作成します。 ``` aws rds create-db-security-group --db-security-group-name mysecgroup --db-security-group-description "My Test Security Group" ``` この例では、新しい DB セキュリティグループに `mysecgroup` という名前が付けられ、説明があります。 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDbSecurityGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-security-group.html)」を参照してください。 ### `create-db-shard-group` 次のコード例は、`create-db-shard-group` を使用する方法を示しています。 **AWS CLI** **例 1: Aurora PostgreSQL プライマリ DB クラスターを作成するには** 次の `create-db-cluster` の例では、Aurora Serverless v2 および Aurora Limitless Database と互換性のある Aurora PostgreSQL SQL プライマリ DB クラスターを作成します。 ``` 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 ``` 出力: ``` { "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 } } } ``` **例 2: プライマリ (ライター) DB インスタンスを作成するには** 次の `create-db-instance` の例では、Aurora Serverless v2 プライマリ (ライター) DB インスタンスを作成します。コンソールを使用して DB クラスターを作成する場合、Amazon RDS は DB クラスターのライター DB インスタンスを自動作成します。ただし、AWS CLI を使用して DB クラスターを作成する場合は、`create-db-instance` AWS CLI コマンドを使用して DB クラスターのライター DB インスタンスを明示的に作成する必要があります。 ``` 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 ``` 出力: ``` { "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 } } ``` **例 3: DB シャードグループを作成するには** 次の `create-db-shard-group` の例では、Aurora PostgreSQL プライマリ DB クラスターに DB シャードグループを作成します。 ``` aws rds create-db-shard-group \ --db-shard-group-identifier my-db-shard-group \ --db-cluster-identifier my-sv2-cluster \ --max-acu 768 ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[Aurora Serverless v2 を使用する](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[CreateDbShardGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-shard-group.html)」を参照してください。 ### `create-db-snapshot` 次のコード例は、`create-db-snapshot` を使用する方法を示しています。 **AWS CLI** **DB スナップショットを作成するには** 次の `create-db-snapshot` の例は、DB スナップショットを作成します。 ``` aws rds create-db-snapshot \ --db-instance-identifier database-mysql \ --db-snapshot-identifier mydbsnapshot ``` 出力: ``` { "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" } } ``` 詳細については、「Amazon RDS ユーザーガイド」の「[DB スナップショットの作成](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateSnapshot.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDBSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-snapshot.html)」を参照してください。 ### `create-db-subnet-group` 次のコード例は、`create-db-subnet-group` を使用する方法を示しています。 **AWS CLI** **DB サブネットグループを作成するには** 次の `create-db-subnet-group` の例では、既存のサブネットを使用して `mysubnetgroup` という名前の DB サブネットグループを作成します。 ``` 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"]' ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[VPC に DB インスタンスを作成する](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.InstanceInVPC)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateDbSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-subnet-group.html)」を参照してください。 ### `create-event-subscription` 次のコード例は、`create-event-subscription` を使用する方法を示しています。 **AWS CLI** **イベントサブスクリプションを作成するには** 次の `create-event-subscription` の例では、現在の AWS アカウントの DB インスタンスのバックアップおよびリカバリイベントのサブスクリプションを作成します。通知は、`--sns-topic-arn` で指定された Amazon Simple Notification Service のトピックに送信されます。 ``` 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 ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateEventSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-event-subscription.html)」を参照してください。 ### `create-global-cluster` 次のコード例は、`create-global-cluster` を使用する方法を示しています。 **AWS CLI** **グローバル DB クラスターを作成するには** 次の `create-global-cluster` の例では、新しい Aurora MySQL 互換のグローバル DB クラスターを作成します。 ``` aws rds create-global-cluster \ --global-cluster-identifier myglobalcluster \ --engine aurora-mysql ``` 出力: ``` { "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": [] } } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[Aurora グローバルデータベースの作成](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-getting-started.html#aurora-global-database-creating)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateGlobalCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-global-cluster.html)」を参照してください。 ### `create-option-group` 次のコード例は、`create-option-group` を使用する方法を示しています。 **AWS CLI** **Amazon RDS オプショングループを作成するには** 次の `create-option-group` コマンドは、`Oracle Enterprise Edition` バージョン `11.2`, is named ``MyOptionGroup` の新しい Amazon RDS オプショングループを作成し、説明を含めます。 ``` 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" ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateOptionGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-option-group.html)」を参照してください。 ### `delete-blue-green-deployment` 次のコード例は、`delete-blue-green-deployment` を使用する方法を示しています。 **AWS CLI** **例 1: RDS for MySQL DB インスタンスのグリーン環境でリソースを削除するには** 次の `delete-blue-green-deployment` の例では、RDS for MySQL DB インスタンスのグリーン環境内のリソースを削除します。 ``` aws rds delete-blue-green-deployment \ --blue-green-deployment-identifier bgd-v53303651eexfake \ --delete-target ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[ブルー/グリーンデプロイの削除](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments-deleting.html)」を参照してください。 **例 2: Aurora MySQL DB クラスターのグリーン環境でリソースを削除するには** 次の `delete-blue-green-deployment` の例では、Aurora MySQL DB クラスターのグリーン環境内のリソースを削除します。 ``` aws rds delete-blue-green-deployment \ --blue-green-deployment-identifier bgd-wi89nwzglccsfake \ --delete-target ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[ブルー/グリーンデプロイの削除](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments-deleting.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteBlueGreenDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-blue-green-deployment.html)」を参照してください。 ### `delete-db-cluster-endpoint` 次のコード例は、`delete-db-cluster-endpoint` を使用する方法を示しています。 **AWS CLI** **カスタム DB クラスターエンドポイントを削除するには** 次の `delete-db-cluster-endpoint` の例では、指定されたカスタム DB クラスターエンドポイントを削除します。 ``` aws rds delete-db-cluster-endpoint \ --db-cluster-endpoint-identifier mycustomendpoint ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[Amazon Aurora 接続管理](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.Endpoints.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDbClusterEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-db-cluster-endpoint.html)」を参照してください。 ### `delete-db-cluster-parameter-group` 次のコード例は、`delete-db-cluster-parameter-group` を使用する方法を示しています。 **AWS CLI** **DB クラスターパラメータグループを削除するには** 次の `delete-db-cluster-parameter-group` の例では、指定された DB クラスターパラメータグループを削除します。 ``` aws rds delete-db-cluster-parameter-group \ --db-cluster-parameter-group-name mydbclusterparametergroup ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Aurora ユーザーガイド*」の「[DB パラメータグループおよび DB クラスターパラメータグループを使用する](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-db-cluster-parameter-group.html)」を参照してください。 ### `delete-db-cluster-snapshot` 次のコード例は、`delete-db-cluster-snapshot` を使用する方法を示しています。 **AWS CLI** **DB クラスタースナップショットを削除するには** 次の `delete-db-cluster-snapshot` の例では、指定したクラスタースナップショットを削除します。 ``` aws rds delete-db-cluster-snapshot \ --db-cluster-snapshot-identifier mydbclustersnapshot ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[スナップショットの削除](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_DeleteSnapshot.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDbClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-db-cluster-snapshot.html)」を参照してください。 ### `delete-db-cluster` 次のコード例は、`delete-db-cluster` を使用する方法を示しています。 **AWS CLI** **例 1: DB クラスター内の DB インスタンスを削除するには** 次の `delete-db-instance` の例では、DB クラスター内の最後の DB インスタンスを削除します。**削除**状態にない DB インスタンスが含まれている DB クラスターは削除できません。DB クラスター内の DB インスタンスを削除するときに、最終的なスナップショットを作成することはできません。 ``` aws rds delete-db-instance \ --db-instance-identifier database-3 ``` 出力: ``` { "DBInstance": { "DBInstanceIdentifier": "database-3", "DBInstanceClass": "db.r4.large", "Engine": "aurora-postgresql", "DBInstanceStatus": "deleting", ...output omitted... } } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[Amazon Aurora DB クラスターで DB インスタンスを削除する](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_DeleteInstance.html)」を参照してください。 **例 2: DB クラスターを削除するには** 次の `delete-db-cluster` の例では、`mycluster` という名前の DB クラスターを削除し、`mycluster-final-snapshot` という名前の最終スナップショットを作成します。DB クラスターのステータスは、スナップショットの作成中に**表示されるようになります**。削除の進行状況を確認するには、`describe-db-clusters` CLI コマンドを使用します。 ``` aws rds delete-db-cluster \ --db-cluster-identifier mycluster \ --no-skip-final-snapshot \ --final-db-snapshot-identifier mycluster-final-snapshot ``` 出力: ``` { "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... } } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[単一 DB インスタンスの Aurora クラスター](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_DeleteInstance.html#USER_DeleteInstance.LastInstance)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-db-cluster.html)」を参照してください。 ### `delete-db-instance-automated-backup` 次のコード例は、`delete-db-instance-automated-backup` を使用する方法を示しています。 **AWS CLI** **リージョンからレプリケートされた自動バックアップを削除するには** 次の `delete-db-instance-automated-backup` の例では、指定された Amazon リソースネーム (ARN) で自動バックアップを削除します。 ``` aws rds delete-db-instance-automated-backup \ --db-instance-automated-backups-arn "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example" ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[レプリケーションされたバックアップの削除](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html#AutomatedBackups.Delete)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDbInstanceAutomatedBackup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-db-instance-automated-backup.html)」を参照してください。 ### `delete-db-instance` 次のコード例は、`delete-db-instance` を使用する方法を示しています。 **AWS CLI** **DB インスタンスを削除するには** 次の `delete-db-instance` の例は、`test-instance-final-snap` という名前の最終 DB スナップショットを作成した後に、指定された DB インスタンスを削除します。 ``` aws rds delete-db-instance \ --db-instance-identifier test-instance \ --final-db-snapshot-identifier test-instance-final-snap ``` 出力: ``` { "DBInstance": { "DBInstanceIdentifier": "test-instance", "DBInstanceStatus": "deleting", ...some output truncated... } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDBInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-db-instance.html)」を参照してください。 ### `delete-db-parameter-group` 次のコード例は、`delete-db-parameter-group` を使用する方法を示しています。 **AWS CLI** **DB パラメータグループを削除するには** 次の `command` の例は、DB パラメータグループを削除します。 ``` aws rds delete-db-parameter-group \ --db-parameter-group-name mydbparametergroup ``` このコマンドでは何も出力されません。 詳細については、「Amazon RDS ユーザーガイド」の「[DB パラメータグループを使用する](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDBParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-db-parameter-group.html)」を参照してください。 ### `delete-db-proxy-endpoint` 次のコード例は、`delete-db-proxy-endpoint` を使用する方法を示しています。 **AWS CLI** **RDS データベースの DB プロキシエンドポイントを削除するには** 次の `delete-db-proxy-endpoint` の例では、ターゲットデータベースの DB プロキシエンドポイントを削除します。 ``` aws rds delete-db-proxy-endpoint \ --db-proxy-endpoint-name proxyEP1 ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[プロキシエンドポイントの削除](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-endpoints.html#rds-proxy-endpoints.DeletingEndpoint)」および「*Amazon Aurora ユーザーガイド*」の「[プロキシエンドポイントの削除](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-endpoints.html#rds-proxy-endpoints.DeletingEndpoint)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDbProxyEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-db-proxy-endpoint.html)」を参照してください。 ### `delete-db-proxy` 次のコード例は、`delete-db-proxy` を使用する方法を示しています。 **AWS CLI** **RDS データベースの DB プロキシを削除するには** 次の `delete-db-proxy` の例は、DB プロキシを削除します。 ``` aws rds delete-db-proxy \ --db-proxy-name proxyExample ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[RDS プロキシの削除](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-managing.html#rds-proxy-deleting)」および「*Amazon Aurora ユーザーガイド*」の「[RDS プロキシの削除](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-managing.html#rds-proxy-deleting)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDbProxy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-db-proxy.html)」を参照してください。 ### `delete-db-security-group` 次のコード例は、`delete-db-security-group` を使用する方法を示しています。 **AWS CLI** **DB セキュリティグループを削除するには** 次の `delete-db-security-group` の例では、`mysecuritygroup` という名前の DB セキュリティプロファイルを削除します。 ``` aws rds delete-db-security-group \ --db-security-group-name mysecuritygroup ``` このコマンドでは何も出力されません。 詳細については、「*Amazon RDS ユーザーガイド*」の「[DB セキュリティグループの操作 (EC2-Classic プラットフォーム)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithSecurityGroups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDbSecurityGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-db-security-group.html)」を参照してください。 ### `delete-db-shard-group` 次のコード例は、`delete-db-shard-group` を使用する方法を示しています。 **AWS CLI** **例 1: DB シャードグループの削除に失敗するには** 次の `delete-db-shard-group` の例は、すべてのデータベースとスキーマを削除する前に DB シャードグループを削除しようとすると発生するエラーを示しています。 ``` aws rds delete-db-shard-group \ --db-shard-group-identifier limitless-test-shard-grp ``` 出力: ``` 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. ``` **例 2: DB シャードグループを正常に削除するには** 次の `delete-db-shard-group` 例では、`public` スキーマを含むすべてのデータベースとスキーマを削除した後、DB シャードグループを削除します。 ``` aws rds delete-db-shard-group \ --db-shard-group-identifier limitless-test-shard-grp ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[Aurora DB クラスターと DB インスタンスを削除する](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_DeleteCluster.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDbShardGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-db-shard-group.html)」を参照してください。 ### `delete-db-snapshot` 次のコード例は、`delete-db-snapshot` を使用する方法を示しています。 **AWS CLI** **DB スナップショットを削除するには** 次の `delete-db-snapshot` の例では、指定した DB スナップショットを削除します。 ``` aws rds delete-db-snapshot \ --db-snapshot-identifier mydbsnapshot ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[スナップショットの削除](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteSnapshot.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDbSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-db-snapshot.html)」を参照してください。 ### `delete-db-subnet-group` 次のコード例は、`delete-db-subnet-group` を使用する方法を示しています。 **AWS CLI** **DB サブネットグループを削除するには** 次の `delete-db-subnet-group` の例では、`mysubnetgroup` という名前の DB サブネットグループを削除します。 ``` aws rds delete-db-subnet-group --db-subnet-group-name mysubnetgroup ``` このコマンドでは何も出力されません。 詳細については、「*Amazon RDS ユーザーガイド*」の「[VPC 内の DB インスタンスの使用](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteDbSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-db-subnet-group.html)」を参照してください。 ### `delete-event-subscription` 次のコード例は、`delete-event-subscription` を使用する方法を示しています。 **AWS CLI** **イベントサブスクリプションを削除するには** 次の `delete-event-subscription` の例では、指定したイベントサブスクリプションを削除します。 ``` aws rds delete-event-subscription --subscription-name my-instance-events ``` 出力: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteEventSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-event-subscription.html)」を参照してください。 ### `delete-global-cluster` 次のコード例は、`delete-global-cluster` を使用する方法を示しています。 **AWS CLI** **グローバル DB クラスターを削除するには** 次の `delete-global-cluster` の例では、Aurora MySQL 互換のグローバル DB クラスターを削除します。出力には、削除しているクラスターが表示されますが、後続の `describe-global-clusters` コマンドにはその DB クラスターはリストされません。 ``` aws rds delete-global-cluster \ --global-cluster-identifier myglobalcluster ``` 出力: ``` { "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": [] } } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[Aurora グローバルデータベースの削除](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-managing.html#aurora-global-database-deleting)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteGlobalCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-global-cluster.html)」を参照してください。 ### `delete-option-group` 次のコード例は、`delete-option-group` を使用する方法を示しています。 **AWS CLI** **オプショングループを削除するには** 次の `delete-option-group` の例は、指定されたオプショングループを削除します。 ``` aws rds delete-option-group \ --option-group-name myoptiongroup ``` このコマンドでは何も出力されません。 詳細については、「*Amazon RDS ユーザーガイド*」の「[オプショングループの削除](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithOptionGroups.html#USER_WorkingWithOptionGroups.Delete)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteOptionGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/delete-option-group.html)」を参照してください。 ### `deregister-db-proxy-targets` 次のコード例は、`deregister-db-proxy-targets` を使用する方法を示しています。 **AWS CLI** **DB プロキシターゲットをデータベースターゲットグループから登録解除するには** 次の `deregister-db-proxy-targets` の例では、プロキシ `proxyExample` とそのターゲット間の関連付けを削除します。 ``` aws rds deregister-db-proxy-targets \ --db-proxy-name proxyExample \ --db-instance-identifiers database-1 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon RDS ユーザーガイド*」の「[RDS プロキシの削除](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-managing.html#rds-proxy-deleting)」および「*Amazon Aurora ユーザーガイド*」の「[RDS プロキシの削除](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-managing.html#rds-proxy-deleting)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeregisterDbProxyTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/deregister-db-proxy-targets.html)」を参照してください。 ### `describe-account-attributes` 次のコード例は、`describe-account-attributes` を使用する方法を示しています。 **AWS CLI** **アカウントの属性を記述するには** 次の `describe-account-attributes` の例は、現在の AWS アカウントの属性を取得します。 ``` aws rds describe-account-attributes ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAccountAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-account-attributes.html)」を参照してください。 ### `describe-blue-green-deployments` 次のコード例は、`describe-blue-green-deployments` を使用する方法を示しています。 **AWS CLI** **例 1: 作成完了後の RDS DB インスタンスのブルー/グリーンデプロイを記述するには** 次の `describe-blue-green-deployment` の例では、作成が完了した後にブルー/グリーンデプロイの詳細を取得します。 ``` aws rds describe-blue-green-deployments \ --blue-green-deployment-identifier bgd-v53303651eexfake ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[ブルー/グリーンデプロイの表示](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments-viewing.html)」を参照してください。 **例 2: Aurora MySQL DB クラスター用にブルー/グリーンデプロイを記述するには** 次の `describe-blue-green-deployment` の例では、ブルー/グリーンデプロイの詳細を取得します。 ``` aws rds describe-blue-green-deployments \ --blue-green-deployment-identifier bgd-wi89nwzglccsfake ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[ブルー/グリーンデプロイの表示](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments-viewing.html)」を参照してください。 **例 3: スイッチオーバー後の Aurora MySQL クラスターのブルー/グリーンデプロイを記述するには** 次の `describe-blue-green-deployment` の例では、グリーン環境を本番環境に昇格した後のブルー/グリーンデプロイの詳細を取得します。 ``` aws rds describe-blue-green-deployments \ --blue-green-deployment-identifier bgd-wi89nwzglccsfake ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[ブルー/グリーンデプロイの表示](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments-viewing.html)」を参照してください。 **例 4: ブルーとグリーンを組み合わせたデプロイを記述するには** 次の `describe-blue-green-deployment` 例では、ブルーとグリーンを組み合わせたデプロイの詳細を取得します。 ``` aws rds describe-blue-green-deployments ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[ブルー/グリーンデプロイの表示](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments-viewing.html)」および「*Amazon Aurora ユーザーガイド*」の「[ブルー/グリーンデプロイの表示](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments-viewing.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeBlueGreenDeployments](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-blue-green-deployments.html)」を参照してください。 ### `describe-certificates` 次のコード例は、`describe-certificates` を使用する方法を示しています。 **AWS CLI** **証明書を記述するには** 次の `describe-certificates` の例では、ユーザーのデフォルトリージョンに関連付けられた証明書の詳細を取得します。 ``` aws rds describe-certificates ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[SSL/TLS を使用して DB インスタンスへの接続を暗号化する](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html)」および「*Amazon Aurora ユーザーガイド*」の「[SSL/TLS を使用して DB クラスターへの接続を暗号化する](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-certificates.html)」を参照してください。 ### `describe-db-cluster-backtracks` 次のコード例は、`describe-db-cluster-backtracks` を使用する方法を示しています。 **AWS CLI** **DB クラスターのバックトラックを記述するには** 次の `describe-db-cluster-backtracks` の例は、指定された DB クラスターの詳細情報を取得します。 ``` aws rds describe-db-cluster-backtracks \ --db-cluster-identifier mydbcluster ``` 出力: ``` { "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" } ] } ``` 詳細については、「Amazon Aurora ユーザーガイド」の「[Aurora DB クラスターのバックトラック](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.Backtrack.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDbClusterBacktracks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-cluster-backtracks.html)」を参照してください。 ### `describe-db-cluster-endpoints` 次のコード例は、`describe-db-cluster-endpoints` を使用する方法を示しています。 **AWS CLI** **例 1: DB クラスターエンドポイントを記述するには** 次の `describe-db-cluster-endpoints` の例では、DB クラスターエンドポイントの詳細を取得します。最も一般的な種類の Aurora クラスターには 2 つのエンドポイントがあります。1 つのエンドポイントのタイプは `WRITER` です。このエンドポイントは、すべての SQL ステートメントに使用できます。もう 1 つのエンドポイントのタイプは `READER` です。このエンドポイントは、SELECT およびその他の読み取り専用 SQL ステートメントでのみ使用できます。 ``` aws rds describe-db-cluster-endpoints ``` 出力: ``` { "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" } ] } ``` **例 2: 単一の DB クラスターの DB クラスターエンドポイントを記述するには** 次の `describe-db-cluster-endpoints` の例では、単一の指定された DB クラスターの DB クラスターエンドポイントの詳細を取得します。Aurora Serverless クラスターには、`WRITER` タイプのエンドポイントが 1 つだけあります。 ``` aws rds describe-db-cluster-endpoints \ --db-cluster-identifier serverless-cluster ``` 出力: ``` { "DBClusterEndpoints": [ { "Status": "available", "Endpoint": "serverless-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", "DBClusterIdentifier": "serverless-cluster", "EndpointType": "WRITER" } ] } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[Amazon Aurora 接続管理](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.Endpoints.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDbClusterEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-cluster-endpoints.html)」を参照してください。 ### `describe-db-cluster-parameter-groups` 次のコード例は、`describe-db-cluster-parameter-groups` を使用する方法を示しています。 **AWS CLI** **DB クラスターパラメータグループを記述するには** 次の `describe-db-cluster-parameter-groups` の例では、DB クラスターパラメータグループの詳細を取得します。 ``` aws rds describe-db-cluster-parameter-groups ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[DB パラメータグループおよび DB クラスターパラメータグループを使用する](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDbClusterParameterGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-cluster-parameter-groups.html)」を参照してください。 ### `describe-db-cluster-parameters` 次のコード例は、`describe-db-cluster-parameters` を使用する方法を示しています。 **AWS CLI** **例 1: DB クラスターパラメータグループのパラメータを記述するには** 次の `describe-db-cluster-parameters` の例では、DB パラメータグループのパラメータに関する詳細を取得します。 ``` aws rds describe-db-cluster-parameters \ --db-cluster-parameter-group-name mydbclusterpg ``` 出力: ``` { "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... ] } ``` **例 2: DB クラスターパラメータグループのパラメータ名のみを一覧表示するには** 次の `describe-db-cluster-parameters` の例では、DB クラスターパラメータグループ内のパラメータの名前のみを取得します。 ``` aws rds describe-db-cluster-parameters \ --db-cluster-parameter-group-name default.aurora-mysql5.7 \ --query 'Parameters[].{ParameterName:ParameterName}' ``` 出力: ``` [ { "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... } ] ``` **例 3: DB クラスターパラメータグループ内の変更可能なパラメータのみを記述するには** 次の `describe-db-cluster-parameters` の例では、DB クラスターパラメータグループで変更できるパラメータの名前のみを取得します。 ``` aws rds describe-db-cluster-parameters \ --db-cluster-parameter-group-name default.aurora-mysql5.7 \ --query 'Parameters[].{ParameterName:ParameterName,IsModifiable:IsModifiable} | [?IsModifiable == `true`]' ``` 出力: ``` [ { "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... } ] ``` **例 4: DB クラスターパラメータグループ内の変更可能なブールパラメータのみを記述するには** 次の `describe-db-cluster-parameters` の例では、DB クラスターパラメータグループで変更できるパラメータとブール値データ型を持つパラメータの名前のみを取得します。 ``` 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`]' ``` 出力: ``` [ { "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... } ] ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[DB パラメータグループおよび DB クラスターパラメータグループを使用する](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDbClusterParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-cluster-parameters.html)」を参照してください。 ### `describe-db-cluster-snapshot-attributes` 次のコード例は、`describe-db-cluster-snapshot-attributes` を使用する方法を示しています。 **AWS CLI** **DB クラスタースナップショットの属性名と値を記述するには** 次の `describe-db-cluster-snapshot-attributes` の例では、指定された DB クラスタースナップショットの属性名と値の詳細を取得します。 ``` aws rds describe-db-cluster-snapshot-attributes \ --db-cluster-snapshot-identifier myclustersnapshot ``` 出力: ``` { "DBClusterSnapshotAttributesResult": { "DBClusterSnapshotIdentifier": "myclustersnapshot", "DBClusterSnapshotAttributes": [ { "AttributeName": "restore", "AttributeValues": [ "123456789012" ] } ] } } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[DB クラスタースナップショットの共有](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_ShareSnapshot.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDbClusterSnapshotAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-cluster-snapshot-attributes.html)」を参照してください。 ### `describe-db-cluster-snapshots` 次のコード例は、`describe-db-cluster-snapshots` を使用する方法を示しています。 **AWS CLI** **DB クラスターの DB クラスタースナップショットを記述するには** 次の `describe-db-cluster-snapshots` の例では、指定された DB クラスターの DB クラスタースナップショットの詳細を取得します。 ``` aws rds describe-db-cluster-snapshots \ --db-cluster-identifier mydbcluster ``` 出力: ``` { "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 } ] } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[DB クラスタースナップショットの作成](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CreateSnapshotCluster.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDbClusterSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-cluster-snapshots.html)」を参照してください。 ### `describe-db-clusters` 次のコード例は、`describe-db-clusters` を使用する方法を示しています。 **AWS CLI** **例 1: DB クラスターを記述するには** 次の `describe-db-clusters` の例は、指定された DB クラスターの詳細情報を取得します。 ``` aws rds describe-db-clusters \ --db-cluster-identifier mydbcluster ``` 出力: ``` { "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 } ] } ``` **例 2: すべての DB クラスターの特定の属性を一覧表示するには** 次の `describe-db-clusters` の例では、現在の AWS リージョン内のすべての DB クラスターの `DBClusterIdentifier`、`Endpoint`、および `ReaderEndpoint` 属性のみを取得します。 ``` aws rds describe-db-clusters \ --query 'DBClusters[].{DBClusterIdentifier:DBClusterIdentifier,Endpoint:Endpoint,ReaderEndpoint:ReaderEndpoint}' ``` 出力: ``` [ { "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... } ] ``` **例 3: 特定の属性を持つ DB クラスターを一覧表示するには** 次の `describe-db-clusters` の例では、`aurora-postgresql` DB エンジンを使用する DB クラスターの `DBClusterIdentifier` および `Engine` 属性のみを取得します。 ``` aws rds describe-db-clusters \ --query 'DBClusters[].{DBClusterIdentifier:DBClusterIdentifier,Engine:Engine} | [?Engine == `aurora-postgresql`]' ``` 出力: ``` [ { "Engine": "aurora-postgresql", "DBClusterIdentifier": "pg2-cluster" } ] ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[Amazon Aurora DB クラスター](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDbClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-clusters.html)」を参照してください。 ### `describe-db-engine-versions` 次のコード例は、`describe-db-engine-versions` を使用する方法を示しています。 **AWS CLI** **MySQL DB エンジンの DB エンジンバージョンを記述するには** 次の `describe-db-engine-versions` の例は、指定された DB エンジンの各 DB エンジンバージョンに関する詳細が表示されます。 ``` aws rds describe-db-engine-versions \ --engine mysql ``` 出力: ``` { "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... ] } ``` 詳細については、「Amazon RDS ユーザーガイド」の「[Amazon Relational Database Service (Amazon RDS) とは](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Welcome.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeDBEngineVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-engine-versions.html)」を参照してください。** ### `describe-db-instance-automated-backups` 次のコード例は、`describe-db-instance-automated-backups` を使用する方法を示しています。 **AWS CLI** **DB インスタンスの自動バックアップを記述するには** 次の `describe-db-instance-automated-backups` の例では、指定された DB インスタンスの自動バックアップの詳細を表示します。詳細には、他の AWS リージョンでのレプリケートされた自動バックアップが含まれます。 ``` aws rds describe-db-instance-automated-backups \ --db-instance-identifier new-orcl-db ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[レプリケーションされたバックアップに関する情報の検索](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html#AutomatedBackups.Replicating.Describe)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDbInstanceAutomatedBackups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-instance-automated-backups.html)」を参照してください。 ### `describe-db-instances` 次のコード例は、`describe-db-instances` を使用する方法を示しています。 **AWS CLI** **DB インスタンスを記述するには** 次の `describe-db-instances` の例は、指定された DB インスタンスの詳細情報を取得します。 ``` aws rds describe-db-instances \ --db-instance-identifier mydbinstancecf ``` 出力: ``` { "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... } ] } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeDBInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-instances.html)」を参照してください。** ### `describe-db-log-files` 次のコード例は、`describe-db-log-files` を使用する方法を示しています。 **AWS CLI** **DB インスタンスのログファイルを記述するには** 次の `describe-db-log-files` の例は、指定された DB インスタンスのログファイルの詳細を取得します。 ``` aws rds describe-db-log-files -\ -db-instance-identifier test-instance ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDbLogFiles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-log-files.html)」を参照してください。 ### `describe-db-parameter-groups` 次のコード例は、`describe-db-parameter-groups` を使用する方法を示しています。 **AWS CLI** **DB パラメータグループを記述するには** 次の `describe-db-parameter-groups` の例では、DB パラメータグループに関する詳細を取得します。 ``` aws rds describe-db-parameter-groups ``` 出力: ``` { "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... ] } ``` 詳細については、「Amazon RDS ユーザーガイド」の「[DB パラメータグループを使用する](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeDBParameterGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-parameter-groups.html)」を参照してください。** ### `describe-db-parameters` 次のコード例は、`describe-db-parameters` を使用する方法を示しています。 **AWS CLI** **DB パラメータグループのパラメータを記述するには** 次の `describe-db-parameters` の例では、指定された DB パラメータグループに関する詳細を取得します。 ``` aws rds describe-db-parameters \ --db-parameter-group-name mydbpg ``` 出力: ``` { "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... ] } ``` 詳細については、「Amazon RDS ユーザーガイド」の「[DB パラメータグループを使用する](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeDBParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-parameters.html)」を参照してください。** ### `describe-db-proxies` 次のコード例は、`describe-db-proxies` を使用する方法を示しています。 **AWS CLI** **RDS データベースの DB プロキシを記述するには** 次の `describe-db-proxies` の例では、DB プロキシに関する情報を取得します。　 ``` aws rds describe-db-proxies ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[RDS プロキシの表示](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-setup.html#rds-proxy-viewing)」および「*Amazon Aurora ユーザーガイド*」の「[RDS プロキシの表示](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-setup.html#rds-proxy-viewing)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDbProxies](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-proxies.html)」を参照してください。 ### `describe-db-proxy-endpoints` 次のコード例は、`describe-db-proxy-endpoints` を使用する方法を示しています。 **AWS CLI** **DB プロキシエンドポイントを記述するには** 次の `describe-db-proxy-endpoints` の例では、DB プロキシエンドポイントに関する情報を返します。 ``` aws rds describe-db-proxy-endpoints ``` 出力: ``` { "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 } ] } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[プロキシエンドポイントの表示](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-endpoints.html#rds-proxy-endpoints.DescribingEndpoint)」および「*Amazon Aurora ユーザーガイド*」の「[プロキシエンドポイントの作成](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-endpoints.html#rds-proxy-endpoints.DescribingEndpoint)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDbProxyEndpoints](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-proxy-endpoints.html)」を参照してください。 ### `describe-db-proxy-target-groups` 次のコード例は、`describe-db-proxy-target-groups` を使用する方法を示しています。 **AWS CLI** **DB プロキシエンドポイントを記述するには** 次の `describe-db-proxy-target-groups` の例では、DB プロキシターゲットグループに関する情報を取得します。　 ``` aws rds describe-db-proxy-target-groups \ --db-proxy-name proxyExample ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[RDS プロキシの表示](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-setup.html#rds-proxy-viewing)」および「*Amazon Aurora ユーザーガイド*」の「[RDS プロキシの表示](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-setup.html#rds-proxy-viewing)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDbProxyTargetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-proxy-target-groups.html)」を参照してください。 ### `describe-db-proxy-targets` 次のコード例は、`describe-db-proxy-targets` を使用する方法を示しています。 **AWS CLI** **DB プロキシターゲットを記述するには** 次の `describe-db-proxy-targets` の例では、DB プロキシターゲットに関する情報を返します。 ``` aws rds describe-db-proxy-targets \ --db-proxy-name proxyExample ``` 出力: ``` { "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" } } ] } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[RDS プロキシの表示](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-setup.html#rds-proxy-viewing)」および「*Amazon Aurora ユーザーガイド*」の「[RDS プロキシの表示](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-setup.html#rds-proxy-viewing)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDbProxyTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-proxy-targets.html)」を参照してください。 ### `describe-db-recommendations` 次のコード例は、`describe-db-recommendations` を使用する方法を示しています。 **AWS CLI** **例 1: すべての DB レコメンデーションを一覧表示するには** 次の `describe-db-recommendations` の例では、AWS アカウント内のすべての DB レコメンデーションを一覧表示します。 ``` aws rds describe-db-recommendations ``` 出力: ``` { "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" } ] } ] } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[Amazon RDS 推奨事項の表示と対応](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/monitoring-recommendations.html)」および「*Amazon Aurora ユーザーガイド*」の「[Amazon RDS 推奨事項の表示と対応](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/monitoring-recommendations.html)」を参照してください。 **例 2: 重要度の高い DB レコメンデーションを一覧表示するには** 次の `describe-db-recommendations` の例では、AWS アカウント内の重要度の高い DB レコメンデーションを一覧表示します。 ``` aws rds describe-db-recommendations \ --filters Name=severity,Values=high ``` 出力: ``` { "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/" } ] } ] } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[Amazon RDS 推奨事項の表示と対応](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/monitoring-recommendations.html)」および「*Amazon Aurora ユーザーガイド*」の「[Amazon RDS 推奨事項の表示と対応](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/monitoring-recommendations.html)」を参照してください。 **例 3: 指定された DB インスタンスの DB レコメンデーションを一覧表示するには** 次の `describe-db-recommendations` の例では、指定された DB インスタンスのすべての DB レコメンデーションを一覧表示します。 ``` aws rds describe-db-recommendations \ --filters Name=dbi-resource-id,Values=database-1 ``` 出力: ``` { "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" } ] } ] } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[Amazon RDS 推奨事項の表示と対応](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/monitoring-recommendations.html)」および「*Amazon Aurora ユーザーガイド*」の「[Amazon RDS 推奨事項の表示と対応](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/monitoring-recommendations.html)」を参照してください。 **例 4: アクティブな DB レコメンデーションをすべて一覧表示するには** 次の `describe-db-recommendations` の例では、AWS アカウント内のアクティブな DB レコメンデーションを一覧表示します。 ``` aws rds describe-db-recommendations \ --filters Name=status,Values=active ``` 出力: ``` { "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" } ] } ] } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[Amazon RDS 推奨事項の表示と対応](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/monitoring-recommendations.html)」および「*Amazon Aurora ユーザーガイド*」の「[Amazon RDS 推奨事項の表示と対応](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/monitoring-recommendations.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDbRecommendations](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-recommendations.html)」を参照してください。 ### `describe-db-security-groups` 次のコード例は、`describe-db-security-groups` を使用する方法を示しています。 **AWS CLI** **DB セキュリティグループを一覧表示するには** 次の `describe-db-security-groups` の例では、DB セキュリティグループを一覧表示します。 ``` aws rds describe-db-security-groups ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[利用可能な DB セキュリティグループを一覧表示する](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithSecurityGroups.html#USER_WorkingWithSecurityGroups.Listing)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDbSecurityGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-security-groups.html)」を参照してください。 ### `describe-db-shard-groups` 次のコード例は、`describe-db-shard-groups` を使用する方法を示しています。 **AWS CLI** **例 1: DB シャードグループを記述するには** 次の `describe-db-shard-groups` の例では、DB シャードグループに関する詳細を取得します。 ``` aws rds describe-db-shard-groups ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[Amazon Aurora DB クラスター](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDbShardGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-shard-groups.html)」を参照してください。 ### `describe-db-snapshot-attributes` 次のコード例は、`describe-db-snapshot-attributes` を使用する方法を示しています。 **AWS CLI** **DB スナップショットの属性名と値を記述するには** 次の `describe-db-snapshot-attributes` の例では、DB スナップショットの属性名と値について説明します。 ``` aws rds describe-db-snapshot-attributes \ --db-snapshot-identifier mydbsnapshot ``` 出力: ``` { "DBSnapshotAttributesResult": { "DBSnapshotIdentifier": "mydbsnapshot", "DBSnapshotAttributes": [ { "AttributeName": "restore", "AttributeValues": [ "123456789012", "210987654321" ] } ] } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[DB スナップショットの共有](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ShareSnapshot.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDbSnapshotAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-snapshot-attributes.html)」を参照してください。 ### `describe-db-snapshots` 次のコード例は、`describe-db-snapshots` を使用する方法を示しています。 **AWS CLI** **例 1: DB インスタンスの DB スナップショットを記述するには** 次の `describe-db-snapshots` の例は、DB インスタンスの DB スナップショットの詳細を取得します。 ``` aws rds describe-db-snapshots \ --db-snapshot-identifier mydbsnapshot ``` 出力: ``` { "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" } ] } ``` 詳細については、「Amazon RDS ユーザーガイド」の「[DB スナップショットの作成](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateSnapshot.html)」を参照してください。** **例 2: 手動で作成されたスナップショットの数を調べるには** 次の `describe-db-snapshots` の例は、`--query` オプションで `length` 演算子を使用して、特定の AWS リージョンに手動で作成されたスナップショットの数を返します。 ``` aws rds describe-db-snapshots \ --snapshot-type manual \ --query "length(*[].{DBSnapshots:SnapshotType})" \ --region eu-central-1 ``` 出力: ``` 35 ``` 詳細については、「Amazon RDS ユーザーガイド」の「[DB スナップショットの作成](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateSnapshot.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeDBSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-snapshots.html)」を参照してください。** ### `describe-db-subnet-groups` 次のコード例は、`describe-db-subnet-groups` を使用する方法を示しています。 **AWS CLI** **DB サブネットグループを記述するには** 次の `describe-db-subnet-groups` の例では、指定された DB サブネットグループに関する詳細を取得します。 ``` aws rds describe-db-subnet-groups ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[Amazon Virtual Private Cloud VPC および Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDbSubnetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-subnet-groups.html)」を参照してください。 ### `describe-engine-default-cluster-parameters` 次のコード例は、`describe-engine-default-cluster-parameters` を使用する方法を示しています。 **AWS CLI** **Aurora データベースエンジンのデフォルトのエンジンおよびシステムパラメータ情報を記述するには** 次の `describe-engine-default-cluster-parameters` の例では、MySQL 5.7 互換の Aurora DB クラスターのデフォルトのエンジンおよびシステムパラメータ情報の詳細を取得します。 ``` aws rds describe-engine-default-cluster-parameters \ --db-parameter-group-family aurora-mysql5.7 ``` 出力: ``` { "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... ] } } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[DB パラメータグループおよび DB クラスターパラメータグループを使用する](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEngineDefaultClusterParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-engine-default-cluster-parameters.html)」を参照してください。 ### `describe-engine-default-parameters` 次のコード例は、`describe-engine-default-parameters` を使用する方法を示しています。 **AWS CLI** **データベースエンジンのデフォルトのエンジンおよびシステムパラメータ情報を記述するには** 次の `describe-engine-default-parameters` の例では、MySQL 5.7 DB インスタンスのデフォルトのエンジンおよびシステムパラメータ情報の詳細を取得します。 ``` aws rds describe-engine-default-parameters \ --db-parameter-group-family mysql5.7 ``` 出力: ``` { "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... ] } } ``` 詳細については、「Amazon RDS ユーザーガイド」の「[DB パラメータグループを使用する](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html)」を参照してください。** + API の詳細については、*AWS CLI コマンドリファレンス*の「[DescribeEngineDefaultParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-engine-default-parameters.html)」を参照してください。 ### `describe-event-categories` 次のコード例は、`describe-event-categories` を使用する方法を示しています。 **AWS CLI** **イベントカテゴリについて表示するには** 次の `describe-event-categories` の例では、使用可能なすべてのイベントソースのイベントカテゴリの詳細を取得します。 ``` aws rds describe-event-categories ``` 出力: ``` { "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" ] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEventCategories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-event-categories.html)」を参照してください。 ### `describe-event-subscriptions` 次のコード例は、`describe-event-subscriptions` を使用する方法を示しています。 **AWS CLI** **イベントサブスクリプションについて表示するには** この例では、現在の AWS アカウントのすべての Amazon RDS イベントサブスクリプションについて説明します。 ``` aws rds describe-event-subscriptions ``` 出力: ``` { "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... ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEventSubscriptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-event-subscriptions.html)」を参照してください。 ### `describe-events` 次のコード例は、`describe-events` を使用する方法を示しています。 **AWS CLI** **イベントを記述するには** 次の `describe-events` の例では、指定した DB インスタンスで発生したイベントの詳細を取得します。 ``` aws rds describe-events \ --source-identifier test-instance \ --source-type db-instance ``` 出力: ``` { "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" } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeEvents](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-events.html)」を参照してください。 ### `describe-export-tasks` 次のコード例は、`describe-export-tasks` を使用する方法を示しています。 **AWS CLI** **スナップショットエクスポートタスクを記述するには** 次の `describe-export-tasks` の例では、Amazon S3 へのスナップショットのエクスポートに関する情報を返します。 ``` aws rds describe-export-tasks ``` 出力: ``` { "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 } ] } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[スナップショットのエクスポートのモニタリング](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ExportSnapshot.html#USER_ExportSnapshot.Monitoring)」を参照してください。 + API の詳細については、「AWS CLI コマンドリファレンス」の「[DescribeExportTasks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-export-tasks.html)」を参照してください。 ### `describe-global-clusters` 次のコード例は、`describe-global-clusters` を使用する方法を示しています。 **AWS CLI** **グローバル DB クラスターを記述するには** 次の `describe-global-clusters` の例では、現在の AWS リージョンの Aurora グローバル DB クラスターを一覧表示します。 ``` aws rds describe-global-clusters ``` 出力: ``` { "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": [] } ] } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[Aurora グローバルデータベースの管理](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-managing.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeGlobalClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-global-clusters.html)」を参照してください。 ### `describe-option-group-options` 次のコード例は、`describe-option-group-options` を使用する方法を示しています。 **AWS CLI** **使用可能なすべてのオプションを記述するには** 次の `describe-option-group-options` の例では、Oracle Database 19c インスタンスの 2 つのオプションを一覧表示します。 ``` aws rds describe-option-group-options \ --engine-name oracle-ee \ --major-engine-version 19 \ --max-items 2 ``` 出力: ``` { "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==" } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[オプショングループのオプションとそれらの設定を一覧表示する](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithOptionGroups.html#USER_WorkingWithOptionGroups.ListOption)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeOptionGroupOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-option-group-options.html)」を参照してください。 ### `describe-option-groups` 次のコード例は、`describe-option-groups` を使用する方法を示しています。 **AWS CLI** **使用可能なオプショングループの説明を表示するには** 次の `describe-option-groups` の例では、Oracle Database 19c インスタンスのオプショングループを一覧表示します。 ``` aws rds describe-option-groups \ --engine-name oracle-ee \ --major-engine-version 19 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[オプショングループのオプションとそれらの設定を一覧表示する](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithOptionGroups.html#USER_WorkingWithOptionGroups.ListOption)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeOptionGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-option-groups.html)」を参照してください。 ### `describe-orderable-db-instance-options` 次のコード例は、`describe-orderable-db-instance-options` を使用する方法を示しています。 **AWS CLI** **順序設定可能な DB インスタンスオプションを記述するには** 次の `describe-orderable-db-instance-options` の例は、MySQL DB エンジンを実行する DB インスタンスの順序設定可能なオプションの詳細を取得します。 ``` aws rds describe-orderable-db-instance-options \ --engine mysql ``` 出力: ``` { "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... } ``` + API の詳細については、AWS CLI コマンドリファレンスの「[DescribeOrderableDBInstanceOptions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-orderable-db-instance-options.html)」を参照してください。** ### `describe-pending-maintenance-actions` 次のコード例は、`describe-pending-maintenance-actions` を使用する方法を示しています。 **AWS CLI** **少なくとも 1 つの保留中のメンテナンスアクションを持つリソースを一覧表示するには** 次の `describe-pending-maintenance-actions` の例では、DB インスタンスの保留中のメンテナンスアクションを一覧表示します。 ``` aws rds describe-pending-maintenance-actions ``` 出力: ``` { "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" } ] } ] } ``` 詳細については、「[Amazon RDS ユーザーガイド](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html)」の「*DB インスタンスのメンテナンス*」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribePendingMaintenanceActions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-pending-maintenance-actions.html)」を参照してください。 ### `describe-reserved-db-instances-offerings` 次のコード例は、`describe-reserved-db-instances-offerings` を使用する方法を示しています。 **AWS CLI** **リザーブド DB インスタンスの提供を記述するには** 次の `describe-reserved-db-instances-offerings` の例では、`oracle` のリザーブド DB インスタンスオプションの詳細を取得します。 ``` aws rds describe-reserved-db-instances-offerings \ --product-description oracle ``` 出力: ``` { "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... } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeReservedDbInstancesOfferings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-reserved-db-instances-offerings.html)」を参照してください。 ### `describe-reserved-db-instances` 次のコード例は、`describe-reserved-db-instances` を使用する方法を示しています。 **AWS CLI** **リザーブド DB インスタンスを記述するには** 次の `describe-reserved-db-instances` の例では、現在の AWS アカウントで予約された DB インスタンスの詳細を取得します。 ``` aws rds describe-reserved-db-instances ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[Amazon RDS のリザーブド DB インスタンス](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithReservedDBInstances.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeReservedDbInstances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-reserved-db-instances.html)」を参照してください。 ### `describe-source-regions` 次のコード例は、`describe-source-regions` を使用する方法を示しています。 **AWS CLI** **ソースリージョンを記述するには** 次の `describe-source-regions` の例では、すべてのソース AWS リージョンの詳細を取得します。また、自動バックアップは、米国西部 (オレゴン) から送信先 AWS リージョンである米国東部 (バージニア北部) にのみレプリケートできることを示しています。 ``` aws rds describe-source-regions \ --region us-east-1 ``` 出力: ``` { "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 } ] } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[レプリケーションされたバックアップに関する情報の検索](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html#AutomatedBackups.Replicating.Describe)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeSourceRegions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-source-regions.html)」を参照してください。 ### `describe-valid-db-instance-modifications` 次のコード例は、`describe-valid-db-instance-modifications` を使用する方法を示しています。 **AWS CLI** **DB インスタンスの有効な変更を記述するには** 次の `describe-valid-db-instance-modifications` の例は、指定された DB インスタンスの有効な変更に関する詳細を取得します。 ``` aws rds describe-valid-db-instance-modifications \ --db-instance-identifier test-instance ``` 出力: ``` { "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" } ] } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeValidDbInstanceModifications](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-valid-db-instance-modifications.html)」を参照してください。 ### `download-db-log-file-portion` 次のコード例は、`download-db-log-file-portion` を使用する方法を示しています。 **AWS CLI** **例 1: DB ログファイルの最新部分をダウンロードするには** 次の `download-db-log-file-portion` の例では、ログファイルの最新の部分のみをダウンロードし、`tail.txt` という名前のローカルファイルに保存します。 ``` aws rds download-db-log-file-portion \ --db-instance-identifier test-instance \ --log-file-name log.txt \ --output text > tail.txt ``` 保存されたファイルには空白行が含まれている場合があります。ダウンロード中にログファイルの各部分の最後に表示されます。 **例 2: DB ログファイル全体をダウンロードするには** 次の `download-db-log-file-portion` の例では、`--starting-token 0` パラメータを使用してログファイル全体をダウンロードし、出力を `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 ``` 保存されたファイルには空白行が含まれている場合があります。ダウンロード中にログファイルの各部分の最後に表示されます。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DownloadDbLogFilePortion](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/download-db-log-file-portion.html)」を参照してください。 ### `generate-auth-token` 次のコード例は、`generate-auth-token` を使用する方法を示しています。 **AWS CLI** **認証トークンを生成するには** 次の `generate-db-auth-token` の例では、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 ``` 出力: ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GenerateAuthToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/generate-auth-token.html)」を参照してください。 ### `generate-db-auth-token` 次のコード例は、`generate-db-auth-token` を使用する方法を示しています。 **AWS CLI** **IAM 認証トークンを生成するには** 次の `generate-db-auth-token` の例では、IAM 認証トークンを生成してデータベースに接続します。 ``` aws rds generate-db-auth-token \ --hostname mydb.123456789012.us-east-1.rds.amazonaws.com \ --port 3306 \ --region us-east-1 \ --username db_user ``` 出力: ``` 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 ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[IAM 認証を使用した DB インスタンスへの接続](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.Connecting.html)」および「*Amazon Aurora ユーザーガイド*」の「[IAM 認証を使用した DB クラスターへの接続](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.Connecting.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GenerateDbAuthToken](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/generate-db-auth-token.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **Amazon RDS リソースのすべてのタグを一覧表示するには** 次の `list-tags-for-resource` の例では、DB インスタンスのすべてのタグを一覧表示します。 ``` aws rds list-tags-for-resource \ --resource-name arn:aws:rds:us-east-1:123456789012:db:orcl1 ``` 出力: ``` { "TagList": [ { "Key": "Environment", "Value": "test" }, { "Key": "Name", "Value": "MyDatabase" } ] } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[Amazon RDS リソースのタグ付け](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/list-tags-for-resource.html)」を参照してください。 ### `modify-certificates` 次のコード例は、`modify-certificates` を使用する方法を示しています。 **AWS CLI** **新しい DB インスタンスのシステムデフォルト SSL/TLS 証明書を一時的に上書きするには** 次の `modify-certificates` の例では、新しい DB インスタンスのシステムデフォルト SSL/TLS 証明書を一時的に上書きします。 ``` aws rds modify-certificates \ --certificate-identifier rds-ca-2019 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[SSL/TLS 証明書のローテーション](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html)」および「*Amazon Aurora ユーザーガイド*」の「[SSL/TLS 証明書のローテーション](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyCertificates](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-certificates.html)」を参照してください。 ### `modify-current-db-cluster-capacity` 次のコード例は、`modify-current-db-cluster-capacity` を使用する方法を示しています。 **AWS CLI** **Aurora Serverless DB クラスターの容量を拡張するには** 次の `modify-current-db-cluster-capacity` の例では、Aurora Serverless DB クラスターの容量を 8 にスケーリングします。 ``` aws rds modify-current-db-cluster-capacity \ --db-cluster-identifier mydbcluster \ --capacity 8 ``` 出力: ``` { "DBClusterIdentifier": "mydbcluster", "PendingCapacity": 8, "CurrentCapacity": 1, "SecondsBeforeTimeout": 300, "TimeoutAction": "ForceApplyCapacityChange" } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[Aurora Serverless v1 DB クラスターのキャパシティーを手動でスケーリングする](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.setting-capacity.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyCurrentDbClusterCapacity](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-current-db-cluster-capacity.html)」を参照してください。 ### `modify-db-cluster-endpoint` 次のコード例は、`modify-db-cluster-endpoint` を使用する方法を示しています。 **AWS CLI** **カスタム DB クラスターエンドポイントを変更するには** 次の `modify-db-cluster-endpoint` の例では、指定されたカスタム DB クラスターエンドポイントを変更します。 ``` aws rds modify-db-cluster-endpoint \ --db-cluster-endpoint-identifier mycustomendpoint \ --static-members dbinstance1 dbinstance2 dbinstance3 ``` 出力: ``` { "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" } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[Amazon Aurora 接続管理](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.Endpoints.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyDbClusterEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-db-cluster-endpoint.html)」を参照してください。 ### `modify-db-cluster-parameter-group` 次のコード例は、`modify-db-cluster-parameter-group` を使用する方法を示しています。 **AWS CLI** **DB クラスターパラメータグループのパラメータを変更するには** 次の `modify-db-cluster-parameter-group` の例は、DB クラスターパラメータのパラメータの値を変更します。 ``` 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" ``` 出力: ``` { "DBClusterParameterGroupName": "mydbclusterpg" } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[DB パラメータグループおよび DB クラスターパラメータグループを使用する](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-db-cluster-parameter-group.html)」を参照してください。 ### `modify-db-cluster-snapshot-attribute` 次のコード例は、`modify-db-cluster-snapshot-attribute` を使用する方法を示しています。 **AWS CLI** **DB クラスタースナップショット属性を変更するには** 次の `modify-db-cluster-snapshot-attribute` の例では、指定された DB クラスタースナップショット属性を変更します。 ``` aws rds modify-db-cluster-snapshot-attribute \ --db-cluster-snapshot-identifier myclustersnapshot \ --attribute-name restore \ --values-to-add 123456789012 ``` 出力: ``` { "DBClusterSnapshotAttributesResult": { "DBClusterSnapshotIdentifier": "myclustersnapshot", "DBClusterSnapshotAttributes": [ { "AttributeName": "restore", "AttributeValues": [ "123456789012" ] } ] } } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[DB クラスターのスナップショットからの復元](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_RestoreFromSnapshot.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyDbClusterSnapshotAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-db-cluster-snapshot-attribute.html)」を参照してください。 ### `modify-db-cluster` 次のコード例は、`modify-db-cluster` を使用する方法を示しています。 **AWS CLI** **例 1: DB クラスターを変更するには** 次の `modify-db-cluster` の例では、`cluster-2` という名前の DB クラスターのマスターユーザーパスワードを変更し、バックアップ保持期間を 14 日間に設定します。`--apply-immediately` パラメータを使用することで、次のメンテナンスウィンドウを待つことなく、すぐに変更することができます。 ``` aws rds modify-db-cluster \ --db-cluster-identifier cluster-2 \ --backup-retention-period 14 \ --master-user-password newpassword99 \ --apply-immediately ``` 出力: ``` { "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": [] } } ``` 詳細については、[Amazon Aurora ユーザーガイド](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Modifying.html)の「*Amazon Aurora DB クラスターの変更*」を参照してください。 **例 2: VPC セキュリティグループを DB クラスターと関連付けるには** 次の `modify-db-instance` の例では、特定の VPC セキュリティグループを関連付け、DB クラスターから DB セキュリティグループを削除します。 ``` aws rds modify-db-cluster \ --db-cluster-identifier dbName \ --vpc-security-group-ids sg-ID ``` 出力: ``` { "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... } } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[セキュリティグループによるアクセス制御](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Overview.RDSSecurityGroups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-db-cluster.html)」を参照してください。 ### `modify-db-instance` 次のコード例は、`modify-db-instance` を使用する方法を示しています。 **AWS CLI** **例 1: DB インスタンスを変更するには** 次の `modify-db-instance` の例は、オプショングループとパラメータグループを互換性のある Microsoft SQL Server DB インスタンスに関連付けます。`--apply-immediately` パラメータを使用することで、次のメンテナンスウィンドウを待つことなく、オプショングループとパラメータグループをすぐに関連付けることができます。 ``` 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 ``` 出力: ``` { "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 } } ``` 詳細については、「Amazon RDS ユーザーガイド」の「[Amazon RDS DB インスタンスを変更する](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html)」を参照してください。** **例 2: VPC セキュリティグループを DB インスタンスと関連付けるには** 次の `modify-db-instance` の例では、特定の VPC セキュリティグループを関連付け、DB インスタンスから DB セキュリティグループを削除します。 ``` aws rds modify-db-instance \ --db-instance-identifier dbName \ --vpc-security-group-ids sg-ID ``` 出力: ``` { "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 ... } } ``` 詳細については、「Amazon RDS ユーザーガイド」の「[セキュリティグループによるアクセス制御](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.RDSSecurityGroups.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンス**の「[ModifyDBInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-db-instance.html)」を参照してください。 ### `modify-db-parameter-group` 次のコード例は、`modify-db-parameter-group` を使用する方法を示しています。 **AWS CLI** **DB パラメータグループを変更するには** 次の `modify-db-parameter-group` の例は、DB パラメータグループの `clr enabled` パラメータの値を変更します。`--apply-immediately` パラメータを使用することで、次のメンテナンスウィンドウを待つことなく、DB パラメータグループをすぐに変更することができます。 ``` aws rds modify-db-parameter-group \ --db-parameter-group-name test-sqlserver-se-2017 \ --parameters "ParameterName='clr enabled',ParameterValue=1,ApplyMethod=immediate" ``` 出力: ``` { "DBParameterGroupName": "test-sqlserver-se-2017" } ``` 詳細については、「Amazon RDS ユーザーガイド」の「[DB パラメータグループのパラメータの変更](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html#USER_WorkingWithParamGroups.Modifying)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンス** の「[ModifyDBParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-db-parameter-group.html)」を参照してください。 ### `modify-db-proxy-endpoint` 次のコード例は、`modify-db-proxy-endpoint` を使用する方法を示しています。 **AWS CLI** **RDS データベースの DB プロキシエンドポイントを変更するには** 次の `modify-db-proxy-endpoint` の例では、DB プロキシエンドポイント `proxyEndpoint` を変更して、読み取りタイムアウトを 65 秒に設定します。 ``` aws rds modify-db-proxy-endpoint \ --db-proxy-endpoint-name proxyEndpoint \ --cli-read-timeout 65 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[プロキシエンドポイントの変更](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-endpoints.html#rds-proxy-endpoints.ModifyingEndpoint)」および「*Amazon Aurora ユーザーガイド*」の「[プロキシエンドポイントの変更](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-endpoints.html#rds-proxy-endpoints.ModifyingEndpoint)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyDbProxyEndpoint](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-db-proxy-endpoint.html)」を参照してください。 ### `modify-db-proxy-target-group` 次のコード例は、`modify-db-proxy-target-group` を使用する方法を示しています。 **AWS CLI** **DB プロキシエンドポイントを変更するには** 次の `modify-db-proxy-target-group` の例では、DB プロキシターゲットグループを変更して、最大接続数を 80%、最大アイドル接続数を 10% に設定します。 ``` aws rds modify-db-proxy-target-group \ --target-group-name default \ --db-proxy-name proxyExample \ --connection-pool-config MaxConnectionsPercent=80,MaxIdleConnectionsPercent=10 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[RDS プロキシの変更](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-managing.html#rds-proxy-modifying-proxy)」および「*Amazon Aurora ユーザーガイド*」の「[RDS プロキシの変更](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-managing.html#rds-proxy-modifying-proxy)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyDbProxyTargetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-db-proxy-target-group.html)」を参照してください。 ### `modify-db-proxy` 次のコード例は、`modify-db-proxy` を使用する方法を示しています。 **AWS CLI** **RDS データベースの DB プロキシを変更するには** 次の `modify-db-proxy` の例では、`proxyExample` という名前の DB プロキシを変更して、接続に SSL を要求するようにしています。 ``` aws rds modify-db-proxy \ --db-proxy-name proxyExample \ --require-tls ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[RDS プロキシの変更](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-managing.html#rds-proxy-modifying-proxy)」および「*Amazon Aurora ユーザーガイド*」の「[RDS プロキシの作成](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-managing.html#rds-proxy-modifying-proxy)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyDbProxy](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-db-proxy.html)」を参照してください。 ### `modify-db-shard-group` 次のコード例は、`modify-db-shard-group` を使用する方法を示しています。 **AWS CLI** **例 1: DB シャードグループを変更するには** 次の `modify-db-shard-group` の例では、DB シャードグループの最大容量を変更します。 ``` aws rds modify-db-shard-group \ --db-shard-group-identifier my-db-shard-group \ --max-acu 1000 ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[Amazon Aurora DB クラスター](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.html)」を参照してください。 **例 2: DB シャードグループを記述するには** 次の `describe-db-shard-groups` の例では、`modify-db-shard-group` コマンドの実行後に DB シャードグループの詳細を取得します。DB シャードグループ `my-db-shard-group` の最大容量は、1000 Aurora キャパシティーユニット (ACU) になりました。 ``` aws rds describe-db-shard-groups ``` 出力: ``` { "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" } ] } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[Amazon Aurora DB クラスター](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyDbShardGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-db-shard-group.html)」を参照してください。 ### `modify-db-snapshot-attribute` 次のコード例は、`modify-db-snapshot-attribute` を使用する方法を示しています。 **AWS CLI** **例 1: 2 つの AWS アカウントで DB スナップショットを復元できるようにするには** 次の `modify-db-snapshot-attribute` の例では、`mydbsnapshot` という名前のスナップショットを復元するために、2 つの AWS アカウント (識別子 `111122223333` および `444455556666`) にアクセス許可を付与します。 ``` aws rds modify-db-snapshot-attribute \ --db-snapshot-identifier mydbsnapshot \ --attribute-name restore \ --values-to-add {"111122223333","444455556666"} ``` 出力: ``` { "DBSnapshotAttributesResult": { "DBSnapshotIdentifier": "mydbsnapshot", "DBSnapshotAttributes": [ { "AttributeName": "restore", "AttributeValues": [ "111122223333", "444455556666" ] } ] } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[スナップショットの共有](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ShareSnapshot.html#USER_ShareSnapshot.Sharing)」を参照してください。 **例 2: AWS アカウントが DB スナップショットを復元できないようにするには** 次の `modify-db-snapshot-attribute` の例では、`mydbsnapshot` という名前の DB スナップショットを復元するアクセス許可を特定の AWS アカウントから削除します。単一のアカウントを指定する場合、アカウント識別子を引用符や中括弧で囲むことはできません。 ``` aws rds modify-db-snapshot-attribute \ --db-snapshot-identifier mydbsnapshot \ --attribute-name restore \ --values-to-remove 444455556666 ``` 出力: ``` { "DBSnapshotAttributesResult": { "DBSnapshotIdentifier": "mydbsnapshot", "DBSnapshotAttributes": [ { "AttributeName": "restore", "AttributeValues": [ "111122223333" ] } ] } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[スナップショットの共有](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ShareSnapshot.html#USER_ShareSnapshot.Sharing)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyDbSnapshotAttribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-db-snapshot-attribute.html)」を参照してください。 ### `modify-db-snapshot-attributes` 次のコード例は、`modify-db-snapshot-attributes` を使用する方法を示しています。 **AWS CLI** **DB スナップショット属性を変更するには** 次の `modify-db-snapshot-attribute` の例では、2 つの AWS アカウント識別子 `111122223333` および `444455556666` が `mydbsnapshot` という名前のスナップショットを復元できるようになります。 ``` aws rds modify-db-snapshot-attribute \ --db-snapshot-identifier mydbsnapshot \ --attribute-name restore \ --values-to-add '["111122223333","444455556666"]' ``` 出力: ``` { "DBSnapshotAttributesResult": { "DBSnapshotIdentifier": "mydbsnapshot", "DBSnapshotAttributes": [ { "AttributeName": "restore", "AttributeValues": [ "111122223333", "444455556666" ] } ] } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[スナップショットの共有](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ShareSnapshot.html#USER_ShareSnapshot.Sharing)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyDbSnapshotAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-db-snapshot-attributes.html)」を参照してください。 ### `modify-db-snapshot` 次のコード例は、`modify-db-snapshot` を使用する方法を示しています。 **AWS CLI** **DB スナップショットを変更するには** 次の `modify-db-snapshot` の例では、`db5-snapshot-upg-test` という名前の PostgeSQL 10.6 スナップショットを PostgreSQL 11.7 にアップグレードします。新しい DB エンジンバージョンは、スナップショットのアップグレードが完了し、そのステータスが**使用可能**になった後に表示されます。 ``` aws rds modify-db-snapshot \ --db-snapshot-identifier db5-snapshot-upg-test \ --engine-version 11.7 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[PostgreSQL DB スナップショットをアップグレードする](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBSnapshot.PostgreSQL.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyDbSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-db-snapshot.html)」を参照してください。 ### `modify-db-subnet-group` 次のコード例は、`modify-db-subnet-group` を使用する方法を示しています。 **AWS CLI** **DB サブネットグループを変更するには** 次の `modify-db-subnet-group` の例では、`mysubnetgroup` という名前の DB サブネットグループに ID が `subnet-08e41f9e230222222` のサブネットを追加します。既存のサブネットをサブネットグループに保持するには、`--subnet-ids` オプションに ID を値として含めます。DB サブネットグループに最低 2 つの異なるアベイラビリティーゾーンがあるサブネットであることを確認します。 ``` aws rds modify-db-subnet-group \ --db-subnet-group-name mysubnetgroup \ --subnet-ids '["subnet-0a1dc4e1a6f123456","subnet-070dd7ecb3aaaaaaa","subnet-00f5b198bc0abcdef","subnet-08e41f9e230222222"]' ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[ステップ 3: DB サブネットグループの作成](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.CreateDBSubnetGroup)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyDbSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-db-subnet-group.html)」を参照してください。 ### `modify-event-subscription` 次のコード例は、`modify-event-subscription` を使用する方法を示しています。 **AWS CLI** **イベントサブスクリプションを変更するには** 次の `modify-event-subscription` の例では、指定されたイベントサブスクリプションを無効にするため、指定された Amazon Simple Notification Service トピックに通知を発行しなくなります。 ``` aws rds modify-event-subscription \ --subscription-name my-instance-events \ --no-enabled ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyEventSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-event-subscription.html)」を参照してください。 ### `modify-global-cluster` 次のコード例は、`modify-global-cluster` を使用する方法を示しています。 **AWS CLI** **グローバル DB クラスターを変更するには** 次の `modify-global-cluster` の例では、Aurora MySQL 互換のグローバル DB クラスターの削除保護を有効にします。 ``` aws rds modify-global-cluster \ --global-cluster-identifier myglobalcluster \ --deletion-protection ``` 出力: ``` { "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": [] } } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[Aurora グローバルデータベースの管理](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-managing.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ModifyGlobalCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/modify-global-cluster.html)」を参照してください。 ### `promote-read-replica-db-cluster` 次のコード例は、`promote-read-replica-db-cluster` を使用する方法を示しています。 **AWS CLI** **DB クラスターリードレプリカを昇格するには** 次の `promote-read-replica-db-cluster` の例では、指定されたリードレプリカをスタンドアロン DB クラスターに昇格させます。 ``` aws rds promote-read-replica-db-cluster \ --db-cluster-identifier mydbcluster-1 ``` 出力: ``` { "DBCluster": { "AllocatedStorage": 1, "AvailabilityZones": [ "us-east-1a", "us-east-1b", "us-east-1c" ], "BackupRetentionPeriod": 1, "DatabaseName": "", "DBClusterIdentifier": "mydbcluster-1", ...some output truncated... } } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[リードレプリカを DB クラスターに昇格させる](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Replication.CrossRegion.html#AuroraMySQL.Replication.CrossRegion.Promote)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PromoteReadReplicaDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/promote-read-replica-db-cluster.html)」を参照してください。 ### `promote-read-replica` 次のコード例は、`promote-read-replica` を使用する方法を示しています。 **AWS CLI** **リードレプリカを昇格させるには** 次の `promote-read-replica` の例では、指定されたリードレプリカをスタンドアロン DB インスタンスに昇格させます。 ``` aws rds promote-read-replica \ --db-instance-identifier test-instance-repl ``` 出力: ``` { "DBInstance": { "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance-repl", "StorageType": "standard", "ReadReplicaSourceDBInstanceIdentifier": "test-instance", "DBInstanceStatus": "modifying", ...some output truncated... } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PromoteReadReplica](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/promote-read-replica.html)」を参照してください。 ### `purchase-reserved-db-instance` 次のコード例は、`purchase-reserved-db-instance` を使用する方法を示しています。 **AWS CLI** **リザーブド DB インスタンスを購入するには** 次の `purchase-reserved-db-instances-offering` の例では、リザーブド DB インスタンスサービスを購入します。`reserved-db-instances-offering-id` は、`describe-reserved-db-instances-offering` コマンドによって返される有効なオファリング ID である必要があります。 aws rds purchase-reserved-db-instances-offering --reserved-db-instances-offering-id 438012d3-4a52-4cc7-b2e3-8dff72e0e706 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PurchaseReservedDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/purchase-reserved-db-instance.html)」を参照してください。 ### `purchase-reserved-db-instances-offerings` 次のコード例は、`purchase-reserved-db-instances-offerings` を使用する方法を示しています。 **AWS CLI** **例 1: 購入するリザーブド DB インスタンスを検索するには** 次の `describe-reserved-db-instances-offerings` の例では、db.t2.micro インスタンスクラスと 1 年間の利用可能なリザーブド MySQL DB インスタンスを一覧表示します。オファリング ID は、リザーブド DB インスタンスの購入に必要です。 ``` aws rds describe-reserved-db-instances-offerings \ --product-description mysql \ --db-instance-class db.t2.micro \ --duration 1 ``` 出力: ``` { "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 ... ] } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[Amazon RDS のリザーブド DB インスタンス](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithReservedDBInstances.html)」を参照してください。 **例 2: リザーブド DB インスタンスを購入するには** 次の `purchase-reserved-db-instances-offering` の例は、前の例からのリザーブド DB インスタンスサービスを購入する方法を示しています。 aws rds purchase-reserved-db-instances-offering --reserved-db-instances-offering-id 8ba30be1-b9ec-447f-8f23-6114e3f4c7b4 出力: ``` { "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" } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[Amazon RDS のリザーブド DB インスタンス](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithReservedDBInstances.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[PurchaseReservedDbInstancesOfferings](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/purchase-reserved-db-instances-offerings.html)」を参照してください。 ### `reboot-db-instance` 次のコード例は、`reboot-db-instance` を使用する方法を示しています。 **AWS CLI** **DB インスタンスを再起動するには** 次の `reboot-db-instance` の例は、指定された DB インスタンスを再起動します。 ``` aws rds reboot-db-instance \ --db-instance-identifier test-mysql-instance ``` 出力: ``` { "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... } } ``` 詳細については、「Amazon RDS ユーザーガイド」の「[DB インスタンスの再起動](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_RebootInstance.html)」を参照してください。** + API の詳細については、AWS CLI コマンドリファレンスの「[RebootDBInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/reboot-db-instance.html)」を参照してください。** ### `reboot-db-shard-group` 次のコード例は、`reboot-db-shard-group` を使用する方法を示しています。 **AWS CLI** **例 1: DB シャードグループを再起動するには** 次の `reboot-db-shard-group` の例では、DB シャードグループを再起動します。 ``` aws rds reboot-db-shard-group \ --db-shard-group-identifier my-db-shard-group ``` 出力: ``` { "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" } ] } ``` 詳細については、「[Amazon Aurora ユーザーガイド](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_RebootCluster.html)」の「*Amazon Aurora DB クラスターまたは Amazon Aurora DB インスタンスの再起動*」を参照してください。 **例 2: DB シャードグループを記述するには** 次の `describe-db-shard-groups` の例では、`reboot-db-shard-group` コマンドの実行後に DB シャードグループの詳細を取得します。DB シャードグループ `my-db-shard-group` を再起動しています。 ``` aws rds describe-db-shard-groups ``` 出力: ``` { "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" } ] } ``` 詳細については、「[Amazon Aurora ユーザーガイド](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_RebootCluster.html)」の「*Amazon Aurora DB クラスターまたは Amazon Aurora DB インスタンスの再起動*」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RebootDbShardGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/reboot-db-shard-group.html)」を参照してください。 ### `register-db-proxy-targets` 次のコード例は、`register-db-proxy-targets` を使用する方法を示しています。 **AWS CLI** **DB プロキシをデータベースに登録するには** 次の `register-db-proxy-targets` の例では、データベースとプロキシ間の関連付けを作成します。 ``` aws rds register-db-proxy-targets \ --db-proxy-name proxyExample \ --db-cluster-identifiers database-5 ``` 出力: ``` { "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" } } ] } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[RDS プロキシの作成](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy-setup.html#rds-proxy-creating)」および「*Amazon Aurora ユーザーガイド*」の「[RDS プロキシの作成](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-setup.html#rds-proxy-creating)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RegisterDbProxyTargets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/register-db-proxy-targets.html)」を参照してください。 ### `remove-from-global-cluster` 次のコード例は、`remove-from-global-cluster` を使用する方法を示しています。 **AWS CLI** **Aurora グローバルデータベースクラスターから Aurora セカンダリクラスターをデタッチするには** 次の `remove-from-global-cluster` の例では、Aurora グローバルデータベースクラスターから Aurora セカンダリクラスターをデタッチします。クラスターは読み取り専用から、読み取り/書き込み機能を備えたスタンドアロンクラスターに変わります。 ``` 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 ``` 出力: ``` { "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" } ] } } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[Amazon Aurora Global Database からのクラスターの削除](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-managing.html#aurora-global-database-detaching)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveFromGlobalCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/remove-from-global-cluster.html)」を参照してください。 ### `remove-option-from-option-group` 次のコード例は、`remove-option-from-option-group` を使用する方法を示しています。 **AWS CLI** **オプショングループからオプションを削除するには** 次の `remove-option-from-option-group` の例では、`OEM` オプションを `myoptiongroup` から削除しています。 ``` aws rds remove-option-from-option-group \ --option-group-name myoptiongroup \ --options OEM \ --apply-immediately ``` 出力: ``` { "OptionGroup": { "OptionGroupName": "myoptiongroup", "OptionGroupDescription": "Test", "EngineName": "oracle-ee", "MajorEngineVersion": "19", "Options": [], "AllowsVpcAndNonVpcInstanceMemberships": true, "OptionGroupArn": "arn:aws:rds:us-east-1:123456789012:og:myoptiongroup" } } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[オプショングループからオプションを削除する](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithOptionGroups.html#USER_WorkingWithOptionGroups.RemoveOption)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveOptionFromOptionGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/remove-option-from-option-group.html)」を参照してください。 ### `remove-role-from-db-cluster` 次のコード例は、`remove-role-from-db-cluster` を使用する方法を示しています。 **AWS CLI** **DB クラスターから AWS Identity and Access Management (IAM) ロールの関連付けを解除するには** 次の `remove-role-from-db-cluster` の例では、DB クラスターからロールを削除します。 ``` aws rds remove-role-from-db-cluster \ --db-cluster-identifier mydbcluster \ --role-arn arn:aws:iam::123456789012:role/RDSLoadFromS3 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon Aurora ユーザーガイド*」の「[IAM ロールと Amazon Aurora MySQL DB クラスターの関連付け](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Integrating.Authorizing.IAM.AddRoleToDBCluster.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveRoleFromDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/remove-role-from-db-cluster.html)」を参照してください。 ### `remove-role-from-db-instance` 次のコード例は、`remove-role-from-db-instance` を使用する方法を示しています。 **AWS CLI** **DB インスタンスから AWS Identity and Access Management (IAM) ロールの関連付けを解除するには** 次の `remove-role-from-db-instance` の例では、`test-instance` という名前の Oracle DB インスタンスから `rds-s3-integration-role` という名前のロールを削除します。 ``` 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 ``` このコマンドでは何も出力されません。 詳細については、「*Amazon RDS ユーザーガイド*」の「[S3 との RDS SQL Server 統合の無効化](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/User.SQLServer.Options.S3-integration.html#Appendix.SQLServer.Options.S3-integration.disabling)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveRoleFromDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/remove-role-from-db-instance.html)」を参照してください。 ### `remove-source-identifier-from-subscription` 次のコード例は、`remove-source-identifier-from-subscription` を使用する方法を示しています。 **AWS CLI** **サブスクリプションからソース識別子を削除するには** 次の `remove-source-identifier` の例は、ソース識別子を既存のサブスクリプションから削除します。 ``` aws rds remove-source-identifier-from-subscription \ --subscription-name my-instance-events \ --source-identifier test-instance-repl ``` 出力: ``` { "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 } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveSourceIdentifierFromSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/remove-source-identifier-from-subscription.html)」を参照してください。 ### `remove-tags-from-resource` 次のコード例は、`remove-tags-from-resource` を使用する方法を示しています。 **AWS CLI** **リソースからタグを削除する** 次の `remove-tags-from-resource` の例では、リソースからタグが削除されます。 ``` aws rds remove-tags-from-resource \ --resource-name arn:aws:rds:us-east-1:123456789012:db:mydbinstance \ --tag-keys Name Environment ``` このコマンドでは何も出力されません。 詳細については、「*Amazon RDS ユーザーガイド*」の「[Amazon RDS リソースのタグ付け](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)」および「*Amazon Aurora ユーザーガイド*」の「[Amazon RDS リソースのタグ付け](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RemoveTagsFromResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/remove-tags-from-resource.html)」を参照してください。 ### `reset-db-cluster-parameter-group` 次のコード例は、`reset-db-cluster-parameter-group` を使用する方法を示しています。 **AWS CLI** **例 1: すべてのパラメータをデフォルト値にリセットするには** 次の `reset-db-cluster-parameter-group` の例では、顧客が作成した DB クラスターパラメータグループのパラメータ値をデフォルト値にリセットします。 ``` aws rds reset-db-cluster-parameter-group \ --db-cluster-parameter-group-name mydbclpg \ --reset-all-parameters ``` 出力: ``` { "DBClusterParameterGroupName": "mydbclpg" } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[DB パラメータグループおよび DB クラスターパラメータグループを使用する](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html)」を参照してください。 **例 2: 特定のパラメータをデフォルト値にリセットするには** 次の `reset-db-cluster-parameter-group` の例では、特定のパラメータのパラメータ値を顧客が作成した DB クラスターパラメータグループのデフォルト値にリセットします。 ``` 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" ``` 出力: ``` { "DBClusterParameterGroupName": "mydbclpg" } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[DB パラメータグループおよび DB クラスターパラメータグループを使用する](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ResetDbClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/reset-db-cluster-parameter-group.html)」を参照してください。 ### `reset-db-parameter-group` 次のコード例は、`reset-db-parameter-group` を使用する方法を示しています。 **AWS CLI** **例 1: すべてのパラメータをデフォルト値にリセットするには** 次の `reset-db-parameter-group` の例では、顧客が作成した DB パラメータグループのパラメータ値をデフォルト値にリセットします。 ``` aws rds reset-db-parameter-group \ --db-parameter-group-name mypg \ --reset-all-parameters ``` 出力: ``` { "DBParameterGroupName": "mypg" } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[DB パラメータグループを使用する](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html)」および「*Amazon Aurora ユーザーガイド*」の「[DB パラメータグループおよび DB クラスターパラメータグループを使用する](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html)」を参照してください。 **例 2: 特定のパラメータをデフォルト値にリセットするには** 次の `reset-db-parameter-group` の例では、特定のパラメータのパラメータ値を顧客が作成した DB パラメータグループのデフォルト値にリセットします。 ``` aws rds reset-db-parameter-group \ --db-parameter-group-name mypg \ --parameters "ParameterName=max_connections,ApplyMethod=immediate" \ "ParameterName=max_allowed_packet,ApplyMethod=immediate" ``` 出力: ``` { "DBParameterGroupName": "mypg" } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[DB パラメータグループを使用する](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html)」および「*Amazon Aurora ユーザーガイド*」の「[DB パラメータグループおよび DB クラスターパラメータグループを使用する](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ResetDbParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/reset-db-parameter-group.html)」を参照してください。 ### `restore-db-cluster-from-s3` 次のコード例は、`restore-db-cluster-from-s3` を使用する方法を示しています。 **AWS CLI** **Amazon S3 バケットから Amazon Aurora DB クラスターを復元するには** 次の `restore-db-cluster-from-s3` の例では、Amazon Aurora MySQL バージョン 5.7 互換 DB クラスターを Amazon S3 の MySQL 5.7 DB バックアップファイルから復元します。 ``` 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 ``` 出力: ``` { "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": [] } } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[Amazon S3 バケットを使用した MySQL からのデータ移行](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Migrating.ExtMySQL.html#AuroraMySQL.Migrating.ExtMySQL.S3)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RestoreDbClusterFromS3](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/restore-db-cluster-from-s3.html)」を参照してください。 ### `restore-db-cluster-from-snapshot` 次のコード例は、`restore-db-cluster-from-snapshot` を使用する方法を示しています。 **AWS CLI** **スナップショットから DB クラスターを復元するには** 次の `restore-db-cluster-from-snapshot` は、PostgreSQL バージョン 10.7 と互換性のある Aurora PostgreSQL DB クラスターを、`test-instance-snapshot` という名前の DB クラスタースナップショットから復元します。 ``` aws rds restore-db-cluster-from-snapshot \ --db-cluster-identifier newdbcluster \ --snapshot-identifier test-instance-snapshot \ --engine aurora-postgresql \ --engine-version 10.7 ``` 出力: ``` { "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": [] } } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[DB クラスターのスナップショットからの復元](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_RestoreFromSnapshot.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RestoreDbClusterFromSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/restore-db-cluster-from-snapshot.html)」を参照してください。 ### `restore-db-cluster-to-point-in-time` 次のコード例は、`restore-db-cluster-to-point-in-time` を使用する方法を示しています。 **AWS CLI** **DB クラスターを特定の時点に復元するには** 次の `restore-db-cluster-to-point-in-time` の例では、`database-4` という名前の DB クラスターを可能な限り最新の時刻に復元します。`copy-on-write` を復元タイプとして使用すると、新しい DB クラスターがソース DB クラスターのクローンとして復元されます。 ``` 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 ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[DB クラスターを指定の時点の状態に復元する](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PIT.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RestoreDbClusterToPointInTime](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/restore-db-cluster-to-point-in-time.html)」を参照してください。 ### `restore-db-instance-from-db-snapshot` 次のコード例は、`restore-db-instance-from-db-snapshot` を使用する方法を示しています。 **AWS CLI** **DB スナップショットから DB インスタンスを復元するには** 次の `restore-db-instance-from-db-snapshot` の例では、指定された DB スナップショットから `db.t3.small` DB インスタンスクラスで `db7-new-instance` という名前の新しい DB インスタンスを作成します。スナップショットが作成されたソース DB インスタンスは、廃止された DB インスタンスクラスを使用するため、アップグレードできません。 ``` 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 ``` 出力: ``` { "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": [] } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[DB スナップショットからの復元](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_RestoreFromSnapshot.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RestoreDbInstanceFromDbSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/restore-db-instance-from-db-snapshot.html)」を参照してください。 ### `restore-db-instance-from-s3` 次のコード例は、`restore-db-instance-from-s3` を使用する方法を示しています。 **AWS CLI** **Amazon S3 のバックアップから DB インスタンスを復元するには** 次の `restore-db-instance-from-s3` の例では、`my-backups` S3 バケット内の既存のバックアップから `restored-test-instance` という名前の新しい DB インスタンスを作成します。 ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RestoreDbInstanceFromS3](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/restore-db-instance-from-s3.html)」を参照してください。 ### `restore-db-instance-to-point-in-time` 次のコード例は、`restore-db-instance-to-point-in-time` を使用する方法を示しています。 **AWS CLI** **例 1: DB インスタンスを特定の時点に復元するには** 次の `restore-db-instance-to-point-in-time` の例は、指定された時刻に `test-instance` を `restored-test-instance` という新しい DB インスタンスに復元します。 ``` 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 ``` 出力: ``` { "DBInstance": { "AllocatedStorage": 20, "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:restored-test-instance", "DBInstanceStatus": "creating", "DBInstanceIdentifier": "restored-test-instance", ...some output omitted... } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[DB インスタンスを指定の時点の状態に復元する](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIT.html)」を参照してください。 **例 2: レプリケーションされたバックアップから指定された時刻に DB インスタンスを復元するには** 次の `restore-db-instance-to-point-in-time` の例では、Oracle DB インスタンスをレプリケートされた自動バックアップから指定された時間に復元します。 ``` 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 ``` 出力: ``` { "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": [] } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[レプリケーションされたバックアップから指定された時刻への復元](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html#AutomatedBackups.PiTR)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RestoreDbInstanceToPointInTime](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/restore-db-instance-to-point-in-time.html)」を参照してください。 ### `start-activity-stream` 次のコード例は、`start-activity-stream` を使用する方法を示しています。 **AWS CLI** **データベースアクティビティストリーミングをスタートするには** 次の `start-activity-stream` の例では、my-pg-cluster という名前の Aurora クラスターをモニタリングするための非同期アクティビティストリームを開始します。 ``` 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 ``` 出力: ``` { "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 } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[データベースアクティビティストリームの開始](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/DBActivityStreams.html#DBActivityStreams.Enabling)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartActivityStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/start-activity-stream.html)」を参照してください。 ### `start-db-cluster` 次のコード例は、`start-db-cluster` を使用する方法を示しています。 **AWS CLI** **DB クラスターを開始するには** 次の `start-db-cluster` の例では、DB クラスターとその DB インスタンスを起動します。 ``` aws rds start-db-cluster \ --db-cluster-identifier mydbcluster ``` 出力: ``` { "DBCluster": { "AllocatedStorage": 1, "AvailabilityZones": [ "us-east-1a", "us-east-1e", "us-east-1b" ], "BackupRetentionPeriod": 1, "DatabaseName": "mydb", "DBClusterIdentifier": "mydbcluster", ...some output truncated... } } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[Amazon Aurora DB クラスターの停止と開始](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-cluster-stop-start.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/start-db-cluster.html)」を参照してください。 ### `start-db-instance-automated-backups-replication` 次のコード例は、`start-db-instance-automated-backups-replication` を使用する方法を示しています。 **AWS CLI** **クロスリージョン自動バックアップを有効にするには** 次の `start-db-instance-automated-backups-replication` の例では、米国東部 (バージニア北部) リージョン の DB インスタンスから 米国西部 (オレゴン) リージョン への自動バックアップをレプリケーションします。バックアップ保持期間は 14 日間です。 ``` 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 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[クロスリージョン自動バックアップの有効化](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html#AutomatedBackups.Replicating.Enable)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartDbInstanceAutomatedBackupsReplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/start-db-instance-automated-backups-replication.html)」を参照してください。 ### `start-db-instance` 次のコード例は、`start-db-instance` を使用する方法を示しています。 **AWS CLI** **DB インスタンスを開始するには** 次の `start-db-instance` の例では、指定された DB インスタンスを起動します。 ``` aws rds start-db-instance \ --db-instance-identifier test-instance ``` 出力: ``` { "DBInstance": { "DBInstanceStatus": "starting", ...some output truncated... } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/start-db-instance.html)」を参照してください。 ### `start-export-task` 次のコード例は、`start-export-task` を使用する方法を示しています。 **AWS CLI** **Amazon S3 にスナップショットをエクスポートするには** 次の `start-export-task` の例では、`db5-snapshot-test` という名前の DB スナップショットを `amzn-s3-demo-bucket` という名前の Amazon S3 バケットにエクスポートします。 ``` 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 ``` 出力: ``` { "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 } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[Amazon S3 バケットへのスナップショットのエクスポート](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ExportSnapshot.html#USER_ExportSnapshot.Exporting)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StartExportTask](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/start-export-task.html)」を参照してください。 ### `stop-activity-stream` 次のコード例は、`stop-activity-stream` を使用する方法を示しています。 **AWS CLI** **データベースアクティビティストリーミングを停止するには** 次の `stop-activity-stream` の例では、my-pg-cluster という名前の Aurora クラスター内のアクティビティストリームを停止します。 ``` aws rds stop-activity-stream \ --region us-east-1 \ --resource-arn arn:aws:rds:us-east-1:1234567890123:cluster:my-pg-cluster \ --apply-immediately ``` 出力: ``` { "KmsKeyId": "arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1", "KinesisStreamName": "aws-rds-das-cluster-0ABCDEFGHI1JKLM2NOPQ3R4S", "Status": "stopping" } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[アクティビティストリームの停止](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/DBActivityStreams.html#DBActivityStreams.Disabling)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopActivityStream](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/stop-activity-stream.html)」を参照してください。 ### `stop-db-cluster` 次のコード例は、`stop-db-cluster` を使用する方法を示しています。 **AWS CLI** **DB クラスターを停止するには** 次の `stop-db-cluster` 例では、DB クラスターとその DB インスタンスを停止します。 ``` aws rds stop-db-cluster \ --db-cluster-identifier mydbcluster ``` 出力: ``` { "DBCluster": { "AllocatedStorage": 1, "AvailabilityZones": [ "us-east-1a", "us-east-1e", "us-east-1b" ], "BackupRetentionPeriod": 1, "DatabaseName": "mydb", "DBClusterIdentifier": "mydbcluster", ...some output truncated... } } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[Amazon Aurora DB クラスターの停止と開始](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-cluster-stop-start.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopDbCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/stop-db-cluster.html)」を参照してください。 ### `stop-db-instance-automated-backups-replication` 次のコード例は、`stop-db-instance-automated-backups-replication` を使用する方法を示しています。 **AWS CLI** **自動バックアップのレプリケーションを停止するには** 次の `stop-db-instance-automated-backups-replication` は、米国西部 (オレゴン) リージョンへの自動バックアップのレプリケーションを終了します。レプリケーションされたバックアップは、設定されたバックアップ保持期間に従って保持されます。 ``` 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" ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[自動バックアップレプリケーションの停止](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html#AutomatedBackups.StopReplicating)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopDbInstanceAutomatedBackupsReplication](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/stop-db-instance-automated-backups-replication.html)」を参照してください。 ### `stop-db-instance` 次のコード例は、`stop-db-instance` を使用する方法を示しています。 **AWS CLI** **DB インスタンスを停止するには** 次の `stop-db-instance` の例では、指定された DB インスタンスを停止します。 ``` aws rds stop-db-instance \ --db-instance-identifier test-instance ``` 出力: ``` { "DBInstance": { "DBInstanceStatus": "stopping", ...some output truncated... } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[StopDbInstance](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/stop-db-instance.html)」を参照してください。 ### `switchover-blue-green-deployment` 次のコード例は、`switchover-blue-green-deployment` を使用する方法を示しています。 **AWS CLI** **例 1: RDS DB インスタンスのブルー/グリーンデプロイを切り替えるには** 次の `switchover-blue-green-deployment` の例では、指定されたグリーン環境を新しい本番環境として昇格させます。 ``` aws rds switchover-blue-green-deployment \ --blue-green-deployment-identifier bgd-wi89nwzglccsfake \ --switchover-timeout 300 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon RDS ユーザーガイド*」の「[ブルー/グリーンデプロイの切り替え](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments-switching.html)」を参照してください。 **例 2: Aurora MySQL DB クラスターのブルー/グリーンデプロイを昇格させるには** 次の `switchover-blue-green-deployment` の例では、指定されたグリーン環境を新しい本番環境として昇格させます。 ``` aws rds switchover-blue-green-deployment \ --blue-green-deployment-identifier bgd-wi89nwzglccsfake \ --switchover-timeout 300 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Aurora ユーザーガイド*」の「[ブルー/グリーンデプロイの切り替え](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments-switching.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[SwitchoverBlueGreenDeployment](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/switchover-blue-green-deployment.html)」を参照してください。 # AWS CLI を使用した Amazon RDS Data Service の例 次のコード例は、Amazon RDS データサービス で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `batch-execute-statement` 次のコード例は、`batch-execute-statement` を使用する方法を示しています。 **AWS CLI** **バッチ SQL ステートメントを実行するには** 次の `batch-execute-statement` の例では、パラメータセットを使用してデータの配列に対してバッチ SQL ステートメントを実行します。 ``` 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\"}}]]" ``` このコマンドでは何も出力されません。 詳細については、「Amazon RDS ユーザーガイド」の「[Aurora Serverless v1 の Data API の使用](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchExecuteStatement](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds-data/batch-execute-statement.html)」を参照してください。 ### `begin-transaction` 次のコード例は、`begin-transaction` を使用する方法を示しています。 **AWS CLI** **SQL トランザクションを開始するには** 次の `begin-transaction` の例では、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" ``` 出力: ``` { "transactionId": "ABC1234567890xyz" } ``` 詳細については、「Amazon RDS ユーザーガイド」の「[Aurora Serverless v1 の Data API の使用](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BeginTransaction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds-data/begin-transaction.html)」を参照してください。 ### `commit-transaction` 次のコード例は、`commit-transaction` を使用する方法を示しています。 **AWS CLI** **SQL トランザクションをコミットするには** 次の `commit-transaction` の例では、指定された SQL トランザクションを終了し、そのトランザクションの一部として行った変更をコミットします。 ``` 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" ``` 出力: ``` { "transactionStatus": "Transaction Committed" } ``` 詳細については、「Amazon RDS ユーザーガイド」の「[Aurora Serverless v1 の Data API の使用](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CommitTransaction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds-data/commit-transaction.html)」を参照してください。 ### `execute-statement` 次のコード例は、`execute-statement` を使用する方法を示しています。 **AWS CLI** **例 1: トランザクションの一部である SQL ステートメントを実行するには** 次の `execute-statement` の例は、トランザクションの一部である SQL ステートメントを実行します。 ``` 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" ``` 出力: ``` { "numberOfRecordsUpdated": 1 } ``` **例 2: パラメータを使用して SQL ステートメントを実行するには** 以下の `execute-statement` の例は、パラメータを使用して SQL ステートメントを実行します。 ``` 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\"}}]" ``` 出力: ``` { "numberOfRecordsUpdated": 1 } ``` 詳細については、「Amazon RDS ユーザーガイド」の「[Aurora Serverless v1 の Data API の使用](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ExecuteStatement](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds-data/execute-statement.html)」を参照してください。 ### `rollback-transaction` 次のコード例は、`rollback-transaction` を使用する方法を示しています。 **AWS CLI** **SQL トランザクションをロールバックするには** 次の `rollback-transaction` の例では、指定された SQL トランザクションをロールバックします。 ``` 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" ``` 出力: ``` { "transactionStatus": "Rollback Complete" } ``` 詳細については、「Amazon RDS ユーザーガイド」の「[Aurora Serverless v1 の Data API の使用](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html)」を参照してください。** + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[RollbackTransaction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds-data/rollback-transaction.html)」を参照してください。 # AWS CLI を使用した Amazon RDS Performance Insights の例 次のコード例は、Amazon RDS Performance Insights で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `create-performance-analysis-report` 次のコード例は、`create-performance-analysis-report` を使用する方法を示しています。 **AWS CLI** **パフォーマンス分析レポートを表示するには** 次の `create-performance-analysis-report` の例では、データベースの `db-abcdefg123456789` に対して、開始時間 `1682969503` と終了時間 `1682979503` を使用してパフォーマンス分析レポートを作成します。 ``` aws pi create-performance-analysis-report \ --service-type RDS \ --identifier db-abcdefg123456789 \ --start-time 1682969503 \ --end-time 1682979503 ``` 出力: ``` { "AnalysisReportId": "report-0234d3ed98e28fb17" } ``` パフォーマンス分析レポートの作成の詳細については、「*Amazon RDS ユーザーガイド*」の「[Performance Insights でのパフォーマンス分析レポートの作成](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.CreatingPerfAnlysisReport.html)」および「*Amazon Aurora ユーザーガイド*」の「[Performance Insights でのパフォーマンス分析レポートの作成](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.UsingDashboard.CreatingPerfAnlysisReport.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreatePerformanceAnalysisReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/create-performance-analysis-report.html)」を参照してください。 ### `delete-performance-analysis-report` 次のコード例は、`delete-performance-analysis-report` を使用する方法を示しています。 **AWS CLI** **パフォーマンス分析レポートを削除するには** 次の `delete-performance-analysis-report` 例では、レポート ID が `report-0d99cc91c4422ee61` であるパフォーマンス分析レポートを削除します。 ``` aws pi delete-performance-analysis-report \ --service-type RDS \ --identifier db-abcdefg123456789 \ --analysis-report-id report-0d99cc91c4422ee61 ``` このコマンドでは何も出力されません。 パフォーマンス分析レポートの削除の詳細については、「*Amazon RDS ユーザーガイド*」の「[Performance Insights のパフォーマンス分析レポートの削除](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.DeletePerfAnalysisReport.html)」および「*Amazon Aurora ユーザーガイド*」の「[Performance Insights のパフォーマンス分析レポートの削除](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.UsingDashboard.DeletePerfAnalysisReport.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeletePerformanceAnalysisReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/delete-performance-analysis-report.html)」を参照してください。 ### `describe-dimension-keys` 次のコード例は、`describe-dimension-keys` を使用する方法を示しています。 **AWS CLI** **例 1: ディメンションキーについて説明するには** この例では、すべての待機イベントの名前をリクエストします。データは、イベント名と、指定された期間におけるそれらのイベントの集計値によって要約されます。 コマンド: ``` 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"}' ``` 出力: ``` { "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 } ] } ``` **例 2: DB 負荷に最も寄与するステートメントの SQL ID を検索するには** 次の `describe-dimension-keys` は、DB 負荷に最も寄与した 10 のステートメントの SQL ステートメントと SQL ID をリクエストします。 ``` 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}' ``` 出力: ``` { "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] } ] } ] } ``` Performance Insights のディメンションの詳細については、「*Amazon RDS ユーザーガイド*」の「[データベース負荷](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.Overview.ActiveSessions.html)」および「*Amazon Aurora ユーザーガイド*」の「[データベース負荷](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.Overview.ActiveSessions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDimensionKeys](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/describe-dimension-keys.html)」を参照してください。 ### `get-dimension-key-details` 次のコード例は、`get-dimension-key-details` を使用する方法を示しています。 **AWS CLI** **DB インスタンスの指定されたディメンショングループの詳細を取得するには** 次の `get-dimension-key-details` 例では、DB インスタンス `db-10BCD2EFGHIJ3KL4M5NO6PQRS5` の SQL ステートメントの全文を取得します。`--group` は `db.sql` であり、`--group-identifier` は `db.sql.id` です。この例では、`example-sql-id` は `get-resource-metrics` または `describe-dimension-keys` オペレーションを使用して取得された SQL ID を表します。この例では、ディメンションの詳細を使用できます。したがって、Performance Insights は、SQL ステートメントを切り捨てることなく、その全文を取得します。 ``` aws pi get-dimension-key-details \ --service-type RDS \ --identifier db-10BCD2EFGHIJ3KL4M5NO6PQRS5 \ --group db.sql \ --group-identifier example-sql-id \ --requested-dimensions statement ``` 出力: ``` { "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" }, ... ] } ``` Performance Insights のディメンションの詳細については、「*Amazon RDS ユーザーガイド*」の「[データベース負荷](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.Overview.ActiveSessions.html)」および「*Amazon Aurora ユーザーガイド*」の「[データベース負荷](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.Overview.ActiveSessions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetDimensionKeyDetails](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/get-dimension-key-details.html)」を参照してください。 ### `get-performance-analysis-report` 次のコード例は、`get-performance-analysis-report` を使用する方法を示しています。 **AWS CLI** **パフォーマンス分析レポートを表示するには** 次の `get-performance-analysis-report` 例では、レポート ID `report-0d99cc91c4422ee61` を持つデータベース `db-abcdefg123456789` のパフォーマンス分析レポートを取得します。レスポンスには、レポートのステータス、ID、時間の詳細、およびインサイトが表示されます。 ``` aws pi get-performance-analysis-report \ --service-type RDS \ --identifier db-abcdefg123456789 \ --analysis-report-id report-0d99cc91c4422ee61 ``` 出力: ``` { "AnalysisReport": { "Status": "Succeeded", "ServiceType": "RDS", "Identifier": "db-abcdefg123456789", "StartTime": 1680583486.584, "AnalysisReportId": "report-0d99cc91c4422ee61", "EndTime": 1680587086.584, "CreateTime": 1680587087.139, "Insights": [ ... (Condensed for space) ] } } ``` パフォーマンス分析レポートの詳細については、「*Amazon RDS ユーザーガイド*」の「[一定期間のデータベースパフォーマンスの分析](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.AnalyzePerformanceTimePeriod.html)」および*「Amazon Aurora ユーザーガイド*」の「[一定期間のデータベースパフォーマンスの分析](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.UsingDashboard.AnalyzePerformanceTimePeriod.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetPerformanceAnalysisReport](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/get-performance-analysis-report.html)」を参照してください。 ### `get-resource-metadata` 次のコード例は、`get-resource-metadata` を使用する方法を示しています。 **AWS CLI** **データベースのリソースメタデータを取得するには** 次の `get-resource-metadata` 例では、データベース `db-abcdefg123456789` のリソースメタデータを取得します。レスポンスは、SQL ダイジェスト統計が有効になっていることを示しています。 ``` aws pi get-resource-metadata \ --service-type RDS \ --identifier db-abcdefg123456789 ``` 出力: ``` { "Identifier": "db-abcdefg123456789", "Features":{ "SQL_DIGEST_STATISTICS":{ "Status": "ENABLED" } } } ``` Performance Insights の SQL 統計の詳細については、「*Amazon RDS ユーザーガイド*」の「[Performance Insights の SQL 統計](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/sql-statistics.html)」および「*Amazon Aurora ユーザーガイド*」の「[Performance Insights の SQL 統計](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/sql-statistics.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetResourceMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/get-resource-metadata.html)」を参照してください。 ### `get-resource-metrics` 次のコード例は、`get-resource-metrics` を使用する方法を示しています。 **AWS CLI** **リソースメトリクスを取得するには** この例では、*db.wait\$1event* ディメンショングループと、そのグループ内の *db.wait\$1event.name* ディメンションのデータポイントをリクエストします。レスポンスでは、関連するデータポイントは、リクエストされたディメンション (*db.wait\$1event.name*) によってグループ化されます。 コマンド: ``` 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 ``` `--metric-queries` の引数は、JSON ファイル `metric-queries.json` に保存されます。ファイルの内容は次のとおりです。 ``` [ { "Metric": "db.load.avg", "GroupBy": { "Group":"db.wait_event" } } ] ``` 出力: ``` { "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...> ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[GetResourceMetrics](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/get-resource-metrics.html)」を参照してください。 ### `list-available-resource-dimensions` 次のコード例は、`list-available-resource-dimensions` を使用する方法を示しています。 **AWS CLI** **DB インスタンスでメトリクスタイプに対してクエリできるディメンションを一覧表示するには** 次の `list-available-resource-dimensions` 例では、データベース `db-abcdefg123456789` に対してクエリできる `db.load` メトリクスを一覧表示します。 ``` aws pi list-available-resource-dimensions \ --service-type RDS \ --identifier db-abcdefg123456789 \ --metrics db.load ``` 出力: ``` { "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" } ] }, ... ] } ] } ``` Performance Insights のディメンションの詳細については、「*Amazon RDS ユーザーガイド*」の「[データベース負荷](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.Overview.ActiveSessions.html)」および「*Amazon Aurora ユーザーガイド*」の「[データベース負荷](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.Overview.ActiveSessions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAvailableResourceDimensions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/list-available-resource-dimensions.html)」を参照してください。 ### `list-available-resource-metrics` 次のコード例は、`list-available-resource-metrics` を使用する方法を示しています。 **AWS CLI** **DB インスタンスのメトリクスタイプに対してクエリできるメトリクスを一覧表示するには** 次の `list-available-resource-metrics` 例では、データベース `db-abcdefg123456789` に対してクエリできる `db.load` メトリクスを一覧表示します。 ``` aws pi list-available-resource-metrics \ --service-type RDS \ --identifier db-abcdefg123456789 \ --metric-types "os" "db" ``` 出力: ``` { "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" }, ...... ] } ``` Performance Insights のメトリクスの詳細については、「*Amazon RDS ユーザーガイド*」の「[データベース負荷](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.Overview.ActiveSessions.html)」および「*Amazon Aurora ユーザーガイド*」の「[データベース負荷](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.Overview.ActiveSessions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListAvailableResourceMetrics](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/list-available-resource-metrics.html)」を参照してください。 ### `list-performance-analysis-reports` 次のコード例は、`list-performance-analysis-reports` を使用する方法を示しています。 **AWS CLI** **データベースのパフォーマンス分析レポートを一覧表示するには** 次の `list-performance-analysis-reports` 例は、データベース `db-abcdefg123456789` のパフォーマンス分析レポートを一覧表示します。レスポンスには、すべてのレポートがレポートの ID、ステータス、および時間の詳細とともに一覧表示されます。 ``` aws pi list-performance-analysis-reports \ --service-type RDS \ --identifier db-abcdefg123456789 ``` 出力: ``` { "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" } ] } ``` パフォーマンス分析レポートの詳細については、「*Amazon RDS ユーザーガイド*」の「[一定期間のデータベースパフォーマンスの分析](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.AnalyzePerformanceTimePeriod.html)」および*「Amazon Aurora ユーザーガイド*」の「[一定期間のデータベースパフォーマンスの分析](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.UsingDashboard.AnalyzePerformanceTimePeriod.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListPerformanceAnalysisReports](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/list-performance-analysis-reports.html)」を参照してください。 ### `list-tags-for-resource` 次のコード例は、`list-tags-for-resource` を使用する方法を示しています。 **AWS CLI** **パフォーマンス分析レポートのタグを一覧表示するには** 次の `list-tags-for-resource` 例では、レポート ID `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 ``` 出力: ``` { "Tags": [ { "Value": "test-tag", "Key": "name" } ] } ``` パフォーマンス分析レポートのタグ付けの詳細については、「*Amazon RDS ユーザーガイド*」の「[Performance Insights のパフォーマンス分析レポートにタグを追加する](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.ManagePerfAnalysisReportTags.html)」および「*Amazon Aurora ユーザーガイド*」の「[Performance Insights のパフォーマンス分析レポートにタグを追加する](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.UsingDashboard.ManagePerfAnalysisReportTags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/list-tags-for-resource.html)」を参照してください。 ### `tag-resource` 次のコード例は、`tag-resource` を使用する方法を示しています。 **AWS CLI** **パフォーマンス分析レポートにタグを追加するには** 次の `tag-resource` 例では、タグ値 `test-tag` を持つタグキー `name` を、レポート ID `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 ``` このコマンドでは何も出力されません。 パフォーマンス分析レポートのタグ付けの詳細については、「*Amazon RDS ユーザーガイド*」の「[Performance Insights のパフォーマンス分析レポートにタグを追加する](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.ManagePerfAnalysisReportTags.html)」および「*Amazon Aurora ユーザーガイド*」の「[Performance Insights のパフォーマンス分析レポートにタグを追加する](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.UsingDashboard.ManagePerfAnalysisReportTags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/tag-resource.html)」を参照してください。 ### `untag-resource` 次のコード例は、`untag-resource` を使用する方法を示しています。 **AWS CLI** **パフォーマンス分析レポートにタグを削除するには** 次の `untag-resource` 例では、レポート ID `report-0d99cc91c4422ee61` を持つパフォーマンス分析レポートのタグ `name` を削除します。 ``` 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 ``` このコマンドでは何も出力されません。 パフォーマンス分析レポートのタグ付けの詳細については、「*Amazon RDS ユーザーガイド*」の「[Performance Insights のパフォーマンス分析レポートにタグを追加する](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.UsingDashboard.ManagePerfAnalysisReportTags.html)」および「*Amazon Aurora ユーザーガイド*」の「[Performance Insights のパフォーマンス分析レポートにタグを追加する](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.UsingDashboard.ManagePerfAnalysisReportTags.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/pi/untag-resource.html)」を参照してください。 # Amazon Redshift examples using AWS CLI 次のコード例は、Amazon Redshift で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。 *アクション*はより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。 各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。 **Topics** + [アクション](#actions) ## アクション ### `accept-reserved-node-exchange` 次のコード例は、`accept-reserved-node-exchange` を使用する方法を示しています。 **AWS CLI** **リザーブドノード交換を受け入れるには** 次の `accept-reserved-node-exchange` の例では、DC1 リザーブドノードと 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 ``` 出力: ``` { "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" } } ``` 詳細については、「*Amazon Redshift クラスター管理ガイド*」の「[AWS CLI を使用したリザーブドノードのアップグレード](https://docs.aws.amazon.com/redshift/latest/mgmt/purchase-reserved-node-offering-console.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AcceptReservedNodeExchange](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/accept-reserved-node-exchange.html)」を参照してください。 ### `authorize-cluster-security-group-ingress` 次のコード例は、`authorize-cluster-security-group-ingress` を使用する方法を示しています。 **AWS CLI** EC2 セキュリティ グループへのアクセスを承認する この例では、名前付き Amazon EC2 セキュリティグループへのアクセスを許可します。コマンド: ``` aws redshift authorize-cluster-security-group-ingress --cluster-security-group-name mysecuritygroup --ec2-security-group-name myec2securitygroup --ec2-security-group-owner-id 123445677890 ``` CIDR 範囲へのアクセスの許可 この例では、CIDR 範囲へのアクセスを許可します。コマンド： ``` aws redshift authorize-cluster-security-group-ingress --cluster-security-group-name mysecuritygroup --cidrip 192.168.100.100/32 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AuthorizeClusterSecurityGroupIngress](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/authorize-cluster-security-group-ingress.html)」を参照してください。 ### `authorize-snapshot-access` 次のコード例は、`authorize-snapshot-access` を使用する方法を示しています。 **AWS CLI** スナップショットを復元する AWS アカウントを承認する SnapshotThis 例では、スナップショット `my-snapshot-id` を復元する AWS アカウント `444455556666` を許可します。デフォルトの出力は JSON 形式です。コマンドは次のとおりです。 ``` aws redshift authorize-snapshot-access --snapshot-id my-snapshot-id --account-with-restore-access 444455556666 ``` 結果: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[AuthorizeSnapshotAccess](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/authorize-snapshot-access.html)」を参照してください。 ### `batch-delete-cluster-snapshots` 次のコード例は、`batch-delete-cluster-snapshots` を使用する方法を示しています。 **AWS CLI** **一連のクラスタースナップショットを削除するには** 次の `batch-delete-cluster-snapshots` の例では、手動クラスタースナップショットのセットを削除します。 ``` aws redshift batch-delete-cluster-snapshots \ --identifiers SnapshotIdentifier=mycluster-2019-11-06-14-12 SnapshotIdentifier=mycluster-2019-11-06-14-20 ``` 出力: ``` { "Resources": [ "mycluster-2019-11-06-14-12", "mycluster-2019-11-06-14-20" ] } ``` 詳細については、「*Amazon Redshift クラスター管理ガイド*」の「[Amazon Redshift スナップショット](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchDeleteClusterSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/batch-delete-cluster-snapshots.html)」を参照してください。 ### `batch-modify-cluster-snapshots` 次のコード例は、`batch-modify-cluster-snapshots` を使用する方法を示しています。 **AWS CLI** **一連のクラスタースナップショットを変更するには** 次の `batch-modify-cluster-snapshots` の例では、一連のクラスタースナップショットの設定を変更します。 ``` 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 ``` 出力: ``` { "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 } } ``` 詳細については、「*Amazon Redshift クラスター管理ガイド*」の「[Amazon Redshift スナップショット](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[BatchModifyClusterSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/batch-modify-cluster-snapshots.html)」を参照してください。 ### `cancel-resize` 次のコード例は、`cancel-resize` を使用する方法を示しています。 **AWS CLI** **クラスターのサイズ変更をキャンセルするには** 次の `cancel-resize` の例では、クラスターの従来のサイズ変更オペレーションをキャンセルします。 ``` aws redshift cancel-resize \ --cluster-identifier mycluster ``` 出力: ``` { "TargetNodeType": "dc2.large", "TargetNumberOfNodes": 2, "TargetClusterType": "multi-node", "Status": "CANCELLING", "ResizeType": "ClassicResize", "TargetEncryptionType": "NONE" } ``` 詳細については、「*Amazon Redshift クラスター管理ガイド*」の「[Amazon Redshift クラスターのサイズ調整](https://docs.aws.amazon.com/redshift/latest/mgmt/rs-resize-tutorial.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「CancelResize」を参照してください。[https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/cancel-resize.html](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/cancel-resize.html) ### `copy-cluster-snapshot` 次のコード例は、`copy-cluster-snapshot` を使用する方法を示しています。 **AWS CLI** すべてのクラスターバージョンの記述を取得する この例は、すべてのクラスターバージョンの記述を返します。デフォルトの出力は JSON 形式です。コマンドは次のとおりです。 ``` aws redshift copy-cluster-snapshot --source-snapshot-identifier cm:examplecluster-2013-01-22-19-27-58 --target-snapshot-identifier my-saved-snapshot-copy ``` 結果: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CopyClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/copy-cluster-snapshot.html)」を参照してください。 ### `create-cluster-parameter-group` 次のコード例は、`create-cluster-parameter-group` を使用する方法を示しています。 **AWS CLI** クラスターパラメータグループを作成する この例では、新しいクラスターパラメータグループを作成します。コマンド: ``` aws redshift create-cluster-parameter-group --parameter-group-name myclusterparametergroup --parameter-group-family redshift-1.0 --description "My first cluster parameter group" ``` 結果: ``` { "ClusterParameterGroup": { "ParameterGroupFamily": "redshift-1.0", "Description": "My first cluster parameter group", "ParameterGroupName": "myclusterparametergroup" }, "ResponseMetadata": { "RequestId": "739448f0-64cc-11e2-8f7d-3b939af52818" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-cluster-parameter-group.html)」を参照してください。 ### `create-cluster-security-group` 次のコード例は、`create-cluster-security-group` を使用する方法を示しています。 **AWS CLI** クラスターセキュリティグループの作成 この例では、新しいクラスターセキュリティグループを作成します。デフォルトの出力は JSON 形式です。コマンドは次のとおりです。 ``` aws redshift create-cluster-security-group --cluster-security-group-name mysecuritygroup --description "This is my cluster security group" ``` 結果: ``` { "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" } } } ``` `--output text` オプションコマンドを使用して、同じ情報をテキスト形式で取得することもできます。 `--output text` オプションコマンド: オプションコマンド: ``` aws redshift create-cluster-security-group --cluster-security-group-name mysecuritygroup --description "This is my cluster security group" --output text ``` 結果: ``` This is my cluster security group 300454760768 mysecuritygroup a0c0bfab-343a-11e2-95d2-c3dc9fe8ab57 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateClusterSecurityGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-cluster-security-group.html)」を参照してください。 ### `create-cluster-snapshot` 次のコード例は、`create-cluster-snapshot` を使用する方法を示しています。 **AWS CLI** クラスタースナップショットを作成する この例では、新しいクラスターを作成します。デフォルトの出力は JSON 形式です。コマンドは次のとおりです。 ``` aws redshift create-cluster-snapshot --cluster-identifier mycluster --snapshot-identifier my-snapshot-id ``` 結果: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-cluster-snapshot.html)」を参照してください。 ### `create-cluster-subnet-group` 次のコード例は、`create-cluster-subnet-group` を使用する方法を示しています。 **AWS CLI** クラスターサブネットグループを作成する この例では、新しいクラスターサブネットグループを作成します。コマンド: ``` aws redshift create-cluster-subnet-group --cluster-subnet-group-name mysubnetgroup --description "My subnet group" --subnet-ids subnet-763fdd1c ``` 結果: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateClusterSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-cluster-subnet-group.html)」を参照してください。 ### `create-cluster` 次のコード例は、`create-cluster` を使用する方法を示しています。 **AWS CLI** この例では、最小限のパラメータセットでクラスターを作成します。デフォルトの出力は JSON 形式です。コマンドは次のとおりです。 ``` aws redshift create-cluster --node-type dw.hs1.xlarge --number-of-nodes 2 --master-username adminuser --master-user-password TopSecret1 --cluster-identifier mycluster ``` 結果: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-cluster.html)」を参照してください。 ### `create-event-subscription` 次のコード例は、`create-event-subscription` を使用する方法を示しています。 **AWS CLI** **イベントの通知サブスクリプションを作成するには** 次の `create-event-subscription` の例は、イベント通知サブスクリプションを作成します。 ``` 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 ``` 出力: ``` { "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": [] } } ``` 詳細については、「*Amazon Redshift クラスター管理ガイド*」の「[Amazon Redshift イベント通知のサブスクライブ](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-event-notifications.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateEventSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-event-subscription.html)」を参照してください。 ### `create-hsm-client-certificate` 次のコード例は、`create-hsm-client-certificate` を使用する方法を示しています。 **AWS CLI** **HSM クライアント証明書を作成するには** 次の `create-hsm-client-certificate` の例では、クラスターが HSM への接続に使用できる HSM クライアント証明書を生成します。 ``` aws redshift create-hsm-client-certificate \ --hsm-client-certificate-identifier myhsmclientcert ``` 出力: ``` { "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": [] } } ``` 詳細については、「*Amazon Redshift クラスター管理ガイド*」の「[Amazon Redshift API アクセス許可のリファレンス](https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-policy-resources.resource-permissions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateHsmClientCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-hsm-client-certificate.html)」を参照してください。 ### `create-hsm-configuration` 次のコード例は、`create-hsm-configuration` を使用する方法を示しています。 **AWS CLI** **HSM 設定を作成するには** 次の `create-hsm-configuration` の例は、クラスターがハードウェアセキュリティモジュール (HSM) においてデータベース暗号化キーを保存または使用する際に必要とする情報を含んだ 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 ``` 出力: ``` { "HsmConfiguration": { "HsmConfigurationIdentifier": "myhsmconnection", "Description": "My HSM connection", "HsmIpAddress": "192.0.2.09", "HsmPartitionName": "myhsmpartition", "Tags": [] } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateHsmConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-hsm-configuration.html)」を参照してください。 ### `create-snapshot-copy-grant` 次のコード例は、`create-snapshot-copy-grant` を使用する方法を示しています。 **AWS CLI** **スナップショットコピーエージェントを作成するには** 次の `create-snapshot-copy-grant` の例では、スナップショットコピー許可を作成し、コピー先の AWS リージョンでコピーされたスナップショットを暗号化します。 ``` aws redshift create-snapshot-copy-grant \ --snapshot-copy-grant-name mysnapshotcopygrantname ``` 出力: ``` { "SnapshotCopyGrant": { "SnapshotCopyGrantName": "mysnapshotcopygrantname", "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/bPxRfih3yCo8nvbEXAMPLEKEY", "Tags": [] } } ``` 詳細については、「*Amazon Redshift クラスター管理ガイド*」の「[Amazon Redshift データベースの暗号化](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateSnapshotCopyGrant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-snapshot-copy-grant.html)」を参照してください。 ### `create-snapshot-schedule` 次のコード例は、`create-snapshot-schedule` を使用する方法を示しています。 **AWS CLI** **スナップショットスケジュールを作成するには** 次の `create-snapshot-schedule` の例では、指定された説明と 12 時間ごとのレートでスナップショットスケジュールを作成します。 ``` aws redshift create-snapshot-schedule \ --schedule-definitions "rate(12 hours)" \ --schedule-identifier mysnapshotschedule \ --schedule-description "My schedule description" ``` 出力: ``` { "ScheduleDefinitions": [ "rate(12 hours)" ], "ScheduleIdentifier": "mysnapshotschedule", "ScheduleDescription": "My schedule description", "Tags": [] } ``` 詳細については、「*Amazon Redshift クラスター管理ガイド*」の「[自動スナップショットのスケジュール](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html#automated-snapshot-schedules)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateSnapshotSchedule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-snapshot-schedule.html)」を参照してください。 ### `create-tags` 次のコード例は、`create-tags` を使用する方法を示しています。 **AWS CLI** **クラスターのタグを作成するには** 次の `create-tags` の例では、指定されたタグキーと値のペアを指定されたクラスターに追加します。 ``` aws redshift create-tags \ --resource-name arn:aws:redshift:us-west-2:123456789012:cluster:mycluster \ --tags "Key"="mytags","Value"="tag1" ``` このコマンドでは、出力が生成されません。 詳細については、「*Amazon Redshift クラスター管理ガイド*」の「[Amazon Redshift のリソースへのタグ付け](https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[CreateTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/create-tags.html)」を参照してください。 ### `delete-cluster-parameter-group` 次のコード例は、`delete-cluster-parameter-group` を使用する方法を示しています。 **AWS CLI** クラスターパラメータグループを削除する この例では、クラスターパラメータグループを削除します。コマンド: ``` aws redshift delete-cluster-parameter-group --parameter-group-name myclusterparametergroup ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteClusterParameterGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-cluster-parameter-group.html)」を参照してください。 ### `delete-cluster-security-group` 次のコード例は、`delete-cluster-security-group` を使用する方法を示しています。 **AWS CLI** クラスターセキュリティグループを削除する この例では、クラスターセキュリティグループを削除します。コマンド: ``` aws redshift delete-cluster-security-group --cluster-security-group-name mysecuritygroup ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteClusterSecurityGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-cluster-security-group.html)」を参照してください。 ### `delete-cluster-snapshot` 次のコード例は、`delete-cluster-snapshot` を使用する方法を示しています。 **AWS CLI** クラスタースナップショットを削除する この例では、クラスタースナップショットを削除します。コマンド: ``` aws redshift delete-cluster-snapshot --snapshot-identifier my-snapshot-id ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteClusterSnapshot](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-cluster-snapshot.html)」を参照してください。 ### `delete-cluster-subnet-group` 次のコード例は、`delete-cluster-subnet-group` を使用する方法を示しています。 **AWS CLI** クラスターサブネットグループを削除する この例では、クラスターサブネットグループを削除します。コマンド: ``` aws redshift delete-cluster-subnet-group --cluster-subnet-group-name mysubnetgroup ``` 結果: ``` { "ResponseMetadata": { "RequestId": "253fbffd-6993-11e2-bc3a-47431073908a" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteClusterSubnetGroup](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-cluster-subnet-group.html)」を参照してください。 ### `delete-cluster` 次のコード例は、`delete-cluster` を使用する方法を示しています。 **AWS CLI** この例では、クラスターを削除してデータを強制的に削除し、最終的なクラスターのスナップショットは作成されません。コマンドは次のとおりです。 ``` aws redshift delete-cluster --cluster-identifier mycluster --skip-final-cluster-snapshot ``` この例では、クラスターは削除しますが、最終クラスターのスナップショットを指定しています。コマンドは次のとおりです。 ``` aws redshift delete-cluster --cluster-identifier mycluster --final-cluster-snapshot-identifier myfinalsnapshot ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteCluster](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-cluster.html)」を参照してください。 ### `delete-event-subscription` 次のコード例は、`delete-event-subscription` を使用する方法を示しています。 **AWS CLI** **イベントサブスクリプションを削除するには** 次の `delete-event-subscription` の例では、指定したイベント通知サブスクリプションを削除します。 ``` aws redshift delete-event-subscription \ --subscription-name mysubscription ``` このコマンドでは、出力が生成されません。 詳細については、「*Amazon Redshift クラスター管理ガイド*」の「[Amazon Redshift イベント通知のサブスクライブ](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-event-notifications.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteEventSubscription](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-event-subscription.html)」を参照してください。 ### `delete-hsm-client-certificate` 次のコード例は、`delete-hsm-client-certificate` を使用する方法を示しています。 **AWS CLI** **HSM** クライアント証明書を削除するには 次の `delete-hsm-client-certificate` の例では、HSM クライアント証明書を削除します。 ``` aws redshift delete-hsm-client-certificate \ --hsm-client-certificate-identifier myhsmclientcert ``` このコマンドでは、出力が生成されません。 詳細については、「*Amazon Redshift クラスター管理ガイド*」の「[Amazon Redshift API アクセス許可のリファレンス](https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-policy-resources.resource-permissions.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteHsmClientCertificate](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-hsm-client-certificate.html)」を参照してください。 ### `delete-hsm-configuration` 次のコード例は、`delete-hsm-configuration` を使用する方法を示しています。 **AWS CLI** **HSM 設定を削除するには** 次の `delete-hsm-configuration` の例では、現在の AWS アカウントから指定された HSM 設定を削除します。 ``` aws redshift delete-hsm-configuration / --hsm-configuration-identifier myhsmconnection ``` このコマンドでは、出力が生成されません。 + API の詳細については、「**AWS CLI コマンドリファレンス」の「[DeleteHsmConfiguration](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-hsm-configuration.html)」を参照してください。 ### `delete-scheduled-action` 次のコード例は、`delete-scheduled-action` を使用する方法を示しています。 **AWS CLI** **スケジュールされたアクションを削除するには** 以下の `delete-scheduled-action` の例では、指定したアクションスケジュールを削除します。 ``` aws redshift delete-scheduled-action \ --scheduled-action-name myscheduledaction ``` このコマンドでは、出力が生成されません。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteScheduledAction](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-scheduled-action.html)」を参照してください。 ### `delete-snapshot-copy-grant` 次のコード例は、`delete-snapshot-copy-grant` を使用する方法を示しています。 **AWS CLI** **スナップショットコピー権限を削除するには** 次の `delete-snapshot-copy-grant` の例では、指定したスナップショットコピー権限を削除します。 ``` aws redshift delete-snapshot-copy-grant \ --snapshot-copy-grant-name mysnapshotcopygrantname ``` このコマンドでは、出力が生成されません。 詳細については、「*Amazon Redshift クラスター管理ガイド*」の「[Amazon Redshift データベースの暗号化](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-db-encryption.html)」を参照してください。 + API の詳細については、「**AWS CLI コマンドリファレンス」の「[DeleteSnapshotCopyGrant](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-snapshot-copy-grant.html)」を参照してください。 ### `delete-snapshot-schedule` 次のコード例は、`delete-snapshot-schedule` を使用する方法を示しています。 **AWS CLI** **スナップショットスケジュールを削除するには** 次の `delete-snapshot-schedule` の例では、指定したスナップショットスケジュールを削除します。スケジュールを削除する前に、クラスターの関連付けを解除する必要があります。 ``` aws redshift delete-snapshot-schedule \ --schedule-identifier mysnapshotschedule ``` このコマンドでは、出力が生成されません。 詳細については、「*Amazon Redshift クラスター管理ガイド*」の「[自動スナップショットのスケジュール](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html#automated-snapshot-schedules)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteSnapshotSchedule](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-snapshot-schedule.html)」を参照してください。 ### `delete-tags` 次のコード例は、`delete-tags` を使用する方法を示しています。 **AWS CLI** **クラスターからタグを削除するには** 次の `delete-tags` の例では、指定されたキー名を持つタグを指定されたクラスターから削除します。 ``` aws redshift delete-tags \ --resource-name arn:aws:redshift:us-west-2:123456789012:cluster:mycluster \ --tag-keys "clustertagkey" "clustertagvalue" ``` このコマンドでは、出力が生成されません。 詳細については、「*Amazon Redshift クラスター管理ガイド*」の「[Amazon Redshift のリソースへのタグ付け](https://docs.aws.amazon.com/redshift/latest/mgmt/amazon-redshift-tagging.html)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DeleteTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/delete-tags.html)」を参照してください。 ### `describe-account-attributes` 次のコード例は、`describe-account-attributes` を使用する方法を示しています。 **AWS CLI** **AWS アカウントの属性を記述するには** 次の `describe-account-attributes` の例では、呼び出し元の AWS アカウントにアタッチされた属性を表示します。 ``` aws redshift describe-account-attributes ``` 出力: ``` { "AccountAttributes": [ { "AttributeName": "max-defer-maintenance-duration", "AttributeValues": [ { "AttributeValue": "45" } ] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeAccountAttributes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-account-attributes.html)」を参照してください。 ### `describe-cluster-db-revisions` 次のコード例は、`describe-cluster-db-revisions` を使用する方法を示しています。 **AWS CLI** **クラスターの DB リビジョンを記述するには** 次の `describe-cluster-db-revisions` の例は、指定されたクラスターの `ClusterDbRevision` オブジェクトの配列の詳細を表示します。 ``` aws redshift describe-cluster-db-revisions \ --cluster-identifier mycluster ``` 出力: ``` { "ClusterDbRevisions": [ { "ClusterIdentifier": "mycluster", "CurrentDatabaseRevision": "11420", "DatabaseRevisionReleaseDate": "2019-11-22T16:43:49.597Z", "RevisionTargets": [] } ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeClusterDbRevisions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-cluster-db-revisions.html)」を参照してください。 ### `describe-cluster-parameter-groups` 次のコード例は、`describe-cluster-parameter-groups` を使用する方法を示しています。 **AWS CLI** すべてのクラスターパラメータグループの記述を取得する この例は、アカウントのすべてのクラスターパラメータグループの説明と列ヘッダーを返します。デフォルトの出力は JSON 形式です。コマンドは次のとおりです。 ``` aws redshift describe-cluster-parameter-groups ``` 結果: ``` { "ParameterGroups": [ { "ParameterGroupFamily": "redshift-1.0", "Description": "My first cluster parameter group", "ParameterGroupName": "myclusterparametergroup" } ], "ResponseMetadata": { "RequestId": "8ceb8f6f-64cc-11e2-bea9-49e0ce183f07" } } ``` `--output text` オプションコマンドを使用して、同じ情報をテキスト形式で取得することもできます。 `--output text` オプションコマンド: オプションコマンド: ``` aws redshift describe-cluster-parameter-groups --output text ``` 結果: ``` redshift-1.0 My first cluster parameter group myclusterparametergroup RESPONSEMETADATA 9e665a36-64cc-11e2-8f7d-3b939af52818 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeClusterParameterGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-cluster-parameter-groups.html)」を参照してください。 ### `describe-cluster-parameters` 次のコード例は、`describe-cluster-parameters` を使用する方法を示しています。 **AWS CLI** 指定されたクラスターパラメータグループのパラメータを取得する この例では、名前付きパラメータグループのパラメータを取得します。デフォルトの出力は JSON 形式です。コマンドは次のとおりです。 ``` aws redshift describe-cluster-parameters --parameter-group-name myclusterparametergroup ``` 結果: ``` { "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...) ] } ``` `--output text` オプションコマンドを使用して、同じ情報をテキスト形式で取得することもできます。 `--output text` オプションコマンド: オプションコマンド: ``` aws redshift describe-cluster-parameters --parameter-group-name myclusterparametergroup --output text ``` 結果: ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeClusterParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-cluster-parameters.html)」を参照してください。 ### `describe-cluster-security-groups` 次のコード例は、`describe-cluster-security-groups` を使用する方法を示しています。 **AWS CLI** すべてのクラスターセキュリティグループの記述を取得する この例は、アカウントのすべてのクラスターセキュリティグループの記述を返します。デフォルトの出力は JSON 形式です。コマンドは次のとおりです。 ``` aws redshift describe-cluster-security-groups ``` 結果: ``` { "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...) ] } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeClusterSecurityGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-cluster-security-groups.html)」を参照してください。 ### `describe-cluster-snapshots` 次のコード例は、`describe-cluster-snapshots` を使用する方法を示しています。 **AWS CLI** すべてのクラスタースナップショットの記述を取得する この例は、アカウントのすべてのクラスタースナップショットの記述を返します。デフォルトの出力は JSON 形式です。コマンドは次のとおりです。 ``` aws redshift describe-cluster-snapshots ``` 結果: ``` { "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...) ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeClusterSnapshots](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-cluster-snapshots.html)」を参照してください。 ### `describe-cluster-subnet-groups` 次のコード例は、`describe-cluster-subnet-groups` を使用する方法を示しています。 **AWS CLI** すべてのクラスターサブネットグループの記述を取得する この例では、すべてのクラスターサブネットグループの説明を返します。デフォルトの出力は JSON 形式です。コマンドは次のとおりです。 ``` aws redshift describe-cluster-subnet-groups ``` 結果: ``` { "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" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeClusterSubnetGroups](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-cluster-subnet-groups.html)」を参照してください。 ### `describe-cluster-tracks` 次のコード例は、`describe-cluster-tracks` を使用する方法を示しています。 **AWS CLI** **クラスタートラックを記述するには** 次の `describe-cluster-tracks` の例では、使用可能なメンテナンストラックの詳細を表示します。 ``` aws redshift describe-cluster-tracks \ --maintenance-track-name current ``` 出力: ``` { "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" } ] } ] } ] } ``` 詳細については、「*Amazon Redshift クラスター管理ガイド*」の「[クラスターメンテナンストラックの選択](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#rs-mgmt-maintenance-tracks)」を参照してください。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeClusterTracks](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-cluster-tracks.html)」を参照してください。 ### `describe-cluster-versions` 次のコード例は、`describe-cluster-versions` を使用する方法を示しています。 **AWS CLI** すべてのクラスターバージョンの記述を取得する この例は、すべてのクラスターバージョンの記述を返します。デフォルトの出力は JSON 形式です。コマンドは次のとおりです。 ``` aws redshift describe-cluster-versions ``` 結果: ``` { "ClusterVersions": [ { "ClusterVersion": "1.0", "Description": "Initial release", "ClusterParameterGroupFamily": "redshift-1.0" } ], "ResponseMetadata": { "RequestId": "16a53de3-64cc-11e2-bec0-17624ad140dd" } } ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeClusterVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-cluster-versions.html)」を参照してください。 ### `describe-clusters` 次のコード例は、`describe-clusters` を使用する方法を示しています。 **AWS CLI** この例は、アカウントのすべてのクラスターの記述を返します。デフォルトの出力は JSON 形式です。コマンドは次のとおりです。 ``` aws redshift describe-clusters ``` 結果: ``` { "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" } } ``` `--output text` オプションコマンドを使用して、同じ情報をテキスト形式で取得することもできます。 `--output text` オプションコマンド: オプションコマンド: ``` aws redshift describe-clusters --output text ``` 結果: ``` 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 ``` + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeClusters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-clusters.html)」を参照してください。 ### `describe-default-cluster-parameters` 次のコード例は、`describe-default-cluster-parameters` を使用する方法を示しています。 **AWS CLI** デフォルトクラスターパラメータの記述を取得する この例では、`redshift-1.0` ファミリーのデフォルトクラスターパラメータの説明を返します。デフォルトの出力は JSON 形式です。コマンドは次のとおりです。 ``` aws redshift describe-default-cluster-parameters --parameter-group-family redshift-1.0 ``` 結果: ``` { "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...) ] } } ``` 有効なパラメータグループファミリーのリストを表示するには、`describe-cluster-parameter-groups` コマンドを使用します。 `describe-cluster-parameter-groups` コマンド。 コマンド。 + API の詳細については、「*AWS CLI コマンドリファレンス*」の「[DescribeDefaultClusterParameters](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/redshift/describe-default-cluster-parameters.html)」を参照してください。 ### `describe-event-categories` 次のコード例は、`describe-event-categories` を使用する方法を示しています。 **AWS CLI** **クラスターのイベントカテゴリを記述するには** 次の `describe-event-categories` の例では、クラスターのイベントカテゴリの詳細を表示します。 ``` aws redshift describe-event-categories \ --source-type cluster ``` 出力: ``` { "EventCategoriesMapList": [ { "SourceType": "cluster", "Events": [ { "EventId": "REDSHIFT-EVENT-2000", "EventCategories": [ "management" ], "EventDescription": "Cluster created at