Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion awscli/examples/gamelift/stop-fleet-actions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The following ``stop-fleet-actions`` example stops the use of all scaling policies that are defined for the specified fleet. After the policies are suspended, fleet capacity remains at the same active instance count unless you adjust it manually. ::

aws gamelift start-fleet-actions \
aws gamelift stop-fleet-actions \
--fleet-id fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
--actions AUTO_SCALING

Expand Down
2 changes: 1 addition & 1 deletion awscli/examples/greengrassv2/untag-resource.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The following ``untag-resource`` example removes an owner tag from an AWS IoT Greengrass core device. ::

aws iotsitewise untag-resource \
aws greengrassv2 untag-resource \
--resource-arn arn:aws:greengrass:us-west-2:123456789012:coreDevices:MyGreengrassCore \
--tag-keys Owner

Expand Down
2 changes: 1 addition & 1 deletion awscli/examples/iot/add-thing-to-billing-group.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This command produces no output.

The following ``add-thing-to-billing-group`` example adds a thing with a specified ARN to a billing group with the specified ARN. Specifying an ARN is helpful if you work with multiple AWS Regions or accounts. It can help ensure that you are adding to the right Region and account. ::

aws iot add-thing-to-thing-group \
aws iot add-thing-to-billing-group \
--billing-group-arn "arn:aws:iot:us-west-2:123456789012:billinggroup/GroupOne" \
--thing-arn "arn:aws:iot:us-west-2:123456789012:thing/MyOtherLightBulb"

Expand Down
32 changes: 9 additions & 23 deletions awscli/examples/iot/describe-audit-suppression.rst
Original file line number Diff line number Diff line change
@@ -1,34 +1,20 @@
**To get details about an audit finding suppression**

The following ``describe-audit-suppression`` example lists details about an audit finding suppression. ::
The following ``describe-audit-suppression`` example gets details about the audit finding suppression for an expiring device certificate. ::

aws iot describe-audit-task \
--task-id "787ed873b69cb4d6cdbae6ddd06996c5"
aws iot describe-audit-suppression \
--check-name DEVICE_CERTIFICATE_EXPIRING_CHECK \
--resource-identifier deviceCertificateId=c7691e8b4a5f7d9e8c6b3a2f1e0d9c8b7a6f5e4d3c2b1a0f9e8d7c6b5a4f3e2d

Output::

{
"taskStatus": "COMPLETED",
"taskType": "SCHEDULED_AUDIT_TASK",
"taskStartTime": 1596168096.157,
"taskStatistics": {
"totalChecks": 1,
"inProgressChecks": 0,
"waitingForDataCollectionChecks": 0,
"compliantChecks": 0,
"nonCompliantChecks": 1,
"failedChecks": 0,
"canceledChecks": 0
"checkName": "DEVICE_CERTIFICATE_EXPIRING_CHECK",
"resourceIdentifier": {
"deviceCertificateId": "c7691e8b4a5f7d9e8c6b3a2f1e0d9c8b7a6f5e4d3c2b1a0f9e8d7c6b5a4f3e2d"
},
"scheduledAuditName": "AWSIoTDeviceDefenderDailyAudit",
"auditDetails": {
"DEVICE_CERTIFICATE_EXPIRING_CHECK": {
"checkRunStatus": "COMPLETED_NON_COMPLIANT",
"checkCompliant": false,
"totalResourcesCount": 195,
"nonCompliantResourcesCount": 2
}
}
"expirationDate": "2020-08-20T00:00:00+00:00",
"suppressIndefinitely": false
}

For more information, see `Audit finding suppressions <https://docs.aws.amazon.com/iot/latest/developerguide/audit-finding-suppressions.html>`__ in the *AWS IoT Developers Guide*.
39 changes: 6 additions & 33 deletions awscli/examples/iot/update-job.rst
Original file line number Diff line number Diff line change
@@ -1,38 +1,11 @@
**To get detailed status for a job**
**To update a job**

The following ``update-job`` example gets detailed status for the job whose ID is ``example-job-01``. ::
The following ``update-job`` example updates the description of the job whose ID is ``example-job-01``. ::

aws iot describe-job \
--job-id "example-job-01"
aws iot update-job \
--job-id "example-job-01" \
--description "example job test"

Output::

{
"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": {}
}
}
This command produces no output.

For more information, see `Creating and Managing Jobs (CLI) <https://docs.aws.amazon.com/iot/latest/developerguide/manage-job-cli.html>`__ in the *AWS IoT Developer Guide*.
2 changes: 1 addition & 1 deletion awscli/examples/kinesis/stop-stream-encryption.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The following ``stop-stream-encryption`` example disables server-side encryption for the specified stream, using the specified AWS KMS key. ::

aws kinesis start-stream-encryption \
aws kinesis stop-stream-encryption \
--encryption-type KMS \
--key-id arn:aws:kms:us-west-2:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
--stream-name samplestream
Expand Down
31 changes: 1 addition & 30 deletions awscli/examples/proton/list-service-instances.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
**Example 1: To list all service instances**
**To list all service instances**

The following ``list-service-instances`` example lists service instances. ::

Expand All @@ -25,32 +25,3 @@ Output::
}

For more information, see `View service instance data <https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-instance-view.html>`__ in the *The AWS Proton Administrator Guide* or `View service instance data <https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-instance-view.html>`__ in the *The AWS Proton User Guide*.

**Example 2: To list the specified service instance**

The following ``list-service-instances`` example lists the specified service instance by using the ``get-service-instance`` command, which gets a service instance. ::

aws proton get-service-instance \
--name "instance-one" \
--service-name "simple-svc"

Output::

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

For more information, see `View service instance data <https://docs.aws.amazon.com/proton/latest/adminguide/ag-svc-instance-view.html>`__ in the *The AWS Proton Administrator Guide* or `View service instance data <https://docs.aws.amazon.com/proton/latest/userguide/ag-svc-instance-view.html>`__ in the *The AWS Proton User Guide*.
81 changes: 81 additions & 0 deletions awscli/examples/rds/create-db-cluster.rst
Original file line number Diff line number Diff line change
Expand Up @@ -183,3 +183,84 @@ Output::
}

For more information, see `Creating an Amazon Aurora DB cluster <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html>`__ in the *Amazon Aurora User Guide*.

**Example 4: To create an Aurora PostgreSQL DB cluster for Aurora Limitless Database**

The following ``create-db-cluster`` example creates an Aurora PostgreSQL primary DB cluster that's compatible with Aurora Serverless v2 and Aurora Limitless Database. After you create the DB cluster, create its writer DB instance with the ``create-db-instance`` command and then a DB shard group with the ``create-db-shard-group`` command. ::

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

Output::

{
"DBCluster": {
"AllocatedStorage": 1,
"AvailabilityZones": [
"us-west-2b",
"us-west-2c",
"us-west-2a"
],
"BackupRetentionPeriod": 1,
"DBClusterIdentifier": "my-sv2-cluster",
"DBClusterParameterGroup": "default.aurora-postgresql15",
"DBSubnetGroup": "default",
"Status": "creating",
"Endpoint": "my-sv2-cluster.cluster-cekycexample.us-west-2.rds.amazonaws.com",
"ReaderEndpoint": "my-sv2-cluster.cluster-ro-cekycexample.us-west-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-west-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
}
}
}

For more information, see `Using Aurora Serverless v2 <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html>`__ in the *Amazon Aurora User Guide*.
118 changes: 117 additions & 1 deletion awscli/examples/rds/create-db-instance.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
**To create a DB instance**
**Example 1: To create a DB instance**

The following ``create-db-instance`` example uses the required options to launch a new DB instance. ::

Expand Down Expand Up @@ -104,3 +104,119 @@ Output::
}

For more information, see `Creating an Amazon RDS DB Instance <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html>`__ in the *Amazon RDS User Guide*.

**Example 2: To create an Aurora Serverless v2 writer DB instance in a DB cluster**

The following ``create-db-instance`` example creates an Aurora Serverless v2 primary (writer) DB instance in a DB cluster. When you use the console to create a DB cluster, Amazon RDS automatically creates the writer DB instance for your DB cluster. However, when you use the AWS CLI to create a DB cluster, you must explicitly create the writer DB instance for your DB cluster using the ``create-db-instance`` command. ::

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

Output::

{
"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-west-2c"
},
"SubnetOutpost": {},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-########",
"SubnetAvailabilityZone": {
"Name": "us-west-2a"
},
"SubnetOutpost": {},
"SubnetStatus": "Active"
},
{
"SubnetIdentifier": "subnet-########",
"SubnetAvailabilityZone": {
"Name": "us-west-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-west-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
}
}

For more information, see `Using Aurora Serverless v2 <https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html>`__ in the *Amazon Aurora User Guide*.
Loading
Loading