aws-sdk-core 2.0.0.rc7 → 2.0.0.rc8
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -5
- data/README.md +2 -2
- data/apis/CloudFormation-2010-05-15.json +27 -0
- data/apis/CloudSearch-2013-01-01.json +16 -0
- data/apis/CloudWatch-2010-08-01.json +0 -185
- data/apis/ElastiCache-2014-03-24.json +7 -0
- data/apis/ElasticTranscoder-2012-09-25.json +118 -2
- data/apis/Glacier-2012-06-01.json +52 -0
- data/apis/RDS-2013-09-09.json +4 -0
- data/apis/S3-2006-03-01.json +490 -468
- data/apis/StorageGateway-2013-06-30.json +28 -0
- data/apis/source/cloudformation-2010-05-15.json +43 -7
- data/apis/source/cloudsearch-2013-01-01.json +38 -16
- data/apis/source/directconnect-2012-10-25.paginators.json +8 -2
- data/apis/source/dynamodb-2012-08-10.json +270 -269
- data/apis/source/ec2-2014-02-01.json +30 -30
- data/apis/source/elasticache-2014-03-24.paginators.json +6 -0
- data/apis/source/elastictranscoder-2012-09-25.json +184 -56
- data/apis/source/elastictranscoder-2012-09-25.paginators.json +4 -0
- data/apis/source/email-2010-12-01.json +1 -1
- data/apis/source/email-2010-12-01.waiters.json +14 -0
- data/apis/source/glacier-2012-06-01.json +77 -13
- data/apis/source/monitoring-2010-08-01.json +0 -308
- data/apis/source/rds-2013-01-10.json +7 -7
- data/apis/source/rds-2013-02-12.json +7 -7
- data/apis/source/rds-2013-09-09.json +76 -57
- data/apis/source/s3-2006-03-01.json +2213 -1209
- data/apis/source/s3-2006-03-01.waiters.json +5 -0
- data/apis/source/storagegateway-2013-06-30.json +441 -401
- data/apis/source/storagegateway-2013-06-30.paginators.json +6 -6
- data/apis/source/sts-2011-06-15.json +9 -9
- data/apis/source/swf-2012-01-25.json +627 -627
- data/doc-src/templates/default/layout/html/layout.erb +37 -0
- data/lib/aws/credential_provider_chain.rb +5 -7
- data/lib/aws/version.rb +1 -1
- data/spec/fixtures/operations/s3/head_object.yml +2 -2
- metadata +4 -5
- data/apis/source/cloudfront-2014-01-31.normal.json +0 -2905
- data/apis/source/elasticloadbalancing-2012-06-01.normal.json +0 -2107
- data/apis/source/kinesis-2013-12-02.normal.json +0 -761
|
@@ -933,7 +933,7 @@
|
|
|
933
933
|
"AWSAccessKeyId": {
|
|
934
934
|
"shape_name": "String",
|
|
935
935
|
"type": "string",
|
|
936
|
-
"documentation": "\n <p>The access key ID of the owner of the bucket
|
|
936
|
+
"documentation": "\n <p>The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance \n in <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html\">Best Practices for Managing AWS Access Keys</a>.</p>\n "
|
|
937
937
|
},
|
|
938
938
|
"UploadPolicy": {
|
|
939
939
|
"shape_name": "String",
|
|
@@ -1025,7 +1025,7 @@
|
|
|
1025
1025
|
"AWSAccessKeyId": {
|
|
1026
1026
|
"shape_name": "String",
|
|
1027
1027
|
"type": "string",
|
|
1028
|
-
"documentation": "\n <p>The access key ID of the owner of the bucket
|
|
1028
|
+
"documentation": "\n <p>The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance \n in <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html\">Best Practices for Managing AWS Access Keys</a>.</p>\n "
|
|
1029
1029
|
},
|
|
1030
1030
|
"UploadPolicy": {
|
|
1031
1031
|
"shape_name": "String",
|
|
@@ -1082,7 +1082,7 @@
|
|
|
1082
1082
|
"errors": [
|
|
1083
1083
|
|
|
1084
1084
|
],
|
|
1085
|
-
"documentation": " \n <p>Bundles an Amazon instance store-backed Windows instance.</p>\n <p>During bundling, only the root device volume (C:\\) is bundled. Data on other\n\t\t\t\tinstance store volumes is not preserved.</p>\n <note>\n <p>This procedure is not applicable for Linux/Unix instances or Windows instances\n that are backed by Amazon EBS.</p>\n\t\t\t</note>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/Creating_InstanceStoreBacked_WinAMI.html\">Creating an Instance Store-Backed Windows AMI</a>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example request bundles the specified instance.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=BundleInstance\n&InstanceId=i-e468cd8d\n&Storage.S3.AWSAccessKeyId='AKIAIOSFODNN7EXAMPLE'\n&Storage.S3.Bucket=myawsbucket \n&Storage.S3.Prefix=winami\n&Storage.S3.UploadPolicy=eyJleHBpcmF0aW9uIjogIjIwMDgtMDgtMzBUMDg6NDk6MD\nlaIiwiY29uZGl0aW9ucyI6IFt7ImJ1Y2tldCI6ICJteS1idWNrZXQifSxbInN0YXJ0cy13aXRoIiwgI\niRrZXkiLCAibXktbmV3LWltYWdlIl0seyJhY2wiOiAiZWMyLWJ1bmRsZS1yZWFkIn1dfEXAMPLE\n&Storage.S3.UploadPolicySignature=fh5tyyyQD8W4COEthj3nlGNEXAMPLE \n&AUTHPARAMS</queryrequest>\n <queryresponse><BundleInstanceResponse xmlns=\"http://ec2.amazonaws.com/doc/
|
|
1085
|
+
"documentation": " \n <p>Bundles an Amazon instance store-backed Windows instance.</p>\n <p>During bundling, only the root device volume (C:\\) is bundled. Data on other\n\t\t\t\tinstance store volumes is not preserved.</p>\n <note>\n <p>This procedure is not applicable for Linux/Unix instances or Windows instances\n that are backed by Amazon EBS.</p>\n\t\t\t</note>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/Creating_InstanceStoreBacked_WinAMI.html\">Creating an Instance Store-Backed Windows AMI</a>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>\n <p>This example request bundles the specified instance.</p>\n <p>Before you specify a value for your access key ID, review and follow the guidance \n in <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html\">Best Practices for Managing AWS Access Keys</a>.</p>\n </description>\n <queryrequest>https://ec2.amazonaws.com/?Action=BundleInstance\n&InstanceId=i-e468cd8d\n&Storage.S3.AWSAccessKeyId='AKIAIOSFODNN7EXAMPLE'\n&Storage.S3.Bucket=myawsbucket \n&Storage.S3.Prefix=winami\n&Storage.S3.UploadPolicy=eyJleHBpcmF0aW9uIjogIjIwMDgtMDgtMzBUMDg6NDk6MD\nlaIiwiY29uZGl0aW9ucyI6IFt7ImJ1Y2tldCI6ICJteS1idWNrZXQifSxbInN0YXJ0cy13aXRoIiwgI\niRrZXkiLCAibXktbmV3LWltYWdlIl0seyJhY2wiOiAiZWMyLWJ1bmRsZS1yZWFkIn1dfEXAMPLE\n&Storage.S3.UploadPolicySignature=fh5tyyyQD8W4COEthj3nlGNEXAMPLE \n&AUTHPARAMS</queryrequest>\n <queryresponse><BundleInstanceResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <bundleInstanceTask>\n <instanceId>i-12345678</instanceId>\n <bundleId>bun-c1a540a8</bundleId>\n <state>bundling</state>\n <startTime>2008-10-07T11:41:50.000Z</startTime>\n <updateTime>2008-10-07T11:51:50.000Z</updateTime>\n <progress>70%</progress>\n <storage>\n <S3>\n <bucket>myawsbucket</bucket>\n <prefix>winami</prefix>\n </S3>\n </storage>\n </bundleInstanceTask>\n</BundleInstanceResponse></queryresponse>\n </example>\n </examples>\n "
|
|
1086
1086
|
},
|
|
1087
1087
|
"CancelBundleTask": {
|
|
1088
1088
|
"name": "CancelBundleTask",
|
|
@@ -1174,7 +1174,7 @@
|
|
|
1174
1174
|
"AWSAccessKeyId": {
|
|
1175
1175
|
"shape_name": "String",
|
|
1176
1176
|
"type": "string",
|
|
1177
|
-
"documentation": "\n <p>The access key ID of the owner of the bucket
|
|
1177
|
+
"documentation": "\n <p>The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance \n in <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html\">Best Practices for Managing AWS Access Keys</a>.</p>\n "
|
|
1178
1178
|
},
|
|
1179
1179
|
"UploadPolicy": {
|
|
1180
1180
|
"shape_name": "String",
|
|
@@ -1231,7 +1231,7 @@
|
|
|
1231
1231
|
"errors": [
|
|
1232
1232
|
|
|
1233
1233
|
],
|
|
1234
|
-
"documentation": " \n <p>Cancels a bundling operation for an instance store-backed Windows instance.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example request cancels the specified bundle task.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CancelBundleTask\n&BundleId=bun-cla322b9\n&AUTHPARAMS</queryrequest>\n <queryresponse><CancelBundleTaskResponse xmlns=\"http://ec2.amazonaws.com/doc/
|
|
1234
|
+
"documentation": " \n <p>Cancels a bundling operation for an instance store-backed Windows instance.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example request cancels the specified bundle task.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CancelBundleTask\n&BundleId=bun-cla322b9\n&AUTHPARAMS</queryrequest>\n <queryresponse><CancelBundleTaskResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <bundleInstanceTask>\n <instanceId>i-12345678</instanceId>\n <bundleId>bun-cla322b9</bundleId>\n <state>canceling</state>\n <startTime>2008-10-07T11:41:50.000Z</startTime>\n <updateTime>2008-10-07T11:51:50.000Z</updateTime>\n <progress>20%</progress>\n <storage>\n <S3>\n <bucket>myawsbucket</bucket>\n <prefix>my-new-image</prefix>\n </S3>\n </storage>\n </bundleInstanceTask>\n</CancelBundleTaskResponse></queryresponse>\n </example>\n </examples>\n "
|
|
1235
1235
|
},
|
|
1236
1236
|
"CancelConversionTask": {
|
|
1237
1237
|
"name": "CancelConversionTask",
|
|
@@ -1647,7 +1647,7 @@
|
|
|
1647
1647
|
"errors": [
|
|
1648
1648
|
|
|
1649
1649
|
],
|
|
1650
|
-
"documentation": " \n <p>Initiates the copy of an AMI from the specified source region to the region in\n\t\t\t\twhich the request was made.</p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html\">Copying AMIs</a>\n in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example request copies the AMI in <code>us-west-2</code> with the ID <code>ami-1a2b3c4d</code>,\n\t\t\t\t\tnaming the new AMI <code>My-Standard-AMI</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CopyImage\n&SourceRegion=us-west-2\n&SourceImageId=ami-1a2b3c4d \n&Name=My-Standard-AMI\n&Description=This%20is%20the%20new%20version%20of%20My-Standard-AMI \n&ClientToken=550e8400-e29b-41d4-a716-446655440000\n&AUTHPARAMS</queryrequest>\n <queryresponse><CopyImageResponse xmlns=\"http://ec2.amazonaws.com/doc/
|
|
1650
|
+
"documentation": " \n <p>Initiates the copy of an AMI from the specified source region to the region in\n\t\t\t\twhich the request was made.</p>\n <p>In cross-region copy operations, the AMI is copied from the region specified with the --source-region option to \n the region specified with the <code>--region</code> option or the <code>EC2_URL</code> environment variable.</p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html\">Copying AMIs</a>\n in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example request copies the AMI in <code>us-west-2</code> with the ID <code>ami-1a2b3c4d</code>,\n\t\t\t\t\tnaming the new AMI <code>My-Standard-AMI</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CopyImage\n&SourceRegion=us-west-2\n&SourceImageId=ami-1a2b3c4d \n&Name=My-Standard-AMI\n&Description=This%20is%20the%20new%20version%20of%20My-Standard-AMI \n&ClientToken=550e8400-e29b-41d4-a716-446655440000\n&AUTHPARAMS</queryrequest>\n <queryresponse><CopyImageResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>60bc441d-fa2c-494d-b155-5d6a3EXAMPLE</requestId>\n <imageId>ami-4d3c2b1a</imageId>\n</CopyImageResponse></queryresponse>\n </example>\n </examples>\n "
|
|
1651
1651
|
},
|
|
1652
1652
|
"CopySnapshot": {
|
|
1653
1653
|
"name": "CopySnapshot",
|
|
@@ -1938,7 +1938,7 @@
|
|
|
1938
1938
|
"errors": [
|
|
1939
1939
|
|
|
1940
1940
|
],
|
|
1941
|
-
"documentation": "\n\t\t <p>Creates a set of DHCP options for your VPC. After creating the set, you must\n\t\t\t\tassociate it with the VPC, causing all existing and new instances that you launch in\n\t\t\t\tthe VPC to use this set of DHCP options. The following are the individual DHCP\n\t\t\t\toptions you can specify. For more information about the options, see <a href=\"http://www.ietf.org/rfc/rfc2132.txt\">RFC 2132</a>.</p>\n <p>For more information about DHCP options, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html\">DHCP Options Sets</a>\n\t\t\t\tin the <i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example creates a set of DHCP options with a domain name
|
|
1941
|
+
"documentation": "\n\t\t <p>Creates a set of DHCP options for your VPC. After creating the set, you must\n\t\t\t\tassociate it with the VPC, causing all existing and new instances that you launch in\n\t\t\t\tthe VPC to use this set of DHCP options. The following are the individual DHCP\n\t\t\t\toptions you can specify. For more information about the options, see <a href=\"http://www.ietf.org/rfc/rfc2132.txt\">RFC 2132</a>.</p>\n <ul>\n <li>\n<code>domain-name-servers</code> - The IP addresses of up to four domain name servers, or\n <code>AmazonProvidedDNS</code>. The default DHCP option set specifies\n <code>AmazonProvidedDNS</code>. If specifying more than one domain name server, specify\n the IP addresses in a single parameter, separated by commas.</li>\n <li>\n<code>domain-name</code> - If you're using AmazonProvidedDNS in <code>us-east-1</code>,\n specify <code>ec2.internal</code>. If you're using AmazonProvidedDNS in another region,\n specify <code>region.compute.internal</code> (for example,\n <code>ap-northeast-1.compute.internal</code>). Otherwise, specify a domain name (for\n example, <code>MyCompany.com</code>).</li>\n <li>\n<code>ntp-servers</code> - The IP addresses of up to four Network Time Protocol (NTP)\n servers.</li>\n <li>\n<code>netbios-name-servers</code> - The IP addresses of up to four NetBIOS name\n servers.</li>\n <li>\n<code>netbios-node-type</code> - The NetBIOS node type (1, 2, 4, or 8). We recommend that\n you specify 2 (broadcast and multicast are not currently supported). For more information\n about these node types, see <a href=\"http://www.ietf.org/rfc/rfc2132.txt\">RFC 2132</a>. </li>\n </ul>\n <p>For more information about DHCP options, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_DHCP_Options.html\">DHCP Options Sets</a>\n\t\t\t\tin the <i>Amazon Virtual Private Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example creates a set of DHCP options with a domain name\n <code>example.com</code> and two DNS servers (<code>10.2.5.1</code> and\n <code>10.2.5.2</code>). The DNS servers' IP addresses are specified in a single\n parameter, separated by commas, to preserve the order in which they are\n specified.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateDhcpOptions \n&DhcpConfiguration.1.Key=domain-name\n&DhcpConfiguration.1.Value.1=example.com\n&DhcpConfiguration.2.Key=domain-name-servers\n&DhcpConfiguration.2.Value.1=10.2.5.1,10.2.5.2\n&AUTHPARAMS</queryrequest>\n <queryresponse><CreateDhcpOptionsResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>\n <dhcpOptions>\n <dhcpOptionsId>dopt-7a8b9c2d</dhcpOptionsId>\n <dhcpConfigurationSet>\n <item>\n <key>domain-name</key>\n <valueSet>\n <item>\n <value>example.com</value>\n </item>\n </valueSet>\n </item>\n <item>\n <key>domain-name-servers</key>\n <valueSet>\n <item>\n <value>10.2.5.1</value>\n </item>\n <item>\n <value>10.2.5.2</value>\n </item>\n </valueSet>\n </item>\n </dhcpConfigurationSet>\n <tagSet/>\n </dhcpOptions>\n</CreateDhcpOptionsResponse></queryresponse>\n </example>\n </examples>\n "
|
|
1942
1942
|
},
|
|
1943
1943
|
"CreateImage": {
|
|
1944
1944
|
"name": "CreateImage",
|
|
@@ -2057,7 +2057,7 @@
|
|
|
2057
2057
|
"errors": [
|
|
2058
2058
|
|
|
2059
2059
|
],
|
|
2060
|
-
"documentation": " \n <p>Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either\n\t\t\t\trunning or stopped.</p>\n <p>If you customized your instance with instance store volumes or EBS volumes\n\t\t\t\tin addition to the root device volume, the new AMI contains block device mapping\n\t\t\t\tinformation for those volumes. When you launch an instance from this new AMI,\n\t\t\t\tthe instance automatically launches with those additional volumes.</p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html\">Creating Amazon EBS-Backed Linux AMIs</a> \n\t\t\t\tin the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example request creates an AMI from the specified instance.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateImage\n&Description=Standard+Web+Server+v1.0\n&InstanceId=i-10a64379\n&Name=standard-web-server-v1.0\n&AUTHPARAMS</queryrequest>\n <queryresponse><CreateImageResponse xmlns=\"http://ec2.amazonaws.com/doc/
|
|
2060
|
+
"documentation": " \n <p>Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either\n\t\t\t\trunning or stopped.</p>\n <p>If you customized your instance with instance store volumes or EBS volumes\n\t\t\t\tin addition to the root device volume, the new AMI contains block device mapping\n\t\t\t\tinformation for those volumes. When you launch an instance from this new AMI,\n\t\t\t\tthe instance automatically launches with those additional volumes.</p>\n <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html\">Creating Amazon EBS-Backed Linux AMIs</a> \n\t\t\t\tin the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example request creates an AMI from the specified instance.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=CreateImage\n&Description=Standard+Web+Server+v1.0\n&InstanceId=i-10a64379\n&Name=standard-web-server-v1.0\n&AUTHPARAMS</queryrequest>\n <queryresponse><CreateImageResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <imageId>ami-4fa54026</imageId>\n</CreateImageResponse></queryresponse>\n </example>\n </examples>\n "
|
|
2061
2061
|
},
|
|
2062
2062
|
"CreateInstanceExportTask": {
|
|
2063
2063
|
"name": "CreateInstanceExportTask",
|
|
@@ -2945,7 +2945,7 @@
|
|
|
2945
2945
|
"PublicDnsName": {
|
|
2946
2946
|
"shape_name": "String",
|
|
2947
2947
|
"type": "string",
|
|
2948
|
-
"documentation":
|
|
2948
|
+
"documentation": "\n\t\t<p>The public DNS name.</p>\n\t",
|
|
2949
2949
|
"xmlname": "publicDnsName"
|
|
2950
2950
|
},
|
|
2951
2951
|
"IpOwnerId": {
|
|
@@ -3034,7 +3034,7 @@
|
|
|
3034
3034
|
"PublicDnsName": {
|
|
3035
3035
|
"shape_name": "String",
|
|
3036
3036
|
"type": "string",
|
|
3037
|
-
"documentation":
|
|
3037
|
+
"documentation": "\n\t\t<p>The public DNS name.</p>\n\t",
|
|
3038
3038
|
"xmlname": "publicDnsName"
|
|
3039
3039
|
},
|
|
3040
3040
|
"IpOwnerId": {
|
|
@@ -5541,7 +5541,7 @@
|
|
|
5541
5541
|
"errors": [
|
|
5542
5542
|
|
|
5543
5543
|
],
|
|
5544
|
-
"documentation": " \n <p>Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch\n\t\t\t\tnew instances.</p>\n <p>This command does not delete the AMI.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example request deregisters the specified AMI.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DeregisterImage\n&ImageId=ami-4fa54026\n&AUTHPARAMS</queryrequest>\n <queryresponse><DeregisterImageResponse xmlns=\"http://ec2.amazonaws.com/doc/
|
|
5544
|
+
"documentation": " \n <p>Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch\n\t\t\t\tnew instances.</p>\n <p>This command does not delete the AMI.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example request deregisters the specified AMI.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DeregisterImage\n&ImageId=ami-4fa54026\n&AUTHPARAMS</queryrequest>\n <queryresponse><DeregisterImageResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</DeregisterImageResponse></queryresponse>\n </example>\n </examples>\n "
|
|
5545
5545
|
},
|
|
5546
5546
|
"DescribeAccountAttributes": {
|
|
5547
5547
|
"name": "DescribeAccountAttributes",
|
|
@@ -6026,7 +6026,7 @@
|
|
|
6026
6026
|
"AWSAccessKeyId": {
|
|
6027
6027
|
"shape_name": "String",
|
|
6028
6028
|
"type": "string",
|
|
6029
|
-
"documentation": "\n <p>The access key ID of the owner of the bucket
|
|
6029
|
+
"documentation": "\n <p>The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance \n in <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html\">Best Practices for Managing AWS Access Keys</a>.</p>\n "
|
|
6030
6030
|
},
|
|
6031
6031
|
"UploadPolicy": {
|
|
6032
6032
|
"shape_name": "String",
|
|
@@ -6086,7 +6086,7 @@
|
|
|
6086
6086
|
"errors": [
|
|
6087
6087
|
|
|
6088
6088
|
],
|
|
6089
|
-
"documentation": " \n <p>Describes one or more of your bundling tasks.</p>\n <note><p>Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use <code>RegisterImage</code> with the Amazon S3 bucket name and image manifest name you provided to the bundle task.</p></note>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example describes the status of the specified bundle task.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeBundleTasks\n&bundleId.1=bun-c1a540a8\n&AUTHPARAMS</queryrequest>\n <queryresponse><DescribeBundleTasksResponse xmlns=\"http://ec2.amazonaws.com/doc/
|
|
6089
|
+
"documentation": " \n <p>Describes one or more of your bundling tasks.</p>\n <note><p>Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use <code>RegisterImage</code> with the Amazon S3 bucket name and image manifest name you provided to the bundle task.</p></note>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example describes the status of the specified bundle task.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeBundleTasks\n&bundleId.1=bun-c1a540a8\n&AUTHPARAMS</queryrequest>\n <queryresponse><DescribeBundleTasksResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <bundleInstanceTasksSet>\n <item>\n <instanceId>i-12345678</instanceId>\n <bundleId>bun-c1a540a8</bundleId>\n <state>cancelling</state>\n <startTime>2008-10-07T11:41:50.000Z</startTime>\n <updateTime>2008-10-07T11:51:50.000Z</updateTime>\n <storage>\n <S3>\n <bucket>myawsbucket</bucket>\n <prefix>winami</prefix>\n </S3>\n </storage>\n <progress>20%</progress>\n </item>\n <bundleInstanceTasksSet>\n</DescribeBundleTasksResponse></queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example filters the response to include only bundle tasks whose state is either <code>complete</code> or <code>failed</code>, and in addition are targeted for the Amazon S3 bucket named <code>myawsbucket</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeBundleTasks\n&Filter.1.Name=s3-bucket\n&Filter.1.Value.1=myawsbucket\n&Filter.2.Name=state\n&Filter.2.Name.1=complete\n&Filter.2.Name.2=failed\n&AUTHPARAMS</queryrequest>\n </example>\n </examples>\n "
|
|
6090
6090
|
},
|
|
6091
6091
|
"DescribeConversionTasks": {
|
|
6092
6092
|
"name": "DescribeConversionTasks",
|
|
@@ -7128,7 +7128,7 @@
|
|
|
7128
7128
|
"errors": [
|
|
7129
7129
|
|
|
7130
7130
|
],
|
|
7131
|
-
"documentation": " \n <p>Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example lists the launch permissions for the specified AMI.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeImageAttribute\n&ImageId=ami-61a54008\n&Attribute=launchPermission\n&AUTHPARAMS</queryrequest>\n <queryresponse><DescribeImageAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/
|
|
7131
|
+
"documentation": " \n <p>Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example lists the launch permissions for the specified AMI.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeImageAttribute\n&ImageId=ami-61a54008\n&Attribute=launchPermission\n&AUTHPARAMS</queryrequest>\n <queryresponse><DescribeImageAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <imageId>ami-61a54008</imageId>\n <launchPermission>\n <item>\n <group>all</group>\n </item>\n <item>\n <userId>495219933132</userId>\n </item>\n </launchPermission>\n</DescribeImageAttributeResponse></queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example lists the product codes for the specified AMI.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeImageAttribute\n&ImageId=ami-2bb65342\n&Attribute=productCodes\n&AUTHPARAMS</queryrequest>\n <queryresponse><DescribeImageAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/>\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <imageId>ami-2bb65342</imageId>\n <productCodes> \n <item>\n <productCode>a1b2c3d4e5f6g7h8i9j10k11</productCode>\n <type>marketplace</type>\n </item> \n </productCodes> \n</DescribeImageAttributeResponse></queryresponse>\n </example>\n </examples>\n "
|
|
7132
7132
|
},
|
|
7133
7133
|
"DescribeImages": {
|
|
7134
7134
|
"name": "DescribeImages",
|
|
@@ -7521,7 +7521,7 @@
|
|
|
7521
7521
|
"errors": [
|
|
7522
7522
|
|
|
7523
7523
|
],
|
|
7524
|
-
"documentation": " \n <p>Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to\n\t\t\t\tyou include public images, private images that you own, and private images owned by\n\t\t\t\tother AWS accounts but for which you have explicit launch permissions.</p>\n <note><p>Deregistered images are included in the returned results for an unspecified interval after deregistration.</p></note>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example describes the specified AMI.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeImages\n&ImageId.1=ami-be3adfd7\n&AUTHPARAMS</queryrequest>\n <queryresponse><DescribeImagesResponse xmlns=\"http://ec2.amazonaws.com/doc/
|
|
7524
|
+
"documentation": " \n <p>Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to\n\t\t\t\tyou include public images, private images that you own, and private images owned by\n\t\t\t\tother AWS accounts but for which you have explicit launch permissions.</p>\n <note><p>Deregistered images are included in the returned results for an unspecified interval after deregistration.</p></note>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example describes the specified AMI.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeImages\n&ImageId.1=ami-be3adfd7\n&AUTHPARAMS</queryrequest>\n <queryresponse><DescribeImagesResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <imagesSet>\n <item>\n <imageId>ami-1a2b3c4d</imageId>\n <imageLocation>amazon/getting-started</imageLocation>\n <imageState>available</imageState>\n <imageOwnerId>123456789012</imageOwnerId>\n <isPublic>true</isPublic>\n <architecture>i386</architecture>\n <imageType>machine</imageType>\n <kernelId>aki-1a2b3c4d</kernelId>\n <ramdiskId>ari-1a2b3c4d</ramdiskId>\n <imageOwnerAlias>amazon</imageOwnerAlias>\n <name>getting-started</name>\n <description>Image Description</description>\n <rootDeviceType>ebs</rootDeviceType>\n <rootDeviceName>/dev/sda</rootDeviceName>\n <blockDeviceMapping>\n <item>\n <deviceName>/dev/sda1</deviceName>\n <ebs>\n <snapshotId>snap-1a2b3c4d</snapshotId>\n <volumeSize>15</volumeSize>\n <deleteOnTermination>false</deleteOnTermination>\n <volumeType>standard</volumeType>\n </ebs>\n </item>\n </blockDeviceMapping>\n <virtualizationType>paravirtual</virtualizationType>\n <tagSet/>\n <hypervisor>xen</hypervisor>\n </item>\n </imagesSet>\n</DescribeImagesResponse></queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example filters the response to include only public Windows images with an <code>x86_64</code> architecture.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeImages\n&Filter.1.Name=is-public\n&Filter.1.Value.1=true\n&Filter.2.Name=architecture\n&Filter.2.Value.1=x86_64\n&Filter.3.Name=platform\n&Filter.3.Value.1=windows\n&AUTHPARAMS</queryrequest>\n <queryresponse><DescribeImagesResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <imagesSet>\n <item>\n <imageId>ami-1a2b3c4d</imageId>\n <imageLocation>ec2-public-windows-images/Server2003r2-x86_64-Win-v1.07.manifest.xml</imageLocation>\n <imageState>available</imageState>\n <imageOwnerId>123456789012</imageOwnerId>\n <isPublic>true</isPublic>\n <architecture>x86_64</architecture>\n <imageType>machine</imageType>\n <platform>windows</platform>\n <imageOwnerAlias>amazon</imageOwnerAlias>\n <rootDeviceType>instance-store</rootDeviceType>\n <blockDeviceMapping/>\n <virtualizationType>hvm</virtualizationType>\n <tagSet/>\n <hypervisor>xen</hypervisor>\n </item>\n ...\n </imagesSet>\n</DescribeImagesResponse></queryresponse>\n </example>\n <example>\n <name>Example 3</name>\n <description>This example returns the results to display images where the owner is\n\t\t\t\t\t\t<code>aws-marketplace</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=DescribeImages\n&Owner.0=aws-marketplace\n&AUTHPARAMS</queryrequest>\n <queryresponse><DescribeImagesResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>4a4a27a2-2e7c-475d-b35b-ca822EXAMPLE</requestId>\n <imagesSet>\n <item>\n <imageId>ami-1a2b3c4d</imageId>\n <imageLocation>aws-marketplace/example-marketplace-amzn-ami.1</imageLocation>\n <imageState>available</imageState>\n <imageOwnerId>123456789012</imageOwnerId>\n <isPublic>true</isPublic>\n <productCodes>\n <item>\n <productCode>a1b2c3d4e5f6g7h8i9j10k11</productCode>\n <type>marketplace</type>\n </item>\n </productCodes>\n <architecture>i386</architecture>\n <imageType>machine</imageType>\n <kernelId>aki-1a2b3c4d</kernelId>\n <imageOwnerAlias>aws-marketplace</imageOwnerAlias>\n <name>example-marketplace-amzn-ami.1</name>\n <description>Amazon Linux AMI i386 EBS</description>\n <rootDeviceType>ebs</rootDeviceType>\n <rootDeviceName>/dev/sda1</rootDeviceName>\n <blockDeviceMapping>\n <item>\n <deviceName>/dev/sda1</deviceName>\n <ebs>\n <snapshotId>snap-1a2b3c4d</snapshotId>\n <volumeSize>8</volumeSize>\n <deleteOnTermination>true</deleteOnTermination>\n </ebs>\n </item>\n </blockDeviceMapping>\n <virtualizationType>paravirtual</virtualizationType>\n <hypervisor>xen</hypervisor>\n </item>\n ...\n </imagesSet>\n</DescribeImagesResponse></queryresponse>\n </example>\n </examples>\n "
|
|
7525
7525
|
},
|
|
7526
7526
|
"DescribeInstanceAttribute": {
|
|
7527
7527
|
"name": "DescribeInstanceAttribute",
|
|
@@ -8102,7 +8102,7 @@
|
|
|
8102
8102
|
"errors": [
|
|
8103
8103
|
|
|
8104
8104
|
],
|
|
8105
|
-
"documentation": "\n <p>Describes the status of one or more instances, including any scheduled events.</p>\n\t\t\t<p>Instance status has two main components:</p>\n\t\t\t<ul>\n\t\t\t\t<li>\n\t\t\t\t\t<p>System Status reports impaired functionality that stems from issues\n\t\t\t\t\t\trelated to the systems that support an instance, such as such as hardware\n\t\t\t\t\t\tfailures and network connectivity problems. This call reports\n\t\t\t\t\t\tsuch problems as impaired reachability.</p>\n\t\t\t\t</li>\n\t\t\t\t<li>\n\t\t\t\t\t<p>Instance Status reports impaired functionality that arises from\n\t\t\t\t\t\tproblems internal to the instance. This call reports\n\t\t\t\t\t\tsuch problems as impaired reachability.</p>\n\t\t\t\t</li>\n\t\t\t</ul>\n <p>Instance status provides information about four types of scheduled events for an\n instance that may require your attention:</p>\n\t\t\t<ul>\n\t\t\t\t<li>\n\t\t\t\t\t<p>Scheduled Reboot: When Amazon EC2 determines that an instance must be rebooted, the\n\t\t\t\t\t\tinstances status returns one of two event codes:\n\t\t\t\t\t\t<code>system-reboot</code> or <code>instance-reboot</code>. System\n\t\t\t\t\t\treboot commonly occurs if certain maintenance or upgrade operations require\n\t\t\t\t\t\ta reboot of the underlying host that supports an instance. Instance reboot\n\t\t\t\t\t\tcommonly occurs if the instance must be rebooted, rather than the underlying\n\t\t\t\t\t\thost. Rebooting events include a scheduled start and end time.</p>\n\t\t\t\t</li>\n\t\t\t\t<li>\n\t\t\t\t\t<p>System Maintenance: When Amazon EC2 determines that an instance requires maintenance that\n\t\t\t\t\t\trequires power or network impact, the instance status is the event\n\t\t\t\t\t\tcode <code>system-maintenance</code>. System maintenance is either\n\t\t\t\t\t\tpower maintenance or network maintenance. For power maintenance, your\n\t\t\t\t\t\tinstance will be unavailable for a brief period of time and then rebooted.\n\t\t\t\t\t\tFor network maintenance, your instance will experience a brief loss of\n\t\t\t\t\t\tnetwork connectivity. System maintenance events include a scheduled start\n\t\t\t\t\t\tand end time. You will also be notified by email if one of your instances is\n\t\t\t\t\t\tset for system maintenance. The email message indicates when your instance\n\t\t\t\t\t\tis scheduled for maintenance.</p>\n\t\t\t\t</li>\n\t\t\t\t<li>\n\t\t\t\t\t<p>Scheduled Retirement: When Amazon EC2 determines that an instance must be shut down, the\n\t\t\t\t\t\tinstance status is the event code\n\t\t\t\t\t\t<code>instance-retirement</code>. Retirement commonly occurs when the\n\t\t\t\t\t\tunderlying host is degraded and must be replaced. Retirement events include\n\t\t\t\t\t\ta scheduled start and end time. You will also be notified by email if one of\n\t\t\t\t\t\tyour instances is set to retiring. The email message indicates when your\n\t\t\t\t\t\tinstance will be permanently retired.</p>\n\t\t\t\t</li>\n\t\t\t\t<li>\n\t\t\t\t\t<p>Scheduled Stop: When Amazon EC2 determines that an instance must be shut down, the\n\t\t\t\t\t\tinstances status returns an event code called <code>instance-stop</code>.\n\t\t\t\t\t\tStop events include a scheduled start and end time. You will also be\n\t\t\t\t\t\tnotified by email if one of your instances is set to stop. The email message\n\t\t\t\t\t\tindicates when your instance will be stopped.</p>\n\t\t\t\t</li>\n\t\t\t</ul>\n\n\t\t\t<p>When your instance is retired, it will either be terminated (if its root device type is the\n\t\t\t\tinstance-store) or stopped (if its root device type is an EBS volume). Instances\n\t\t\t\tstopped due to retirement will not be restarted, but you can do so manually. You can\n\t\t\t\talso avoid retirement of EBS-backed instances by manually restarting your instance\n\t\t\t\twhen its event code is <code>instance-retirement</code>. This ensures that your\n\t\t\t\tinstance is started on a different underlying host.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example returns instance status descriptions for all instances.</description>\n <queryrequest>https://ec2.amazonaws.com/?\nAction=DescribeInstanceStatus\n&AUTHPARAMS</queryrequest>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example returns instance status descriptions for the specified instances.</description>\n <queryrequest>https://ec2.amazonaws.com/?\nAction=DescribeInstanceStatus\n&InstanceId.0=i-1a2b3c4d\n&InstanceId.1=i-2a2b3c4d\n&AUTHPARAMS</queryrequest>\n </example>\n <example>\n <name>Example 3</name>\n <description>This example returns instance status descriptions for all instances specified\n\t\t\t\t\tby supported DescribeInstanceStatus filters.</description>\n <queryrequest>https://ec2.amazonaws.com/?\nAction=DescribeInstanceStatus\n&Filter.0.Name=system-status.reachability\n&Filter.0.Value.failed\n&AUTHPARAMS</queryrequest>\n <queryresponse><DescribeInstanceStatusResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>3be1508e-c444-4fef-89cc-0b1223c4f02fEXAMPLE</requestId>\n <instanceStatusSet>\n <item>\n <instanceId>i-1a2b3c4d</instanceId>\n <availabilityZone>us-east-1d</availabilityZone>\n <instanceState>\n <code>16</code>\n <name>running</name>\n </instanceState>\n <systemStatus>\n <status>impaired</status>\n <details>\n <item>\n <name>reachability</name>\n <status>failed</status>\n <impairedSince>YYYY-MM-DDTHH:MM:SS.000Z</impairedSince>\n </item>\n </details>\n </systemStatus>\n <instanceStatus>\n <status>impaired</status>\n <details>\n <item>\n <name>reachability</name>\n <status>failed</status>\n <impairedSince>YYYY-MM-DDTHH:MM:SS.000Z</impairedSince>\n </item>\n </details>\n </instanceStatus>\n <eventsSet>\n <item>\n <code>instance-retirement</code>\n <description>The instance is running on degraded hardware</description>\n <notBefore>YYYY-MM-DDTHH:MM:SS+0000</notBefore>\n <notAfter>YYYY-MM-DDTHH:MM:SS+0000</notAfter>\n </item>\n </eventsSet>\n </item>\n <item>\n <instanceId>i-2a2b3c4d</instanceId>\n <availabilityZone>us-east-1d</availabilityZone>\n <instanceState>\n <code>16</code>\n <name>running</name>\n </instanceState>\n <systemStatus>\n <status>ok</status>\n <details>\n <item>\n <name>reachability</name>\n <status>passed</status>\n </item>\n </details>\n </systemStatus>\n <instanceStatus>\n <status>ok</status>\n <details>\n <item>\n <name>reachability</name>\n <status>passed</status>\n </item>\n </details>\n </instanceStatus>\n <eventsSet>\n <item>\n <code>instance-reboot</code>\n <description>The instance is scheduled for a reboot</description>\n <notBefore>YYYY-MM-DDTHH:MM:SS+0000</notBefore>\n <notAfter>YYYY-MM-DDTHH:MM:SS+0000</notAfter>\n </item>\n </eventsSet>\n </item>\n <item>\n <instanceId>i-3a2b3c4d</instanceId>\n <availabilityZone>us-east-1d</availabilityZone>\n <instanceState>\n <code>16</code>\n <name>running</name>\n </instanceState>\n <systemStatus>\n <status>ok</status>\n <details>\n <item>\n <name>reachability</name>\n <status>passed</status>\n </item>\n </details>\n </systemStatus>\n <instanceStatus>\n <status>ok</status>\n <details>\n <item>\n <name>reachability</name>\n <status>passed</status>\n </item>\n </details>\n </instanceStatus>\n </item>\n <item>\n <instanceId>i-4a2b3c4d</instanceId>\n <availabilityZone>us-east-1d</availabilityZone>\n <instanceState>\n <code>16</code>\n <name>running</name>\n </instanceState>\n <systemStatus>\n <status>ok</status>\n <details>\n <item>\n <name>reachability</name>\n <status>passed</status>\n </item>\n </details>\n </systemStatus>\n <instanceStatus>\n <status>insufficient-data</status>\n <details>\n <item>\n <name>reachability</name>\n <status>insufficient-data</status>\n </item>\n </details>\n </instanceStatus>\n </item>\n </instanceStatusSet>\n</DescribeInstanceStatusResponse></queryresponse>\n </example>\n </examples>\n\t "
|
|
8105
|
+
"documentation": "\n <p>Describes the status of one or more instances, including any scheduled events.</p>\n\t\t\t<p>Instance status has two main components:</p>\n\t\t\t<ul>\n\t\t\t\t<li>\n\t\t\t\t\t<p>System Status reports impaired functionality that stems from issues\n\t\t\t\t\t\trelated to the systems that support an instance, such as such as hardware\n\t\t\t\t\t\tfailures and network connectivity problems. This call reports\n\t\t\t\t\t\tsuch problems as impaired reachability.</p>\n\t\t\t\t</li>\n\t\t\t\t<li>\n\t\t\t\t\t<p>Instance Status reports impaired functionality that arises from\n\t\t\t\t\t\tproblems internal to the instance. This call reports\n\t\t\t\t\t\tsuch problems as impaired reachability.</p>\n\t\t\t\t</li>\n\t\t\t</ul>\n <p>Instance status provides information about four types of scheduled events for an\n instance that may require your attention:</p>\n\t\t\t<ul>\n\t\t\t\t<li>\n\t\t\t\t\t<p>Scheduled Reboot: When Amazon EC2 determines that an instance must be rebooted, the\n\t\t\t\t\t\tinstances status returns one of two event codes:\n\t\t\t\t\t\t<code>system-reboot</code> or <code>instance-reboot</code>. System\n\t\t\t\t\t\treboot commonly occurs if certain maintenance or upgrade operations require\n\t\t\t\t\t\ta reboot of the underlying host that supports an instance. Instance reboot\n\t\t\t\t\t\tcommonly occurs if the instance must be rebooted, rather than the underlying\n\t\t\t\t\t\thost. Rebooting events include a scheduled start and end time.</p>\n\t\t\t\t</li>\n\t\t\t\t<li>\n\t\t\t\t\t<p>System Maintenance: When Amazon EC2 determines that an instance requires maintenance that\n\t\t\t\t\t\trequires power or network impact, the instance status is the event\n\t\t\t\t\t\tcode <code>system-maintenance</code>. System maintenance is either\n\t\t\t\t\t\tpower maintenance or network maintenance. For power maintenance, your\n\t\t\t\t\t\tinstance will be unavailable for a brief period of time and then rebooted.\n\t\t\t\t\t\tFor network maintenance, your instance will experience a brief loss of\n\t\t\t\t\t\tnetwork connectivity. System maintenance events include a scheduled start\n\t\t\t\t\t\tand end time. You will also be notified by email if one of your instances is\n\t\t\t\t\t\tset for system maintenance. The email message indicates when your instance\n\t\t\t\t\t\tis scheduled for maintenance.</p>\n\t\t\t\t</li>\n\t\t\t\t<li>\n\t\t\t\t\t<p>Scheduled Retirement: When Amazon EC2 determines that an instance must be shut down, the\n\t\t\t\t\t\tinstance status is the event code\n\t\t\t\t\t\t<code>instance-retirement</code>. Retirement commonly occurs when the\n\t\t\t\t\t\tunderlying host is degraded and must be replaced. Retirement events include\n\t\t\t\t\t\ta scheduled start and end time. You will also be notified by email if one of\n\t\t\t\t\t\tyour instances is set to retiring. The email message indicates when your\n\t\t\t\t\t\tinstance will be permanently retired.</p>\n\t\t\t\t</li>\n\t\t\t\t<li>\n\t\t\t\t\t<p>Scheduled Stop: When Amazon EC2 determines that an instance must be shut down, the\n\t\t\t\t\t\tinstances status returns an event code called <code>instance-stop</code>.\n\t\t\t\t\t\tStop events include a scheduled start and end time. You will also be\n\t\t\t\t\t\tnotified by email if one of your instances is set to stop. The email message\n\t\t\t\t\t\tindicates when your instance will be stopped.</p>\n\t\t\t\t</li>\n\t\t\t</ul>\n\n\t\t\t<p>When your instance is retired, it will either be terminated (if its root device type is the\n\t\t\t\tinstance-store) or stopped (if its root device type is an EBS volume). Instances\n\t\t\t\tstopped due to retirement will not be restarted, but you can do so manually. You can\n\t\t\t\talso avoid retirement of EBS-backed instances by manually restarting your instance\n\t\t\t\twhen its event code is <code>instance-retirement</code>. This ensures that your\n\t\t\t\tinstance is started on a different underlying host.</p>\n <p>For more information about failed status checks, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstances.html\">Troubleshooting Instances with Failed Status Checks</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. For more information about working with scheduled events, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html#schedevents_actions\">Working with an Instance That Has a Scheduled Event</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example returns instance status descriptions for all instances.</description>\n <queryrequest>https://ec2.amazonaws.com/?\nAction=DescribeInstanceStatus\n&AUTHPARAMS</queryrequest>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example returns instance status descriptions for the specified instances.</description>\n <queryrequest>https://ec2.amazonaws.com/?\nAction=DescribeInstanceStatus\n&InstanceId.0=i-1a2b3c4d\n&InstanceId.1=i-2a2b3c4d\n&AUTHPARAMS</queryrequest>\n </example>\n <example>\n <name>Example 3</name>\n <description>This example returns instance status descriptions for all instances specified\n\t\t\t\t\tby supported DescribeInstanceStatus filters.</description>\n <queryrequest>https://ec2.amazonaws.com/?\nAction=DescribeInstanceStatus\n&Filter.0.Name=system-status.reachability\n&Filter.0.Value.failed\n&AUTHPARAMS</queryrequest>\n <queryresponse><DescribeInstanceStatusResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>3be1508e-c444-4fef-89cc-0b1223c4f02fEXAMPLE</requestId>\n <instanceStatusSet>\n <item>\n <instanceId>i-1a2b3c4d</instanceId>\n <availabilityZone>us-east-1d</availabilityZone>\n <instanceState>\n <code>16</code>\n <name>running</name>\n </instanceState>\n <systemStatus>\n <status>impaired</status>\n <details>\n <item>\n <name>reachability</name>\n <status>failed</status>\n <impairedSince>YYYY-MM-DDTHH:MM:SS.000Z</impairedSince>\n </item>\n </details>\n </systemStatus>\n <instanceStatus>\n <status>impaired</status>\n <details>\n <item>\n <name>reachability</name>\n <status>failed</status>\n <impairedSince>YYYY-MM-DDTHH:MM:SS.000Z</impairedSince>\n </item>\n </details>\n </instanceStatus>\n <eventsSet>\n <item>\n <code>instance-retirement</code>\n <description>The instance is running on degraded hardware</description>\n <notBefore>YYYY-MM-DDTHH:MM:SS+0000</notBefore>\n <notAfter>YYYY-MM-DDTHH:MM:SS+0000</notAfter>\n </item>\n </eventsSet>\n </item>\n <item>\n <instanceId>i-2a2b3c4d</instanceId>\n <availabilityZone>us-east-1d</availabilityZone>\n <instanceState>\n <code>16</code>\n <name>running</name>\n </instanceState>\n <systemStatus>\n <status>ok</status>\n <details>\n <item>\n <name>reachability</name>\n <status>passed</status>\n </item>\n </details>\n </systemStatus>\n <instanceStatus>\n <status>ok</status>\n <details>\n <item>\n <name>reachability</name>\n <status>passed</status>\n </item>\n </details>\n </instanceStatus>\n <eventsSet>\n <item>\n <code>instance-reboot</code>\n <description>The instance is scheduled for a reboot</description>\n <notBefore>YYYY-MM-DDTHH:MM:SS+0000</notBefore>\n <notAfter>YYYY-MM-DDTHH:MM:SS+0000</notAfter>\n </item>\n </eventsSet>\n </item>\n <item>\n <instanceId>i-3a2b3c4d</instanceId>\n <availabilityZone>us-east-1d</availabilityZone>\n <instanceState>\n <code>16</code>\n <name>running</name>\n </instanceState>\n <systemStatus>\n <status>ok</status>\n <details>\n <item>\n <name>reachability</name>\n <status>passed</status>\n </item>\n </details>\n </systemStatus>\n <instanceStatus>\n <status>ok</status>\n <details>\n <item>\n <name>reachability</name>\n <status>passed</status>\n </item>\n </details>\n </instanceStatus>\n </item>\n <item>\n <instanceId>i-4a2b3c4d</instanceId>\n <availabilityZone>us-east-1d</availabilityZone>\n <instanceState>\n <code>16</code>\n <name>running</name>\n </instanceState>\n <systemStatus>\n <status>ok</status>\n <details>\n <item>\n <name>reachability</name>\n <status>passed</status>\n </item>\n </details>\n </systemStatus>\n <instanceStatus>\n <status>insufficient-data</status>\n <details>\n <item>\n <name>reachability</name>\n <status>insufficient-data</status>\n </item>\n </details>\n </instanceStatus>\n </item>\n </instanceStatusSet>\n</DescribeInstanceStatusResponse></queryresponse>\n </example>\n </examples>\n\t "
|
|
8106
8106
|
},
|
|
8107
8107
|
"DescribeInstances": {
|
|
8108
8108
|
"name": "DescribeInstances",
|
|
@@ -9676,7 +9676,7 @@
|
|
|
9676
9676
|
"documentation": "\n ",
|
|
9677
9677
|
"xmlname": "Filter"
|
|
9678
9678
|
},
|
|
9679
|
-
"documentation": "\n\t\t <p>One or more filters.</p>\n\t\t <ul>\n\t\t <li>\n\t\t <p><code>addresses.private-ip-address</code> - The private IP addresses associated with the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>addresses.primary</code> - Whether the private IP address is the primary IP address associated with the network interface. </p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>addresses.association.public-ip</code> - The association ID returned when the network interface was associated with the Elastic IP address.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>addresses.association.owner-id</code> - The owner ID of the addresses associated with the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>association.association-id</code> - The association ID returned when the network interface was associated with an IP address.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>association.allocation-id</code> - The allocation ID returned when you allocated the Elastic IP address for your network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>association.ip-owner-id</code> - The owner of the Elastic IP address associated with the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>association.public-ip</code> - The address of the Elastic IP address bound to the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>attachment.attachment-id</code> - The ID of the interface attachment.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>attachment.instance-id</code> - The ID of the instance to which the network interface is attached.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>attachment.instance-owner-id</code> - The owner ID of the instance to which the network interface is attached.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>attachment.device-index</code> - The device index to which the network interface is attached.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>attachment.status</code> - The status of the attachment (<code>attaching</code> | <code>attached</code> | <code>detaching</code> | <code>detached</code>).</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>attachment.attach.time</code> - The time that the network interface was attached to an instance.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>attachment.delete-on-termination</code> - Indicates whether the attachment is deleted when an instance is terminated.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>availability-zone</code> - The Availability Zone of the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>description</code> - The description of the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>group-id</code> - The ID of a security group associated with the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>group-name</code> - The name of a security group associated with the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>mac-address</code> - The MAC address of the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>network-interface-id</code> - The ID of the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>owner-id</code> - The AWS account ID of the network interface owner.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>private-ip-address</code> - The private IP address or addresses of the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>private-dns-name</code> - The private DNS name of the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>requester-id</code> - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>requester-managed</code> - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>source-desk-check</code> - Indicates whether the network interface performs source/destination checking. \n\t\t A value of <code>true</code> means checking is enabled, and <code>false</code> means checking is disabled. \n\t\t The value must be <code>false</code> for the network interface to perform Network Address Translation (NAT) in your VPC. </p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>status</code> - The status of the network interface. If the network interface is not attached to an instance, the status is <code>available</code>; \n\t\t if a network interface is attached to an instance the status is <code>in-use</code>.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>subnet-id</code> - The ID of the subnet for the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. \n\t\t For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n\t\t the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n\t\t If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>vpc-id</code> - The ID of the VPC for the network interface.</p>\n\t\t </li>\n\t\t </ul>\n ",
|
|
9679
|
+
"documentation": "\n\t\t <p>One or more filters.</p>\n\t\t <ul>\n\t\t <li>\n\t\t <p><code>addresses.private-ip-address</code> - The private IP addresses associated with the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>addresses.primary</code> - Whether the private IP address is the primary IP address associated with the network interface. </p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>addresses.association.public-ip</code> - The association ID returned when the network interface was associated with the Elastic IP address.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>addresses.association.owner-id</code> - The owner ID of the addresses associated with the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>association.association-id</code> - The association ID returned when the network interface was associated with an IP address.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>association.allocation-id</code> - The allocation ID returned when you allocated the Elastic IP address for your network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>association.ip-owner-id</code> - The owner of the Elastic IP address associated with the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>association.public-ip</code> - The address of the Elastic IP address bound to the network interface.</p>\n\t\t </li>\n\t\t \t<li>\n\t\t \t\t <p><code>association.public-dns-name</code> - The public DNS name for the network interface.</p>\n\t\t \t</li>\n\t\t <li>\n\t\t <p><code>attachment.attachment-id</code> - The ID of the interface attachment.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>attachment.instance-id</code> - The ID of the instance to which the network interface is attached.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>attachment.instance-owner-id</code> - The owner ID of the instance to which the network interface is attached.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>attachment.device-index</code> - The device index to which the network interface is attached.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>attachment.status</code> - The status of the attachment (<code>attaching</code> | <code>attached</code> | <code>detaching</code> | <code>detached</code>).</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>attachment.attach.time</code> - The time that the network interface was attached to an instance.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>attachment.delete-on-termination</code> - Indicates whether the attachment is deleted when an instance is terminated.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>availability-zone</code> - The Availability Zone of the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>description</code> - The description of the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>group-id</code> - The ID of a security group associated with the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>group-name</code> - The name of a security group associated with the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>mac-address</code> - The MAC address of the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>network-interface-id</code> - The ID of the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>owner-id</code> - The AWS account ID of the network interface owner.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>private-ip-address</code> - The private IP address or addresses of the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>private-dns-name</code> - The private DNS name of the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>requester-id</code> - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>requester-managed</code> - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>source-desk-check</code> - Indicates whether the network interface performs source/destination checking. \n\t\t A value of <code>true</code> means checking is enabled, and <code>false</code> means checking is disabled. \n\t\t The value must be <code>false</code> for the network interface to perform Network Address Translation (NAT) in your VPC. </p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>status</code> - The status of the network interface. If the network interface is not attached to an instance, the status is <code>available</code>; \n\t\t if a network interface is attached to an instance the status is <code>in-use</code>.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>subnet-id</code> - The ID of the subnet for the network interface.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. \n\t\t For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n\t\t the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n\t\t If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>vpc-id</code> - The ID of the VPC for the network interface.</p>\n\t\t </li>\n\t\t </ul>\n ",
|
|
9680
9680
|
"flattened": true
|
|
9681
9681
|
}
|
|
9682
9682
|
},
|
|
@@ -9872,7 +9872,7 @@
|
|
|
9872
9872
|
"PublicDnsName": {
|
|
9873
9873
|
"shape_name": "String",
|
|
9874
9874
|
"type": "string",
|
|
9875
|
-
"documentation":
|
|
9875
|
+
"documentation": "\n\t\t<p>The public DNS name.</p>\n\t",
|
|
9876
9876
|
"xmlname": "publicDnsName"
|
|
9877
9877
|
},
|
|
9878
9878
|
"IpOwnerId": {
|
|
@@ -9961,7 +9961,7 @@
|
|
|
9961
9961
|
"PublicDnsName": {
|
|
9962
9962
|
"shape_name": "String",
|
|
9963
9963
|
"type": "string",
|
|
9964
|
-
"documentation":
|
|
9964
|
+
"documentation": "\n\t\t<p>The public DNS name.</p>\n\t",
|
|
9965
9965
|
"xmlname": "publicDnsName"
|
|
9966
9966
|
},
|
|
9967
9967
|
"IpOwnerId": {
|
|
@@ -13167,7 +13167,7 @@
|
|
|
13167
13167
|
"documentation": "\n ",
|
|
13168
13168
|
"xmlname": "Filter"
|
|
13169
13169
|
},
|
|
13170
|
-
"documentation": "\n\t\t <p>One or more filters.</p>\n\t\t <ul>\n\t\t <li>\n\t\t <p><code>
|
|
13170
|
+
"documentation": "\n\t\t <p>One or more filters.</p>\n\t\t <ul>\n\t\t <li>\n\t\t <p><code>availabilityZone</code> - The Availability Zone for the subnet. You can also use\n\t\t\t\t\t\t<code>availability-zone</code> as the filter name.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>available-ip-address-count</code> - The number of IP addresses in the subnet that are available.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>cidrBlock</code> - The CIDR block of the subnet. The CIDR block you specify must\n\t\t\t\t\texactly match the subnet's CIDR block for information to be returned for the subnet. You\n\t\t\t\t\tcan also use <code>cidr</code> or <code>cidr-block</code> as the filter names.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>defaultForAz</code> - Indicates whether this is the default subnet for the\n\t\t\t\t\tAvailability Zone. You can also use <code>default-for-az</code> as the filter name.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>state</code> - The state of the subnet (<code>pending</code> | <code>available</code>).</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>subnet-id</code> - The ID of the subnet.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. \n\t\t For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n\t\t the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n\t\t If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</p>\n\t\t </li>\n\t\t <li>\n\t\t <p><code>vpc-id</code> - The ID of the VPC for the subnet.</p>\n\t\t </li>\n\t\t </ul>\n ",
|
|
13171
13171
|
"flattened": true
|
|
13172
13172
|
}
|
|
13173
13173
|
},
|
|
@@ -15765,7 +15765,7 @@
|
|
|
15765
15765
|
"errors": [
|
|
15766
15766
|
|
|
15767
15767
|
],
|
|
15768
|
-
"documentation": "\n
|
|
15768
|
+
"documentation": "\n <p>Creates an import instance task using metadata from the specified disk image. After\n importing the image, you then upload it using the <function>ec2-import-volume</function> command in the EC2 command line\n tools. For more information, see <ulink url=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html\">Using the Command Line\n Tools to Import Your Virtual Machine to Amazon EC2</ulink> in the\n <emphasis>Amazon Elastic Compute Cloud User Guide</emphasis>.</p>\n \n \n <examples>\n <example>\n <name>Example</name>\n <description>This example creates an import instance task that migrates a Windows Server\n 2008 SP2 (32-bit) VM into the AWS <code>us-east-1</code> region.</description> \n <queryrequest>https://ec2.amazonaws.com/?Action=ImportInstance\n &LaunchSpecification.Architecture=x86_64\n &LaunchSpecification.InstanceType=m1.xlarge\n &DiskImage.1.Image.Format=VMDK\n &DiskImage.1.Image.Bytes=1179593728\n &DiskImage.1.Image.ImportManifestUrl=https://s3.amazonaws.com/myawsbucket/a3a5e1b6-590d-43cc-97c1-15c7325d3f41/Win_2008_Server_Data_Center_SP2_32-bit.vmdkmanifest.xml?AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE&Expires=1294855591&Signature=5snej01TlTtL0uR7KExtEXAMPLE%3D\n &DiskImage.1.Volume.Size=12\t\n &Platform=Windows\n &AUTHPARAMS</queryrequest>\n <queryresponse><ImportInstanceResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-06-15/\">\n <conversionTask>\n <conversionTaskId>import-i-ffvko9js</conversionTaskId>\n <expirationTime>2010-12-22T12:01Z</expirationTime>\n <importInstance>\n <volumes>\n <item>\n <bytesConverted>0</bytesConverted>\n <availabilityZone>us-east-1a</availabilityZone>\n <image>\n <format>VMDK</format>\n <size>1179593728</size>\n <importManifestUrl>\n https://s3.amazonaws.com/myawsbucket/a3a5e1b6-590d-43cc-97c1-15c7325d3f41/Win_2008_Server_Data_Center_SP2_32-bit.vmdkmanifest.xml?AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE&Expires=1294855591&Signature=5snej01TlTtL0uR7KExtEXAMPLE%3D\n </importManifestUrl>\n </image>\n <description/>\n <volume>\n <size>12</size>\n <id>vol-1a2b3c4d</id>\n </volume>\n <status>active</status>\n <statusMessage/>\n </item>\n </volumes>\n <instanceId>i-12655a7f</instanceId>\n <description/>\n </importInstance>\n </conversionTask>\n</ImportInstanceResponse></queryresponse>\n </example>\n </examples>\n "
|
|
15769
15769
|
},
|
|
15770
15770
|
"ImportKeyPair": {
|
|
15771
15771
|
"name": "ImportKeyPair",
|
|
@@ -16191,7 +16191,7 @@
|
|
|
16191
16191
|
"errors": [
|
|
16192
16192
|
|
|
16193
16193
|
],
|
|
16194
|
-
"documentation": "\n <p>Creates an import volume task using metadata from the specified disk image.\n After importing the image, you then upload it using the\n <function>ec2-
|
|
16194
|
+
"documentation": "\n <p>Creates an import volume task using metadata from the specified disk image.\n After importing the image, you then upload it using the\n <function>ec2-import-volume</function> command in the Amazon EC2 command-line interface (CLI) tools. \n For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UploadingYourInstancesandVolumes.html\">Using the Command Line\n Tools to Import Your Virtual Machine to Amazon EC2</a> in the\n <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example creates an import volume task that migrates a Windows Server 2008\n SP2 (32-bit) volume into the AWS <code>us-east-1</code> region.</description> \n <queryrequest>https://ec2.amazonaws.com/?Action=ImportVolume\n &AvailabilityZone=us-east-1c\n &Image.Format=VMDK\n &Image.Bytes=128696320\n &Image.ImportManifestUrl=https://s3.amazonaws.com/myawsbucket/a3a5e1b6-590d-43cc-97c1-15c7325d3f41/Win_2008_Server_Data_Center_SP2_32-bit.vmdkmanifest.xml?AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE&Expires=1294855591&Signature=5snej01TlTtL0uR7KExtEXAMPLE%3D\n &VolumeSize=8\n &AUTHPARAMS></queryrequest>\n <queryresponse><ImportVolumeResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-06-15/\">\n <conversionTask>\n <conversionTaskId>import-i-fh95npoc</conversionTaskId>\n <expirationTime>2010-12-22T12:01Z</expirationTime>\n <importVolume>\n <bytesConverted>0</bytesConverted>\n <availabilityZone>us-east-1c</availabilityZone>\n <description/>\n <image>\n <format>VDMK</format>\n <size>128696320</size>\n <importManifestUrl>\n https://s3.amazonaws.com/myawsbucket/a3a5e1b6-590d-43cc-97c1-15c7325d3f41/Win_2008_Server_Data_Center_SP2_32-bit.vmdkmanifest.xml?AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE&Expires=1294855591&Signature=5snej01TlTtL0uR7KExtEXAMPLE%3D\n </importManifestUrl>\n <checksum>ccb1b0536a4a70e86016b85229b5c6b10b14a4eb</checksum>\n </image>\n <volume>\n <size>8</size>\n <id>vol-34d8a2ff</id>\n </volume>\n </importVolume>\n <state>active</state>\n <statusMessage/>\n </conversionTask>\n</ImportVolumeResponse></queryresponse>\n </example>\n </examples>\n "
|
|
16195
16195
|
},
|
|
16196
16196
|
"ModifyImageAttribute": {
|
|
16197
16197
|
"name": "ModifyImageAttribute",
|
|
@@ -16546,7 +16546,7 @@
|
|
|
16546
16546
|
"documentation": " \n "
|
|
16547
16547
|
}
|
|
16548
16548
|
},
|
|
16549
|
-
"documentation": " \n "
|
|
16549
|
+
"documentation": "\n <p>Set to <code>simple</code> to enable enhanced networking for the instance.</p>\n <p>There is no way to disable enhanced networking at this time.</p>\n <p>This option is supported only for HVM instances. Specifying this option\n with a PV instance can make it unreachable.</p> \n "
|
|
16550
16550
|
}
|
|
16551
16551
|
},
|
|
16552
16552
|
"documentation": "\n "
|
|
@@ -17125,7 +17125,7 @@
|
|
|
17125
17125
|
"errors": [
|
|
17126
17126
|
|
|
17127
17127
|
],
|
|
17128
|
-
"documentation": "\n\t\t\t<p>Requests a reboot of one or more instances. This operation is asynchronous; it\n\t\t\t\tonly queues a request to reboot the specified instances. The operation\n\t\t\t\tsucceeds if the instances are valid and belong to you. Requests to reboot terminated\n\t\t\t\tinstances are ignored.</p>\n\t\t\t<p>If a Linux/Unix instance does not cleanly shut down within four minutes,\n\t\t\t\tAmazon EC2 performs a hard reboot.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example reboots two instances.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RebootInstances\n&InstanceId.1=i-1a2b3c4d\n&InstanceId.2=i-4d3acf62\n&AUTHPARAMS</queryrequest>\n <queryresponse><RebootInstancesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <return>true</return>\n</RebootInstancesResponse></queryresponse>\n </example>\n </examples>\n "
|
|
17128
|
+
"documentation": "\n\t\t\t<p>Requests a reboot of one or more instances. This operation is asynchronous; it\n\t\t\t\tonly queues a request to reboot the specified instances. The operation\n\t\t\t\tsucceeds if the instances are valid and belong to you. Requests to reboot terminated\n\t\t\t\tinstances are ignored.</p>\n\t\t\t<p>If a Linux/Unix instance does not cleanly shut down within four minutes,\n\t\t\t\tAmazon EC2 performs a hard reboot.</p>\n <p>For more information about troubleshooting, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-console.html\">Getting Console Output and Rebooting Instances</a> in the\n <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example reboots two instances.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RebootInstances\n&InstanceId.1=i-1a2b3c4d\n&InstanceId.2=i-4d3acf62\n&AUTHPARAMS</queryrequest>\n <queryresponse><RebootInstancesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <return>true</return>\n</RebootInstancesResponse></queryresponse>\n </example>\n </examples>\n "
|
|
17129
17129
|
},
|
|
17130
17130
|
"RegisterImage": {
|
|
17131
17131
|
"name": "RegisterImage",
|
|
@@ -17250,7 +17250,7 @@
|
|
|
17250
17250
|
"SriovNetSupport": {
|
|
17251
17251
|
"shape_name": "String",
|
|
17252
17252
|
"type": "string",
|
|
17253
|
-
"documentation": "\n <p>Set to <code>simple</code> to enable enhanced networking for the AMI and any instances that you launch from the AMI.</p>\n "
|
|
17253
|
+
"documentation": "\n <p>Set to <code>simple</code> to enable enhanced networking for the AMI and any instances that you launch from the AMI.</p>\n <p>There is no way to disable enhanced networking at this time.</p>\n <p>This option is supported only for HVM AMIs. Specifying this option\n with a PV AMI can make instances launched from the AMI unreachable.</p>\n "
|
|
17254
17254
|
}
|
|
17255
17255
|
},
|
|
17256
17256
|
"documentation": "\n "
|
|
@@ -17271,7 +17271,7 @@
|
|
|
17271
17271
|
"errors": [
|
|
17272
17272
|
|
|
17273
17273
|
],
|
|
17274
|
-
"documentation": " \n <p>Registers an AMI. When you're creating an AMI, this is the final step\n\t\t\t\tyou must complete before you can launch an instance from the AMI. For more\n\t\t\t\tinformation about creating AMIs, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami.html\">Creating Your Own AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <note><p>For Amazon EBS-backed instances, <a>CreateImage</a> creates and registers the AMI in a single request, so you don't have to register the AMI yourself.</p></note>\n <p>You can also use <code>RegisterImage</code> to create an Amazon EBS-backed AMI\n\t\t\t\tfrom a snapshot of a root device volume. For more information, see\n\t\t\t\t<a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_LaunchingInstanceFromSnapshot.html\">Launching an\n\t\t\t\t\tInstance from a Snapshot</a> in the\n\t\t\t\t<i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <p>If needed, you can deregister an AMI at any time. Any modifications you make to an AMI\n\t\t\t\tbacked by an instance store volume invalidates its registration. If you make changes to an image,\n\t\t\t\tderegister the previous image and register the new image.</p>\n <note><p>You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.</p></note>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example registers the AMI specified in the\n\t\t\t\t\t<code>my-new-image.manifest.xml</code> manifest file, located in the bucket\n\t\t\t\t\tcalled <code>myawsbucket</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RegisterImage\n&ImageLocation=myawsbucket/my-new-image.manifest.xml\n&AUTHPARAMS</queryrequest>\n <queryresponse><RegisterImageResponse xmlns=\"http://ec2.amazonaws.com/doc/
|
|
17274
|
+
"documentation": " \n <p>Registers an AMI. When you're creating an AMI, this is the final step\n\t\t\t\tyou must complete before you can launch an instance from the AMI. For more\n\t\t\t\tinformation about creating AMIs, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami.html\">Creating Your Own AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <note><p>For Amazon EBS-backed instances, <a>CreateImage</a> creates and registers the AMI in a single request, so you don't have to register the AMI yourself.</p></note>\n <p>You can also use <code>RegisterImage</code> to create an Amazon EBS-backed AMI\n\t\t\t\tfrom a snapshot of a root device volume. For more information, see\n\t\t\t\t<a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_LaunchingInstanceFromSnapshot.html\">Launching an\n\t\t\t\t\tInstance from a Snapshot</a> in the\n\t\t\t\t<i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <p>If needed, you can deregister an AMI at any time. Any modifications you make to an AMI\n\t\t\t\tbacked by an instance store volume invalidates its registration. If you make changes to an image,\n\t\t\t\tderegister the previous image and register the new image.</p>\n <note><p>You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.</p></note>\n <examples>\n <example>\n <name>Example 1</name>\n <description>This example registers the AMI specified in the\n\t\t\t\t\t<code>my-new-image.manifest.xml</code> manifest file, located in the bucket\n\t\t\t\t\tcalled <code>myawsbucket</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RegisterImage\n&ImageLocation=myawsbucket/my-new-image.manifest.xml\n&AUTHPARAMS</queryrequest>\n <queryresponse><RegisterImageResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <imageId>ami-1a2b3c4d</imageId>\n</RegisterImageResponse></queryresponse>\n </example>\n <example>\n <name>Example 2</name>\n <description>This example registers an Amazon EBS snapshot to create an AMI backed by\n\t\t\t\t\tAmazon EBS.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RegisterImage\n&RootDeviceName=/dev/sda1 \n&BlockDeviceMapping.1.DeviceName=/dev/sda1 \n&BlockDeviceMapping.1.Ebs.SnapshotId=snap-1a2b3c4d \n&Name=MyImage\n&AUTHPARAMS</queryrequest>\n <queryresponse><RegisterImageResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <imageId>ami-1a2b3c4d</imageId>\n</RegisterImageResponse></queryresponse>\n </example>\n <example>\n <name>Example 3</name>\n <description>This example registers the AMI with an Amazon EBS snapshot as the root device,\n\t\t\t\t\ta separate snapshot as a secondary device, and an empty 100 GiB Amazon EBS\n\t\t\t\t\tvolume as a storage device.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RegisterImage\n&RootDeviceName=/dev/sda1\n&BlockDeviceMapping.1.DeviceName=/dev/sda1\n&BlockDeviceMapping.1.Ebs.SnapshotId=snap-1a2b3c4d\n&BlockDeviceMapping.2.DeviceName=/dev/sdb\n&BlockDeviceMapping.2.Ebs.SnapshotId=snap-2a2b3c4d\n&BlockDeviceMapping.3.DeviceName=/dev/sdc\n&BlockDeviceMapping.3.Ebs.VolumeSize=100\n&Name=MyImage\n&AUTHPARAMS</queryrequest>\n <queryresponse><RegisterImageResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <imageId>ami-1a2b3c4d</imageId>\n</RegisterImageResponse></queryresponse>\n </example>\n </examples>\n "
|
|
17275
17275
|
},
|
|
17276
17276
|
"RejectVpcPeeringConnection": {
|
|
17277
17277
|
"name": "RejectVpcPeeringConnection",
|
|
@@ -18579,7 +18579,7 @@
|
|
|
18579
18579
|
"errors": [
|
|
18580
18580
|
|
|
18581
18581
|
],
|
|
18582
|
-
"documentation": " \n <p>Resets an attribute of an AMI to its default value.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example resets the <code>launchPermission</code> attribute for the\n\t\t\t\t\tspecified AMI.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=ResetImageAttribute\n&ImageId=ami-61a54008\n&Attribute=launchPermission\n&AUTHPARAMS</queryrequest>\n <queryresponse><ResetImageAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/
|
|
18582
|
+
"documentation": " \n <p>Resets an attribute of an AMI to its default value.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example resets the <code>launchPermission</code> attribute for the\n\t\t\t\t\tspecified AMI.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=ResetImageAttribute\n&ImageId=ami-61a54008\n&Attribute=launchPermission\n&AUTHPARAMS</queryrequest>\n <queryresponse><ResetImageAttributeResponse xmlns=\"http://ec2.amazonaws.com/doc/2014-02-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> \n <return>true</return>\n</ResetImageAttributeResponse></queryresponse>\n </example>\n </examples>\n "
|
|
18583
18583
|
},
|
|
18584
18584
|
"ResetInstanceAttribute": {
|
|
18585
18585
|
"name": "ResetInstanceAttribute",
|
|
@@ -20103,7 +20103,7 @@
|
|
|
20103
20103
|
"errors": [
|
|
20104
20104
|
|
|
20105
20105
|
],
|
|
20106
|
-
"documentation": "\n <p>Launches the specified number of instances using an AMI for which you have permissions.</p>\n <p>When you launch an instance, it enters the <code>pending</code> state.\n After the instance is ready for you, it enters the <code>running</code> state.\n To check the state of your instance, call <a>DescribeInstances</a>.</p>\n\n <p>If you don't specify a security group when launching an instance, Amazon EC2 uses\n the default security group. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html\">Security Groups</a>\n in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n\n <p>Linux instances have access to the public key of the key pair at boot.\n You can use this key to provide secure access to the instance.\n Amazon EC2 public images use this feature to provide secure access without passwords.\n For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html\">Key Pairs</a>\n in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n\n <p>You can provide optional user data when launching an instance. For more\n information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html\">Instance\n Metadata</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n\n\t\t<p>If any of the AMIs have a product code attached for which the user has not\n\t\t\tsubscribed, <code>RunInstances</code> fails.</p>\n\n <examples>\n <example>\n <description>This example launches three instances using the AMI with the ID <code>ami-60a54009</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RunInstances\n&ImageId=ami-60a54009\n&MaxCount=3\n&MinCount=1\n&KeyName=my-key-pair\n&Placement.AvailabilityZone=us-east-1d\n&AUTHPARAMS</queryrequest>\n </example>\n <example>\n <description>This example launches an <code>m1.small</code> instance into a subnet.\n Because no network interface is specified, the default network interface is used.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RunInstances\n&ImageId=ami-31814f58\n&InstanceType=m1.small\n&MaxCount=1\n&MinCount=1\n&KeyName=my-key-pair\n&SubnetId=subnet-b2a249da\n&AUTHPARAMS</queryrequest>\n </example>\n <example>\n <description>This example launches an <code>m1.large</code> instance into a subnet.\n The network interface specifies a primary private IP address of <code>10.0.2.106</code>\n and two secondary private IP addresses (<code>10.0.2.107</code> and <code>10.0.2.108</code>).</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RunInstances\n&ImageId=ami-beb0caec\n&InstanceType=m1.large\n&MaxCount=1\n&MinCount=1\n&KeyName=my-key-pair\n&NetworkInterface.0.DeviceIndex=0\n&NetworkInterface.0.PrivateIpAddresses.0.Primary=true\n&NetworkInterface.0.PrivateIpAddresses.0.PrivateIpAddress=10.0.2.106\n&NetworkInterface.0.PrivateIpAddresses.1.Primary=false\n&NetworkInterface.0.PrivateIpAddresses.1.PrivateIpAddress=10.0.2.107\n&NetworkInterface.0.PrivateIpAddresses.2.Primary=false\n&NetworkInterface.0.PrivateIpAddresses.2.PrivateIpAddress=10.0.2.108\n&NetworkInterface.0.SubnetId=subnet-a61dafcf\n&AUTHPARAMS</queryrequest>\n </example>\n <example>\n <description>This example launches a Dedicated Instance into the specified subnet.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RunInstances\n&ImageId=ami-2a1fec43\n&MaxCount=1\n&MinCount=1\n&KeyName=my-key-pair\n&SubnetId=subnet-dea63cb7\n&Placement.Tenancy=dedicated\n&AUTHPARAMS</queryrequest>\n </example>\n <example>\n <description>This request launches an instance into a nondefault subnet, and requests a public IP\n address for a new network interface with the device index of 0.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RunInstances\n&ImageId=ami-1a2b3c4d\n&MaxCount=1\n&MinCount=1\n&NetworkInterface.0.DeviceIndex=0\n&NetworkInterface.0.AssociatePublicIpAddress=true\n&NetworkInterface.0.SubnetId=subnet-1a2b3c4d\n&AUTHPARAMS</queryrequest>\n </example>\n <example>\n <description>This request launches an <code>m1.large</code> instance with a block device\n mapping. There are two instance store volumes mapped to <code>/dev/sdc</code> and\n <code>/dev/sdd</code>, and a 100 GB Amazon EBS volume mapped to\n <code>/dev/sdf</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RunInstances\n&ImageId=ami-1a2b3c4d\n&InstanceType=m1.large\n&BlockDeviceMapping.1.DeviceName=%2Fdev%2Fsdc\n&BlockDeviceMapping.1.VirtualName=ephemeral0\n&BlockDeviceMapping.2.DeviceName=%2Fdev%2Fsdd\n&BlockDeviceMapping.2.VirtualName=ephemeral1\n&BlockDeviceMapping.3.DeviceName=%2Fdev%2Fsdf\n&BlockDeviceMapping.3.Ebs.DeleteOnTermination=false\n&BlockDeviceMapping.3.Ebs.VolumeSize=100\n&EbsOptimized=false\n&MinCount=1\n&MaxCount=1\n&DisableApiTermination=false\n&Monitoring.Enabled=false\n&AUTHPARAMS</queryrequest>\n </example>\n </examples>\n "
|
|
20106
|
+
"documentation": "\n <p>Launches the specified number of instances using an AMI for which you have permissions.</p>\n <p>When you launch an instance, it enters the <code>pending</code> state.\n After the instance is ready for you, it enters the <code>running</code> state.\n To check the state of your instance, call <a>DescribeInstances</a>.</p>\n\n <p>If you don't specify a security group when launching an instance, Amazon EC2 uses\n the default security group. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html\">Security Groups</a>\n in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n\n <p>Linux instances have access to the public key of the key pair at boot.\n You can use this key to provide secure access to the instance.\n Amazon EC2 public images use this feature to provide secure access without passwords.\n For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html\">Key Pairs</a>\n in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n\n <p>You can provide optional user data when launching an instance. For more\n information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html\">Instance\n Metadata</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n\n\t\t<p>If any of the AMIs have a product code attached for which the user has not\n\t\t\tsubscribed, <code>RunInstances</code> fails.</p>\n \n <p>For more information about troubleshooting, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_InstanceStraightToTerminated.html\">What To Do If An\n Instance Immediately Terminates</a>, and <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesConnecting.html\">Troubleshooting Connecting to Your Instance</a> in the\n <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n\n <examples>\n <example>\n <description>This example launches three instances using the AMI with the ID <code>ami-60a54009</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RunInstances\n&ImageId=ami-60a54009\n&MaxCount=3\n&MinCount=1\n&KeyName=my-key-pair\n&Placement.AvailabilityZone=us-east-1d\n&AUTHPARAMS</queryrequest>\n </example>\n <example>\n <description>This example launches an <code>m1.small</code> instance into a subnet.\n Because no network interface is specified, the default network interface is used.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RunInstances\n&ImageId=ami-31814f58\n&InstanceType=m1.small\n&MaxCount=1\n&MinCount=1\n&KeyName=my-key-pair\n&SubnetId=subnet-b2a249da\n&AUTHPARAMS</queryrequest>\n </example>\n <example>\n <description>This example launches an <code>m1.large</code> instance into a subnet.\n The network interface specifies a primary private IP address of <code>10.0.2.106</code>\n and two secondary private IP addresses (<code>10.0.2.107</code> and <code>10.0.2.108</code>).</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RunInstances\n&ImageId=ami-beb0caec\n&InstanceType=m1.large\n&MaxCount=1\n&MinCount=1\n&KeyName=my-key-pair\n&NetworkInterface.0.DeviceIndex=0\n&NetworkInterface.0.PrivateIpAddresses.0.Primary=true\n&NetworkInterface.0.PrivateIpAddresses.0.PrivateIpAddress=10.0.2.106\n&NetworkInterface.0.PrivateIpAddresses.1.Primary=false\n&NetworkInterface.0.PrivateIpAddresses.1.PrivateIpAddress=10.0.2.107\n&NetworkInterface.0.PrivateIpAddresses.2.Primary=false\n&NetworkInterface.0.PrivateIpAddresses.2.PrivateIpAddress=10.0.2.108\n&NetworkInterface.0.SubnetId=subnet-a61dafcf\n&AUTHPARAMS</queryrequest>\n </example>\n <example>\n <description>This example launches a Dedicated Instance into the specified subnet.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RunInstances\n&ImageId=ami-2a1fec43\n&MaxCount=1\n&MinCount=1\n&KeyName=my-key-pair\n&SubnetId=subnet-dea63cb7\n&Placement.Tenancy=dedicated\n&AUTHPARAMS</queryrequest>\n </example>\n <example>\n <description>This request launches an instance into a nondefault subnet, and requests a public IP\n address for a new network interface with the device index of 0.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RunInstances\n&ImageId=ami-1a2b3c4d\n&MaxCount=1\n&MinCount=1\n&NetworkInterface.0.DeviceIndex=0\n&NetworkInterface.0.AssociatePublicIpAddress=true\n&NetworkInterface.0.SubnetId=subnet-1a2b3c4d\n&AUTHPARAMS</queryrequest>\n </example>\n <example>\n <description>This request launches an <code>m1.large</code> instance with a block device\n mapping. There are two instance store volumes mapped to <code>/dev/sdc</code> and\n <code>/dev/sdd</code>, and a 100 GB Amazon EBS volume mapped to\n <code>/dev/sdf</code>.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=RunInstances\n&ImageId=ami-1a2b3c4d\n&InstanceType=m1.large\n&BlockDeviceMapping.1.DeviceName=%2Fdev%2Fsdc\n&BlockDeviceMapping.1.VirtualName=ephemeral0\n&BlockDeviceMapping.2.DeviceName=%2Fdev%2Fsdd\n&BlockDeviceMapping.2.VirtualName=ephemeral1\n&BlockDeviceMapping.3.DeviceName=%2Fdev%2Fsdf\n&BlockDeviceMapping.3.Ebs.DeleteOnTermination=false\n&BlockDeviceMapping.3.Ebs.VolumeSize=100\n&EbsOptimized=false\n&MinCount=1\n&MaxCount=1\n&DisableApiTermination=false\n&Monitoring.Enabled=false\n&AUTHPARAMS</queryrequest>\n </example>\n </examples>\n "
|
|
20107
20107
|
},
|
|
20108
20108
|
"StartInstances": {
|
|
20109
20109
|
"name": "StartInstances",
|
|
@@ -20343,7 +20343,7 @@
|
|
|
20343
20343
|
"errors": [
|
|
20344
20344
|
|
|
20345
20345
|
],
|
|
20346
|
-
"documentation": "\n\t\t\t<p>Stops an Amazon EBS-backed instance. Each time you transition an instance from\n\t\t\t\tstopped to started, Amazon EC2 charges a full instance hour, even if transitions happen\n\t\t\t\tmultiple times within a single hour.</p>\n\t\t\t<p>You can't start or stop Spot Instances.</p>\n\t\t\t<p>Instances that use Amazon EBS volumes as their root devices can be quickly stopped\n\t\t\t\tand started. When an instance is stopped, the compute resources are released and you\n\t\t\t\tare not billed for hourly instance usage. However, your root partition Amazon EBS\n\t\t\t\tvolume remains, continues to persist your data, and you are charged for Amazon EBS\n\t\t\t\tvolume usage. You can restart your instance at any time.</p>\n\t\t\t<p>Before stopping an instance, make sure it is in a state from which it can\n\t\t\t\tbe restarted. Stopping an instance does not preserve data stored in RAM.</p>\n\t\t\t<p>Performing this operation on an instance that uses an instance store as its\n\t\t\t\troot device returns an error.</p>\n <p>You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances.\n What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance,\n the root device and any other devices attached to the instance persist. When you terminate an instance, the root\n device and any other devices attached during the instance launch are automatically deleted. For more information\n about the differences between stopping and terminating instances, see\n <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html\">Instance Lifecycle</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example stops the specified instance.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=StopInstances\n&InstanceId.1=i-10a64379\n&AUTHPARAMS</queryrequest>\n <queryresponse><StopInstancesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <instancesSet>\n <item>\n <instanceId>i-10a64379</instanceId>\n <currentState>\n <code>64</code>\n <name>stopping</name>\n </currentState>\n <previousState>\n <code>16</code>\n <name>running</name>\n </previousState>\n </instancesSet>\n</StopInstancesResponse></queryresponse>\n </example>\n </examples>\n "
|
|
20346
|
+
"documentation": "\n\t\t\t<p>Stops an Amazon EBS-backed instance. Each time you transition an instance from\n\t\t\t\tstopped to started, Amazon EC2 charges a full instance hour, even if transitions happen\n\t\t\t\tmultiple times within a single hour.</p>\n\t\t\t<p>You can't start or stop Spot Instances.</p>\n\t\t\t<p>Instances that use Amazon EBS volumes as their root devices can be quickly stopped\n\t\t\t\tand started. When an instance is stopped, the compute resources are released and you\n\t\t\t\tare not billed for hourly instance usage. However, your root partition Amazon EBS\n\t\t\t\tvolume remains, continues to persist your data, and you are charged for Amazon EBS\n\t\t\t\tvolume usage. You can restart your instance at any time.</p>\n\t\t\t<p>Before stopping an instance, make sure it is in a state from which it can\n\t\t\t\tbe restarted. Stopping an instance does not preserve data stored in RAM.</p>\n\t\t\t<p>Performing this operation on an instance that uses an instance store as its\n\t\t\t\troot device returns an error.</p>\n <p>You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances.\n What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance,\n the root device and any other devices attached to the instance persist. When you terminate an instance, the root\n device and any other devices attached during the instance launch are automatically deleted. For more information\n about the differences between stopping and terminating instances, see\n <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html\">Instance Lifecycle</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <p>For more information about troubleshooting, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesStopping.html\">Troubleshooting\n Stopping Your Instance</a> in the\n <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example stops the specified instance.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=StopInstances\n&InstanceId.1=i-10a64379\n&AUTHPARAMS</queryrequest>\n <queryresponse><StopInstancesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <instancesSet>\n <item>\n <instanceId>i-10a64379</instanceId>\n <currentState>\n <code>64</code>\n <name>stopping</name>\n </currentState>\n <previousState>\n <code>16</code>\n <name>running</name>\n </previousState>\n </instancesSet>\n</StopInstancesResponse></queryresponse>\n </example>\n </examples>\n "
|
|
20347
20347
|
},
|
|
20348
20348
|
"TerminateInstances": {
|
|
20349
20349
|
"name": "TerminateInstances",
|
|
@@ -20458,7 +20458,7 @@
|
|
|
20458
20458
|
"errors": [
|
|
20459
20459
|
|
|
20460
20460
|
],
|
|
20461
|
-
"documentation": "\n\t\t\t<p>Shuts down one or more instances. This operation is idempotent; if you terminate\n\t\t\t\tan instance more than once, each call succeeds.</p>\n\t\t\t<p>Terminated instances remain visible after termination (for approximately one\n\t\t\t\thour).</p>\n\t\t\t<p>By default, Amazon EC2 deletes all Amazon EBS volumes that were attached\n\t\t\t\twhen the instance launched. Volumes attached after instance launch\n\t\t\t\tcontinue running.</p>\n <p>You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances.\n What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance,\n the root device and any other devices attached to the instance persist. When you terminate an instance, the root\n device and any other devices attached during the instance launch are automatically deleted. For more information\n about the differences between stopping and terminating instances, see\n <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html\">Instance Lifecycle</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example terminates the specified instance.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=TerminateInstances\n&InstanceId.1=i-3ea74257\n&AUTHPARAMS</queryrequest>\n <queryresponse><TerminateInstancesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <instancesSet>\n <item>\n <instanceId>i-3ea74257</instanceId>\n <currentState>\n <code>32</code>\n <name>shutting-down</name>\n </currentState>\n <previousState>\n <code>16</code>\n <name>running</name>\n </previousState>\n </item>\n </instancesSet>\n</TerminateInstancesResponse></queryresponse>\n </example>\n </examples>\n "
|
|
20461
|
+
"documentation": "\n\t\t\t<p>Shuts down one or more instances. This operation is idempotent; if you terminate\n\t\t\t\tan instance more than once, each call succeeds.</p>\n\t\t\t<p>Terminated instances remain visible after termination (for approximately one\n\t\t\t\thour).</p>\n\t\t\t<p>By default, Amazon EC2 deletes all Amazon EBS volumes that were attached\n\t\t\t\twhen the instance launched. Volumes attached after instance launch\n\t\t\t\tcontinue running.</p>\n <p>You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances.\n What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance,\n the root device and any other devices attached to the instance persist. When you terminate an instance, the root\n device and any other devices attached during the instance launch are automatically deleted. For more information\n about the differences between stopping and terminating instances, see\n <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html\">Instance Lifecycle</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <p>For more information about troubleshooting, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesShuttingDown.html\">Troubleshooting Terminating Your Instance</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>\n <examples>\n <example>\n <name>Example</name>\n <description>This example terminates the specified instance.</description>\n <queryrequest>https://ec2.amazonaws.com/?Action=TerminateInstances\n&InstanceId.1=i-3ea74257\n&AUTHPARAMS</queryrequest>\n <queryresponse><TerminateInstancesResponse xmlns=\"http://ec2.amazonaws.com/doc/2013-10-01/\">\n <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>\n <instancesSet>\n <item>\n <instanceId>i-3ea74257</instanceId>\n <currentState>\n <code>32</code>\n <name>shutting-down</name>\n </currentState>\n <previousState>\n <code>16</code>\n <name>running</name>\n </previousState>\n </item>\n </instancesSet>\n</TerminateInstancesResponse></queryresponse>\n </example>\n </examples>\n "
|
|
20462
20462
|
},
|
|
20463
20463
|
"UnassignPrivateIpAddresses": {
|
|
20464
20464
|
"name": "UnassignPrivateIpAddresses",
|
|
@@ -65,6 +65,12 @@
|
|
|
65
65
|
"output_token": "Marker",
|
|
66
66
|
"limit_key": "MaxRecords",
|
|
67
67
|
"result_key": "ReplicationGroups"
|
|
68
|
+
},
|
|
69
|
+
"DescribeSnapshots": {
|
|
70
|
+
"input_token": "Marker",
|
|
71
|
+
"output_token": "Marker",
|
|
72
|
+
"limit_key": "MaxRecords",
|
|
73
|
+
"result_key": "Snapshots"
|
|
68
74
|
}
|
|
69
75
|
}
|
|
70
76
|
}
|
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
"signature_version": "v4",
|
|
5
5
|
"service_full_name": "Amazon Elastic Transcoder",
|
|
6
6
|
"endpoint_prefix": "elastictranscoder",
|
|
7
|
+
"xmlnamespace": "http://elastictranscoder.amazonaws.com/doc/2012-09-25/",
|
|
7
8
|
"documentation": "\n <fullname>AWS Elastic Transcoder Service</fullname>\n <p>The AWS Elastic Transcoder Service.</p>\n ",
|
|
8
9
|
"operations": {
|
|
9
10
|
"CancelJob": {
|
|
@@ -173,7 +174,7 @@
|
|
|
173
174
|
"SegmentDuration": {
|
|
174
175
|
"shape_name": "Float",
|
|
175
176
|
"type": "string",
|
|
176
|
-
"pattern": "^\\d{1,5}(
|
|
177
|
+
"pattern": "^\\d{1,5}(\\.\\d{0,5})?$",
|
|
177
178
|
"documentation": "\n <p>If you specify a preset in <code>PresetId</code> for which the value of\n <code>Container</code> is ts (MPEG-TS), SegmentDuration is the duration of each .ts\n file in seconds. The range of valid values is 1 to 60 seconds.</p>\n "
|
|
178
179
|
},
|
|
179
180
|
"Watermarks": {
|
|
@@ -280,13 +281,13 @@
|
|
|
280
281
|
"StartTime": {
|
|
281
282
|
"shape_name": "Time",
|
|
282
283
|
"type": "string",
|
|
283
|
-
"pattern": "(^\\d{1,5}(
|
|
284
|
+
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
284
285
|
"documentation": "\n <p>The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.</p>\n "
|
|
285
286
|
},
|
|
286
287
|
"Duration": {
|
|
287
288
|
"shape_name": "Time",
|
|
288
289
|
"type": "string",
|
|
289
|
-
"pattern": "(^\\d{1,5}(
|
|
290
|
+
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
290
291
|
"documentation": "\n <p>The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.</p>\n <p>If you specify a value longer than the duration of the input file , Elastic Transcoder transcodes \n the file and returns a warning message.</p>\n "
|
|
291
292
|
}
|
|
292
293
|
},
|
|
@@ -335,7 +336,7 @@
|
|
|
335
336
|
"SegmentDuration": {
|
|
336
337
|
"shape_name": "Float",
|
|
337
338
|
"type": "string",
|
|
338
|
-
"pattern": "^\\d{1,5}(
|
|
339
|
+
"pattern": "^\\d{1,5}(\\.\\d{0,5})?$",
|
|
339
340
|
"documentation": "\n <p>If you specify a preset in <code>PresetId</code> for which the value of\n <code>Container</code> is ts (MPEG-TS), SegmentDuration is the duration of each .ts\n file in seconds. The range of valid values is 1 to 60 seconds.</p>\n "
|
|
340
341
|
},
|
|
341
342
|
"Watermarks": {
|
|
@@ -442,13 +443,13 @@
|
|
|
442
443
|
"StartTime": {
|
|
443
444
|
"shape_name": "Time",
|
|
444
445
|
"type": "string",
|
|
445
|
-
"pattern": "(^\\d{1,5}(
|
|
446
|
+
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
446
447
|
"documentation": "\n <p>The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.</p>\n "
|
|
447
448
|
},
|
|
448
449
|
"Duration": {
|
|
449
450
|
"shape_name": "Time",
|
|
450
451
|
"type": "string",
|
|
451
|
-
"pattern": "(^\\d{1,5}(
|
|
452
|
+
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
452
453
|
"documentation": "\n <p>The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.</p>\n <p>If you specify a value longer than the duration of the input file , Elastic Transcoder transcodes \n the file and returns a warning message.</p>\n "
|
|
453
454
|
}
|
|
454
455
|
},
|
|
@@ -528,6 +529,11 @@
|
|
|
528
529
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
529
530
|
"documentation": "\n <p> The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the\n job or to delete the job. </p>\n "
|
|
530
531
|
},
|
|
532
|
+
"Arn": {
|
|
533
|
+
"shape_name": "String",
|
|
534
|
+
"type": "string",
|
|
535
|
+
"documentation": "\n <p>The Amazon Resource Name (ARN) for the job.</p>\n "
|
|
536
|
+
},
|
|
531
537
|
"PipelineId": {
|
|
532
538
|
"shape_name": "Id",
|
|
533
539
|
"type": "string",
|
|
@@ -615,7 +621,7 @@
|
|
|
615
621
|
"SegmentDuration": {
|
|
616
622
|
"shape_name": "Float",
|
|
617
623
|
"type": "string",
|
|
618
|
-
"pattern": "^\\d{1,5}(
|
|
624
|
+
"pattern": "^\\d{1,5}(\\.\\d{0,5})?$",
|
|
619
625
|
"documentation": "\n <p><important>(Outputs in MPEG-TS format only.</important>If you specify a preset in\n <code>PresetId</code> for which the value of <code>Container</code>is\n <code>ts</code> (MPEG-TS), <code>SegmentDuration</code> is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by <code>SegmentDuration</code>, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n <code>OutputKeys</code>.</p>\n "
|
|
620
626
|
},
|
|
621
627
|
"Status": {
|
|
@@ -750,13 +756,13 @@
|
|
|
750
756
|
"StartTime": {
|
|
751
757
|
"shape_name": "Time",
|
|
752
758
|
"type": "string",
|
|
753
|
-
"pattern": "(^\\d{1,5}(
|
|
759
|
+
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
754
760
|
"documentation": "\n <p>The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.</p>\n "
|
|
755
761
|
},
|
|
756
762
|
"Duration": {
|
|
757
763
|
"shape_name": "Time",
|
|
758
764
|
"type": "string",
|
|
759
|
-
"pattern": "(^\\d{1,5}(
|
|
765
|
+
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
760
766
|
"documentation": "\n <p>The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.</p>\n <p>If you specify a value longer than the duration of the input file , Elastic Transcoder transcodes \n the file and returns a warning message.</p>\n "
|
|
761
767
|
}
|
|
762
768
|
},
|
|
@@ -810,7 +816,7 @@
|
|
|
810
816
|
"SegmentDuration": {
|
|
811
817
|
"shape_name": "Float",
|
|
812
818
|
"type": "string",
|
|
813
|
-
"pattern": "^\\d{1,5}(
|
|
819
|
+
"pattern": "^\\d{1,5}(\\.\\d{0,5})?$",
|
|
814
820
|
"documentation": "\n <p><important>(Outputs in MPEG-TS format only.</important>If you specify a preset in\n <code>PresetId</code> for which the value of <code>Container</code>is\n <code>ts</code> (MPEG-TS), <code>SegmentDuration</code> is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by <code>SegmentDuration</code>, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n <code>OutputKeys</code>.</p>\n "
|
|
815
821
|
},
|
|
816
822
|
"Status": {
|
|
@@ -945,13 +951,13 @@
|
|
|
945
951
|
"StartTime": {
|
|
946
952
|
"shape_name": "Time",
|
|
947
953
|
"type": "string",
|
|
948
|
-
"pattern": "(^\\d{1,5}(
|
|
954
|
+
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
949
955
|
"documentation": "\n <p>The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.</p>\n "
|
|
950
956
|
},
|
|
951
957
|
"Duration": {
|
|
952
958
|
"shape_name": "Time",
|
|
953
959
|
"type": "string",
|
|
954
|
-
"pattern": "(^\\d{1,5}(
|
|
960
|
+
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
955
961
|
"documentation": "\n <p>The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.</p>\n <p>If you specify a value longer than the duration of the input file , Elastic Transcoder transcodes \n the file and returns a warning message.</p>\n "
|
|
956
962
|
}
|
|
957
963
|
},
|
|
@@ -1664,13 +1670,13 @@
|
|
|
1664
1670
|
"MaxWidth": {
|
|
1665
1671
|
"shape_name": "PixelsOrPercent",
|
|
1666
1672
|
"type": "string",
|
|
1667
|
-
"pattern": "(^\\d{1,3}(
|
|
1673
|
+
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)",
|
|
1668
1674
|
"documentation": "\n <p>The maximum width of the watermark in one of the following formats: <ul>\n <li>number of pixels (px): The minimum value is 16 pixels, and the maximum value is\n the value of <code>MaxWidth</code>.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100. Use the value of\n <code>Target</code> to specify whether you want Elastic Transcoder to include the black\n bars that are added by Elastic Transcoder, if any, in the calculation.</li> If\n you specify the value in pixels, it must be less than or equal to the value of\n <code>MaxWidth</code>.</ul></p>\n "
|
|
1669
1675
|
},
|
|
1670
1676
|
"MaxHeight": {
|
|
1671
1677
|
"shape_name": "PixelsOrPercent",
|
|
1672
1678
|
"type": "string",
|
|
1673
|
-
"pattern": "(^\\d{1,3}(
|
|
1679
|
+
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)",
|
|
1674
1680
|
"documentation": "\n <p>The maximum height of the watermark in one of the following formats: <ul>\n <li>number of pixels (px): The minimum value is 16 pixels, and the maximum value is\n the value of <code>MaxHeight</code>.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100. Use the value of\n <code>Target</code> to specify whether you want Elastic Transcoder to include the black\n bars that are added by Elastic Transcoder, if any, in the calculation.</li>\n </ul> If you specify the value in pixels, it must be less than or equal to the value of\n <code>MaxHeight</code>.</p>\n "
|
|
1675
1681
|
},
|
|
1676
1682
|
"SizingPolicy": {
|
|
@@ -1688,7 +1694,7 @@
|
|
|
1688
1694
|
"HorizontalOffset": {
|
|
1689
1695
|
"shape_name": "PixelsOrPercent",
|
|
1690
1696
|
"type": "string",
|
|
1691
|
-
"pattern": "(^\\d{1,3}(
|
|
1697
|
+
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)",
|
|
1692
1698
|
"documentation": "\n <p>The amount by which you want the horizontal position of the watermark to be offset from\n the position specified by HorizontalAlign: <ul>\n <li>number of pixels (px): The minimum value is 0 pixels, and the maximum value is\n the value of MaxWidth.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100.</li>\n </ul>For example, if you specify Left for <code>HorizontalAlign</code> and 5px for\n <code>HorizontalOffset</code>, the left side of the watermark appears 5 pixels from\n the left border of the output video.</p>\n <p><code>HorizontalOffset</code> is only valid when the value of\n <code>HorizontalAlign</code> is <code>Left</code> or <code>Right</code>. If you\n specify an offset that causes the watermark to extend beyond the left or right border\n and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic\n Transcoder has added black bars, the watermark extends into the black bars. If the\n watermark extends beyond the black bars, it is cropped.</p>\n <p>Use the value of <code>Target</code> to specify whether you want to include the black\n bars that are added by Elastic Transcoder, if any, in the offset calculation.</p>\n "
|
|
1693
1699
|
},
|
|
1694
1700
|
"VerticalAlign": {
|
|
@@ -1700,13 +1706,13 @@
|
|
|
1700
1706
|
"VerticalOffset": {
|
|
1701
1707
|
"shape_name": "PixelsOrPercent",
|
|
1702
1708
|
"type": "string",
|
|
1703
|
-
"pattern": "(^\\d{1,3}(
|
|
1709
|
+
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)",
|
|
1704
1710
|
"documentation": "\n <code>VerticalOffset</code>\n <p>The amount by which you want the vertical position of the watermark to be offset from the\n position specified by VerticalAlign:<ul>\n <li>number of pixels (px): The minimum value is 0 pixels, and the maximum value is\n the value of <code>MaxHeight</code>.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100.</li>\n </ul> For example, if you specify <code>Top</code> for <code>VerticalAlign</code> and\n <code>5px</code> for <code>VerticalOffset</code>, the top of the watermark appears 5\n pixels from the top border of the output video.</p>\n <p><code>VerticalOffset</code> is only valid when the value of VerticalAlign is Top or\n Bottom.</p>\n <p>If you specify an offset that causes the watermark to extend beyond the top or bottom\n border and Elastic Transcoder has not added black bars, the watermark is cropped. If\n Elastic Transcoder has added black bars, the watermark extends into the black bars. If\n the watermark extends beyond the black bars, it is cropped.</p>\n\n <p>Use the value of <code>Target</code> to specify whether you want Elastic Transcoder to\n include the black bars that are added by Elastic Transcoder, if any, in the offset\n calculation.</p>\n "
|
|
1705
1711
|
},
|
|
1706
1712
|
"Opacity": {
|
|
1707
1713
|
"shape_name": "Opacity",
|
|
1708
1714
|
"type": "string",
|
|
1709
|
-
"pattern": "^\\d{1,3}(
|
|
1715
|
+
"pattern": "^\\d{1,3}(\\.\\d{0,20})?$",
|
|
1710
1716
|
"documentation": "\n <p>A percentage that indicates how much you want a watermark to obscure the video in the\n location where it appears. Valid values are 0 (the watermark is invisible) to 100 (the\n watermark completely obscures the video in the specified location). The datatype of\n <code>Opacity</code> is float.</p>\n <p>Elastic Transcoder supports transparent .png graphics. If you use a transparent .png, the transparent\n portion of the video appears as if you had specified a value of 0 for\n <code>Opacity</code>. The .jpg file format doesn't support transparency.</p>\n "
|
|
1711
1717
|
},
|
|
1712
1718
|
"Target": {
|
|
@@ -1731,7 +1737,7 @@
|
|
|
1731
1737
|
"shape_name": "AudioCodec",
|
|
1732
1738
|
"type": "string",
|
|
1733
1739
|
"pattern": "(^AAC$)|(^vorbis$)|(^mp3$)",
|
|
1734
|
-
"documentation": "\n <p>
|
|
1740
|
+
"documentation": "\n <p>The audio codec for the output file. Valid values include <code>aac</code>, \n <code>mp3</code>, and <code>vorbis</code>.</p>\n "
|
|
1735
1741
|
},
|
|
1736
1742
|
"SampleRate": {
|
|
1737
1743
|
"shape_name": "AudioSampleRate",
|
|
@@ -1750,6 +1756,19 @@
|
|
|
1750
1756
|
"type": "string",
|
|
1751
1757
|
"pattern": "(^auto$)|(^0$)|(^1$)|(^2$)",
|
|
1752
1758
|
"documentation": "\n <p>The number of audio channels in the output file. Valid values include:</p>\n <p><code>auto</code>, <code>0</code>, <code>1</code>, <code>2</code></p>\n <p>If you specify <code>auto</code>, Elastic Transcoder automatically detects the number of channels in\n the input file.</p>\n "
|
|
1759
|
+
},
|
|
1760
|
+
"CodecOptions": {
|
|
1761
|
+
"shape_name": "AudioCodecOptions",
|
|
1762
|
+
"type": "structure",
|
|
1763
|
+
"members": {
|
|
1764
|
+
"Profile": {
|
|
1765
|
+
"shape_name": "AudioCodecProfile",
|
|
1766
|
+
"type": "string",
|
|
1767
|
+
"pattern": "(^auto$)|(^AAC-LC$)|(^HE-AAC$)|(^HE-AACv2$)",
|
|
1768
|
+
"documentation": "\n <p>If you specified <code>AAC</code> for <code>Audio:Codec</code>, choose the AAC profile for the output file.\n Elastic Transcoder supports the following profiles:</p>\n <ul>\n <li>\n<code>auto</code>: If you specify <code>auto</code>, Elastic Transcoder will select\n the profile based on the bit rate selected for the output file.</li>\n <li>\n<code>AAC-LC</code>: The most common AAC profile. Use for bitrates larger than\n 64 kbps.</li>\n <li>\n<code>HE-AAC</code>: Not supported on some older players and devices.\n Use for bitrates between 40 and 80 kbps.</li>\n <li>\n<code>HE-AACv2</code>: Not supported on some players and devices.\n Use for bitrates less than 48 kbps.</li>\n </ul>\n <note><p>If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated\n your presets to use AAC-LC. You can change the value as required.</p></note> \n "
|
|
1769
|
+
}
|
|
1770
|
+
},
|
|
1771
|
+
"documentation": "\n <p>If you specified <code>AAC</code> for <code>Audio:Codec</code>, this is the <code>AAC</code> \n compression profile to use. Valid values include:</p>\n <p><code>auto</code>, <code>AAC-LC</code>, <code>HE-AAC</code>, <code>HE-AACv2</code></p>\n <p>If you specify <code>auto</code>, Elastic Transcoder chooses a profile based on the bit rate of the output file.</p>\n "
|
|
1753
1772
|
}
|
|
1754
1773
|
},
|
|
1755
1774
|
"documentation": "\n <p>A section of the request body that specifies the audio parameters.</p>\n "
|
|
@@ -1826,6 +1845,11 @@
|
|
|
1826
1845
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
1827
1846
|
"documentation": "\n <p>Identifier for the new preset. You use this value to get settings for the preset or to\n delete it.</p>\n "
|
|
1828
1847
|
},
|
|
1848
|
+
"Arn": {
|
|
1849
|
+
"shape_name": "String",
|
|
1850
|
+
"type": "string",
|
|
1851
|
+
"documentation": "\n <p>The Amazon Resource Name (ARN) for the preset.</p>\n "
|
|
1852
|
+
},
|
|
1829
1853
|
"Name": {
|
|
1830
1854
|
"shape_name": "Name",
|
|
1831
1855
|
"type": "string",
|
|
@@ -1854,7 +1878,7 @@
|
|
|
1854
1878
|
"shape_name": "AudioCodec",
|
|
1855
1879
|
"type": "string",
|
|
1856
1880
|
"pattern": "(^AAC$)|(^vorbis$)|(^mp3$)",
|
|
1857
|
-
"documentation": "\n <p>
|
|
1881
|
+
"documentation": "\n <p>The audio codec for the output file. Valid values include <code>aac</code>, \n <code>mp3</code>, and <code>vorbis</code>.</p>\n "
|
|
1858
1882
|
},
|
|
1859
1883
|
"SampleRate": {
|
|
1860
1884
|
"shape_name": "AudioSampleRate",
|
|
@@ -1873,6 +1897,19 @@
|
|
|
1873
1897
|
"type": "string",
|
|
1874
1898
|
"pattern": "(^auto$)|(^0$)|(^1$)|(^2$)",
|
|
1875
1899
|
"documentation": "\n <p>The number of audio channels in the output file. Valid values include:</p>\n <p><code>auto</code>, <code>0</code>, <code>1</code>, <code>2</code></p>\n <p>If you specify <code>auto</code>, Elastic Transcoder automatically detects the number of channels in\n the input file.</p>\n "
|
|
1900
|
+
},
|
|
1901
|
+
"CodecOptions": {
|
|
1902
|
+
"shape_name": "AudioCodecOptions",
|
|
1903
|
+
"type": "structure",
|
|
1904
|
+
"members": {
|
|
1905
|
+
"Profile": {
|
|
1906
|
+
"shape_name": "AudioCodecProfile",
|
|
1907
|
+
"type": "string",
|
|
1908
|
+
"pattern": "(^auto$)|(^AAC-LC$)|(^HE-AAC$)|(^HE-AACv2$)",
|
|
1909
|
+
"documentation": "\n <p>If you specified <code>AAC</code> for <code>Audio:Codec</code>, choose the AAC profile for the output file.\n Elastic Transcoder supports the following profiles:</p>\n <ul>\n <li>\n<code>auto</code>: If you specify <code>auto</code>, Elastic Transcoder will select\n the profile based on the bit rate selected for the output file.</li>\n <li>\n<code>AAC-LC</code>: The most common AAC profile. Use for bitrates larger than\n 64 kbps.</li>\n <li>\n<code>HE-AAC</code>: Not supported on some older players and devices.\n Use for bitrates between 40 and 80 kbps.</li>\n <li>\n<code>HE-AACv2</code>: Not supported on some players and devices.\n Use for bitrates less than 48 kbps.</li>\n </ul>\n <note><p>If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated\n your presets to use AAC-LC. You can change the value as required.</p></note> \n "
|
|
1910
|
+
}
|
|
1911
|
+
},
|
|
1912
|
+
"documentation": "\n <p>If you specified <code>AAC</code> for <code>Audio:Codec</code>, this is the <code>AAC</code> \n compression profile to use. Valid values include:</p>\n <p><code>auto</code>, <code>AAC-LC</code>, <code>HE-AAC</code>, <code>HE-AACv2</code></p>\n <p>If you specify <code>auto</code>, Elastic Transcoder chooses a profile based on the bit rate of the output file.</p>\n "
|
|
1876
1913
|
}
|
|
1877
1914
|
},
|
|
1878
1915
|
"documentation": "\n <p>A section of the response body that provides information about the audio preset\n values.</p>\n "
|
|
@@ -1996,13 +2033,13 @@
|
|
|
1996
2033
|
"MaxWidth": {
|
|
1997
2034
|
"shape_name": "PixelsOrPercent",
|
|
1998
2035
|
"type": "string",
|
|
1999
|
-
"pattern": "(^\\d{1,3}(
|
|
2036
|
+
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)",
|
|
2000
2037
|
"documentation": "\n <p>The maximum width of the watermark in one of the following formats: <ul>\n <li>number of pixels (px): The minimum value is 16 pixels, and the maximum value is\n the value of <code>MaxWidth</code>.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100. Use the value of\n <code>Target</code> to specify whether you want Elastic Transcoder to include the black\n bars that are added by Elastic Transcoder, if any, in the calculation.</li> If\n you specify the value in pixels, it must be less than or equal to the value of\n <code>MaxWidth</code>.</ul></p>\n "
|
|
2001
2038
|
},
|
|
2002
2039
|
"MaxHeight": {
|
|
2003
2040
|
"shape_name": "PixelsOrPercent",
|
|
2004
2041
|
"type": "string",
|
|
2005
|
-
"pattern": "(^\\d{1,3}(
|
|
2042
|
+
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)",
|
|
2006
2043
|
"documentation": "\n <p>The maximum height of the watermark in one of the following formats: <ul>\n <li>number of pixels (px): The minimum value is 16 pixels, and the maximum value is\n the value of <code>MaxHeight</code>.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100. Use the value of\n <code>Target</code> to specify whether you want Elastic Transcoder to include the black\n bars that are added by Elastic Transcoder, if any, in the calculation.</li>\n </ul> If you specify the value in pixels, it must be less than or equal to the value of\n <code>MaxHeight</code>.</p>\n "
|
|
2007
2044
|
},
|
|
2008
2045
|
"SizingPolicy": {
|
|
@@ -2020,7 +2057,7 @@
|
|
|
2020
2057
|
"HorizontalOffset": {
|
|
2021
2058
|
"shape_name": "PixelsOrPercent",
|
|
2022
2059
|
"type": "string",
|
|
2023
|
-
"pattern": "(^\\d{1,3}(
|
|
2060
|
+
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)",
|
|
2024
2061
|
"documentation": "\n <p>The amount by which you want the horizontal position of the watermark to be offset from\n the position specified by HorizontalAlign: <ul>\n <li>number of pixels (px): The minimum value is 0 pixels, and the maximum value is\n the value of MaxWidth.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100.</li>\n </ul>For example, if you specify Left for <code>HorizontalAlign</code> and 5px for\n <code>HorizontalOffset</code>, the left side of the watermark appears 5 pixels from\n the left border of the output video.</p>\n <p><code>HorizontalOffset</code> is only valid when the value of\n <code>HorizontalAlign</code> is <code>Left</code> or <code>Right</code>. If you\n specify an offset that causes the watermark to extend beyond the left or right border\n and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic\n Transcoder has added black bars, the watermark extends into the black bars. If the\n watermark extends beyond the black bars, it is cropped.</p>\n <p>Use the value of <code>Target</code> to specify whether you want to include the black\n bars that are added by Elastic Transcoder, if any, in the offset calculation.</p>\n "
|
|
2025
2062
|
},
|
|
2026
2063
|
"VerticalAlign": {
|
|
@@ -2032,13 +2069,13 @@
|
|
|
2032
2069
|
"VerticalOffset": {
|
|
2033
2070
|
"shape_name": "PixelsOrPercent",
|
|
2034
2071
|
"type": "string",
|
|
2035
|
-
"pattern": "(^\\d{1,3}(
|
|
2072
|
+
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)",
|
|
2036
2073
|
"documentation": "\n <code>VerticalOffset</code>\n <p>The amount by which you want the vertical position of the watermark to be offset from the\n position specified by VerticalAlign:<ul>\n <li>number of pixels (px): The minimum value is 0 pixels, and the maximum value is\n the value of <code>MaxHeight</code>.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100.</li>\n </ul> For example, if you specify <code>Top</code> for <code>VerticalAlign</code> and\n <code>5px</code> for <code>VerticalOffset</code>, the top of the watermark appears 5\n pixels from the top border of the output video.</p>\n <p><code>VerticalOffset</code> is only valid when the value of VerticalAlign is Top or\n Bottom.</p>\n <p>If you specify an offset that causes the watermark to extend beyond the top or bottom\n border and Elastic Transcoder has not added black bars, the watermark is cropped. If\n Elastic Transcoder has added black bars, the watermark extends into the black bars. If\n the watermark extends beyond the black bars, it is cropped.</p>\n\n <p>Use the value of <code>Target</code> to specify whether you want Elastic Transcoder to\n include the black bars that are added by Elastic Transcoder, if any, in the offset\n calculation.</p>\n "
|
|
2037
2074
|
},
|
|
2038
2075
|
"Opacity": {
|
|
2039
2076
|
"shape_name": "Opacity",
|
|
2040
2077
|
"type": "string",
|
|
2041
|
-
"pattern": "^\\d{1,3}(
|
|
2078
|
+
"pattern": "^\\d{1,3}(\\.\\d{0,20})?$",
|
|
2042
2079
|
"documentation": "\n <p>A percentage that indicates how much you want a watermark to obscure the video in the\n location where it appears. Valid values are 0 (the watermark is invisible) to 100 (the\n watermark completely obscures the video in the specified location). The datatype of\n <code>Opacity</code> is float.</p>\n <p>Elastic Transcoder supports transparent .png graphics. If you use a transparent .png, the transparent\n portion of the video appears as if you had specified a value of 0 for\n <code>Opacity</code>. The .jpg file format doesn't support transparency.</p>\n "
|
|
2043
2080
|
},
|
|
2044
2081
|
"Target": {
|
|
@@ -2358,6 +2395,11 @@
|
|
|
2358
2395
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
2359
2396
|
"documentation": "\n <p> The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the\n job or to delete the job. </p>\n "
|
|
2360
2397
|
},
|
|
2398
|
+
"Arn": {
|
|
2399
|
+
"shape_name": "String",
|
|
2400
|
+
"type": "string",
|
|
2401
|
+
"documentation": "\n <p>The Amazon Resource Name (ARN) for the job.</p>\n "
|
|
2402
|
+
},
|
|
2361
2403
|
"PipelineId": {
|
|
2362
2404
|
"shape_name": "Id",
|
|
2363
2405
|
"type": "string",
|
|
@@ -2445,7 +2487,7 @@
|
|
|
2445
2487
|
"SegmentDuration": {
|
|
2446
2488
|
"shape_name": "Float",
|
|
2447
2489
|
"type": "string",
|
|
2448
|
-
"pattern": "^\\d{1,5}(
|
|
2490
|
+
"pattern": "^\\d{1,5}(\\.\\d{0,5})?$",
|
|
2449
2491
|
"documentation": "\n <p><important>(Outputs in MPEG-TS format only.</important>If you specify a preset in\n <code>PresetId</code> for which the value of <code>Container</code>is\n <code>ts</code> (MPEG-TS), <code>SegmentDuration</code> is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by <code>SegmentDuration</code>, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n <code>OutputKeys</code>.</p>\n "
|
|
2450
2492
|
},
|
|
2451
2493
|
"Status": {
|
|
@@ -2580,13 +2622,13 @@
|
|
|
2580
2622
|
"StartTime": {
|
|
2581
2623
|
"shape_name": "Time",
|
|
2582
2624
|
"type": "string",
|
|
2583
|
-
"pattern": "(^\\d{1,5}(
|
|
2625
|
+
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
2584
2626
|
"documentation": "\n <p>The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.</p>\n "
|
|
2585
2627
|
},
|
|
2586
2628
|
"Duration": {
|
|
2587
2629
|
"shape_name": "Time",
|
|
2588
2630
|
"type": "string",
|
|
2589
|
-
"pattern": "(^\\d{1,5}(
|
|
2631
|
+
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
2590
2632
|
"documentation": "\n <p>The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.</p>\n <p>If you specify a value longer than the duration of the input file , Elastic Transcoder transcodes \n the file and returns a warning message.</p>\n "
|
|
2591
2633
|
}
|
|
2592
2634
|
},
|
|
@@ -2640,7 +2682,7 @@
|
|
|
2640
2682
|
"SegmentDuration": {
|
|
2641
2683
|
"shape_name": "Float",
|
|
2642
2684
|
"type": "string",
|
|
2643
|
-
"pattern": "^\\d{1,5}(
|
|
2685
|
+
"pattern": "^\\d{1,5}(\\.\\d{0,5})?$",
|
|
2644
2686
|
"documentation": "\n <p><important>(Outputs in MPEG-TS format only.</important>If you specify a preset in\n <code>PresetId</code> for which the value of <code>Container</code>is\n <code>ts</code> (MPEG-TS), <code>SegmentDuration</code> is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by <code>SegmentDuration</code>, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n <code>OutputKeys</code>.</p>\n "
|
|
2645
2687
|
},
|
|
2646
2688
|
"Status": {
|
|
@@ -2775,13 +2817,13 @@
|
|
|
2775
2817
|
"StartTime": {
|
|
2776
2818
|
"shape_name": "Time",
|
|
2777
2819
|
"type": "string",
|
|
2778
|
-
"pattern": "(^\\d{1,5}(
|
|
2820
|
+
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
2779
2821
|
"documentation": "\n <p>The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.</p>\n "
|
|
2780
2822
|
},
|
|
2781
2823
|
"Duration": {
|
|
2782
2824
|
"shape_name": "Time",
|
|
2783
2825
|
"type": "string",
|
|
2784
|
-
"pattern": "(^\\d{1,5}(
|
|
2826
|
+
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
2785
2827
|
"documentation": "\n <p>The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.</p>\n <p>If you specify a value longer than the duration of the input file , Elastic Transcoder transcodes \n the file and returns a warning message.</p>\n "
|
|
2786
2828
|
}
|
|
2787
2829
|
},
|
|
@@ -2965,6 +3007,11 @@
|
|
|
2965
3007
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
2966
3008
|
"documentation": "\n <p> The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the\n job or to delete the job. </p>\n "
|
|
2967
3009
|
},
|
|
3010
|
+
"Arn": {
|
|
3011
|
+
"shape_name": "String",
|
|
3012
|
+
"type": "string",
|
|
3013
|
+
"documentation": "\n <p>The Amazon Resource Name (ARN) for the job.</p>\n "
|
|
3014
|
+
},
|
|
2968
3015
|
"PipelineId": {
|
|
2969
3016
|
"shape_name": "Id",
|
|
2970
3017
|
"type": "string",
|
|
@@ -3052,7 +3099,7 @@
|
|
|
3052
3099
|
"SegmentDuration": {
|
|
3053
3100
|
"shape_name": "Float",
|
|
3054
3101
|
"type": "string",
|
|
3055
|
-
"pattern": "^\\d{1,5}(
|
|
3102
|
+
"pattern": "^\\d{1,5}(\\.\\d{0,5})?$",
|
|
3056
3103
|
"documentation": "\n <p><important>(Outputs in MPEG-TS format only.</important>If you specify a preset in\n <code>PresetId</code> for which the value of <code>Container</code>is\n <code>ts</code> (MPEG-TS), <code>SegmentDuration</code> is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by <code>SegmentDuration</code>, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n <code>OutputKeys</code>.</p>\n "
|
|
3057
3104
|
},
|
|
3058
3105
|
"Status": {
|
|
@@ -3187,13 +3234,13 @@
|
|
|
3187
3234
|
"StartTime": {
|
|
3188
3235
|
"shape_name": "Time",
|
|
3189
3236
|
"type": "string",
|
|
3190
|
-
"pattern": "(^\\d{1,5}(
|
|
3237
|
+
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
3191
3238
|
"documentation": "\n <p>The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.</p>\n "
|
|
3192
3239
|
},
|
|
3193
3240
|
"Duration": {
|
|
3194
3241
|
"shape_name": "Time",
|
|
3195
3242
|
"type": "string",
|
|
3196
|
-
"pattern": "(^\\d{1,5}(
|
|
3243
|
+
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
3197
3244
|
"documentation": "\n <p>The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.</p>\n <p>If you specify a value longer than the duration of the input file , Elastic Transcoder transcodes \n the file and returns a warning message.</p>\n "
|
|
3198
3245
|
}
|
|
3199
3246
|
},
|
|
@@ -3247,7 +3294,7 @@
|
|
|
3247
3294
|
"SegmentDuration": {
|
|
3248
3295
|
"shape_name": "Float",
|
|
3249
3296
|
"type": "string",
|
|
3250
|
-
"pattern": "^\\d{1,5}(
|
|
3297
|
+
"pattern": "^\\d{1,5}(\\.\\d{0,5})?$",
|
|
3251
3298
|
"documentation": "\n <p><important>(Outputs in MPEG-TS format only.</important>If you specify a preset in\n <code>PresetId</code> for which the value of <code>Container</code>is\n <code>ts</code> (MPEG-TS), <code>SegmentDuration</code> is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by <code>SegmentDuration</code>, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n <code>OutputKeys</code>.</p>\n "
|
|
3252
3299
|
},
|
|
3253
3300
|
"Status": {
|
|
@@ -3382,13 +3429,13 @@
|
|
|
3382
3429
|
"StartTime": {
|
|
3383
3430
|
"shape_name": "Time",
|
|
3384
3431
|
"type": "string",
|
|
3385
|
-
"pattern": "(^\\d{1,5}(
|
|
3432
|
+
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
3386
3433
|
"documentation": "\n <p>The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.</p>\n "
|
|
3387
3434
|
},
|
|
3388
3435
|
"Duration": {
|
|
3389
3436
|
"shape_name": "Time",
|
|
3390
3437
|
"type": "string",
|
|
3391
|
-
"pattern": "(^\\d{1,5}(
|
|
3438
|
+
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
3392
3439
|
"documentation": "\n <p>The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.</p>\n <p>If you specify a value longer than the duration of the input file , Elastic Transcoder transcodes \n the file and returns a warning message.</p>\n "
|
|
3393
3440
|
}
|
|
3394
3441
|
},
|
|
@@ -3525,12 +3572,26 @@
|
|
|
3525
3572
|
"name": "ListPipelines",
|
|
3526
3573
|
"http": {
|
|
3527
3574
|
"method": "GET",
|
|
3528
|
-
"uri": "/2012-09-25/pipelines"
|
|
3575
|
+
"uri": "/2012-09-25/pipelines?Ascending={Ascending}&PageToken={PageToken}"
|
|
3529
3576
|
},
|
|
3530
3577
|
"input": {
|
|
3531
3578
|
"shape_name": "ListPipelinesRequest",
|
|
3532
3579
|
"type": "structure",
|
|
3533
3580
|
"members": {
|
|
3581
|
+
"Ascending": {
|
|
3582
|
+
"shape_name": "Ascending",
|
|
3583
|
+
"type": "string",
|
|
3584
|
+
"pattern": "(^true$)|(^false$)",
|
|
3585
|
+
"documentation": "\n <p>To list pipelines in chronological order by the date and time that they were created, enter\n <code>true</code>. To list pipelines in reverse chronological order, enter\n <code>false</code>.</p>\n ",
|
|
3586
|
+
"location": "uri"
|
|
3587
|
+
},
|
|
3588
|
+
"PageToken": {
|
|
3589
|
+
"shape_name": "Id",
|
|
3590
|
+
"type": "string",
|
|
3591
|
+
"pattern": "^\\d{13}-\\w{6}$",
|
|
3592
|
+
"documentation": "\n <p>When Elastic Transcoder returns more than one page of results, use <code>pageToken</code> in\n subsequent <code>GET</code> requests to get each successive page of results. </p>\n ",
|
|
3593
|
+
"location": "uri"
|
|
3594
|
+
}
|
|
3534
3595
|
},
|
|
3535
3596
|
"documentation": "\n <p>The <code>ListPipelineRequest</code> structure.</p>\n "
|
|
3536
3597
|
},
|
|
@@ -3736,6 +3797,12 @@
|
|
|
3736
3797
|
"documentation": "\n <p>The pipeline (queue) that is used to manage jobs.</p>\n "
|
|
3737
3798
|
},
|
|
3738
3799
|
"documentation": "\n <p>An array of <code>Pipeline</code> objects.</p>\n "
|
|
3800
|
+
},
|
|
3801
|
+
"NextPageToken": {
|
|
3802
|
+
"shape_name": "Id",
|
|
3803
|
+
"type": "string",
|
|
3804
|
+
"pattern": "^\\d{13}-\\w{6}$",
|
|
3805
|
+
"documentation": "\n <p>A value that you use to access the second and subsequent pages of results, if any. When\n the pipelines fit on one page or when you've reached the last page\n of results, the value of <code>NextPageToken</code> is <code>null</code>.</p>\n "
|
|
3739
3806
|
}
|
|
3740
3807
|
},
|
|
3741
3808
|
"documentation": "\n <p>A list of the pipelines associated with the current AWS account.</p>\n "
|
|
@@ -3776,12 +3843,26 @@
|
|
|
3776
3843
|
"name": "ListPresets",
|
|
3777
3844
|
"http": {
|
|
3778
3845
|
"method": "GET",
|
|
3779
|
-
"uri": "/2012-09-25/presets"
|
|
3846
|
+
"uri": "/2012-09-25/presets?Ascending={Ascending}&PageToken={PageToken}"
|
|
3780
3847
|
},
|
|
3781
3848
|
"input": {
|
|
3782
3849
|
"shape_name": "ListPresetsRequest",
|
|
3783
3850
|
"type": "structure",
|
|
3784
3851
|
"members": {
|
|
3852
|
+
"Ascending": {
|
|
3853
|
+
"shape_name": "Ascending",
|
|
3854
|
+
"type": "string",
|
|
3855
|
+
"pattern": "(^true$)|(^false$)",
|
|
3856
|
+
"documentation": "\n <p>To list presets in chronological order by the date and time that they were created, enter\n <code>true</code>. To list presets in reverse chronological order, enter\n <code>false</code>.</p>\n ",
|
|
3857
|
+
"location": "uri"
|
|
3858
|
+
},
|
|
3859
|
+
"PageToken": {
|
|
3860
|
+
"shape_name": "Id",
|
|
3861
|
+
"type": "string",
|
|
3862
|
+
"pattern": "^\\d{13}-\\w{6}$",
|
|
3863
|
+
"documentation": "\n <p>When Elastic Transcoder returns more than one page of results, use <code>pageToken</code> in\n subsequent <code>GET</code> requests to get each successive page of results. </p>\n ",
|
|
3864
|
+
"location": "uri"
|
|
3865
|
+
}
|
|
3785
3866
|
},
|
|
3786
3867
|
"documentation": "\n <p>The <code>ListPresetsRequest</code> structure.</p>\n "
|
|
3787
3868
|
},
|
|
@@ -3802,6 +3883,11 @@
|
|
|
3802
3883
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
3803
3884
|
"documentation": "\n <p>Identifier for the new preset. You use this value to get settings for the preset or to\n delete it.</p>\n "
|
|
3804
3885
|
},
|
|
3886
|
+
"Arn": {
|
|
3887
|
+
"shape_name": "String",
|
|
3888
|
+
"type": "string",
|
|
3889
|
+
"documentation": "\n <p>The Amazon Resource Name (ARN) for the preset.</p>\n "
|
|
3890
|
+
},
|
|
3805
3891
|
"Name": {
|
|
3806
3892
|
"shape_name": "Name",
|
|
3807
3893
|
"type": "string",
|
|
@@ -3830,7 +3916,7 @@
|
|
|
3830
3916
|
"shape_name": "AudioCodec",
|
|
3831
3917
|
"type": "string",
|
|
3832
3918
|
"pattern": "(^AAC$)|(^vorbis$)|(^mp3$)",
|
|
3833
|
-
"documentation": "\n <p>
|
|
3919
|
+
"documentation": "\n <p>The audio codec for the output file. Valid values include <code>aac</code>, \n <code>mp3</code>, and <code>vorbis</code>.</p>\n "
|
|
3834
3920
|
},
|
|
3835
3921
|
"SampleRate": {
|
|
3836
3922
|
"shape_name": "AudioSampleRate",
|
|
@@ -3849,6 +3935,19 @@
|
|
|
3849
3935
|
"type": "string",
|
|
3850
3936
|
"pattern": "(^auto$)|(^0$)|(^1$)|(^2$)",
|
|
3851
3937
|
"documentation": "\n <p>The number of audio channels in the output file. Valid values include:</p>\n <p><code>auto</code>, <code>0</code>, <code>1</code>, <code>2</code></p>\n <p>If you specify <code>auto</code>, Elastic Transcoder automatically detects the number of channels in\n the input file.</p>\n "
|
|
3938
|
+
},
|
|
3939
|
+
"CodecOptions": {
|
|
3940
|
+
"shape_name": "AudioCodecOptions",
|
|
3941
|
+
"type": "structure",
|
|
3942
|
+
"members": {
|
|
3943
|
+
"Profile": {
|
|
3944
|
+
"shape_name": "AudioCodecProfile",
|
|
3945
|
+
"type": "string",
|
|
3946
|
+
"pattern": "(^auto$)|(^AAC-LC$)|(^HE-AAC$)|(^HE-AACv2$)",
|
|
3947
|
+
"documentation": "\n <p>If you specified <code>AAC</code> for <code>Audio:Codec</code>, choose the AAC profile for the output file.\n Elastic Transcoder supports the following profiles:</p>\n <ul>\n <li>\n<code>auto</code>: If you specify <code>auto</code>, Elastic Transcoder will select\n the profile based on the bit rate selected for the output file.</li>\n <li>\n<code>AAC-LC</code>: The most common AAC profile. Use for bitrates larger than\n 64 kbps.</li>\n <li>\n<code>HE-AAC</code>: Not supported on some older players and devices.\n Use for bitrates between 40 and 80 kbps.</li>\n <li>\n<code>HE-AACv2</code>: Not supported on some players and devices.\n Use for bitrates less than 48 kbps.</li>\n </ul>\n <note><p>If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated\n your presets to use AAC-LC. You can change the value as required.</p></note> \n "
|
|
3948
|
+
}
|
|
3949
|
+
},
|
|
3950
|
+
"documentation": "\n <p>If you specified <code>AAC</code> for <code>Audio:Codec</code>, this is the <code>AAC</code> \n compression profile to use. Valid values include:</p>\n <p><code>auto</code>, <code>AAC-LC</code>, <code>HE-AAC</code>, <code>HE-AACv2</code></p>\n <p>If you specify <code>auto</code>, Elastic Transcoder chooses a profile based on the bit rate of the output file.</p>\n "
|
|
3852
3951
|
}
|
|
3853
3952
|
},
|
|
3854
3953
|
"documentation": "\n <p>A section of the response body that provides information about the audio preset\n values.</p>\n "
|
|
@@ -3972,13 +4071,13 @@
|
|
|
3972
4071
|
"MaxWidth": {
|
|
3973
4072
|
"shape_name": "PixelsOrPercent",
|
|
3974
4073
|
"type": "string",
|
|
3975
|
-
"pattern": "(^\\d{1,3}(
|
|
4074
|
+
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)",
|
|
3976
4075
|
"documentation": "\n <p>The maximum width of the watermark in one of the following formats: <ul>\n <li>number of pixels (px): The minimum value is 16 pixels, and the maximum value is\n the value of <code>MaxWidth</code>.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100. Use the value of\n <code>Target</code> to specify whether you want Elastic Transcoder to include the black\n bars that are added by Elastic Transcoder, if any, in the calculation.</li> If\n you specify the value in pixels, it must be less than or equal to the value of\n <code>MaxWidth</code>.</ul></p>\n "
|
|
3977
4076
|
},
|
|
3978
4077
|
"MaxHeight": {
|
|
3979
4078
|
"shape_name": "PixelsOrPercent",
|
|
3980
4079
|
"type": "string",
|
|
3981
|
-
"pattern": "(^\\d{1,3}(
|
|
4080
|
+
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)",
|
|
3982
4081
|
"documentation": "\n <p>The maximum height of the watermark in one of the following formats: <ul>\n <li>number of pixels (px): The minimum value is 16 pixels, and the maximum value is\n the value of <code>MaxHeight</code>.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100. Use the value of\n <code>Target</code> to specify whether you want Elastic Transcoder to include the black\n bars that are added by Elastic Transcoder, if any, in the calculation.</li>\n </ul> If you specify the value in pixels, it must be less than or equal to the value of\n <code>MaxHeight</code>.</p>\n "
|
|
3983
4082
|
},
|
|
3984
4083
|
"SizingPolicy": {
|
|
@@ -3996,7 +4095,7 @@
|
|
|
3996
4095
|
"HorizontalOffset": {
|
|
3997
4096
|
"shape_name": "PixelsOrPercent",
|
|
3998
4097
|
"type": "string",
|
|
3999
|
-
"pattern": "(^\\d{1,3}(
|
|
4098
|
+
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)",
|
|
4000
4099
|
"documentation": "\n <p>The amount by which you want the horizontal position of the watermark to be offset from\n the position specified by HorizontalAlign: <ul>\n <li>number of pixels (px): The minimum value is 0 pixels, and the maximum value is\n the value of MaxWidth.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100.</li>\n </ul>For example, if you specify Left for <code>HorizontalAlign</code> and 5px for\n <code>HorizontalOffset</code>, the left side of the watermark appears 5 pixels from\n the left border of the output video.</p>\n <p><code>HorizontalOffset</code> is only valid when the value of\n <code>HorizontalAlign</code> is <code>Left</code> or <code>Right</code>. If you\n specify an offset that causes the watermark to extend beyond the left or right border\n and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic\n Transcoder has added black bars, the watermark extends into the black bars. If the\n watermark extends beyond the black bars, it is cropped.</p>\n <p>Use the value of <code>Target</code> to specify whether you want to include the black\n bars that are added by Elastic Transcoder, if any, in the offset calculation.</p>\n "
|
|
4001
4100
|
},
|
|
4002
4101
|
"VerticalAlign": {
|
|
@@ -4008,13 +4107,13 @@
|
|
|
4008
4107
|
"VerticalOffset": {
|
|
4009
4108
|
"shape_name": "PixelsOrPercent",
|
|
4010
4109
|
"type": "string",
|
|
4011
|
-
"pattern": "(^\\d{1,3}(
|
|
4110
|
+
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)",
|
|
4012
4111
|
"documentation": "\n <code>VerticalOffset</code>\n <p>The amount by which you want the vertical position of the watermark to be offset from the\n position specified by VerticalAlign:<ul>\n <li>number of pixels (px): The minimum value is 0 pixels, and the maximum value is\n the value of <code>MaxHeight</code>.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100.</li>\n </ul> For example, if you specify <code>Top</code> for <code>VerticalAlign</code> and\n <code>5px</code> for <code>VerticalOffset</code>, the top of the watermark appears 5\n pixels from the top border of the output video.</p>\n <p><code>VerticalOffset</code> is only valid when the value of VerticalAlign is Top or\n Bottom.</p>\n <p>If you specify an offset that causes the watermark to extend beyond the top or bottom\n border and Elastic Transcoder has not added black bars, the watermark is cropped. If\n Elastic Transcoder has added black bars, the watermark extends into the black bars. If\n the watermark extends beyond the black bars, it is cropped.</p>\n\n <p>Use the value of <code>Target</code> to specify whether you want Elastic Transcoder to\n include the black bars that are added by Elastic Transcoder, if any, in the offset\n calculation.</p>\n "
|
|
4013
4112
|
},
|
|
4014
4113
|
"Opacity": {
|
|
4015
4114
|
"shape_name": "Opacity",
|
|
4016
4115
|
"type": "string",
|
|
4017
|
-
"pattern": "^\\d{1,3}(
|
|
4116
|
+
"pattern": "^\\d{1,3}(\\.\\d{0,20})?$",
|
|
4018
4117
|
"documentation": "\n <p>A percentage that indicates how much you want a watermark to obscure the video in the\n location where it appears. Valid values are 0 (the watermark is invisible) to 100 (the\n watermark completely obscures the video in the specified location). The datatype of\n <code>Opacity</code> is float.</p>\n <p>Elastic Transcoder supports transparent .png graphics. If you use a transparent .png, the transparent\n portion of the video appears as if you had specified a value of 0 for\n <code>Opacity</code>. The .jpg file format doesn't support transparency.</p>\n "
|
|
4019
4118
|
},
|
|
4020
4119
|
"Target": {
|
|
@@ -4096,6 +4195,12 @@
|
|
|
4096
4195
|
"documentation": "\n <p>Presets are templates that contain most of the settings for transcoding media files from\n one format to another. Elastic Transcoder includes some default presets for common formats, for\n example, several iPod and iPhone versions. You can also create your own presets for\n formats that aren't included among the default presets. You specify which preset you\n want to use when you create a job.</p>\n "
|
|
4097
4196
|
},
|
|
4098
4197
|
"documentation": "\n <p>An array of <code>Preset</code> objects.</p>\n "
|
|
4198
|
+
},
|
|
4199
|
+
"NextPageToken": {
|
|
4200
|
+
"shape_name": "Id",
|
|
4201
|
+
"type": "string",
|
|
4202
|
+
"pattern": "^\\d{13}-\\w{6}$",
|
|
4203
|
+
"documentation": "\n <p>A value that you use to access the second and subsequent pages of results, if any. When\n the presets fit on one page or when you've reached the last page\n of results, the value of <code>NextPageToken</code> is <code>null</code>.</p>\n "
|
|
4099
4204
|
}
|
|
4100
4205
|
},
|
|
4101
4206
|
"documentation": "\n <p>The <code>ListPresetsResponse</code> structure.</p>\n "
|
|
@@ -4166,6 +4271,11 @@
|
|
|
4166
4271
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
4167
4272
|
"documentation": "\n <p> The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the\n job or to delete the job. </p>\n "
|
|
4168
4273
|
},
|
|
4274
|
+
"Arn": {
|
|
4275
|
+
"shape_name": "String",
|
|
4276
|
+
"type": "string",
|
|
4277
|
+
"documentation": "\n <p>The Amazon Resource Name (ARN) for the job.</p>\n "
|
|
4278
|
+
},
|
|
4169
4279
|
"PipelineId": {
|
|
4170
4280
|
"shape_name": "Id",
|
|
4171
4281
|
"type": "string",
|
|
@@ -4253,7 +4363,7 @@
|
|
|
4253
4363
|
"SegmentDuration": {
|
|
4254
4364
|
"shape_name": "Float",
|
|
4255
4365
|
"type": "string",
|
|
4256
|
-
"pattern": "^\\d{1,5}(
|
|
4366
|
+
"pattern": "^\\d{1,5}(\\.\\d{0,5})?$",
|
|
4257
4367
|
"documentation": "\n <p><important>(Outputs in MPEG-TS format only.</important>If you specify a preset in\n <code>PresetId</code> for which the value of <code>Container</code>is\n <code>ts</code> (MPEG-TS), <code>SegmentDuration</code> is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by <code>SegmentDuration</code>, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n <code>OutputKeys</code>.</p>\n "
|
|
4258
4368
|
},
|
|
4259
4369
|
"Status": {
|
|
@@ -4388,13 +4498,13 @@
|
|
|
4388
4498
|
"StartTime": {
|
|
4389
4499
|
"shape_name": "Time",
|
|
4390
4500
|
"type": "string",
|
|
4391
|
-
"pattern": "(^\\d{1,5}(
|
|
4501
|
+
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
4392
4502
|
"documentation": "\n <p>The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.</p>\n "
|
|
4393
4503
|
},
|
|
4394
4504
|
"Duration": {
|
|
4395
4505
|
"shape_name": "Time",
|
|
4396
4506
|
"type": "string",
|
|
4397
|
-
"pattern": "(^\\d{1,5}(
|
|
4507
|
+
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
4398
4508
|
"documentation": "\n <p>The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.</p>\n <p>If you specify a value longer than the duration of the input file , Elastic Transcoder transcodes \n the file and returns a warning message.</p>\n "
|
|
4399
4509
|
}
|
|
4400
4510
|
},
|
|
@@ -4448,7 +4558,7 @@
|
|
|
4448
4558
|
"SegmentDuration": {
|
|
4449
4559
|
"shape_name": "Float",
|
|
4450
4560
|
"type": "string",
|
|
4451
|
-
"pattern": "^\\d{1,5}(
|
|
4561
|
+
"pattern": "^\\d{1,5}(\\.\\d{0,5})?$",
|
|
4452
4562
|
"documentation": "\n <p><important>(Outputs in MPEG-TS format only.</important>If you specify a preset in\n <code>PresetId</code> for which the value of <code>Container</code>is\n <code>ts</code> (MPEG-TS), <code>SegmentDuration</code> is the maximum duration of\n each .ts file in seconds. The range of valid values is 1 to 60 seconds. If the duration\n of the video is not evenly divisible by <code>SegmentDuration</code>, the duration of\n the last segment is the remainder of total length/SegmentDuration. Elastic Transcoder\n creates an output-specific playlist for each output that you specify in OutputKeys. To\n add an output to the master playlist for this job, include it in\n <code>OutputKeys</code>.</p>\n "
|
|
4453
4563
|
},
|
|
4454
4564
|
"Status": {
|
|
@@ -4583,13 +4693,13 @@
|
|
|
4583
4693
|
"StartTime": {
|
|
4584
4694
|
"shape_name": "Time",
|
|
4585
4695
|
"type": "string",
|
|
4586
|
-
"pattern": "(^\\d{1,5}(
|
|
4696
|
+
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
4587
4697
|
"documentation": "\n <p>The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS \n (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). \n If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.</p>\n "
|
|
4588
4698
|
},
|
|
4589
4699
|
"Duration": {
|
|
4590
4700
|
"shape_name": "Time",
|
|
4591
4701
|
"type": "string",
|
|
4592
|
-
"pattern": "(^\\d{1,5}(
|
|
4702
|
+
"pattern": "(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)",
|
|
4593
4703
|
"documentation": "\n <p>The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS \n is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, \n Elastic Transcoder creates an output file from StartTime to the end of the file.</p>\n <p>If you specify a value longer than the duration of the input file , Elastic Transcoder transcodes \n the file and returns a warning message.</p>\n "
|
|
4594
4704
|
}
|
|
4595
4705
|
},
|
|
@@ -5008,6 +5118,11 @@
|
|
|
5008
5118
|
"pattern": "^\\d{13}-\\w{6}$",
|
|
5009
5119
|
"documentation": "\n <p>Identifier for the new preset. You use this value to get settings for the preset or to\n delete it.</p>\n "
|
|
5010
5120
|
},
|
|
5121
|
+
"Arn": {
|
|
5122
|
+
"shape_name": "String",
|
|
5123
|
+
"type": "string",
|
|
5124
|
+
"documentation": "\n <p>The Amazon Resource Name (ARN) for the preset.</p>\n "
|
|
5125
|
+
},
|
|
5011
5126
|
"Name": {
|
|
5012
5127
|
"shape_name": "Name",
|
|
5013
5128
|
"type": "string",
|
|
@@ -5036,7 +5151,7 @@
|
|
|
5036
5151
|
"shape_name": "AudioCodec",
|
|
5037
5152
|
"type": "string",
|
|
5038
5153
|
"pattern": "(^AAC$)|(^vorbis$)|(^mp3$)",
|
|
5039
|
-
"documentation": "\n <p>
|
|
5154
|
+
"documentation": "\n <p>The audio codec for the output file. Valid values include <code>aac</code>, \n <code>mp3</code>, and <code>vorbis</code>.</p>\n "
|
|
5040
5155
|
},
|
|
5041
5156
|
"SampleRate": {
|
|
5042
5157
|
"shape_name": "AudioSampleRate",
|
|
@@ -5055,6 +5170,19 @@
|
|
|
5055
5170
|
"type": "string",
|
|
5056
5171
|
"pattern": "(^auto$)|(^0$)|(^1$)|(^2$)",
|
|
5057
5172
|
"documentation": "\n <p>The number of audio channels in the output file. Valid values include:</p>\n <p><code>auto</code>, <code>0</code>, <code>1</code>, <code>2</code></p>\n <p>If you specify <code>auto</code>, Elastic Transcoder automatically detects the number of channels in\n the input file.</p>\n "
|
|
5173
|
+
},
|
|
5174
|
+
"CodecOptions": {
|
|
5175
|
+
"shape_name": "AudioCodecOptions",
|
|
5176
|
+
"type": "structure",
|
|
5177
|
+
"members": {
|
|
5178
|
+
"Profile": {
|
|
5179
|
+
"shape_name": "AudioCodecProfile",
|
|
5180
|
+
"type": "string",
|
|
5181
|
+
"pattern": "(^auto$)|(^AAC-LC$)|(^HE-AAC$)|(^HE-AACv2$)",
|
|
5182
|
+
"documentation": "\n <p>If you specified <code>AAC</code> for <code>Audio:Codec</code>, choose the AAC profile for the output file.\n Elastic Transcoder supports the following profiles:</p>\n <ul>\n <li>\n<code>auto</code>: If you specify <code>auto</code>, Elastic Transcoder will select\n the profile based on the bit rate selected for the output file.</li>\n <li>\n<code>AAC-LC</code>: The most common AAC profile. Use for bitrates larger than\n 64 kbps.</li>\n <li>\n<code>HE-AAC</code>: Not supported on some older players and devices.\n Use for bitrates between 40 and 80 kbps.</li>\n <li>\n<code>HE-AACv2</code>: Not supported on some players and devices.\n Use for bitrates less than 48 kbps.</li>\n </ul>\n <note><p>If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated\n your presets to use AAC-LC. You can change the value as required.</p></note> \n "
|
|
5183
|
+
}
|
|
5184
|
+
},
|
|
5185
|
+
"documentation": "\n <p>If you specified <code>AAC</code> for <code>Audio:Codec</code>, this is the <code>AAC</code> \n compression profile to use. Valid values include:</p>\n <p><code>auto</code>, <code>AAC-LC</code>, <code>HE-AAC</code>, <code>HE-AACv2</code></p>\n <p>If you specify <code>auto</code>, Elastic Transcoder chooses a profile based on the bit rate of the output file.</p>\n "
|
|
5058
5186
|
}
|
|
5059
5187
|
},
|
|
5060
5188
|
"documentation": "\n <p>A section of the response body that provides information about the audio preset\n values.</p>\n "
|
|
@@ -5178,13 +5306,13 @@
|
|
|
5178
5306
|
"MaxWidth": {
|
|
5179
5307
|
"shape_name": "PixelsOrPercent",
|
|
5180
5308
|
"type": "string",
|
|
5181
|
-
"pattern": "(^\\d{1,3}(
|
|
5309
|
+
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)",
|
|
5182
5310
|
"documentation": "\n <p>The maximum width of the watermark in one of the following formats: <ul>\n <li>number of pixels (px): The minimum value is 16 pixels, and the maximum value is\n the value of <code>MaxWidth</code>.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100. Use the value of\n <code>Target</code> to specify whether you want Elastic Transcoder to include the black\n bars that are added by Elastic Transcoder, if any, in the calculation.</li> If\n you specify the value in pixels, it must be less than or equal to the value of\n <code>MaxWidth</code>.</ul></p>\n "
|
|
5183
5311
|
},
|
|
5184
5312
|
"MaxHeight": {
|
|
5185
5313
|
"shape_name": "PixelsOrPercent",
|
|
5186
5314
|
"type": "string",
|
|
5187
|
-
"pattern": "(^\\d{1,3}(
|
|
5315
|
+
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)",
|
|
5188
5316
|
"documentation": "\n <p>The maximum height of the watermark in one of the following formats: <ul>\n <li>number of pixels (px): The minimum value is 16 pixels, and the maximum value is\n the value of <code>MaxHeight</code>.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100. Use the value of\n <code>Target</code> to specify whether you want Elastic Transcoder to include the black\n bars that are added by Elastic Transcoder, if any, in the calculation.</li>\n </ul> If you specify the value in pixels, it must be less than or equal to the value of\n <code>MaxHeight</code>.</p>\n "
|
|
5189
5317
|
},
|
|
5190
5318
|
"SizingPolicy": {
|
|
@@ -5202,7 +5330,7 @@
|
|
|
5202
5330
|
"HorizontalOffset": {
|
|
5203
5331
|
"shape_name": "PixelsOrPercent",
|
|
5204
5332
|
"type": "string",
|
|
5205
|
-
"pattern": "(^\\d{1,3}(
|
|
5333
|
+
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)",
|
|
5206
5334
|
"documentation": "\n <p>The amount by which you want the horizontal position of the watermark to be offset from\n the position specified by HorizontalAlign: <ul>\n <li>number of pixels (px): The minimum value is 0 pixels, and the maximum value is\n the value of MaxWidth.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100.</li>\n </ul>For example, if you specify Left for <code>HorizontalAlign</code> and 5px for\n <code>HorizontalOffset</code>, the left side of the watermark appears 5 pixels from\n the left border of the output video.</p>\n <p><code>HorizontalOffset</code> is only valid when the value of\n <code>HorizontalAlign</code> is <code>Left</code> or <code>Right</code>. If you\n specify an offset that causes the watermark to extend beyond the left or right border\n and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic\n Transcoder has added black bars, the watermark extends into the black bars. If the\n watermark extends beyond the black bars, it is cropped.</p>\n <p>Use the value of <code>Target</code> to specify whether you want to include the black\n bars that are added by Elastic Transcoder, if any, in the offset calculation.</p>\n "
|
|
5207
5335
|
},
|
|
5208
5336
|
"VerticalAlign": {
|
|
@@ -5214,13 +5342,13 @@
|
|
|
5214
5342
|
"VerticalOffset": {
|
|
5215
5343
|
"shape_name": "PixelsOrPercent",
|
|
5216
5344
|
"type": "string",
|
|
5217
|
-
"pattern": "(^\\d{1,3}(
|
|
5345
|
+
"pattern": "(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{2,4}?px$)",
|
|
5218
5346
|
"documentation": "\n <code>VerticalOffset</code>\n <p>The amount by which you want the vertical position of the watermark to be offset from the\n position specified by VerticalAlign:<ul>\n <li>number of pixels (px): The minimum value is 0 pixels, and the maximum value is\n the value of <code>MaxHeight</code>.</li>\n <li>integer percentage (%): The range of valid values is 0 to 100.</li>\n </ul> For example, if you specify <code>Top</code> for <code>VerticalAlign</code> and\n <code>5px</code> for <code>VerticalOffset</code>, the top of the watermark appears 5\n pixels from the top border of the output video.</p>\n <p><code>VerticalOffset</code> is only valid when the value of VerticalAlign is Top or\n Bottom.</p>\n <p>If you specify an offset that causes the watermark to extend beyond the top or bottom\n border and Elastic Transcoder has not added black bars, the watermark is cropped. If\n Elastic Transcoder has added black bars, the watermark extends into the black bars. If\n the watermark extends beyond the black bars, it is cropped.</p>\n\n <p>Use the value of <code>Target</code> to specify whether you want Elastic Transcoder to\n include the black bars that are added by Elastic Transcoder, if any, in the offset\n calculation.</p>\n "
|
|
5219
5347
|
},
|
|
5220
5348
|
"Opacity": {
|
|
5221
5349
|
"shape_name": "Opacity",
|
|
5222
5350
|
"type": "string",
|
|
5223
|
-
"pattern": "^\\d{1,3}(
|
|
5351
|
+
"pattern": "^\\d{1,3}(\\.\\d{0,20})?$",
|
|
5224
5352
|
"documentation": "\n <p>A percentage that indicates how much you want a watermark to obscure the video in the\n location where it appears. Valid values are 0 (the watermark is invisible) to 100 (the\n watermark completely obscures the video in the specified location). The datatype of\n <code>Opacity</code> is float.</p>\n <p>Elastic Transcoder supports transparent .png graphics. If you use a transparent .png, the transparent\n portion of the video appears as if you had specified a value of 0 for\n <code>Opacity</code>. The .jpg file format doesn't support transparency.</p>\n "
|
|
5225
5353
|
},
|
|
5226
5354
|
"Target": {
|