aws-sdk-core 2.0.0.rc1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +7 -0
- data/.simplecov +6 -0
- data/.travis.yml +12 -0
- data/.yardopts +11 -0
- data/Gemfile +26 -0
- data/LICENSE.txt +12 -0
- data/README.md +169 -0
- data/Rakefile +15 -0
- data/apis/AutoScaling-2011-01-01.json +1852 -0
- data/apis/CloudFormation-2010-05-15.json +981 -0
- data/apis/CloudFront-2012-05-05.json +3861 -0
- data/apis/CloudFront-2013-05-12.json +4593 -0
- data/apis/CloudFront-2013-08-26.json +4849 -0
- data/apis/CloudSearch-2011-02-01.json +2080 -0
- data/apis/CloudWatch-2010-08-01.json +1206 -0
- data/apis/DataPipeline-2012-10-29.json +901 -0
- data/apis/DirectConnect-2012-10-25.json +825 -0
- data/apis/DynamoDB-2011-12-05.json +2857 -0
- data/apis/DynamoDB-2012-08-10.json +3127 -0
- data/apis/EC2-2013-06-15.json +13600 -0
- data/apis/EC2-2013-10-01.json +14574 -0
- data/apis/EMR-2009-03-31.json +957 -0
- data/apis/ElastiCache-2012-11-15.json +2921 -0
- data/apis/ElastiCache-2013-06-15.json +3586 -0
- data/apis/ElasticBeanstalk-2010-12-01.json +2225 -0
- data/apis/ElasticLoadBalancing-2012-06-01.json +1215 -0
- data/apis/ElasticTranscoder-2012-09-25.json +3692 -0
- data/apis/Glacier-2012-06-01.json +1058 -0
- data/apis/IAM-2010-05-08.json +2863 -0
- data/apis/ImportExport-2010-06-01.json +328 -0
- data/apis/OpsWorks-2013-02-18.json +3546 -0
- data/apis/RDS-2013-01-10.json +6772 -0
- data/apis/RDS-2013-02-12.json +7151 -0
- data/apis/RDS-2013-05-15.json +7809 -0
- data/apis/Redshift-2012-12-01.json +4180 -0
- data/apis/Route53-2012-12-12.json +1018 -0
- data/apis/S3-2006-03-01.json +3787 -0
- data/apis/SDB-2009-04-15.json +539 -0
- data/apis/SES-2010-12-01.json +678 -0
- data/apis/SNS-2010-03-31.json +870 -0
- data/apis/SQS-2012-11-05.json +798 -0
- data/apis/STS-2011-06-15.json +352 -0
- data/apis/SWF-2012-01-25.json +5451 -0
- data/apis/StorageGateway-2012-06-30.json +1696 -0
- data/apis/Support-2013-04-15.json +794 -0
- data/apis/configuration/endpoints.json +1337 -0
- data/apis/source/autoscaling-2011-01-01.json +3215 -0
- data/apis/source/autoscaling-2011-01-01.paginators.json +52 -0
- data/apis/source/cloudformation-2010-05-15.json +1260 -0
- data/apis/source/cloudformation-2010-05-15.paginators.json +24 -0
- data/apis/source/cloudfront-2012-05-05.json +6588 -0
- data/apis/source/cloudfront-2012-05-05.paginators.json +28 -0
- data/apis/source/cloudfront-2013-05-12.json +7614 -0
- data/apis/source/cloudfront-2013-05-12.paginators.json +28 -0
- data/apis/source/cloudfront-2013-08-26.json +8016 -0
- data/apis/source/cloudfront-2013-08-26.paginators.json +28 -0
- data/apis/source/cloudsearch-2011-02-01.json +3585 -0
- data/apis/source/cloudsearch-2011-02-01.paginators.json +13 -0
- data/apis/source/datapipeline-2012-10-29.json +2144 -0
- data/apis/source/datapipeline-2012-10-29.paginators.json +25 -0
- data/apis/source/directconnect-2012-10-25.json +1271 -0
- data/apis/source/directconnect-2012-10-25.paginators.json +16 -0
- data/apis/source/dynamodb-2011-12-05.json +4380 -0
- data/apis/source/dynamodb-2011-12-05.paginators.json +24 -0
- data/apis/source/dynamodb-2012-08-10.json +4839 -0
- data/apis/source/dynamodb-2012-08-10.paginators.json +24 -0
- data/apis/source/ec2-2013-02-01.json +18820 -0
- data/apis/source/ec2-2013-02-01.paginators.json +115 -0
- data/apis/source/ec2-2013-06-15.json +18820 -0
- data/apis/source/ec2-2013-06-15.paginators.json +115 -0
- data/apis/source/ec2-2013-10-01.json +19885 -0
- data/apis/source/ec2-2013-10-01.paginators.json +115 -0
- data/apis/source/elasticache-2012-11-15.json +4403 -0
- data/apis/source/elasticache-2012-11-15.paginators.json +64 -0
- data/apis/source/elasticache-2013-06-15.json +5421 -0
- data/apis/source/elasticache-2013-06-15.paginators.json +64 -0
- data/apis/source/elasticbeanstalk-2010-12-01.json +3151 -0
- data/apis/source/elasticbeanstalk-2010-12-01.paginators.json +25 -0
- data/apis/source/elasticloadbalancing-2012-06-01.json +2041 -0
- data/apis/source/elasticloadbalancing-2012-06-01.paginators.json +18 -0
- data/apis/source/elasticmapreduce-2009-03-31.json +1478 -0
- data/apis/source/elasticmapreduce-2009-03-31.paginators.json +7 -0
- data/apis/source/elastictranscoder-2012-09-25.json +6148 -0
- data/apis/source/elastictranscoder-2012-09-25.paginators.json +20 -0
- data/apis/source/email-2010-12-01.json +892 -0
- data/apis/source/email-2010-12-01.paginators.json +13 -0
- data/apis/source/glacier-2012-06-01.json +3147 -0
- data/apis/source/glacier-2012-06-01.paginators.json +28 -0
- data/apis/source/iam-2010-05-08.json +5857 -0
- data/apis/source/iam-2010-05-08.paginators.json +116 -0
- data/apis/source/importexport-2010-06-01.json +876 -0
- data/apis/source/importexport-2010-06-01.paginators.json +10 -0
- data/apis/source/monitoring-2010-08-01.json +1910 -0
- data/apis/source/monitoring-2010-08-01.paginators.json +24 -0
- data/apis/source/opsworks-2013-02-18.json +5848 -0
- data/apis/source/opsworks-2013-02-18.paginators.json +46 -0
- data/apis/source/rds-2013-01-10.json +9283 -0
- data/apis/source/rds-2013-01-10.paginators.json +105 -0
- data/apis/source/rds-2013-02-12.json +9777 -0
- data/apis/source/rds-2013-02-12.paginators.json +105 -0
- data/apis/source/rds-2013-05-15.json +10618 -0
- data/apis/source/rds-2013-05-15.paginators.json +105 -0
- data/apis/source/redshift-2012-12-01.json +5742 -0
- data/apis/source/redshift-2012-12-01.paginators.json +74 -0
- data/apis/source/route53-2012-12-12.json +2067 -0
- data/apis/source/route53-2012-12-12.paginators.json +33 -0
- data/apis/source/s3-2006-03-01.json +4261 -0
- data/apis/source/s3-2006-03-01.paginators.json +46 -0
- data/apis/source/sdb-2009-04-15.json +1145 -0
- data/apis/source/sdb-2009-04-15.paginators.json +15 -0
- data/apis/source/sns-2010-03-31.json +2234 -0
- data/apis/source/sns-2010-03-31.paginators.json +19 -0
- data/apis/source/sqs-2012-11-05.json +1162 -0
- data/apis/source/sqs-2012-11-05.paginators.json +7 -0
- data/apis/source/storagegateway-2012-06-30.json +9487 -0
- data/apis/source/storagegateway-2012-06-30.paginators.json +28 -0
- data/apis/source/sts-2011-06-15.json +627 -0
- data/apis/source/support-2013-04-15.json +1261 -0
- data/apis/source/support-2013-04-15.paginators.json +31 -0
- data/apis/source/swf-2012-01-25.json +8744 -0
- data/apis/source/swf-2012-01-25.paginators.json +46 -0
- data/aws-sdk-core.gemspec +21 -0
- data/bin/aws.rb +156 -0
- data/doc-src/images/lastnode.png +0 -0
- data/doc-src/images/node.png +0 -0
- data/doc-src/images/vline.png +0 -0
- data/doc-src/plugins/apis.rb +205 -0
- data/doc-src/templates/default/fulldoc/html/css/common.css +90 -0
- data/doc-src/templates/default/fulldoc/html/js/tabs.js +21 -0
- data/doc-src/templates/default/fulldoc/html/setup.rb +61 -0
- data/doc-src/templates/default/layout/html/footer.erb +29 -0
- data/doc-src/templates/default/layout/html/setup.rb +3 -0
- data/features/autoscaling/client.feature +22 -0
- data/features/autoscaling/setup.rb +6 -0
- data/features/cloudformation/client.feature +18 -0
- data/features/cloudformation/setup.rb +6 -0
- data/features/cloudfront/client.feature +21 -0
- data/features/cloudfront/setup.rb +6 -0
- data/features/cloudsearch/client.feature +18 -0
- data/features/cloudsearch/setup.rb +6 -0
- data/features/cloudwatch/client.feature +21 -0
- data/features/cloudwatch/setup.rb +6 -0
- data/features/common/step_definitions.rb +65 -0
- data/features/datapipeline/client.feature +18 -0
- data/features/datapipeline/setup.rb +6 -0
- data/features/directconnect/client.feature +18 -0
- data/features/directconnect/setup.rb +6 -0
- data/features/dynamodb/client.feature +21 -0
- data/features/dynamodb/setup.rb +8 -0
- data/features/dynamodb/simplified.feature +32 -0
- data/features/dynamodb/step_definitions.rb +3 -0
- data/features/ec2/client.feature +21 -0
- data/features/ec2/setup.rb +6 -0
- data/features/ec2/step_definitions.rb +19 -0
- data/features/elasticache/client.feature +18 -0
- data/features/elasticache/setup.rb +6 -0
- data/features/elasticbeanstalk/client.feature +18 -0
- data/features/elasticbeanstalk/setup.rb +6 -0
- data/features/elasticloadbalancing/client.feature +18 -0
- data/features/elasticloadbalancing/setup.rb +6 -0
- data/features/elastictranscoder/client.feature +18 -0
- data/features/elastictranscoder/setup.rb +6 -0
- data/features/emr/client.feature +18 -0
- data/features/emr/setup.rb +6 -0
- data/features/env.rb +23 -0
- data/features/glacier/client.feature +28 -0
- data/features/glacier/setup.rb +16 -0
- data/features/glacier/step_definitions.rb +25 -0
- data/features/iam/client.feature +18 -0
- data/features/iam/setup.rb +6 -0
- data/features/importexport/client.feature +18 -0
- data/features/importexport/setup.rb +6 -0
- data/features/opsworks/client.feature +18 -0
- data/features/opsworks/setup.rb +6 -0
- data/features/rds/client.feature +18 -0
- data/features/rds/setup.rb +6 -0
- data/features/redshift/client.feature +18 -0
- data/features/redshift/setup.rb +6 -0
- data/features/route53/client.feature +18 -0
- data/features/route53/setup.rb +6 -0
- data/features/s3/buckets.feature +22 -0
- data/features/s3/objects.feature +18 -0
- data/features/s3/setup.rb +17 -0
- data/features/s3/step_definitions.rb +66 -0
- data/features/s3/test.png +0 -0
- data/features/sdb/client.feature +18 -0
- data/features/sdb/setup.rb +6 -0
- data/features/ses/client.feature +18 -0
- data/features/ses/setup.rb +6 -0
- data/features/sns/client.feature +18 -0
- data/features/sns/setup.rb +6 -0
- data/features/sqs/client.feature +23 -0
- data/features/sqs/setup.rb +10 -0
- data/features/sqs/step_definitions.rb +18 -0
- data/features/storagegateway/client.feature +18 -0
- data/features/storagegateway/setup.rb +6 -0
- data/features/sts/client.feature +18 -0
- data/features/sts/setup.rb +6 -0
- data/features/swf/client.feature +21 -0
- data/features/swf/setup.rb +6 -0
- data/integration-test-config.json.sample +3 -0
- data/lib/aws-sdk-core.rb +11 -0
- data/lib/aws.rb +175 -0
- data/lib/aws/api/base_translator.rb +72 -0
- data/lib/aws/api/doc_example.rb +116 -0
- data/lib/aws/api/documentor.rb +140 -0
- data/lib/aws/api/operation_translator.rb +77 -0
- data/lib/aws/api/service_namer.rb +40 -0
- data/lib/aws/api/service_translators/cloud_front.rb +19 -0
- data/lib/aws/api/service_translators/dynamo_db.rb +7 -0
- data/lib/aws/api/service_translators/glacier.rb +37 -0
- data/lib/aws/api/service_translators/import_export.rb +15 -0
- data/lib/aws/api/service_translators/route53.rb +23 -0
- data/lib/aws/api/service_translators/s3.rb +11 -0
- data/lib/aws/api/service_translators/sqs.rb +10 -0
- data/lib/aws/api/service_translators/swf.rb +7 -0
- data/lib/aws/api/shape_translator.rb +96 -0
- data/lib/aws/api/translator.rb +150 -0
- data/lib/aws/api/visitor.rb +32 -0
- data/lib/aws/credentials.rb +35 -0
- data/lib/aws/error_handler.rb +48 -0
- data/lib/aws/errors.rb +83 -0
- data/lib/aws/json/builder.rb +77 -0
- data/lib/aws/json/error_parser.rb +20 -0
- data/lib/aws/json/parser.rb +67 -0
- data/lib/aws/json/serializer.rb +15 -0
- data/lib/aws/plugins/credentials.rb +48 -0
- data/lib/aws/plugins/dynamodb_extended_retries.rb +22 -0
- data/lib/aws/plugins/glacier_api_version.rb +19 -0
- data/lib/aws/plugins/glacier_checksums.rb +100 -0
- data/lib/aws/plugins/global_configuration.rb +79 -0
- data/lib/aws/plugins/json_protocol.rb +30 -0
- data/lib/aws/plugins/json_rpc_headers.rb +34 -0
- data/lib/aws/plugins/query_protocol.rb +11 -0
- data/lib/aws/plugins/regional_endpoint.rb +37 -0
- data/lib/aws/plugins/retry_errors.rb +149 -0
- data/lib/aws/plugins/s3_bucket_dns.rb +78 -0
- data/lib/aws/plugins/s3_complete_multipart_upload_fix.rb +38 -0
- data/lib/aws/plugins/s3_get_bucket_location_fix.rb +21 -0
- data/lib/aws/plugins/s3_md5s.rb +61 -0
- data/lib/aws/plugins/s3_redirects.rb +38 -0
- data/lib/aws/plugins/s3_regional_endpoint.rb +19 -0
- data/lib/aws/plugins/s3_signer.rb +9 -0
- data/lib/aws/plugins/signature_v2.rb +9 -0
- data/lib/aws/plugins/signature_v3.rb +9 -0
- data/lib/aws/plugins/signature_v4.rb +29 -0
- data/lib/aws/plugins/sqs_queue_urls.rb +33 -0
- data/lib/aws/plugins/swf_read_timeouts.rb +23 -0
- data/lib/aws/plugins/user_agent.rb +32 -0
- data/lib/aws/plugins/xml_protocol.rb +11 -0
- data/lib/aws/query/builder.rb +102 -0
- data/lib/aws/query/param.rb +43 -0
- data/lib/aws/query/param_list.rb +91 -0
- data/lib/aws/query/serializer.rb +24 -0
- data/lib/aws/request_handler.rb +39 -0
- data/lib/aws/response_handler.rb +38 -0
- data/lib/aws/service.rb +237 -0
- data/lib/aws/signers/base.rb +29 -0
- data/lib/aws/signers/handler.rb +18 -0
- data/lib/aws/signers/s3.rb +162 -0
- data/lib/aws/signers/v2.rb +48 -0
- data/lib/aws/signers/v3.rb +34 -0
- data/lib/aws/signers/v4.rb +142 -0
- data/lib/aws/structure.rb +38 -0
- data/lib/aws/timestamp_formatter.rb +16 -0
- data/lib/aws/util.rb +38 -0
- data/lib/aws/version.rb +3 -0
- data/lib/aws/xml/builder.rb +134 -0
- data/lib/aws/xml/error_parser.rb +24 -0
- data/lib/aws/xml/parser.rb +147 -0
- data/lib/aws/xml/serializer.rb +16 -0
- data/spec/aws/credentials_spec.rb +39 -0
- data/spec/aws/iam_spec.rb +17 -0
- data/spec/aws/json/builder_spec.rb +183 -0
- data/spec/aws/json/parser_spec.rb +238 -0
- data/spec/aws/operations_spec.rb +145 -0
- data/spec/aws/plugins/credentials_spec.rb +76 -0
- data/spec/aws/plugins/global_configuration_spec.rb +56 -0
- data/spec/aws/plugins/region_endpoint_spec.rb +77 -0
- data/spec/aws/plugins/retry_errors_spec.rb +253 -0
- data/spec/aws/query/builder_spec.rb +361 -0
- data/spec/aws/query/param_list_spec.rb +80 -0
- data/spec/aws/query/param_spec.rb +59 -0
- data/spec/aws/service_spec.rb +247 -0
- data/spec/aws/signers/v4_spec.rb +141 -0
- data/spec/aws/structure_spec.rb +103 -0
- data/spec/aws/xml/builder_spec.rb +404 -0
- data/spec/aws/xml/parser_spec.rb +716 -0
- data/spec/aws_spec.rb +89 -0
- data/spec/fixtures/api/swf.json +100 -0
- data/spec/fixtures/operations/cloudfront/list_distributions.yml +195 -0
- data/spec/fixtures/operations/cloudfront/max_items.yml +12 -0
- data/spec/fixtures/operations/dynamodb/error_parsing.yml +13 -0
- data/spec/fixtures/operations/glacier/error_parsing.yml +10 -0
- data/spec/fixtures/operations/glacier/list_vaults.yml +24 -0
- data/spec/fixtures/operations/iam/result_wrapped_elements.yml +31 -0
- data/spec/fixtures/operations/s3/304_response.yml +12 -0
- data/spec/fixtures/operations/s3/400_response.yml +12 -0
- data/spec/fixtures/operations/s3/403_response.yml +12 -0
- data/spec/fixtures/operations/s3/404_response.yml +12 -0
- data/spec/fixtures/operations/s3/comlete_multipart_upload_error.yml +18 -0
- data/spec/fixtures/operations/s3/create_bucket_with_location_constraint.yml +25 -0
- data/spec/fixtures/operations/s3/create_bucket_without_location_constraint.yml +9 -0
- data/spec/fixtures/operations/s3/delete_objects.yml +54 -0
- data/spec/fixtures/operations/s3/error_parsing.yml +17 -0
- data/spec/fixtures/operations/s3/get_bucket_location.yml +17 -0
- data/spec/fixtures/operations/s3/get_bucket_location_classic.yml +17 -0
- data/spec/fixtures/operations/s3/head_bucket_with_dns_incompatible_name.yml +12 -0
- data/spec/fixtures/operations/s3/head_object.yml +50 -0
- data/spec/fixtures/operations/s3/list_buckets.yml +41 -0
- data/spec/fixtures/operations/s3/md5_checksum_disabled.yml +10 -0
- data/spec/fixtures/operations/s3/md5_checksum_enabled.yml +8 -0
- data/spec/fixtures/operations/swf/list_domains.yml +20 -0
- data/spec/spec_helper.rb +55 -0
- data/tasks/apis.rake +51 -0
- data/tasks/docs.rake +59 -0
- data/tasks/test.rake +39 -0
- data/vendor/seahorse/.gitignore +5 -0
- data/vendor/seahorse/.simplecov +4 -0
- data/vendor/seahorse/.yardopts +10 -0
- data/vendor/seahorse/Gemfile +20 -0
- data/vendor/seahorse/LICENSE.txt +12 -0
- data/vendor/seahorse/README.md +129 -0
- data/vendor/seahorse/Rakefile +7 -0
- data/vendor/seahorse/ca-bundle.crt +3554 -0
- data/vendor/seahorse/lib/seahorse.rb +6 -0
- data/vendor/seahorse/lib/seahorse/client.rb +61 -0
- data/vendor/seahorse/lib/seahorse/client/base.rb +239 -0
- data/vendor/seahorse/lib/seahorse/client/block_io.rb +39 -0
- data/vendor/seahorse/lib/seahorse/client/configuration.rb +197 -0
- data/vendor/seahorse/lib/seahorse/client/handler.rb +26 -0
- data/vendor/seahorse/lib/seahorse/client/handler_builder.rb +49 -0
- data/vendor/seahorse/lib/seahorse/client/handler_list.rb +250 -0
- data/vendor/seahorse/lib/seahorse/client/http/endpoint.rb +95 -0
- data/vendor/seahorse/lib/seahorse/client/http/headers.rb +94 -0
- data/vendor/seahorse/lib/seahorse/client/http/plain_string_io.rb +11 -0
- data/vendor/seahorse/lib/seahorse/client/http/request.rb +78 -0
- data/vendor/seahorse/lib/seahorse/client/http/response.rb +45 -0
- data/vendor/seahorse/lib/seahorse/client/logging/formatter.rb +319 -0
- data/vendor/seahorse/lib/seahorse/client/logging/handler.rb +35 -0
- data/vendor/seahorse/lib/seahorse/client/net_http/connection_pool.rb +339 -0
- data/vendor/seahorse/lib/seahorse/client/net_http/handler.rb +109 -0
- data/vendor/seahorse/lib/seahorse/client/param_converter.rb +202 -0
- data/vendor/seahorse/lib/seahorse/client/param_validator.rb +139 -0
- data/vendor/seahorse/lib/seahorse/client/plugin.rb +80 -0
- data/vendor/seahorse/lib/seahorse/client/plugin_list.rb +142 -0
- data/vendor/seahorse/lib/seahorse/client/plugins/api.rb +11 -0
- data/vendor/seahorse/lib/seahorse/client/plugins/content_length.rb +22 -0
- data/vendor/seahorse/lib/seahorse/client/plugins/endpoint.rb +36 -0
- data/vendor/seahorse/lib/seahorse/client/plugins/json_simple.rb +34 -0
- data/vendor/seahorse/lib/seahorse/client/plugins/logging.rb +37 -0
- data/vendor/seahorse/lib/seahorse/client/plugins/net_http.rb +26 -0
- data/vendor/seahorse/lib/seahorse/client/plugins/operation_methods.rb +48 -0
- data/vendor/seahorse/lib/seahorse/client/plugins/param_conversion.rb +29 -0
- data/vendor/seahorse/lib/seahorse/client/plugins/param_validation.rb +30 -0
- data/vendor/seahorse/lib/seahorse/client/plugins/raise_response_errors.rb +29 -0
- data/vendor/seahorse/lib/seahorse/client/plugins/restful_bindings.rb +205 -0
- data/vendor/seahorse/lib/seahorse/client/request.rb +62 -0
- data/vendor/seahorse/lib/seahorse/client/request_context.rb +68 -0
- data/vendor/seahorse/lib/seahorse/client/response.rb +106 -0
- data/vendor/seahorse/lib/seahorse/client/xml/builder.rb +92 -0
- data/vendor/seahorse/lib/seahorse/model.rb +38 -0
- data/vendor/seahorse/lib/seahorse/model/api.rb +39 -0
- data/vendor/seahorse/lib/seahorse/model/node.rb +102 -0
- data/vendor/seahorse/lib/seahorse/model/operation.rb +32 -0
- data/vendor/seahorse/lib/seahorse/model/operation_input.rb +30 -0
- data/vendor/seahorse/lib/seahorse/model/operations.rb +59 -0
- data/vendor/seahorse/lib/seahorse/model/property.rb +141 -0
- data/vendor/seahorse/lib/seahorse/model/shapes/shape.rb +229 -0
- data/vendor/seahorse/lib/seahorse/model/types.rb +8 -0
- data/vendor/seahorse/lib/seahorse/version.rb +3 -0
- data/vendor/seahorse/seahorse.gemspec +20 -0
- data/vendor/seahorse/spec/fixtures/plugin.rb +4 -0
- data/vendor/seahorse/spec/seahorse/client/base_spec.rb +308 -0
- data/vendor/seahorse/spec/seahorse/client/configuration_spec.rb +118 -0
- data/vendor/seahorse/spec/seahorse/client/handler_builder_spec.rb +159 -0
- data/vendor/seahorse/spec/seahorse/client/handler_list_spec.rb +243 -0
- data/vendor/seahorse/spec/seahorse/client/handler_spec.rb +40 -0
- data/vendor/seahorse/spec/seahorse/client/http/endpoint_spec.rb +168 -0
- data/vendor/seahorse/spec/seahorse/client/http/headers_spec.rb +213 -0
- data/vendor/seahorse/spec/seahorse/client/http/plain_string_io_spec.rb +23 -0
- data/vendor/seahorse/spec/seahorse/client/http/request_spec.rb +142 -0
- data/vendor/seahorse/spec/seahorse/client/http/response_spec.rb +77 -0
- data/vendor/seahorse/spec/seahorse/client/logging/formatter_spec.rb +197 -0
- data/vendor/seahorse/spec/seahorse/client/logging/handler_spec.rb +63 -0
- data/vendor/seahorse/spec/seahorse/client/net_http/connection_pool_spec.rb +10 -0
- data/vendor/seahorse/spec/seahorse/client/net_http/handler_spec.rb +232 -0
- data/vendor/seahorse/spec/seahorse/client/param_converter_spec.rb +318 -0
- data/vendor/seahorse/spec/seahorse/client/param_validator_spec.rb +271 -0
- data/vendor/seahorse/spec/seahorse/client/plugin_list_spec.rb +166 -0
- data/vendor/seahorse/spec/seahorse/client/plugin_spec.rb +118 -0
- data/vendor/seahorse/spec/seahorse/client/plugins/content_length_spec.rb +19 -0
- data/vendor/seahorse/spec/seahorse/client/plugins/endpoint_spec.rb +43 -0
- data/vendor/seahorse/spec/seahorse/client/plugins/logging_spec.rb +46 -0
- data/vendor/seahorse/spec/seahorse/client/plugins/net_http_spec.rb +71 -0
- data/vendor/seahorse/spec/seahorse/client/plugins/operation_methods_spec.rb +74 -0
- data/vendor/seahorse/spec/seahorse/client/plugins/restful_bindings/uri_path_builder_spec.rb +91 -0
- data/vendor/seahorse/spec/seahorse/client/request_context_spec.rb +105 -0
- data/vendor/seahorse/spec/seahorse/client/request_spec.rb +102 -0
- data/vendor/seahorse/spec/seahorse/client/response_spec.rb +171 -0
- data/vendor/seahorse/spec/seahorse/client/xml/builder/xml_doc_spec.rb +142 -0
- data/vendor/seahorse/spec/seahorse/client/xml/builder_spec.rb +10 -0
- data/vendor/seahorse/spec/seahorse/client_spec.rb +13 -0
- data/vendor/seahorse/spec/seahorse/model/api_spec.rb +72 -0
- data/vendor/seahorse/spec/seahorse/model/node_spec.rb +114 -0
- data/vendor/seahorse/spec/seahorse/model/operation_input_spec.rb +53 -0
- data/vendor/seahorse/spec/seahorse/model/operation_spec.rb +48 -0
- data/vendor/seahorse/spec/seahorse/model/operations_spec.rb +64 -0
- data/vendor/seahorse/spec/seahorse/model/property_spec.rb +136 -0
- data/vendor/seahorse/spec/seahorse/model/shapes/shape_spec.rb +105 -0
- data/vendor/seahorse/spec/seahorse/version_spec.rb +11 -0
- data/vendor/seahorse/spec/spec_helper.rb +34 -0
- data/vendor/seahorse/tasks/ca_bundle.rake +23 -0
- data/vendor/seahorse/tasks/docs.rake +11 -0
- data/vendor/seahorse/tasks/test.rake +26 -0
- metadata +614 -0
@@ -0,0 +1,2144 @@
|
|
1
|
+
{
|
2
|
+
"api_version": "2012-10-29",
|
3
|
+
"type": "json",
|
4
|
+
"json_version": 1.1,
|
5
|
+
"target_prefix": "DataPipeline",
|
6
|
+
"signature_version": "v4",
|
7
|
+
"service_full_name": "AWS Data Pipeline",
|
8
|
+
"endpoint_prefix": "datapipeline",
|
9
|
+
"xmlnamespace": "http://datapipeline.amazonaws.com/doc/2012-10-29/",
|
10
|
+
"documentation": "\n <p> \n This is the <i>AWS Data Pipeline API Reference</i>. This guide provides descriptions and\n samples of the AWS Data Pipeline API.\n </p>\n \n <p>\n AWS Data Pipeline is a web service that configures and manages a data-driven workflow called a pipeline. AWS Data Pipeline handles the details of scheduling and ensuring that data dependencies are met so your application can focus on processing the data.</p>\n \n <p>\n The AWS Data Pipeline API implements two main sets of functionality. The first set of actions configure the pipeline in the web service. You call these actions to create a pipeline and define data sources, schedules, dependencies, and the transforms to be performed on the data.\n </p>\n \n <p>\n The second set of actions are used by a task runner application that calls the AWS Data Pipeline API to receive the next task ready for processing. The logic for performing the task, such as querying the data, running data analysis, or converting the data from one format to another, is contained within the task runner. The task runner performs the task assigned to it by the web service, reporting progress to the web service as it does so. When the task is done, the task runner reports the final success or failure of the task to the web service.\n </p>\n \n <p>\n AWS Data Pipeline provides an open-source implementation of a task runner called AWS Data Pipeline Task Runner. AWS Data Pipeline Task Runner provides logic for common data management scenarios, such as performing database queries and running data analysis using Amazon Elastic MapReduce (Amazon EMR). You can use AWS Data Pipeline Task Runner as your task runner, or you can write your own task runner to provide custom data management.\n </p>\n \n \n <p>\n The AWS Data Pipeline API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see \n <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4 Signing Process</a>. In the code examples in this reference, the Signature Version 4 Request parameters are represented as AuthParams.\n </p>\n \n ",
|
11
|
+
"operations": {
|
12
|
+
"ActivatePipeline": {
|
13
|
+
"name": "ActivatePipeline",
|
14
|
+
"input": {
|
15
|
+
"shape_name": "ActivatePipelineInput",
|
16
|
+
"type": "structure",
|
17
|
+
"members": {
|
18
|
+
"pipelineId": {
|
19
|
+
"shape_name": "id",
|
20
|
+
"type": "string",
|
21
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
22
|
+
"min_length": 1,
|
23
|
+
"max_length": 1024,
|
24
|
+
"documentation": "\n <p>The identifier of the pipeline to activate. </p>\n ",
|
25
|
+
"required": true
|
26
|
+
}
|
27
|
+
},
|
28
|
+
"documentation": "\n <p>The input of the ActivatePipeline action.</p>\n "
|
29
|
+
},
|
30
|
+
"output": {
|
31
|
+
"shape_name": "ActivatePipelineOutput",
|
32
|
+
"type": "structure",
|
33
|
+
"members": {
|
34
|
+
},
|
35
|
+
"documentation": "\n <p>Contains the output from the <a>ActivatePipeline</a> action.</p>\n "
|
36
|
+
},
|
37
|
+
"errors": [
|
38
|
+
{
|
39
|
+
"shape_name": "PipelineNotFoundException",
|
40
|
+
"type": "structure",
|
41
|
+
"members": {
|
42
|
+
"message": {
|
43
|
+
"shape_name": "errorMessage",
|
44
|
+
"type": "string",
|
45
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
46
|
+
}
|
47
|
+
},
|
48
|
+
"documentation": "\n <p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>\n "
|
49
|
+
},
|
50
|
+
{
|
51
|
+
"shape_name": "PipelineDeletedException",
|
52
|
+
"type": "structure",
|
53
|
+
"members": {
|
54
|
+
"message": {
|
55
|
+
"shape_name": "errorMessage",
|
56
|
+
"type": "string",
|
57
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
58
|
+
}
|
59
|
+
},
|
60
|
+
"documentation": "\n <p>The specified pipeline has been deleted.</p>\n "
|
61
|
+
},
|
62
|
+
{
|
63
|
+
"shape_name": "InternalServiceError",
|
64
|
+
"type": "structure",
|
65
|
+
"members": {
|
66
|
+
"message": {
|
67
|
+
"shape_name": "errorMessage",
|
68
|
+
"type": "string",
|
69
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
70
|
+
}
|
71
|
+
},
|
72
|
+
"documentation": "\n <p>An internal service error occurred.</p>\n "
|
73
|
+
},
|
74
|
+
{
|
75
|
+
"shape_name": "InvalidRequestException",
|
76
|
+
"type": "structure",
|
77
|
+
"members": {
|
78
|
+
"message": {
|
79
|
+
"shape_name": "errorMessage",
|
80
|
+
"type": "string",
|
81
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
82
|
+
}
|
83
|
+
},
|
84
|
+
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
|
85
|
+
}
|
86
|
+
],
|
87
|
+
"documentation": "\n <p>\n Validates a pipeline and initiates processing. If the pipeline does not pass validation, activation fails.\n </p>\n <p>\n Call this action to start processing pipeline tasks of a pipeline you've created using the <a>CreatePipeline</a> and <a>PutPipelineDefinition</a> actions. A pipeline cannot be modified after it has been successfully activated. \n </p>\n <examples>\n <request>\n \nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.ActivatePipeline\nContent-Length: 39\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\"}\n\n </request>\n <response>\n \nHTTP/1.1 200 \nx-amzn-RequestId: ee19d5bf-074e-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 2\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{}\n \n </response>\n </examples>\n "
|
88
|
+
},
|
89
|
+
"CreatePipeline": {
|
90
|
+
"name": "CreatePipeline",
|
91
|
+
"input": {
|
92
|
+
"shape_name": "CreatePipelineInput",
|
93
|
+
"type": "structure",
|
94
|
+
"members": {
|
95
|
+
"name": {
|
96
|
+
"shape_name": "id",
|
97
|
+
"type": "string",
|
98
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
99
|
+
"min_length": 1,
|
100
|
+
"max_length": 1024,
|
101
|
+
"documentation": "\n <p>\n The name of the new pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each new pipeline a unique pipeline identifier.\n </p> \n ",
|
102
|
+
"required": true
|
103
|
+
},
|
104
|
+
"uniqueId": {
|
105
|
+
"shape_name": "id",
|
106
|
+
"type": "string",
|
107
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
108
|
+
"min_length": 1,
|
109
|
+
"max_length": 1024,
|
110
|
+
"documentation": "\n <p>\n A unique identifier that you specify. This identifier is not the same as the pipeline identifier assigned by AWS Data Pipeline. You are responsible for defining the format and ensuring the uniqueness of this identifier. You use this parameter to ensure idempotency during repeated calls to <a>CreatePipeline</a>. For example, if the first call to <a>CreatePipeline</a> does not return a clear success, you can pass in the same unique identifier and pipeline name combination on a subsequent call to <a>CreatePipeline</a>. <a>CreatePipeline</a> ensures that if a pipeline already exists with the same name and unique identifier, a new pipeline will not be created. Instead, you'll receive the pipeline identifier from the previous attempt. The uniqueness of the name and unique identifier combination is scoped to the AWS account or IAM user credentials.\n </p>\n ",
|
111
|
+
"required": true
|
112
|
+
},
|
113
|
+
"description": {
|
114
|
+
"shape_name": "string",
|
115
|
+
"type": "string",
|
116
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
117
|
+
"min_length": 0,
|
118
|
+
"max_length": 1024,
|
119
|
+
"documentation": "\n <p>The description of the new pipeline.</p> \n "
|
120
|
+
}
|
121
|
+
},
|
122
|
+
"documentation": "\n <p>The input for the <a>CreatePipeline</a> action.</p> \n "
|
123
|
+
},
|
124
|
+
"output": {
|
125
|
+
"shape_name": "CreatePipelineOutput",
|
126
|
+
"type": "structure",
|
127
|
+
"members": {
|
128
|
+
"pipelineId": {
|
129
|
+
"shape_name": "id",
|
130
|
+
"type": "string",
|
131
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
132
|
+
"min_length": 1,
|
133
|
+
"max_length": 1024,
|
134
|
+
"documentation": "\n <p>The ID that AWS Data Pipeline assigns the newly created pipeline. The ID is a string of the form: df-06372391ZG65EXAMPLE.</p>\n ",
|
135
|
+
"required": true
|
136
|
+
}
|
137
|
+
},
|
138
|
+
"documentation": "\n <p>Contains the output from the <a>CreatePipeline</a> action.</p>\n "
|
139
|
+
},
|
140
|
+
"errors": [
|
141
|
+
{
|
142
|
+
"shape_name": "InternalServiceError",
|
143
|
+
"type": "structure",
|
144
|
+
"members": {
|
145
|
+
"message": {
|
146
|
+
"shape_name": "errorMessage",
|
147
|
+
"type": "string",
|
148
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
149
|
+
}
|
150
|
+
},
|
151
|
+
"documentation": "\n <p>An internal service error occurred.</p>\n "
|
152
|
+
},
|
153
|
+
{
|
154
|
+
"shape_name": "InvalidRequestException",
|
155
|
+
"type": "structure",
|
156
|
+
"members": {
|
157
|
+
"message": {
|
158
|
+
"shape_name": "errorMessage",
|
159
|
+
"type": "string",
|
160
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
161
|
+
}
|
162
|
+
},
|
163
|
+
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
|
164
|
+
}
|
165
|
+
],
|
166
|
+
"documentation": "\n <p>Creates a new empty pipeline. When this action succeeds, you can then use the <a>PutPipelineDefinition</a> action to populate the pipeline.</p> \n \n <examples>\n <request>\n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.CreatePipeline\nContent-Length: 91\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"name\": \"myPipeline\",\n \"uniqueId\": \"123456789\",\n \"description\": \"This is my first pipeline\"}\n \n </request>\n \n <response>\n \nHTTP/1.1 200 \nx-amzn-RequestId: b16911ce-0774-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 40\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\"}\n \n </response>\n </examples>\n \n "
|
167
|
+
},
|
168
|
+
"DeletePipeline": {
|
169
|
+
"name": "DeletePipeline",
|
170
|
+
"input": {
|
171
|
+
"shape_name": "DeletePipelineInput",
|
172
|
+
"type": "structure",
|
173
|
+
"members": {
|
174
|
+
"pipelineId": {
|
175
|
+
"shape_name": "id",
|
176
|
+
"type": "string",
|
177
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
178
|
+
"min_length": 1,
|
179
|
+
"max_length": 1024,
|
180
|
+
"documentation": "\n <p>The identifier of the pipeline to be deleted.</p>\n ",
|
181
|
+
"required": true
|
182
|
+
}
|
183
|
+
},
|
184
|
+
"documentation": "\n <p>The input for the <a>DeletePipeline</a> action.</p>\n "
|
185
|
+
},
|
186
|
+
"output": null,
|
187
|
+
"errors": [
|
188
|
+
{
|
189
|
+
"shape_name": "PipelineNotFoundException",
|
190
|
+
"type": "structure",
|
191
|
+
"members": {
|
192
|
+
"message": {
|
193
|
+
"shape_name": "errorMessage",
|
194
|
+
"type": "string",
|
195
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
196
|
+
}
|
197
|
+
},
|
198
|
+
"documentation": "\n <p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>\n "
|
199
|
+
},
|
200
|
+
{
|
201
|
+
"shape_name": "InternalServiceError",
|
202
|
+
"type": "structure",
|
203
|
+
"members": {
|
204
|
+
"message": {
|
205
|
+
"shape_name": "errorMessage",
|
206
|
+
"type": "string",
|
207
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
208
|
+
}
|
209
|
+
},
|
210
|
+
"documentation": "\n <p>An internal service error occurred.</p>\n "
|
211
|
+
},
|
212
|
+
{
|
213
|
+
"shape_name": "InvalidRequestException",
|
214
|
+
"type": "structure",
|
215
|
+
"members": {
|
216
|
+
"message": {
|
217
|
+
"shape_name": "errorMessage",
|
218
|
+
"type": "string",
|
219
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
220
|
+
}
|
221
|
+
},
|
222
|
+
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
|
223
|
+
}
|
224
|
+
],
|
225
|
+
"documentation": "\n <p>\n Permanently deletes a pipeline, its pipeline definition and its run history. You cannot query or restore a deleted pipeline. AWS Data Pipeline will attempt to cancel instances associated with the pipeline that are currently being processed by task runners. Deleting a pipeline cannot be undone.\n </p>\n <p> \n To temporarily pause a pipeline instead of deleting it, call <a>SetStatus</a> with the status set to Pause on individual components. Components that are paused by <a>SetStatus</a> can be resumed.\n </p>\n \n <examples>\n <request>\n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.DeletePipeline\nContent-Length: 50\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\"}\n\n </request>\n \n <response>\n \nx-amzn-RequestId: b7a88c81-0754-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 0\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\nUnexpected response: 200, OK, undefined\n \n </response>\n </examples>\n "
|
226
|
+
},
|
227
|
+
"DescribeObjects": {
|
228
|
+
"name": "DescribeObjects",
|
229
|
+
"input": {
|
230
|
+
"shape_name": "DescribeObjectsInput",
|
231
|
+
"type": "structure",
|
232
|
+
"members": {
|
233
|
+
"pipelineId": {
|
234
|
+
"shape_name": "id",
|
235
|
+
"type": "string",
|
236
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
237
|
+
"min_length": 1,
|
238
|
+
"max_length": 1024,
|
239
|
+
"documentation": "\n <p>Identifier of the pipeline that contains the object definitions.</p>\n ",
|
240
|
+
"required": true
|
241
|
+
},
|
242
|
+
"objectIds": {
|
243
|
+
"shape_name": "idList",
|
244
|
+
"type": "list",
|
245
|
+
"members": {
|
246
|
+
"shape_name": "id",
|
247
|
+
"type": "string",
|
248
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
249
|
+
"min_length": 1,
|
250
|
+
"max_length": 1024,
|
251
|
+
"documentation": null
|
252
|
+
},
|
253
|
+
"documentation": "\n <p>Identifiers of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.</p>\n ",
|
254
|
+
"required": true
|
255
|
+
},
|
256
|
+
"evaluateExpressions": {
|
257
|
+
"shape_name": "boolean",
|
258
|
+
"type": "boolean",
|
259
|
+
"documentation": "\n <p>Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.</p>\n "
|
260
|
+
},
|
261
|
+
"marker": {
|
262
|
+
"shape_name": "string",
|
263
|
+
"type": "string",
|
264
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
265
|
+
"min_length": 0,
|
266
|
+
"max_length": 1024,
|
267
|
+
"documentation": "\n <p>The starting point for the results to be returned. The first time you call <a>DescribeObjects</a>, this value should be empty. As long as the action returns <code>HasMoreResults</code> as <code>True</code>, you can call <a>DescribeObjects</a> again and pass the marker value from the response to retrieve the next set of results.</p>\n "
|
268
|
+
}
|
269
|
+
},
|
270
|
+
"documentation": "\n <p> The <a>DescribeObjects</a> action returns the object definitions for a specified set of object identifiers. You can filter the results to named fields and used markers to page through the results. </p>\n "
|
271
|
+
},
|
272
|
+
"output": {
|
273
|
+
"shape_name": "DescribeObjectsOutput",
|
274
|
+
"type": "structure",
|
275
|
+
"members": {
|
276
|
+
"pipelineObjects": {
|
277
|
+
"shape_name": "PipelineObjectList",
|
278
|
+
"type": "list",
|
279
|
+
"members": {
|
280
|
+
"shape_name": "PipelineObject",
|
281
|
+
"type": "structure",
|
282
|
+
"members": {
|
283
|
+
"id": {
|
284
|
+
"shape_name": "id",
|
285
|
+
"type": "string",
|
286
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
287
|
+
"min_length": 1,
|
288
|
+
"max_length": 1024,
|
289
|
+
"documentation": "\n <p>Identifier of the object.</p>\n ",
|
290
|
+
"required": true
|
291
|
+
},
|
292
|
+
"name": {
|
293
|
+
"shape_name": "id",
|
294
|
+
"type": "string",
|
295
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
296
|
+
"min_length": 1,
|
297
|
+
"max_length": 1024,
|
298
|
+
"documentation": "\n <p>Name of the object.</p>\n ",
|
299
|
+
"required": true
|
300
|
+
},
|
301
|
+
"fields": {
|
302
|
+
"shape_name": "fieldList",
|
303
|
+
"type": "list",
|
304
|
+
"members": {
|
305
|
+
"shape_name": "Field",
|
306
|
+
"type": "structure",
|
307
|
+
"members": {
|
308
|
+
"key": {
|
309
|
+
"shape_name": "fieldNameString",
|
310
|
+
"type": "string",
|
311
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
312
|
+
"min_length": 1,
|
313
|
+
"max_length": 256,
|
314
|
+
"documentation": "\n <p>The field identifier.</p>\n ",
|
315
|
+
"required": true
|
316
|
+
},
|
317
|
+
"stringValue": {
|
318
|
+
"shape_name": "fieldStringValue",
|
319
|
+
"type": "string",
|
320
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
321
|
+
"min_length": 0,
|
322
|
+
"max_length": 10240,
|
323
|
+
"documentation": "\n <p>The field value, expressed as a String.</p>\n "
|
324
|
+
},
|
325
|
+
"refValue": {
|
326
|
+
"shape_name": "fieldNameString",
|
327
|
+
"type": "string",
|
328
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
329
|
+
"min_length": 1,
|
330
|
+
"max_length": 256,
|
331
|
+
"documentation": "\n <p>The field value, expressed as the identifier of another object.</p>\n "
|
332
|
+
}
|
333
|
+
},
|
334
|
+
"documentation": "\n <p>A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (<code>StringValue</code>) or a reference to another object (<code>RefValue</code>) but not as both.</p>\n "
|
335
|
+
},
|
336
|
+
"documentation": "\n <p>Key-value pairs that define the properties of the object.</p>\n ",
|
337
|
+
"required": true
|
338
|
+
}
|
339
|
+
},
|
340
|
+
"documentation": "\n <p>Contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.</p>\n "
|
341
|
+
},
|
342
|
+
"documentation": "\n <p>An array of object definitions that are returned by the call to <a>DescribeObjects</a>.</p>\n ",
|
343
|
+
"required": true
|
344
|
+
},
|
345
|
+
"marker": {
|
346
|
+
"shape_name": "string",
|
347
|
+
"type": "string",
|
348
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
349
|
+
"min_length": 0,
|
350
|
+
"max_length": 1024,
|
351
|
+
"documentation": "\n <p>\n The starting point for the next page of results. To view the next page of results, call <a>DescribeObjects</a> again with this marker value.\n </p>\n "
|
352
|
+
},
|
353
|
+
"hasMoreResults": {
|
354
|
+
"shape_name": "boolean",
|
355
|
+
"type": "boolean",
|
356
|
+
"documentation": "\n <p>If <code>True</code>, there are more pages of results to return.</p>\n "
|
357
|
+
}
|
358
|
+
},
|
359
|
+
"documentation": "\n <p>If <code>True</code>, there are more results that can be returned in another call to <a>DescribeObjects</a>.</p>\n "
|
360
|
+
},
|
361
|
+
"errors": [
|
362
|
+
{
|
363
|
+
"shape_name": "InternalServiceError",
|
364
|
+
"type": "structure",
|
365
|
+
"members": {
|
366
|
+
"message": {
|
367
|
+
"shape_name": "errorMessage",
|
368
|
+
"type": "string",
|
369
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
370
|
+
}
|
371
|
+
},
|
372
|
+
"documentation": "\n <p>An internal service error occurred.</p>\n "
|
373
|
+
},
|
374
|
+
{
|
375
|
+
"shape_name": "InvalidRequestException",
|
376
|
+
"type": "structure",
|
377
|
+
"members": {
|
378
|
+
"message": {
|
379
|
+
"shape_name": "errorMessage",
|
380
|
+
"type": "string",
|
381
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
382
|
+
}
|
383
|
+
},
|
384
|
+
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
|
385
|
+
},
|
386
|
+
{
|
387
|
+
"shape_name": "PipelineNotFoundException",
|
388
|
+
"type": "structure",
|
389
|
+
"members": {
|
390
|
+
"message": {
|
391
|
+
"shape_name": "errorMessage",
|
392
|
+
"type": "string",
|
393
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
394
|
+
}
|
395
|
+
},
|
396
|
+
"documentation": "\n <p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>\n "
|
397
|
+
},
|
398
|
+
{
|
399
|
+
"shape_name": "PipelineDeletedException",
|
400
|
+
"type": "structure",
|
401
|
+
"members": {
|
402
|
+
"message": {
|
403
|
+
"shape_name": "errorMessage",
|
404
|
+
"type": "string",
|
405
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
406
|
+
}
|
407
|
+
},
|
408
|
+
"documentation": "\n <p>The specified pipeline has been deleted.</p>\n "
|
409
|
+
}
|
410
|
+
],
|
411
|
+
"documentation": "\n <p>\n Returns the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object. \n </p>\n \n <examples>\n \n <request>\n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.DescribeObjects\nContent-Length: 98\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\",\n \"objectIds\": \n [\"Schedule\"],\n \"evaluateExpressions\": true}\n\n </request>\n \n <response>\n\nx-amzn-RequestId: 4c18ea5d-0777-11e2-8a14-21bb8a1f50ef\nContent-Type: application/x-amz-json-1.1\nContent-Length: 1488\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"hasMoreResults\": false, \n \"pipelineObjects\": \n [\n {\"fields\": \n [\n {\"key\": \"startDateTime\", \n \"stringValue\": \"2012-12-12T00:00:00\"}, \n {\"key\": \"parent\", \n \"refValue\": \"Default\"}, \n {\"key\": \"@sphere\", \n \"stringValue\": \"COMPONENT\"}, \n {\"key\": \"type\", \n \"stringValue\": \"Schedule\"}, \n {\"key\": \"period\", \n \"stringValue\": \"1 hour\"}, \n {\"key\": \"endDateTime\", \n \"stringValue\": \"2012-12-21T18:00:00\"}, \n {\"key\": \"@version\", \n \"stringValue\": \"1\"}, \n {\"key\": \"@status\", \n \"stringValue\": \"PENDING\"}, \n {\"key\": \"@pipelineId\", \n \"stringValue\": \"df-06372391ZG65EXAMPLE\"}\n ], \n \"id\": \"Schedule\", \n \"name\": \"Schedule\"}\n ]\n}\n \n </response>\n </examples>\n \n "
|
412
|
+
},
|
413
|
+
"DescribePipelines": {
|
414
|
+
"name": "DescribePipelines",
|
415
|
+
"input": {
|
416
|
+
"shape_name": "DescribePipelinesInput",
|
417
|
+
"type": "structure",
|
418
|
+
"members": {
|
419
|
+
"pipelineIds": {
|
420
|
+
"shape_name": "idList",
|
421
|
+
"type": "list",
|
422
|
+
"members": {
|
423
|
+
"shape_name": "id",
|
424
|
+
"type": "string",
|
425
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
426
|
+
"min_length": 1,
|
427
|
+
"max_length": 1024,
|
428
|
+
"documentation": null
|
429
|
+
},
|
430
|
+
"documentation": "\n <p>Identifiers of the pipelines to describe. You can pass as many as 25 identifiers in a single call to <a>DescribePipelines</a>. You can obtain pipeline identifiers by calling <a>ListPipelines</a>.</p>\n ",
|
431
|
+
"required": true
|
432
|
+
}
|
433
|
+
},
|
434
|
+
"documentation": "\n <p>The input to the <a>DescribePipelines</a> action.</p>\n "
|
435
|
+
},
|
436
|
+
"output": {
|
437
|
+
"shape_name": "DescribePipelinesOutput",
|
438
|
+
"type": "structure",
|
439
|
+
"members": {
|
440
|
+
"pipelineDescriptionList": {
|
441
|
+
"shape_name": "PipelineDescriptionList",
|
442
|
+
"type": "list",
|
443
|
+
"members": {
|
444
|
+
"shape_name": "PipelineDescription",
|
445
|
+
"type": "structure",
|
446
|
+
"members": {
|
447
|
+
"pipelineId": {
|
448
|
+
"shape_name": "id",
|
449
|
+
"type": "string",
|
450
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
451
|
+
"min_length": 1,
|
452
|
+
"max_length": 1024,
|
453
|
+
"documentation": "\n <p>The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form <code>df-297EG78HU43EEXAMPLE</code>.</p>\n ",
|
454
|
+
"required": true
|
455
|
+
},
|
456
|
+
"name": {
|
457
|
+
"shape_name": "id",
|
458
|
+
"type": "string",
|
459
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
460
|
+
"min_length": 1,
|
461
|
+
"max_length": 1024,
|
462
|
+
"documentation": "\n <p>Name of the pipeline.</p>\n ",
|
463
|
+
"required": true
|
464
|
+
},
|
465
|
+
"fields": {
|
466
|
+
"shape_name": "fieldList",
|
467
|
+
"type": "list",
|
468
|
+
"members": {
|
469
|
+
"shape_name": "Field",
|
470
|
+
"type": "structure",
|
471
|
+
"members": {
|
472
|
+
"key": {
|
473
|
+
"shape_name": "fieldNameString",
|
474
|
+
"type": "string",
|
475
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
476
|
+
"min_length": 1,
|
477
|
+
"max_length": 256,
|
478
|
+
"documentation": "\n <p>The field identifier.</p>\n ",
|
479
|
+
"required": true
|
480
|
+
},
|
481
|
+
"stringValue": {
|
482
|
+
"shape_name": "fieldStringValue",
|
483
|
+
"type": "string",
|
484
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
485
|
+
"min_length": 0,
|
486
|
+
"max_length": 10240,
|
487
|
+
"documentation": "\n <p>The field value, expressed as a String.</p>\n "
|
488
|
+
},
|
489
|
+
"refValue": {
|
490
|
+
"shape_name": "fieldNameString",
|
491
|
+
"type": "string",
|
492
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
493
|
+
"min_length": 1,
|
494
|
+
"max_length": 256,
|
495
|
+
"documentation": "\n <p>The field value, expressed as the identifier of another object.</p>\n "
|
496
|
+
}
|
497
|
+
},
|
498
|
+
"documentation": "\n <p>A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (<code>StringValue</code>) or a reference to another object (<code>RefValue</code>) but not as both.</p>\n "
|
499
|
+
},
|
500
|
+
"documentation": "\n <p>A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.</p>\n ",
|
501
|
+
"required": true
|
502
|
+
},
|
503
|
+
"description": {
|
504
|
+
"shape_name": "string",
|
505
|
+
"type": "string",
|
506
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
507
|
+
"min_length": 0,
|
508
|
+
"max_length": 1024,
|
509
|
+
"documentation": "\n <p>Description of the pipeline.</p>\n "
|
510
|
+
}
|
511
|
+
},
|
512
|
+
"documentation": "\n <p>Contains pipeline metadata.</p>\n "
|
513
|
+
},
|
514
|
+
"documentation": "\n <p>An array of descriptions returned for the specified pipelines.</p>\n ",
|
515
|
+
"required": true
|
516
|
+
}
|
517
|
+
},
|
518
|
+
"documentation": "\n <p>Contains the output from the <a>DescribePipelines</a> action.</p>\n "
|
519
|
+
},
|
520
|
+
"errors": [
|
521
|
+
{
|
522
|
+
"shape_name": "PipelineNotFoundException",
|
523
|
+
"type": "structure",
|
524
|
+
"members": {
|
525
|
+
"message": {
|
526
|
+
"shape_name": "errorMessage",
|
527
|
+
"type": "string",
|
528
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
529
|
+
}
|
530
|
+
},
|
531
|
+
"documentation": "\n <p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>\n "
|
532
|
+
},
|
533
|
+
{
|
534
|
+
"shape_name": "PipelineDeletedException",
|
535
|
+
"type": "structure",
|
536
|
+
"members": {
|
537
|
+
"message": {
|
538
|
+
"shape_name": "errorMessage",
|
539
|
+
"type": "string",
|
540
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
541
|
+
}
|
542
|
+
},
|
543
|
+
"documentation": "\n <p>The specified pipeline has been deleted.</p>\n "
|
544
|
+
},
|
545
|
+
{
|
546
|
+
"shape_name": "InternalServiceError",
|
547
|
+
"type": "structure",
|
548
|
+
"members": {
|
549
|
+
"message": {
|
550
|
+
"shape_name": "errorMessage",
|
551
|
+
"type": "string",
|
552
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
553
|
+
}
|
554
|
+
},
|
555
|
+
"documentation": "\n <p>An internal service error occurred.</p>\n "
|
556
|
+
},
|
557
|
+
{
|
558
|
+
"shape_name": "InvalidRequestException",
|
559
|
+
"type": "structure",
|
560
|
+
"members": {
|
561
|
+
"message": {
|
562
|
+
"shape_name": "errorMessage",
|
563
|
+
"type": "string",
|
564
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
565
|
+
}
|
566
|
+
},
|
567
|
+
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
|
568
|
+
}
|
569
|
+
],
|
570
|
+
"documentation": "\n <p>\n Retrieve metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines you have read permission for.\n </p>\n <p>\n To retrieve the full pipeline definition instead of metadata about the pipeline, call the <a>GetPipelineDefinition</a> action.\n </p>\n \n \n <examples>\n <request>\n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.DescribePipelines\nContent-Length: 70\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineIds\": \n [\"df-08785951KAKJEXAMPLE\"]\n}\n\n </request>\n \n\n <response>\n \nx-amzn-RequestId: 02870eb7-0736-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 767\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"pipelineDescriptionList\": \n [\n {\"description\": \"This is my first pipeline\", \n \"fields\": \n [\n {\"key\": \"@pipelineState\", \n \"stringValue\": \"SCHEDULED\"}, \n {\"key\": \"description\", \n \"stringValue\": \"This is my first pipeline\"}, \n {\"key\": \"name\", \n \"stringValue\": \"myPipeline\"}, \n {\"key\": \"@creationTime\", \n \"stringValue\": \"2012-12-13T01:24:06\"}, \n {\"key\": \"@id\", \n \"stringValue\": \"df-0937003356ZJEXAMPLE\"}, \n {\"key\": \"@sphere\", \n \"stringValue\": \"PIPELINE\"}, \n {\"key\": \"@version\", \n \"stringValue\": \"1\"}, \n {\"key\": \"@userId\", \n \"stringValue\": \"924374875933\"}, \n {\"key\": \"@accountId\", \n \"stringValue\": \"924374875933\"}, \n {\"key\": \"uniqueId\", \n \"stringValue\": \"1234567890\"}\n ], \n \"name\": \"myPipeline\", \n \"pipelineId\": \"df-0937003356ZJEXAMPLE\"}\n ]\n}\n</response>\n </examples> \n \n "
|
571
|
+
},
|
572
|
+
"EvaluateExpression": {
|
573
|
+
"name": "EvaluateExpression",
|
574
|
+
"input": {
|
575
|
+
"shape_name": "EvaluateExpressionInput",
|
576
|
+
"type": "structure",
|
577
|
+
"members": {
|
578
|
+
"pipelineId": {
|
579
|
+
"shape_name": "id",
|
580
|
+
"type": "string",
|
581
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
582
|
+
"min_length": 1,
|
583
|
+
"max_length": 1024,
|
584
|
+
"documentation": "\n <p>The identifier of the pipeline.</p>\n ",
|
585
|
+
"required": true
|
586
|
+
},
|
587
|
+
"objectId": {
|
588
|
+
"shape_name": "id",
|
589
|
+
"type": "string",
|
590
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
591
|
+
"min_length": 1,
|
592
|
+
"max_length": 1024,
|
593
|
+
"documentation": "\n <p>The identifier of the object.</p>\n ",
|
594
|
+
"required": true
|
595
|
+
},
|
596
|
+
"expression": {
|
597
|
+
"shape_name": "longString",
|
598
|
+
"type": "string",
|
599
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
600
|
+
"min_length": 0,
|
601
|
+
"max_length": 20971520,
|
602
|
+
"documentation": "\n <p>The expression to evaluate.</p>\n ",
|
603
|
+
"required": true
|
604
|
+
}
|
605
|
+
},
|
606
|
+
"documentation": "\n <p>The input for the <a>EvaluateExpression</a> action.</p>\n "
|
607
|
+
},
|
608
|
+
"output": {
|
609
|
+
"shape_name": "EvaluateExpressionOutput",
|
610
|
+
"type": "structure",
|
611
|
+
"members": {
|
612
|
+
"evaluatedExpression": {
|
613
|
+
"shape_name": "longString",
|
614
|
+
"type": "string",
|
615
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
616
|
+
"min_length": 0,
|
617
|
+
"max_length": 20971520,
|
618
|
+
"documentation": "\n <p>The evaluated expression.</p>\n ",
|
619
|
+
"required": true
|
620
|
+
}
|
621
|
+
},
|
622
|
+
"documentation": "\n <p>Contains the output from the <a>EvaluateExpression</a> action.</p>\n "
|
623
|
+
},
|
624
|
+
"errors": [
|
625
|
+
{
|
626
|
+
"shape_name": "InternalServiceError",
|
627
|
+
"type": "structure",
|
628
|
+
"members": {
|
629
|
+
"message": {
|
630
|
+
"shape_name": "errorMessage",
|
631
|
+
"type": "string",
|
632
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
633
|
+
}
|
634
|
+
},
|
635
|
+
"documentation": "\n <p>An internal service error occurred.</p>\n "
|
636
|
+
},
|
637
|
+
{
|
638
|
+
"shape_name": "TaskNotFoundException",
|
639
|
+
"type": "structure",
|
640
|
+
"members": {
|
641
|
+
"message": {
|
642
|
+
"shape_name": "errorMessage",
|
643
|
+
"type": "string",
|
644
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
645
|
+
}
|
646
|
+
},
|
647
|
+
"documentation": "\n <p>The specified task was not found. </p>\n "
|
648
|
+
},
|
649
|
+
{
|
650
|
+
"shape_name": "InvalidRequestException",
|
651
|
+
"type": "structure",
|
652
|
+
"members": {
|
653
|
+
"message": {
|
654
|
+
"shape_name": "errorMessage",
|
655
|
+
"type": "string",
|
656
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
657
|
+
}
|
658
|
+
},
|
659
|
+
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
|
660
|
+
},
|
661
|
+
{
|
662
|
+
"shape_name": "PipelineNotFoundException",
|
663
|
+
"type": "structure",
|
664
|
+
"members": {
|
665
|
+
"message": {
|
666
|
+
"shape_name": "errorMessage",
|
667
|
+
"type": "string",
|
668
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
669
|
+
}
|
670
|
+
},
|
671
|
+
"documentation": "\n <p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>\n "
|
672
|
+
},
|
673
|
+
{
|
674
|
+
"shape_name": "PipelineDeletedException",
|
675
|
+
"type": "structure",
|
676
|
+
"members": {
|
677
|
+
"message": {
|
678
|
+
"shape_name": "errorMessage",
|
679
|
+
"type": "string",
|
680
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
681
|
+
}
|
682
|
+
},
|
683
|
+
"documentation": "\n <p>The specified pipeline has been deleted.</p>\n "
|
684
|
+
}
|
685
|
+
],
|
686
|
+
"documentation": "\n <p>Evaluates a string in the context of a specified object. A task runner can use this action to evaluate SQL queries stored in Amazon S3. </p>\n \n \n \n <examples>\n <request>\n \nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.DescribePipelines\nContent-Length: 164\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-08785951KAKJEXAMPLE\",\n \"objectId\": \"Schedule\",\n \"expression\": \"Transform started at #{startDateTime} and finished at #{endDateTime}\"}\n\n </request>\n \n \n <response>\n \nx-amzn-RequestId: 02870eb7-0736-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 103\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"evaluatedExpression\": \"Transform started at 2012-12-12T00:00:00 and finished at 2012-12-21T18:00:00\"}\n</response>\n </examples> \n "
|
687
|
+
},
|
688
|
+
"GetPipelineDefinition": {
|
689
|
+
"name": "GetPipelineDefinition",
|
690
|
+
"input": {
|
691
|
+
"shape_name": "GetPipelineDefinitionInput",
|
692
|
+
"type": "structure",
|
693
|
+
"members": {
|
694
|
+
"pipelineId": {
|
695
|
+
"shape_name": "id",
|
696
|
+
"type": "string",
|
697
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
698
|
+
"min_length": 1,
|
699
|
+
"max_length": 1024,
|
700
|
+
"documentation": "\n <p>The identifier of the pipeline.</p>\n ",
|
701
|
+
"required": true
|
702
|
+
},
|
703
|
+
"version": {
|
704
|
+
"shape_name": "string",
|
705
|
+
"type": "string",
|
706
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
707
|
+
"min_length": 0,
|
708
|
+
"max_length": 1024,
|
709
|
+
"documentation": "\n <p>The version of the pipeline definition to retrieve. This parameter accepts the values <code>latest</code> (default) and <code>active</code>. Where <code>latest</code> indicates the last definition saved to the pipeline and <code>active</code> indicates the last definition of the pipeline that was activated.</p>\n "
|
710
|
+
}
|
711
|
+
},
|
712
|
+
"documentation": "\n <p>The input for the <a>GetPipelineDefinition</a> action.</p>\n "
|
713
|
+
},
|
714
|
+
"output": {
|
715
|
+
"shape_name": "GetPipelineDefinitionOutput",
|
716
|
+
"type": "structure",
|
717
|
+
"members": {
|
718
|
+
"pipelineObjects": {
|
719
|
+
"shape_name": "PipelineObjectList",
|
720
|
+
"type": "list",
|
721
|
+
"members": {
|
722
|
+
"shape_name": "PipelineObject",
|
723
|
+
"type": "structure",
|
724
|
+
"members": {
|
725
|
+
"id": {
|
726
|
+
"shape_name": "id",
|
727
|
+
"type": "string",
|
728
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
729
|
+
"min_length": 1,
|
730
|
+
"max_length": 1024,
|
731
|
+
"documentation": "\n <p>Identifier of the object.</p>\n ",
|
732
|
+
"required": true
|
733
|
+
},
|
734
|
+
"name": {
|
735
|
+
"shape_name": "id",
|
736
|
+
"type": "string",
|
737
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
738
|
+
"min_length": 1,
|
739
|
+
"max_length": 1024,
|
740
|
+
"documentation": "\n <p>Name of the object.</p>\n ",
|
741
|
+
"required": true
|
742
|
+
},
|
743
|
+
"fields": {
|
744
|
+
"shape_name": "fieldList",
|
745
|
+
"type": "list",
|
746
|
+
"members": {
|
747
|
+
"shape_name": "Field",
|
748
|
+
"type": "structure",
|
749
|
+
"members": {
|
750
|
+
"key": {
|
751
|
+
"shape_name": "fieldNameString",
|
752
|
+
"type": "string",
|
753
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
754
|
+
"min_length": 1,
|
755
|
+
"max_length": 256,
|
756
|
+
"documentation": "\n <p>The field identifier.</p>\n ",
|
757
|
+
"required": true
|
758
|
+
},
|
759
|
+
"stringValue": {
|
760
|
+
"shape_name": "fieldStringValue",
|
761
|
+
"type": "string",
|
762
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
763
|
+
"min_length": 0,
|
764
|
+
"max_length": 10240,
|
765
|
+
"documentation": "\n <p>The field value, expressed as a String.</p>\n "
|
766
|
+
},
|
767
|
+
"refValue": {
|
768
|
+
"shape_name": "fieldNameString",
|
769
|
+
"type": "string",
|
770
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
771
|
+
"min_length": 1,
|
772
|
+
"max_length": 256,
|
773
|
+
"documentation": "\n <p>The field value, expressed as the identifier of another object.</p>\n "
|
774
|
+
}
|
775
|
+
},
|
776
|
+
"documentation": "\n <p>A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (<code>StringValue</code>) or a reference to another object (<code>RefValue</code>) but not as both.</p>\n "
|
777
|
+
},
|
778
|
+
"documentation": "\n <p>Key-value pairs that define the properties of the object.</p>\n ",
|
779
|
+
"required": true
|
780
|
+
}
|
781
|
+
},
|
782
|
+
"documentation": "\n <p>Contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.</p>\n "
|
783
|
+
},
|
784
|
+
"documentation": "\n <p>An array of objects defined in the pipeline.</p>\n "
|
785
|
+
}
|
786
|
+
},
|
787
|
+
"documentation": "\n <p>Contains the output from the <a>GetPipelineDefinition</a> action.</p>\n "
|
788
|
+
},
|
789
|
+
"errors": [
|
790
|
+
{
|
791
|
+
"shape_name": "InternalServiceError",
|
792
|
+
"type": "structure",
|
793
|
+
"members": {
|
794
|
+
"message": {
|
795
|
+
"shape_name": "errorMessage",
|
796
|
+
"type": "string",
|
797
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
798
|
+
}
|
799
|
+
},
|
800
|
+
"documentation": "\n <p>An internal service error occurred.</p>\n "
|
801
|
+
},
|
802
|
+
{
|
803
|
+
"shape_name": "InvalidRequestException",
|
804
|
+
"type": "structure",
|
805
|
+
"members": {
|
806
|
+
"message": {
|
807
|
+
"shape_name": "errorMessage",
|
808
|
+
"type": "string",
|
809
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
810
|
+
}
|
811
|
+
},
|
812
|
+
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
|
813
|
+
},
|
814
|
+
{
|
815
|
+
"shape_name": "PipelineNotFoundException",
|
816
|
+
"type": "structure",
|
817
|
+
"members": {
|
818
|
+
"message": {
|
819
|
+
"shape_name": "errorMessage",
|
820
|
+
"type": "string",
|
821
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
822
|
+
}
|
823
|
+
},
|
824
|
+
"documentation": "\n <p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>\n "
|
825
|
+
},
|
826
|
+
{
|
827
|
+
"shape_name": "PipelineDeletedException",
|
828
|
+
"type": "structure",
|
829
|
+
"members": {
|
830
|
+
"message": {
|
831
|
+
"shape_name": "errorMessage",
|
832
|
+
"type": "string",
|
833
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
834
|
+
}
|
835
|
+
},
|
836
|
+
"documentation": "\n <p>The specified pipeline has been deleted.</p>\n "
|
837
|
+
}
|
838
|
+
],
|
839
|
+
"documentation": "\n <p>Returns the definition of the specified pipeline. You can call <a>GetPipelineDefinition</a> to retrieve the pipeline definition you provided using <a>PutPipelineDefinition</a>.</p>\n\n <examples>\n <request>\n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.GetPipelineDefinition\nContent-Length: 40\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\"}\n\n </request>\n <response>\n \nx-amzn-RequestId: e28309e5-0776-11e2-8a14-21bb8a1f50ef\nContent-Type: application/x-amz-json-1.1\nContent-Length: 890\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"pipelineObjects\": \n [\n {\"fields\": \n [\n {\"key\": \"workerGroup\", \n \"stringValue\": \"workerGroup\"}\n ], \n \"id\": \"Default\", \n \"name\": \"Default\"}, \n {\"fields\": \n [\n {\"key\": \"startDateTime\", \n \"stringValue\": \"2012-09-25T17:00:00\"}, \n {\"key\": \"type\", \n \"stringValue\": \"Schedule\"}, \n {\"key\": \"period\", \n \"stringValue\": \"1 hour\"}, \n {\"key\": \"endDateTime\", \n \"stringValue\": \"2012-09-25T18:00:00\"}\n ], \n \"id\": \"Schedule\", \n \"name\": \"Schedule\"}, \n {\"fields\": \n [\n {\"key\": \"schedule\", \n \"refValue\": \"Schedule\"}, \n {\"key\": \"command\", \n \"stringValue\": \"echo hello\"}, \n {\"key\": \"parent\", \n \"refValue\": \"Default\"}, \n {\"key\": \"type\", \n \"stringValue\": \"ShellCommandActivity\"}\n ], \n \"id\": \"SayHello\", \n \"name\": \"SayHello\"}\n ]\n}\n\n </response>\n </examples>\n "
|
840
|
+
},
|
841
|
+
"ListPipelines": {
|
842
|
+
"name": "ListPipelines",
|
843
|
+
"input": {
|
844
|
+
"shape_name": "ListPipelinesInput",
|
845
|
+
"type": "structure",
|
846
|
+
"members": {
|
847
|
+
"marker": {
|
848
|
+
"shape_name": "string",
|
849
|
+
"type": "string",
|
850
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
851
|
+
"min_length": 0,
|
852
|
+
"max_length": 1024,
|
853
|
+
"documentation": "\n <p>The starting point for the results to be returned. The first time you call <a>ListPipelines</a>, this value should be empty. As long as the action returns <code>HasMoreResults</code> as <code>True</code>, you can call <a>ListPipelines</a> again and pass the marker value from the response to retrieve the next set of results.</p>\n "
|
854
|
+
}
|
855
|
+
},
|
856
|
+
"documentation": "\n <p>The input to the <a>ListPipelines</a> action.</p>\n "
|
857
|
+
},
|
858
|
+
"output": {
|
859
|
+
"shape_name": "ListPipelinesOutput",
|
860
|
+
"type": "structure",
|
861
|
+
"members": {
|
862
|
+
"pipelineIdList": {
|
863
|
+
"shape_name": "pipelineList",
|
864
|
+
"type": "list",
|
865
|
+
"members": {
|
866
|
+
"shape_name": "PipelineIdName",
|
867
|
+
"type": "structure",
|
868
|
+
"members": {
|
869
|
+
"id": {
|
870
|
+
"shape_name": "id",
|
871
|
+
"type": "string",
|
872
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
873
|
+
"min_length": 1,
|
874
|
+
"max_length": 1024,
|
875
|
+
"documentation": "\n <p>Identifier of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form <code>df-297EG78HU43EEXAMPLE</code>.</p>\n "
|
876
|
+
},
|
877
|
+
"name": {
|
878
|
+
"shape_name": "id",
|
879
|
+
"type": "string",
|
880
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
881
|
+
"min_length": 1,
|
882
|
+
"max_length": 1024,
|
883
|
+
"documentation": "\n <p>Name of the pipeline.</p>\n "
|
884
|
+
}
|
885
|
+
},
|
886
|
+
"documentation": "\n <p>Contains the name and identifier of a pipeline.</p>\n "
|
887
|
+
},
|
888
|
+
"documentation": "\n <p>\n A list of all the pipeline identifiers that your account has permission to access. If you require additional information about the pipelines, you can use these identifiers to call <a>DescribePipelines</a> and <a>GetPipelineDefinition</a>.\n </p> \n ",
|
889
|
+
"required": true
|
890
|
+
},
|
891
|
+
"marker": {
|
892
|
+
"shape_name": "string",
|
893
|
+
"type": "string",
|
894
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
895
|
+
"min_length": 0,
|
896
|
+
"max_length": 1024,
|
897
|
+
"documentation": "\n <p>If not null, indicates the starting point for the set of pipeline identifiers that the next call to <a>ListPipelines</a> will retrieve. If null, there are no more pipeline identifiers.</p>\n "
|
898
|
+
},
|
899
|
+
"hasMoreResults": {
|
900
|
+
"shape_name": "boolean",
|
901
|
+
"type": "boolean",
|
902
|
+
"documentation": "\n <p>If <code>True</code>, there are more results that can be obtained by a subsequent call to <a>ListPipelines</a>.</p>\n "
|
903
|
+
}
|
904
|
+
},
|
905
|
+
"documentation": "\n <p>Contains the output from the <a>ListPipelines</a> action.</p> \n "
|
906
|
+
},
|
907
|
+
"errors": [
|
908
|
+
{
|
909
|
+
"shape_name": "InternalServiceError",
|
910
|
+
"type": "structure",
|
911
|
+
"members": {
|
912
|
+
"message": {
|
913
|
+
"shape_name": "errorMessage",
|
914
|
+
"type": "string",
|
915
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
916
|
+
}
|
917
|
+
},
|
918
|
+
"documentation": "\n <p>An internal service error occurred.</p>\n "
|
919
|
+
},
|
920
|
+
{
|
921
|
+
"shape_name": "InvalidRequestException",
|
922
|
+
"type": "structure",
|
923
|
+
"members": {
|
924
|
+
"message": {
|
925
|
+
"shape_name": "errorMessage",
|
926
|
+
"type": "string",
|
927
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
928
|
+
}
|
929
|
+
},
|
930
|
+
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
|
931
|
+
}
|
932
|
+
],
|
933
|
+
"documentation": "\n <p>Returns a list of pipeline identifiers for all active pipelines. Identifiers are returned only for pipelines you have permission to access. </p> \n \n <examples>\n <request>\n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.ListPipelines\nContent-Length: 14\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{}\n\n </request>\n \n <response>\n \nStatus:\nx-amzn-RequestId: b3104dc5-0734-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 39\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"PipelineIdList\": \n [\n {\"id\": \"df-08785951KAKJEXAMPLE\",\n \"name\": \"MyPipeline\"}, \n {\"id\": \"df-08662578ISYEXAMPLE\", \n \"name\": \"MySecondPipeline\"}\n ]\n} \n </response>\n </examples>\n \n "
|
934
|
+
},
|
935
|
+
"PollForTask": {
|
936
|
+
"name": "PollForTask",
|
937
|
+
"input": {
|
938
|
+
"shape_name": "PollForTaskInput",
|
939
|
+
"type": "structure",
|
940
|
+
"members": {
|
941
|
+
"workerGroup": {
|
942
|
+
"shape_name": "string",
|
943
|
+
"type": "string",
|
944
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
945
|
+
"min_length": 0,
|
946
|
+
"max_length": 1024,
|
947
|
+
"documentation": "\n <p>Indicates the type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for <code>workerGroup</code> in the call to <a>PollForTask</a>. There are no wildcard values permitted in <code>workerGroup</code>, the string must be an exact, case-sensitive, match.\n </p>\n ",
|
948
|
+
"required": true
|
949
|
+
},
|
950
|
+
"hostname": {
|
951
|
+
"shape_name": "id",
|
952
|
+
"type": "string",
|
953
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
954
|
+
"min_length": 1,
|
955
|
+
"max_length": 1024,
|
956
|
+
"documentation": "\n <p>The public DNS name of the calling task runner.</p>\n "
|
957
|
+
},
|
958
|
+
"instanceIdentity": {
|
959
|
+
"shape_name": "InstanceIdentity",
|
960
|
+
"type": "structure",
|
961
|
+
"members": {
|
962
|
+
"document": {
|
963
|
+
"shape_name": "string",
|
964
|
+
"type": "string",
|
965
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
966
|
+
"min_length": 0,
|
967
|
+
"max_length": 1024,
|
968
|
+
"documentation": "\n <p>A description of an Amazon EC2 instance that is generated when the instance is launched and exposed to the instance via the instance metadata service in the form of a JSON representation of an object.</p>\n "
|
969
|
+
},
|
970
|
+
"signature": {
|
971
|
+
"shape_name": "string",
|
972
|
+
"type": "string",
|
973
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
974
|
+
"min_length": 0,
|
975
|
+
"max_length": 1024,
|
976
|
+
"documentation": "\n <p>A signature which can be used to verify the accuracy and authenticity of the information provided in the instance identity document.</p>\n "
|
977
|
+
}
|
978
|
+
},
|
979
|
+
"documentation": "\n <p>Identity information for the Amazon EC2 instance that is hosting the task runner. You can get this value by calling the URI, <code>http://169.254.169.254/latest/meta-data/instance-id</code>, from the EC2 instance. For more information, go to <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html\">Instance Metadata</a> in the <i>Amazon Elastic Compute Cloud User Guide.</i> Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.</p>\n "
|
980
|
+
}
|
981
|
+
},
|
982
|
+
"documentation": "\n <p>The data type passed in as input to the PollForTask action.</p>\n "
|
983
|
+
},
|
984
|
+
"output": {
|
985
|
+
"shape_name": "PollForTaskOutput",
|
986
|
+
"type": "structure",
|
987
|
+
"members": {
|
988
|
+
"taskObject": {
|
989
|
+
"shape_name": "TaskObject",
|
990
|
+
"type": "structure",
|
991
|
+
"members": {
|
992
|
+
"taskId": {
|
993
|
+
"shape_name": "taskId",
|
994
|
+
"type": "string",
|
995
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
996
|
+
"min_length": 1,
|
997
|
+
"max_length": 2048,
|
998
|
+
"documentation": "\n <p>An internal identifier for the task. This ID is passed to the <a>SetTaskStatus</a> and <a>ReportTaskProgress</a> actions.</p>\n "
|
999
|
+
},
|
1000
|
+
"pipelineId": {
|
1001
|
+
"shape_name": "id",
|
1002
|
+
"type": "string",
|
1003
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1004
|
+
"min_length": 1,
|
1005
|
+
"max_length": 1024,
|
1006
|
+
"documentation": "\n <p>Identifier of the pipeline that provided the task.</p>\n "
|
1007
|
+
},
|
1008
|
+
"attemptId": {
|
1009
|
+
"shape_name": "id",
|
1010
|
+
"type": "string",
|
1011
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1012
|
+
"min_length": 1,
|
1013
|
+
"max_length": 1024,
|
1014
|
+
"documentation": "\n <p>Identifier of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted.</p>\n "
|
1015
|
+
},
|
1016
|
+
"objects": {
|
1017
|
+
"shape_name": "PipelineObjectMap",
|
1018
|
+
"type": "map",
|
1019
|
+
"keys": {
|
1020
|
+
"shape_name": "id",
|
1021
|
+
"type": "string",
|
1022
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1023
|
+
"min_length": 1,
|
1024
|
+
"max_length": 1024,
|
1025
|
+
"documentation": null
|
1026
|
+
},
|
1027
|
+
"members": {
|
1028
|
+
"shape_name": "PipelineObject",
|
1029
|
+
"type": "structure",
|
1030
|
+
"members": {
|
1031
|
+
"id": {
|
1032
|
+
"shape_name": "id",
|
1033
|
+
"type": "string",
|
1034
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1035
|
+
"min_length": 1,
|
1036
|
+
"max_length": 1024,
|
1037
|
+
"documentation": "\n <p>Identifier of the object.</p>\n ",
|
1038
|
+
"required": true
|
1039
|
+
},
|
1040
|
+
"name": {
|
1041
|
+
"shape_name": "id",
|
1042
|
+
"type": "string",
|
1043
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1044
|
+
"min_length": 1,
|
1045
|
+
"max_length": 1024,
|
1046
|
+
"documentation": "\n <p>Name of the object.</p>\n ",
|
1047
|
+
"required": true
|
1048
|
+
},
|
1049
|
+
"fields": {
|
1050
|
+
"shape_name": "fieldList",
|
1051
|
+
"type": "list",
|
1052
|
+
"members": {
|
1053
|
+
"shape_name": "Field",
|
1054
|
+
"type": "structure",
|
1055
|
+
"members": {
|
1056
|
+
"key": {
|
1057
|
+
"shape_name": "fieldNameString",
|
1058
|
+
"type": "string",
|
1059
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1060
|
+
"min_length": 1,
|
1061
|
+
"max_length": 256,
|
1062
|
+
"documentation": "\n <p>The field identifier.</p>\n ",
|
1063
|
+
"required": true
|
1064
|
+
},
|
1065
|
+
"stringValue": {
|
1066
|
+
"shape_name": "fieldStringValue",
|
1067
|
+
"type": "string",
|
1068
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1069
|
+
"min_length": 0,
|
1070
|
+
"max_length": 10240,
|
1071
|
+
"documentation": "\n <p>The field value, expressed as a String.</p>\n "
|
1072
|
+
},
|
1073
|
+
"refValue": {
|
1074
|
+
"shape_name": "fieldNameString",
|
1075
|
+
"type": "string",
|
1076
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1077
|
+
"min_length": 1,
|
1078
|
+
"max_length": 256,
|
1079
|
+
"documentation": "\n <p>The field value, expressed as the identifier of another object.</p>\n "
|
1080
|
+
}
|
1081
|
+
},
|
1082
|
+
"documentation": "\n <p>A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (<code>StringValue</code>) or a reference to another object (<code>RefValue</code>) but not as both.</p>\n "
|
1083
|
+
},
|
1084
|
+
"documentation": "\n <p>Key-value pairs that define the properties of the object.</p>\n ",
|
1085
|
+
"required": true
|
1086
|
+
}
|
1087
|
+
},
|
1088
|
+
"documentation": "\n <p>Contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.</p>\n "
|
1089
|
+
},
|
1090
|
+
"documentation": "\n <p>Connection information for the location where the task runner will publish the output of the task.</p>\n "
|
1091
|
+
}
|
1092
|
+
},
|
1093
|
+
"documentation": "\n <p>An instance of <a>PollForTaskResult</a>, which contains an instance of <a>TaskObject</a>. The returned object contains all the information needed to complete the task that is being assigned to the task runner. One of the fields returned in this object is taskId, which contains an identifier for the task being assigned. The calling task runner uses taskId in subsequent calls to <a>ReportTaskProgress</a> and <a>SetTaskStatus</a>.</p>\n "
|
1094
|
+
}
|
1095
|
+
},
|
1096
|
+
"documentation": "\n <p>Contains the output from the PollForTask action.</p>\n "
|
1097
|
+
},
|
1098
|
+
"errors": [
|
1099
|
+
{
|
1100
|
+
"shape_name": "InternalServiceError",
|
1101
|
+
"type": "structure",
|
1102
|
+
"members": {
|
1103
|
+
"message": {
|
1104
|
+
"shape_name": "errorMessage",
|
1105
|
+
"type": "string",
|
1106
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
1107
|
+
}
|
1108
|
+
},
|
1109
|
+
"documentation": "\n <p>An internal service error occurred.</p>\n "
|
1110
|
+
},
|
1111
|
+
{
|
1112
|
+
"shape_name": "InvalidRequestException",
|
1113
|
+
"type": "structure",
|
1114
|
+
"members": {
|
1115
|
+
"message": {
|
1116
|
+
"shape_name": "errorMessage",
|
1117
|
+
"type": "string",
|
1118
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
1119
|
+
}
|
1120
|
+
},
|
1121
|
+
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
|
1122
|
+
},
|
1123
|
+
{
|
1124
|
+
"shape_name": "TaskNotFoundException",
|
1125
|
+
"type": "structure",
|
1126
|
+
"members": {
|
1127
|
+
"message": {
|
1128
|
+
"shape_name": "errorMessage",
|
1129
|
+
"type": "string",
|
1130
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
1131
|
+
}
|
1132
|
+
},
|
1133
|
+
"documentation": "\n <p>The specified task was not found. </p>\n "
|
1134
|
+
}
|
1135
|
+
],
|
1136
|
+
"documentation": "\n <p>\n Task runners call this action to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for the workerGroup parameter of the <a>PollForTask</a> call. The task returned by <a>PollForTask</a> may come from any of the pipelines that match the workerGroup value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner.\n </p>\n <p>\n If tasks are ready in the work queue, <a>PollForTask</a> returns a response immediately. If no tasks are available in the queue, <a>PollForTask</a> uses long-polling and holds on to a poll connection for up to a 90 seconds during which time the first newly scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task runner should not call <a>PollForTask</a> again on the same <code>workerGroup</code> until it receives a response, and this may take up to 90 seconds.\n </p>\n\n <examples>\n <request>\n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.PollForTask\nContent-Length: 59\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"workerGroup\": \"MyworkerGroup\",\n \"hostname\": \"example.com\"}\n\n </request>\n \n <response>\n \nx-amzn-RequestId: 41c713d2-0775-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 39\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"taskObject\": \n {\"attemptId\": \"@SayHello_2012-12-12T00:00:00_Attempt=1\", \n \"objects\": \n {\"@SayHello_2012-12-12T00:00:00_Attempt=1\": \n {\"fields\": \n [\n {\"key\": \"@componentParent\", \n \"refValue\": \"SayHello\"}, \n {\"key\": \"@scheduledStartTime\", \n \"stringValue\": \"2012-12-12T00:00:00\"}, \n {\"key\": \"parent\", \n \"refValue\": \"SayHello\"}, \n {\"key\": \"@sphere\", \n \"stringValue\": \"ATTEMPT\"}, \n {\"key\": \"workerGroup\", \n \"stringValue\": \"workerGroup\"}, \n {\"key\": \"@instanceParent\", \n \"refValue\": \"@SayHello_2012-12-12T00:00:00\"}, \n {\"key\": \"type\", \n \"stringValue\": \"ShellCommandActivity\"}, \n {\"key\": \"@status\", \n \"stringValue\": \"WAITING_FOR_RUNNER\"}, \n {\"key\": \"@version\", \n \"stringValue\": \"1\"}, \n {\"key\": \"schedule\", \n \"refValue\": \"Schedule\"}, \n {\"key\": \"@actualStartTime\", \n \"stringValue\": \"2012-12-13T01:40:50\"}, \n {\"key\": \"command\", \n \"stringValue\": \"echo hello\"}, \n {\"key\": \"@scheduledEndTime\", \n \"stringValue\": \"2012-12-12T01:00:00\"}, \n {\"key\": \"@activeInstances\", \n \"refValue\": \"@SayHello_2012-12-12T00:00:00\"}, \n {\"key\": \"@pipelineId\", \n \"stringValue\": \"df-0937003356ZJEXAMPLE\"}\n ], \n \"id\": \"@SayHello_2012-12-12T00:00:00_Attempt=1\", \n \"name\": \"@SayHello_2012-12-12T00:00:00_Attempt=1\"}\n }, \n \"pipelineId\": \"df-0937003356ZJEXAMPLE\", \n \"taskId\": \"2xaM4wRs5zOsIH+g9U3oVHfAgAlbSqU6XduncB0HhZ3xMnmvfePZPn4dIbYXHyWyRK+cU15MqDHwdrvftx/4wv+sNS4w34vJfv7QA9aOoOazW28l1GYSb2ZRR0N0paiQp+d1MhSKo10hOTWOsVK5S5Lnx9Qm6omFgXHyIvZRIvTlrQMpr1xuUrflyGOfbFOGpOLpvPE172MYdqpZKnbSS4TcuqgQKSWV2833fEubI57DPOP7ghWa2TcYeSIv4pdLYG53fTuwfbnbdc98g2LNUQzSVhSnt7BoqyNwht2aQ6b/UHg9A80+KVpuXuqmz3m1MXwHFgxjdmuesXNOrrlGpeLCcRWD+aGo0RN1NqhQRzNAig8V4GlaPTQzMsRCljKqvrIyAoP3Tt2XEGsHkkQo12rEX8Z90957XX2qKRwhruwYzqGkSLWjINoLdAxUJdpRXRc5DJTrBd3D5mdzn7kY1l7NEh4kFHJDt3Cx4Z3Mk8MYCACyCk/CEyy9DwuPi66cLz0NBcgbCM5LKjTBOwo1m+am+pvM1kSposE9FPP1+RFGb8k6jQBTJx3TRz1yKilnGXQTZ5xvdOFpJrklIT0OXP1MG3+auM9FlJA+1dX90QoNJE5z7axmK//MOGXUdkqFe2kiDkorqjxwDvc0Js9pVKfKvAmW8YqUbmI9l0ERpWCXXnLVHNmPWz3jaPY+OBAmuJWDmxB/Z8p94aEDg4BVXQ7LvsKQ3DLYhaB7yJ390CJT+i0mm+EBqY60V6YikPSWDFrYQ/NPi2b1DgE19mX8zHqw8qprIl4yh1Ckx2Iige4En/N5ktOoIxnASxAw/TzcE2skxdw5KlHDF+UTj71m16CR/dIaKlXijlfNlNzUBo/bNSadCQn3G5NoO501wPKI:XO50TgDNyo8EXAMPLE/g==:1\"}\n}\n \n </response>\n </examples>\n "
|
1137
|
+
},
|
1138
|
+
"PutPipelineDefinition": {
|
1139
|
+
"name": "PutPipelineDefinition",
|
1140
|
+
"input": {
|
1141
|
+
"shape_name": "PutPipelineDefinitionInput",
|
1142
|
+
"type": "structure",
|
1143
|
+
"members": {
|
1144
|
+
"pipelineId": {
|
1145
|
+
"shape_name": "id",
|
1146
|
+
"type": "string",
|
1147
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1148
|
+
"min_length": 1,
|
1149
|
+
"max_length": 1024,
|
1150
|
+
"documentation": "\n <p>The identifier of the pipeline to be configured.</p>\n ",
|
1151
|
+
"required": true
|
1152
|
+
},
|
1153
|
+
"pipelineObjects": {
|
1154
|
+
"shape_name": "PipelineObjectList",
|
1155
|
+
"type": "list",
|
1156
|
+
"members": {
|
1157
|
+
"shape_name": "PipelineObject",
|
1158
|
+
"type": "structure",
|
1159
|
+
"members": {
|
1160
|
+
"id": {
|
1161
|
+
"shape_name": "id",
|
1162
|
+
"type": "string",
|
1163
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1164
|
+
"min_length": 1,
|
1165
|
+
"max_length": 1024,
|
1166
|
+
"documentation": "\n <p>Identifier of the object.</p>\n ",
|
1167
|
+
"required": true
|
1168
|
+
},
|
1169
|
+
"name": {
|
1170
|
+
"shape_name": "id",
|
1171
|
+
"type": "string",
|
1172
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1173
|
+
"min_length": 1,
|
1174
|
+
"max_length": 1024,
|
1175
|
+
"documentation": "\n <p>Name of the object.</p>\n ",
|
1176
|
+
"required": true
|
1177
|
+
},
|
1178
|
+
"fields": {
|
1179
|
+
"shape_name": "fieldList",
|
1180
|
+
"type": "list",
|
1181
|
+
"members": {
|
1182
|
+
"shape_name": "Field",
|
1183
|
+
"type": "structure",
|
1184
|
+
"members": {
|
1185
|
+
"key": {
|
1186
|
+
"shape_name": "fieldNameString",
|
1187
|
+
"type": "string",
|
1188
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1189
|
+
"min_length": 1,
|
1190
|
+
"max_length": 256,
|
1191
|
+
"documentation": "\n <p>The field identifier.</p>\n ",
|
1192
|
+
"required": true
|
1193
|
+
},
|
1194
|
+
"stringValue": {
|
1195
|
+
"shape_name": "fieldStringValue",
|
1196
|
+
"type": "string",
|
1197
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1198
|
+
"min_length": 0,
|
1199
|
+
"max_length": 10240,
|
1200
|
+
"documentation": "\n <p>The field value, expressed as a String.</p>\n "
|
1201
|
+
},
|
1202
|
+
"refValue": {
|
1203
|
+
"shape_name": "fieldNameString",
|
1204
|
+
"type": "string",
|
1205
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1206
|
+
"min_length": 1,
|
1207
|
+
"max_length": 256,
|
1208
|
+
"documentation": "\n <p>The field value, expressed as the identifier of another object.</p>\n "
|
1209
|
+
}
|
1210
|
+
},
|
1211
|
+
"documentation": "\n <p>A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (<code>StringValue</code>) or a reference to another object (<code>RefValue</code>) but not as both.</p>\n "
|
1212
|
+
},
|
1213
|
+
"documentation": "\n <p>Key-value pairs that define the properties of the object.</p>\n ",
|
1214
|
+
"required": true
|
1215
|
+
}
|
1216
|
+
},
|
1217
|
+
"documentation": "\n <p>Contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.</p>\n "
|
1218
|
+
},
|
1219
|
+
"documentation": "\n <p>The objects that define the pipeline. These will overwrite the existing pipeline definition.</p>\n ",
|
1220
|
+
"required": true
|
1221
|
+
}
|
1222
|
+
},
|
1223
|
+
"documentation": "\n <p>The input of the <a>PutPipelineDefinition</a> action.</p>\n "
|
1224
|
+
},
|
1225
|
+
"output": {
|
1226
|
+
"shape_name": "PutPipelineDefinitionOutput",
|
1227
|
+
"type": "structure",
|
1228
|
+
"members": {
|
1229
|
+
"validationErrors": {
|
1230
|
+
"shape_name": "ValidationErrors",
|
1231
|
+
"type": "list",
|
1232
|
+
"members": {
|
1233
|
+
"shape_name": "ValidationError",
|
1234
|
+
"type": "structure",
|
1235
|
+
"members": {
|
1236
|
+
"id": {
|
1237
|
+
"shape_name": "id",
|
1238
|
+
"type": "string",
|
1239
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1240
|
+
"min_length": 1,
|
1241
|
+
"max_length": 1024,
|
1242
|
+
"documentation": "\n <p>The identifier of the object that contains the validation error.</p>\n "
|
1243
|
+
},
|
1244
|
+
"errors": {
|
1245
|
+
"shape_name": "validationMessages",
|
1246
|
+
"type": "list",
|
1247
|
+
"members": {
|
1248
|
+
"shape_name": "validationMessage",
|
1249
|
+
"type": "string",
|
1250
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1251
|
+
"min_length": 0,
|
1252
|
+
"max_length": 10000,
|
1253
|
+
"documentation": null
|
1254
|
+
},
|
1255
|
+
"documentation": "\n <p>A description of the validation error.</p>\n "
|
1256
|
+
}
|
1257
|
+
},
|
1258
|
+
"documentation": "\n <p>Defines a validation error returned by <a>PutPipelineDefinition</a> or <a>ValidatePipelineDefinition</a>. Validation errors prevent pipeline activation. The set of validation errors that can be returned are defined by AWS Data Pipeline.</p>\n "
|
1259
|
+
},
|
1260
|
+
"documentation": "\n <p>A list of the validation errors that are associated with the objects defined in <code>pipelineObjects</code>.</p>\n "
|
1261
|
+
},
|
1262
|
+
"validationWarnings": {
|
1263
|
+
"shape_name": "ValidationWarnings",
|
1264
|
+
"type": "list",
|
1265
|
+
"members": {
|
1266
|
+
"shape_name": "ValidationWarning",
|
1267
|
+
"type": "structure",
|
1268
|
+
"members": {
|
1269
|
+
"id": {
|
1270
|
+
"shape_name": "id",
|
1271
|
+
"type": "string",
|
1272
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1273
|
+
"min_length": 1,
|
1274
|
+
"max_length": 1024,
|
1275
|
+
"documentation": "\n <p>The identifier of the object that contains the validation warning.</p>\n "
|
1276
|
+
},
|
1277
|
+
"warnings": {
|
1278
|
+
"shape_name": "validationMessages",
|
1279
|
+
"type": "list",
|
1280
|
+
"members": {
|
1281
|
+
"shape_name": "validationMessage",
|
1282
|
+
"type": "string",
|
1283
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1284
|
+
"min_length": 0,
|
1285
|
+
"max_length": 10000,
|
1286
|
+
"documentation": null
|
1287
|
+
},
|
1288
|
+
"documentation": "\n <p>A description of the validation warning.</p>\n "
|
1289
|
+
}
|
1290
|
+
},
|
1291
|
+
"documentation": "\n <p>Defines a validation warning returned by <a>PutPipelineDefinition</a> or <a>ValidatePipelineDefinition</a>. Validation warnings do not prevent pipeline activation. The set of validation warnings that can be returned are defined by AWS Data Pipeline.</p>\n "
|
1292
|
+
},
|
1293
|
+
"documentation": "\n <p>A list of the validation warnings that are associated with the objects defined in <code>pipelineObjects</code>.</p>\n "
|
1294
|
+
},
|
1295
|
+
"errored": {
|
1296
|
+
"shape_name": "boolean",
|
1297
|
+
"type": "boolean",
|
1298
|
+
"documentation": "\n <p>If <code>True</code>, there were validation errors. If errored is <code>True</code>, the pipeline definition is stored but cannot be activated until you correct the pipeline and call <a>PutPipelineDefinition</a> to commit the corrected pipeline.</p>\n ",
|
1299
|
+
"required": true
|
1300
|
+
}
|
1301
|
+
},
|
1302
|
+
"documentation": "\n <p>Contains the output of the <a>PutPipelineDefinition</a> action.</p>\n "
|
1303
|
+
},
|
1304
|
+
"errors": [
|
1305
|
+
{
|
1306
|
+
"shape_name": "InternalServiceError",
|
1307
|
+
"type": "structure",
|
1308
|
+
"members": {
|
1309
|
+
"message": {
|
1310
|
+
"shape_name": "errorMessage",
|
1311
|
+
"type": "string",
|
1312
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
1313
|
+
}
|
1314
|
+
},
|
1315
|
+
"documentation": "\n <p>An internal service error occurred.</p>\n "
|
1316
|
+
},
|
1317
|
+
{
|
1318
|
+
"shape_name": "InvalidRequestException",
|
1319
|
+
"type": "structure",
|
1320
|
+
"members": {
|
1321
|
+
"message": {
|
1322
|
+
"shape_name": "errorMessage",
|
1323
|
+
"type": "string",
|
1324
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
1325
|
+
}
|
1326
|
+
},
|
1327
|
+
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
|
1328
|
+
},
|
1329
|
+
{
|
1330
|
+
"shape_name": "PipelineNotFoundException",
|
1331
|
+
"type": "structure",
|
1332
|
+
"members": {
|
1333
|
+
"message": {
|
1334
|
+
"shape_name": "errorMessage",
|
1335
|
+
"type": "string",
|
1336
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
1337
|
+
}
|
1338
|
+
},
|
1339
|
+
"documentation": "\n <p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>\n "
|
1340
|
+
},
|
1341
|
+
{
|
1342
|
+
"shape_name": "PipelineDeletedException",
|
1343
|
+
"type": "structure",
|
1344
|
+
"members": {
|
1345
|
+
"message": {
|
1346
|
+
"shape_name": "errorMessage",
|
1347
|
+
"type": "string",
|
1348
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
1349
|
+
}
|
1350
|
+
},
|
1351
|
+
"documentation": "\n <p>The specified pipeline has been deleted.</p>\n "
|
1352
|
+
}
|
1353
|
+
],
|
1354
|
+
"documentation": "\n <p>Adds tasks, schedules, and preconditions that control the behavior of the pipeline. You can use PutPipelineDefinition to populate a new pipeline.\n </p>\n <p>\n <a>PutPipelineDefinition</a> also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline.\n <ol>\n <li>An object is missing a name or identifier field.</li>\n <li>A string or reference field is empty.</li>\n <li>The number of objects in the pipeline exceeds the maximum allowed objects.</li>\n </ol>\n </p>\n <p>\n Pipeline object definitions are passed to the <a>PutPipelineDefinition</a> action and returned by the <a>GetPipelineDefinition</a> action. \n </p>\n <examples>\n <example>\n <name>Example 1</name>\n <description>\n This example sets an valid pipeline configuration and returns success.\n </description>\n <request>\n \nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.PutPipelineDefinition\nContent-Length: 914\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-0937003356ZJEXAMPLE\",\n \"pipelineObjects\": \n [\n {\"id\": \"Default\",\n \"name\": \"Default\",\n \"fields\": \n [\n {\"key\": \"workerGroup\", \n \"stringValue\": \"workerGroup\"}\n ]\n }, \n {\"id\": \"Schedule\",\n \"name\": \"Schedule\",\n \"fields\": \n [\n {\"key\": \"startDateTime\", \n \"stringValue\": \"2012-12-12T00:00:00\"}, \n {\"key\": \"type\", \n \"stringValue\": \"Schedule\"}, \n {\"key\": \"period\", \n \"stringValue\": \"1 hour\"}, \n {\"key\": \"endDateTime\", \n \"stringValue\": \"2012-12-21T18:00:00\"}\n ]\n },\n {\"id\": \"SayHello\",\n \"name\": \"SayHello\",\n \"fields\": \n [\n {\"key\": \"type\", \n \"stringValue\": \"ShellCommandActivity\"},\n {\"key\": \"command\", \n \"stringValue\": \"echo hello\"},\n {\"key\": \"parent\", \n \"refValue\": \"Default\"},\n {\"key\": \"schedule\", \n \"refValue\": \"Schedule\"}\n ]\n }\n ]\n}\n \n </request>\n <response>\n \nHTTP/1.1 200 \nx-amzn-RequestId: f74afc14-0754-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 18\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"errored\": false}\n\n \n </response>\n </example>\n <example>\n <name>Example 2</name>\n <description>\n This example sets an invalid pipeline configuration (the value for <code>workerGroup</code> is an empty string) and returns an error message.\n </description>\n <request>\n \nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.PutPipelineDefinition\nContent-Length: 903\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\",\n \"pipelineObjects\": \n [\n {\"id\": \"Default\",\n \"name\": \"Default\",\n \"fields\": \n [\n {\"key\": \"workerGroup\", \n \"stringValue\": \"\"}\n ]\n }, \n {\"id\": \"Schedule\",\n \"name\": \"Schedule\",\n \"fields\": \n [\n {\"key\": \"startDateTime\", \n \"stringValue\": \"2012-09-25T17:00:00\"}, \n {\"key\": \"type\", \n \"stringValue\": \"Schedule\"}, \n {\"key\": \"period\", \n \"stringValue\": \"1 hour\"}, \n {\"key\": \"endDateTime\", \n \"stringValue\": \"2012-09-25T18:00:00\"}\n ]\n },\n {\"id\": \"SayHello\",\n \"name\": \"SayHello\",\n \"fields\": \n [\n {\"key\": \"type\", \n \"stringValue\": \"ShellCommandActivity\"},\n {\"key\": \"command\", \n \"stringValue\": \"echo hello\"},\n {\"key\": \"parent\", \n \"refValue\": \"Default\"},\n {\"key\": \"schedule\", \n \"refValue\": \"Schedule\"}\n \n ]\n }\n ]\n}\n \n </request>\n <response>\n \nHTTP/1.1 200 \nx-amzn-RequestId: f74afc14-0754-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 18\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"__type\": \"com.amazon.setl.webservice#InvalidRequestException\", \n \"message\": \"Pipeline definition has errors: Could not save the pipeline definition due to FATAL errors: [com.amazon.setl.webservice.ValidationError@108d7ea9] Please call Validate to validate your pipeline\"}\n\n \n </response>\n </example>\n </examples>\n "
|
1355
|
+
},
|
1356
|
+
"QueryObjects": {
|
1357
|
+
"name": "QueryObjects",
|
1358
|
+
"input": {
|
1359
|
+
"shape_name": "QueryObjectsInput",
|
1360
|
+
"type": "structure",
|
1361
|
+
"members": {
|
1362
|
+
"pipelineId": {
|
1363
|
+
"shape_name": "id",
|
1364
|
+
"type": "string",
|
1365
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1366
|
+
"min_length": 1,
|
1367
|
+
"max_length": 1024,
|
1368
|
+
"documentation": "\n <p>Identifier of the pipeline to be queried for object names.</p>\n ",
|
1369
|
+
"required": true
|
1370
|
+
},
|
1371
|
+
"query": {
|
1372
|
+
"shape_name": "Query",
|
1373
|
+
"type": "structure",
|
1374
|
+
"members": {
|
1375
|
+
"selectors": {
|
1376
|
+
"shape_name": "SelectorList",
|
1377
|
+
"type": "list",
|
1378
|
+
"members": {
|
1379
|
+
"shape_name": "Selector",
|
1380
|
+
"type": "structure",
|
1381
|
+
"members": {
|
1382
|
+
"fieldName": {
|
1383
|
+
"shape_name": "string",
|
1384
|
+
"type": "string",
|
1385
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1386
|
+
"min_length": 0,
|
1387
|
+
"max_length": 1024,
|
1388
|
+
"documentation": "\n <p>The name of the field that the operator will be applied to. The field name is the \"key\" portion of the field definition in the pipeline definition syntax that is used by the AWS Data Pipeline API. If the field is not set on the object, the condition fails.</p>\n "
|
1389
|
+
},
|
1390
|
+
"operator": {
|
1391
|
+
"shape_name": "Operator",
|
1392
|
+
"type": "structure",
|
1393
|
+
"members": {
|
1394
|
+
"type": {
|
1395
|
+
"shape_name": "OperatorType",
|
1396
|
+
"type": "string",
|
1397
|
+
"enum": [
|
1398
|
+
"EQ",
|
1399
|
+
"REF_EQ",
|
1400
|
+
"LE",
|
1401
|
+
"GE",
|
1402
|
+
"BETWEEN"
|
1403
|
+
],
|
1404
|
+
"documentation": " \n <p>\n The logical operation to be performed: equal (<code>EQ</code>), equal reference (<code>REF_EQ</code>), less than or equal (<code>LE</code>), greater than or equal (<code>GE</code>), or between (<code>BETWEEN</code>). Equal reference (<code>REF_EQ</code>) can be used only with reference fields. The other comparison types can be used only with String fields. The comparison types you can use apply only to certain object fields, as detailed below. \n </p>\n <p>\n The comparison operators EQ and REF_EQ act on the following fields:\n </p>\n <ul>\n <li>name</li>\n <li>@sphere</li>\n <li>parent</li>\n <li>@componentParent</li>\n <li>@instanceParent</li>\n <li>@status</li>\n <li>@scheduledStartTime</li>\n <li>@scheduledEndTime</li>\n <li>@actualStartTime</li>\n <li>@actualEndTime</li>\n </ul>\n \n <p>\n The comparison operators <code>GE</code>, <code>LE</code>, and <code>BETWEEN</code> act on the following fields:\n </p>\n <ul>\n <li>@scheduledStartTime</li>\n <li>@scheduledEndTime</li>\n <li>@actualStartTime</li>\n <li>@actualEndTime</li>\n </ul>\n <p>Note that fields beginning with the at sign (@) are read-only and set by the web service. When you name fields, you should choose names containing only alpha-numeric values, as symbols may be reserved by AWS Data Pipeline. User-defined fields that you add to a pipeline should prefix their name with the string \"my\".</p>\n "
|
1405
|
+
},
|
1406
|
+
"values": {
|
1407
|
+
"shape_name": "stringList",
|
1408
|
+
"type": "list",
|
1409
|
+
"members": {
|
1410
|
+
"shape_name": "string",
|
1411
|
+
"type": "string",
|
1412
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1413
|
+
"min_length": 0,
|
1414
|
+
"max_length": 1024,
|
1415
|
+
"documentation": null
|
1416
|
+
},
|
1417
|
+
"documentation": " \n <p>The value that the actual field value will be compared with.</p>\n "
|
1418
|
+
}
|
1419
|
+
},
|
1420
|
+
"documentation": " \n <p>Contains a logical operation for comparing the value of a field with a specified value.</p> \n "
|
1421
|
+
}
|
1422
|
+
},
|
1423
|
+
"documentation": "\n <p>A comparision that is used to determine whether a query should return this object.</p> \n "
|
1424
|
+
},
|
1425
|
+
"documentation": "\n <p>List of selectors that define the query. An object must satisfy all of the selectors to match the query.</p>\n "
|
1426
|
+
}
|
1427
|
+
},
|
1428
|
+
"documentation": "\n <p>\n Query that defines the objects to be returned. The <a>Query</a> object can contain a maximum of ten selectors. \n The conditions in the query are limited to top-level String fields in the object. \n These filters can be applied to components, instances, and attempts. \n </p>\n "
|
1429
|
+
},
|
1430
|
+
"sphere": {
|
1431
|
+
"shape_name": "string",
|
1432
|
+
"type": "string",
|
1433
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1434
|
+
"min_length": 0,
|
1435
|
+
"max_length": 1024,
|
1436
|
+
"documentation": "\n <p>\n Specifies whether the query applies to components or instances.\t\n Allowable values: <code>COMPONENT</code>, <code>INSTANCE</code>, <code>ATTEMPT</code>.\n </p>\n ",
|
1437
|
+
"required": true
|
1438
|
+
},
|
1439
|
+
"marker": {
|
1440
|
+
"shape_name": "string",
|
1441
|
+
"type": "string",
|
1442
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1443
|
+
"min_length": 0,
|
1444
|
+
"max_length": 1024,
|
1445
|
+
"documentation": "\n <p>\n The starting point for the results to be returned. The first time you call <a>QueryObjects</a>, this value should be empty. As long as the action returns <code>HasMoreResults</code> as <code>True</code>, you can call <a>QueryObjects</a> again and pass the marker value from the response to retrieve the next set of results.\n </p>\n "
|
1446
|
+
},
|
1447
|
+
"limit": {
|
1448
|
+
"shape_name": "int",
|
1449
|
+
"type": "integer",
|
1450
|
+
"documentation": "\n <p>Specifies the maximum number of object names that <a>QueryObjects</a> will return in a single call. The default value is 100. </p>\n "
|
1451
|
+
}
|
1452
|
+
},
|
1453
|
+
"documentation": "\n <p>The input for the <a>QueryObjects</a> action.</p>\n "
|
1454
|
+
},
|
1455
|
+
"output": {
|
1456
|
+
"shape_name": "QueryObjectsOutput",
|
1457
|
+
"type": "structure",
|
1458
|
+
"members": {
|
1459
|
+
"ids": {
|
1460
|
+
"shape_name": "idList",
|
1461
|
+
"type": "list",
|
1462
|
+
"members": {
|
1463
|
+
"shape_name": "id",
|
1464
|
+
"type": "string",
|
1465
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1466
|
+
"min_length": 1,
|
1467
|
+
"max_length": 1024,
|
1468
|
+
"documentation": null
|
1469
|
+
},
|
1470
|
+
"documentation": "\n <p>A list of identifiers that match the query selectors.</p>\n "
|
1471
|
+
},
|
1472
|
+
"marker": {
|
1473
|
+
"shape_name": "string",
|
1474
|
+
"type": "string",
|
1475
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1476
|
+
"min_length": 0,
|
1477
|
+
"max_length": 1024,
|
1478
|
+
"documentation": "\n <p>\n The starting point for the results to be returned. As long as the action returns <code>HasMoreResults</code> as <code>True</code>, you can call <a>QueryObjects</a> again and pass the marker value from the response to retrieve the next set of results.\n </p>\n "
|
1479
|
+
},
|
1480
|
+
"hasMoreResults": {
|
1481
|
+
"shape_name": "boolean",
|
1482
|
+
"type": "boolean",
|
1483
|
+
"documentation": "\n <p>If <code>True</code>, there are more results that can be obtained by a subsequent call to <a>QueryObjects</a>.</p>\n "
|
1484
|
+
}
|
1485
|
+
},
|
1486
|
+
"documentation": "\n <p>Contains the output from the <a>QueryObjects</a> action.</p>\n "
|
1487
|
+
},
|
1488
|
+
"errors": [
|
1489
|
+
{
|
1490
|
+
"shape_name": "PipelineNotFoundException",
|
1491
|
+
"type": "structure",
|
1492
|
+
"members": {
|
1493
|
+
"message": {
|
1494
|
+
"shape_name": "errorMessage",
|
1495
|
+
"type": "string",
|
1496
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
1497
|
+
}
|
1498
|
+
},
|
1499
|
+
"documentation": "\n <p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>\n "
|
1500
|
+
},
|
1501
|
+
{
|
1502
|
+
"shape_name": "PipelineDeletedException",
|
1503
|
+
"type": "structure",
|
1504
|
+
"members": {
|
1505
|
+
"message": {
|
1506
|
+
"shape_name": "errorMessage",
|
1507
|
+
"type": "string",
|
1508
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
1509
|
+
}
|
1510
|
+
},
|
1511
|
+
"documentation": "\n <p>The specified pipeline has been deleted.</p>\n "
|
1512
|
+
},
|
1513
|
+
{
|
1514
|
+
"shape_name": "InternalServiceError",
|
1515
|
+
"type": "structure",
|
1516
|
+
"members": {
|
1517
|
+
"message": {
|
1518
|
+
"shape_name": "errorMessage",
|
1519
|
+
"type": "string",
|
1520
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
1521
|
+
}
|
1522
|
+
},
|
1523
|
+
"documentation": "\n <p>An internal service error occurred.</p>\n "
|
1524
|
+
},
|
1525
|
+
{
|
1526
|
+
"shape_name": "InvalidRequestException",
|
1527
|
+
"type": "structure",
|
1528
|
+
"members": {
|
1529
|
+
"message": {
|
1530
|
+
"shape_name": "errorMessage",
|
1531
|
+
"type": "string",
|
1532
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
1533
|
+
}
|
1534
|
+
},
|
1535
|
+
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
|
1536
|
+
}
|
1537
|
+
],
|
1538
|
+
"documentation": "\n <p>Queries a pipeline for the names of objects that match a specified set of conditions.</p>\n \n <p>The objects returned by <a>QueryObjects</a> are paginated and then filtered by the value you set for query. This means the action may return an empty result set with a value set for marker. If <code>HasMoreResults</code> is set to <code>True</code>, you should continue to call <a>QueryObjects</a>, passing in the returned value for marker, until <code>HasMoreResults</code> returns <code>False</code>.</p>\n\n <examples>\n <request>\n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.QueryObjects\nContent-Length: 123\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\",\n \"query\": \n {\"selectors\": \n [\n ]\n },\n \"sphere\": \"PO\",\n \"marker\": \"\",\n \"limit\": 10}\n\n </request>\n \n \n <response>\n\nx-amzn-RequestId: 14d704c1-0775-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 72\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"hasMoreResults\": false, \n \"ids\": \n [\"@SayHello_1_2012-09-25T17:00:00\"]\n}\n </response>\n </examples>\n \n "
|
1539
|
+
},
|
1540
|
+
"ReportTaskProgress": {
|
1541
|
+
"name": "ReportTaskProgress",
|
1542
|
+
"input": {
|
1543
|
+
"shape_name": "ReportTaskProgressInput",
|
1544
|
+
"type": "structure",
|
1545
|
+
"members": {
|
1546
|
+
"taskId": {
|
1547
|
+
"shape_name": "taskId",
|
1548
|
+
"type": "string",
|
1549
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1550
|
+
"min_length": 1,
|
1551
|
+
"max_length": 2048,
|
1552
|
+
"documentation": "\n <p>Identifier of the task assigned to the task runner. This value is provided in the <a>TaskObject</a> that the service returns with the response for the <a>PollForTask</a> action.</p>\n ",
|
1553
|
+
"required": true
|
1554
|
+
}
|
1555
|
+
},
|
1556
|
+
"documentation": "\n <p>The input for the ReportTaskProgress action.</p>\n "
|
1557
|
+
},
|
1558
|
+
"output": {
|
1559
|
+
"shape_name": "ReportTaskProgressOutput",
|
1560
|
+
"type": "structure",
|
1561
|
+
"members": {
|
1562
|
+
"canceled": {
|
1563
|
+
"shape_name": "boolean",
|
1564
|
+
"type": "boolean",
|
1565
|
+
"documentation": "\n <p>If <code>True</code>, the calling task runner should cancel processing of the task. The task runner does not need to call <a>SetTaskStatus</a> for canceled tasks.</p>\n ",
|
1566
|
+
"required": true
|
1567
|
+
}
|
1568
|
+
},
|
1569
|
+
"documentation": "\n <p>Contains the output from the ReportTaskProgress action.</p>\n "
|
1570
|
+
},
|
1571
|
+
"errors": [
|
1572
|
+
{
|
1573
|
+
"shape_name": "InternalServiceError",
|
1574
|
+
"type": "structure",
|
1575
|
+
"members": {
|
1576
|
+
"message": {
|
1577
|
+
"shape_name": "errorMessage",
|
1578
|
+
"type": "string",
|
1579
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
1580
|
+
}
|
1581
|
+
},
|
1582
|
+
"documentation": "\n <p>An internal service error occurred.</p>\n "
|
1583
|
+
},
|
1584
|
+
{
|
1585
|
+
"shape_name": "InvalidRequestException",
|
1586
|
+
"type": "structure",
|
1587
|
+
"members": {
|
1588
|
+
"message": {
|
1589
|
+
"shape_name": "errorMessage",
|
1590
|
+
"type": "string",
|
1591
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
1592
|
+
}
|
1593
|
+
},
|
1594
|
+
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
|
1595
|
+
},
|
1596
|
+
{
|
1597
|
+
"shape_name": "TaskNotFoundException",
|
1598
|
+
"type": "structure",
|
1599
|
+
"members": {
|
1600
|
+
"message": {
|
1601
|
+
"shape_name": "errorMessage",
|
1602
|
+
"type": "string",
|
1603
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
1604
|
+
}
|
1605
|
+
},
|
1606
|
+
"documentation": "\n <p>The specified task was not found. </p>\n "
|
1607
|
+
},
|
1608
|
+
{
|
1609
|
+
"shape_name": "PipelineNotFoundException",
|
1610
|
+
"type": "structure",
|
1611
|
+
"members": {
|
1612
|
+
"message": {
|
1613
|
+
"shape_name": "errorMessage",
|
1614
|
+
"type": "string",
|
1615
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
1616
|
+
}
|
1617
|
+
},
|
1618
|
+
"documentation": "\n <p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>\n "
|
1619
|
+
},
|
1620
|
+
{
|
1621
|
+
"shape_name": "PipelineDeletedException",
|
1622
|
+
"type": "structure",
|
1623
|
+
"members": {
|
1624
|
+
"message": {
|
1625
|
+
"shape_name": "errorMessage",
|
1626
|
+
"type": "string",
|
1627
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
1628
|
+
}
|
1629
|
+
},
|
1630
|
+
"documentation": "\n <p>The specified pipeline has been deleted.</p>\n "
|
1631
|
+
}
|
1632
|
+
],
|
1633
|
+
"documentation": "\n <p>\n Updates the AWS Data Pipeline service on the progress of the calling task runner. When the task runner is assigned a task, it should call ReportTaskProgress to acknowledge that it has the task within 2 minutes. If the web service does not recieve this acknowledgement within the 2 minute window, it will assign the task in a subsequent <a>PollForTask</a> call. After this initial acknowledgement, the task runner only needs to report progress every 15 minutes to maintain its ownership of the task. You can change this reporting time from 15 minutes by specifying a <code>reportProgressTimeout</code> field in your pipeline.\n \n \n \n If a task runner does not report its status after 5 minutes, AWS Data Pipeline will assume that the task runner is unable to process the task and will reassign the task in a subsequent response to <a>PollForTask</a>. task runners should call <a>ReportTaskProgress</a> every 60 seconds.\n </p>\n \n <examples>\n <request>\n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.ReportTaskProgress\nContent-Length: 832\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"taskId\": \"aaGgHT4LuH0T0Y0oLrJRjas5qH0d8cDPADxqq3tn+zCWGELkCdV2JprLreXm1oxeP5EFZHFLJ69kjSsLYE0iYHYBYVGBrB+E/pYq7ANEEeGJFnSBMRiXZVA+8UJ3OzcInvXeinqBmBaKwii7hnnKb/AXjXiNTXyxgydX1KAyg1AxkwBYG4cfPYMZbuEbQJFJvv5C/2+GVXz1w94nKYTeUeepwUOFOuRLS6JVtZoYwpF56E+Yfk1IcGpFOvCZ01B4Bkuu7x3J+MD/j6kJgZLAgbCJQtI3eiW3kdGmX0p0I2BdY1ZsX6b4UiSvM3OMj6NEHJCJL4E0ZfitnhCoe24Kvjo6C2hFbZq+ei/HPgSXBQMSagkr4vS9c0ChzxH2+LNYvec6bY4kymkaZI1dvOzmpa0FcnGf5AjSK4GpsViZ/ujz6zxFv81qBXzjF0/4M1775rjV1VUdyKaixiA/sJiACNezqZqETidp8d24BDPRhGsj6pBCrnelqGFrk/gXEXUsJ+xwMifRC8UVwiKekpAvHUywVk7Ku4jH/n3i2VoLRP6FXwpUbelu34iiZ9czpXyLtyPKwxa87dlrnRVURwkcVjOt2Mcrcaqe+cbWHvNRhyrPkkdfSF3ac8/wfgVbXvLEB2k9mKc67aD9rvdc1PKX09Tk8BKklsMTpZ3TRCd4NzQlJKigMe8Jat9+1tKj4Ole5ZzW6uyTu2s2iFjEV8KXu4MaiRJyNKCdKeGhhZWY37Qk4NBK4Ppgu+C6Y41dpfOh288SLDEVx0/UySlqOEdhba7c6BiPp5r3hKj3mk9lFy5OYp1aoGLeeFmjXveTnPdf2gkWqXXg7AUbJ7jEs1F0lKZQg4szep2gcKyAJXgvXLfJJHcha8Lfb/Ee7wYmyOcAaRpDBoFNSbtoVXar46teIrpho+ZDvynUXvU0grHWGOk=:wn3SgymHZM99bEXAMPLE\",\n \"fields\": \n [\n {\"key\": \"percentComplete\",\n \"stringValue\": \"50\"}\n ]\n}\n\n </request>\n \n <response>\n\nx-amzn-RequestId: 640bd023-0775-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 18\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"canceled\": false}\n \n</response>\n </examples>\n \n "
|
1634
|
+
},
|
1635
|
+
"ReportTaskRunnerHeartbeat": {
|
1636
|
+
"name": "ReportTaskRunnerHeartbeat",
|
1637
|
+
"input": {
|
1638
|
+
"shape_name": "ReportTaskRunnerHeartbeatInput",
|
1639
|
+
"type": "structure",
|
1640
|
+
"members": {
|
1641
|
+
"taskrunnerId": {
|
1642
|
+
"shape_name": "id",
|
1643
|
+
"type": "string",
|
1644
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1645
|
+
"min_length": 1,
|
1646
|
+
"max_length": 1024,
|
1647
|
+
"documentation": "\n <p>The identifier of the task runner. This value should be unique across your AWS account. In the case of AWS Data Pipeline Task Runner launched on a resource managed by AWS Data Pipeline, the web service provides a unique identifier when it launches the application. If you have written a custom task runner, you should assign a unique identifier for the task runner.</p>\n ",
|
1648
|
+
"required": true
|
1649
|
+
},
|
1650
|
+
"workerGroup": {
|
1651
|
+
"shape_name": "string",
|
1652
|
+
"type": "string",
|
1653
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1654
|
+
"min_length": 0,
|
1655
|
+
"max_length": 1024,
|
1656
|
+
"documentation": "\n <p>Indicates the type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for <code>workerGroup</code> in the call to <a>ReportTaskRunnerHeartbeat</a>. There are no wildcard values permitted in <code>workerGroup</code>, the string must be an exact, case-sensitive, match.</p>\n "
|
1657
|
+
},
|
1658
|
+
"hostname": {
|
1659
|
+
"shape_name": "id",
|
1660
|
+
"type": "string",
|
1661
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1662
|
+
"min_length": 1,
|
1663
|
+
"max_length": 1024,
|
1664
|
+
"documentation": "\n <p>The public DNS name of the calling task runner.</p>\n "
|
1665
|
+
}
|
1666
|
+
},
|
1667
|
+
"documentation": "\n <p>The input for the ReportTaskRunnerHeartbeat action.</p>\n "
|
1668
|
+
},
|
1669
|
+
"output": {
|
1670
|
+
"shape_name": "ReportTaskRunnerHeartbeatOutput",
|
1671
|
+
"type": "structure",
|
1672
|
+
"members": {
|
1673
|
+
"terminate": {
|
1674
|
+
"shape_name": "boolean",
|
1675
|
+
"type": "boolean",
|
1676
|
+
"documentation": "\n <p>Indicates whether the calling task runner should terminate. If <code>True</code>, the task runner that called <a>ReportTaskRunnerHeartbeat</a> should terminate. </p>\n ",
|
1677
|
+
"required": true
|
1678
|
+
}
|
1679
|
+
},
|
1680
|
+
"documentation": "\n <p>Contains the output from the <a>ReportTaskRunnerHeartbeat</a> action.</p>\n "
|
1681
|
+
},
|
1682
|
+
"errors": [
|
1683
|
+
{
|
1684
|
+
"shape_name": "InternalServiceError",
|
1685
|
+
"type": "structure",
|
1686
|
+
"members": {
|
1687
|
+
"message": {
|
1688
|
+
"shape_name": "errorMessage",
|
1689
|
+
"type": "string",
|
1690
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
1691
|
+
}
|
1692
|
+
},
|
1693
|
+
"documentation": "\n <p>An internal service error occurred.</p>\n "
|
1694
|
+
},
|
1695
|
+
{
|
1696
|
+
"shape_name": "InvalidRequestException",
|
1697
|
+
"type": "structure",
|
1698
|
+
"members": {
|
1699
|
+
"message": {
|
1700
|
+
"shape_name": "errorMessage",
|
1701
|
+
"type": "string",
|
1702
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
1703
|
+
}
|
1704
|
+
},
|
1705
|
+
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
|
1706
|
+
}
|
1707
|
+
],
|
1708
|
+
"documentation": "\n <p>Task runners call <a>ReportTaskRunnerHeartbeat</a> every 15 minutes to indicate that they are operational. In the case of AWS Data Pipeline Task Runner launched on a resource managed by AWS Data Pipeline, the web service can use this call to detect when the task runner application has failed and restart a new instance.</p>\n \n <examples>\n <request> \n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.ReportTaskRunnerHeartbeat\nContent-Length: 84\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"taskrunnerId\": \"1234567890\",\n \"workerGroup\": \"wg-12345\",\n \"hostname\": \"example.com\"}\n\n </request>\n \n <response>\n\nStatus:\nx-amzn-RequestId: b3104dc5-0734-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 20\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"terminate\": false}\n \n </response>\n </examples>\n "
|
1709
|
+
},
|
1710
|
+
"SetStatus": {
|
1711
|
+
"name": "SetStatus",
|
1712
|
+
"input": {
|
1713
|
+
"shape_name": "SetStatusInput",
|
1714
|
+
"type": "structure",
|
1715
|
+
"members": {
|
1716
|
+
"pipelineId": {
|
1717
|
+
"shape_name": "id",
|
1718
|
+
"type": "string",
|
1719
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1720
|
+
"min_length": 1,
|
1721
|
+
"max_length": 1024,
|
1722
|
+
"documentation": "\n <p>Identifies the pipeline that contains the objects.</p>\n ",
|
1723
|
+
"required": true
|
1724
|
+
},
|
1725
|
+
"objectIds": {
|
1726
|
+
"shape_name": "idList",
|
1727
|
+
"type": "list",
|
1728
|
+
"members": {
|
1729
|
+
"shape_name": "id",
|
1730
|
+
"type": "string",
|
1731
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1732
|
+
"min_length": 1,
|
1733
|
+
"max_length": 1024,
|
1734
|
+
"documentation": null
|
1735
|
+
},
|
1736
|
+
"documentation": "\n <p>Identifies an array of objects. The corresponding objects can be either physical or components, but not a mix of both types.</p>\n ",
|
1737
|
+
"required": true
|
1738
|
+
},
|
1739
|
+
"status": {
|
1740
|
+
"shape_name": "string",
|
1741
|
+
"type": "string",
|
1742
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1743
|
+
"min_length": 0,
|
1744
|
+
"max_length": 1024,
|
1745
|
+
"documentation": "\n <p>Specifies the status to be set on all the objects in <code>objectIds</code>. For components, this can be either <code>PAUSE</code> or <code>RESUME</code>. For instances, this can be either <code>CANCEL</code>, <code>RERUN</code>, or <code>MARK_FINISHED</code>.</p>\n ",
|
1746
|
+
"required": true
|
1747
|
+
}
|
1748
|
+
},
|
1749
|
+
"documentation": "\n <p>The input to the <a>SetStatus</a> action.</p>\n "
|
1750
|
+
},
|
1751
|
+
"output": null,
|
1752
|
+
"errors": [
|
1753
|
+
{
|
1754
|
+
"shape_name": "PipelineNotFoundException",
|
1755
|
+
"type": "structure",
|
1756
|
+
"members": {
|
1757
|
+
"message": {
|
1758
|
+
"shape_name": "errorMessage",
|
1759
|
+
"type": "string",
|
1760
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
1761
|
+
}
|
1762
|
+
},
|
1763
|
+
"documentation": "\n <p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>\n "
|
1764
|
+
},
|
1765
|
+
{
|
1766
|
+
"shape_name": "PipelineDeletedException",
|
1767
|
+
"type": "structure",
|
1768
|
+
"members": {
|
1769
|
+
"message": {
|
1770
|
+
"shape_name": "errorMessage",
|
1771
|
+
"type": "string",
|
1772
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
1773
|
+
}
|
1774
|
+
},
|
1775
|
+
"documentation": "\n <p>The specified pipeline has been deleted.</p>\n "
|
1776
|
+
},
|
1777
|
+
{
|
1778
|
+
"shape_name": "InternalServiceError",
|
1779
|
+
"type": "structure",
|
1780
|
+
"members": {
|
1781
|
+
"message": {
|
1782
|
+
"shape_name": "errorMessage",
|
1783
|
+
"type": "string",
|
1784
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
1785
|
+
}
|
1786
|
+
},
|
1787
|
+
"documentation": "\n <p>An internal service error occurred.</p>\n "
|
1788
|
+
},
|
1789
|
+
{
|
1790
|
+
"shape_name": "InvalidRequestException",
|
1791
|
+
"type": "structure",
|
1792
|
+
"members": {
|
1793
|
+
"message": {
|
1794
|
+
"shape_name": "errorMessage",
|
1795
|
+
"type": "string",
|
1796
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
1797
|
+
}
|
1798
|
+
},
|
1799
|
+
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
|
1800
|
+
}
|
1801
|
+
],
|
1802
|
+
"documentation": "\n <p>Requests that the status of an array of physical or logical pipeline objects be updated in the pipeline. This update may not occur immediately, but is eventually consistent. The status that can be set depends on the type of object.</p>\n \n <examples>\n <request>\n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.SetStatus\nContent-Length: 100\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-0634701J7KEXAMPLE\", \n \"objectIds\": \n [\"o-08600941GHJWMBR9E2\"], \n \"status\": \"pause\"}\n\n </request>\n \n <response>\n\nx-amzn-RequestId: e83b8ab7-076a-11e2-af6f-6bc7a6be60d9\nContent-Type: application/x-amz-json-1.1\nContent-Length: 0\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\nUnexpected response: 200, OK, undefined\n \n </response>\n </examples>\n \n "
|
1803
|
+
},
|
1804
|
+
"SetTaskStatus": {
|
1805
|
+
"name": "SetTaskStatus",
|
1806
|
+
"input": {
|
1807
|
+
"shape_name": "SetTaskStatusInput",
|
1808
|
+
"type": "structure",
|
1809
|
+
"members": {
|
1810
|
+
"taskId": {
|
1811
|
+
"shape_name": "taskId",
|
1812
|
+
"type": "string",
|
1813
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1814
|
+
"min_length": 1,
|
1815
|
+
"max_length": 2048,
|
1816
|
+
"documentation": "\n <p>Identifies the task assigned to the task runner. This value is set in the <a>TaskObject</a> that is returned by the <a>PollForTask</a> action.</p>\n ",
|
1817
|
+
"required": true
|
1818
|
+
},
|
1819
|
+
"taskStatus": {
|
1820
|
+
"shape_name": "TaskStatus",
|
1821
|
+
"type": "string",
|
1822
|
+
"enum": [
|
1823
|
+
"FINISHED",
|
1824
|
+
"FAILED",
|
1825
|
+
"FALSE"
|
1826
|
+
],
|
1827
|
+
"documentation": "\n <p>If <code>FINISHED</code>, the task successfully completed. If <code>FAILED</code> the task ended unsuccessfully. The <code>FALSE</code> value is used by preconditions.</p>\n ",
|
1828
|
+
"required": true
|
1829
|
+
},
|
1830
|
+
"errorId": {
|
1831
|
+
"shape_name": "string",
|
1832
|
+
"type": "string",
|
1833
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1834
|
+
"min_length": 0,
|
1835
|
+
"max_length": 1024,
|
1836
|
+
"documentation": "\n <p>If an error occurred during the task, this value specifies an id value that represents the error. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string \"Service_\" which is reserved by the system.</p>\n "
|
1837
|
+
},
|
1838
|
+
"errorMessage": {
|
1839
|
+
"shape_name": "errorMessage",
|
1840
|
+
"type": "string",
|
1841
|
+
"documentation": "\n <p>If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.</p>\n "
|
1842
|
+
},
|
1843
|
+
"errorStackTrace": {
|
1844
|
+
"shape_name": "string",
|
1845
|
+
"type": "string",
|
1846
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1847
|
+
"min_length": 0,
|
1848
|
+
"max_length": 1024,
|
1849
|
+
"documentation": "\n <p>If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.</p>\n "
|
1850
|
+
}
|
1851
|
+
},
|
1852
|
+
"documentation": "\n <p>The input of the SetTaskStatus action.</p>\n "
|
1853
|
+
},
|
1854
|
+
"output": {
|
1855
|
+
"shape_name": "SetTaskStatusOutput",
|
1856
|
+
"type": "structure",
|
1857
|
+
"members": {
|
1858
|
+
},
|
1859
|
+
"documentation": "\n <p>The output from the <a>SetTaskStatus</a> action.</p>\n "
|
1860
|
+
},
|
1861
|
+
"errors": [
|
1862
|
+
{
|
1863
|
+
"shape_name": "InternalServiceError",
|
1864
|
+
"type": "structure",
|
1865
|
+
"members": {
|
1866
|
+
"message": {
|
1867
|
+
"shape_name": "errorMessage",
|
1868
|
+
"type": "string",
|
1869
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
1870
|
+
}
|
1871
|
+
},
|
1872
|
+
"documentation": "\n <p>An internal service error occurred.</p>\n "
|
1873
|
+
},
|
1874
|
+
{
|
1875
|
+
"shape_name": "TaskNotFoundException",
|
1876
|
+
"type": "structure",
|
1877
|
+
"members": {
|
1878
|
+
"message": {
|
1879
|
+
"shape_name": "errorMessage",
|
1880
|
+
"type": "string",
|
1881
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
1882
|
+
}
|
1883
|
+
},
|
1884
|
+
"documentation": "\n <p>The specified task was not found. </p>\n "
|
1885
|
+
},
|
1886
|
+
{
|
1887
|
+
"shape_name": "InvalidRequestException",
|
1888
|
+
"type": "structure",
|
1889
|
+
"members": {
|
1890
|
+
"message": {
|
1891
|
+
"shape_name": "errorMessage",
|
1892
|
+
"type": "string",
|
1893
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
1894
|
+
}
|
1895
|
+
},
|
1896
|
+
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
|
1897
|
+
},
|
1898
|
+
{
|
1899
|
+
"shape_name": "PipelineNotFoundException",
|
1900
|
+
"type": "structure",
|
1901
|
+
"members": {
|
1902
|
+
"message": {
|
1903
|
+
"shape_name": "errorMessage",
|
1904
|
+
"type": "string",
|
1905
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
1906
|
+
}
|
1907
|
+
},
|
1908
|
+
"documentation": "\n <p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>\n "
|
1909
|
+
},
|
1910
|
+
{
|
1911
|
+
"shape_name": "PipelineDeletedException",
|
1912
|
+
"type": "structure",
|
1913
|
+
"members": {
|
1914
|
+
"message": {
|
1915
|
+
"shape_name": "errorMessage",
|
1916
|
+
"type": "string",
|
1917
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
1918
|
+
}
|
1919
|
+
},
|
1920
|
+
"documentation": "\n <p>The specified pipeline has been deleted.</p>\n "
|
1921
|
+
}
|
1922
|
+
],
|
1923
|
+
"documentation": "\n <p>\n Notifies AWS Data Pipeline that a task is completed and provides information about the final status. The task runner calls this action regardless of whether the task was sucessful. The task runner does not need to call <a>SetTaskStatus</a> for tasks that are canceled by the web service during a call to <a>ReportTaskProgress</a>.\n </p>\n \n <examples>\n <request>\n\nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.SetTaskStatus\nContent-Length: 847\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"taskId\": \"aaGgHT4LuH0T0Y0oLrJRjas5qH0d8cDPADxqq3tn+zCWGELkCdV2JprLreXm1oxeP5EFZHFLJ69kjSsLYE0iYHYBYVGBrB+E/pYq7ANEEeGJFnSBMRiXZVA+8UJ3OzcInvXeinqBmBaKwii7hnnKb/AXjXiNTXyxgydX1KAyg1AxkwBYG4cfPYMZbuEbQJFJvv5C/2+GVXz1w94nKYTeUeepwUOFOuRLS6JVtZoYwpF56E+Yfk1IcGpFOvCZ01B4Bkuu7x3J+MD/j6kJgZLAgbCJQtI3eiW3kdGmX0p0I2BdY1ZsX6b4UiSvM3OMj6NEHJCJL4E0ZfitnhCoe24Kvjo6C2hFbZq+ei/HPgSXBQMSagkr4vS9c0ChzxH2+LNYvec6bY4kymkaZI1dvOzmpa0FcnGf5AjSK4GpsViZ/ujz6zxFv81qBXzjF0/4M1775rjV1VUdyKaixiA/sJiACNezqZqETidp8d24BDPRhGsj6pBCrnelqGFrk/gXEXUsJ+xwMifRC8UVwiKekpAvHUywVk7Ku4jH/n3i2VoLRP6FXwpUbelu34iiZ9czpXyLtyPKwxa87dlrnRVURwkcVjOt2Mcrcaqe+cbWHvNRhyrPkkdfSF3ac8/wfgVbXvLEB2k9mKc67aD9rvdc1PKX09Tk8BKklsMTpZ3TRCd4NzQlJKigMe8Jat9+1tKj4Ole5ZzW6uyTu2s2iFjEV8KXu4MaiRJyNKCdKeGhhZWY37Qk4NBK4Ppgu+C6Y41dpfOh288SLDEVx0/UySlqOEdhba7c6BiPp5r3hKj3mk9lFy5OYp1aoGLeeFmjXveTnPdf2gkWqXXg7AUbJ7jEs1F0lKZQg4szep2gcKyAJXgvXLfJJHcha8Lfb/Ee7wYmyOcAaRpDBoFNSbtoVXar46teIrpho+ZDvynUXvU0grHWGOk=:wn3SgymHZM99bEXAMPLE\",\n \"taskStatus\": \"FINISHED\"}\n \n </request>\n \n <response>\n\nx-amzn-RequestId: 8c8deb53-0788-11e2-af9c-6bc7a6be6qr8 \nContent-Type: application/x-amz-json-1.1\nContent-Length: 0\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{}\n \n </response>\n </examples>\n \n "
|
1924
|
+
},
|
1925
|
+
"ValidatePipelineDefinition": {
|
1926
|
+
"name": "ValidatePipelineDefinition",
|
1927
|
+
"input": {
|
1928
|
+
"shape_name": "ValidatePipelineDefinitionInput",
|
1929
|
+
"type": "structure",
|
1930
|
+
"members": {
|
1931
|
+
"pipelineId": {
|
1932
|
+
"shape_name": "id",
|
1933
|
+
"type": "string",
|
1934
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1935
|
+
"min_length": 1,
|
1936
|
+
"max_length": 1024,
|
1937
|
+
"documentation": "\n <p>Identifies the pipeline whose definition is to be validated.</p>\n ",
|
1938
|
+
"required": true
|
1939
|
+
},
|
1940
|
+
"pipelineObjects": {
|
1941
|
+
"shape_name": "PipelineObjectList",
|
1942
|
+
"type": "list",
|
1943
|
+
"members": {
|
1944
|
+
"shape_name": "PipelineObject",
|
1945
|
+
"type": "structure",
|
1946
|
+
"members": {
|
1947
|
+
"id": {
|
1948
|
+
"shape_name": "id",
|
1949
|
+
"type": "string",
|
1950
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1951
|
+
"min_length": 1,
|
1952
|
+
"max_length": 1024,
|
1953
|
+
"documentation": "\n <p>Identifier of the object.</p>\n ",
|
1954
|
+
"required": true
|
1955
|
+
},
|
1956
|
+
"name": {
|
1957
|
+
"shape_name": "id",
|
1958
|
+
"type": "string",
|
1959
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1960
|
+
"min_length": 1,
|
1961
|
+
"max_length": 1024,
|
1962
|
+
"documentation": "\n <p>Name of the object.</p>\n ",
|
1963
|
+
"required": true
|
1964
|
+
},
|
1965
|
+
"fields": {
|
1966
|
+
"shape_name": "fieldList",
|
1967
|
+
"type": "list",
|
1968
|
+
"members": {
|
1969
|
+
"shape_name": "Field",
|
1970
|
+
"type": "structure",
|
1971
|
+
"members": {
|
1972
|
+
"key": {
|
1973
|
+
"shape_name": "fieldNameString",
|
1974
|
+
"type": "string",
|
1975
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1976
|
+
"min_length": 1,
|
1977
|
+
"max_length": 256,
|
1978
|
+
"documentation": "\n <p>The field identifier.</p>\n ",
|
1979
|
+
"required": true
|
1980
|
+
},
|
1981
|
+
"stringValue": {
|
1982
|
+
"shape_name": "fieldStringValue",
|
1983
|
+
"type": "string",
|
1984
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1985
|
+
"min_length": 0,
|
1986
|
+
"max_length": 10240,
|
1987
|
+
"documentation": "\n <p>The field value, expressed as a String.</p>\n "
|
1988
|
+
},
|
1989
|
+
"refValue": {
|
1990
|
+
"shape_name": "fieldNameString",
|
1991
|
+
"type": "string",
|
1992
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
1993
|
+
"min_length": 1,
|
1994
|
+
"max_length": 256,
|
1995
|
+
"documentation": "\n <p>The field value, expressed as the identifier of another object.</p>\n "
|
1996
|
+
}
|
1997
|
+
},
|
1998
|
+
"documentation": "\n <p>A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (<code>StringValue</code>) or a reference to another object (<code>RefValue</code>) but not as both.</p>\n "
|
1999
|
+
},
|
2000
|
+
"documentation": "\n <p>Key-value pairs that define the properties of the object.</p>\n ",
|
2001
|
+
"required": true
|
2002
|
+
}
|
2003
|
+
},
|
2004
|
+
"documentation": "\n <p>Contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.</p>\n "
|
2005
|
+
},
|
2006
|
+
"documentation": "\n <p>A list of objects that define the pipeline changes to validate against the pipeline.</p>\n ",
|
2007
|
+
"required": true
|
2008
|
+
}
|
2009
|
+
},
|
2010
|
+
"documentation": "\n <p>The input of the <a>ValidatePipelineDefinition</a> action.</p>\n "
|
2011
|
+
},
|
2012
|
+
"output": {
|
2013
|
+
"shape_name": "ValidatePipelineDefinitionOutput",
|
2014
|
+
"type": "structure",
|
2015
|
+
"members": {
|
2016
|
+
"validationErrors": {
|
2017
|
+
"shape_name": "ValidationErrors",
|
2018
|
+
"type": "list",
|
2019
|
+
"members": {
|
2020
|
+
"shape_name": "ValidationError",
|
2021
|
+
"type": "structure",
|
2022
|
+
"members": {
|
2023
|
+
"id": {
|
2024
|
+
"shape_name": "id",
|
2025
|
+
"type": "string",
|
2026
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
2027
|
+
"min_length": 1,
|
2028
|
+
"max_length": 1024,
|
2029
|
+
"documentation": "\n <p>The identifier of the object that contains the validation error.</p>\n "
|
2030
|
+
},
|
2031
|
+
"errors": {
|
2032
|
+
"shape_name": "validationMessages",
|
2033
|
+
"type": "list",
|
2034
|
+
"members": {
|
2035
|
+
"shape_name": "validationMessage",
|
2036
|
+
"type": "string",
|
2037
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
2038
|
+
"min_length": 0,
|
2039
|
+
"max_length": 10000,
|
2040
|
+
"documentation": null
|
2041
|
+
},
|
2042
|
+
"documentation": "\n <p>A description of the validation error.</p>\n "
|
2043
|
+
}
|
2044
|
+
},
|
2045
|
+
"documentation": "\n <p>Defines a validation error returned by <a>PutPipelineDefinition</a> or <a>ValidatePipelineDefinition</a>. Validation errors prevent pipeline activation. The set of validation errors that can be returned are defined by AWS Data Pipeline.</p>\n "
|
2046
|
+
},
|
2047
|
+
"documentation": "\n <p>Lists the validation errors that were found by <a>ValidatePipelineDefinition</a>.</p>\n "
|
2048
|
+
},
|
2049
|
+
"validationWarnings": {
|
2050
|
+
"shape_name": "ValidationWarnings",
|
2051
|
+
"type": "list",
|
2052
|
+
"members": {
|
2053
|
+
"shape_name": "ValidationWarning",
|
2054
|
+
"type": "structure",
|
2055
|
+
"members": {
|
2056
|
+
"id": {
|
2057
|
+
"shape_name": "id",
|
2058
|
+
"type": "string",
|
2059
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
2060
|
+
"min_length": 1,
|
2061
|
+
"max_length": 1024,
|
2062
|
+
"documentation": "\n <p>The identifier of the object that contains the validation warning.</p>\n "
|
2063
|
+
},
|
2064
|
+
"warnings": {
|
2065
|
+
"shape_name": "validationMessages",
|
2066
|
+
"type": "list",
|
2067
|
+
"members": {
|
2068
|
+
"shape_name": "validationMessage",
|
2069
|
+
"type": "string",
|
2070
|
+
"pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*",
|
2071
|
+
"min_length": 0,
|
2072
|
+
"max_length": 10000,
|
2073
|
+
"documentation": null
|
2074
|
+
},
|
2075
|
+
"documentation": "\n <p>A description of the validation warning.</p>\n "
|
2076
|
+
}
|
2077
|
+
},
|
2078
|
+
"documentation": "\n <p>Defines a validation warning returned by <a>PutPipelineDefinition</a> or <a>ValidatePipelineDefinition</a>. Validation warnings do not prevent pipeline activation. The set of validation warnings that can be returned are defined by AWS Data Pipeline.</p>\n "
|
2079
|
+
},
|
2080
|
+
"documentation": "\n <p>Lists the validation warnings that were found by <a>ValidatePipelineDefinition</a>.</p>\n "
|
2081
|
+
},
|
2082
|
+
"errored": {
|
2083
|
+
"shape_name": "boolean",
|
2084
|
+
"type": "boolean",
|
2085
|
+
"documentation": "\n <p>If <code>True</code>, there were validation errors.</p>\n ",
|
2086
|
+
"required": true
|
2087
|
+
}
|
2088
|
+
},
|
2089
|
+
"documentation": "\n <p>Contains the output from the <a>ValidatePipelineDefinition</a> action.</p>\n "
|
2090
|
+
},
|
2091
|
+
"errors": [
|
2092
|
+
{
|
2093
|
+
"shape_name": "InternalServiceError",
|
2094
|
+
"type": "structure",
|
2095
|
+
"members": {
|
2096
|
+
"message": {
|
2097
|
+
"shape_name": "errorMessage",
|
2098
|
+
"type": "string",
|
2099
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
2100
|
+
}
|
2101
|
+
},
|
2102
|
+
"documentation": "\n <p>An internal service error occurred.</p>\n "
|
2103
|
+
},
|
2104
|
+
{
|
2105
|
+
"shape_name": "InvalidRequestException",
|
2106
|
+
"type": "structure",
|
2107
|
+
"members": {
|
2108
|
+
"message": {
|
2109
|
+
"shape_name": "errorMessage",
|
2110
|
+
"type": "string",
|
2111
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
2112
|
+
}
|
2113
|
+
},
|
2114
|
+
"documentation": "\n <p>The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.</p>\n "
|
2115
|
+
},
|
2116
|
+
{
|
2117
|
+
"shape_name": "PipelineNotFoundException",
|
2118
|
+
"type": "structure",
|
2119
|
+
"members": {
|
2120
|
+
"message": {
|
2121
|
+
"shape_name": "errorMessage",
|
2122
|
+
"type": "string",
|
2123
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
2124
|
+
}
|
2125
|
+
},
|
2126
|
+
"documentation": "\n <p>The specified pipeline was not found. Verify that you used the correct user and account identifiers.</p>\n "
|
2127
|
+
},
|
2128
|
+
{
|
2129
|
+
"shape_name": "PipelineDeletedException",
|
2130
|
+
"type": "structure",
|
2131
|
+
"members": {
|
2132
|
+
"message": {
|
2133
|
+
"shape_name": "errorMessage",
|
2134
|
+
"type": "string",
|
2135
|
+
"documentation": "\n <p>Description of the error message.</p>\n "
|
2136
|
+
}
|
2137
|
+
},
|
2138
|
+
"documentation": "\n <p>The specified pipeline has been deleted.</p>\n "
|
2139
|
+
}
|
2140
|
+
],
|
2141
|
+
"documentation": "\n <p>Tests the pipeline definition with a set of validation checks to ensure that it is well formed and can run without error. </p>\n\n <examples>\n <example>\n <name>Example 1</name>\n <description>\n This example sets an valid pipeline configuration and returns success.\n </description>\n <request>\n \nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.ValidatePipelineDefinition\nContent-Length: 936\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\",\n \"pipelineObjects\": \n [\n {\"id\": \"Default\",\n \"name\": \"Default\",\n \"fields\": \n [\n {\"key\": \"workerGroup\", \n \"stringValue\": \"MyworkerGroup\"}\n ]\n }, \n {\"id\": \"Schedule\",\n \"name\": \"Schedule\",\n \"fields\": \n [\n {\"key\": \"startDateTime\", \n \"stringValue\": \"2012-09-25T17:00:00\"}, \n {\"key\": \"type\", \n \"stringValue\": \"Schedule\"}, \n {\"key\": \"period\", \n \"stringValue\": \"1 hour\"}, \n {\"key\": \"endDateTime\", \n \"stringValue\": \"2012-09-25T18:00:00\"}\n ]\n },\n {\"id\": \"SayHello\",\n \"name\": \"SayHello\",\n \"fields\": \n [\n {\"key\": \"type\", \n \"stringValue\": \"ShellCommandActivity\"},\n {\"key\": \"command\", \n \"stringValue\": \"echo hello\"},\n {\"key\": \"parent\", \n \"refValue\": \"Default\"},\n {\"key\": \"schedule\", \n \"refValue\": \"Schedule\"}\n \n ]\n }\n ]\n}\n \n </request>\n <response>\n \nx-amzn-RequestId: 92c9f347-0776-11e2-8a14-21bb8a1f50ef\nContent-Type: application/x-amz-json-1.1\nContent-Length: 18\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"errored\": false}\n \n </response>\n </example>\n <example>\n <name>Example 2</name>\n <description>\n This example sets an invalid pipeline configuration and returns the associated set of validation errors.\n </description>\n \n <request>\n \nPOST / HTTP/1.1\nContent-Type: application/x-amz-json-1.1\nX-Amz-Target: DataPipeline.ValidatePipelineDefinition\nContent-Length: 903\nHost: datapipeline.us-east-1.amazonaws.com\nX-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT\nAuthorization: AuthParams\n\n{\"pipelineId\": \"df-06372391ZG65EXAMPLE\",\n \"pipelineObjects\": \n [\n {\"id\": \"Default\",\n \"name\": \"Default\",\n \"fields\": \n [\n {\"key\": \"workerGroup\", \n \"stringValue\": \"MyworkerGroup\"}\n ]\n }, \n {\"id\": \"Schedule\",\n \"name\": \"Schedule\",\n \"fields\": \n [\n {\"key\": \"startDateTime\", \n \"stringValue\": \"bad-time\"}, \n {\"key\": \"type\", \n \"stringValue\": \"Schedule\"}, \n {\"key\": \"period\", \n \"stringValue\": \"1 hour\"}, \n {\"key\": \"endDateTime\", \n \"stringValue\": \"2012-09-25T18:00:00\"}\n ]\n },\n {\"id\": \"SayHello\",\n \"name\": \"SayHello\",\n \"fields\": \n [\n {\"key\": \"type\", \n \"stringValue\": \"ShellCommandActivity\"},\n {\"key\": \"command\", \n \"stringValue\": \"echo hello\"},\n {\"key\": \"parent\", \n \"refValue\": \"Default\"},\n {\"key\": \"schedule\", \n \"refValue\": \"Schedule\"}\n \n ]\n }\n ]\n}\n \n </request>\n <response>\n \nx-amzn-RequestId: 496a1f5a-0e6a-11e2-a61c-bd6312c92ddd\nContent-Type: application/x-amz-json-1.1\nContent-Length: 278\nDate: Mon, 12 Nov 2012 17:50:53 GMT\n\n{\"errored\": true, \n \"validationErrors\": \n [\n {\"errors\": \n [\"INVALID_FIELD_VALUE: 'startDateTime' value must be a literal datetime value.\"], \n \"id\": \"Schedule\"}\n ]\n}\n \n </response>\n </example>\n </examples>\n "
|
2142
|
+
}
|
2143
|
+
}
|
2144
|
+
}
|