Creating Kinesis Analytics applications using aws cli - amazon-web-services
I want to create a kinesis analytics application using aws cli. I use this command to create the application
aws kinesisanalytics create-application --application-name smartfactorytest1 --application-code "CREATE OR REPLACE STREAM DESTINATION_SQL_STREAM ( "device_serial" VARCHAR(16), "uploadRate" INTEGER, "downloadRate" INTEGER);
CREATE OR REPLACE PUMP "STREAM_PUMP"
AS INSERT INTO DESTINATION_SQL_STREAM
SELECT STREAM "device_serial", "uploadRate", "downloadRate"
FROM SOURCE_SQL_STREAM_001
-- LIKE compares a string to a string pattern (_ matches all char, % matches substring)
-- SIMILAR TO compares string to a regex, may use ESCAPE
WHERE "uploadRate" >20000" --inputs NamePrefix="SOURCE_SQL_STREAM",KinesisStreamsInput={ResourceARN="sourcearn",RoleARN="rolearn"}
But I get this error
invalid type for parameter Inputs[0].KinesisStreamsInput, value: ResourceARN=string, type: <class 'str'>, valid types: <class 'dict'>
Can anyone tell me what am I doing wrong? Any help would be appreciated.
I believe the issue is either that you need to take the quotes out in the KinesisStreamsInput section, or you need to add quotes and escape them. The documentation is unclear on which is the correct option.
According to the AWS Kinesis Analytics CLI Reference, https://docs.aws.amazon.com/cli/latest/reference/kinesisanalytics/create-application.html, the syntax for --inputs with KinesisStreamsInput should look like the example provided for KinesisStreamsOutput:
Name=string,KinesisStreamsOutput={ResourceARN=string,RoleARN=string},...
This would mean removing the quotes around your sourcearn and rolearn. However, the documentation isn't clear that this refers to the CLI syntax in all cases.
If that doesn't work, according to this AWS CLI usage guide page, https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html, it specifies adding quotes and escaping the relevant ones, depending on your OS...
"Linux or macOS
Use single quotation marks (' ') to enclose the JSON data structure, as in the following example. You don't have to do anything special with the embedded double quotation marks embedded in the JSON string.
aws ec2 run-instances --image-id ami-12345678 --block-device-mappings '[{"DeviceName":"/dev/sdb","Ebs":{"VolumeSize":20,"DeleteOnTermination":false,"VolumeType":"standard"}}]'
PowerShell
PowerShell requires single quotation marks (' ') to enclose the JSON data structure. Also, because double quotation marks have a special meaning to PowerShell, you must use a backslash () to escape each double quotation mark (") within the JSON structure, as in the following example.
PS C:\> aws ec2 run-instances --image-id ami-12345678 --block-device-mappings '[{\"DeviceName\":\"/dev/sdb\",\"Ebs\":{\"VolumeSize\":20,\"DeleteOnTermination\":false,\"VolumeType\":\"standard\"}}]'
Windows Command Prompt
The Windows command prompt requires double quotation marks (" ") to enclose the JSON data structure. Also, to prevent the command processor from misinterpreting the double quotation marks embedded in the JSON, you must also escape (precede with a backslash [ \ ] character) each double quotation mark (") within the JSON data structure itself, as in the following example.
C:\> aws ec2 run-instances --image-id ami-12345678 --block-device-mappings "[{\"DeviceName\":\"/dev/sdb\",\"Ebs\":{\"VolumeSize\":20,\"DeleteOnTermination\":false,\"VolumeType\":\"standard\"}}]"
Only the outermost double quotation marks are not escaped."
This link also references needing to escape quotes on Windows, and is using the kinesisanalytics command: https://github.com/aws/aws-cli/issues/3103
"Rishi74744 commented on Feb 6, 2018
I got it to work as -
aws kinesisanalytics add-application-reference-data-source --endpoint https://kinesisanalytics.us-east-1.amazonaws.com --region us-east-1 --application-name alerts --reference-data-source "{\"TableName\":\"DeviceData\",\"S3ReferenceDataSource\":{\"BucketARN\":\"arn: aws: s3: : : bucket-name\",\"FileKey\":\"device.csv\",\"ReferenceRoleARN\":\"arn: aws: iam: : account-id: role/role-name\"},\"ReferenceSchema\":{\"RecordFormat\":{\"RecordFormatType\":\"CSV\",\"MappingParameters\":{\"CSVMappingParameters\":{\"RecordRowDelimiter\":\"\n\",\"RecordColumnDelimiter\":\", \"}}},\"RecordEncoding\":\"UTF-8\",\"RecordColumns\":[{\"Name\":\"key1\",\"SqlType\":\"VARCHAR(64)\"},{\"Name\":\"key2\",\"SqlType\":\"VARCHAR(64)\"}]}}" --current-application-version-id 2
But this should be mentioned in the documentation."
One note: it may be preferable to use JSON files as inputs and use this syntax instead: --cli-input-json file://input.json. This is referenced in the AWS Kinesis CLI Command Reference (first link, under 1.) and also mentioned in the GitHub link above. It's also the method used by the majority of the AWS Kinesis documentation. For example, JSON files used for different purposes in Kinesis Analytics:
https://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html
Please let me know what works, and I will work with my AWS rep to improve the documentation.
Related
AWS CloudFormation keys not accepting special characters
I have noticed that AWS CloudFormation does not like special characters. When I update a key:value pair in our pipeline.yml file with special char e.g. PAR_FTP_PASS: ^XoN*H89Ie!rhpl!wan=Jcyo6mo, I see the following error: parameters[5] ParameterKey, ParameterValue or UsePreviousValue expected I am able to update the value through the AWS CloudFormation UI. It seems like the issue is to do with AWS CloudFOrmation parsing the yml file. Is there a workaround with this issue?
AWS Tags have some restrictions on what they can contain, see here: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-restrictions A key note which can catch people out is: "Although EC2 allows for any character in its tags, other services are more restrictive. The allowed characters across services are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / #." So I'd check if the service you are adding this onto can support that string.
Single Quotes Converting to Special Characters using AWS CLI
I am making SES Templates using the AWS CLI and having issues with single quotes converting to special characters when the emails are sent. This also happens when doing a DynamoDB put item operation using the CLI when a string contains a single quote within it. I've tried backslashes, wrapping the quote in double quotes then escaping it etc. aws ses send-bulk-templated-email --cli-input-json file://test.json aws dynamodb put-item --table-name TABLE --item file://item.json Item/Test Example (snippets of the json): test: "SubjectPart":"Happy birthday! Get more involved in managing your healthcare now that you're 18" item: "S": "Now that you're 18" Output: Happy birthday! Get more involved in managing your healthcare now that you’re 18 and Now that you’re 18 Expected: Happy birthday! Get more involved in managing your healthcare now that you're 18 and Now that you're 18
Assuming that you're using Linux or Mac, with the bash shell ... Here is an example of how to escape quote characters when using the awscli: aws dynamodb put-item \ --table mytable \ --item '{"id":{"S":"1"}, "name":{"S":"Fred'\''s Garage"}}' Here is a second way: aws dynamodb put-item \ --table mytable \ --item $'{"id":{"S":"1"}, "name":{"S":"Fred\'s Garage"}}' In the latter example, words of the form $'string' are treated specially and allow you to quote certain characters.
Welp after many trial and errors this is what worked: you\u2019re I have no idea why but it did. Posting this answer in case others experience this as well. Example: "SubjectPart":"Happy birthday! Get more involved in managing your healthcare now that you\u2019re 18" This will give you the expected output.
Escaping Terraform String Properly
How can I properly escape a Terraform string for trying to be interpolated that contains double curly braces? I'm reading a json file using templating and it keeps failing on this issue. "customInventory": "{{ customInventory }}" I want to keep the double braces. Nothing works so far and this is preventing the correct passing of this value to an Amazon Web Services Ssm doc. The Terraform documentation doesn't provide much insight other than escaping quotes and dollar signs. I've tried Unicode values, double braces, backslashes and other permutations without any success.
This syntax is AWS Ssm doc parameter syntax. The error was actually not terraform but AWS reporting back invalid input when attempting to create the doc. Changing to Enabled instead of {{ customInventory }} resolved the issue and allowed me to publish the doc.
AWS CloudSearch request using CLI returns Invalid Javascript Object error
I'm trying to query my AWS Cloudsearch (2013 API) domain using the AWS CLI on Ubuntu. I haven't been able to get it to work successfully when the search is restricted to a specific field. The following query: aws --profile myprofile cloudsearchdomain search --endpoint-url "https://search-mydomain-abc123xyz.eu-west-1.cloudsearch.amazonaws.com" --query-options {"fields":["my_field"]} --query-parser "simple" --return "my_field" --search-query "foo bar" ...returns the following error: An error occurred (SearchException) when calling the Search operation: q.options contains invalid javascript object If I remove the --query-options parameter from the above query, then it works. From the AWS CLI docs regarding the fields options of the --query-options parameter: An array of the fields to search when no fields are specified in a search... Valid for: simple , structured , lucene , and dismax aws cli version: aws-cli/1.11.150 Python/2.7.12 Linux/4.10.0-28-generic botocore/1.7.8
I think the documentation is a bit misleading as JSon does not like embedded double quotes inside double quotes, you would need to replace with single quote as --query-options "{'fields':['my_field']}" or you can escape the double quote --query-options "{\"fields\":[\"my_field\"]}"
aws ec2 request-spot-instances CLI issues
Trying to start a couple of spot instances within a simple script, and the syntax supplied in the AWS documentation and aws ec2 request-spot-instances help output is listed in either JAVA or JSON syntax. How does one enter the parameters under the JSON syntax from inside a shell script? aws --version aws-cli/1.2.6 Python/2.6.5 Linux/2.6.21.7-2.fc8xen aws ec2 request-spot-instances help -- at the start of "launch specification" it lists JSON syntax --launch-specification (structure) Specifies additional launch instance information. JSON Syntax: { "ImageId": "string", "KeyName": "string", }, .... "EbsOptimized": true|false, "SecurityGroupIds": ["string", ...], "SecurityGroups": ["string", ...] } I have tried every possible combination of the following, adding & moving brackets, quotes, changing options, etc, all to no avail. What would be the correct formatting of the variable $launch below to have this work? Other command variations -- "ec2-request-spot-instances" are not working in my environment, nor does it work if I try to substitute --spot-price with -p. #!/bin/bash launch="{"ImageId":"ami-a999999","InstanceType":"c1.medium"} "SecurityGroups":"launch-wizard-6"" echo $launch aws ec2 request-spot-instances --spot-price 0.01 --instance-count 1 --type c1.small --launch-specification $launch This provides result: Unknown options: SecurityGroups:launch-wizard-6 Substituting the security group number has the same result. aws ec2 describe-instances works perfectly, as does aws ec2 start-instance, so the environment and account information are properly setup, but I need to utilize spot pricing. In fact, nothing is working as listed in this user documentation: http://docs.aws.amazon.com/AWSEC2/latest/CommandLineReference/ApiReference-cmd-RequestSpotInstances.html Thank you,
I know this is an old question, but in case somebody runs into it. I had the same issue recently with the CLI. It was very hard to get all the parameters to work correctly for request-spot-instances #!/bin/bash AWS_DEFAULT_OUTPUT="text" UserData=$(base64 < userdata-current) region="us-west-2" price="0.03" zone="us-west-2c" aws ec2 request-spot-instances --region $region --spot-price $price --launch-specification "{ \"KeyName\": \"YourKey\", \"ImageId\": \"ami-3d50120d\" , \"UserData\": \"$UserData\", \"InstanceType\": \"r3.large\" , \"Placement\": {\"AvailabilityZone\": \"$zone\"}, \"IamInstanceProfile\": {\"Arn\": \"arn:aws:iam::YourAccount:YourProfile\"}, \"SecurityGroupIds\": [\"YourSecurityGroupId\"],\"SubnetId\": \"YourSubnectId\" }" Basically what I had to do is put my user data in an external file, load it into the UserData variable and then pass that on the command line. Trying to get everything on the command line or using an external file for the ec2-request-spot-instances just kept failing. Note that other commands worked just fine, so this is specific to the ec2-request-spot-instances. I detailed more about what i ended up doing here.
You have to use a list in this case: "SecurityGroups": ["string", ...] so "SecurityGroups":"launch-wizard-6" become "SecurityGroups":["launch-wizard-6"] Anyway, I'm dealing with the CLI right now and I found more useful to use a external JSON Here is an example using Python: myJson="file:///Users/xxx/Documents/Python/xxxxx/spotInstanceInformation.json" x= subprocess.check_output(["/usr/local/bin/aws ec2 request-spot-instances --spot-price 0.2 --launch-specification "+myJson],shell=True) print x And the output is: "SpotInstanceRequests": [ { "Status": { "UpdateTime": "2013-12-09T02:41:41.000Z", "Code": "pending-evaluation", "Message": "Your Spot request has been submitted for review, and is pending evaluation." etc etc .... Doc is here : http://docs.aws.amazon.com/cli/latest/reference/ec2/request-spot-instances.html FYI - I'm appending file:/// because I'm using MAC. If you are launching your bash script using Linux, you could just use myJson="/path/to/file/"
The first problem, here, is quoting and formatting: $ launch="{"ImageId":"ami-a999999","InstanceType":"c1.medium"} "SecurityGroups":"launch-wizard-6"" This isn't going to generate valid JSON, because the block you copied from the help file includes a spurious closing brace from a nested object that you didn't include, the closing brace is missing, and the unescaped double quotes are disappearing. But we're not really getting to the point where the json is actually being validated, because with that space after the last brace, the cli is assuming that SecurityGroups and launch-wizard-6 are more command line options following the argument to --launch-specification: $ echo $launch {ImageId:ami-a999999,InstanceType:c1.medium} SecurityGroups:launch-wizard-6 That's probably not what you expected... so we'll fix the quoting so that it looks like one long argument, after the json is valid: From the perspective of just generating valid json structures (not necessarily content), the data you are most likely trying to send would actually look like this, based on the docs: {"ImageId":"ami-a999999","InstanceType":"c1.medium","SecurityGroups":["launch-wizard-6"]} Check that as structurally valid JSON, here. Fixing the bracing, commas, and bracketing, the CLI stops throwing that error, with this formatting: $ launch='{"ImageId":"ami-a999999","InstanceType":"c1.medium","SecurityGroups":["launch-wizard-6"]}' $ echo $launch {"ImageId":"ami-a999999","InstanceType":"c1.medium","SecurityGroups":["launch-wizard-6"]} That isn't to say the API might not subsequently reject the request due to something else incorrect or missing, but you were never actually getting to the point of sending anything to the API; this was failing local validation in the command line tools.