### Start an Instance Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/lightsail/start-instance.rst This example demonstrates how to start a specific AWS Lightsail instance using the AWS CLI. ```APIDOC ## POST /lightsail/start-instance ### Description Starts a specified AWS Lightsail instance. ### Method POST ### Endpoint /lightsail/start-instance ### Parameters #### Query Parameters - **--instance-name** (string) - Required - The name of the instance to start. ### Request Example ```json { "instance-name": "WordPress-1" } ``` ### Response #### Success Response (200) - **operations** (array) - A list of operations performed. - **id** (string) - The unique identifier for the operation. - **resourceName** (string) - The name of the resource affected by the operation. - **resourceType** (string) - The type of the resource. - **createdAt** (number) - The timestamp when the operation was created. - **location** (object) - The location of the resource. - **availabilityZone** (string) - The availability zone. - **regionName** (string) - The region name. - **isTerminal** (boolean) - Indicates if the operation is terminal. - **operationType** (string) - The type of operation. - **status** (string) - The current status of the operation. - **statusChangedAt** (number) - The timestamp when the status last changed. #### Response Example ```json { "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 } ] } ``` ``` -------------------------------- ### Start a Canary Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/synthetics/start-canary.rst This example demonstrates how to start a specific AWS Synthetics canary using the `start-canary` command. ```APIDOC ## POST /start-canary ### Description Starts a specific AWS Synthetics canary. The canary will begin running its defined script. ### Method POST ### Endpoint /start-canary ### Parameters #### Query Parameters - **name** (string) - Required - The name of the canary to start. ### Request Example ```json { "name": "demo_canary" } ``` ### Response #### Success Response (200) This command produces no output upon successful execution. #### Response Example (No output) ``` -------------------------------- ### Start Composition with Thumbnail Recording Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/ivs-realtime/start-composition.rst This example demonstrates how to start a composition for a specified stage, streaming to a channel and S3, with thumbnail recording enabled. ```APIDOC ## POST /ivs-realtime start-composition ### Description Starts a composition for a specified stage to be streamed to specified destinations, with optional thumbnail recording enabled. ### Method POST ### Endpoint /ivs-realtime start-composition ### Parameters #### Query Parameters - **stage-arn** (string) - Required - The ARN of the stage to use for the composition. - **destinations** (JSON string) - Required - A JSON string representing the destinations for the composition. This can include channel destinations and S3 destinations. ### Request Example ```json { "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}] } } ] } ``` ### Response #### Success Response (200) - **composition** (object) - Details of the started composition. - **arn** (string) - The ARN of the composition. - **destinations** (array) - List of destinations for the composition. - **stageArn** (string) - The ARN of the stage used for the composition. - **startTime** (string) - The start time of the composition. - **state** (string) - The current state of the composition. - **tags** (object) - Tags associated with the composition. #### Response Example ```json { "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": { "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": {} } } ``` ``` -------------------------------- ### Start Configuration Deployment Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/appconfig/start-deployment.rst This example demonstrates how to start a deployment to an application using the AWS AppConfig CLI. It specifies the application, environment, deployment strategy, configuration profile, and configuration version. ```APIDOC ## POST /applications/{applicationId}/environments/{environmentId}/deployments ### Description Starts a deployment to an application using the specified environment, deployment strategy, and configuration profile. ### Method POST ### Endpoint /applications/{applicationId}/environments/{environmentId}/deployments ### Parameters #### Path Parameters - **applicationId** (string) - Required - The application ID to start deployment for. - **environmentId** (string) - Required - The environment ID to start deployment for. #### Query Parameters - **deploymentStrategyId** (string) - Required - The ID of the deployment strategy to use. - **configurationProfileId** (string) - Required - The ID of the configuration profile to deploy. - **configurationVersion** (string) - Required - The version of the configuration to deploy. ### Request Example ```json { "applicationId": "339ohji", "environmentId": "54j1r29", "deploymentStrategyId": "1225qzk", "configurationProfileId": "ur8hx2f", "configurationVersion": "1" } ``` ### Response #### Success Response (200) - **ApplicationId** (string) - The ID of the application. - **EnvironmentId** (string) - The ID of the environment. - **DeploymentStrategyId** (string) - The ID of the deployment strategy. - **ConfigurationProfileId** (string) - The ID of the configuration profile. - **DeploymentNumber** (integer) - The deployment number. - **ConfigurationName** (string) - The name of the configuration. - **ConfigurationLocationUri** (string) - The URI of the configuration location. - **ConfigurationVersion** (string) - The version of the configuration. - **DeploymentDurationInMinutes** (integer) - The duration of the deployment in minutes. - **GrowthType** (string) - The type of growth for the deployment. - **GrowthFactor** (float) - The growth factor for the deployment. - **FinalBakeTimeInMinutes** (integer) - The final bake time in minutes. - **State** (string) - The current state of the deployment. - **EventLog** (array) - A list of events related to the deployment. - **PercentageComplete** (float) - The percentage of the deployment that is complete. - **StartedAt** (string) - The timestamp when the deployment started. #### Response Example ```json { "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" } ``` ``` -------------------------------- ### Start an AWS Pipe Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/pipes/start-pipe.rst This example demonstrates how to start a specific AWS Pipe by its name. ```APIDOC ## POST /pipes start-pipe ### Description Starts an existing AWS Pipe. ### Method POST ### Endpoint /pipes start-pipe ### Parameters #### Query Parameters - **name** (string) - Required - The name of the pipe to start. ### Request Example ```json { "name": "Demo_Pipe" } ``` ### Response #### Success Response (200) - **Arn** (string) - The Amazon Resource Name (ARN) of the pipe. - **Name** (string) - The name of the pipe. - **DesiredState** (string) - The desired state of the pipe (e.g., RUNNING). - **CurrentState** (string) - The current state of the pipe (e.g., STARTING). - **CreationTime** (string) - The timestamp when the pipe was created. - **LastModifiedTime** (string) - The timestamp when the pipe was last modified. #### Response Example ```json { "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" } ``` ``` -------------------------------- ### Example output for start-incident Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/ssm-incidents/start-incident.rst The JSON response returned after successfully starting an incident. ```json { "incidentRecordArn": "arn:aws:ssm-incidents::682428703967:incident-record/Example-Response-Plan/6ebcc812-85f5-b7eb-8b2f-283e4d844308" } ``` -------------------------------- ### Example output for start-instance command Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/lightsail/start-instance.rst The JSON response returned after successfully executing the start-instance command. ```json { "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 } ] } ``` -------------------------------- ### Get Patches Installed Since a Specific Time Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/ssm/describe-instance-patches.rst Retrieves information about patches installed since a specified time for the instance. This example combines filters and a JMESPath query for precise results. ```bash aws ssm describe-instance-patches \ --instance-id "i-1234567890abcdef0" \ --filters Key=State,Values=Installed \ --query "Patches[?InstalledTime >= `2023-01-01T16:00:00`"]" ``` -------------------------------- ### Provisioning Template Version Output Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/iot/create-provisioning-template-version.rst Example response returned after successfully creating a provisioning template version. ```json { "templateArn": "arn:aws:iot:us-east-1:123456789012:provisioningtemplate/widget-template", "templateName": "widget-template", "versionId": 2, "isDefaultVersion": false } ``` -------------------------------- ### Download a specific bundled installer version Source: https://github.com/aws/aws-cli/blob/develop/UPGRADE_PY3.md Example command to download a specific version of the AWS CLI bundled installer (version 1.18.200). ```bash curl https://s3.amazonaws.com/aws-cli/awscli-bundle-1.18.200.zip -o awscli-bundle.zip ``` -------------------------------- ### Get Enabled Baseline Example Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/controltower/get-enabled-baseline.rst This example demonstrates how to retrieve details of an enabled baseline in AWS Control Tower. ```bash aws controltower get-enabled-baseline \ --enabled-baseline-identifier arn:aws:controltower:us-east-1:123456789012:enabledbaseline/XOM12BEL4YD578CQ2 ``` -------------------------------- ### Example JSON Configuration File Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/ec2/get-instance-types-from-instance-requirements.rst A sample configuration file defining specific architecture, virtualization, CPU, and memory requirements. ```json { "ArchitectureTypes": [ "x86_64" ], "VirtualizationTypes": [ "hvm" ], "InstanceRequirements": { "VCpuCount": { "Min": 4, "Max": 6 }, "MemoryMiB": { "Min": 2048 }, "InstanceGenerations": [ "current" ] } } ``` -------------------------------- ### Get Control Tower Baseline Operation Example Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/controltower/get-baseline-operation.rst This example demonstrates how to retrieve details about a specific Control Tower baseline operation by its identifier. ```bash aws controltower get-baseline-operation \ --operation-identifier "51e190ac-8a37-4f6d-b63c-fb5104b5db38" ``` -------------------------------- ### Get Enabled Control Example Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/controltower/get-enabled-control.rst This example demonstrates how to retrieve details for a specific enabled control in AWS Control Tower. ```bash aws controltower get-enabled-control \ --enabled-control-identifier arn:aws:controltower:us-east-1:123456789012:enabledcontrol/26RGJRSLXCP1KW8D ``` -------------------------------- ### POST /start-deployment Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/apprunner/start-deployment.rst Initiates a manual deployment to an App Runner service. ```APIDOC ## POST /start-deployment ### Description Initiates a manual deployment to an App Runner service. ### Method POST ### Endpoint aws apprunner start-deployment ### Request Body - **ServiceArn** (string) - Required - The Amazon Resource Name (ARN) of the App Runner service. ### Request Example { "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python-app/8fe1e10304f84fd2b0df550fe98a71fa" } ### Response #### Success Response (200) - **OperationId** (string) - The unique identifier for the deployment operation. #### Response Example { "OperationId": "853a7d5b-fc9f-4730-831b-fd8037ab832a" } ``` -------------------------------- ### Get Control Operation Example Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/controltower/get-control-operation.rst This example demonstrates how to retrieve details of a specific AWS Control Tower control operation using the AWS CLI. ```bash aws controltower get-control-operation \ --operation-identifier "7691fc5a-de87-4540-8c95-b0aabd56382c" ``` -------------------------------- ### Example Output of List Packaging Configurations Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/mediapackage-vod/list-packaging-configurations.rst This is an example JSON output from the `list-packaging-configurations` command, showing details for CMAF, DASH, HLS, and a custom HLS configuration with encryption. ```json { "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" } } ] } ] } ``` -------------------------------- ### Example Deployment Information Output Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/deploy/get-deployment.rst This is an example of the JSON output you can expect when retrieving deployment information. It includes details like application name, status, and revision. ```json { "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 } } ``` -------------------------------- ### Create Basic Windows Fleet Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/gamelift/create-fleet.rst Creates a minimally configured fleet of spot Windows instances. Use update-fleet to complete configuration. ```bash 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}]' ``` -------------------------------- ### Install AWS CLI with Python 3 using bundled installer Source: https://github.com/aws/aws-cli/blob/develop/UPGRADE_PY3.md Command to install the AWS CLI using the bundled installer with a Python 3 environment. ```bash $ python awscli-bundle/install -i /usr/local/aws -b /usr/local/bin/aws ``` -------------------------------- ### Amazon ECS SDK Reference Examples Source: https://github.com/aws/aws-cli/blob/develop/CHANGELOG.rst Adding SDK reference examples for Amazon ECS operations. ```python SDK reference examples for Amazon ECS operations ``` -------------------------------- ### Get System Template Revisions - Output Example Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/iotthingsgraph/get-system-template-revisions.rst This is an example of the JSON output you can expect when retrieving system template revision information. ```json { "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 } ] } ``` -------------------------------- ### Example output for list-installed-components Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/greengrassv2/list-installed-components.rst The JSON response structure returned by the list-installed-components command. ```json { "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 } ] } ``` -------------------------------- ### Start live tail streaming session for log groups Source: https://github.com/aws/aws-cli/blob/develop/CHANGELOG.rst Adds support for starting a live tail streaming session for one or more log groups. ```bash feature:logs start-live-tail ``` -------------------------------- ### Example Output of Get IPAM Pool CIDRs Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/ec2/get-ipam-pool-cidrs.rst This is an example of the JSON output you can expect when successfully retrieving IPAM pool CIDRs. ```json { "IpamPoolCidr": { "Cidr": "10.0.0.0/24", "State": "provisioned" } } ``` -------------------------------- ### Example Output for Create Application Version Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/elasticbeanstalk/create-application-version.rst This is an example of the JSON output you can expect after successfully creating a new application version. ```json { "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" } } } ``` -------------------------------- ### SSM Start Session profile name handling Source: https://github.com/aws/aws-cli/blob/develop/CHANGELOG.rst Only provide profile name to session-manager-plugin if provided using --profile flag. ```bash bugfix:``ssm start-session``: Only provide profile name to session-manager-plugin if provided using --profile flag ``` -------------------------------- ### Verify Python 3 Installation Source: https://github.com/aws/aws-cli/blob/develop/UPGRADE_PY3.md Commands to check the installed Python 3 version. ```bash $ python --version Python 3.10.20 $ python3 --version Python 3.10.20 $ python3.10 --version Python 3.10.20 ``` -------------------------------- ### Example output for create-instances-from-snapshot Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/lightsail/create-instances-from-snapshot.rst The JSON response returned after successfully initiating the instance creation process. ```json { "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 } ] } ``` -------------------------------- ### Bugfix in configure get Source: https://github.com/aws/aws-cli/blob/develop/CHANGELOG.rst This entry details a bugfix related to the 'configure get' command, specifically addressing how it handles default profiles. ```text bugfix:configure: Properly use the default profile in ``configure get`` ``` -------------------------------- ### Get Workgroup Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/athena/create-work-group.rst Example of retrieving details for a specific workgroup. ```APIDOC ## GET /aws/athena/workgroups/{workgroupName} ### Description Retrieves the details of a specified workgroup in AWS Athena. ### Method GET ### Endpoint /aws/athena/workgroups/{workgroupName} ### Parameters #### Path Parameters - **workgroupName** (string) - Required - The name of the workgroup to retrieve. ### Response #### Success Response (200) - **workgroup** (object) - Contains details about the workgroup. - **name** (string) - The name of the workgroup. - **description** (string) - The description of the workgroup. - **configuration** (object) - The configuration settings for the workgroup. - **resultConfiguration** (object) - The output location for query results. - **outputLocation** (string) - The S3 bucket URI for query results. - **enforceWorkGroupConfiguration** (boolean) - Whether workgroup configuration settings are enforced. - **publishCloudWatchMetricsEnabled** (boolean) - Whether CloudWatch metrics publishing is enabled. - **tags** (array) - An array of tag objects associated with the workgroup. - **key** (string) - The tag key. - **value** (string) - The tag value. #### Response Example ```json { "workgroup": { "name": "Data_Analyst_Group", "description": "Workgroup for data analysts", "configuration": { "resultConfiguration": { "outputLocation": "s3://amzn-s3-demo-bucket" }, "enforceWorkGroupConfiguration": true, "publishCloudWatchMetricsEnabled": true }, "tags": [ { "key": "Division", "value": "West" }, { "key": "Location", "value": "Seattle" }, { "key": "Team", "value": "Big Data" } ] } } ``` ``` -------------------------------- ### Create Launch Configuration with Instance Store Volume Mapping Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/autoscaling/create-launch-configuration.rst Use this command to create a launch configuration that includes an instance store volume mapped to a specific device name. Ensure the instance type supports instance store volumes. ```bash 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"}]' ``` -------------------------------- ### Create Launch Configuration for Spot Instances Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/autoscaling/create-launch-configuration.rst This command creates a launch configuration where Spot Instances are the only purchase option, specifying a maximum Spot price. ```bash aws autoscaling create-launch-configuration \ --launch-configuration-name my-lc \ --image-id ami-04d5cc9b88example \ --instance-type m5.large \ --spot-price "0.50" ``` -------------------------------- ### Example Output for Modify Instance Event Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/ec2/modify-instance-event-start-time.rst This is an example of the JSON output you might receive after successfully modifying an instance event start time. ```json { "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" } } ``` -------------------------------- ### Setup IoT Temperature Sensors Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/iot/get-cardinality.rst Creates 10 IoT things with temperature, rackId, and stateNormal attributes using a bash script. ```bash # 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 ``` -------------------------------- ### Example Output of Get Content Moderation Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/rekognition/get-content-moderation.rst This is an example of the JSON output returned by the `get-content-moderation` command, showing detected moderation labels and video metadata. ```json { "NextToken": "dlhcKMHMzpCBGFukz6IO3JMcWiJAamCVhXHt3r6b4b5Tfbyw3q7o+Jeezt+ZpgfOnW9FCCgQ", "ModerationLabels": [ { "Timestamp": 0, "ModerationLabel": { "Confidence": 97.39583587646484, "ParentName": "", "Name": "Violence" } }, { "Timestamp": 0, "ModerationLabel": { "Confidence": 97.39583587646484, "ParentName": "Violence", "Name": "Weapon Violence" } } ], "JobStatus": "SUCCEEDED", "VideoMetadata": { "Format": "QuickTime / MOV", "FrameRate": 29.97515869140625, "Codec": "h264", "DurationMillis": 6039, "FrameHeight": 1920, "FrameWidth": 1080 } } ``` -------------------------------- ### Create a basic launch template Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/ec2/create-launch-template.rst Creates a launch template specifying subnet, public IP, IPv6, and instance tags. ```bash 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"}]}]}' ``` -------------------------------- ### Network Insights Analysis Output Example Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/ec2/start-network-insights-analysis.rst Example output from the start-network-insights-analysis command, showing the analysis ID, ARN, path ID, start date, and status. ```json { "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" } } ``` -------------------------------- ### Provisioned product description output Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/servicecatalog/describe-provisioned-product.rst Example JSON output returned by the describe-provisioned-product command. ```json { "ProvisionedProductDetail": { "Status": "ERROR", "CreatedTime": 1577222793.358, "Arn": "arn:aws:servicecatalog:us-west-2:123456789012:stack/mytestppname3/pp-dpom27bm4abcd", "Id": "pp-dpom27bm4abcd", "StatusMessage": "AmazonCloudFormationException Parameters: [KeyName] must have values (Service: AmazonCloudFormation; Status Code: 400; Error Code: ValidationError; Request ID: 5528602a-a9ef-427c-825c-f82c31b814f5)", "IdempotencyToken": "527c5358-2a1a-4b9e-b1b9-7293b0ddff42", "LastRecordId": "rec-tfuawdjovzxge", "Type": "CFN_STACK", "Name": "mytestppname3" }, "CloudWatchDashboards": [] } ``` -------------------------------- ### Workflow run output Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/omics/start-run.rst Example response returned after successfully starting a run. ```json { "arn": "arn:aws:omics:us-west-2:123456789012:run/1234567", "id": "1234567", "status": "PENDING", "tags": {} } ``` -------------------------------- ### Example Output - Storage Configurations Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/ivs-realtime/list-storage-configurations.rst This is an example of the JSON output returned by the `list-storage-configurations` command, showing details of configured storage. ```json { "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": {} } ] } ``` -------------------------------- ### Command output example Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/appconfig/get-configuration.rst Displays the metadata returned by the get-configuration command. ```json { "ConfigurationVersion": "1", "ContentType": "application/json" } ``` -------------------------------- ### Example Output for Get Subnet CIDR Reservation Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/ec2/get-subnet-cidr-reservations.rst This is an example of the JSON output you can expect when retrieving information about subnet CIDR reservations. It includes IPv4 and IPv6 reservations. ```json { "SubnetIpv4CidrReservations": [ { "SubnetCidrReservationId": "scr-044f977c4eEXAMPLE", "SubnetId": "subnet-03c51e2e6cEXAMPLE", "Cidr": "10.1.0.16/28", "ReservationType": "prefix", "OwnerId": "123456789012" } ], "SubnetIpv6CidrReservations": [] } ``` -------------------------------- ### Get Storage Configuration Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/ivs-realtime/get-storage-configuration.rst This example demonstrates how to retrieve the details of a specific storage configuration using its ARN. ```bash aws ivs-realtime get-storage-configuration \ --arn "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh" ``` -------------------------------- ### Example output for create-connection Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/apprunner/create-connection.rst Displays the connection details including the ARN and initial status. ```json { "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" } } ``` -------------------------------- ### Example configuration file content Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/appconfig/get-configuration.rst Represents the structure of the file saved by the get-configuration command. ```json { "Name": "ExampleApplication", "Id": ExampleID, "Rank": 7 } ``` -------------------------------- ### Start Clinician-Patient Dialogue Transcription Job Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/transcribe/start-medical-transcription-job.rst This example starts a medical transcription job for an audio file containing a clinician-patient dialogue. The output location is specified in the JSON input. ```bash aws transcribe start-medical-transcription-job \ --cli-input-json file://mysecondfile.json ``` ```json { "MedicalTranscriptionJobName": "simple-dictation-medical-transcription-job", "LanguageCode": "language-code", "Specialty": "PRIMARYCARE", "Type": "CONVERSATION", "OutputBucketName":"amzn-s3-demo-bucket", "Media": { "MediaFileUri": "s3://amzn-s3-demo-bucket/your-audio-file.extension" } } ``` -------------------------------- ### AWS CodeDeploy Commands Source: https://github.com/aws/aws-cli/blob/develop/CHANGELOG.rst Adds register, deregister, install, and uninstall commands and updates to the latest AWS CodeDeploy API. ```bash aws codedeploy ``` -------------------------------- ### Configure options from file Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/elasticbeanstalk/update-environment.rst Applies multiple configuration settings defined in a local JSON file. ```bash aws elasticbeanstalk update-environment --environment-name my-env --option-settings file://options.json ``` -------------------------------- ### GET /get-content-moderation Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/rekognition/get-content-moderation.rst Retrieves the results of an unsafe content moderation operation started by start-content-moderation. ```APIDOC ## GET get-content-moderation ### Description Displays the results of an unsafe content operation that was started previously. ### Method GET ### Endpoint aws rekognition get-content-moderation ### Parameters #### Query Parameters - **job-id** (string) - Required - The identifier for the content moderation job. ### Request Example aws rekognition get-content-moderation --job-id 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef ### Response #### Success Response (200) - **NextToken** (string) - Token for pagination. - **ModerationLabels** (array) - List of detected moderation labels. - **JobStatus** (string) - The status of the job (e.g., SUCCEEDED). - **VideoMetadata** (object) - Metadata about the processed video. #### Response Example { "NextToken": "dlhcKMHMzpCBGFukz6IO3JMcWiJAamCVhXHt3r6b4b5Tfbyw3q7o+Jeezt+ZpgfOnW9FCCgQ", "ModerationLabels": [ { "Timestamp": 0, "ModerationLabel": { "Confidence": 97.39583587646484, "ParentName": "", "Name": "Violence" } } ], "JobStatus": "SUCCEEDED", "VideoMetadata": { "Format": "QuickTime / MOV", "FrameRate": 29.97515869140625, "Codec": "h264", "DurationMillis": 6039, "FrameHeight": 1920, "FrameWidth": 1080 } } ``` -------------------------------- ### List provisioning artifacts for a product Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/servicecatalog/list-provisioning-artifacts.rst Retrieves details for all provisioning artifacts associated with the specified product ID. ```bash aws servicecatalog list-provisioning-artifacts \ --product-id prod-nfi2abcdefgcpw ``` -------------------------------- ### Install AWS CLI with Python 3 using pip Source: https://github.com/aws/aws-cli/blob/develop/UPGRADE_PY3.md Command to install the AWS CLI using pip with a Python 3 environment. ```bash $ python -m pip install awscli ``` -------------------------------- ### Start an AppConfig deployment Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/appconfig/start-deployment.rst Initiates a deployment to an application using specific environment, strategy, and profile identifiers. ```bash aws appconfig start-deployment \ --application-id 339ohji \ --environment-id 54j1r29 \ --deployment-strategy-id 1225qzk \ --configuration-profile-id ur8hx2f \ --configuration-version 1 ``` -------------------------------- ### Example Output for Get Reference Store Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/omics/get-reference-store.rst This is an example of the JSON output you can expect when retrieving details about a reference store. It includes the store's ARN, creation timestamp, unique ID, and name. ```json { "arn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890", "creationTime": "2022-09-23T23:27:20.364Z", "id": "1234567890", "name": "my-rstore-0" } ``` -------------------------------- ### Example output for search-products-as-admin Source: https://github.com/aws/aws-cli/blob/develop/awscli/examples/servicecatalog/search-products-as-admin.rst The JSON response returned after executing the search-products-as-admin command. ```json { "ProductViewDetails": [ { "ProductViewSummary": { "Name": "my product", "Owner": "owner name", "Type": "CLOUD_FORMATION_TEMPLATE", "ProductId": "prod-abcdfz3syn2rg", "HasDefaultPath": false, "Id": "prodview-abcdmyuzv2dlu", "ShortDescription": "description" }, "ProductARN": "arn:aws:catalog:us-west-2:123456789012:product/prod-abcdfz3syn2rg", "CreatedTime": 1562097906.0, "Status": "CREATED" } ] } ```