Merge pull request aws#4865 from bisdavid/awsdocs-01-22

New CLI Examples for IoT and GreenGrass
tim-finnigan · Jan 22, 2020 · f2d5a45 · f2d5a45
2 parents 858aa76 + 4af58b3
commit f2d5a45
Show file tree

Hide file tree

Showing 6 changed files with 132 additions and 0 deletions.
diff --git a/awscli/examples/greengrass/list-bulk-deployment-detailed-reports.rst b/awscli/examples/greengrass/list-bulk-deployment-detailed-reports.rst
@@ -0,0 +1,32 @@
+**To list information about individual deployments in a bulk deployment**
+
+The following ``list-bulk-deployment-detailed-reports`` example displays information about the individual deployments in a bulk deployment operation, including status. ::
+
+    aws greengrass list-bulk-deployment-detailed-reports \
+        --bulk-deployment-id 42ce9c42-489b-4ed4-b905-8996aa50ef9d
+
+Output::
+
+    {
+        "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"
+            },
+            ...
+        ]
+    }
+
+For more information, see `Create Bulk Deployments for Groups <https://docs.aws.amazon.com/greengrass/latest/developerguide/bulk-deploy-cli.html>`__ in the *AWS IoT Greengrass Developer Guide*.
diff --git a/awscli/examples/iot/create-domain-configuration.rst b/awscli/examples/iot/create-domain-configuration.rst
@@ -0,0 +1,16 @@
+**To create a domain configuration**
+
+The following ``create-domain-configuration`` example creates an AWS-managed domain configuration with a service type of ``DATA``. ::
+
+    aws iot create-domain-configuration \
+        --domain-configuration-name "additionalDataDomain" \
+        --service-type "DATA"
+
+Output::
+
+    {
+        "domainConfigurationName": "additionalDataDomain",
+        "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/additionalDataDomain/dikMh"
+    }
+
+For more information, see `Configurable Endpoints <https://docs.aws.amazon.com/iot/latest/developerguide/iot-custom-endpoints-configurable-aws.html>`__ in the *AWS IoT Developer Guide*.
diff --git a/awscli/examples/iot/delete-domain-configuration.rst b/awscli/examples/iot/delete-domain-configuration.rst
@@ -0,0 +1,11 @@
+**To delete a domain configuration**
+
+The following ``delete-domain-configuration`` example deletes a domain configuration named ``additionalDataDomain`` from your AWS account. ::
+
+    aws iot update-domain-configuration \
+        --domain-configuration-name "additionalDataDomain" \
+        --domain-configuration-status "DISABLED"
+
+This command produces no output.
+
+For more information, see `Configurable Endpoints <https://docs.aws.amazon.com/iot/latest/developerguide/iot-custom-endpoints-configurable-aws.html>`__ in the *AWS IoT Developer Guide*.
diff --git a/awscli/examples/iot/describe-domain-configuration.rst b/awscli/examples/iot/describe-domain-configuration.rst
@@ -0,0 +1,20 @@
+**To describe a domain configuration**
+
+The following ``describe-domain-configuration`` example displays details about the specified domain configuration. ::
+
+    aws iot describe-domain-configuration \
+        --domain-configuration-name "additionalDataDomain"
+
+Output::
+
+    {    
+        "domainConfigurationName": "additionalDataDomain",   
+        "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/additionalDataDomain/dikMh",   
+        "domainName": "d01645582h24k4we2vblw-ats.iot.us-west-2.amazonaws.com",   
+        "serverCertificates": [],   
+        "domainConfigurationStatus": "ENABLED",  
+        "serviceType": "DATA",  
+        "domainType": "AWS_MANAGED"
+    }
+
+For more information, see `Configurable Endpoints <https://docs.aws.amazon.com/iot/latest/developerguide/iot-custom-endpoints-configurable-aws.html>`__ in the *AWS IoT Developer Guide*.
diff --git a/awscli/examples/iot/list-domain-configurations.rst b/awscli/examples/iot/list-domain-configurations.rst
@@ -0,0 +1,37 @@
+**To list domain configurations**
+
+The following ``list-domain-configurations`` example lists the domain configurations in your AWS account that have the specified service type. ::
+
+    aws iot list-domain-configurations \
+        --service-type "DATA"
+
+Output::
+
+    {
+        "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"           
+            }    
+        ]
+    }
+
+For more information, see `Configurable Endpoints <https://docs.aws.amazon.com/iot/latest/developerguide/iot-custom-endpoints-configurable-aws.html>`__ in the *AWS IoT Developer Guide*.
diff --git a/awscli/examples/iot/update-domain-configuration.rst b/awscli/examples/iot/update-domain-configuration.rst
@@ -0,0 +1,16 @@
+**To update a domain configuration**
+
+The following ``update-domain-configuration`` example disables the specified domain configuration. ::
+
+    aws iot update-domain-configuration \
+        --domain-configuration-name "additionalDataDomain" \
+        --domain-configuration-status "DISABLED"
+
+Output::
+
+    {
+        "domainConfigurationName": "additionalDataDomain",
+        "domainConfigurationArn": "arn:aws:iot:us-west-2:123456789012:domainconfiguration/additionalDataDomain/dikMh"
+    }
+
+For more information, see `Configurable Endpoints <https://docs.aws.amazon.com/iot/latest/developerguide/iot-custom-endpoints-configurable-aws.html>`__ in the *AWS IoT Developer Guide*.