vendor: update all dependencies to latest versions

This commit is contained in:
Nick Craig-Wood
2018-01-16 13:20:59 +00:00
parent 8e83fb6fb9
commit 7d3a17725d
4878 changed files with 1974229 additions and 201215 deletions

View File

@ -3,11 +3,11 @@ language: go
sudo: required
go:
- 1.5
- 1.6
- 1.7
- 1.8
- 1.9
- 1.5.x
- 1.6.x
- 1.7.x
- 1.8.x
- 1.9.x
- tip
# Use Go 1.5's vendoring experiment for 1.5 tests.
@ -23,3 +23,7 @@ script:
matrix:
allow_failures:
- go: tip
branches:
only:
- master

View File

@ -1,3 +1,677 @@
Release v1.12.62 (2018-01-15)
===
### Service Client Updates
* `aws/endpoints`: Updated Regions and Endpoints metadata.
* `service/lambda`: Updates service API and documentation
* Support for creating Lambda Functions using 'dotnetcore2.0' and 'go1.x'.
Release v1.12.61 (2018-01-12)
===
### Service Client Updates
* `service/glue`: Updates service API and documentation
* Support is added to generate ETL scripts in Scala which can now be run by AWS Glue ETL jobs. In addition, the trigger API now supports firing when any conditions are met (in addition to all conditions). Also, jobs can be triggered based on a "failed" or "stopped" job run (in addition to a "succeeded" job run).
Release v1.12.60 (2018-01-11)
===
### Service Client Updates
* `service/elasticloadbalancing`: Updates service API and documentation
* `service/elasticloadbalancingv2`: Updates service API and documentation
* `service/rds`: Updates service API and documentation
* Read Replicas for Amazon RDS for MySQL, MariaDB, and PostgreSQL now support Multi-AZ deployments.Amazon RDS Read Replicas enable you to create one or more read-only copies of your database instance within the same AWS Region or in a different AWS Region. Updates made to the source database are asynchronously copied to the Read Replicas. In addition to providing scalability for read-heavy workloads, you can choose to promote a Read Replica to become standalone a DB instance when needed.Amazon RDS Multi-AZ Deployments provide enhanced availability for database instances within a single AWS Region. With Multi-AZ, your data is synchronously replicated to a standby in a different Availability Zone (AZ). In case of an infrastructure failure, Amazon RDS performs an automatic failover to the standby, minimizing disruption to your applications.You can now combine Read Replicas with Multi-AZ as part of a disaster recovery strategy for your production databases. A well-designed and tested plan is critical for maintaining business continuity after a disaster. Since Read Replicas can also be created in different regions than the source database, your Read Replica can be promoted to become the new production database in case of a regional disruption.You can also combine Read Replicas with Multi-AZ for your database engine upgrade process. You can create a Read Replica of your production database instance and upgrade it to a new database engine version. When the upgrade is complete, you can stop applications, promote the Read Replica to a standalone database instance and switch over your applications. Since the database instance is already a Multi-AZ deployment, no additional steps are needed.For more information, see the Amazon RDS User Guide.
* `service/ssm`: Updates service documentation
* Updates documentation for the HierarchyLevelLimitExceededException error.
Release v1.12.59 (2018-01-09)
===
### Service Client Updates
* `service/kms`: Updates service documentation
* Documentation updates for AWS KMS
Release v1.12.58 (2018-01-09)
===
### Service Client Updates
* `service/ds`: Updates service API and documentation
* On October 24 we introduced AWS Directory Service for Microsoft Active Directory (Standard Edition), also known as AWS Microsoft AD (Standard Edition), which is a managed Microsoft Active Directory (AD) that is optimized for small and midsize businesses (SMBs). With this SDK release, you can now create an AWS Microsoft AD directory using API. This enables you to run typical SMB workloads using a cost-effective, highly available, and managed Microsoft AD in the AWS Cloud.
Release v1.12.57 (2018-01-08)
===
### Service Client Updates
* `service/codedeploy`: Updates service API and documentation
* The AWS CodeDeploy API was updated to support DeleteGitHubAccountToken, a new method that deletes a GitHub account connection.
* `service/discovery`: Updates service API and documentation
* Documentation updates for AWS Application Discovery Service.
* `service/route53`: Updates service API and documentation
* This release adds an exception to the CreateTrafficPolicyVersion API operation.
Release v1.12.56 (2018-01-05)
===
### Service Client Updates
* `service/inspector`: Updates service API, documentation, and examples
* Added 2 new attributes to the DescribeAssessmentTemplate response, indicating the total number of assessment runs and last assessment run ARN (if present.)
* `service/snowball`: Updates service documentation
* Documentation updates for snowball
* `service/ssm`: Updates service documentation
* Documentation updates for ssm
Release v1.12.55 (2018-01-02)
===
### Service Client Updates
* `service/rds`: Updates service documentation
* Documentation updates for rds
Release v1.12.54 (2017-12-29)
===
### Service Client Updates
* `aws/endpoints`: Updated Regions and Endpoints metadata.
* `service/workspaces`: Updates service API and documentation
* Modify WorkSpaces have been updated with flexible storage and switching of hardware bundles feature. The following configurations have been added to ModifyWorkSpacesProperties: storage and compute. This update provides the capability to configure the storage of a WorkSpace. It also adds the capability of switching hardware bundle of a WorkSpace by specifying an eligible compute (Value, Standard, Performance, Power).
Release v1.12.53 (2017-12-22)
===
### Service Client Updates
* `service/ec2`: Updates service API
* This release fixes an issue with tags not showing in DescribeAddresses responses.
* `service/ecs`: Updates service API and documentation
* Amazon ECS users can now set a health check initialization wait period of their ECS services, the services that are associated with an Elastic Load Balancer (ELB) will wait for a period of time before the ELB become healthy. You can now configure this in Create and Update Service.
* `service/inspector`: Updates service API and documentation
* PreviewAgents API now returns additional fields within the AgentPreview data type. The API now shows the agent health and availability status for all instances included in the assessment target. This allows users to check the health status of Inspector Agents before running an assessment. In addition, it shows the instance ID, hostname, and IP address of the targeted instances.
* `service/sagemaker`: Updates service API and documentation
* SageMaker Models no longer support SupplementalContainers. API's that have been affected are CreateModel and DescribeModel.
Release v1.12.52 (2017-12-21)
===
### Service Client Updates
* `service/codebuild`: Updates service API and documentation
* Adding support allowing AWS CodeBuild customers to select specific curated image versions.
* `service/ec2`: Updates service API and documentation
* Elastic IP tagging enables you to add key and value metadata to your Elastic IPs so that you can search, filter, and organize them according to your organization's needs.
* `aws/endpoints`: Updated Regions and Endpoints metadata.
* `service/kinesisanalytics`: Updates service API and documentation
* Kinesis Analytics now supports AWS Lambda functions as output.
Release v1.12.51 (2017-12-21)
===
### Service Client Updates
* `service/config`: Updates service API
* `aws/endpoints`: Updated Regions and Endpoints metadata.
* `service/iot`: Updates service API and documentation
* This release adds support for code signed Over-the-air update functionality for Amazon FreeRTOS. Users can now create and schedule Over-the-air updates to their Amazon FreeRTOS devices using these new APIs.
Release v1.12.50 (2017-12-19)
===
### Service Client Updates
* `service/apigateway`: Updates service API and documentation
* API Gateway now adds support for calling API with compressed payloads using one of the supported content codings, tagging an API stage for cost allocation, and returning API keys from a custom authorizer for use with a usage plan.
* `aws/endpoints`: Updated Regions and Endpoints metadata.
* `service/mediastore-data`: Updates service documentation
* `service/route53`: Updates service API and documentation
* Route 53 added support for a new China (Ningxia) region, cn-northwest-1. You can now specify cn-northwest-1 as the region for latency-based or geoproximity routing. Route 53 also added support for a new EU (Paris) region, eu-west-3. You can now associate VPCs in eu-west-3 with private hosted zones and create alias records that route traffic to resources in eu-west-3.
Release v1.12.49 (2017-12-19)
===
### Service Client Updates
* `aws/endpoints`: Updated Regions and Endpoints metadata.
* `service/monitoring`: Updates service documentation
* Documentation updates for monitoring
Release v1.12.48 (2017-12-15)
===
### Service Client Updates
* `service/appstream`: Updates service API and documentation
* This API update is to enable customers to add tags to their Amazon AppStream 2.0 resources
Release v1.12.47 (2017-12-14)
===
### Service Client Updates
* `service/apigateway`: Updates service API and documentation
* Adds support for Cognito Authorizer scopes at the API method level.
* `service/email`: Updates service documentation
* Added information about the maximum number of transactions per second for the SendCustomVerificationEmail operation.
* `aws/endpoints`: Updated Regions and Endpoints metadata.
Release v1.12.46 (2017-12-12)
===
### Service Client Updates
* `service/workmail`: Adds new service
* Today, Amazon WorkMail released an administrative SDK and enabled AWS CloudTrail integration. With the administrative SDK, you can natively integrate WorkMail with your existing services. The SDK enables programmatic user, resource, and group management through API calls. This means your existing IT tools and workflows can now automate WorkMail management, and third party applications can streamline WorkMail migrations and account actions.
Release v1.12.45 (2017-12-11)
===
### Service Client Updates
* `service/cognito-idp`: Updates service API and documentation
* `aws/endpoints`: Updated Regions and Endpoints metadata.
* `service/lex-models`: Updates service API and documentation
* `service/sagemaker`: Updates service API
* CreateModel API Update: The request parameter 'ExecutionRoleArn' has changed from optional to required.
Release v1.12.44 (2017-12-08)
===
### Service Client Updates
* `service/appstream`: Updates service API and documentation
* This API update is to support the feature that allows customers to automatically consume the latest Amazon AppStream 2.0 agent as and when published by AWS.
* `service/ecs`: Updates service documentation
* Documentation updates for Windows containers.
* `service/monitoring`: Updates service API and documentation
* With this launch, you can now create a CloudWatch alarm that alerts you when M out of N datapoints of a metric are breaching your predefined threshold, such as three out of five times in any given five minutes interval or two out of six times in a thirty minutes interval. When M out of N datapoints are not breaching your threshold in an interval, the alarm will be in OK state. Please note that the M datapoints out of N datapoints in an interval can be of any order and does not need to be consecutive. Consequently, you can now get alerted even when the spikes in your metrics are intermittent over an interval.
Release v1.12.43 (2017-12-07)
===
### Service Client Updates
* `service/email`: Updates service API, documentation, and paginators
* Customers can customize the emails that Amazon SES sends when verifying new identities. This feature is helpful for developers whose applications send email through Amazon SES on behalf of their customers.
* `service/es`: Updates service API and documentation
* Added support for encryption of data at rest on Amazon Elasticsearch Service using AWS KMS
### SDK Bugs
* `models/apis` Fixes removes colliding sagemaker models folders ([#1686](https://github.com/aws/aws-sdk-go/pull/1686))
* Fixes Release v1.12.42's SageMaker vs sagemaker model folders.
Release v1.12.42 (2017-12-06)
===
### Service Client Updates
* `service/clouddirectory`: Updates service API and documentation
* Amazon Cloud Directory makes it easier for you to apply schema changes across your directories with in-place schema upgrades. Your directories now remain available while backward-compatible schema changes are being applied, such as the addition of new fields. You also can view the history of your schema changes in Cloud Directory by using both major and minor version identifiers, which can help you track and audit schema versions across directories.
* `service/elasticbeanstalk`: Updates service documentation
* Documentation updates for AWS Elastic Beanstalk.
* `service/sagemaker`: Adds new service
* Initial waiters for common SageMaker workflows.
Release v1.12.41 (2017-12-05)
===
### Service Client Updates
* `service/iot`: Updates service API and documentation
* Add error action API for RulesEngine.
* `service/servicecatalog`: Updates service API and documentation
* ServiceCatalog has two distinct personas for its use, an "admin" persona (who creates sets of products with different versions and prescribes who has access to them) and an "end-user" persona (who can launch cloud resources based on the configuration data their admins have given them access to). This API update will allow admin users to deactivate/activate product versions, end-user will only be able to access and launch active product versions.
* `service/servicediscovery`: Adds new service
* Amazon Route 53 Auto Naming lets you configure public or private namespaces that your microservice applications run in. When instances of the service become available, you can call the Auto Naming API to register the instance, and Amazon Route 53 automatically creates up to five DNS records and an optional health check. Clients that submit DNS queries for the service receive an answer that contains up to eight healthy records.
Release v1.12.40 (2017-12-04)
===
### Service Client Updates
* `service/budgets`: Updates service API and documentation
* Add additional costTypes to support finer control for different charges included in a cost budget.
* `service/ecs`: Updates service documentation
* Documentation updates for ecs
Release v1.12.39 (2017-12-01)
===
### Service Client Updates
* `service/SageMaker`: Updates service waiters
Release v1.12.38 (2017-11-30)
===
### Service Client Updates
* `service/AWSMoneypenny`: Adds new service
* `service/Cloud9`: Adds new service
* `service/Serverless Registry`: Adds new service
* `service/apigateway`: Updates service API, documentation, and paginators
* Added support Private Integration and VPC Link features in API Gateway. This allows to create an API with the API Gateway private integration, thus providing clients access to HTTP/HTTPS resources in an Amazon VPC from outside of the VPC through a VpcLink resource.
* `service/ec2`: Updates service API and documentation
* Adds the following updates: 1. Spread Placement ensures that instances are placed on distinct hardware in order to reduce correlated failures. 2. Inter-region VPC Peering allows customers to peer VPCs across different AWS regions without requiring additional gateways, VPN connections or physical hardware
* `service/lambda`: Updates service API and documentation
* AWS Lambda now supports the ability to set the concurrency limits for individual functions, and increasing memory to 3008 MB.
Release v1.12.37 (2017-11-30)
===
### Service Client Updates
* `service/Ardi`: Adds new service
* `service/autoscaling`: Updates service API and documentation
* You can now use Auto Scaling with EC2 Launch Templates via the CreateAutoScalingGroup and UpdateAutoScalingGroup APIs.
* `service/ec2`: Updates service API and documentation
* Adds the following updates: 1. T2 Unlimited enables high CPU performance for any period of time whenever required 2. You are now able to create and launch EC2 m5 and h1 instances
* `service/lightsail`: Updates service API and documentation
* This release adds support for load balancer and TLS/SSL certificate management. This set of APIs allows customers to create, manage, and scale secure load balanced applications on Lightsail infrastructure. To provide support for customers who manage their DNS on Lightsail, we've added the ability create an Alias A type record which can point to a load balancer DNS name via the CreateDomainEntry API http://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateDomainEntry.html.
* `service/ssm`: Updates service API and documentation
* This release updates AWS Systems Manager APIs to enable executing automations at controlled rate, target resources in a resource groups and execute entire automation at once or single step at a time. It is now also possible to use YAML, in addition to JSON, when creating Systems Manager documents.
* `service/waf`: Updates service API and documentation
* This release adds support for rule group and managed rule group. Rule group is a container of rules that customers can create, put rules in it and associate the rule group to a WebACL. All rules in a rule group will function identically as they would if each rule was individually associated to the WebACL. Managed rule group is a pre-configured rule group composed by our security partners and made available via the AWS Marketplace. Customers can subscribe to these managed rule groups, associate the managed rule group to their WebACL and start using them immediately to protect their resources.
* `service/waf-regional`: Updates service API and documentation
Release v1.12.36 (2017-11-29)
===
### Service Client Updates
* `service/DeepInsight`: Adds new service
* `service/IronmanRuntime`: Adds new service
* `service/Orchestra - Laser`: Adds new service
* `service/SageMaker`: Adds new service
* `service/Shine`: Adds new service
* `service/archived.kinesisvideo`: Adds new service
* `service/data.kinesisvideo`: Adds new service
* `service/dynamodb`: Updates service API and documentation
* Amazon DynamoDB now supports the following features: Global Table and On-Demand Backup. Global Table is a fully-managed, multi-region, multi-master database. DynamoDB customers can now write anywhere and read anywhere with single-digit millisecond latency by performing database operations closest to where end users reside. Global Table also enables customers to disaster-proof their applications, keeping them running and data accessible even in the face of natural disasters or region disruptions. Customers can set up Global Table with just a few clicks in the AWS Management Console-no application rewrites required. On-Demand Backup capability is to protect data from loss due to application errors, and meet customers' archival needs for compliance and regulatory reasons. Customers can backup and restore their DynamoDB table data anytime, with a single-click in the AWS management console or a single API call. Backup and restore actions execute with zero impact on table performance or availability. For more information, see the Amazon DynamoDB Developer Guide.
* `service/ecs`: Updates service API and documentation
* Amazon Elastic Container Service (Amazon ECS) released a new launch type for running containers on a serverless infrastructure. The Fargate launch type allows you to run your containerized applications without the need to provision and manage the backend infrastructure. Just register your task definition and Fargate launches the container for you.
* `service/glacier`: Updates service API and documentation
* This release includes support for Glacier Select, a new feature that allows you to filter and analyze your Glacier archives and store the results in a user-specified S3 location.
* `service/greengrass`: Updates service API and documentation
* Greengrass OTA feature allows updating Greengrass Core and Greengrass OTA Agent. Local Resource Access feature allows Greengrass Lambdas to access local resources such as peripheral devices and volumes.
* `service/iot`: Updates service API and documentation
* This release adds support for a number of new IoT features, including AWS IoT Device Management (Jobs, Fleet Index and Thing Registration), Thing Groups, Policies on Thing Groups, Registry & Job Events, JSON Logs, Fine-Grained Logging Controls, Custom Authorization and AWS Service Authentication Using X.509 Certificates.
* `service/kinesisvideo`: Adds new service
* Announcing Amazon Kinesis Video Streams, a fully managed video ingestion and storage service. Kinesis Video Streams makes it easy to securely stream video from connected devices to AWS for machine learning, analytics, and processing. You can also stream other time-encoded data like RADAR and LIDAR signals using Kinesis Video Streams.
* `service/rekognition`: Updates service API, documentation, and paginators
* This release introduces Amazon Rekognition support for video analysis.
* `service/s3`: Updates service API and documentation
* This release includes support for Glacier Select, a new feature that allows you to filter and analyze your Glacier storage class objects and store the results in a user-specified S3 location.
Release v1.12.35 (2017-11-29)
===
### Service Client Updates
* `service/AmazonMQ`: Adds new service
* `service/GuardDuty`: Adds new service
* `service/apigateway`: Updates service API and documentation
* Changes related to CanaryReleaseDeployment feature. Enables API developer to create a deployment as canary deployment and test API changes with percentage of customers before promoting changes to all customers.
* `service/batch`: Updates service API and documentation
* Add support for Array Jobs which allow users to easily submit many copies of a job with a single API call. This change also enhances the job dependency model to support N_TO_N and sequential dependency chains. The ListJobs and DescribeJobs APIs now have the ability to list or describe the status of entire Array Jobs or individual elements within the array.
* `service/cognito-idp`: Updates service API and documentation
* `service/deepdish`: Adds new service
* AWS AppSync is an enterprise-level, fully managed GraphQL service with real-time data synchronization and offline programming features.
* `service/ec2`: Updates service API and documentation
* Adds the following updates: 1. You are now able to host a service powered by AWS PrivateLink to provide private connectivity to other VPCs. You are now also able to create endpoints to other services powered by PrivateLink including AWS services, Marketplace Seller services or custom services created by yourself or other AWS VPC customers. 2. You are now able to save launch parameters in a single template that can be used with Auto Scaling, Spot Fleet, Spot, and On Demand instances. 3. You are now able to launch Spot instances via the RunInstances API, using a single additional parameter. RunInstances will response synchronously with an instance ID should capacity be available for your Spot request. 4. A simplified Spot pricing model which delivers low, predictable prices that adjust gradually, based on long-term trends in supply and demand. 5. Amazon EC2 Spot can now hibernate Amazon EBS-backed instances in the event of an interruption, so your workloads pick up from where they left off. Spot can fulfill your request by resuming instances from a hibernated state when capacity is available.
* `service/lambda`: Updates service API and documentation
* Lambda aliases can now shift traffic between two function versions, based on preassigned weights.
Release v1.12.34 (2017-11-27)
===
### Service Client Updates
* `service/data.mediastore`: Adds new service
* `service/mediaconvert`: Adds new service
* AWS Elemental MediaConvert is a file-based video conversion service that transforms media into formats required for traditional broadcast and for internet streaming to multi-screen devices.
* `service/medialive`: Adds new service
* AWS Elemental MediaLive is a video service that lets you easily create live outputs for broadcast and streaming delivery.
* `service/mediapackage`: Adds new service
* AWS Elemental MediaPackage is a just-in-time video packaging and origination service that lets you format highly secure and reliable live outputs for a variety of devices.
* `service/mediastore`: Adds new service
* AWS Elemental MediaStore is an AWS storage service optimized for media. It gives you the performance, consistency, and low latency required to deliver live and on-demand video content. AWS Elemental MediaStore acts as the origin store in your video workflow.
Release v1.12.33 (2017-11-22)
===
### Service Client Updates
* `service/acm`: Updates service API and documentation
* AWS Certificate Manager now supports the ability to import domainless certs and additional Key Types as well as an additional validation method for DNS.
* `aws/endpoints`: Updated Regions and Endpoints metadata.
Release v1.12.32 (2017-11-22)
===
### Service Client Updates
* `service/apigateway`: Updates service API and documentation
* Add support for Access logs and customizable integration timeouts
* `service/cloudformation`: Updates service API and documentation
* 1) Instance-level parameter overrides (CloudFormation-StackSet feature): This feature will allow the customers to override the template parameters on specific stackInstances. Customers will also have ability to update their existing instances with/without parameter-overrides using a new API "UpdateStackInstances" 2) Add support for SSM parameters in CloudFormation - This feature will allow the customers to use Systems Manager parameters in CloudFormation templates. They will be able to see values for these parameters in Describe APIs.
* `service/codebuild`: Updates service API and documentation
* Adding support for accessing Amazon VPC resources from AWS CodeBuild, dependency caching and build badges.
* `service/elasticmapreduce`: Updates service API and documentation
* Enable Kerberos on Amazon EMR.
* `aws/endpoints`: Updated Regions and Endpoints metadata.
* `service/rekognition`: Updates service API and documentation
* This release includes updates to Amazon Rekognition for the following APIs. The new DetectText API allows you to recognize and extract textual content from images. Face Model Versioning has been added to operations that deal with face detection.
* `service/shield`: Updates service API, documentation, and paginators
* The AWS Shield SDK has been updated in order to support Elastic IP address protections, the addition of AttackProperties objects in DescribeAttack responses, and a new GetSubscriptionState operation.
* `service/storagegateway`: Updates service API and documentation
* AWS Storage Gateway now enables you to get notification when all your files written to your NFS file share have been uploaded to Amazon S3. Storage Gateway also enables guessing of the MIME type for uploaded objects based on file extensions.
* `service/xray`: Updates service API, documentation, and paginators
* Added automatic pagination support for AWS X-Ray APIs in the SDKs that support this feature.
Release v1.12.31 (2017-11-20)
===
### Service Client Updates
* `service/apigateway`: Updates service documentation
* Documentation updates for Apigateway
* `service/codecommit`: Updates service API, documentation, and paginators
* AWS CodeCommit now supports pull requests. You can use pull requests to collaboratively review code changes for minor changes or fixes, major feature additions, or new versions of your released software.
* `service/firehose`: Updates service API and documentation
* This release includes a new Kinesis Firehose feature that supports Splunk as Kinesis Firehose delivery destination. You can now use Kinesis Firehose to ingest real-time data to Splunk in a serverless, reliable, and salable manner. This release also includes a new feature that allows you to configure Lambda buffer size in Kinesis Firehose data transformation feature. You can now customize the data buffer size before invoking Lambda function in Kinesis Firehose for data transformation. This feature allows you to flexibly trade-off processing and delivery latency with cost and efficiency based on your specific use cases and requirements.
* `service/iis`: Adds new service
* The AWS Cost Explorer API gives customers programmatic access to AWS cost and usage information, allowing them to perform adhoc queries and build interactive cost management applications that leverage this dataset.
* `service/kinesis`: Updates service API and documentation
* Customers can now obtain the important characteristics of their stream with DescribeStreamSummary. The response will not include the shard list for the stream but will have the number of open shards, and all the other fields included in the DescribeStream response.
* `service/workdocs`: Updates service API and documentation
* DescribeGroups API and miscellaneous enhancements
### SDK Bugs
* `aws/client`: Retry delays for throttled exception were not limited to 5 mintues [#1654](https://github.com/aws/aws-sdk-go/pull/1654)
* Fixes [#1653](https://github.com/aws/aws-sdk-go/issues/1653)
Release v1.12.30 (2017-11-17)
===
### Service Client Updates
* `service/application-autoscaling`: Updates service API and documentation
* `service/dms`: Updates service API, documentation, and paginators
* Support for migration task assessment. Support for data validation after the migration.
* `service/elasticloadbalancingv2`: Updates service API and documentation
* `aws/endpoints`: Updated Regions and Endpoints metadata.
* `service/rds`: Updates service API and documentation
* Amazon RDS now supports importing MySQL databases by using backup files from Amazon S3.
* `service/s3`: Updates service API
* Added ORC to the supported S3 Inventory formats.
### SDK Bugs
* `private/protocol/restjson`: Define JSONValue marshaling for body and querystring ([#1640](https://github.com/aws/aws-sdk-go/pull/1640))
* Adds support for APIs which use JSONValue for body and querystring targets.
* Fixes [#1636](https://github.com/aws/aws-sdk-go/issues/1636)
Release v1.12.29 (2017-11-16)
===
### Service Client Updates
* `service/application-autoscaling`: Updates service API and documentation
* `service/ec2`: Updates service API
* You are now able to create and launch EC2 x1e smaller instance sizes
* `service/glue`: Updates service API and documentation
* API update for AWS Glue. New crawler configuration attribute enables customers to specify crawler behavior. New XML classifier enables classification of XML data.
* `service/opsworkscm`: Updates service API, documentation, and waiters
* Documentation updates for OpsWorks-cm: a new feature, OpsWorks for Puppet Enterprise, that allows users to create and manage OpsWorks-hosted Puppet Enterprise servers.
* `service/organizations`: Updates service API, documentation, and paginators
* This release adds APIs that you can use to enable and disable integration with AWS services designed to work with AWS Organizations. This integration allows the AWS service to perform operations on your behalf on all of the accounts in your organization. Although you can use these APIs yourself, we recommend that you instead use the commands provided in the other AWS service to enable integration with AWS Organizations.
* `service/route53`: Updates service API and documentation
* You can use Route 53's GetAccountLimit/GetHostedZoneLimit/GetReusableDelegationSetLimit APIs to view your current limits (including custom set limits) on Route 53 resources such as hosted zones and health checks. These APIs also return the number of each resource you're currently using to enable comparison against your current limits.
Release v1.12.28 (2017-11-15)
===
### Service Client Updates
* `service/apigateway`: Updates service API and documentation
* 1. Extended GetDocumentationParts operation to support retrieving documentation parts resources without contents. 2. Added hosted zone ID in the custom domain response.
* `service/email`: Updates service API, documentation, and examples
* SES launches Configuration Set Reputation Metrics and Email Pausing Today, two features that build upon the capabilities of the reputation dashboard. The first is the ability to export reputation metrics for individual configuration sets. The second is the ability to temporarily pause email sending, either at the configuration set level, or across your entire Amazon SES account.
* `service/polly`: Updates service API
* Amazon Polly adds Korean language support with new female voice - "Seoyeon" and new Indian English female voice - "Aditi"
* `service/states`: Updates service API and documentation
* You can now use the UpdateStateMachine API to update your state machine definition and role ARN. Existing executions will continue to use the previous definition and role ARN. You can use the DescribeStateMachineForExecution API to determine which state machine definition and role ARN is associated with an execution
Release v1.12.27 (2017-11-14)
===
### Service Client Updates
* `service/ecs`: Updates service API and documentation
* Added new mode for Task Networking in ECS, called awsvpc mode. Mode configuration parameters to be passed in via awsvpcConfiguration. Updated APIs now use/show this new mode - RegisterTaskDefinition, CreateService, UpdateService, RunTask, StartTask.
* `aws/endpoints`: Updated Regions and Endpoints metadata.
* `service/lightsail`: Updates service API and documentation
* Lightsail now supports attached block storage, which allows you to scale your applications and protect application data with additional SSD-backed storage disks. This feature allows Lightsail customers to attach secure storage disks to their Lightsail instances and manage their attached disks, including creating and deleting disks, attaching and detaching disks from instances, and backing up disks via snapshot.
* `service/route53`: Updates service API and documentation
* When a Route 53 health check or hosted zone is created by a linked AWS service, the object now includes information about the service that created it. Hosted zones or health checks that are created by a linked service can't be updated or deleted using Route 53.
* `service/ssm`: Updates service API and documentation
* EC2 Systems Manager GetInventory API adds support for aggregation.
### SDK Enhancements
* `aws/request`: Remove default port from HTTP host header ([#1618](https://github.com/aws/aws-sdk-go/pull/1618))
* Updates the SDK to automatically remove default ports based on the URL's scheme when setting the HTTP Host header's value.
* Fixes [#1537](https://github.com/aws/aws-sdk-go/issues/1537)
Release v1.12.26 (2017-11-09)
===
### Service Client Updates
* `service/ec2`: Updates service API and documentation
* Introduces the following features: 1. Create a default subnet in an Availability Zone if no default subnet exists. 2. Spot Fleet integrates with Elastic Load Balancing to enable you to attach one or more load balancers to a Spot Fleet request. When you attach the load balancer, it automatically registers the instance in the Spot Fleet to the load balancers which distributes incoming traffic across the instances.
* `aws/endpoints`: Updated Regions and Endpoints metadata.
Release v1.12.25 (2017-11-08)
===
### Service Client Updates
* `service/application-autoscaling`: Updates service API and documentation
* `service/batch`: Updates service documentation
* Documentation updates for AWS Batch.
* `service/ec2`: Updates service API and documentation
* AWS PrivateLink for Amazon Services - Customers can now privately access Amazon services from their Amazon Virtual Private Cloud (VPC), without using public IPs, and without requiring the traffic to traverse across the Internet.
* `service/elasticache`: Updates service API and documentation
* This release adds online resharding for ElastiCache for Redis offering, providing the ability to add and remove shards from a running cluster. Developers can now dynamically scale-out or scale-in their Redis cluster workloads to adapt to changes in demand. ElastiCache will resize the cluster by adding or removing shards and redistribute hash slots uniformly across the new shard configuration, all while the cluster continues to stay online and serves requests.
* `aws/endpoints`: Updated Regions and Endpoints metadata.
Release v1.12.24 (2017-11-07)
===
### Service Client Updates
* `service/elasticloadbalancingv2`: Updates service documentation
* `aws/endpoints`: Updated Regions and Endpoints metadata.
* `service/rds`: Updates service API and documentation
* DescribeOrderableDBInstanceOptions now returns the minimum and maximum allowed values for storage size, total provisioned IOPS, and provisioned IOPS per GiB for a DB instance.
* `service/s3`: Updates service API, documentation, and examples
* This releases adds support for 4 features: 1. Default encryption for S3 Bucket, 2. Encryption status in inventory and Encryption support for inventory. 3. Cross region replication of KMS-encrypted objects, and 4. ownership overwrite for CRR.
Release v1.12.23 (2017-11-07)
===
### Service Client Updates
* `service/api.pricing`: Adds new service
* `service/ec2`: Updates service API
* You are now able to create and launch EC2 C5 instances, the next generation of EC2's compute-optimized instances, in us-east-1, us-west-2 and eu-west-1. C5 instances offer up to 72 vCPUs, 144 GiB of DDR4 instance memory, 25 Gbps in Network bandwidth and improved EBS and Networking bandwidth on smaller instance sizes to deliver improved performance for compute-intensive workloads.
* `aws/endpoints`: Updated Regions and Endpoints metadata.
* `service/kms`: Updates service API, documentation, and examples
* Documentation updates for AWS KMS.
* `service/organizations`: Updates service documentation
* This release updates permission statements for several API operations, and corrects some other minor errors.
* `service/states`: Updates service API, documentation, and paginators
* Documentation update.
Release v1.12.22 (2017-11-03)
===
### Service Client Updates
* `service/ecs`: Updates service API and documentation
* Amazon ECS users can now add devices to their containers and enable init process in containers through the use of docker's 'devices' and 'init' features. These fields can be specified under linuxParameters in ContainerDefinition in the Task Definition Template.
* `aws/endpoints`: Updated Regions and Endpoints metadata.
Release v1.12.21 (2017-11-02)
===
### Service Client Updates
* `service/apigateway`: Updates service API and documentation
* This release supports creating and managing Regional and Edge-Optimized API endpoints.
* `aws/endpoints`: Updated Regions and Endpoints metadata.
### SDK Bugs
* `aws/request`: Fix bug in request presign creating invalide URL ([#1624](https://github.com/aws/aws-sdk-go/pull/1624))
* Fixes a bug the Request Presign and PresignRequest methods that would allow a invalid expire duration as input. A expire time of 0 would be interpreted by the SDK to generate a normal request signature, not a presigned URL. This caused the returned URL unusable.
* Fixes [#1617](https://github.com/aws/aws-sdk-go/issues/1617)
Release v1.12.20 (2017-11-01)
===
### Service Client Updates
* `service/acm`: Updates service documentation
* Documentation updates for ACM
* `service/cloudhsmv2`: Updates service documentation
* Minor documentation update for AWS CloudHSM (cloudhsmv2).
* `service/directconnect`: Updates service API and documentation
* AWS DirectConnect now provides support for Global Access for Virtual Private Cloud (VPC) via a new feature called Direct Connect Gateway. A Direct Connect Gateway will allow you to group multiple Direct Connect Private Virtual Interfaces (DX-VIF) and Private Virtual Gateways (VGW) from different AWS regions (but belonging to the same AWS Account) and pass traffic from any DX-VIF to any VPC in the grouping.
* `aws/endpoints`: Updated Regions and Endpoints metadata.
### SDK Enhancements
* `aws/client`: Adding status code 429 to throttlable status codes in default retryer (#1621)
Release v1.12.19 (2017-10-26)
===
### Service Client Updates
* `aws/endpoints`: Updated Regions and Endpoints metadata.
Release v1.12.18 (2017-10-26)
===
### Service Client Updates
* `service/cloudfront`: Updates service API and documentation
* You can now specify additional options for MinimumProtocolVersion, which controls the SSL/TLS protocol that CloudFront uses to communicate with viewers. The minimum protocol version that you choose also determines the ciphers that CloudFront uses to encrypt the content that it returns to viewers.
* `service/ec2`: Updates service API
* You are now able to create and launch EC2 P3 instance, next generation GPU instances, optimized for machine learning and high performance computing applications. With up to eight NVIDIA Tesla V100 GPUs, P3 instances provide up to one petaflop of mixed-precision, 125 teraflops of single-precision, and 62 teraflops of double-precision floating point performance, as well as a 300 GB/s second-generation NVLink interconnect that enables high-speed, low-latency GPU-to-GPU communication. P3 instances also feature up to 64 vCPUs based on custom Intel Xeon E5 (Broadwell) processors, 488 GB of DRAM, and 25 Gbps of dedicated aggregate network bandwidth using the Elastic Network Adapter (ENA).
* `aws/endpoints`: Updated Regions and Endpoints metadata.
Release v1.12.17 (2017-10-24)
===
### Service Client Updates
* `service/config`: Updates service API
* `service/elasticache`: Updates service API, documentation, and examples
* Amazon ElastiCache for Redis today announced support for data encryption both for data in-transit and data at-rest. The new encryption in-transit functionality enables ElastiCache for Redis customers to encrypt data for all communication between clients and Redis engine, and all intra-cluster Redis communication. The encryption at-rest functionality allows customers to encrypt their S3 based backups. Customers can begin using the new functionality by simply enabling this functionality via AWS console, and a small configuration change in their Redis clients. The ElastiCache for Redis service automatically manages life cycle of the certificates required for encryption, including the issuance, renewal and expiration of certificates. Additionally, as part of this launch, customers will gain the ability to start using the Redis AUTH command that provides an added level of authentication.
* `service/glue`: Adds new service
* AWS Glue: Adding a new API, BatchStopJobRun, to stop one or more job runs for a specified Job.
* `service/pinpoint`: Updates service API and documentation
* Added support for APNs VoIP messages. Added support for collapsible IDs, message priority, and TTL for APNs and FCM/GCM.
Release v1.12.16 (2017-10-23)
===
### Service Client Updates
* `aws/endpoints`: Updated Regions and Endpoints metadata.
* `service/organizations`: Updates service API and documentation
* This release supports integrating other AWS services with AWS Organizations through the use of an IAM service-linked role called AWSServiceRoleForOrganizations. Certain operations automatically create that role if it does not already exist.
Release v1.12.15 (2017-10-20)
===
### Service Client Updates
* `service/ec2`: Updates service API and documentation
* Adding pagination support for DescribeSecurityGroups for EC2 Classic and VPC Security Groups
Release v1.12.14 (2017-10-19)
===
### Service Client Updates
* `service/sqs`: Updates service API and documentation
* Added support for tracking cost allocation by adding, updating, removing, and listing the metadata tags of Amazon SQS queues.
* `service/ssm`: Updates service API and documentation
* EC2 Systems Manager versioning support for Parameter Store. Also support for referencing parameter versions in SSM Documents.
Release v1.12.13 (2017-10-18)
===
### Service Client Updates
* `service/lightsail`: Updates service API and documentation
* This release adds support for Windows Server-based Lightsail instances. The GetInstanceAccessDetails API now returns the password of your Windows Server-based instance when using the default key pair. GetInstanceAccessDetails also returns a PasswordData object for Windows Server instances containing the ciphertext and keyPairName. The Blueprint data type now includes a list of platform values (LINUX_UNIX or WINDOWS). The Bundle data type now includes a list of SupportedPlatforms values (LINUX_UNIX or WINDOWS).
Release v1.12.12 (2017-10-17)
===
### Service Client Updates
* `aws/endpoints`: Updated Regions and Endpoints metadata.
* `service/es`: Updates service API and documentation
* This release adds support for VPC access to Amazon Elasticsearch Service.
* This release adds support for VPC access to Amazon Elasticsearch Service.
Release v1.12.11 (2017-10-16)
===
### Service Client Updates
* `service/cloudhsm`: Updates service API and documentation
* Documentation updates for AWS CloudHSM Classic.
* `service/ec2`: Updates service API and documentation
* You can now change the tenancy of your VPC from dedicated to default with a single API operation. For more details refer to the documentation for changing VPC tenancy.
* `service/es`: Updates service API and documentation
* AWS Elasticsearch adds support for enabling slow log publishing. Using slow log publishing options customers can configure and enable index/query slow log publishing of their domain to preferred AWS Cloudwatch log group.
* `service/rds`: Updates service API and waiters
* Adds waiters for DBSnapshotAvailable and DBSnapshotDeleted.
* `service/waf`: Updates service API and documentation
* This release adds support for regular expressions as match conditions in rules, and support for geographical location by country of request IP address as a match condition in rules.
* `service/waf-regional`: Updates service API and documentation
Release v1.12.10 (2017-10-12)
===
### Service Client Updates
* `service/codecommit`: Updates service API and documentation
* This release includes the DeleteBranch API and a change to the contents of a Commit object.
* `service/dms`: Updates service API and documentation
* This change includes addition of new optional parameter to an existing API
* `service/elasticbeanstalk`: Updates service API and documentation
* Added the ability to add, delete or update Tags
* `service/polly`: Updates service API
* Amazon Polly exposes two new voices: "Matthew" (US English) and "Takumi" (Japanese)
* `service/rds`: Updates service API and documentation
* You can now call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
Release v1.12.9 (2017-10-11)
===
### Service Client Updates
* `service/ecr`: Updates service API, documentation, and paginators
* Adds support for new API set used to manage Amazon ECR repository lifecycle policies. Amazon ECR lifecycle policies enable you to specify the lifecycle management of images in a repository. The configuration is a set of one or more rules, where each rule defines an action for Amazon ECR to apply to an image. This allows the automation of cleaning up unused images, for example expiring images based on age or status. A lifecycle policy preview API is provided as well, which allows you to see the impact of a lifecycle policy on an image repository before you execute it
* `service/email`: Updates service API and documentation
* Added content related to email template management and templated email sending operations.
* `aws/endpoints`: Updated Regions and Endpoints metadata.
Release v1.12.8 (2017-10-10)
===
### Service Client Updates
* `service/ec2`: Updates service API and documentation
* This release includes updates to AWS Virtual Private Gateway.
* `service/elasticloadbalancingv2`: Updates service API and documentation
* `service/opsworkscm`: Updates service API and documentation
* Provide engine specific information for node associations.
Release v1.12.7 (2017-10-06)
===
### Service Client Updates
* `service/sqs`: Updates service documentation
* Documentation updates regarding availability of FIFO queues and miscellaneous corrections.
Release v1.12.6 (2017-10-05)
===
### Service Client Updates
* `service/redshift`: Updates service API and documentation
* DescribeEventSubscriptions API supports tag keys and tag values as request parameters.
Release v1.12.5 (2017-10-04)
===
### Service Client Updates
* `service/kinesisanalytics`: Updates service API and documentation
* Kinesis Analytics now supports schema discovery on objects in S3. Additionally, Kinesis Analytics now supports input data preprocessing through Lambda.
* `service/route53domains`: Updates service API and documentation
* Added a new API that checks whether a domain name can be transferred to Amazon Route 53.
### SDK Bugs
* `service/s3/s3crypto`: Correct PutObjectRequest documentation ([#1568](https://github.com/aws/aws-sdk-go/pull/1568))
* s3Crypto's PutObjectRequest docstring example was using an incorrect value. Corrected the type used in the example.
Release v1.12.4 (2017-10-03)
===
### Service Client Updates
* `service/ec2`: Updates service API, documentation, and waiters
* This release includes service updates to AWS VPN.
* `service/ssm`: Updates service API and documentation
* EC2 Systems Manager support for tagging SSM Documents. Also support for tag-based permissions to restrict access to SSM Documents based on these tags.
Release v1.12.3 (2017-10-02)
===
### Service Client Updates
* `service/cloudhsm`: Updates service documentation and paginators
* Documentation updates for CloudHSM
Release v1.12.2 (2017-09-29)
===

View File

@ -67,7 +67,7 @@ Please be aware of the following notes prior to opening a pull request:
5. The JSON files under the SDK's `models` folder are sourced from outside the SDK.
Such as `models/apis/ec2/2016-11-15/api.json`. We will not accept pull requests
directly on these models. If you discover an issue with the models please
create a Github [issue](issues) describing the issue.
create a [GitHub issue][issues] describing the issue.
### Testing

View File

@ -6,6 +6,8 @@ aws-sdk-go is the official AWS SDK for the Go programming language.
Checkout our [release notes](https://github.com/aws/aws-sdk-go/releases) for information about the latest bug fixes, updates, and features added to the SDK.
We [announced](https://aws.amazon.com/blogs/developer/aws-sdk-for-go-2-0-developer-preview/) the Developer Preview for the [v2 AWS SDK for Go](). The v2 SDK is available at https://github.com/aws/aws-sdk-go-v2, and `go get github.com/aws/aws-sdk-go-v2` via `go get`. Check out the v2 SDK's [changes and updates](https://github.com/aws/aws-sdk-go-v2/blob/master/CHANGELOG.md), and let us know what you think. We want your feedback.
## Installing
If you are using Go 1.5 with the `GO15VENDOREXPERIMENT=1` vendoring flag, or 1.6 and higher you can use the following command to retrieve the SDK. The SDK's non-testing dependencies will be included and are vendored in the `vendor` folder.
@ -185,7 +187,7 @@ Option's SharedConfigState parameter.
}))
```
[credentials_pkg]: ttps://docs.aws.amazon.com/sdk-for-go/api/aws/credentials
[credentials_pkg]: https://docs.aws.amazon.com/sdk-for-go/api/aws/credentials
### Configuring AWS Region
@ -305,7 +307,7 @@ documentation for the errors that could be returned.
// will leak connections.
defer result.Body.Close()
fmt.Println("Object Size:", aws.StringValue(result.ContentLength))
fmt.Println("Object Size:", aws.Int64Value(result.ContentLength))
```
### API Request Pagination and Resource Waiters

View File

@ -5,11 +5,11 @@ import (
"fmt"
"io"
"io/ioutil"
"reflect"
"testing"
"time"
"github.com/aws/aws-sdk-go/aws/awsutil"
"github.com/stretchr/testify/assert"
)
func ExampleCopy() {
@ -81,12 +81,24 @@ func TestCopy1(t *testing.T) {
awsutil.Copy(&f2, f1)
// Values are equal
assert.Equal(t, f2.A, f1.A)
assert.Equal(t, f2.B, f1.B)
assert.Equal(t, f2.C, f1.C)
assert.Equal(t, f2.D, f1.D)
assert.Equal(t, f2.E.B, f1.E.B)
assert.Equal(t, f2.E.D, f1.E.D)
if v1, v2 := f2.A, f1.A; v1 != v2 {
t.Errorf("expected values to be equivalent but received %v and %v", v1, v2)
}
if v1, v2 := f2.B, f1.B; !reflect.DeepEqual(v1, v2) {
t.Errorf("expected values to be equivalent but received %v and %v", v1, v2)
}
if v1, v2 := f2.C, f1.C; !reflect.DeepEqual(v1, v2) {
t.Errorf("expected values to be equivalent but received %v and %v", v1, v2)
}
if v1, v2 := f2.D, f1.D; !v1.Equal(*v2) {
t.Errorf("expected values to be equivalent but received %v and %v", v1, v2)
}
if v1, v2 := f2.E.B, f1.E.B; !reflect.DeepEqual(v1, v2) {
t.Errorf("expected values to be equivalent but received %v and %v", v1, v2)
}
if v1, v2 := f2.E.D, f1.E.D; v1 != v2 {
t.Errorf("expected values to be equivalent but received %v and %v", v1, v2)
}
// But pointers are not!
str3 := "nothello"
@ -99,14 +111,30 @@ func TestCopy1(t *testing.T) {
*f2.E.B = int3
f2.E.c = 5
f2.E.D = 5
assert.NotEqual(t, f2.A, f1.A)
assert.NotEqual(t, f2.B, f1.B)
assert.NotEqual(t, f2.C, f1.C)
assert.NotEqual(t, f2.D, f1.D)
assert.NotEqual(t, f2.E.a, f1.E.a)
assert.NotEqual(t, f2.E.B, f1.E.B)
assert.NotEqual(t, f2.E.c, f1.E.c)
assert.NotEqual(t, f2.E.D, f1.E.D)
if v1, v2 := f2.A, f1.A; v1 == v2 {
t.Errorf("expected values to be not equivalent, but received %v", v1)
}
if v1, v2 := f2.B, f1.B; reflect.DeepEqual(v1, v2) {
t.Errorf("expected values to be not equivalent, but received %v", v1)
}
if v1, v2 := f2.C, f1.C; reflect.DeepEqual(v1, v2) {
t.Errorf("expected values to be not equivalent, but received %v", v1)
}
if v1, v2 := f2.D, f1.D; v1 == v2 {
t.Errorf("expected values to be not equivalent, but received %v", v1)
}
if v1, v2 := f2.E.a, f1.E.a; v1 == v2 {
t.Errorf("expected values to be not equivalent, but received %v", v1)
}
if v1, v2 := f2.E.B, f1.E.B; v1 == v2 {
t.Errorf("expected values to be not equivalent, but received %v", v1)
}
if v1, v2 := f2.E.c, f1.E.c; v1 == v2 {
t.Errorf("expected values to be not equivalent, but received %v", v1)
}
if v1, v2 := f2.E.D, f1.E.D; v1 == v2 {
t.Errorf("expected values to be not equivalent, but received %v", v1)
}
}
func TestCopyNestedWithUnexported(t *testing.T) {
@ -125,10 +153,18 @@ func TestCopyNestedWithUnexported(t *testing.T) {
awsutil.Copy(&f2, f1)
// Values match
assert.Equal(t, f2.A, f1.A)
assert.NotEqual(t, f2.B, f1.B)
assert.NotEqual(t, f2.B.a, f1.B.a)
assert.Equal(t, f2.B.B, f2.B.B)
if v1, v2 := f2.A, f1.A; v1 != v2 {
t.Errorf("expected values to be equivalent but received %v and %v", v1, v2)
}
if v1, v2 := f2.B, f1.B; v1 == v2 {
t.Errorf("expected values to be not equivalent, but received %v", v1)
}
if v1, v2 := f2.B.a, f1.B.a; v1 == v2 {
t.Errorf("expected values to be not equivalent, but received %v", v1)
}
if v1, v2 := f2.B.B, f2.B.B; v1 != v2 {
t.Errorf("expected values to be equivalent but received %v and %v", v1, v2)
}
}
func TestCopyIgnoreNilMembers(t *testing.T) {
@ -139,34 +175,56 @@ func TestCopyIgnoreNilMembers(t *testing.T) {
}
f := &Foo{}
assert.Nil(t, f.A)
assert.Nil(t, f.B)
assert.Nil(t, f.C)
if v1 := f.A; v1 != nil {
t.Errorf("expected nil, but received %v", v1)
}
if v1 := f.B; v1 != nil {
t.Errorf("expected nil, but received %v", v1)
}
if v1 := f.C; v1 != nil {
t.Errorf("expected nil, but received %v", v1)
}
var f2 Foo
awsutil.Copy(&f2, f)
assert.Nil(t, f2.A)
assert.Nil(t, f2.B)
assert.Nil(t, f2.C)
if v1 := f2.A; v1 != nil {
t.Errorf("expected nil, but received %v", v1)
}
if v1 := f2.B; v1 != nil {
t.Errorf("expected nil, but received %v", v1)
}
if v1 := f2.C; v1 != nil {
t.Errorf("expected nil, but received %v", v1)
}
fcopy := awsutil.CopyOf(f)
f3 := fcopy.(*Foo)
assert.Nil(t, f3.A)
assert.Nil(t, f3.B)
assert.Nil(t, f3.C)
if v1 := f3.A; v1 != nil {
t.Errorf("expected nil, but received %v", v1)
}
if v1 := f3.B; v1 != nil {
t.Errorf("expected nil, but received %v", v1)
}
if v1 := f3.C; v1 != nil {
t.Errorf("expected nil, but received %v", v1)
}
}
func TestCopyPrimitive(t *testing.T) {
str := "hello"
var s string
awsutil.Copy(&s, &str)
assert.Equal(t, "hello", s)
if v1, v2 := "hello", s; v1 != v2 {
t.Errorf("expected values to be equivalent but received %v and %v", v1, v2)
}
}
func TestCopyNil(t *testing.T) {
var s string
awsutil.Copy(&s, nil)
assert.Equal(t, "", s)
if v1, v2 := "", s; v1 != v2 {
t.Errorf("expected values to be equivalent but received %v and %v", v1, v2)
}
}
func TestCopyReader(t *testing.T) {
@ -174,13 +232,21 @@ func TestCopyReader(t *testing.T) {
var r io.Reader
awsutil.Copy(&r, buf)
b, err := ioutil.ReadAll(r)
assert.NoError(t, err)
assert.Equal(t, []byte("hello world"), b)
if err != nil {
t.Errorf("expected no error, but received %v", err)
}
if v1, v2 := []byte("hello world"), b; !bytes.Equal(v1, v2) {
t.Errorf("expected values to be equivalent but received %v and %v", v1, v2)
}
// empty bytes because this is not a deep copy
b, err = ioutil.ReadAll(buf)
assert.NoError(t, err)
assert.Equal(t, []byte(""), b)
if err != nil {
t.Errorf("expected no error, but received %v", err)
}
if v1, v2 := []byte(""), b; !bytes.Equal(v1, v2) {
t.Errorf("expected values to be equivalent but received %v and %v", v1, v2)
}
}
func TestCopyDifferentStructs(t *testing.T) {
@ -226,17 +292,39 @@ func TestCopyDifferentStructs(t *testing.T) {
awsutil.Copy(&f2, f1)
// Values are equal
assert.Equal(t, f2.A, f1.A)
assert.Equal(t, f2.B, f1.B)
assert.Equal(t, f2.C, f1.C)
assert.Equal(t, "unique", f1.SrcUnique)
assert.Equal(t, 1, f1.SameNameDiffType)
assert.Equal(t, 0, f2.DstUnique)
assert.Equal(t, "", f2.SameNameDiffType)
assert.Equal(t, int1, *f1.unexportedPtr)
assert.Nil(t, f2.unexportedPtr)
assert.Equal(t, int2, *f1.ExportedPtr)
assert.Equal(t, int2, *f2.ExportedPtr)
if v1, v2 := f2.A, f1.A; v1 != v2 {
t.Errorf("expected values to be equivalent but received %v and %v", v1, v2)
}
if v1, v2 := f2.B, f1.B; !reflect.DeepEqual(v1, v2) {
t.Errorf("expected values to be equivalent but received %v and %v", v1, v2)
}
if v1, v2 := f2.C, f1.C; !reflect.DeepEqual(v1, v2) {
t.Errorf("expected values to be equivalent but received %v and %v", v1, v2)
}
if v1, v2 := "unique", f1.SrcUnique; v1 != v2 {
t.Errorf("expected values to be equivalent but received %v and %v", v1, v2)
}
if v1, v2 := 1, f1.SameNameDiffType; v1 != v2 {
t.Errorf("expected values to be equivalent but received %v and %v", v1, v2)
}
if v1, v2 := 0, f2.DstUnique; v1 != v2 {
t.Errorf("expected values to be equivalent but received %v and %v", v1, v2)
}
if v1, v2 := "", f2.SameNameDiffType; v1 != v2 {
t.Errorf("expected values to be equivalent but received %v and %v", v1, v2)
}
if v1, v2 := int1, *f1.unexportedPtr; v1 != v2 {
t.Errorf("expected values to be equivalent but received %v and %v", v1, v2)
}
if v1 := f2.unexportedPtr; v1 != nil {
t.Errorf("expected nil, but received %v", v1)
}
if v1, v2 := int2, *f1.ExportedPtr; v1 != v2 {
t.Errorf("expected values to be equivalent but received %v and %v", v1, v2)
}
if v1, v2 := int2, *f2.ExportedPtr; v1 != v2 {
t.Errorf("expected values to be equivalent but received %v and %v", v1, v2)
}
}
func ExampleCopyOf() {

View File

@ -5,7 +5,6 @@ import (
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/awsutil"
"github.com/stretchr/testify/assert"
)
func TestDeepEqual(t *testing.T) {
@ -24,6 +23,8 @@ func TestDeepEqual(t *testing.T) {
}
for i, c := range cases {
assert.Equal(t, c.equal, awsutil.DeepEqual(c.a, c.b), "%d, a:%v b:%v, %t", i, c.a, c.b, c.equal)
if awsutil.DeepEqual(c.a, c.b) != c.equal {
t.Errorf("%d, a:%v b:%v, %t", i, c.a, c.b, c.equal)
}
}
}

View File

@ -1,10 +1,10 @@
package awsutil_test
import (
"strings"
"testing"
"github.com/aws/aws-sdk-go/aws/awsutil"
"github.com/stretchr/testify/assert"
)
type Struct struct {
@ -50,8 +50,12 @@ func TestValueAtPathSuccess(t *testing.T) {
}
for i, c := range testCases {
v, err := awsutil.ValuesAtPath(c.data, c.path)
assert.NoError(t, err, "case %d, expected no error, %s", i, c.path)
assert.Equal(t, c.expect, v, "case %d, %s", i, c.path)
if err != nil {
t.Errorf("case %v, expected no error, %v", i, c.path)
}
if e, a := c.expect, v; !awsutil.DeepEqual(e, a) {
t.Errorf("case %v, %v", i, c.path)
}
}
}
@ -78,12 +82,18 @@ func TestValueAtPathFailure(t *testing.T) {
for i, c := range testCases {
v, err := awsutil.ValuesAtPath(c.data, c.path)
if c.errContains != "" {
assert.Contains(t, err.Error(), c.errContains, "case %d, expected error, %s", i, c.path)
if !strings.Contains(err.Error(), c.errContains) {
t.Errorf("case %v, expected error, %v", i, c.path)
}
continue
} else {
assert.NoError(t, err, "case %d, expected no error, %s", i, c.path)
if err != nil {
t.Errorf("case %v, expected no error, %v", i, c.path)
}
}
if e, a := c.expect, v; !awsutil.DeepEqual(e, a) {
t.Errorf("case %v, %v", i, c.path)
}
assert.Equal(t, c.expect, v, "case %d, %s", i, c.path)
}
}
@ -92,51 +102,81 @@ func TestSetValueAtPathSuccess(t *testing.T) {
awsutil.SetValueAtPath(&s, "C", "test1")
awsutil.SetValueAtPath(&s, "B.B.C", "test2")
awsutil.SetValueAtPath(&s, "B.D.C", "test3")
assert.Equal(t, "test1", s.C)
assert.Equal(t, "test2", s.B.B.C)
assert.Equal(t, "test3", s.B.D.C)
if e, a := "test1", s.C; e != a {
t.Errorf("expected %v, but received %v", e, a)
}
if e, a := "test2", s.B.B.C; e != a {
t.Errorf("expected %v, but received %v", e, a)
}
if e, a := "test3", s.B.D.C; e != a {
t.Errorf("expected %v, but received %v", e, a)
}
awsutil.SetValueAtPath(&s, "B.*.C", "test0")
assert.Equal(t, "test0", s.B.B.C)
assert.Equal(t, "test0", s.B.D.C)
if e, a := "test0", s.B.B.C; e != a {
t.Errorf("expected %v, but received %v", e, a)
}
if e, a := "test0", s.B.D.C; e != a {
t.Errorf("expected %v, but received %v", e, a)
}
var s2 Struct
awsutil.SetValueAtPath(&s2, "b.b.c", "test0")
assert.Equal(t, "test0", s2.B.B.C)
if e, a := "test0", s2.B.B.C; e != a {
t.Errorf("expected %v, but received %v", e, a)
}
awsutil.SetValueAtPath(&s2, "A", []Struct{{}})
assert.Equal(t, []Struct{{}}, s2.A)
if e, a := []Struct{{}}, s2.A; !awsutil.DeepEqual(e, a) {
t.Errorf("expected %v, but received %v", e, a)
}
str := "foo"
s3 := Struct{}
awsutil.SetValueAtPath(&s3, "b.b.c", str)
assert.Equal(t, "foo", s3.B.B.C)
if e, a := "foo", s3.B.B.C; e != a {
t.Errorf("expected %v, but received %v", e, a)
}
s3 = Struct{B: &Struct{B: &Struct{C: str}}}
awsutil.SetValueAtPath(&s3, "b.b.c", nil)
assert.Equal(t, "", s3.B.B.C)
if e, a := "", s3.B.B.C; e != a {
t.Errorf("expected %v, but received %v", e, a)
}
s3 = Struct{}
awsutil.SetValueAtPath(&s3, "b.b.c", nil)
assert.Equal(t, "", s3.B.B.C)
if e, a := "", s3.B.B.C; e != a {
t.Errorf("expected %v, but received %v", e, a)
}
s3 = Struct{}
awsutil.SetValueAtPath(&s3, "b.b.c", &str)
assert.Equal(t, "foo", s3.B.B.C)
if e, a := "foo", s3.B.B.C; e != a {
t.Errorf("expected %v, but received %v", e, a)
}
var s4 struct{ Name *string }
awsutil.SetValueAtPath(&s4, "Name", str)
assert.Equal(t, str, *s4.Name)
if e, a := str, *s4.Name; e != a {
t.Errorf("expected %v, but received %v", e, a)
}
s4 = struct{ Name *string }{}
awsutil.SetValueAtPath(&s4, "Name", nil)
assert.Equal(t, (*string)(nil), s4.Name)
if e, a := (*string)(nil), s4.Name; e != a {
t.Errorf("expected %v, but received %v", e, a)
}
s4 = struct{ Name *string }{Name: &str}
awsutil.SetValueAtPath(&s4, "Name", nil)
assert.Equal(t, (*string)(nil), s4.Name)
if e, a := (*string)(nil), s4.Name; e != a {
t.Errorf("expected %v, but received %v", e, a)
}
s4 = struct{ Name *string }{}
awsutil.SetValueAtPath(&s4, "Name", &str)
assert.Equal(t, str, *s4.Name)
if e, a := str, *s4.Name; e != a {
t.Errorf("expected %v, but received %v", e, a)
}
}

View File

@ -2,6 +2,7 @@ package client
import (
"math/rand"
"strconv"
"sync"
"time"
@ -38,14 +39,18 @@ func (d DefaultRetryer) RetryRules(r *request.Request) time.Duration {
minTime := 30
throttle := d.shouldThrottle(r)
if throttle {
if delay, ok := getRetryDelay(r); ok {
return delay
}
minTime = 500
}
retryCount := r.RetryCount
if retryCount > 13 {
retryCount = 13
} else if throttle && retryCount > 8 {
if throttle && retryCount > 8 {
retryCount = 8
} else if retryCount > 13 {
retryCount = 13
}
delay := (1 << uint(retryCount)) * (seededRand.Intn(minTime) + minTime)
@ -68,12 +73,49 @@ func (d DefaultRetryer) ShouldRetry(r *request.Request) bool {
// ShouldThrottle returns true if the request should be throttled.
func (d DefaultRetryer) shouldThrottle(r *request.Request) bool {
if r.HTTPResponse.StatusCode == 502 ||
r.HTTPResponse.StatusCode == 503 ||
r.HTTPResponse.StatusCode == 504 {
return true
switch r.HTTPResponse.StatusCode {
case 429:
case 502:
case 503:
case 504:
default:
return r.IsErrorThrottle()
}
return r.IsErrorThrottle()
return true
}
// This will look in the Retry-After header, RFC 7231, for how long
// it will wait before attempting another request
func getRetryDelay(r *request.Request) (time.Duration, bool) {
if !canUseRetryAfterHeader(r) {
return 0, false
}
delayStr := r.HTTPResponse.Header.Get("Retry-After")
if len(delayStr) == 0 {
return 0, false
}
delay, err := strconv.Atoi(delayStr)
if err != nil {
return 0, false
}
return time.Duration(delay) * time.Second, true
}
// Will look at the status code to see if the retry header pertains to
// the status code.
func canUseRetryAfterHeader(r *request.Request) bool {
switch r.HTTPResponse.StatusCode {
case 429:
case 503:
default:
return false
}
return true
}
// lockedSource is a thread-safe implementation of rand.Source

View File

@ -0,0 +1,189 @@
package client
import (
"net/http"
"testing"
"time"
"github.com/aws/aws-sdk-go/aws/request"
)
func TestRetryThrottleStatusCodes(t *testing.T) {
cases := []struct {
expectThrottle bool
expectRetry bool
r request.Request
}{
{
false,
false,
request.Request{
HTTPResponse: &http.Response{StatusCode: 200},
},
},
{
true,
true,
request.Request{
HTTPResponse: &http.Response{StatusCode: 429},
},
},
{
true,
true,
request.Request{
HTTPResponse: &http.Response{StatusCode: 502},
},
},
{
true,
true,
request.Request{
HTTPResponse: &http.Response{StatusCode: 503},
},
},
{
true,
true,
request.Request{
HTTPResponse: &http.Response{StatusCode: 504},
},
},
{
false,
true,
request.Request{
HTTPResponse: &http.Response{StatusCode: 500},
},
},
}
d := DefaultRetryer{NumMaxRetries: 10}
for i, c := range cases {
throttle := d.shouldThrottle(&c.r)
retry := d.ShouldRetry(&c.r)
if e, a := c.expectThrottle, throttle; e != a {
t.Errorf("%d: expected %v, but received %v", i, e, a)
}
if e, a := c.expectRetry, retry; e != a {
t.Errorf("%d: expected %v, but received %v", i, e, a)
}
}
}
func TestCanUseRetryAfter(t *testing.T) {
cases := []struct {
r request.Request
e bool
}{
{
request.Request{
HTTPResponse: &http.Response{StatusCode: 200},
},
false,
},
{
request.Request{
HTTPResponse: &http.Response{StatusCode: 500},
},
false,
},
{
request.Request{
HTTPResponse: &http.Response{StatusCode: 429},
},
true,
},
{
request.Request{
HTTPResponse: &http.Response{StatusCode: 503},
},
true,
},
}
for i, c := range cases {
a := canUseRetryAfterHeader(&c.r)
if c.e != a {
t.Errorf("%d: expected %v, but received %v", i, c.e, a)
}
}
}
func TestGetRetryDelay(t *testing.T) {
cases := []struct {
r request.Request
e time.Duration
equal bool
ok bool
}{
{
request.Request{
HTTPResponse: &http.Response{StatusCode: 429, Header: http.Header{"Retry-After": []string{"3600"}}},
},
3600 * time.Second,
true,
true,
},
{
request.Request{
HTTPResponse: &http.Response{StatusCode: 503, Header: http.Header{"Retry-After": []string{"120"}}},
},
120 * time.Second,
true,
true,
},
{
request.Request{
HTTPResponse: &http.Response{StatusCode: 503, Header: http.Header{"Retry-After": []string{"120"}}},
},
1 * time.Second,
false,
true,
},
{
request.Request{
HTTPResponse: &http.Response{StatusCode: 503, Header: http.Header{"Retry-After": []string{""}}},
},
0 * time.Second,
true,
false,
},
}
for i, c := range cases {
a, ok := getRetryDelay(&c.r)
if c.ok != ok {
t.Errorf("%d: expected %v, but received %v", i, c.ok, ok)
}
if (c.e != a) == c.equal {
t.Errorf("%d: expected %v, but received %v", i, c.e, a)
}
}
}
func TestRetryDelay(t *testing.T) {
r := request.Request{}
for i := 0; i < 100; i++ {
rTemp := r
rTemp.HTTPResponse = &http.Response{StatusCode: 500, Header: http.Header{"Retry-After": []string{""}}}
rTemp.RetryCount = i
a, _ := getRetryDelay(&rTemp)
if a > 5*time.Minute {
t.Errorf("retry delay should never be greater than five minutes, received %d", a)
}
}
for i := 0; i < 100; i++ {
rTemp := r
rTemp.RetryCount = i
rTemp.HTTPResponse = &http.Response{StatusCode: 503, Header: http.Header{"Retry-After": []string{""}}}
a, _ := getRetryDelay(&rTemp)
if a > 5*time.Minute {
t.Errorf("retry delay should never be greater than five minutes, received %d", a)
}
}
}

View File

@ -168,7 +168,7 @@ type Config struct {
//
EC2MetadataDisableTimeoutOverride *bool
// Instructs the endpiont to be generated for a service client to
// Instructs the endpoint to be generated for a service client to
// be the dual stack endpoint. The dual stack endpoint will support
// both IPv4 and IPv6 addressing.
//

View File

@ -9,6 +9,7 @@ package defaults
import (
"fmt"
"net"
"net/http"
"net/url"
"os"
@ -118,14 +119,43 @@ func RemoteCredProvider(cfg aws.Config, handlers request.Handlers) credentials.P
return ec2RoleProvider(cfg, handlers)
}
var lookupHostFn = net.LookupHost
func isLoopbackHost(host string) (bool, error) {
ip := net.ParseIP(host)
if ip != nil {
return ip.IsLoopback(), nil
}
// Host is not an ip, perform lookup
addrs, err := lookupHostFn(host)
if err != nil {
return false, err
}
for _, addr := range addrs {
if !net.ParseIP(addr).IsLoopback() {
return false, nil
}
}
return true, nil
}
func localHTTPCredProvider(cfg aws.Config, handlers request.Handlers, u string) credentials.Provider {
var errMsg string
parsed, err := url.Parse(u)
if err != nil {
errMsg = fmt.Sprintf("invalid URL, %v", err)
} else if host := aws.URLHostname(parsed); !(host == "localhost" || host == "127.0.0.1") {
errMsg = fmt.Sprintf("invalid host address, %q, only localhost and 127.0.0.1 are valid.", host)
} else {
host := aws.URLHostname(parsed)
if len(host) == 0 {
errMsg = "unable to parse host from local HTTP cred provider URL"
} else if isLoopback, loopbackErr := isLoopbackHost(host); loopbackErr != nil {
errMsg = fmt.Sprintf("failed to resolve host %q, %v", host, loopbackErr)
} else if !isLoopback {
errMsg = fmt.Sprintf("invalid endpoint host, %q, only loopback hosts are allowed.", host)
}
}
if len(errMsg) > 0 {

View File

@ -13,12 +13,40 @@ import (
)
func TestHTTPCredProvider(t *testing.T) {
origFn := lookupHostFn
defer func() { lookupHostFn = origFn }()
lookupHostFn = func(host string) ([]string, error) {
m := map[string]struct {
Addrs []string
Err error
}{
"localhost": {Addrs: []string{"::1", "127.0.0.1"}},
"actuallylocal": {Addrs: []string{"127.0.0.2"}},
"notlocal": {Addrs: []string{"::1", "127.0.0.1", "192.168.1.10"}},
"www.example.com": {Addrs: []string{"10.10.10.10"}},
}
h, ok := m[host]
if !ok {
t.Fatalf("unknown host in test, %v", host)
return nil, fmt.Errorf("unknown host")
}
return h.Addrs, h.Err
}
cases := []struct {
Host string
Fail bool
}{
{"localhost", false}, {"127.0.0.1", false},
{"www.example.com", true}, {"169.254.170.2", true},
{"localhost", false},
{"actuallylocal", false},
{"127.0.0.1", false},
{"127.1.1.1", false},
{"[::1]", false},
{"www.example.com", true},
{"169.254.170.2", true},
}
defer os.Clearenv()

View File

@ -24,6 +24,7 @@ const (
EuCentral1RegionID = "eu-central-1" // EU (Frankfurt).
EuWest1RegionID = "eu-west-1" // EU (Ireland).
EuWest2RegionID = "eu-west-2" // EU (London).
EuWest3RegionID = "eu-west-3" // EU (Paris).
SaEast1RegionID = "sa-east-1" // South America (Sao Paulo).
UsEast1RegionID = "us-east-1" // US East (N. Virginia).
UsEast2RegionID = "us-east-2" // US East (Ohio).
@ -33,7 +34,8 @@ const (
// AWS China partition's regions.
const (
CnNorth1RegionID = "cn-north-1" // China (Beijing).
CnNorth1RegionID = "cn-north-1" // China (Beijing).
CnNorthwest1RegionID = "cn-northwest-1" // China (Ningxia).
)
// AWS GovCloud (US) partition's regions.
@ -44,6 +46,7 @@ const (
// Service identifiers
const (
AcmServiceID = "acm" // Acm.
ApiPricingServiceID = "api.pricing" // ApiPricing.
ApigatewayServiceID = "apigateway" // Apigateway.
ApplicationAutoscalingServiceID = "application-autoscaling" // ApplicationAutoscaling.
Appstream2ServiceID = "appstream2" // Appstream2.
@ -69,6 +72,7 @@ const (
ConfigServiceID = "config" // Config.
CurServiceID = "cur" // Cur.
DatapipelineServiceID = "datapipeline" // Datapipeline.
DaxServiceID = "dax" // Dax.
DevicefarmServiceID = "devicefarm" // Devicefarm.
DirectconnectServiceID = "directconnect" // Directconnect.
DiscoveryServiceID = "discovery" // Discovery.
@ -220,6 +224,9 @@ var awsPartition = partition{
"eu-west-2": region{
Description: "EU (London)",
},
"eu-west-3": region{
Description: "EU (Paris)",
},
"sa-east-1": region{
Description: "South America (Sao Paulo)",
},
@ -249,6 +256,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -256,6 +264,17 @@ var awsPartition = partition{
"us-west-2": endpoint{},
},
},
"api.pricing": service{
Defaults: endpoint{
CredentialScope: credentialScope{
Service: "pricing",
},
},
Endpoints: endpoints{
"ap-south-1": endpoint{},
"us-east-1": endpoint{},
},
},
"apigateway": service{
Endpoints: endpoints{
@ -268,6 +287,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -293,6 +313,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -319,6 +340,8 @@ var awsPartition = partition{
Endpoints: endpoints{
"ap-northeast-1": endpoint{},
"ap-southeast-1": endpoint{},
"ap-southeast-2": endpoint{},
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -339,6 +362,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -397,6 +421,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -436,10 +461,17 @@ var awsPartition = partition{
"cloudhsmv2": service{
Endpoints: endpoints{
"eu-west-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
"us-west-2": endpoint{},
"ap-northeast-1": endpoint{},
"ap-south-1": endpoint{},
"ap-southeast-1": endpoint{},
"ap-southeast-2": endpoint{},
"ca-central-1": endpoint{},
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
"us-west-1": endpoint{},
"us-west-2": endpoint{},
},
},
"cloudsearch": service{
@ -469,6 +501,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -480,6 +513,7 @@ var awsPartition = partition{
Endpoints: endpoints{
"ap-northeast-1": endpoint{},
"ap-northeast-2": endpoint{},
"ap-southeast-1": endpoint{},
"ap-southeast-2": endpoint{},
"ca-central-1": endpoint{},
@ -523,6 +557,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -552,8 +587,10 @@ var awsPartition = partition{
"codestar": service{
Endpoints: endpoints{
"ap-northeast-1": endpoint{},
"ap-southeast-1": endpoint{},
"ap-southeast-2": endpoint{},
"ca-central-1": endpoint{},
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
@ -623,6 +660,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -646,6 +684,18 @@ var awsPartition = partition{
"us-west-2": endpoint{},
},
},
"dax": service{
Endpoints: endpoints{
"ap-northeast-1": endpoint{},
"ap-south-1": endpoint{},
"eu-west-1": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-west-1": endpoint{},
"us-west-2": endpoint{},
},
},
"devicefarm": service{
Endpoints: endpoints{
@ -664,6 +714,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -689,6 +740,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -701,6 +753,7 @@ var awsPartition = partition{
Endpoints: endpoints{
"ap-northeast-1": endpoint{},
"ap-northeast-2": endpoint{},
"ap-south-1": endpoint{},
"ap-southeast-1": endpoint{},
"ap-southeast-2": endpoint{},
"ca-central-1": endpoint{},
@ -710,6 +763,7 @@ var awsPartition = partition{
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
"us-west-1": endpoint{},
"us-west-2": endpoint{},
},
},
@ -727,6 +781,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"local": endpoint{
Hostname: "localhost:8000",
Protocols: []string{"http"},
@ -755,6 +810,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -777,12 +833,16 @@ var awsPartition = partition{
Endpoints: endpoints{
"ap-northeast-1": endpoint{},
"ap-northeast-2": endpoint{},
"ap-south-1": endpoint{},
"ap-southeast-1": endpoint{},
"ap-southeast-2": endpoint{},
"ca-central-1": endpoint{},
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
"us-west-1": endpoint{},
@ -793,12 +853,16 @@ var awsPartition = partition{
Endpoints: endpoints{
"ap-northeast-1": endpoint{},
"ap-northeast-2": endpoint{},
"ap-south-1": endpoint{},
"ap-southeast-1": endpoint{},
"ap-southeast-2": endpoint{},
"ca-central-1": endpoint{},
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
"us-west-1": endpoint{},
@ -817,6 +881,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -836,6 +901,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -868,6 +934,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -892,6 +959,7 @@ var awsPartition = partition{
},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{
SSLCommonName: "{service}.{region}.{dnsSuffix}",
@ -944,6 +1012,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -963,6 +1032,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -1014,6 +1084,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
"us-west-1": endpoint{},
@ -1023,6 +1094,7 @@ var awsPartition = partition{
"glue": service{
Endpoints: endpoints{
"eu-west-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
"us-west-2": endpoint{},
@ -1082,6 +1154,7 @@ var awsPartition = partition{
"ap-northeast-2": endpoint{},
"ap-south-1": endpoint{},
"ap-southeast-2": endpoint{},
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"us-east-1": endpoint{},
"us-west-1": endpoint{},
@ -1119,6 +1192,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -1146,6 +1220,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -1165,6 +1240,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -1199,6 +1275,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -1278,6 +1355,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -1306,6 +1384,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -1347,10 +1426,21 @@ var awsPartition = partition{
"polly": service{
Endpoints: endpoints{
"eu-west-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
"us-west-2": endpoint{},
"ap-northeast-1": endpoint{},
"ap-northeast-2": endpoint{},
"ap-south-1": endpoint{},
"ap-southeast-1": endpoint{},
"ap-southeast-2": endpoint{},
"ca-central-1": endpoint{},
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
"us-west-1": endpoint{},
"us-west-2": endpoint{},
},
},
"rds": service{
@ -1365,6 +1455,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{
SSLCommonName: "{service}.{dnsSuffix}",
@ -1386,6 +1477,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -1427,6 +1519,7 @@ var awsPartition = partition{
},
},
Endpoints: endpoints{
"eu-west-1": endpoint{},
"us-east-1": endpoint{},
},
},
@ -1442,26 +1535,27 @@ var awsPartition = partition{
},
Endpoints: endpoints{
"ap-northeast-1": endpoint{
Hostname: "s3-ap-northeast-1.amazonaws.com",
Hostname: "s3.ap-northeast-1.amazonaws.com",
SignatureVersions: []string{"s3", "s3v4"},
},
"ap-northeast-2": endpoint{},
"ap-south-1": endpoint{},
"ap-southeast-1": endpoint{
Hostname: "s3-ap-southeast-1.amazonaws.com",
Hostname: "s3.ap-southeast-1.amazonaws.com",
SignatureVersions: []string{"s3", "s3v4"},
},
"ap-southeast-2": endpoint{
Hostname: "s3-ap-southeast-2.amazonaws.com",
Hostname: "s3.ap-southeast-2.amazonaws.com",
SignatureVersions: []string{"s3", "s3v4"},
},
"ca-central-1": endpoint{},
"eu-central-1": endpoint{},
"eu-west-1": endpoint{
Hostname: "s3-eu-west-1.amazonaws.com",
Hostname: "s3.eu-west-1.amazonaws.com",
SignatureVersions: []string{"s3", "s3v4"},
},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"s3-external-1": endpoint{
Hostname: "s3-external-1.amazonaws.com",
SignatureVersions: []string{"s3", "s3v4"},
@ -1470,7 +1564,7 @@ var awsPartition = partition{
},
},
"sa-east-1": endpoint{
Hostname: "s3-sa-east-1.amazonaws.com",
Hostname: "s3.sa-east-1.amazonaws.com",
SignatureVersions: []string{"s3", "s3v4"},
},
"us-east-1": endpoint{
@ -1479,11 +1573,11 @@ var awsPartition = partition{
},
"us-east-2": endpoint{},
"us-west-1": endpoint{
Hostname: "s3-us-west-1.amazonaws.com",
Hostname: "s3.us-west-1.amazonaws.com",
SignatureVersions: []string{"s3", "s3v4"},
},
"us-west-2": endpoint{
Hostname: "s3-us-west-2.amazonaws.com",
Hostname: "s3.us-west-2.amazonaws.com",
SignatureVersions: []string{"s3", "s3v4"},
},
},
@ -1511,14 +1605,18 @@ var awsPartition = partition{
Endpoints: endpoints{
"ap-northeast-1": endpoint{},
"ap-northeast-2": endpoint{},
"ap-south-1": endpoint{},
"ap-southeast-1": endpoint{},
"ap-southeast-2": endpoint{},
"ca-central-1": endpoint{},
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
"us-west-1": endpoint{},
"us-west-2": endpoint{},
},
},
@ -1539,10 +1637,13 @@ var awsPartition = partition{
"ap-northeast-2": endpoint{},
"ap-south-1": endpoint{},
"ap-southeast-2": endpoint{},
"ca-central-1": endpoint{},
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-3": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
"us-west-1": endpoint{},
"us-west-2": endpoint{},
},
},
@ -1555,6 +1656,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -1576,6 +1678,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -1598,6 +1701,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{
SSLCommonName: "queue.{dnsSuffix}",
@ -1619,6 +1723,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -1651,6 +1756,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -1675,6 +1781,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"local": endpoint{
Hostname: "localhost:8000",
Protocols: []string{"http"},
@ -1713,6 +1820,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-1-fips": endpoint{
@ -1762,6 +1870,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -1881,8 +1990,17 @@ var awscnPartition = partition{
"cn-north-1": region{
Description: "China (Beijing)",
},
"cn-northwest-1": region{
Description: "China (Ningxia)",
},
},
Services: services{
"apigateway": service{
Endpoints: endpoints{
"cn-north-1": endpoint{},
},
},
"application-autoscaling": service{
Defaults: endpoint{
Hostname: "autoscaling.{region}.amazonaws.com",
@ -1892,7 +2010,8 @@ var awscnPartition = partition{
},
},
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"autoscaling": service{
@ -1900,23 +2019,33 @@ var awscnPartition = partition{
Protocols: []string{"http", "https"},
},
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"cloudformation": service{
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"cloudtrail": service{
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"codedeploy": service{
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"cognito-identity": service{
Endpoints: endpoints{
"cn-north-1": endpoint{},
},
@ -1924,13 +2053,15 @@ var awscnPartition = partition{
"config": service{
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"directconnect": service{
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"dynamodb": service{
@ -1938,7 +2069,8 @@ var awscnPartition = partition{
Protocols: []string{"http", "https"},
},
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"ec2": service{
@ -1946,7 +2078,8 @@ var awscnPartition = partition{
Protocols: []string{"http", "https"},
},
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"ec2metadata": service{
@ -1975,13 +2108,15 @@ var awscnPartition = partition{
"elasticache": service{
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"elasticbeanstalk": service{
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"elasticloadbalancing": service{
@ -1989,7 +2124,8 @@ var awscnPartition = partition{
Protocols: []string{"https"},
},
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"elasticmapreduce": service{
@ -1997,13 +2133,21 @@ var awscnPartition = partition{
Protocols: []string{"http", "https"},
},
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"es": service{
Endpoints: endpoints{
"cn-northwest-1": endpoint{},
},
},
"events": service{
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"glacier": service{
@ -2011,7 +2155,8 @@ var awscnPartition = partition{
Protocols: []string{"http", "https"},
},
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"iam": service{
@ -2039,6 +2184,13 @@ var awscnPartition = partition{
},
"kinesis": service{
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"lambda": service{
Endpoints: endpoints{
"cn-north-1": endpoint{},
},
@ -2046,7 +2198,8 @@ var awscnPartition = partition{
"logs": service{
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"monitoring": service{
@ -2054,19 +2207,22 @@ var awscnPartition = partition{
Protocols: []string{"http", "https"},
},
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"rds": service{
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"redshift": service{
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"s3": service{
@ -2075,7 +2231,8 @@ var awscnPartition = partition{
SignatureVersions: []string{"s3v4"},
},
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"snowball": service{
@ -2089,7 +2246,8 @@ var awscnPartition = partition{
Protocols: []string{"http", "https"},
},
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"sqs": service{
@ -2098,13 +2256,15 @@ var awscnPartition = partition{
Protocols: []string{"http", "https"},
},
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"ssm": service{
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"storagegateway": service{
@ -2121,19 +2281,22 @@ var awscnPartition = partition{
},
},
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"sts": service{
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"swf": service{
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"tagging": service{
@ -2227,10 +2390,22 @@ var awsusgovPartition = partition{
"us-gov-west-1": endpoint{},
},
},
"dms": service{
Endpoints: endpoints{
"us-gov-west-1": endpoint{},
},
},
"dynamodb": service{
Endpoints: endpoints{
"us-gov-west-1": endpoint{},
"us-gov-west-1-fips": endpoint{
Hostname: "dynamodb.us-gov-west-1.amazonaws.com",
CredentialScope: credentialScope{
Region: "us-gov-west-1",
},
},
},
},
"ec2": service{
@ -2256,6 +2431,12 @@ var awsusgovPartition = partition{
"us-gov-west-1": endpoint{},
},
},
"elasticbeanstalk": service{
Endpoints: endpoints{
"us-gov-west-1": endpoint{},
},
},
"elasticloadbalancing": service{
Endpoints: endpoints{
@ -2359,7 +2540,7 @@ var awsusgovPartition = partition{
},
},
"us-gov-west-1": endpoint{
Hostname: "s3-us-gov-west-1.amazonaws.com",
Hostname: "s3.us-gov-west-1.amazonaws.com",
Protocols: []string{"http", "https"},
},
},
@ -2407,6 +2588,12 @@ var awsusgovPartition = partition{
},
Endpoints: endpoints{
"us-gov-west-1": endpoint{},
"us-gov-west-1-fips": endpoint{
Hostname: "dynamodb.us-gov-west-1.amazonaws.com",
CredentialScope: credentialScope{
Region: "us-gov-west-1",
},
},
},
},
"sts": service{

View File

@ -28,6 +28,10 @@ const (
// during body reads.
ErrCodeResponseTimeout = "ResponseTimeout"
// ErrCodeInvalidPresignExpire is returned when the expire time provided to
// presign is invalid
ErrCodeInvalidPresignExpire = "InvalidPresignExpireError"
// CanceledErrorCode is the error code that will be returned by an
// API request that was canceled. Requests given a aws.Context may
// return this error when canceled.
@ -42,7 +46,6 @@ type Request struct {
Retryer
Time time.Time
ExpireTime time.Duration
Operation *Operation
HTTPRequest *http.Request
HTTPResponse *http.Response
@ -60,6 +63,11 @@ type Request struct {
LastSignedAt time.Time
DisableFollowRedirects bool
// A value greater than 0 instructs the request to be signed as Presigned URL
// You should not set this field directly. Instead use Request's
// Presign or PresignRequest methods.
ExpireTime time.Duration
context aws.Context
built bool
@ -104,6 +112,8 @@ func New(cfg aws.Config, clientInfo metadata.ClientInfo, handlers Handlers,
err = awserr.New("InvalidEndpointURL", "invalid endpoint uri", err)
}
SanitizeHostForHeader(httpReq)
r := &Request{
Config: cfg,
ClientInfo: clientInfo,
@ -250,40 +260,59 @@ func (r *Request) SetReaderBody(reader io.ReadSeeker) {
// Presign returns the request's signed URL. Error will be returned
// if the signing fails.
func (r *Request) Presign(expireTime time.Duration) (string, error) {
r.ExpireTime = expireTime
//
// It is invalid to create a presigned URL with a expire duration 0 or less. An
// error is returned if expire duration is 0 or less.
func (r *Request) Presign(expire time.Duration) (string, error) {
r = r.copy()
// Presign requires all headers be hoisted. There is no way to retrieve
// the signed headers not hoisted without this. Making the presigned URL
// useless.
r.NotHoist = false
if r.Operation.BeforePresignFn != nil {
r = r.copy()
err := r.Operation.BeforePresignFn(r)
if err != nil {
return "", err
}
}
r.Sign()
if r.Error != nil {
return "", r.Error
}
return r.HTTPRequest.URL.String(), nil
u, _, err := getPresignedURL(r, expire)
return u, err
}
// PresignRequest behaves just like presign, with the addition of returning a
// set of headers that were signed.
//
// It is invalid to create a presigned URL with a expire duration 0 or less. An
// error is returned if expire duration is 0 or less.
//
// Returns the URL string for the API operation with signature in the query string,
// and the HTTP headers that were included in the signature. These headers must
// be included in any HTTP request made with the presigned URL.
//
// To prevent hoisting any headers to the query string set NotHoist to true on
// this Request value prior to calling PresignRequest.
func (r *Request) PresignRequest(expireTime time.Duration) (string, http.Header, error) {
r.ExpireTime = expireTime
r.Sign()
if r.Error != nil {
return "", nil, r.Error
func (r *Request) PresignRequest(expire time.Duration) (string, http.Header, error) {
r = r.copy()
return getPresignedURL(r, expire)
}
func getPresignedURL(r *Request, expire time.Duration) (string, http.Header, error) {
if expire <= 0 {
return "", nil, awserr.New(
ErrCodeInvalidPresignExpire,
"presigned URL requires an expire duration greater than 0",
nil,
)
}
r.ExpireTime = expire
if r.Operation.BeforePresignFn != nil {
if err := r.Operation.BeforePresignFn(r); err != nil {
return "", nil, err
}
}
if err := r.Sign(); err != nil {
return "", nil, err
}
return r.HTTPRequest.URL.String(), r.SignedHeaderVals, nil
}
@ -579,3 +608,72 @@ func shouldRetryCancel(r *Request) bool {
errStr != "net/http: request canceled while waiting for connection")
}
// SanitizeHostForHeader removes default port from host and updates request.Host
func SanitizeHostForHeader(r *http.Request) {
host := getHost(r)
port := portOnly(host)
if port != "" && isDefaultPort(r.URL.Scheme, port) {
r.Host = stripPort(host)
}
}
// Returns host from request
func getHost(r *http.Request) string {
if r.Host != "" {
return r.Host
}
return r.URL.Host
}
// Hostname returns u.Host, without any port number.
//
// If Host is an IPv6 literal with a port number, Hostname returns the
// IPv6 literal without the square brackets. IPv6 literals may include
// a zone identifier.
//
// Copied from the Go 1.8 standard library (net/url)
func stripPort(hostport string) string {
colon := strings.IndexByte(hostport, ':')
if colon == -1 {
return hostport
}
if i := strings.IndexByte(hostport, ']'); i != -1 {
return strings.TrimPrefix(hostport[:i], "[")
}
return hostport[:colon]
}
// Port returns the port part of u.Host, without the leading colon.
// If u.Host doesn't contain a port, Port returns an empty string.
//
// Copied from the Go 1.8 standard library (net/url)
func portOnly(hostport string) string {
colon := strings.IndexByte(hostport, ':')
if colon == -1 {
return ""
}
if i := strings.Index(hostport, "]:"); i != -1 {
return hostport[i+len("]:"):]
}
if strings.Contains(hostport, "]") {
return ""
}
return hostport[colon+len(":"):]
}
// Returns true if the specified URI is using the standard port
// (i.e. port 80 for HTTP URIs or 443 for HTTPS URIs)
func isDefaultPort(scheme, port string) bool {
if port == "" {
return true
}
lowerCaseScheme := strings.ToLower(scheme)
if (lowerCaseScheme == "http" && port == "80") || (lowerCaseScheme == "https" && port == "443") {
return true
}
return false
}

View File

@ -8,9 +8,11 @@ import (
"io/ioutil"
"net/http"
"net/http/httptest"
"net/url"
"reflect"
"runtime"
"strconv"
"strings"
"testing"
"time"
@ -26,6 +28,7 @@ import (
"github.com/aws/aws-sdk-go/awstesting/unit"
"github.com/aws/aws-sdk-go/private/protocol/jsonrpc"
"github.com/aws/aws-sdk-go/private/protocol/rest"
"github.com/aws/aws-sdk-go/aws/defaults"
)
type testData struct {
@ -112,7 +115,8 @@ func TestRequestRecoverRetry4xxRetryable(t *testing.T) {
reqNum := 0
reqs := []http.Response{
{StatusCode: 400, Body: body(`{"__type":"Throttling","message":"Rate exceeded."}`)},
{StatusCode: 429, Body: body(`{"__type":"ProvisionedThroughputExceededException","message":"Rate exceeded."}`)},
{StatusCode: 400, Body: body(`{"__type":"ProvisionedThroughputExceededException","message":"Rate exceeded."}`)},
{StatusCode: 429, Body: body(`{"__type":"FooException","message":"Rate exceeded."}`)},
{StatusCode: 200, Body: body(`{"data":"valid"}`)},
}
@ -131,7 +135,7 @@ func TestRequestRecoverRetry4xxRetryable(t *testing.T) {
if err != nil {
t.Fatalf("expect no error, but got %v", err)
}
if e, a := 2, int(r.RetryCount); e != a {
if e, a := 3, int(r.RetryCount); e != a {
t.Errorf("expect %d retry count, got %d", e, a)
}
if e, a := "valid", out.Data; e != a {
@ -842,3 +846,159 @@ func TestRequest_TemporaryRetry(t *testing.T) {
t.Errorf("expect temporary error, was not")
}
}
func TestRequest_Presign(t *testing.T) {
presign := func(r *request.Request, expire time.Duration) (string, http.Header, error) {
u, err := r.Presign(expire)
return u, nil, err
}
presignRequest := func(r *request.Request, expire time.Duration) (string, http.Header, error) {
return r.PresignRequest(expire)
}
mustParseURL := func(v string) *url.URL {
u, err := url.Parse(v)
if err != nil {
panic(err)
}
return u
}
cases := []struct {
Expire time.Duration
PresignFn func(*request.Request, time.Duration) (string, http.Header, error)
SignerFn func(*request.Request)
URL string
Header http.Header
Err string
}{
{
PresignFn: presign,
Err: request.ErrCodeInvalidPresignExpire,
},
{
PresignFn: presignRequest,
Err: request.ErrCodeInvalidPresignExpire,
},
{
Expire: -1,
PresignFn: presign,
Err: request.ErrCodeInvalidPresignExpire,
},
{
// Presign clear NotHoist
Expire: 1 * time.Minute,
PresignFn: func(r *request.Request, dur time.Duration) (string, http.Header, error) {
r.NotHoist = true
return presign(r, dur)
},
SignerFn: func(r *request.Request) {
r.HTTPRequest.URL = mustParseURL("https://endpoint/presignedURL")
fmt.Println("url", r.HTTPRequest.URL.String())
if r.NotHoist {
r.Error = fmt.Errorf("expect NotHoist to be cleared")
}
},
URL: "https://endpoint/presignedURL",
},
{
// PresignRequest does not clear NotHoist
Expire: 1 * time.Minute,
PresignFn: func(r *request.Request, dur time.Duration) (string, http.Header, error) {
r.NotHoist = true
return presignRequest(r, dur)
},
SignerFn: func(r *request.Request) {
r.HTTPRequest.URL = mustParseURL("https://endpoint/presignedURL")
if !r.NotHoist {
r.Error = fmt.Errorf("expect NotHoist not to be cleared")
}
},
URL: "https://endpoint/presignedURL",
},
{
// PresignRequest returns signed headers
Expire: 1 * time.Minute,
PresignFn: presignRequest,
SignerFn: func(r *request.Request) {
r.HTTPRequest.URL = mustParseURL("https://endpoint/presignedURL")
r.HTTPRequest.Header.Set("UnsigndHeader", "abc")
r.SignedHeaderVals = http.Header{
"X-Amzn-Header": []string{"abc", "123"},
"X-Amzn-Header2": []string{"efg", "456"},
}
},
URL: "https://endpoint/presignedURL",
Header: http.Header{
"X-Amzn-Header": []string{"abc", "123"},
"X-Amzn-Header2": []string{"efg", "456"},
},
},
}
svc := awstesting.NewClient()
svc.Handlers.Clear()
for i, c := range cases {
req := svc.NewRequest(&request.Operation{
Name: "name", HTTPMethod: "GET", HTTPPath: "/path",
}, &struct{}{}, &struct{}{})
req.Handlers.Sign.PushBack(c.SignerFn)
u, h, err := c.PresignFn(req, c.Expire)
if len(c.Err) != 0 {
if e, a := c.Err, err.Error(); !strings.Contains(a, e) {
t.Errorf("%d, expect %v to be in %v", i, e, a)
}
continue
} else if err != nil {
t.Errorf("%d, expect no error, got %v", i, err)
continue
}
if e, a := c.URL, u; e != a {
t.Errorf("%d, expect %v URL, got %v", i, e, a)
}
if e, a := c.Header, h; !reflect.DeepEqual(e, a) {
t.Errorf("%d, expect %v header got %v", i, e, a)
}
}
}
func TestNew_EndpointWithDefaultPort(t *testing.T) {
endpoint := "https://estest.us-east-1.es.amazonaws.com:443"
expectedRequestHost := "estest.us-east-1.es.amazonaws.com"
r := request.New(
aws.Config{},
metadata.ClientInfo{Endpoint: endpoint},
defaults.Handlers(),
client.DefaultRetryer{},
&request.Operation{},
nil,
nil,
)
if h := r.HTTPRequest.Host; h != expectedRequestHost {
t.Errorf("expect %v host, got %q", expectedRequestHost, h)
}
}
func TestSanitizeHostForHeader(t *testing.T) {
cases := []struct {
url string
expectedRequestHost string
}{
{"https://estest.us-east-1.es.amazonaws.com:443", "estest.us-east-1.es.amazonaws.com"},
{"https://estest.us-east-1.es.amazonaws.com", "estest.us-east-1.es.amazonaws.com"},
{"https://localhost:9200", "localhost:9200"},
{"http://localhost:80", "localhost"},
{"http://localhost:8080", "localhost:8080"},
}
for _, c := range cases {
r, _ := http.NewRequest("GET", c.url, nil)
request.SanitizeHostForHeader(r)
if h := r.Host; h != c.expectedRequestHost {
t.Errorf("expect %v host, got %q", c.expectedRequestHost, h)
}
}
}

View File

@ -14,6 +14,7 @@ import (
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/credentials"
"github.com/aws/aws-sdk-go/aws/defaults"
"github.com/aws/aws-sdk-go/aws/endpoints"
"github.com/aws/aws-sdk-go/awstesting"
"github.com/aws/aws-sdk-go/service/s3"
)
@ -89,14 +90,31 @@ func TestSessionCopy(t *testing.T) {
}
func TestSessionClientConfig(t *testing.T) {
s, err := NewSession(&aws.Config{Region: aws.String("orig_region")})
s, err := NewSession(&aws.Config{
Credentials: credentials.AnonymousCredentials,
Region: aws.String("orig_region"),
EndpointResolver: endpoints.ResolverFunc(
func(service, region string, opts ...func(*endpoints.Options)) (endpoints.ResolvedEndpoint, error) {
if e, a := "mock-service", service; e != a {
t.Errorf("expect %q service, got %q", e, a)
}
if e, a := "other-region", region; e != a {
t.Errorf("expect %q region, got %q", e, a)
}
return endpoints.ResolvedEndpoint{
URL: "https://" + service + "." + region + ".amazonaws.com",
SigningRegion: region,
}, nil
},
),
})
assert.NoError(t, err)
cfg := s.ClientConfig("s3", &aws.Config{Region: aws.String("us-west-2")})
cfg := s.ClientConfig("mock-service", &aws.Config{Region: aws.String("other-region")})
assert.Equal(t, "https://s3-us-west-2.amazonaws.com", cfg.Endpoint)
assert.Equal(t, "us-west-2", cfg.SigningRegion)
assert.Equal(t, "us-west-2", *cfg.Config.Region)
assert.Equal(t, "https://mock-service.other-region.amazonaws.com", cfg.Endpoint)
assert.Equal(t, "other-region", cfg.SigningRegion)
assert.Equal(t, "other-region", *cfg.Config.Region)
}
func TestNewSession_NoCredentials(t *testing.T) {

View File

@ -10,7 +10,6 @@ import (
"github.com/aws/aws-sdk-go/aws/signer/v4"
"github.com/aws/aws-sdk-go/awstesting/unit"
"github.com/stretchr/testify/assert"
)
func TestStandaloneSign(t *testing.T) {
@ -22,7 +21,9 @@ func TestStandaloneSign(t *testing.T) {
c.SubDomain, c.Region, c.Service)
req, err := http.NewRequest("GET", host, nil)
assert.NoError(t, err)
if err != nil {
t.Errorf("expected no error, but received %v", err)
}
// URL.EscapedPath() will be used by the signer to get the
// escaped form of the request's URI path.
@ -30,12 +31,20 @@ func TestStandaloneSign(t *testing.T) {
req.URL.RawQuery = c.OrigQuery
_, err = signer.Sign(req, nil, c.Service, c.Region, time.Unix(0, 0))
assert.NoError(t, err)
if err != nil {
t.Errorf("expected no error, but received %v", err)
}
actual := req.Header.Get("Authorization")
assert.Equal(t, c.ExpSig, actual)
assert.Equal(t, c.OrigURI, req.URL.Path)
assert.Equal(t, c.EscapedURI, req.URL.EscapedPath())
if e, a := c.ExpSig, actual; e != a {
t.Errorf("expected %v, but recieved %v", e, a)
}
if e, a := c.OrigURI, req.URL.Path; e != a {
t.Errorf("expected %v, but recieved %v", e, a)
}
if e, a := c.EscapedURI, req.URL.EscapedPath(); e != a {
t.Errorf("expected %v, but recieved %v", e, a)
}
}
}
@ -48,7 +57,9 @@ func TestStandaloneSign_RawPath(t *testing.T) {
c.SubDomain, c.Region, c.Service)
req, err := http.NewRequest("GET", host, nil)
assert.NoError(t, err)
if err != nil {
t.Errorf("expected no error, but received %v", err)
}
// URL.EscapedPath() will be used by the signer to get the
// escaped form of the request's URI path.
@ -57,11 +68,19 @@ func TestStandaloneSign_RawPath(t *testing.T) {
req.URL.RawQuery = c.OrigQuery
_, err = signer.Sign(req, nil, c.Service, c.Region, time.Unix(0, 0))
assert.NoError(t, err)
if err != nil {
t.Errorf("expected no error, but received %v", err)
}
actual := req.Header.Get("Authorization")
assert.Equal(t, c.ExpSig, actual)
assert.Equal(t, c.OrigURI, req.URL.Path)
assert.Equal(t, c.EscapedURI, req.URL.EscapedPath())
if e, a := c.ExpSig, actual; e != a {
t.Errorf("expected %v, but recieved %v", e, a)
}
if e, a := c.OrigURI, req.URL.Path; e != a {
t.Errorf("expected %v, but recieved %v", e, a)
}
if e, a := c.EscapedURI, req.URL.EscapedPath(); e != a {
t.Errorf("expected %v, but recieved %v", e, a)
}
}
}

View File

@ -164,3 +164,91 @@ func TestStandaloneSign_CustomURIEscape(t *testing.T) {
t.Errorf("expect %v, got %v", e, a)
}
}
func TestStandaloneSign_WithPort(t *testing.T) {
cases := []struct {
description string
url string
expectedSig string
}{
{
"default HTTPS port",
"https://estest.us-east-1.es.amazonaws.com:443/_search",
"AWS4-HMAC-SHA256 Credential=AKID/19700101/us-east-1/es/aws4_request, SignedHeaders=host;x-amz-date;x-amz-security-token, Signature=e573fc9aa3a156b720976419319be98fb2824a3abc2ddd895ecb1d1611c6a82d",
},
{
"default HTTP port",
"http://example.com:80/_search",
"AWS4-HMAC-SHA256 Credential=AKID/19700101/us-east-1/es/aws4_request, SignedHeaders=host;x-amz-date;x-amz-security-token, Signature=54ebe60c4ae03a40948b849e13c333523235f38002e2807059c64a9a8c7cb951",
},
{
"non-standard HTTP port",
"http://example.com:9200/_search",
"AWS4-HMAC-SHA256 Credential=AKID/19700101/us-east-1/es/aws4_request, SignedHeaders=host;x-amz-date;x-amz-security-token, Signature=cd9d926a460f8d3b58b57beadbd87666dc667e014c0afaa4cea37b2867f51b4f",
},
{
"non-standard HTTPS port",
"https://example.com:9200/_search",
"AWS4-HMAC-SHA256 Credential=AKID/19700101/us-east-1/es/aws4_request, SignedHeaders=host;x-amz-date;x-amz-security-token, Signature=cd9d926a460f8d3b58b57beadbd87666dc667e014c0afaa4cea37b2867f51b4f",
},
}
for _, c := range cases {
signer := v4.NewSigner(unit.Session.Config.Credentials)
req, _ := http.NewRequest("GET", c.url, nil)
_, err := signer.Sign(req, nil, "es", "us-east-1", time.Unix(0, 0))
if err != nil {
t.Fatalf("expect no error, got %v", err)
}
actual := req.Header.Get("Authorization")
if e, a := c.expectedSig, actual; e != a {
t.Errorf("%s, expect %v, got %v", c.description, e, a)
}
}
}
func TestStandalonePresign_WithPort(t *testing.T) {
cases := []struct {
description string
url string
expectedSig string
}{
{
"default HTTPS port",
"https://estest.us-east-1.es.amazonaws.com:443/_search",
"0abcf61a351063441296febf4b485734d780634fba8cf1e7d9769315c35255d6",
},
{
"default HTTP port",
"http://example.com:80/_search",
"fce9976dd6c849c21adfa6d3f3e9eefc651d0e4a2ccd740d43efddcccfdc8179",
},
{
"non-standard HTTP port",
"http://example.com:9200/_search",
"f33c25a81c735e42bef35ed5e9f720c43940562e3e616ff0777bf6dde75249b0",
},
{
"non-standard HTTPS port",
"https://example.com:9200/_search",
"f33c25a81c735e42bef35ed5e9f720c43940562e3e616ff0777bf6dde75249b0",
},
}
for _, c := range cases {
signer := v4.NewSigner(unit.Session.Config.Credentials)
req, _ := http.NewRequest("GET", c.url, nil)
_, err := signer.Presign(req, nil, "es", "us-east-1", 5 * time.Minute, time.Unix(0, 0))
if err != nil {
t.Fatalf("expect no error, got %v", err)
}
actual := req.URL.Query().Get("X-Amz-Signature")
if e, a := c.expectedSig, actual; e != a {
t.Errorf("%s, expect %v, got %v", c.description, e, a)
}
}
}

View File

@ -2,8 +2,6 @@ package v4
import (
"testing"
"github.com/stretchr/testify/assert"
)
func TestRuleCheckWhitelist(t *testing.T) {
@ -13,8 +11,12 @@ func TestRuleCheckWhitelist(t *testing.T) {
},
}
assert.True(t, w.IsValid("Cache-Control"))
assert.False(t, w.IsValid("Cache-"))
if !w.IsValid("Cache-Control") {
t.Error("expected true value")
}
if w.IsValid("Cache-") {
t.Error("expected false value")
}
}
func TestRuleCheckBlacklist(t *testing.T) {
@ -24,16 +26,26 @@ func TestRuleCheckBlacklist(t *testing.T) {
},
}
assert.False(t, b.IsValid("Cache-Control"))
assert.True(t, b.IsValid("Cache-"))
if b.IsValid("Cache-Control") {
t.Error("expected false value")
}
if !b.IsValid("Cache-") {
t.Error("expected true value")
}
}
func TestRuleCheckPattern(t *testing.T) {
p := patterns{"X-Amz-Meta-"}
assert.True(t, p.IsValid("X-Amz-Meta-"))
assert.True(t, p.IsValid("X-Amz-Meta-Star"))
assert.False(t, p.IsValid("Cache-"))
if !p.IsValid("X-Amz-Meta-") {
t.Error("expected true value")
}
if !p.IsValid("X-Amz-Meta-Star") {
t.Error("expected true value")
}
if p.IsValid("Cache-") {
t.Error("expected false value")
}
}
func TestRuleComplexWhitelist(t *testing.T) {
@ -50,8 +62,16 @@ func TestRuleComplexWhitelist(t *testing.T) {
inclusiveRules{patterns{"X-Amz-"}, blacklist{w}},
}
assert.True(t, r.IsValid("X-Amz-Blah"))
assert.False(t, r.IsValid("X-Amz-Meta-"))
assert.False(t, r.IsValid("X-Amz-Meta-Star"))
assert.False(t, r.IsValid("Cache-Control"))
if !r.IsValid("X-Amz-Blah") {
t.Error("expected true value")
}
if r.IsValid("X-Amz-Meta-") {
t.Error("expected false value")
}
if r.IsValid("X-Amz-Meta-Star") {
t.Error("expected false value")
}
if r.IsValid("Cache-Control") {
t.Error("expected false value")
}
}

View File

@ -268,7 +268,7 @@ type signingCtx struct {
// "X-Amz-Content-Sha256" header with a precomputed value. The signer will
// only compute the hash if the request header value is empty.
func (v4 Signer) Sign(r *http.Request, body io.ReadSeeker, service, region string, signTime time.Time) (http.Header, error) {
return v4.signWithBody(r, body, service, region, 0, signTime)
return v4.signWithBody(r, body, service, region, 0, false, signTime)
}
// Presign signs AWS v4 requests with the provided body, service name, region
@ -302,10 +302,10 @@ func (v4 Signer) Sign(r *http.Request, body io.ReadSeeker, service, region strin
// presigned request's signature you can set the "X-Amz-Content-Sha256"
// HTTP header and that will be included in the request's signature.
func (v4 Signer) Presign(r *http.Request, body io.ReadSeeker, service, region string, exp time.Duration, signTime time.Time) (http.Header, error) {
return v4.signWithBody(r, body, service, region, exp, signTime)
return v4.signWithBody(r, body, service, region, exp, true, signTime)
}
func (v4 Signer) signWithBody(r *http.Request, body io.ReadSeeker, service, region string, exp time.Duration, signTime time.Time) (http.Header, error) {
func (v4 Signer) signWithBody(r *http.Request, body io.ReadSeeker, service, region string, exp time.Duration, isPresign bool, signTime time.Time) (http.Header, error) {
currentTimeFn := v4.currentTimeFn
if currentTimeFn == nil {
currentTimeFn = time.Now
@ -317,7 +317,7 @@ func (v4 Signer) signWithBody(r *http.Request, body io.ReadSeeker, service, regi
Query: r.URL.Query(),
Time: signTime,
ExpireTime: exp,
isPresign: exp != 0,
isPresign: isPresign,
ServiceName: service,
Region: region,
DisableURIPathEscaping: v4.DisableURIPathEscaping,
@ -339,6 +339,7 @@ func (v4 Signer) signWithBody(r *http.Request, body io.ReadSeeker, service, regi
return http.Header{}, err
}
ctx.sanitizeHostForHeader()
ctx.assignAmzQueryValues()
ctx.build(v4.DisableHeaderHoisting)
@ -363,6 +364,10 @@ func (v4 Signer) signWithBody(r *http.Request, body io.ReadSeeker, service, regi
return ctx.SignedHeaderVals, nil
}
func (ctx *signingCtx) sanitizeHostForHeader() {
request.SanitizeHostForHeader(ctx.Request)
}
func (ctx *signingCtx) handlePresignRemoval() {
if !ctx.isPresign {
return
@ -467,7 +472,7 @@ func signSDKRequestWithCurrTime(req *request.Request, curTimeFn func() time.Time
}
signedHeaders, err := v4.signWithBody(req.HTTPRequest, req.GetBody(),
name, region, req.ExpireTime, signingTime,
name, region, req.ExpireTime, req.ExpireTime > 0, signingTime,
)
if err != nil {
req.Error = err

View File

@ -1,32 +1,49 @@
package aws
import (
"bytes"
"math/rand"
"testing"
"github.com/stretchr/testify/assert"
)
func TestWriteAtBuffer(t *testing.T) {
b := &WriteAtBuffer{}
n, err := b.WriteAt([]byte{1}, 0)
assert.NoError(t, err)
assert.Equal(t, 1, n)
if err != nil {
t.Errorf("expected no error, but received %v", err)
}
if e, a := 1, n; e != a {
t.Errorf("expected %d, but recieved %d", e, a)
}
n, err = b.WriteAt([]byte{1, 1, 1}, 5)
assert.NoError(t, err)
assert.Equal(t, 3, n)
if err != nil {
t.Errorf("expected no error, but received %v", err)
}
if e, a := 3, n; e != a {
t.Errorf("expected %d, but recieved %d", e, a)
}
n, err = b.WriteAt([]byte{2}, 1)
assert.NoError(t, err)
assert.Equal(t, 1, n)
if err != nil {
t.Errorf("expected no error, but received %v", err)
}
if e, a := 1, n; e != a {
t.Errorf("expected %d, but recieved %d", e, a)
}
n, err = b.WriteAt([]byte{3}, 2)
assert.NoError(t, err)
assert.Equal(t, 1, n)
if err != nil {
t.Errorf("expected no error, but received %v", err)
}
if e, a := 1, n; e != a {
t.Errorf("expected %d, but received %d", e, a)
}
assert.Equal(t, []byte{1, 2, 3, 0, 0, 1, 1, 1}, b.Bytes())
if !bytes.Equal([]byte{1, 2, 3, 0, 0, 1, 1, 1}, b.Bytes()) {
t.Errorf("expected %v, but received %v", []byte{1, 2, 3, 0, 0, 1, 1, 1}, b.Bytes())
}
}
func BenchmarkWriteAtBuffer(b *testing.B) {

View File

@ -5,4 +5,4 @@ package aws
const SDKName = "aws-sdk-go"
// SDKVersion is the version of this SDK
const SDKVersion = "1.12.2"
const SDKVersion = "1.12.62"

View File

@ -79,8 +79,8 @@ func init() {
gucumber.T.Errorf("no error returned")
}
if ok {
if e, a := data, err.Error(); !strings.Contains(a, e) {
gucumber.T.Errorf("expect %v to be in %v, was not", e, a)
if a := err.Error(); len(a) == 0 {
gucumber.T.Errorf("expect string length to be greater than zero")
}
}
})
@ -138,8 +138,8 @@ func init() {
if !ok {
gucumber.T.Errorf("no error returned")
}
if e, a := data, err.Error(); !strings.Contains(a, e) {
gucumber.T.Errorf("expect %v to be in %v, was not", e, a)
if a := err.Error(); len(a) == 0 {
gucumber.T.Errorf("expect string length to be greater than zero")
}
})

21
vendor/github.com/aws/aws-sdk-go/buildspec.yml generated vendored Normal file
View File

@ -0,0 +1,21 @@
version: 0.2
phases:
build:
commands:
- echo Build started on `date`
- export GOPATH=/go
- export SDK_CB_ROOT=`pwd`
- export SDK_GO_ROOT=/go/src/github.com/aws/aws-sdk-go
- mkdir -p /go/src/github.com/aws
- ln -s $SDK_CB_ROOT $SDK_GO_ROOT
- cd $SDK_GO_ROOT
- make unit
- cd $SDK_CB_ROOT
- #echo Compiling the Go code...
post_build:
commands:
- echo Build completed on `date`
#artifacts:
# files:
# - hello

View File

@ -197,7 +197,7 @@
// regions different from the Session's region.
//
// svc := s3.New(sess, &aws.Config{
// Region: aws.String(ednpoints.UsWest2RegionID),
// Region: aws.String(endpoints.UsWest2RegionID),
// })
//
// See the Config type in the aws package for more information and additional

View File

@ -68,7 +68,7 @@ func main() {
ddbSvc.ListTables(&dynamodb.ListTablesInput{})
// Setting Config's Endpoint will override the EndpointResolver. Forcing
// the service clien to make all operation to the endpoint specified
// the service client to make all operation to the endpoint specified
// the in the config.
ddbSvcLocal := dynamodb.New(sess, &aws.Config{
Endpoint: aws.String("http://localhost:8088"),

View File

@ -0,0 +1,11 @@
# Using Custom Retry Strategies with the SDK
This example highlights how you can define a custom retry strategy for the SDK to use. The example wraps the SDK's DefaultRetryer with a set of custom rules to not retry HTTP 5xx status codes. In all other cases the custom retry strategy falls back the SDK's DefaultRetryer's functionality.
## Usage
This example will attempt to make an Amazon CloudWatch Logs PutLogEvents DescribeLogGroups API call. This example expects to retrieve credentials from the `~/.aws/credentials` file.
```sh
go run ./custom_retryer.go
```

View File

@ -0,0 +1,75 @@
// +build example
package main
import (
"fmt"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/awserr"
"github.com/aws/aws-sdk-go/aws/client"
"github.com/aws/aws-sdk-go/aws/credentials"
"github.com/aws/aws-sdk-go/aws/defaults"
"github.com/aws/aws-sdk-go/aws/endpoints"
"github.com/aws/aws-sdk-go/aws/request"
"github.com/aws/aws-sdk-go/aws/session"
"github.com/aws/aws-sdk-go/service/cloudwatchlogs"
)
func main() {
sess := session.Must(
session.NewSession(&aws.Config{
// Use a custom retryer to provide custom retry rules.
Retryer: CustomRetryer{DefaultRetryer: client.DefaultRetryer{NumMaxRetries: 3}},
// Use the SDK's SharedCredentialsProvider directly instead of the
// SDK's default credential chain. This ensures that the
// application can call Config.Credentials.Expire. This is counter
// to the SDK's default credentials chain, which will never reread
// the shared credentials file.
Credentials: credentials.NewCredentials(&credentials.SharedCredentialsProvider{
Filename: defaults.SharedCredentialsFilename(),
Profile: "default",
}),
Region: aws.String(endpoints.UsWest2RegionID),
}),
)
// Add a request handler to the AfterRetry handler stack that is used by the
// SDK to be executed after the SDK has determined if it will retry.
// This handler forces the SDK's Credentials to be expired, and next call to
// Credentials.Get will attempt to refresh the credentials.
sess.Handlers.AfterRetry.PushBack(func(req *request.Request) {
if aerr, ok := req.Error.(awserr.RequestFailure); ok && aerr != nil {
if aerr.Code() == "InvalidClaimException" {
// Force the credentials to expire based on error code. Next
// call to Credentials.Get will attempt to refresh credentials.
req.Config.Credentials.Expire()
}
}
})
svc := cloudwatchlogs.New(sess)
resp, err := svc.DescribeLogGroups(&cloudwatchlogs.DescribeLogGroupsInput{})
fmt.Println(resp, err)
}
// CustomRetryer wraps the SDK's built in DefaultRetryer adding additional
// custom features. Such as, no retry for 5xx status codes, and refresh
// credentials.
type CustomRetryer struct {
client.DefaultRetryer
}
// ShouldRetry overrides the SDK's built in DefaultRetryer adding customization
// to not retry 5xx status codes.
func (r CustomRetryer) ShouldRetry(req *request.Request) bool {
if req.HTTPResponse.StatusCode >= 500 {
// Don't retry any 5xx status codes.
return false
}
// Fallback to SDK's built in retry rules
return r.DefaultRetryer.ShouldRetry(req)
}

View File

@ -4,7 +4,7 @@ Uploads a file to S3 given a bucket and object key. Also takes a duration
value to terminate the update if it doesn't complete within that time.
The AWS Region needs to be provided in the AWS shared config or on the
environment variable as `AWS_REGION`. Credentials also must be provided
environment variable as `AWS_REGION`. Credentials also must be provided.
Will default to shared config file, but can load from environment if provided.
## Usage:

View File

@ -63,7 +63,7 @@
"base": null,
"refs": {
"DisassociateDiscoveredResourceRequest$ConfigurationId": "<p>ConfigurationId of the ADS resource to be disassociated.</p>",
"DiscoveredResource$ConfigurationId": "<p>The configurationId in ADS that uniquely identifies the on-premise resource.</p>"
"DiscoveredResource$ConfigurationId": "<p>The configurationId in ADS that uniquely identifies the on-premises resource.</p>"
}
},
"CreateProgressUpdateStreamRequest": {

View File

@ -0,0 +1,528 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2017-09-23",
"endpointPrefix":"cloud9",
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"AWS Cloud9",
"signatureVersion":"v4",
"targetPrefix":"AWSCloud9WorkspaceManagementService",
"uid":"cloud9-2017-09-23"
},
"operations":{
"CreateEnvironmentEC2":{
"name":"CreateEnvironmentEC2",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateEnvironmentEC2Request"},
"output":{"shape":"CreateEnvironmentEC2Result"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"TooManyRequestsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServerErrorException"}
],
"idempotent":true
},
"CreateEnvironmentMembership":{
"name":"CreateEnvironmentMembership",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateEnvironmentMembershipRequest"},
"output":{"shape":"CreateEnvironmentMembershipResult"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"TooManyRequestsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServerErrorException"}
],
"idempotent":true
},
"DeleteEnvironment":{
"name":"DeleteEnvironment",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteEnvironmentRequest"},
"output":{"shape":"DeleteEnvironmentResult"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"TooManyRequestsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServerErrorException"}
],
"idempotent":true
},
"DeleteEnvironmentMembership":{
"name":"DeleteEnvironmentMembership",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteEnvironmentMembershipRequest"},
"output":{"shape":"DeleteEnvironmentMembershipResult"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"TooManyRequestsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServerErrorException"}
],
"idempotent":true
},
"DescribeEnvironmentMemberships":{
"name":"DescribeEnvironmentMemberships",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeEnvironmentMembershipsRequest"},
"output":{"shape":"DescribeEnvironmentMembershipsResult"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"TooManyRequestsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServerErrorException"}
]
},
"DescribeEnvironmentStatus":{
"name":"DescribeEnvironmentStatus",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeEnvironmentStatusRequest"},
"output":{"shape":"DescribeEnvironmentStatusResult"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"TooManyRequestsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServerErrorException"}
]
},
"DescribeEnvironments":{
"name":"DescribeEnvironments",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeEnvironmentsRequest"},
"output":{"shape":"DescribeEnvironmentsResult"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"TooManyRequestsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServerErrorException"}
]
},
"ListEnvironments":{
"name":"ListEnvironments",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListEnvironmentsRequest"},
"output":{"shape":"ListEnvironmentsResult"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"TooManyRequestsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServerErrorException"}
]
},
"UpdateEnvironment":{
"name":"UpdateEnvironment",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateEnvironmentRequest"},
"output":{"shape":"UpdateEnvironmentResult"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"TooManyRequestsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServerErrorException"}
],
"idempotent":true
},
"UpdateEnvironmentMembership":{
"name":"UpdateEnvironmentMembership",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateEnvironmentMembershipRequest"},
"output":{"shape":"UpdateEnvironmentMembershipResult"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"TooManyRequestsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServerErrorException"}
],
"idempotent":true
}
},
"shapes":{
"AutomaticStopTimeMinutes":{
"type":"integer",
"box":true,
"max":20160
},
"BadRequestException":{
"type":"structure",
"members":{
},
"exception":true
},
"BoundedEnvironmentIdList":{
"type":"list",
"member":{"shape":"EnvironmentId"},
"max":25,
"min":1
},
"ClientRequestToken":{
"type":"string",
"pattern":"[\\x20-\\x7E]{10,128}"
},
"ConflictException":{
"type":"structure",
"members":{
},
"exception":true
},
"CreateEnvironmentEC2Request":{
"type":"structure",
"required":[
"name",
"instanceType"
],
"members":{
"name":{"shape":"EnvironmentName"},
"description":{"shape":"EnvironmentDescription"},
"clientRequestToken":{"shape":"ClientRequestToken"},
"instanceType":{"shape":"InstanceType"},
"subnetId":{"shape":"SubnetId"},
"automaticStopTimeMinutes":{"shape":"AutomaticStopTimeMinutes"},
"ownerArn":{"shape":"UserArn"}
}
},
"CreateEnvironmentEC2Result":{
"type":"structure",
"members":{
"environmentId":{"shape":"EnvironmentId"}
}
},
"CreateEnvironmentMembershipRequest":{
"type":"structure",
"required":[
"environmentId",
"userArn",
"permissions"
],
"members":{
"environmentId":{"shape":"EnvironmentId"},
"userArn":{"shape":"UserArn"},
"permissions":{"shape":"MemberPermissions"}
}
},
"CreateEnvironmentMembershipResult":{
"type":"structure",
"members":{
"membership":{"shape":"EnvironmentMember"}
}
},
"DeleteEnvironmentMembershipRequest":{
"type":"structure",
"required":[
"environmentId",
"userArn"
],
"members":{
"environmentId":{"shape":"EnvironmentId"},
"userArn":{"shape":"UserArn"}
}
},
"DeleteEnvironmentMembershipResult":{
"type":"structure",
"members":{
}
},
"DeleteEnvironmentRequest":{
"type":"structure",
"required":["environmentId"],
"members":{
"environmentId":{"shape":"EnvironmentId"}
}
},
"DeleteEnvironmentResult":{
"type":"structure",
"members":{
}
},
"DescribeEnvironmentMembershipsRequest":{
"type":"structure",
"members":{
"userArn":{"shape":"UserArn"},
"environmentId":{"shape":"EnvironmentId"},
"permissions":{"shape":"PermissionsList"},
"nextToken":{"shape":"String"},
"maxResults":{"shape":"MaxResults"}
}
},
"DescribeEnvironmentMembershipsResult":{
"type":"structure",
"members":{
"memberships":{"shape":"EnvironmentMembersList"},
"nextToken":{"shape":"String"}
}
},
"DescribeEnvironmentStatusRequest":{
"type":"structure",
"required":["environmentId"],
"members":{
"environmentId":{"shape":"EnvironmentId"}
}
},
"DescribeEnvironmentStatusResult":{
"type":"structure",
"members":{
"status":{"shape":"EnvironmentStatus"},
"message":{"shape":"String"}
}
},
"DescribeEnvironmentsRequest":{
"type":"structure",
"required":["environmentIds"],
"members":{
"environmentIds":{"shape":"BoundedEnvironmentIdList"}
}
},
"DescribeEnvironmentsResult":{
"type":"structure",
"members":{
"environments":{"shape":"EnvironmentList"}
}
},
"Environment":{
"type":"structure",
"members":{
"id":{"shape":"EnvironmentId"},
"name":{"shape":"EnvironmentName"},
"description":{"shape":"EnvironmentDescription"},
"type":{"shape":"EnvironmentType"},
"arn":{"shape":"String"},
"ownerArn":{"shape":"String"}
}
},
"EnvironmentDescription":{
"type":"string",
"max":200
},
"EnvironmentId":{
"type":"string",
"pattern":"^[a-zA-Z0-9]{8,32}$"
},
"EnvironmentIdList":{
"type":"list",
"member":{"shape":"EnvironmentId"}
},
"EnvironmentList":{
"type":"list",
"member":{"shape":"Environment"}
},
"EnvironmentMember":{
"type":"structure",
"members":{
"permissions":{"shape":"Permissions"},
"userId":{"shape":"String"},
"userArn":{"shape":"UserArn"},
"environmentId":{"shape":"EnvironmentId"},
"lastAccess":{"shape":"Timestamp"}
}
},
"EnvironmentMembersList":{
"type":"list",
"member":{"shape":"EnvironmentMember"}
},
"EnvironmentName":{
"type":"string",
"max":60,
"min":1
},
"EnvironmentStatus":{
"type":"string",
"enum":[
"error",
"creating",
"connecting",
"ready",
"stopping",
"stopped",
"deleting"
]
},
"EnvironmentType":{
"type":"string",
"enum":[
"ssh",
"ec2"
]
},
"ForbiddenException":{
"type":"structure",
"members":{
},
"exception":true
},
"InstanceType":{
"type":"string",
"max":20,
"min":5,
"pattern":"^[a-z][1-9][.][a-z0-9]+$"
},
"InternalServerErrorException":{
"type":"structure",
"members":{
},
"exception":true,
"fault":true
},
"LimitExceededException":{
"type":"structure",
"members":{
},
"exception":true
},
"ListEnvironmentsRequest":{
"type":"structure",
"members":{
"nextToken":{"shape":"String"},
"maxResults":{"shape":"MaxResults"}
}
},
"ListEnvironmentsResult":{
"type":"structure",
"members":{
"nextToken":{"shape":"String"},
"environmentIds":{"shape":"EnvironmentIdList"}
}
},
"MaxResults":{
"type":"integer",
"box":true,
"max":25,
"min":0
},
"MemberPermissions":{
"type":"string",
"enum":[
"read-write",
"read-only"
]
},
"NotFoundException":{
"type":"structure",
"members":{
},
"exception":true
},
"Permissions":{
"type":"string",
"enum":[
"owner",
"read-write",
"read-only"
]
},
"PermissionsList":{
"type":"list",
"member":{"shape":"Permissions"}
},
"String":{"type":"string"},
"SubnetId":{
"type":"string",
"max":30,
"min":5
},
"Timestamp":{"type":"timestamp"},
"TooManyRequestsException":{
"type":"structure",
"members":{
},
"exception":true
},
"UpdateEnvironmentMembershipRequest":{
"type":"structure",
"required":[
"environmentId",
"userArn",
"permissions"
],
"members":{
"environmentId":{"shape":"EnvironmentId"},
"userArn":{"shape":"UserArn"},
"permissions":{"shape":"MemberPermissions"}
}
},
"UpdateEnvironmentMembershipResult":{
"type":"structure",
"members":{
"membership":{"shape":"EnvironmentMember"}
}
},
"UpdateEnvironmentRequest":{
"type":"structure",
"required":["environmentId"],
"members":{
"environmentId":{"shape":"EnvironmentId"},
"name":{"shape":"EnvironmentName"},
"description":{"shape":"EnvironmentDescription"}
}
},
"UpdateEnvironmentResult":{
"type":"structure",
"members":{
}
},
"UserArn":{
"type":"string",
"pattern":"arn:aws:(iam|sts)::\\d+:\\S+"
}
}
}

View File

@ -0,0 +1,317 @@
{
"version": "2.0",
"service": "<fullname>AWS Cloud9</fullname> <p>AWS Cloud9 is a collection of tools that you can use to code, build, run, test, debug, and release software in the cloud.</p> <p>In the background, these tools are available through development environments running on Amazon Elastic Compute Cloud (Amazon EC2) instances (known as <i>Amazon EC2 environments</i>), your own servers (known as <i>SSH environments</i>), or a combination. This enables you to create and switch between multiple environments, with each environment set up for a specific development project.</p> <p>For more information about AWS Cloud9, see the <i>AWS Cloud9 User Guide</i>.</p> <p>AWS Cloud9 supports these operations:</p> <ul> <li> <p> <code>CreateEnvironmentEC2</code>: Creates an AWS Cloud9 development environment, launches an Amazon EC2 instance, and then hosts the environment on the instance.</p> </li> <li> <p> <code>CreateEnvironmentMembership</code>: Adds an environment member to an environment.</p> </li> <li> <p> <code>DeleteEnvironment</code>: Deletes an environment. If the environment is hosted on an Amazon EC2 instance, also terminates the instance.</p> </li> <li> <p> <code>DeleteEnvironmentMembership</code>: Deletes an environment member from an environment.</p> </li> <li> <p> <code>DescribeEnvironmentMemberships</code>: Gets information about environment members for an environment.</p> </li> <li> <p> <code>DescribeEnvironments</code>: Gets information about environments.</p> </li> <li> <p> <code>DescribeEnvironmentStatus</code>: Gets status information for an environment.</p> </li> <li> <p> <code>ListEnvironments</code>: Gets a list of environment identifiers.</p> </li> <li> <p> <code>UpdateEnvironment</code>: Changes the settings of an existing environment.</p> </li> <li> <p> <code>UpdateEnvironmentMembership</code>: Changes the settings of an existing environment member for an environment.</p> </li> </ul>",
"operations": {
"CreateEnvironmentEC2": "<p>Creates an AWS Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then hosts the environment on the instance.</p>",
"CreateEnvironmentMembership": "<p>Adds an environment member to an AWS Cloud9 development environment.</p>",
"DeleteEnvironment": "<p>Deletes an AWS Cloud9 development environment. If the environment is hosted on an Amazon Elastic Compute Cloud (Amazon EC2) instance, also terminates the instance.</p>",
"DeleteEnvironmentMembership": "<p>Deletes an environment member from an AWS Cloud9 development environment.</p>",
"DescribeEnvironmentMemberships": "<p>Gets information about environment members for an AWS Cloud9 development environment.</p>",
"DescribeEnvironmentStatus": "<p>Gets status information for an AWS Cloud9 development environment.</p>",
"DescribeEnvironments": "<p>Gets information about AWS Cloud9 development environments.</p>",
"ListEnvironments": "<p>Gets a list of AWS Cloud9 development environment identifiers.</p>",
"UpdateEnvironment": "<p>Changes the settings of an existing AWS Cloud9 development environment.</p>",
"UpdateEnvironmentMembership": "<p>Changes the settings of an existing environment member for an AWS Cloud9 development environment.</p>"
},
"shapes": {
"AutomaticStopTimeMinutes": {
"base": null,
"refs": {
"CreateEnvironmentEC2Request$automaticStopTimeMinutes": "<p>The number of minutes until the running instance is shut down after the environment has last been used.</p>"
}
},
"BadRequestException": {
"base": "<p>The target request is invalid.</p>",
"refs": {
}
},
"BoundedEnvironmentIdList": {
"base": null,
"refs": {
"DescribeEnvironmentsRequest$environmentIds": "<p>The IDs of invidividual environments to get information about.</p>"
}
},
"ClientRequestToken": {
"base": null,
"refs": {
"CreateEnvironmentEC2Request$clientRequestToken": "<p>A unique, case-sensitive string that helps AWS Cloud9 to ensure this operation completes no more than one time.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html\">Client Tokens</a> in the <i>Amazon EC2 API Reference</i>.</p>"
}
},
"ConflictException": {
"base": "<p>A conflict occurred.</p>",
"refs": {
}
},
"CreateEnvironmentEC2Request": {
"base": null,
"refs": {
}
},
"CreateEnvironmentEC2Result": {
"base": null,
"refs": {
}
},
"CreateEnvironmentMembershipRequest": {
"base": null,
"refs": {
}
},
"CreateEnvironmentMembershipResult": {
"base": null,
"refs": {
}
},
"DeleteEnvironmentMembershipRequest": {
"base": null,
"refs": {
}
},
"DeleteEnvironmentMembershipResult": {
"base": null,
"refs": {
}
},
"DeleteEnvironmentRequest": {
"base": null,
"refs": {
}
},
"DeleteEnvironmentResult": {
"base": null,
"refs": {
}
},
"DescribeEnvironmentMembershipsRequest": {
"base": null,
"refs": {
}
},
"DescribeEnvironmentMembershipsResult": {
"base": null,
"refs": {
}
},
"DescribeEnvironmentStatusRequest": {
"base": null,
"refs": {
}
},
"DescribeEnvironmentStatusResult": {
"base": null,
"refs": {
}
},
"DescribeEnvironmentsRequest": {
"base": null,
"refs": {
}
},
"DescribeEnvironmentsResult": {
"base": null,
"refs": {
}
},
"Environment": {
"base": "<p>Information about an AWS Cloud9 development environment.</p>",
"refs": {
"EnvironmentList$member": null
}
},
"EnvironmentDescription": {
"base": null,
"refs": {
"CreateEnvironmentEC2Request$description": "<p>The description of the environment to create.</p>",
"Environment$description": "<p>The description for the environment.</p>",
"UpdateEnvironmentRequest$description": "<p>Any new or replacement description for the environment.</p>"
}
},
"EnvironmentId": {
"base": null,
"refs": {
"BoundedEnvironmentIdList$member": null,
"CreateEnvironmentEC2Result$environmentId": "<p>The ID of the environment that was created.</p>",
"CreateEnvironmentMembershipRequest$environmentId": "<p>The ID of the environment that contains the environment member you want to add.</p>",
"DeleteEnvironmentMembershipRequest$environmentId": "<p>The ID of the environment to delete the environment member from.</p>",
"DeleteEnvironmentRequest$environmentId": "<p>The ID of the environment to delete.</p>",
"DescribeEnvironmentMembershipsRequest$environmentId": "<p>The ID of the environment to get environment member information about.</p>",
"DescribeEnvironmentStatusRequest$environmentId": "<p>The ID of the environment to get status information about.</p>",
"Environment$id": "<p>The ID of the environment.</p>",
"EnvironmentIdList$member": null,
"EnvironmentMember$environmentId": "<p>The ID of the environment for the environment member.</p>",
"UpdateEnvironmentMembershipRequest$environmentId": "<p>The ID of the environment for the environment member whose settings you want to change.</p>",
"UpdateEnvironmentRequest$environmentId": "<p>The ID of the environment to change settings.</p>"
}
},
"EnvironmentIdList": {
"base": null,
"refs": {
"ListEnvironmentsResult$environmentIds": "<p>The list of environment identifiers.</p>"
}
},
"EnvironmentList": {
"base": null,
"refs": {
"DescribeEnvironmentsResult$environments": "<p>Information about the environments that are returned.</p>"
}
},
"EnvironmentMember": {
"base": "<p>Information about an environment member for an AWS Cloud9 development environment.</p>",
"refs": {
"CreateEnvironmentMembershipResult$membership": "<p>Information about the environment member that was added.</p>",
"EnvironmentMembersList$member": null,
"UpdateEnvironmentMembershipResult$membership": "<p>Information about the environment member whose settings were changed.</p>"
}
},
"EnvironmentMembersList": {
"base": null,
"refs": {
"DescribeEnvironmentMembershipsResult$memberships": "<p>Information about the environment members for the environment.</p>"
}
},
"EnvironmentName": {
"base": null,
"refs": {
"CreateEnvironmentEC2Request$name": "<p>The name of the environment to create.</p> <p>This name is visible to other AWS IAM users in the same AWS account.</p>",
"Environment$name": "<p>The name of the environment.</p>",
"UpdateEnvironmentRequest$name": "<p>Any replacement name for the environment.</p>"
}
},
"EnvironmentStatus": {
"base": null,
"refs": {
"DescribeEnvironmentStatusResult$status": "<p>The status of the environment. Available values include:</p> <ul> <li> <p> <code>connecting</code>: The environment is connecting.</p> </li> <li> <p> <code>creating</code>: The environment is being created.</p> </li> <li> <p> <code>deleting</code>: The environment is being deleted.</p> </li> <li> <p> <code>error</code>: The environment is in an error state.</p> </li> <li> <p> <code>ready</code>: The environment is ready.</p> </li> <li> <p> <code>stopped</code>: The environment is stopped.</p> </li> <li> <p> <code>stopping</code>: The environment is stopping.</p> </li> </ul>"
}
},
"EnvironmentType": {
"base": null,
"refs": {
"Environment$type": "<p>The type of environment. Valid values include the following:</p> <ul> <li> <p> <code>ec2</code>: An environment hosted on an Amazon Elastic Compute Cloud (Amazon EC2) instance.</p> </li> <li> <p> <code>ssh</code>: An environment hosted on your own server.</p> </li> </ul>"
}
},
"ForbiddenException": {
"base": "<p>An access permissions issue occurred.</p>",
"refs": {
}
},
"InstanceType": {
"base": null,
"refs": {
"CreateEnvironmentEC2Request$instanceType": "<p>The type of instance to host the environment on (for example, <code>t2.micro</code>).</p>"
}
},
"InternalServerErrorException": {
"base": "<p>An internal server error occurred.</p>",
"refs": {
}
},
"LimitExceededException": {
"base": "<p>A service limit was exceeded.</p>",
"refs": {
}
},
"ListEnvironmentsRequest": {
"base": null,
"refs": {
}
},
"ListEnvironmentsResult": {
"base": null,
"refs": {
}
},
"MaxResults": {
"base": null,
"refs": {
"DescribeEnvironmentMembershipsRequest$maxResults": "<p>The maximum number of environment members to get information about.</p>",
"ListEnvironmentsRequest$maxResults": "<p>The maximum number of environments to get identifiers for.</p>"
}
},
"MemberPermissions": {
"base": null,
"refs": {
"CreateEnvironmentMembershipRequest$permissions": "<p>The type of environment member permissions you want to associate with this environment member. Available values include:</p> <ul> <li> <p> <code>read-only</code>: Has read-only access to the environment.</p> </li> <li> <p> <code>read-write</code>: Has read-write access to the environment.</p> </li> </ul>",
"UpdateEnvironmentMembershipRequest$permissions": "<p>The replacement type of environment member permissions you want to associate with this environment member. Available values include:</p> <ul> <li> <p> <code>read-only</code>: Has read-only access to the environment.</p> </li> <li> <p> <code>read-write</code>: Has read-write access to the environment.</p> </li> </ul>"
}
},
"NotFoundException": {
"base": "<p>The target resource cannot be found.</p>",
"refs": {
}
},
"Permissions": {
"base": null,
"refs": {
"EnvironmentMember$permissions": "<p>The type of environment member permissions associated with this environment member. Available values include:</p> <ul> <li> <p> <code>owner</code>: Owns the environment.</p> </li> <li> <p> <code>read-only</code>: Has read-only access to the environment.</p> </li> <li> <p> <code>read-write</code>: Has read-write access to the environment.</p> </li> </ul>",
"PermissionsList$member": null
}
},
"PermissionsList": {
"base": null,
"refs": {
"DescribeEnvironmentMembershipsRequest$permissions": "<p>The type of environment member permissions to get information about. Available values include:</p> <ul> <li> <p> <code>owner</code>: Owns the environment.</p> </li> <li> <p> <code>read-only</code>: Has read-only access to the environment.</p> </li> <li> <p> <code>read-write</code>: Has read-write access to the environment.</p> </li> </ul> <p>If no value is specified, information about all environment members are returned.</p>"
}
},
"String": {
"base": null,
"refs": {
"DescribeEnvironmentMembershipsRequest$nextToken": "<p>During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a <i>next token</i>. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.</p>",
"DescribeEnvironmentMembershipsResult$nextToken": "<p>If there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a <i>next token</i>. To get the next batch of items in the list, call this operation again, adding the next token to the call.</p>",
"DescribeEnvironmentStatusResult$message": "<p>Any informational message about the status of the environment.</p>",
"Environment$arn": "<p>The Amazon Resource Name (ARN) of the environment.</p>",
"Environment$ownerArn": "<p>The Amazon Resource Name (ARN) of the environment owner.</p>",
"EnvironmentMember$userId": "<p>The user ID in AWS Identity and Access Management (AWS IAM) of the environment member.</p>",
"ListEnvironmentsRequest$nextToken": "<p>During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a <i>next token</i>. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.</p>",
"ListEnvironmentsResult$nextToken": "<p>If there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a <i>next token</i>. To get the next batch of items in the list, call this operation again, adding the next token to the call.</p>"
}
},
"SubnetId": {
"base": null,
"refs": {
"CreateEnvironmentEC2Request$subnetId": "<p>The ID of the subnet in Amazon VPC that AWS Cloud9 will use to communicate with the Amazon EC2 instance.</p>"
}
},
"Timestamp": {
"base": null,
"refs": {
"EnvironmentMember$lastAccess": "<p>The time, expressed in epoch time format, when the environment member last opened the environment.</p>"
}
},
"TooManyRequestsException": {
"base": "<p>Too many service requests were made over the given time period.</p>",
"refs": {
}
},
"UpdateEnvironmentMembershipRequest": {
"base": null,
"refs": {
}
},
"UpdateEnvironmentMembershipResult": {
"base": null,
"refs": {
}
},
"UpdateEnvironmentRequest": {
"base": null,
"refs": {
}
},
"UpdateEnvironmentResult": {
"base": null,
"refs": {
}
},
"UserArn": {
"base": null,
"refs": {
"CreateEnvironmentEC2Request$ownerArn": "<p>The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN of any AWS IAM principal. If this value is not specified, the ARN defaults to this environment's creator.</p>",
"CreateEnvironmentMembershipRequest$userArn": "<p>The Amazon Resource Name (ARN) of the environment member you want to add.</p>",
"DeleteEnvironmentMembershipRequest$userArn": "<p>The Amazon Resource Name (ARN) of the environment member to delete from the environment.</p>",
"DescribeEnvironmentMembershipsRequest$userArn": "<p>The Amazon Resource Name (ARN) of an individual environment member to get information about. If no value is specified, information about all environment members are returned.</p>",
"EnvironmentMember$userArn": "<p>The Amazon Resource Name (ARN) of the environment member.</p>",
"UpdateEnvironmentMembershipRequest$userArn": "<p>The Amazon Resource Name (ARN) of the environment member whose settings you want to change.</p>"
}
}
}
}

View File

@ -0,0 +1,14 @@
{
"pagination": {
"DescribeEnvironmentMemberships": {
"input_token": "nextToken",
"output_token": "nextToken",
"limit_key": "maxResults"
},
"ListEnvironments": {
"input_token": "nextToken",
"output_token": "nextToken",
"limit_key": "maxResults"
}
}
}

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,930 @@
{
"version" : "2.0",
"service" : "Assess, monitor, manage, and remediate security issues across your AWS infrastructure, applications, and data.",
"operations" : {
"AcceptInvitation" : "Accepts the invitation to be monitored by a master GuardDuty account.",
"ArchiveFindings" : "Archives Amazon GuardDuty findings specified by the list of finding IDs.",
"CreateDetector" : "Creates a single Amazon GuardDuty detector. A detector is an object that represents the GuardDuty service. A detector must be created in order for GuardDuty to become operational.",
"CreateIPSet" : "Creates a new IPSet - a list of trusted IP addresses that have been whitelisted for secure communication with AWS infrastructure and applications.",
"CreateMembers" : "Creates member accounts of the current AWS account by specifying a list of AWS account IDs. The current AWS account can then invite these members to manage GuardDuty in their accounts.",
"CreateSampleFindings" : "Generates example findings of types specified by the list of finding types. If 'NULL' is specified for findingTypes, the API generates example findings of all supported finding types.",
"CreateThreatIntelSet" : "Create a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses. GuardDuty generates findings based on ThreatIntelSets.",
"DeclineInvitations" : "Declines invitations sent to the current member account by AWS account specified by their account IDs.",
"DeleteDetector" : "Deletes a Amazon GuardDuty detector specified by the detector ID.",
"DeleteIPSet" : "Deletes the IPSet specified by the IPSet ID.",
"DeleteInvitations" : "Deletes invitations sent to the current member account by AWS accounts specified by their account IDs.",
"DeleteMembers" : "Deletes GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs.",
"DeleteThreatIntelSet" : "Deletes ThreatIntelSet specified by the ThreatIntelSet ID.",
"DisassociateFromMasterAccount" : "Disassociates the current GuardDuty member account from its master account.",
"DisassociateMembers" : "Disassociates GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs.",
"GetDetector" : "Retrieves an Amazon GuardDuty detector specified by the detectorId.",
"GetFindings" : "Describes Amazon GuardDuty findings specified by finding IDs.",
"GetFindingsStatistics" : "Lists Amazon GuardDuty findings' statistics for the specified detector ID.",
"GetIPSet" : "Retrieves the IPSet specified by the IPSet ID.",
"GetInvitationsCount" : "Returns the count of all GuardDuty membership invitations that were sent to the current member account except the currently accepted invitation.",
"GetMasterAccount" : "Provides the details for the GuardDuty master account to the current GuardDuty member account.",
"GetMembers" : "Retrieves GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs.",
"GetThreatIntelSet" : "Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.",
"InviteMembers" : "Invites other AWS accounts (created as members of the current AWS account by CreateMembers) to enable GuardDuty and allow the current AWS account to view and manage these accounts' GuardDuty findings on their behalf as the master account.",
"ListDetectors" : "Lists detectorIds of all the existing Amazon GuardDuty detector resources.",
"ListFindings" : "Lists Amazon GuardDuty findings for the specified detector ID.",
"ListIPSets" : "Lists the IPSets of the GuardDuty service specified by the detector ID.",
"ListInvitations" : "Lists all GuardDuty membership invitations that were sent to the current AWS account.",
"ListMembers" : "Lists details about all member accounts for the current GuardDuty master account.",
"ListThreatIntelSets" : "Lists the ThreatIntelSets of the GuardDuty service specified by the detector ID.",
"StartMonitoringMembers" : "Re-enables GuardDuty to monitor findings of the member accounts specified by the account IDs. A master GuardDuty account can run this command after disabling GuardDuty from monitoring these members' findings by running StopMonitoringMembers.",
"StopMonitoringMembers" : "Disables GuardDuty from monitoring findings of the member accounts specified by the account IDs. After running this command, a master GuardDuty account can run StartMonitoringMembers to re-enable GuardDuty to monitor these members' findings.",
"UnarchiveFindings" : "Unarchives Amazon GuardDuty findings specified by the list of finding IDs.",
"UpdateDetector" : "Updates an Amazon GuardDuty detector specified by the detectorId.",
"UpdateFindingsFeedback" : "Marks specified Amazon GuardDuty findings as useful or not useful.",
"UpdateIPSet" : "Updates the IPSet specified by the IPSet ID.",
"UpdateThreatIntelSet" : "Updates the ThreatIntelSet specified by ThreatIntelSet ID."
},
"shapes" : {
"AcceptInvitationRequest" : {
"base" : "AcceptInvitation request body.",
"refs" : { }
},
"AccountDetail" : {
"base" : "An object containing the member's accountId and email address.",
"refs" : {
"AccountDetails$member" : null
}
},
"AccountDetails" : {
"base" : "A list of account/email pairs.",
"refs" : {
"CreateMembersRequest$AccountDetails" : "A list of account ID and email address pairs of the accounts that you want to associate with the master GuardDuty account."
}
},
"AccountId" : {
"base" : "AWS account ID.",
"refs" : {
"AccountDetail$AccountId" : "Member account ID.",
"Member$AccountId" : null
}
},
"AccountIds" : {
"base" : "A list of account IDs.",
"refs" : {
"DeclineInvitationsRequest$AccountIds" : "A list of account IDs of the AWS accounts that sent invitations to the current member account that you want to decline invitations from.",
"DeleteInvitationsRequest$AccountIds" : "A list of account IDs of the AWS accounts that sent invitations to the current member account that you want to delete invitations from.",
"DeleteMembersRequest$AccountIds" : "A list of account IDs of the GuardDuty member accounts that you want to delete.",
"DisassociateMembersRequest$AccountIds" : "A list of account IDs of the GuardDuty member accounts that you want to disassociate from master.",
"GetMembersRequest$AccountIds" : "A list of account IDs of the GuardDuty member accounts that you want to describe.",
"InviteMembersRequest$AccountIds" : "A list of account IDs of the accounts that you want to invite to GuardDuty as members.",
"StartMonitoringMembersRequest$AccountIds" : "A list of account IDs of the GuardDuty member accounts whose findings you want the master account to monitor.",
"StopMonitoringMembersRequest$AccountIds" : "A list of account IDs of the GuardDuty member accounts whose findings you want the master account to stop monitoring."
}
},
"Action" : {
"base" : "Information about the activity described in a finding.",
"refs" : {
"Service$Action" : "Information about the activity described in a finding."
}
},
"Activate" : {
"base" : "Whether we should start processing the list immediately or not.",
"refs" : {
"CreateIPSetRequest$Activate" : "A boolean value that indicates whether GuardDuty is to start using the uploaded IPSet.",
"CreateThreatIntelSetRequest$Activate" : "A boolean value that indicates whether GuardDuty is to start using the uploaded ThreatIntelSet.",
"UpdateIPSetRequest$Activate" : "The updated boolean value that specifies whether the IPSet is active or not.",
"UpdateThreatIntelSetRequest$Activate" : "The updated boolean value that specifies whether the ThreateIntelSet is active or not."
}
},
"ArchiveFindingsRequest" : {
"base" : "Archive Findings Request",
"refs" : { }
},
"AwsApiCallAction" : {
"base" : "Information about the AWS_API_CALL action described in this finding.",
"refs" : {
"Action$AwsApiCallAction" : "Information about the AWS_API_CALL action described in this finding."
}
},
"BadRequestException" : {
"base" : "Error response object.",
"refs" : { }
},
"City" : {
"base" : "City information of the remote IP address.",
"refs" : {
"RemoteIpDetails$City" : "City information of the remote IP address."
}
},
"Comments" : {
"base" : "Additional feedback about the GuardDuty findings.",
"refs" : {
"UpdateFindingsFeedbackRequest$Comments" : "Additional feedback about the GuardDuty findings."
}
},
"Condition" : {
"base" : "Finding attribute (for example, accountId) for which conditions and values must be specified when querying findings.",
"refs" : {
"MapOfCondition$member" : null
}
},
"CountBySeverityFindingStatistic" : {
"base" : "The count of findings for the given severity.",
"refs" : {
"MapOfCountBySeverityFindingStatistic$member" : null
}
},
"Country" : {
"base" : "Country information of the remote IP address.",
"refs" : {
"RemoteIpDetails$Country" : "Country code of the remote IP address."
}
},
"CreateDetectorRequest" : {
"base" : "Create Detector Request",
"refs" : { }
},
"CreateDetectorResponse" : {
"base" : "CreateDetector response object.",
"refs" : { }
},
"CreateIPSetRequest" : {
"base" : "Create IP Set Request",
"refs" : { }
},
"CreateIPSetResponse" : {
"base" : "CreateIPSet response object.",
"refs" : { }
},
"CreateMembersRequest" : {
"base" : "CreateMembers body",
"refs" : { }
},
"CreateMembersResponse" : {
"base" : "CreateMembers response object.",
"refs" : { }
},
"CreateSampleFindingsRequest" : {
"base" : "Create Sample Findings Request",
"refs" : { }
},
"CreateThreatIntelSetRequest" : {
"base" : "Create Threat Intel Set Request",
"refs" : { }
},
"CreateThreatIntelSetResponse" : {
"base" : "CreateThreatIntelSet response object.",
"refs" : { }
},
"CreatedAt" : {
"base" : "The first time a resource was created. The format will be ISO-8601.",
"refs" : {
"Finding$CreatedAt" : "The time stamp at which a finding was generated.",
"GetDetectorResponse$CreatedAt" : null
}
},
"DeclineInvitationsRequest" : {
"base" : "DeclineInvitations request body.",
"refs" : { }
},
"DeclineInvitationsResponse" : {
"base" : "DeclineInvitations response object.",
"refs" : { }
},
"DeleteInvitationsRequest" : {
"base" : "DeleteInvitations request body.",
"refs" : { }
},
"DeleteInvitationsResponse" : {
"base" : "DeleteInvitations response object.",
"refs" : { }
},
"DeleteMembersRequest" : {
"base" : "DeleteMembers request body.",
"refs" : { }
},
"DeleteMembersResponse" : {
"base" : "DeleteMembers response object.",
"refs" : { }
},
"DetectorId" : {
"base" : "The unique identifier for a detector.",
"refs" : {
"CreateDetectorResponse$DetectorId" : "The unique ID of the created detector.",
"DetectorIds$member" : null,
"Member$DetectorId" : null,
"Service$DetectorId" : "Detector ID for the GuardDuty service."
}
},
"DetectorIds" : {
"base" : "A list of detector Ids.",
"refs" : {
"ListDetectorsResponse$DetectorIds" : null
}
},
"DetectorStatus" : {
"base" : "The status of detector.",
"refs" : {
"GetDetectorResponse$Status" : null
}
},
"DisassociateMembersRequest" : {
"base" : "DisassociateMembers request body.",
"refs" : { }
},
"DisassociateMembersResponse" : {
"base" : "DisassociateMembers response object.",
"refs" : { }
},
"DnsRequestAction" : {
"base" : "Information about the DNS_REQUEST action described in this finding.",
"refs" : {
"Action$DnsRequestAction" : "Information about the DNS_REQUEST action described in this finding."
}
},
"Domain" : {
"base" : "A domain name.",
"refs" : {
"DnsRequestAction$Domain" : "Domain information for the DNS request."
}
},
"DomainDetails" : {
"base" : "Domain information for the AWS API call.",
"refs" : {
"AwsApiCallAction$DomainDetails" : "Domain information for the AWS API call."
}
},
"Email" : {
"base" : "Member account's email address.",
"refs" : {
"AccountDetail$Email" : "Member account's email address.",
"Member$Email" : "Member account's email address."
}
},
"Enable" : {
"base" : "A boolean value that specifies whether the detector is to be enabled.",
"refs" : {
"CreateDetectorRequest$Enable" : "A boolean value that specifies whether the detector is to be enabled.",
"UpdateDetectorRequest$Enable" : "Updated boolean value for the detector that specifies whether the detector is enabled."
}
},
"Eq" : {
"base" : "Represents the equal condition to be applied to a single field when querying for findings.",
"refs" : {
"Condition$Eq" : "Represents the equal condition to be applied to a single field when querying for findings."
}
},
"ErrorResponse" : {
"base" : "Error response object.",
"refs" : { }
},
"Feedback" : {
"base" : "Finding Feedback Value",
"refs" : {
"UpdateFindingsFeedbackRequest$Feedback" : "Valid values: USEFUL | NOT_USEFUL"
}
},
"Finding" : {
"base" : "Representation of a abnormal or suspicious activity.",
"refs" : {
"Findings$member" : null
}
},
"FindingCriteria" : {
"base" : "Represents the criteria used for querying findings.",
"refs" : {
"GetFindingsStatisticsRequest$FindingCriteria" : "Represents the criteria used for querying findings.",
"ListFindingsRequest$FindingCriteria" : "Represents the criteria used for querying findings."
}
},
"FindingId" : {
"base" : "The unique identifier for the Finding",
"refs" : {
"FindingIds$member" : null
}
},
"FindingIds" : {
"base" : "The list of the Findings.",
"refs" : {
"ArchiveFindingsRequest$FindingIds" : "IDs of the findings that you want to archive.",
"GetFindingsRequest$FindingIds" : "IDs of the findings that you want to retrieve.",
"ListFindingsResponse$FindingIds" : null,
"UnarchiveFindingsRequest$FindingIds" : "IDs of the findings that you want to unarchive.",
"UpdateFindingsFeedbackRequest$FindingIds" : "IDs of the findings that you want to mark as useful or not useful."
}
},
"FindingStatisticType" : {
"base" : "The types of finding statistics.",
"refs" : {
"FindingStatisticTypes$member" : null
}
},
"FindingStatisticTypes" : {
"base" : "The list of the finding statistics.",
"refs" : {
"GetFindingsStatisticsRequest$FindingStatisticTypes" : "Types of finding statistics to retrieve."
}
},
"FindingStatistics" : {
"base" : "Finding statistics object.",
"refs" : {
"GetFindingsStatisticsResponse$FindingStatistics" : "Finding statistics object."
}
},
"FindingType" : {
"base" : "The finding type for the finding",
"refs" : {
"FindingTypes$member" : null
}
},
"FindingTypes" : {
"base" : "The list of the finding types.",
"refs" : {
"CreateSampleFindingsRequest$FindingTypes" : "Types of sample findings that you want to generate."
}
},
"Findings" : {
"base" : "A list of findings.",
"refs" : {
"GetFindingsResponse$Findings" : null
}
},
"GeoLocation" : {
"base" : "Location information of the remote IP address.",
"refs" : {
"RemoteIpDetails$GeoLocation" : "Location information of the remote IP address."
}
},
"GetDetectorResponse" : {
"base" : "GetDetector response object.",
"refs" : { }
},
"GetFindingsRequest" : {
"base" : "Get Findings Request",
"refs" : { }
},
"GetFindingsResponse" : {
"base" : "GetFindings response object.",
"refs" : { }
},
"GetFindingsStatisticsRequest" : {
"base" : "Get Findings Statistics Request",
"refs" : { }
},
"GetFindingsStatisticsResponse" : {
"base" : "GetFindingsStatistics response object.",
"refs" : { }
},
"GetIPSetResponse" : {
"base" : "GetIPSet response object.",
"refs" : { }
},
"GetInvitationsCountResponse" : {
"base" : "GetInvitationsCount response object.",
"refs" : { }
},
"GetMasterAccountResponse" : {
"base" : "GetMasterAccount response object.",
"refs" : { }
},
"GetMembersRequest" : {
"base" : "GetMembers request body.",
"refs" : { }
},
"GetMembersResponse" : {
"base" : "GetMembers response object.",
"refs" : { }
},
"GetThreatIntelSetResponse" : {
"base" : "GetThreatIntelSet response object",
"refs" : { }
},
"IamInstanceProfile" : {
"base" : "The profile information of the EC2 instance.",
"refs" : {
"InstanceDetails$IamInstanceProfile" : null
}
},
"InstanceDetails" : {
"base" : "The information about the EC2 instance associated with the activity that prompted GuardDuty to generate a finding.",
"refs" : {
"Resource$InstanceDetails" : null
}
},
"InternalServerErrorException" : {
"base" : "Error response object.",
"refs" : { }
},
"Invitation" : {
"base" : "Invitation from an AWS account to become the current account's master.",
"refs" : {
"Invitations$member" : null
}
},
"InvitationId" : {
"base" : "This value is used to validate the master account to the member account.",
"refs" : {
"AcceptInvitationRequest$InvitationId" : "This value is used to validate the master account to the member account.",
"Invitation$InvitationId" : "This value is used to validate the inviter account to the member account.",
"Master$InvitationId" : "This value is used to validate the master account to the member account."
}
},
"Invitations" : {
"base" : "A list of invitation descriptions.",
"refs" : {
"ListInvitationsResponse$Invitations" : null
}
},
"InviteMembersRequest" : {
"base" : "InviteMembers request body.",
"refs" : { }
},
"InviteMembersResponse" : {
"base" : "InviteMembers response object.",
"refs" : { }
},
"InvitedAt" : {
"base" : "Timestamp at which a member has been invited. The format will be ISO-8601.",
"refs" : {
"Invitation$InvitedAt" : "Timestamp at which the invitation was sent",
"Master$InvitedAt" : "Timestamp at which the invitation was sent",
"Member$InvitedAt" : "Timestamp at which the invitation was sent"
}
},
"IpSetFormat" : {
"base" : "The format of the ipSet.",
"refs" : {
"CreateIPSetRequest$Format" : "The format of the file that contains the IPSet.",
"GetIPSetResponse$Format" : "The format of the file that contains the IPSet."
}
},
"IpSetId" : {
"base" : "The unique identifier for an IP Set",
"refs" : {
"CreateIPSetResponse$IpSetId" : null,
"IpSetIds$member" : null
}
},
"IpSetIds" : {
"base" : "A list of the IP set IDs",
"refs" : {
"ListIPSetsResponse$IpSetIds" : null
}
},
"IpSetStatus" : {
"base" : "The status of ipSet file uploaded.",
"refs" : {
"GetIPSetResponse$Status" : "The status of ipSet file uploaded."
}
},
"Ipv6Address" : {
"base" : "IpV6 address of the EC2 instance.",
"refs" : {
"Ipv6Addresses$member" : null
}
},
"Ipv6Addresses" : {
"base" : "A list of EC2 instance IPv6 address information.",
"refs" : {
"NetworkInterface$Ipv6Addresses" : "A list of EC2 instance IPv6 address information."
}
},
"ListDetectorsResponse" : {
"base" : "ListDetectors response object.",
"refs" : { }
},
"ListFindingsRequest" : {
"base" : "List Findings Request",
"refs" : { }
},
"ListFindingsResponse" : {
"base" : "ListFindings response object.",
"refs" : { }
},
"ListIPSetsResponse" : {
"base" : "ListIPSets response object.",
"refs" : { }
},
"ListInvitationsResponse" : {
"base" : "ListInvitations response object.",
"refs" : { }
},
"ListMembersResponse" : {
"base" : "ListMembers response object.",
"refs" : { }
},
"ListThreatIntelSetsResponse" : {
"base" : "ListThreatIntelSets response object.",
"refs" : { }
},
"LocalPortDetails" : {
"base" : "Local port information of the connection.",
"refs" : {
"NetworkConnectionAction$LocalPortDetails" : "Local port information of the connection."
}
},
"Location" : {
"base" : "The location of the S3 bucket where the list resides. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key)",
"refs" : {
"CreateIPSetRequest$Location" : "The URI of the file that contains the IPSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key)",
"CreateThreatIntelSetRequest$Location" : "The URI of the file that contains the ThreatIntelSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key).",
"GetIPSetResponse$Location" : "The URI of the file that contains the IPSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key)",
"GetThreatIntelSetResponse$Location" : "The URI of the file that contains the ThreatIntelSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key).",
"UpdateIPSetRequest$Location" : "The updated URI of the file that contains the IPSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key).",
"UpdateThreatIntelSetRequest$Location" : "The updated URI of the file that contains the ThreateIntelSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key)"
}
},
"MapOfCondition" : {
"base" : null,
"refs" : {
"FindingCriteria$Criterion" : "Represents a map of finding properties that match specified conditions and values when querying findings."
}
},
"MapOfCountBySeverityFindingStatistic" : {
"base" : null,
"refs" : {
"FindingStatistics$CountBySeverity" : "Represents a map of severity to count statistic for a set of findings"
}
},
"Master" : {
"base" : "Contains details about the master account.",
"refs" : {
"GetMasterAccountResponse$Master" : null
}
},
"MasterId" : {
"base" : "The master account ID.",
"refs" : {
"AcceptInvitationRequest$MasterId" : "The account ID of the master GuardDuty account whose invitation you're accepting.",
"Member$MasterId" : null
}
},
"MaxResults" : {
"base" : "You can use this parameter to indicate the maximum number of items that you want in the response.",
"refs" : {
"ListFindingsRequest$MaxResults" : "You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50."
}
},
"Member" : {
"base" : "Contains details about the member account.",
"refs" : {
"Members$member" : null
}
},
"Members" : {
"base" : "A list of member descriptions.",
"refs" : {
"GetMembersResponse$Members" : null,
"ListMembersResponse$Members" : null
}
},
"Message" : {
"base" : "The invitation message that you want to send to the accounts that you're inviting to GuardDuty as members.",
"refs" : {
"InviteMembersRequest$Message" : "The invitation message that you want to send to the accounts that you're inviting to GuardDuty as members."
}
},
"Name" : {
"base" : "The user-friendly name to identify the list.",
"refs" : {
"CreateIPSetRequest$Name" : "The user friendly name to identify the IPSet. This name is displayed in all findings that are triggered by activity that involves IP addresses included in this IPSet.",
"CreateThreatIntelSetRequest$Name" : "A user-friendly ThreatIntelSet name that is displayed in all finding generated by activity that involves IP addresses included in this ThreatIntelSet.",
"GetIPSetResponse$Name" : "The user friendly name to identify the IPSet. This name is displayed in all findings that are triggered by activity that involves IP addresses included in this IPSet.",
"GetThreatIntelSetResponse$Name" : "A user-friendly ThreatIntelSet name that is displayed in all finding generated by activity that involves IP addresses included in this ThreatIntelSet.",
"UpdateIPSetRequest$Name" : "The unique ID that specifies the IPSet that you want to update.",
"UpdateThreatIntelSetRequest$Name" : "The unique ID that specifies the ThreatIntelSet that you want to update."
}
},
"Neq" : {
"base" : "Represents the not equal condition to be applied to a single field when querying for findings.",
"refs" : {
"Condition$Neq" : "Represents the not equal condition to be applied to a single field when querying for findings."
}
},
"NetworkConnectionAction" : {
"base" : "Information about the NETWORK_CONNECTION action described in this finding.",
"refs" : {
"Action$NetworkConnectionAction" : "Information about the NETWORK_CONNECTION action described in this finding."
}
},
"NetworkInterface" : {
"base" : "The network interface information of the EC2 instance.",
"refs" : {
"NetworkInterfaces$member" : null
}
},
"NetworkInterfaces" : {
"base" : "The network interface information of the EC2 instance.",
"refs" : {
"InstanceDetails$NetworkInterfaces" : "The network interface information of the EC2 instance."
}
},
"NextToken" : {
"base" : "You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.",
"refs" : {
"ListDetectorsResponse$NextToken" : null,
"ListFindingsRequest$NextToken" : "You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListFindings action. For subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.",
"ListFindingsResponse$NextToken" : null,
"ListIPSetsResponse$NextToken" : null,
"ListInvitationsResponse$NextToken" : null,
"ListMembersResponse$NextToken" : null,
"ListThreatIntelSetsResponse$NextToken" : null
}
},
"OrderBy" : {
"base" : null,
"refs" : {
"SortCriteria$OrderBy" : "Order by which the sorted findings are to be displayed."
}
},
"Organization" : {
"base" : "ISP Organization information of the remote IP address.",
"refs" : {
"RemoteIpDetails$Organization" : "ISP Organization information of the remote IP address."
}
},
"PrivateDnsName" : {
"base" : "Private DNS name of the EC2 instance.",
"refs" : {
"NetworkInterface$PrivateDnsName" : "Private DNS name of the EC2 instance.",
"PrivateIpAddressDetails$PrivateDnsName" : "Private DNS name of the EC2 instance."
}
},
"PrivateIpAddress" : {
"base" : "Private IP address of the EC2 instance.",
"refs" : {
"NetworkInterface$PrivateIpAddress" : "Private IP address of the EC2 instance.",
"PrivateIpAddressDetails$PrivateIpAddress" : "Private IP address of the EC2 instance."
}
},
"PrivateIpAddressDetails" : {
"base" : "Other private IP address information of the EC2 instance.",
"refs" : {
"PrivateIpAddresses$member" : null
}
},
"PrivateIpAddresses" : {
"base" : "Other private IP address information of the EC2 instance.",
"refs" : {
"NetworkInterface$PrivateIpAddresses" : "Other private IP address information of the EC2 instance."
}
},
"ProductCode" : {
"base" : "The product code of the EC2 instance.",
"refs" : {
"ProductCodes$member" : null
}
},
"ProductCodes" : {
"base" : "The product code of the EC2 instance.",
"refs" : {
"InstanceDetails$ProductCodes" : "The product code of the EC2 instance."
}
},
"RemoteIpDetails" : {
"base" : "Remote IP information of the connection.",
"refs" : {
"AwsApiCallAction$RemoteIpDetails" : "Remote IP information of the connection.",
"NetworkConnectionAction$RemoteIpDetails" : "Remote IP information of the connection."
}
},
"RemotePortDetails" : {
"base" : "Remote port information of the connection.",
"refs" : {
"NetworkConnectionAction$RemotePortDetails" : "Remote port information of the connection."
}
},
"Resource" : {
"base" : "The AWS resource associated with the activity that prompted GuardDuty to generate a finding.",
"refs" : {
"Finding$Resource" : "The AWS resource associated with the activity that prompted GuardDuty to generate a finding."
}
},
"SecurityGroup" : {
"base" : "Security groups associated with the EC2 instance.",
"refs" : {
"SecurityGroups$member" : null
}
},
"SecurityGroups" : {
"base" : "Security groups associated with the EC2 instance.",
"refs" : {
"NetworkInterface$SecurityGroups" : "Security groups associated with the EC2 instance."
}
},
"Service" : {
"base" : "Additional information assigned to the generated finding by GuardDuty.",
"refs" : {
"Finding$Service" : "Additional information assigned to the generated finding by GuardDuty."
}
},
"ServiceRole" : {
"base" : "Customer serviceRole name or ARN for accessing customer resources",
"refs" : {
"GetDetectorResponse$ServiceRole" : null
}
},
"SortCriteria" : {
"base" : "Represents the criteria used for sorting findings.",
"refs" : {
"GetFindingsRequest$SortCriteria" : "Represents the criteria used for sorting findings.",
"ListFindingsRequest$SortCriteria" : "Represents the criteria used for sorting findings."
}
},
"StartMonitoringMembersRequest" : {
"base" : "StartMonitoringMembers request body.",
"refs" : { }
},
"StartMonitoringMembersResponse" : {
"base" : "StartMonitoringMembers response object.",
"refs" : { }
},
"StopMonitoringMembersRequest" : {
"base" : "StopMonitoringMembers request body.",
"refs" : { }
},
"StopMonitoringMembersResponse" : {
"base" : "StopMonitoringMembers response object.",
"refs" : { }
},
"Tag" : {
"base" : "A tag of the EC2 instance.",
"refs" : {
"Tags$member" : null
}
},
"Tags" : {
"base" : "The tags of the EC2 instance.",
"refs" : {
"InstanceDetails$Tags" : "The tags of the EC2 instance."
}
},
"ThreatIntelSetFormat" : {
"base" : "The format of the threatIntelSet.",
"refs" : {
"CreateThreatIntelSetRequest$Format" : "The format of the file that contains the ThreatIntelSet.",
"GetThreatIntelSetResponse$Format" : "The format of the threatIntelSet."
}
},
"ThreatIntelSetId" : {
"base" : "The unique identifier for an threat intel set",
"refs" : {
"CreateThreatIntelSetResponse$ThreatIntelSetId" : null,
"ThreatIntelSetIds$member" : null
}
},
"ThreatIntelSetIds" : {
"base" : "The list of the threat intel set IDs",
"refs" : {
"ListThreatIntelSetsResponse$ThreatIntelSetIds" : null
}
},
"ThreatIntelSetStatus" : {
"base" : "The status of threatIntelSet file uploaded.",
"refs" : {
"GetThreatIntelSetResponse$Status" : "The status of threatIntelSet file uploaded."
}
},
"UnarchiveFindingsRequest" : {
"base" : "Unrchive Findings Request",
"refs" : { }
},
"UnprocessedAccount" : {
"base" : "An object containing the unprocessed account and a result string explaining why it was unprocessed.",
"refs" : {
"UnprocessedAccounts$member" : null
}
},
"UnprocessedAccounts" : {
"base" : "A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.",
"refs" : {
"CreateMembersResponse$UnprocessedAccounts" : "A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.",
"DeclineInvitationsResponse$UnprocessedAccounts" : "A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.",
"DeleteInvitationsResponse$UnprocessedAccounts" : "A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.",
"DeleteMembersResponse$UnprocessedAccounts" : "A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.",
"DisassociateMembersResponse$UnprocessedAccounts" : "A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.",
"GetMembersResponse$UnprocessedAccounts" : "A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.",
"InviteMembersResponse$UnprocessedAccounts" : "A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.",
"StartMonitoringMembersResponse$UnprocessedAccounts" : "A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.",
"StopMonitoringMembersResponse$UnprocessedAccounts" : "A list of objects containing the unprocessed account and a result string explaining why it was unprocessed."
}
},
"UpdateDetectorRequest" : {
"base" : "Update Detector Request",
"refs" : { }
},
"UpdateFindingsFeedbackRequest" : {
"base" : "Update findings feedback body",
"refs" : { }
},
"UpdateIPSetRequest" : {
"base" : "Update IP Set Request",
"refs" : { }
},
"UpdateThreatIntelSetRequest" : {
"base" : "Update Threat Intel Set Request",
"refs" : { }
},
"UpdatedAt" : {
"base" : "The first time a resource was created. The format will be ISO-8601.",
"refs" : {
"Finding$UpdatedAt" : "The time stamp at which a finding was last updated.",
"GetDetectorResponse$UpdatedAt" : null,
"Member$UpdatedAt" : null
}
},
"__boolean" : {
"base" : null,
"refs" : {
"NetworkConnectionAction$Blocked" : "Network connection blocked information.",
"Service$Archived" : "Indicates whether this finding is archived."
}
},
"__double" : {
"base" : null,
"refs" : {
"Finding$Confidence" : "The confidence level of a finding.",
"Finding$Severity" : "The severity of a finding.",
"GeoLocation$Lat" : "Latitude information of remote IP address.",
"GeoLocation$Lon" : "Longitude information of remote IP address."
}
},
"__integer" : {
"base" : null,
"refs" : {
"Condition$Gt" : "Represents the greater than condition to be applied to a single field when querying for findings.",
"Condition$Gte" : "Represents the greater than equal condition to be applied to a single field when querying for findings.",
"Condition$Lt" : "Represents the less than condition to be applied to a single field when querying for findings.",
"Condition$Lte" : "Represents the less than equal condition to be applied to a single field when querying for findings.",
"GetInvitationsCountResponse$InvitationsCount" : "The number of received invitations.",
"LocalPortDetails$Port" : "Port number of the local connection.",
"RemotePortDetails$Port" : "Port number of the remote connection.",
"Service$Count" : "Total count of the occurrences of this finding type."
}
},
"__string" : {
"base" : null,
"refs" : {
"AccountIds$member" : null,
"Action$ActionType" : "GuardDuty Finding activity type.",
"AwsApiCallAction$Api" : "AWS API name.",
"AwsApiCallAction$CallerType" : "AWS API caller type.",
"AwsApiCallAction$ServiceName" : "AWS service name whose API was invoked.",
"City$CityName" : "City name of the remote IP address.",
"Country$CountryCode" : "Country code of the remote IP address.",
"Country$CountryName" : "Country name of the remote IP address.",
"Eq$member" : null,
"ErrorResponse$Message" : "The error message.",
"ErrorResponse$Type" : "The error type.",
"Finding$AccountId" : "AWS account ID where the activity occurred that prompted GuardDuty to generate a finding.",
"Finding$Arn" : "The ARN of a finding described by the action.",
"Finding$Description" : "The description of a finding.",
"Finding$Id" : "The identifier that corresponds to a finding described by the action.",
"Finding$Partition" : "The AWS resource partition.",
"Finding$Region" : "The AWS region where the activity occurred that prompted GuardDuty to generate a finding.",
"Finding$SchemaVersion" : "Findings' schema version.",
"Finding$Title" : "The title of a finding.",
"Finding$Type" : "The type of a finding described by the action.",
"IamInstanceProfile$Arn" : "AWS EC2 instance profile ARN.",
"IamInstanceProfile$Id" : "AWS EC2 instance profile ID.",
"InstanceDetails$AvailabilityZone" : "The availability zone of the EC2 instance.",
"InstanceDetails$ImageId" : "The image ID of the EC2 instance.",
"InstanceDetails$InstanceId" : "The ID of the EC2 instance.",
"InstanceDetails$InstanceState" : "The state of the EC2 instance.",
"InstanceDetails$InstanceType" : "The type of the EC2 instance.",
"InstanceDetails$LaunchTime" : "The launch time of the EC2 instance.",
"InstanceDetails$Platform" : "The platform of the EC2 instance.",
"Invitation$AccountId" : "Inviter account ID",
"Invitation$RelationshipStatus" : "The status of the relationship between the inviter and invitee accounts.",
"LocalPortDetails$PortName" : "Port name of the local connection.",
"Master$AccountId" : "Master account ID",
"Master$RelationshipStatus" : "The status of the relationship between the master and member accounts.",
"Member$RelationshipStatus" : "The status of the relationship between the member and the master.",
"Neq$member" : null,
"NetworkConnectionAction$ConnectionDirection" : "Network connection direction.",
"NetworkConnectionAction$Protocol" : "Network connection protocol.",
"NetworkInterface$PublicDnsName" : "Public DNS name of the EC2 instance.",
"NetworkInterface$PublicIp" : "Public IP address of the EC2 instance.",
"NetworkInterface$SubnetId" : "The subnet ID of the EC2 instance.",
"NetworkInterface$VpcId" : "The VPC ID of the EC2 instance.",
"Organization$Asn" : "Autonomous system number of the internet provider of the remote IP address.",
"Organization$AsnOrg" : "Organization that registered this ASN.",
"Organization$Isp" : "ISP information for the internet provider.",
"Organization$Org" : "Name of the internet provider.",
"ProductCode$Code" : "Product code information.",
"ProductCode$ProductType" : "Product code type.",
"RemoteIpDetails$IpAddressV4" : "IPV4 remote address of the connection.",
"RemotePortDetails$PortName" : "Port name of the remote connection.",
"Resource$ResourceType" : "The type of the AWS resource.",
"SecurityGroup$GroupId" : "EC2 instance's security group ID.",
"SecurityGroup$GroupName" : "EC2 instance's security group name.",
"Service$EventFirstSeen" : "First seen timestamp of the activity that prompted GuardDuty to generate this finding.",
"Service$EventLastSeen" : "Last seen timestamp of the activity that prompted GuardDuty to generate this finding.",
"Service$ResourceRole" : "Resource role information for this finding.",
"Service$ServiceName" : "The name of the AWS service (GuardDuty) that generated a finding.",
"Service$UserFeedback" : "Feedback left about the finding.",
"SortCriteria$AttributeName" : "Represents the finding attribute (for example, accountId) by which to sort findings.",
"Tag$Key" : "EC2 instance tag key.",
"Tag$Value" : "EC2 instance tag value.",
"UnprocessedAccount$AccountId" : "AWS Account ID.",
"UnprocessedAccount$Result" : "A reason why the account hasn't been processed."
}
}
}
}

View File

@ -0,0 +1,40 @@
{
"pagination": {
"ListDetectors": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "DetectorIds"
},
"ListFindings": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "FindingIds"
},
"ListIPSets": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "IpSetIds"
},
"ListThreatIntelSets": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "ThreatIntelSetIds"
},
"ListInvitations": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Invitations"
},
"ListMembers": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Members"
}
}
}

View File

@ -158,7 +158,7 @@
"type":"string",
"max":2048,
"min":20,
"pattern":"arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=/,.@-]+)*"
"pattern":"arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=,.@-]+)*"
},
"CertificateBody":{
"type":"string",
@ -205,7 +205,9 @@
"InUseBy":{"shape":"InUseList"},
"FailureReason":{"shape":"FailureReason"},
"Type":{"shape":"CertificateType"},
"RenewalSummary":{"shape":"RenewalSummary"}
"RenewalSummary":{"shape":"RenewalSummary"},
"KeyUsages":{"shape":"KeyUsageList"},
"ExtendedKeyUsages":{"shape":"ExtendedKeyUsageList"}
}
},
"CertificateStatus":{
@ -289,7 +291,9 @@
"DomainName":{"shape":"DomainNameString"},
"ValidationEmails":{"shape":"ValidationEmailList"},
"ValidationDomain":{"shape":"DomainNameString"},
"ValidationStatus":{"shape":"DomainStatus"}
"ValidationStatus":{"shape":"DomainStatus"},
"ResourceRecord":{"shape":"ResourceRecord"},
"ValidationMethod":{"shape":"ValidationMethod"}
}
},
"DomainValidationList":{
@ -315,6 +319,38 @@
"max":100,
"min":1
},
"ExtendedKeyUsage":{
"type":"structure",
"members":{
"Name":{"shape":"ExtendedKeyUsageName"},
"OID":{"shape":"String"}
}
},
"ExtendedKeyUsageFilterList":{
"type":"list",
"member":{"shape":"ExtendedKeyUsageName"}
},
"ExtendedKeyUsageList":{
"type":"list",
"member":{"shape":"ExtendedKeyUsage"}
},
"ExtendedKeyUsageName":{
"type":"string",
"enum":[
"TLS_WEB_SERVER_AUTHENTICATION",
"TLS_WEB_CLIENT_AUTHENTICATION",
"CODE_SIGNING",
"EMAIL_PROTECTION",
"TIME_STAMPING",
"OCSP_SIGNING",
"IPSEC_END_SYSTEM",
"IPSEC_TUNNEL",
"IPSEC_USER",
"ANY",
"NONE",
"CUSTOM"
]
},
"FailureReason":{
"type":"string",
"enum":[
@ -322,9 +358,18 @@
"ADDITIONAL_VERIFICATION_REQUIRED",
"DOMAIN_NOT_ALLOWED",
"INVALID_PUBLIC_DOMAIN",
"CAA_ERROR",
"OTHER"
]
},
"Filters":{
"type":"structure",
"members":{
"extendedKeyUsage":{"shape":"ExtendedKeyUsageFilterList"},
"keyUsage":{"shape":"KeyUsageFilterList"},
"keyTypes":{"shape":"KeyAlgorithmList"}
}
},
"GetCertificateRequest":{
"type":"structure",
"required":["CertificateArn"],
@ -401,7 +446,44 @@
"enum":[
"RSA_2048",
"RSA_1024",
"EC_prime256v1"
"RSA_4096",
"EC_prime256v1",
"EC_secp384r1",
"EC_secp521r1"
]
},
"KeyAlgorithmList":{
"type":"list",
"member":{"shape":"KeyAlgorithm"}
},
"KeyUsage":{
"type":"structure",
"members":{
"Name":{"shape":"KeyUsageName"}
}
},
"KeyUsageFilterList":{
"type":"list",
"member":{"shape":"KeyUsageName"}
},
"KeyUsageList":{
"type":"list",
"member":{"shape":"KeyUsage"}
},
"KeyUsageName":{
"type":"string",
"enum":[
"DIGITAL_SIGNATURE",
"NON_REPUDIATION",
"KEY_ENCIPHERMENT",
"DATA_ENCIPHERMENT",
"KEY_AGREEMENT",
"CERTIFICATE_SIGNING",
"CRL_SIGNING",
"ENCIPHER_ONLY",
"DECIPHER_ONLY",
"ANY",
"CUSTOM"
]
},
"LimitExceededException":{
@ -415,6 +497,7 @@
"type":"structure",
"members":{
"CertificateStatuses":{"shape":"CertificateStatuses"},
"Includes":{"shape":"Filters"},
"NextToken":{"shape":"NextToken"},
"MaxItems":{"shape":"MaxItems"}
}
@ -456,6 +539,10 @@
"min":1,
"sensitive":true
},
"RecordType":{
"type":"string",
"enum":["CNAME"]
},
"RemoveTagsFromCertificateRequest":{
"type":"structure",
"required":[
@ -492,6 +579,7 @@
"required":["DomainName"],
"members":{
"DomainName":{"shape":"DomainNameString"},
"ValidationMethod":{"shape":"ValidationMethod"},
"SubjectAlternativeNames":{"shape":"DomainList"},
"IdempotencyToken":{"shape":"IdempotencyToken"},
"DomainValidationOptions":{"shape":"DomainValidationOptionList"}
@ -537,6 +625,19 @@
},
"exception":true
},
"ResourceRecord":{
"type":"structure",
"required":[
"Name",
"Type",
"Value"
],
"members":{
"Name":{"shape":"String"},
"Type":{"shape":"RecordType"},
"Value":{"shape":"String"}
}
},
"RevocationReason":{
"type":"string",
"enum":[
@ -590,6 +691,13 @@
"ValidationEmailList":{
"type":"list",
"member":{"shape":"String"}
},
"ValidationMethod":{
"type":"string",
"enum":[
"EMAIL",
"DNS"
]
}
}
}

View File

@ -2,15 +2,15 @@
"version": "2.0",
"service": "<fullname>AWS Certificate Manager</fullname> <p>Welcome to the AWS Certificate Manager (ACM) API documentation.</p> <p>You can use ACM to manage SSL/TLS certificates for your AWS-based websites and applications. For general information about using ACM, see the <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/\"> <i>AWS Certificate Manager User Guide</i> </a>.</p>",
"operations": {
"AddTagsToCertificate": "<p>Adds one or more tags to an ACM Certificate. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a <code>key</code> and an optional <code>value</code>. You specify the certificate on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair.</p> <p>You can apply a tag to just one certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM Certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/tags.html\">Tagging ACM Certificates</a>.</p> <p>To remove one or more tags, use the <a>RemoveTagsFromCertificate</a> action. To view all of the tags that have been applied to the certificate, use the <a>ListTagsForCertificate</a> action.</p>",
"DeleteCertificate": "<p>Deletes an ACM Certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list of ACM Certificates that can be displayed by calling the <a>ListCertificates</a> action or be retrieved by calling the <a>GetCertificate</a> action. The certificate will not be available for use by other AWS services.</p> <note> <p>You cannot delete an ACM Certificate that is being used by another AWS service. To delete a certificate that is in use, the certificate association must first be removed.</p> </note>",
"AddTagsToCertificate": "<p>Adds one or more tags to an ACM Certificate. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a <code>key</code> and an optional <code>value</code>. You specify the certificate on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. </p> <p>You can apply a tag to just one certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM Certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/tags.html\">Tagging ACM Certificates</a>. </p> <p>To remove one or more tags, use the <a>RemoveTagsFromCertificate</a> action. To view all of the tags that have been applied to the certificate, use the <a>ListTagsForCertificate</a> action. </p>",
"DeleteCertificate": "<p>Deletes a certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list that can be displayed by calling the <a>ListCertificates</a> action or be retrieved by calling the <a>GetCertificate</a> action. The certificate will not be available for use by AWS services integrated with ACM. </p> <note> <p>You cannot delete an ACM Certificate that is being used by another AWS service. To delete a certificate that is in use, the certificate association must first be removed.</p> </note>",
"DescribeCertificate": "<p>Returns detailed metadata about the specified ACM Certificate.</p>",
"GetCertificate": "<p>Retrieves an ACM Certificate and certificate chain for the certificate specified by an ARN. The chain is an ordered list of certificates that contains the root certificate, intermediate certificates of subordinate CAs, and the ACM Certificate. The certificate and certificate chain are base64 encoded. If you want to decode the certificate chain to see the individual certificate fields, you can use OpenSSL.</p> <note> <p>Currently, ACM Certificates can be used only with Elastic Load Balancing and Amazon CloudFront.</p> </note>",
"ImportCertificate": "<p>Imports an SSL/TLS certificate into AWS Certificate Manager (ACM) to use with <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-services.html\">ACM's integrated AWS services</a>.</p> <note> <p>ACM does not provide <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html\">managed renewal</a> for certificates that you import.</p> </note> <p>For more information about importing certificates into ACM, including the differences between certificates that you import and those that ACM provides, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html\">Importing Certificates</a> in the <i>AWS Certificate Manager User Guide</i>.</p> <p>To import a certificate, you must provide the certificate and the matching private key. When the certificate is not self-signed, you must also provide a certificate chain. You can omit the certificate chain when importing a self-signed certificate.</p> <p>The certificate, private key, and certificate chain must be PEM-encoded. For more information about converting these items to PEM format, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html#import-certificate-troubleshooting\">Importing Certificates Troubleshooting</a> in the <i>AWS Certificate Manager User Guide</i>.</p> <p>To import a new certificate, omit the <code>CertificateArn</code> field. Include this field only when you want to replace a previously imported certificate.</p> <p>This operation returns the <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> of the imported certificate.</p>",
"ListCertificates": "<p>Retrieves a list of ACM Certificates and the domain name for each. You can optionally filter the list to return only the certificates that match the specified status.</p>",
"ListTagsForCertificate": "<p>Lists the tags that have been applied to the ACM Certificate. Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM Certificate, use the <a>AddTagsToCertificate</a> action. To delete a tag, use the <a>RemoveTagsFromCertificate</a> action.</p>",
"RemoveTagsFromCertificate": "<p>Remove one or more tags from an ACM Certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value.</p> <p>To add tags to a certificate, use the <a>AddTagsToCertificate</a> action. To view all of the tags that have been applied to a specific ACM Certificate, use the <a>ListTagsForCertificate</a> action.</p>",
"RequestCertificate": "<p>Requests an ACM Certificate for use with other AWS services. To request an ACM Certificate, you must specify the fully qualified domain name (FQDN) for your site. You can also specify additional FQDNs if users can reach your site by using other names. For each domain name you specify, email is sent to the domain owner to request approval to issue the certificate. After receiving approval from the domain owner, the ACM Certificate is issued. For more information, see the <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/\">AWS Certificate Manager User Guide</a>.</p>",
"GetCertificate": "<p>Retrieves a certificate specified by an ARN and its certificate chain . The chain is an ordered list of certificates that contains the end entity ertificate, intermediate certificates of subordinate CAs, and the root certificate in that order. The certificate and certificate chain are base64 encoded. If you want to decode the certificate to see the individual fields, you can use OpenSSL.</p>",
"ImportCertificate": "<p>Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with ACM. For more information, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-services.html\">Integrated Services</a>. </p> <note> <p>ACM does not provide <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html\">managed renewal</a> for certificates that you import.</p> </note> <p>For more information about importing certificates into ACM, including the differences between certificates that you import and those that ACM provides, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html\">Importing Certificates</a> in the <i>AWS Certificate Manager User Guide</i>. </p> <p>In general, you can import almost any valid certificate. However, services integrated with ACM allow only certificate types they support to be associated with their resources. The following guidelines are also important:</p> <ul> <li> <p>You must enter the private key that matches the certificate you are importing.</p> </li> <li> <p>The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase.</p> </li> <li> <p>If the certificate you are importing is not self-signed, you must enter its certificate chain.</p> </li> <li> <p>If a certificate chain is included, the issuer must be the subject of one of the certificates in the chain.</p> </li> <li> <p>The certificate, private key, and certificate chain must be PEM-encoded.</p> </li> <li> <p>The current time must be between the <code>Not Before</code> and <code>Not After</code> certificate fields.</p> </li> <li> <p>The <code>Issuer</code> field must not be empty.</p> </li> <li> <p>The OCSP authority URL must not exceed 1000 characters.</p> </li> <li> <p>To import a new certificate, omit the <code>CertificateArn</code> field. Include this field only when you want to replace a previously imported certificate.</p> </li> <li> <p>When you import a certificate by using the CLI or one of the SDKs, you must specify the certificate, certificate chain, and private key parameters as file names preceded by <code>file://</code>. For example, you can specify a certificate saved in the <code>C:\\temp</code> folder as <code>C:\\temp\\certificate_to_import.pem</code>. If you are making an HTTP or HTTPS Query request, include these parameters as BLOBs. </p> </li> </ul> <p>This operation returns the <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> of the imported certificate.</p>",
"ListCertificates": "<p>Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate. </p>",
"ListTagsForCertificate": "<p>Lists the tags that have been applied to the ACM Certificate. Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM Certificate, use the <a>AddTagsToCertificate</a> action. To delete a tag, use the <a>RemoveTagsFromCertificate</a> action. </p>",
"RemoveTagsFromCertificate": "<p>Remove one or more tags from an ACM Certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. </p> <p>To add tags to a certificate, use the <a>AddTagsToCertificate</a> action. To view all of the tags that have been applied to a specific ACM Certificate, use the <a>ListTagsForCertificate</a> action. </p>",
"RequestCertificate": "<p>Requests an ACM Certificate for use with other AWS services. To request an ACM Certificate, you must specify the fully qualified domain name (FQDN) for your site in the <code>DomainName</code> parameter. You can also specify additional FQDNs in the <code>SubjectAlternativeNames</code> parameter if users can reach your site by using other names. </p> <p>For each domain name you specify, email is sent to the domain owner to request approval to issue the certificate. Email is sent to three registered contact addresses in the WHOIS database and to five common system administration addresses formed from the <code>DomainName</code> you enter or the optional <code>ValidationDomain</code> parameter. For more information, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate.html\">Validate Domain Ownership</a>. </p> <p>After receiving approval from the domain owner, the ACM Certificate is issued. For more information, see the <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/\">AWS Certificate Manager User Guide</a>. </p>",
"ResendValidationEmail": "<p>Resends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM Certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking <b>I Approve</b>. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM Certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate. For more information about setting up your contact email addresses, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/setup-email.html\">Configure Email for your Domain</a>. </p>"
},
"shapes": {
@ -22,18 +22,18 @@
"Arn": {
"base": null,
"refs": {
"AddTagsToCertificateRequest$CertificateArn": "<p>String that contains the ARN of the ACM Certificate to which the tag is to be applied. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>",
"AddTagsToCertificateRequest$CertificateArn": "<p>String that contains the ARN of the ACM Certificate to which the tag is to be applied. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>. </p>",
"CertificateDetail$CertificateArn": "<p>The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>",
"CertificateSummary$CertificateArn": "<p>Amazon Resource Name (ARN) of the certificate. This is of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>",
"CertificateSummary$CertificateArn": "<p>Amazon Resource Name (ARN) of the certificate. This is of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>. </p>",
"DeleteCertificateRequest$CertificateArn": "<p>String that contains the ARN of the ACM Certificate to be deleted. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>",
"DescribeCertificateRequest$CertificateArn": "<p>The Amazon Resource Name (ARN) of the ACM Certificate. The ARN must have the following form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>",
"GetCertificateRequest$CertificateArn": "<p>String that contains a certificate ARN in the following format:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>",
"ImportCertificateRequest$CertificateArn": "<p>The <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> of an imported certificate to replace. To import a new certificate, omit this field.</p>",
"ImportCertificateRequest$CertificateArn": "<p>The <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> of an imported certificate to replace. To import a new certificate, omit this field. </p>",
"ImportCertificateResponse$CertificateArn": "<p>The <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> of the imported certificate.</p>",
"ListTagsForCertificateRequest$CertificateArn": "<p>String that contains the ARN of the ACM Certificate for which you want to list the tags. This has the following form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>",
"RemoveTagsFromCertificateRequest$CertificateArn": "<p>String that contains the ARN of the ACM Certificate with one or more tags that you want to remove. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>",
"ListTagsForCertificateRequest$CertificateArn": "<p>String that contains the ARN of the ACM Certificate for which you want to list the tags. This must have the following form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>. </p>",
"RemoveTagsFromCertificateRequest$CertificateArn": "<p>String that contains the ARN of the ACM Certificate with one or more tags that you want to remove. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>. </p>",
"RequestCertificateResponse$CertificateArn": "<p>String that contains the ARN of the issued certificate. This must be of the form:</p> <p> <code>arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p>",
"ResendValidationEmailRequest$CertificateArn": "<p>String that contains the ARN of the requested certificate. The certificate ARN is generated and returned by the <a>RequestCertificate</a> action as soon as the request is made. By default, using this parameter causes email to be sent to all top-level domains you specified in the certificate request.</p> <p>The ARN must be of the form:</p> <p> <code>arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p>"
"ResendValidationEmailRequest$CertificateArn": "<p>String that contains the ARN of the requested certificate. The certificate ARN is generated and returned by the <a>RequestCertificate</a> action as soon as the request is made. By default, using this parameter causes email to be sent to all top-level domains you specified in the certificate request. The ARN must be of the form: </p> <p> <code>arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p>"
}
},
"CertificateBody": {
@ -45,7 +45,7 @@
"CertificateBodyBlob": {
"base": null,
"refs": {
"ImportCertificateRequest$Certificate": "<p>The certificate to import. It must meet the following requirements:</p> <ul> <li> <p>Must be PEM-encoded.</p> </li> <li> <p>Must contain a 1024-bit or 2048-bit RSA public key.</p> </li> <li> <p>Must be valid at the time of import. You cannot import a certificate before its validity period begins (the certificate's <code>NotBefore</code> date) or after it expires (the certificate's <code>NotAfter</code> date).</p> </li> </ul>"
"ImportCertificateRequest$Certificate": "<p>The certificate to import.</p>"
}
},
"CertificateChain": {
@ -57,11 +57,11 @@
"CertificateChainBlob": {
"base": null,
"refs": {
"ImportCertificateRequest$CertificateChain": "<p>The certificate chain. It must be PEM-encoded.</p>"
"ImportCertificateRequest$CertificateChain": "<p>The PEM encoded certificate chain.</p>"
}
},
"CertificateDetail": {
"base": "<p>Contains metadata about an ACM certificate. This structure is returned in the response to a <a>DescribeCertificate</a> request.</p>",
"base": "<p>Contains metadata about an ACM certificate. This structure is returned in the response to a <a>DescribeCertificate</a> request. </p>",
"refs": {
"DescribeCertificateResponse$Certificate": "<p>Metadata about an ACM certificate.</p>"
}
@ -76,11 +76,11 @@
"CertificateStatuses": {
"base": null,
"refs": {
"ListCertificatesRequest$CertificateStatuses": "<p>The status or statuses on which to filter the list of ACM Certificates.</p>"
"ListCertificatesRequest$CertificateStatuses": "<p>Filter the certificate list by status value.</p>"
}
},
"CertificateSummary": {
"base": "<p>This structure is returned in the response object of <a>ListCertificates</a> action.</p>",
"base": "<p>This structure is returned in the response object of <a>ListCertificates</a> action. </p>",
"refs": {
"CertificateSummaryList$member": null
}
@ -94,7 +94,7 @@
"CertificateType": {
"base": null,
"refs": {
"CertificateDetail$Type": "<p>The source of the certificate. For certificates provided by ACM, this value is <code>AMAZON_ISSUED</code>. For certificates that you imported with <a>ImportCertificate</a>, this value is <code>IMPORTED</code>. ACM does not provide <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html\">managed renewal</a> for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html\">Importing Certificates</a> in the <i>AWS Certificate Manager User Guide</i>.</p>"
"CertificateDetail$Type": "<p>The source of the certificate. For certificates provided by ACM, this value is <code>AMAZON_ISSUED</code>. For certificates that you imported with <a>ImportCertificate</a>, this value is <code>IMPORTED</code>. ACM does not provide <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html\">managed renewal</a> for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html\">Importing Certificates</a> in the <i>AWS Certificate Manager User Guide</i>. </p>"
}
},
"DeleteCertificateRequest": {
@ -115,8 +115,8 @@
"DomainList": {
"base": null,
"refs": {
"CertificateDetail$SubjectAlternativeNames": "<p>One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.</p>",
"RequestCertificateRequest$SubjectAlternativeNames": "<p>Additional FQDNs to be included in the Subject Alternative Name extension of the ACM Certificate. For example, add the name www.example.net to a certificate for which the <code>DomainName</code> field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM Certificate is 100. However, the initial limit is 10 domain names. If you need more than 10 names, you must request a limit increase. For more information, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html\">Limits</a>.</p>"
"CertificateDetail$SubjectAlternativeNames": "<p>One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website. </p>",
"RequestCertificateRequest$SubjectAlternativeNames": "<p>Additional FQDNs to be included in the Subject Alternative Name extension of the ACM Certificate. For example, add the name www.example.net to a certificate for which the <code>DomainName</code> field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM Certificate is 100. However, the initial limit is 10 domain names. If you need more than 10 names, you must request a limit increase. For more information, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html\">Limits</a>.</p> <p> The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples: </p> <ul> <li> <p> <code>(63 octets).(63 octets).(63 octets).(61 octets)</code> is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.</p> </li> <li> <p> <code>(64 octets).(63 octets).(63 octets).(61 octets)</code> is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets.</p> </li> <li> <p> <code>(63 octets).(63 octets).(63 octets).(62 octets)</code> is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.</p> </li> </ul>"
}
},
"DomainNameString": {
@ -125,11 +125,11 @@
"CertificateDetail$DomainName": "<p>The fully qualified domain name for the certificate, such as www.example.com or example.com.</p>",
"CertificateSummary$DomainName": "<p>Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.</p>",
"DomainList$member": null,
"DomainValidation$DomainName": "<p>A fully qualified domain name (FQDN) in the certificate. For example, <code>www.example.com</code> or <code>example.com</code>.</p>",
"DomainValidation$DomainName": "<p>A fully qualified domain name (FQDN) in the certificate. For example, <code>www.example.com</code> or <code>example.com</code>. </p>",
"DomainValidation$ValidationDomain": "<p>The domain name that ACM used to send domain validation emails.</p>",
"DomainValidationOption$DomainName": "<p>A fully qualified domain name (FQDN) in the certificate request.</p>",
"DomainValidationOption$ValidationDomain": "<p>The domain name that you want ACM to use to send you validation emails. This domain name is the suffix of the email addresses that you want ACM to use. This must be the same as the <code>DomainName</code> value or a superdomain of the <code>DomainName</code> value. For example, if you request a certificate for <code>testing.example.com</code>, you can specify <code>example.com</code> for this value. In that case, ACM sends domain validation emails to the following five addresses:</p> <ul> <li> <p>admin@example.com</p> </li> <li> <p>administrator@example.com</p> </li> <li> <p>hostmaster@example.com</p> </li> <li> <p>postmaster@example.com</p> </li> <li> <p>webmaster@example.com</p> </li> </ul>",
"RequestCertificateRequest$DomainName": "<p> Fully qualified domain name (FQDN), such as www.example.com, of the site that you want to secure with an ACM Certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com. </p> <p> The maximum length of a DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples: </p> <p> <code>(63 octets).(63 octets).(63 octets).(61 octets)</code> is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets. </p> <p> <code>(64 octets).(63 octets).(63 octets).(61 octets)</code> is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets. </p> <p> <code>(63 octets).(63 octets).(63 octets).(62 octets)</code> is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets. </p>",
"RequestCertificateRequest$DomainName": "<p> Fully qualified domain name (FQDN), such as www.example.com, of the site that you want to secure with an ACM Certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com. </p> <p> The first domain name you enter cannot exceed 63 octets, including periods. Each subsequent Subject Alternative Name (SAN), however, can be up to 253 octets in length. </p>",
"ResendValidationEmailRequest$Domain": "<p>The fully qualified domain name (FQDN) of the certificate that needs to be validated.</p>",
"ResendValidationEmailRequest$ValidationDomain": "<p>The base validation domain that will act as the suffix of the email addresses that are used to send the emails. This must be the same as the <code>Domain</code> value or a superdomain of the <code>Domain</code> value. For example, if you requested a certificate for <code>site.subdomain.example.com</code> and specify a <b>ValidationDomain</b> of <code>subdomain.example.com</code>, ACM sends email to the domain registrant, technical contact, and administrative contact in WHOIS and the following five addresses:</p> <ul> <li> <p>admin@subdomain.example.com</p> </li> <li> <p>administrator@subdomain.example.com</p> </li> <li> <p>hostmaster@subdomain.example.com</p> </li> <li> <p>postmaster@subdomain.example.com</p> </li> <li> <p>webmaster@subdomain.example.com</p> </li> </ul>"
}
@ -137,7 +137,7 @@
"DomainStatus": {
"base": null,
"refs": {
"DomainValidation$ValidationStatus": "<p>The validation status of the domain name.</p>"
"DomainValidation$ValidationStatus": "<p>The validation status of the domain name. This can be one of the following values:</p> <ul> <li> <p> <code>PENDING_VALIDATION</code> </p> </li> <li> <p> <code/>SUCCESS</p> </li> <li> <p> <code/>FAILED</p> </li> </ul>"
}
},
"DomainValidation": {
@ -149,12 +149,12 @@
"DomainValidationList": {
"base": null,
"refs": {
"CertificateDetail$DomainValidationOptions": "<p>Contains information about the initial validation of each domain name that occurs as a result of the <a>RequestCertificate</a> request. This field exists only when the certificate type is <code>AMAZON_ISSUED</code>.</p>",
"CertificateDetail$DomainValidationOptions": "<p>Contains information about the initial validation of each domain name that occurs as a result of the <a>RequestCertificate</a> request. This field exists only when the certificate type is <code>AMAZON_ISSUED</code>. </p>",
"RenewalSummary$DomainValidationOptions": "<p>Contains information about the validation of each domain name in the certificate, as it pertains to ACM's <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html\">managed renewal</a>. This is different from the initial validation that occurs as a result of the <a>RequestCertificate</a> request. This field exists only when the certificate type is <code>AMAZON_ISSUED</code>.</p>"
}
},
"DomainValidationOption": {
"base": "<p>Contains information about the domain names that you want ACM to use to send you emails to validate your ownership of the domain.</p>",
"base": "<p>Contains information about the domain names that you want ACM to use to send you emails that enable you to validate domain ownership.</p>",
"refs": {
"DomainValidationOptionList$member": null
}
@ -162,13 +162,44 @@
"DomainValidationOptionList": {
"base": null,
"refs": {
"RequestCertificateRequest$DomainValidationOptions": "<p>The domain name that you want ACM to use to send you emails to validate your ownership of the domain.</p>"
"RequestCertificateRequest$DomainValidationOptions": "<p>The domain name that you want ACM to use to send you emails so taht your can validate domain ownership.</p>"
}
},
"ExtendedKeyUsage": {
"base": "<p>The Extended Key Usage X.509 v3 extension defines one or more purposes for which the public key can be used. This is in addition to or in place of the basic purposes specified by the Key Usage extension. </p>",
"refs": {
"ExtendedKeyUsageList$member": null
}
},
"ExtendedKeyUsageFilterList": {
"base": null,
"refs": {
"Filters$extendedKeyUsage": "<p>Specify one or more <a>ExtendedKeyUsage</a> extension values.</p>"
}
},
"ExtendedKeyUsageList": {
"base": null,
"refs": {
"CertificateDetail$ExtendedKeyUsages": "<p>Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID). </p>"
}
},
"ExtendedKeyUsageName": {
"base": null,
"refs": {
"ExtendedKeyUsage$Name": "<p>The name of an Extended Key Usage value.</p>",
"ExtendedKeyUsageFilterList$member": null
}
},
"FailureReason": {
"base": null,
"refs": {
"CertificateDetail$FailureReason": "<p>The reason the certificate request failed. This value exists only when the certificate status is <code>FAILED</code>. For more information, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/troubleshooting.html#troubleshooting-failed\">Certificate Request Failed</a> in the <i>AWS Certificate Manager User Guide</i>.</p>"
"CertificateDetail$FailureReason": "<p>The reason the certificate request failed. This value exists only when the certificate status is <code>FAILED</code>. For more information, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/troubleshooting.html#troubleshooting-failed\">Certificate Request Failed</a> in the <i>AWS Certificate Manager User Guide</i>. </p>"
}
},
"Filters": {
"base": "<p>This structure can be used in the <a>ListCertificates</a> action to filter the output of the certificate list. </p>",
"refs": {
"ListCertificatesRequest$Includes": "<p>Filter the certificate list by one or more of the following values. For more information, see the <a>Filters</a> structure.</p> <ul> <li> <p>extendedKeyUsage</p> </li> <li> <p>keyUsage</p> </li> <li> <p>keyTypes</p> </li> </ul>"
}
},
"GetCertificateRequest": {
@ -200,7 +231,7 @@
"InUseList": {
"base": null,
"refs": {
"CertificateDetail$InUseBy": "<p>A list of ARNs for the AWS resources that are using the certificate. A certificate can be used by multiple AWS resources.</p>"
"CertificateDetail$InUseBy": "<p>A list of ARNs for the AWS resources that are using the certificate. A certificate can be used by multiple AWS resources. </p>"
}
},
"InvalidArnException": {
@ -226,7 +257,39 @@
"KeyAlgorithm": {
"base": null,
"refs": {
"CertificateDetail$KeyAlgorithm": "<p>The algorithm that was used to generate the key pair (the public and private key).</p>"
"CertificateDetail$KeyAlgorithm": "<p>The algorithm that was used to generate the public-private key pair.</p>",
"KeyAlgorithmList$member": null
}
},
"KeyAlgorithmList": {
"base": null,
"refs": {
"Filters$keyTypes": "<p>Specify one or more algorithms that can be used to generate key pairs.</p>"
}
},
"KeyUsage": {
"base": "<p>The Key Usage X.509 v3 extension defines the purpose of the public key contained in the certificate.</p>",
"refs": {
"KeyUsageList$member": null
}
},
"KeyUsageFilterList": {
"base": null,
"refs": {
"Filters$keyUsage": "<p>Specify one or more <a>KeyUsage</a> extension values.</p>"
}
},
"KeyUsageList": {
"base": null,
"refs": {
"CertificateDetail$KeyUsages": "<p>A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.</p>"
}
},
"KeyUsageName": {
"base": null,
"refs": {
"KeyUsage$Name": "<p>A string value that contains a Key Usage extension name.</p>",
"KeyUsageFilterList$member": null
}
},
"LimitExceededException": {
@ -270,7 +333,13 @@
"PrivateKeyBlob": {
"base": null,
"refs": {
"ImportCertificateRequest$PrivateKey": "<p>The private key that matches the public key in the certificate. It must meet the following requirements:</p> <ul> <li> <p>Must be PEM-encoded.</p> </li> <li> <p>Must be unencrypted. You cannot import a private key that is protected by a password or passphrase.</p> </li> </ul>"
"ImportCertificateRequest$PrivateKey": "<p>The private key that matches the public key in the certificate.</p>"
}
},
"RecordType": {
"base": null,
"refs": {
"ResourceRecord$Type": "<p>The type of DNS record. Currently this can be <code>CNAME</code>.</p>"
}
},
"RemoveTagsFromCertificateRequest": {
@ -320,10 +389,16 @@
"refs": {
}
},
"ResourceRecord": {
"base": "<p>Contains a DNS record value that you can use to can use to validate ownership or control of a domain. This is used by the <a>DescribeCertificate</a> action. </p>",
"refs": {
"DomainValidation$ResourceRecord": "<p>Contains the CNAME record that you add to your DNS database for domain validation. For more information, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html\">Use DNS to Validate Domain Ownership</a>.</p>"
}
},
"RevocationReason": {
"base": null,
"refs": {
"CertificateDetail$RevocationReason": "<p>The reason the certificate was revoked. This value exists only when the certificate status is <code>REVOKED</code>.</p>"
"CertificateDetail$RevocationReason": "<p>The reason the certificate was revoked. This value exists only when the certificate status is <code>REVOKED</code>. </p>"
}
},
"String": {
@ -333,6 +408,7 @@
"CertificateDetail$Subject": "<p>The name of the entity that is associated with the public key contained in the certificate.</p>",
"CertificateDetail$Issuer": "<p>The name of the certificate authority that issued and signed the certificate.</p>",
"CertificateDetail$SignatureAlgorithm": "<p>The algorithm that was used to sign the certificate.</p>",
"ExtendedKeyUsage$OID": "<p>An object identifier (OID) for the extension value. OIDs are strings of numbers separated by periods. The following OIDs are defined in RFC 3280 and RFC 5280. </p> <ul> <li> <p> <code>1.3.6.1.5.5.7.3.1 (TLS_WEB_SERVER_AUTHENTICATION)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.2 (TLS_WEB_CLIENT_AUTHENTICATION)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.3 (CODE_SIGNING)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.4 (EMAIL_PROTECTION)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.8 (TIME_STAMPING)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.9 (OCSP_SIGNING)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.5 (IPSEC_END_SYSTEM)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.6 (IPSEC_TUNNEL)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.7 (IPSEC_USER)</code> </p> </li> </ul>",
"InUseList$member": null,
"InvalidArnException$message": null,
"InvalidDomainValidationOptionsException$message": null,
@ -342,6 +418,8 @@
"RequestInProgressException$message": null,
"ResourceInUseException$message": null,
"ResourceNotFoundException$message": null,
"ResourceRecord$Name": "<p>The name of the DNS record to create in your domain. This is supplied by ACM.</p>",
"ResourceRecord$Value": "<p>The value of the CNAME record to add to your DNS database. This is supplied by ACM.</p>",
"TooManyTagsException$message": null,
"ValidationEmailList$member": null
}
@ -349,10 +427,10 @@
"TStamp": {
"base": null,
"refs": {
"CertificateDetail$CreatedAt": "<p>The time at which the certificate was requested. This value exists only when the certificate type is <code>AMAZON_ISSUED</code>.</p>",
"CertificateDetail$IssuedAt": "<p>The time at which the certificate was issued. This value exists only when the certificate type is <code>AMAZON_ISSUED</code>.</p>",
"CertificateDetail$ImportedAt": "<p>The date and time at which the certificate was imported. This value exists only when the certificate type is <code>IMPORTED</code>.</p>",
"CertificateDetail$RevokedAt": "<p>The time at which the certificate was revoked. This value exists only when the certificate status is <code>REVOKED</code>.</p>",
"CertificateDetail$CreatedAt": "<p>The time at which the certificate was requested. This value exists only when the certificate type is <code>AMAZON_ISSUED</code>. </p>",
"CertificateDetail$IssuedAt": "<p>The time at which the certificate was issued. This value exists only when the certificate type is <code>AMAZON_ISSUED</code>. </p>",
"CertificateDetail$ImportedAt": "<p>The date and time at which the certificate was imported. This value exists only when the certificate type is <code>IMPORTED</code>. </p>",
"CertificateDetail$RevokedAt": "<p>The time at which the certificate was revoked. This value exists only when the certificate status is <code>REVOKED</code>. </p>",
"CertificateDetail$NotBefore": "<p>The time before which the certificate is not valid.</p>",
"CertificateDetail$NotAfter": "<p>The time after which the certificate is not valid.</p>"
}
@ -393,6 +471,13 @@
"refs": {
"DomainValidation$ValidationEmails": "<p>A list of email addresses that ACM used to send domain validation emails.</p>"
}
},
"ValidationMethod": {
"base": null,
"refs": {
"DomainValidation$ValidationMethod": "<p>Specifies the domain validation method.</p>",
"RequestCertificateRequest$ValidationMethod": "<p>The method you want to use to validate your domain.</p>"
}
}
}
}

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,39 @@
{
"pagination": {
"ListSkills": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"ListTags": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"SearchDevices": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"SearchProfiles": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"SearchRooms": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"SearchSkillGroups": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"SearchUsers": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
}
}
}

View File

@ -5,6 +5,7 @@
"endpointPrefix":"apigateway",
"protocol":"rest-json",
"serviceFullName":"Amazon API Gateway",
"serviceId":"API Gateway",
"signatureVersion":"v4",
"uid":"apigateway-2015-07-09"
},
@ -254,6 +255,21 @@
{"shape":"TooManyRequestsException"}
]
},
"CreateVpcLink":{
"name":"CreateVpcLink",
"http":{
"method":"POST",
"requestUri":"/vpclinks",
"responseCode":202
},
"input":{"shape":"CreateVpcLinkRequest"},
"output":{"shape":"VpcLink"},
"errors":[
{"shape":"UnauthorizedException"},
{"shape":"BadRequestException"},
{"shape":"TooManyRequestsException"}
]
},
"DeleteApiKey":{
"name":"DeleteApiKey",
"http":{
@ -563,6 +579,21 @@
{"shape":"TooManyRequestsException"}
]
},
"DeleteVpcLink":{
"name":"DeleteVpcLink",
"http":{
"method":"DELETE",
"requestUri":"/vpclinks/{vpclink_id}",
"responseCode":202
},
"input":{"shape":"DeleteVpcLinkRequest"},
"errors":[
{"shape":"UnauthorizedException"},
{"shape":"NotFoundException"},
{"shape":"TooManyRequestsException"},
{"shape":"BadRequestException"}
]
},
"FlushStageAuthorizersCache":{
"name":"FlushStageAuthorizersCache",
"http":{
@ -1156,6 +1187,22 @@
{"shape":"TooManyRequestsException"}
]
},
"GetTags":{
"name":"GetTags",
"http":{
"method":"GET",
"requestUri":"/tags/{resource_arn}"
},
"input":{"shape":"GetTagsRequest"},
"output":{"shape":"Tags"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"UnauthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"NotFoundException"},
{"shape":"LimitExceededException"}
]
},
"GetUsage":{
"name":"GetUsage",
"http":{
@ -1233,6 +1280,34 @@
{"shape":"NotFoundException"}
]
},
"GetVpcLink":{
"name":"GetVpcLink",
"http":{
"method":"GET",
"requestUri":"/vpclinks/{vpclink_id}"
},
"input":{"shape":"GetVpcLinkRequest"},
"output":{"shape":"VpcLink"},
"errors":[
{"shape":"UnauthorizedException"},
{"shape":"NotFoundException"},
{"shape":"TooManyRequestsException"}
]
},
"GetVpcLinks":{
"name":"GetVpcLinks",
"http":{
"method":"GET",
"requestUri":"/vpclinks"
},
"input":{"shape":"GetVpcLinksRequest"},
"output":{"shape":"VpcLinks"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"UnauthorizedException"},
{"shape":"TooManyRequestsException"}
]
},
"ImportApiKeys":{
"name":"ImportApiKeys",
"http":{
@ -1389,6 +1464,23 @@
{"shape":"ConflictException"}
]
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"PUT",
"requestUri":"/tags/{resource_arn}",
"responseCode":204
},
"input":{"shape":"TagResourceRequest"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"UnauthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"NotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"ConflictException"}
]
},
"TestInvokeAuthorizer":{
"name":"TestInvokeAuthorizer",
"http":{
@ -1419,6 +1511,22 @@
{"shape":"TooManyRequestsException"}
]
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"DELETE",
"requestUri":"/tags/{resource_arn}",
"responseCode":204
},
"input":{"shape":"UntagResourceRequest"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"UnauthorizedException"},
{"shape":"TooManyRequestsException"},
{"shape":"NotFoundException"},
{"shape":"ConflictException"}
]
},
"UpdateAccount":{
"name":"UpdateAccount",
"http":{
@ -1751,9 +1859,32 @@
{"shape":"NotFoundException"},
{"shape":"ConflictException"}
]
},
"UpdateVpcLink":{
"name":"UpdateVpcLink",
"http":{
"method":"PATCH",
"requestUri":"/vpclinks/{vpclink_id}"
},
"input":{"shape":"UpdateVpcLinkRequest"},
"output":{"shape":"VpcLink"},
"errors":[
{"shape":"UnauthorizedException"},
{"shape":"NotFoundException"},
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"TooManyRequestsException"}
]
}
},
"shapes":{
"AccessLogSettings":{
"type":"structure",
"members":{
"format":{"shape":"String"},
"destinationArn":{"shape":"String"}
}
},
"Account":{
"type":"structure",
"members":{
@ -1784,6 +1915,13 @@
"warnings":{"shape":"ListOfString"}
}
},
"ApiKeySourceType":{
"type":"string",
"enum":[
"HEADER",
"AUTHORIZER"
]
},
"ApiKeys":{
"type":"structure",
"members":{
@ -1890,6 +2028,15 @@
"FLUSH_IN_PROGRESS"
]
},
"CanarySettings":{
"type":"structure",
"members":{
"percentTraffic":{"shape":"Double"},
"deploymentId":{"shape":"String"},
"stageVariableOverrides":{"shape":"MapOfStringToString"},
"useStageCache":{"shape":"Boolean"}
}
},
"ClientCertificate":{
"type":"structure",
"members":{
@ -1918,6 +2065,13 @@
"error":{"httpStatusCode":409},
"exception":true
},
"ConnectionType":{
"type":"string",
"enum":[
"INTERNET",
"VPC_LINK"
]
},
"ContentHandlingStrategy":{
"type":"string",
"enum":[
@ -1992,7 +2146,8 @@
"description":{"shape":"String"},
"cacheClusterEnabled":{"shape":"NullableBoolean"},
"cacheClusterSize":{"shape":"CacheClusterSize"},
"variables":{"shape":"MapOfStringToString"}
"variables":{"shape":"MapOfStringToString"},
"canarySettings":{"shape":"DeploymentCanarySettings"}
}
},
"CreateDocumentationPartRequest":{
@ -2038,7 +2193,10 @@
"certificateBody":{"shape":"String"},
"certificatePrivateKey":{"shape":"String"},
"certificateChain":{"shape":"String"},
"certificateArn":{"shape":"String"}
"certificateArn":{"shape":"String"},
"regionalCertificateName":{"shape":"String"},
"regionalCertificateArn":{"shape":"String"},
"endpointConfiguration":{"shape":"EndpointConfiguration"}
}
},
"CreateModelRequest":{
@ -2103,7 +2261,10 @@
"description":{"shape":"String"},
"version":{"shape":"String"},
"cloneFrom":{"shape":"String"},
"binaryMediaTypes":{"shape":"ListOfString"}
"binaryMediaTypes":{"shape":"ListOfString"},
"minimumCompressionSize":{"shape":"NullableInteger"},
"apiKeySource":{"shape":"ApiKeySourceType"},
"endpointConfiguration":{"shape":"EndpointConfiguration"}
}
},
"CreateStageRequest":{
@ -2125,7 +2286,9 @@
"cacheClusterEnabled":{"shape":"Boolean"},
"cacheClusterSize":{"shape":"CacheClusterSize"},
"variables":{"shape":"MapOfStringToString"},
"documentationVersion":{"shape":"String"}
"documentationVersion":{"shape":"String"},
"canarySettings":{"shape":"CanarySettings"},
"tags":{"shape":"MapOfStringToString"}
}
},
"CreateUsagePlanKeyRequest":{
@ -2156,6 +2319,18 @@
"quota":{"shape":"QuotaSettings"}
}
},
"CreateVpcLinkRequest":{
"type":"structure",
"required":[
"name",
"targetArns"
],
"members":{
"name":{"shape":"String"},
"description":{"shape":"String"},
"targetArns":{"shape":"ListOfString"}
}
},
"DeleteApiKeyRequest":{
"type":"structure",
"required":["apiKey"],
@ -2532,6 +2707,17 @@
}
}
},
"DeleteVpcLinkRequest":{
"type":"structure",
"required":["vpcLinkId"],
"members":{
"vpcLinkId":{
"shape":"String",
"location":"uri",
"locationName":"vpclink_id"
}
}
},
"Deployment":{
"type":"structure",
"members":{
@ -2541,6 +2727,14 @@
"apiSummary":{"shape":"PathToMapOfMethodSnapshot"}
}
},
"DeploymentCanarySettings":{
"type":"structure",
"members":{
"percentTraffic":{"shape":"Double"},
"stageVariableOverrides":{"shape":"MapOfStringToString"},
"useStageCache":{"shape":"Boolean"}
}
},
"Deployments":{
"type":"structure",
"members":{
@ -2633,7 +2827,13 @@
"certificateName":{"shape":"String"},
"certificateArn":{"shape":"String"},
"certificateUploadDate":{"shape":"Timestamp"},
"distributionDomainName":{"shape":"String"}
"regionalDomainName":{"shape":"String"},
"regionalHostedZoneId":{"shape":"String"},
"regionalCertificateName":{"shape":"String"},
"regionalCertificateArn":{"shape":"String"},
"distributionDomainName":{"shape":"String"},
"distributionHostedZoneId":{"shape":"String"},
"endpointConfiguration":{"shape":"EndpointConfiguration"}
}
},
"DomainNames":{
@ -2647,6 +2847,19 @@
}
},
"Double":{"type":"double"},
"EndpointConfiguration":{
"type":"structure",
"members":{
"types":{"shape":"ListOfEndpointType"}
}
},
"EndpointType":{
"type":"string",
"enum":[
"REGIONAL",
"EDGE"
]
},
"ExportResponse":{
"type":"structure",
"members":{
@ -3007,6 +3220,11 @@
"shape":"NullableInteger",
"location":"querystring",
"locationName":"limit"
},
"locationStatus":{
"shape":"LocationStatusType",
"location":"querystring",
"locationName":"locationStatus"
}
}
},
@ -3532,6 +3750,27 @@
}
}
},
"GetTagsRequest":{
"type":"structure",
"required":["resourceArn"],
"members":{
"resourceArn":{
"shape":"String",
"location":"uri",
"locationName":"resource_arn"
},
"position":{
"shape":"String",
"location":"querystring",
"locationName":"position"
},
"limit":{
"shape":"NullableInteger",
"location":"querystring",
"locationName":"limit"
}
}
},
"GetUsagePlanKeyRequest":{
"type":"structure",
"required":[
@ -3648,6 +3887,32 @@
}
}
},
"GetVpcLinkRequest":{
"type":"structure",
"required":["vpcLinkId"],
"members":{
"vpcLinkId":{
"shape":"String",
"location":"uri",
"locationName":"vpclink_id"
}
}
},
"GetVpcLinksRequest":{
"type":"structure",
"members":{
"position":{
"shape":"String",
"location":"querystring",
"locationName":"position"
},
"limit":{
"shape":"NullableInteger",
"location":"querystring",
"locationName":"limit"
}
}
},
"ImportApiKeysRequest":{
"type":"structure",
"required":[
@ -3719,11 +3984,14 @@
"type":{"shape":"IntegrationType"},
"httpMethod":{"shape":"String"},
"uri":{"shape":"String"},
"connectionType":{"shape":"ConnectionType"},
"connectionId":{"shape":"String"},
"credentials":{"shape":"String"},
"requestParameters":{"shape":"MapOfStringToString"},
"requestTemplates":{"shape":"MapOfStringToString"},
"passthroughBehavior":{"shape":"String"},
"contentHandling":{"shape":"ContentHandlingStrategy"},
"timeoutInMillis":{"shape":"Integer"},
"cacheNamespace":{"shape":"String"},
"cacheKeyParameters":{"shape":"ListOfString"},
"integrationResponses":{"shape":"MapOfIntegrationResponse"}
@ -3802,6 +4070,10 @@
"type":"list",
"member":{"shape":"DomainName"}
},
"ListOfEndpointType":{
"type":"list",
"member":{"shape":"EndpointType"}
},
"ListOfGatewayResponse":{
"type":"list",
"member":{"shape":"GatewayResponse"}
@ -3862,6 +4134,17 @@
"type":"list",
"member":{"shape":"UsagePlanKey"}
},
"ListOfVpcLink":{
"type":"list",
"member":{"shape":"VpcLink"}
},
"LocationStatusType":{
"type":"string",
"enum":[
"DOCUMENTED",
"UNDOCUMENTED"
]
},
"Long":{"type":"long"},
"MapOfHeaderValues":{
"type":"map",
@ -3925,7 +4208,8 @@
"requestParameters":{"shape":"MapOfStringToBoolean"},
"requestModels":{"shape":"MapOfStringToString"},
"methodResponses":{"shape":"MapOfMethodResponse"},
"methodIntegration":{"shape":"Integration"}
"methodIntegration":{"shape":"Integration"},
"authorizationScopes":{"shape":"ListOfString"}
}
},
"MethodResponse":{
@ -4066,13 +4350,16 @@
"locationName":"httpMethod"
},
"uri":{"shape":"String"},
"connectionType":{"shape":"ConnectionType"},
"connectionId":{"shape":"String"},
"credentials":{"shape":"String"},
"requestParameters":{"shape":"MapOfStringToString"},
"requestTemplates":{"shape":"MapOfStringToString"},
"passthroughBehavior":{"shape":"String"},
"cacheNamespace":{"shape":"String"},
"cacheKeyParameters":{"shape":"ListOfString"},
"contentHandling":{"shape":"ContentHandlingStrategy"}
"contentHandling":{"shape":"ContentHandlingStrategy"},
"timeoutInMillis":{"shape":"NullableInteger"}
}
},
"PutIntegrationResponseRequest":{
@ -4140,7 +4427,8 @@
"operationName":{"shape":"String"},
"requestParameters":{"shape":"MapOfStringToBoolean"},
"requestModels":{"shape":"MapOfStringToString"},
"requestValidatorId":{"shape":"String"}
"requestValidatorId":{"shape":"String"},
"authorizationScopes":{"shape":"ListOfString"}
}
},
"PutMethodResponseRequest":{
@ -4277,7 +4565,10 @@
"createdDate":{"shape":"Timestamp"},
"version":{"shape":"String"},
"warnings":{"shape":"ListOfString"},
"binaryMediaTypes":{"shape":"ListOfString"}
"binaryMediaTypes":{"shape":"ListOfString"},
"minimumCompressionSize":{"shape":"NullableInteger"},
"apiKeySource":{"shape":"ApiKeySourceType"},
"endpointConfiguration":{"shape":"EndpointConfiguration"}
}
},
"RestApis":{
@ -4363,6 +4654,9 @@
"methodSettings":{"shape":"MapOfMethodSettings"},
"variables":{"shape":"MapOfStringToString"},
"documentationVersion":{"shape":"String"},
"accessLogSettings":{"shape":"AccessLogSettings"},
"canarySettings":{"shape":"CanarySettings"},
"tags":{"shape":"MapOfStringToString"},
"createdDate":{"shape":"Timestamp"},
"lastUpdatedDate":{"shape":"Timestamp"}
}
@ -4385,6 +4679,27 @@
"pattern":"[1-5]\\d\\d"
},
"String":{"type":"string"},
"TagResourceRequest":{
"type":"structure",
"required":[
"resourceArn",
"tags"
],
"members":{
"resourceArn":{
"shape":"String",
"location":"uri",
"locationName":"resource_arn"
},
"tags":{"shape":"MapOfStringToString"}
}
},
"Tags":{
"type":"structure",
"members":{
"tags":{"shape":"MapOfStringToString"}
}
},
"Template":{
"type":"structure",
"members":{
@ -4504,6 +4819,25 @@
"error":{"httpStatusCode":401},
"exception":true
},
"UntagResourceRequest":{
"type":"structure",
"required":[
"resourceArn",
"tagKeys"
],
"members":{
"resourceArn":{
"shape":"String",
"location":"uri",
"locationName":"resource_arn"
},
"tagKeys":{
"shape":"ListOfString",
"location":"querystring",
"locationName":"tagKeys"
}
}
},
"UpdateAccountRequest":{
"type":"structure",
"members":{
@ -4906,6 +5240,18 @@
"patchOperations":{"shape":"ListOfPatchOperation"}
}
},
"UpdateVpcLinkRequest":{
"type":"structure",
"required":["vpcLinkId"],
"members":{
"vpcLinkId":{
"shape":"String",
"location":"uri",
"locationName":"vpclink_id"
},
"patchOperations":{"shape":"ListOfPatchOperation"}
}
},
"Usage":{
"type":"structure",
"members":{
@ -4959,6 +5305,36 @@
"locationName":"item"
}
}
},
"VpcLink":{
"type":"structure",
"members":{
"id":{"shape":"String"},
"name":{"shape":"String"},
"description":{"shape":"String"},
"targetArns":{"shape":"ListOfString"},
"status":{"shape":"VpcLinkStatus"},
"statusMessage":{"shape":"String"}
}
},
"VpcLinkStatus":{
"type":"string",
"enum":[
"AVAILABLE",
"PENDING",
"DELETING",
"FAILED"
]
},
"VpcLinks":{
"type":"structure",
"members":{
"position":{"shape":"String"},
"items":{
"shape":"ListOfVpcLink",
"locationName":"item"
}
}
}
}
}

File diff suppressed because one or more lines are too long

View File

@ -65,6 +65,12 @@
"limit_key": "limit",
"output_token": "position",
"result_key": "items"
},
"GetVpcLinks": {
"input_token": "position",
"limit_key": "limit",
"output_token": "position",
"result_key": "items"
}
}
}

View File

@ -0,0 +1,20 @@
{
"version": 1,
"defaultRegion": "us-west-2",
"testCases": [
{
"operationName": "GetDomainNames",
"input": {},
"errorExpectedFromService": false
},
{
"operationName": "CreateUsagePlanKey",
"input": {
"usagePlanId": "foo",
"keyId": "bar",
"keyType": "fixx"
},
"errorExpectedFromService": true
}
]
}

View File

@ -6,6 +6,7 @@
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"Application Auto Scaling",
"serviceId":"Application Auto Scaling",
"signatureVersion":"v4",
"signingName":"application-autoscaling",
"targetPrefix":"AnyScaleFrontendService",
@ -27,6 +28,21 @@
{"shape":"InternalServiceException"}
]
},
"DeleteScheduledAction":{
"name":"DeleteScheduledAction",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteScheduledActionRequest"},
"output":{"shape":"DeleteScheduledActionResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ObjectNotFoundException"},
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
]
},
"DeregisterScalableTarget":{
"name":"DeregisterScalableTarget",
"http":{
@ -88,6 +104,21 @@
{"shape":"InternalServiceException"}
]
},
"DescribeScheduledActions":{
"name":"DescribeScheduledActions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeScheduledActionsRequest"},
"output":{"shape":"DescribeScheduledActionsResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
]
},
"PutScalingPolicy":{
"name":"PutScalingPolicy",
"http":{
@ -105,6 +136,22 @@
{"shape":"InternalServiceException"}
]
},
"PutScheduledAction":{
"name":"PutScheduledAction",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutScheduledActionRequest"},
"output":{"shape":"PutScheduledActionResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"ObjectNotFoundException"},
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
]
},
"RegisterScalableTarget":{
"name":"RegisterScalableTarget",
"http":{
@ -188,6 +235,25 @@
"members":{
}
},
"DeleteScheduledActionRequest":{
"type":"structure",
"required":[
"ServiceNamespace",
"ScheduledActionName",
"ResourceId"
],
"members":{
"ServiceNamespace":{"shape":"ServiceNamespace"},
"ScheduledActionName":{"shape":"ResourceIdMaxLen1600"},
"ResourceId":{"shape":"ResourceIdMaxLen1600"},
"ScalableDimension":{"shape":"ScalableDimension"}
}
},
"DeleteScheduledActionResponse":{
"type":"structure",
"members":{
}
},
"DeregisterScalableTargetRequest":{
"type":"structure",
"required":[
@ -261,6 +327,25 @@
"NextToken":{"shape":"XmlString"}
}
},
"DescribeScheduledActionsRequest":{
"type":"structure",
"required":["ServiceNamespace"],
"members":{
"ScheduledActionNames":{"shape":"ResourceIdsMaxLen1600"},
"ServiceNamespace":{"shape":"ServiceNamespace"},
"ResourceId":{"shape":"ResourceIdMaxLen1600"},
"ScalableDimension":{"shape":"ScalableDimension"},
"MaxResults":{"shape":"MaxResults"},
"NextToken":{"shape":"XmlString"}
}
},
"DescribeScheduledActionsResponse":{
"type":"structure",
"members":{
"ScheduledActions":{"shape":"ScheduledActions"},
"NextToken":{"shape":"XmlString"}
}
},
"DisableScaleIn":{"type":"boolean"},
"ErrorMessage":{"type":"string"},
"FailedResourceAccessException":{
@ -334,7 +419,13 @@
"type":"string",
"enum":[
"DynamoDBReadCapacityUtilization",
"DynamoDBWriteCapacityUtilization"
"DynamoDBWriteCapacityUtilization",
"ALBRequestCountPerTarget",
"RDSReaderAverageCPUUtilization",
"RDSReaderAverageDatabaseConnections",
"EC2SpotFleetRequestAverageCPUUtilization",
"EC2SpotFleetRequestAverageNetworkIn",
"EC2SpotFleetRequestAverageNetworkOut"
]
},
"MetricUnit":{"type":"string"},
@ -393,6 +484,29 @@
"Alarms":{"shape":"Alarms"}
}
},
"PutScheduledActionRequest":{
"type":"structure",
"required":[
"ServiceNamespace",
"ScheduledActionName",
"ResourceId"
],
"members":{
"ServiceNamespace":{"shape":"ServiceNamespace"},
"Schedule":{"shape":"ResourceIdMaxLen1600"},
"ScheduledActionName":{"shape":"ScheduledActionName"},
"ResourceId":{"shape":"ResourceIdMaxLen1600"},
"ScalableDimension":{"shape":"ScalableDimension"},
"StartTime":{"shape":"TimestampType"},
"EndTime":{"shape":"TimestampType"},
"ScalableTargetAction":{"shape":"ScalableTargetAction"}
}
},
"PutScheduledActionResponse":{
"type":"structure",
"members":{
}
},
"RegisterScalableTargetRequest":{
"type":"structure",
"required":[
@ -444,7 +558,8 @@
"dynamodb:table:ReadCapacityUnits",
"dynamodb:table:WriteCapacityUnits",
"dynamodb:index:ReadCapacityUnits",
"dynamodb:index:WriteCapacityUnits"
"dynamodb:index:WriteCapacityUnits",
"rds:cluster:ReadReplicaCount"
]
},
"ScalableTarget":{
@ -468,6 +583,13 @@
"CreationTime":{"shape":"TimestampType"}
}
},
"ScalableTargetAction":{
"type":"structure",
"members":{
"MinCapacity":{"shape":"ResourceCapacity"},
"MaxCapacity":{"shape":"ResourceCapacity"}
}
},
"ScalableTargets":{
"type":"list",
"member":{"shape":"ScalableTarget"}
@ -542,6 +664,39 @@
"CreationTime":{"shape":"TimestampType"}
}
},
"ScheduledAction":{
"type":"structure",
"required":[
"ScheduledActionName",
"ScheduledActionARN",
"ServiceNamespace",
"Schedule",
"ResourceId",
"CreationTime"
],
"members":{
"ScheduledActionName":{"shape":"ScheduledActionName"},
"ScheduledActionARN":{"shape":"ResourceIdMaxLen1600"},
"ServiceNamespace":{"shape":"ServiceNamespace"},
"Schedule":{"shape":"ResourceIdMaxLen1600"},
"ResourceId":{"shape":"ResourceIdMaxLen1600"},
"ScalableDimension":{"shape":"ScalableDimension"},
"StartTime":{"shape":"TimestampType"},
"EndTime":{"shape":"TimestampType"},
"ScalableTargetAction":{"shape":"ScalableTargetAction"},
"CreationTime":{"shape":"TimestampType"}
}
},
"ScheduledActionName":{
"type":"string",
"max":256,
"min":1,
"pattern":"(?!((^[ ]+.*)|(.*([\\u0000-\\u001f]|[\\u007f-\\u009f]|[:/|])+.*)|(.*[ ]+$))).+"
},
"ScheduledActions":{
"type":"list",
"member":{"shape":"ScheduledAction"}
},
"ServiceNamespace":{
"type":"string",
"enum":[
@ -549,7 +704,8 @@
"elasticmapreduce",
"ec2",
"appstream",
"dynamodb"
"dynamodb",
"rds"
]
},
"StepAdjustment":{

View File

@ -1,13 +1,16 @@
{
"version": "2.0",
"service": "<p>With Application Auto Scaling, you can automatically scale your AWS resources. The experience similar to that of <a href=\"https://aws.amazon.com/autoscaling/\">Auto Scaling</a>. You can use Application Auto Scaling to accomplish the following tasks:</p> <ul> <li> <p>Define scaling policies to automatically scale your AWS resources</p> </li> <li> <p>Scale your resources in response to CloudWatch alarms</p> </li> <li> <p>View the history of your scaling events</p> </li> </ul> <p>Application Auto Scaling can scale the following AWS resources:</p> <ul> <li> <p>Amazon ECS services. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-auto-scaling.html\">Service Auto Scaling</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p> </li> <li> <p>Amazon EC2 Spot fleets. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/fleet-auto-scaling.html\">Automatic Scaling for Spot Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p> </li> <li> <p>Amazon EMR clusters. For more information, see <a href=\"http://docs.aws.amazon.com/ElasticMapReduce/latest/ManagementGuide/emr-automatic-scaling.html\">Using Automatic Scaling in Amazon EMR</a> in the <i>Amazon EMR Management Guide</i>.</p> </li> <li> <p>AppStream 2.0 fleets. For more information, see <a href=\"http://docs.aws.amazon.com/appstream2/latest/developerguide/autoscaling.html\">Fleet Auto Scaling for Amazon AppStream 2.0</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p> </li> <li> <p>Provisioned read and write capacity for Amazon DynamoDB tables and global secondary indexes. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/AutoScaling.html\">Managing Throughput Capacity Automatically with DynamoDB Auto Scaling</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> </li> </ul> <p>For a list of supported regions, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#as-app_region\">AWS Regions and Endpoints: Application Auto Scaling</a> in the <i>AWS General Reference</i>.</p>",
"service": "<p>With Application Auto Scaling, you can automatically scale your AWS resources. The experience is similar to that of <a href=\"https://aws.amazon.com/autoscaling/\">Auto Scaling</a>. You can use Application Auto Scaling to accomplish the following tasks:</p> <ul> <li> <p>Define scaling policies to automatically scale your AWS resources</p> </li> <li> <p>Scale your resources in response to CloudWatch alarms</p> </li> <li> <p>View the history of your scaling events</p> </li> </ul> <p>Application Auto Scaling can scale the following AWS resources:</p> <ul> <li> <p>Amazon ECS services. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-auto-scaling.html\">Service Auto Scaling</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p> </li> <li> <p>Amazon EC2 Spot fleets. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/fleet-auto-scaling.html\">Automatic Scaling for Spot Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p> </li> <li> <p>Amazon EMR clusters. For more information, see <a href=\"http://docs.aws.amazon.com/ElasticMapReduce/latest/ManagementGuide/emr-automatic-scaling.html\">Using Automatic Scaling in Amazon EMR</a> in the <i>Amazon EMR Management Guide</i>.</p> </li> <li> <p>AppStream 2.0 fleets. For more information, see <a href=\"http://docs.aws.amazon.com/appstream2/latest/developerguide/autoscaling.html\">Fleet Auto Scaling for Amazon AppStream 2.0</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p> </li> <li> <p>Provisioned read and write capacity for Amazon DynamoDB tables and global secondary indexes. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/AutoScaling.html\">Managing Throughput Capacity Automatically with DynamoDB Auto Scaling</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> </li> <li> <p>Amazon Aurora Replicas. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Integrating.AutoScaling.html\">Using Application Auto Scaling with an Amazon Aurora DB Cluster</a>.</p> </li> </ul> <p>For a list of supported regions, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#as-app_region\">AWS Regions and Endpoints: Application Auto Scaling</a> in the <i>AWS General Reference</i>.</p>",
"operations": {
"DeleteScalingPolicy": "<p>Deletes the specified Application Auto Scaling scaling policy.</p> <p>Deleting a policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action.</p> <p>To create a scaling policy or update an existing one, see <a>PutScalingPolicy</a>.</p>",
"DeleteScheduledAction": "<p>Deletes the specified Application Auto Scaling scheduled action.</p>",
"DeregisterScalableTarget": "<p>Deregisters a scalable target.</p> <p>Deregistering a scalable target deletes the scaling policies that are associated with it.</p> <p>To create a scalable target or update an existing one, see <a>RegisterScalableTarget</a>.</p>",
"DescribeScalableTargets": "<p>Provides descriptive information about the scalable targets in the specified namespace.</p> <p>You can filter the results using the <code>ResourceIds</code> and <code>ScalableDimension</code> parameters.</p> <p>To create a scalable target or update an existing one, see <a>RegisterScalableTarget</a>. If you are no longer using a scalable target, you can deregister it using <a>DeregisterScalableTarget</a>.</p>",
"DescribeScalingActivities": "<p>Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.</p> <p>You can filter the results using the <code>ResourceId</code> and <code>ScalableDimension</code> parameters.</p> <p>Scaling activities are triggered by CloudWatch alarms that are associated with scaling policies. To view the scaling policies for a service namespace, see <a>DescribeScalingPolicies</a>. To create a scaling policy or update an existing one, see <a>PutScalingPolicy</a>.</p>",
"DescribeScalingPolicies": "<p>Provides descriptive information about the scaling policies in the specified namespace.</p> <p>You can filter the results using the <code>ResourceId</code>, <code>ScalableDimension</code>, and <code>PolicyNames</code> parameters.</p> <p>To create a scaling policy or update an existing one, see <a>PutScalingPolicy</a>. If you are no longer using a scaling policy, you can delete it using <a>DeleteScalingPolicy</a>.</p>",
"DescribeScalingPolicies": "<p>Describes the scaling policies for the specified service namespace.</p> <p>You can filter the results using the <code>ResourceId</code>, <code>ScalableDimension</code>, and <code>PolicyNames</code> parameters.</p> <p>To create a scaling policy or update an existing one, see <a>PutScalingPolicy</a>. If you are no longer using a scaling policy, you can delete it using <a>DeleteScalingPolicy</a>.</p>",
"DescribeScheduledActions": "<p>Describes the scheduled actions for the specified service namespace.</p> <p>You can filter the results using the <code>ResourceId</code>, <code>ScalableDimension</code>, and <code>ScheduledActionNames</code> parameters.</p> <p>To create a scheduled action or update an existing one, see <a>PutScheduledAction</a>. If you are no longer using a scheduled action, you can delete it using <a>DeleteScheduledAction</a>.</p>",
"PutScalingPolicy": "<p>Creates or updates a policy for an Application Auto Scaling scalable target.</p> <p>Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy without first registering a scalable target using <a>RegisterScalableTarget</a>.</p> <p>To update a policy, specify its policy name and the parameters that you want to change. Any parameters that you don't specify are not changed by this update request.</p> <p>You can view the scaling policies for a service namespace using <a>DescribeScalingPolicies</a>. If you are no longer using a scaling policy, you can delete it using <a>DeleteScalingPolicy</a>.</p>",
"PutScheduledAction": "<p>Creates or updates a scheduled action for an Application Auto Scaling scalable target.</p> <p>Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scheduled action applies to the scalable target identified by those three attributes. You cannot create a scheduled action without first registering a scalable target using <a>RegisterScalableTarget</a>.</p> <p>To update an action, specify its name and the parameters that you want to change. If you don't specify start and end times, the old values are deleted. Any other parameters that you don't specify are not changed by this update request.</p> <p>You can view the scheduled actions using <a>DescribeScheduledActions</a>. If you are no longer using a scheduled action, you can delete it using <a>DeleteScheduledAction</a>.</p>",
"RegisterScalableTarget": "<p>Registers or updates a scalable target. A scalable target is a resource that Application Auto Scaling can scale out or scale in. After you have registered a scalable target, you can use this operation to update the minimum and maximum values for your scalable dimension.</p> <p>After you register a scalable target, you can create and apply scaling policies using <a>PutScalingPolicy</a>. You can view the scaling policies for a service namespace using <a>DescribeScalableTargets</a>. If you are no longer using a scalable target, you can deregister it using <a>DeregisterScalableTarget</a>.</p>"
},
"shapes": {
@ -59,6 +62,16 @@
"refs": {
}
},
"DeleteScheduledActionRequest": {
"base": null,
"refs": {
}
},
"DeleteScheduledActionResponse": {
"base": null,
"refs": {
}
},
"DeregisterScalableTargetRequest": {
"base": null,
"refs": {
@ -99,6 +112,16 @@
"refs": {
}
},
"DescribeScheduledActionsRequest": {
"base": null,
"refs": {
}
},
"DescribeScheduledActionsResponse": {
"base": null,
"refs": {
}
},
"DisableScaleIn": {
"base": null,
"refs": {
@ -142,7 +165,8 @@
"refs": {
"DescribeScalableTargetsRequest$MaxResults": "<p>The maximum number of scalable target results. This value can be between 1 and 50. The default value is 50.</p> <p>If this parameter is used, the operation returns up to <code>MaxResults</code> results at a time, along with a <code>NextToken</code> value. To get the next set of results, include the <code>NextToken</code> value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a <code>NextToken</code> value, if applicable.</p>",
"DescribeScalingActivitiesRequest$MaxResults": "<p>The maximum number of scalable target results. This value can be between 1 and 50. The default value is 50.</p> <p>If this parameter is used, the operation returns up to <code>MaxResults</code> results at a time, along with a <code>NextToken</code> value. To get the next set of results, include the <code>NextToken</code> value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a <code>NextToken</code> value, if applicable.</p>",
"DescribeScalingPoliciesRequest$MaxResults": "<p>The maximum number of scalable target results. This value can be between 1 and 50. The default value is 50.</p> <p>If this parameter is used, the operation returns up to <code>MaxResults</code> results at a time, along with a <code>NextToken</code> value. To get the next set of results, include the <code>NextToken</code> value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a <code>NextToken</code> value, if applicable.</p>"
"DescribeScalingPoliciesRequest$MaxResults": "<p>The maximum number of scalable target results. This value can be between 1 and 50. The default value is 50.</p> <p>If this parameter is used, the operation returns up to <code>MaxResults</code> results at a time, along with a <code>NextToken</code> value. To get the next set of results, include the <code>NextToken</code> value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a <code>NextToken</code> value, if applicable.</p>",
"DescribeScheduledActionsRequest$MaxResults": "<p>The maximum number of scheduled action results. This value can be between 1 and 50. The default value is 50.</p> <p>If this parameter is used, the operation returns up to <code>MaxResults</code> results at a time, along with a <code>NextToken</code> value. To get the next set of results, include the <code>NextToken</code> value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a <code>NextToken</code> value, if applicable.</p>"
}
},
"MetricAggregationType": {
@ -204,7 +228,7 @@
"MetricType": {
"base": null,
"refs": {
"PredefinedMetricSpecification$PredefinedMetricType": "<p>The metric type.</p>"
"PredefinedMetricSpecification$PredefinedMetricType": "<p>The metric type. The <code>ALBRequestCountPerTarget</code> metric type applies only to Spot fleet requests.</p>"
}
},
"MetricUnit": {
@ -254,6 +278,16 @@
"refs": {
}
},
"PutScheduledActionRequest": {
"base": null,
"refs": {
}
},
"PutScheduledActionResponse": {
"base": null,
"refs": {
}
},
"RegisterScalableTargetRequest": {
"base": null,
"refs": {
@ -270,7 +304,9 @@
"RegisterScalableTargetRequest$MinCapacity": "<p>The minimum value to scale to in response to a scale in event. This parameter is required if you are registering a scalable target and optional if you are updating one.</p>",
"RegisterScalableTargetRequest$MaxCapacity": "<p>The maximum value to scale to in response to a scale out event. This parameter is required if you are registering a scalable target and optional if you are updating one.</p>",
"ScalableTarget$MinCapacity": "<p>The minimum value to scale to in response to a scale in event.</p>",
"ScalableTarget$MaxCapacity": "<p>The maximum value to scale to in response to a scale out event.</p>"
"ScalableTarget$MaxCapacity": "<p>The maximum value to scale to in response to a scale out event.</p>",
"ScalableTargetAction$MinCapacity": "<p>The minimum capacity.</p>",
"ScalableTargetAction$MaxCapacity": "<p>The maximum capacity.</p>"
}
},
"ResourceId": {
@ -285,48 +321,61 @@
"base": null,
"refs": {
"DeleteScalingPolicyRequest$PolicyName": "<p>The name of the scaling policy.</p>",
"DeleteScalingPolicyRequest$ResourceId": "<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> </ul>",
"DeregisterScalableTargetRequest$ResourceId": "<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> </ul>",
"DescribeScalingActivitiesRequest$ResourceId": "<p>The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> </ul>",
"DescribeScalingPoliciesRequest$ResourceId": "<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> </ul>",
"PutScalingPolicyRequest$ResourceId": "<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> </ul>",
"DeleteScalingPolicyRequest$ResourceId": "<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> </ul>",
"DeleteScheduledActionRequest$ScheduledActionName": "<p>The name of the scheduled action.</p>",
"DeleteScheduledActionRequest$ResourceId": "<p>The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> </ul>",
"DeregisterScalableTargetRequest$ResourceId": "<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> </ul>",
"DescribeScalingActivitiesRequest$ResourceId": "<p>The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> </ul>",
"DescribeScalingPoliciesRequest$ResourceId": "<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> </ul>",
"DescribeScheduledActionsRequest$ResourceId": "<p>The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> </ul>",
"PutScalingPolicyRequest$ResourceId": "<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> </ul>",
"PutScalingPolicyResponse$PolicyARN": "<p>The Amazon Resource Name (ARN) of the resulting scaling policy.</p>",
"RegisterScalableTargetRequest$ResourceId": "<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> </ul>",
"RegisterScalableTargetRequest$RoleARN": "<p>The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf. This parameter is required when you register a scalable target and optional when you update one.</p>",
"PutScheduledActionRequest$Schedule": "<p>The schedule for this action. The following formats are supported:</p> <ul> <li> <p>At expressions - <code>at(<i>yyyy</i>-<i>mm</i>-<i>dd</i>T<i>hh</i>:<i>mm</i>:<i>ss</i>)</code> </p> </li> <li> <p>Rate expressions - <code>rate(<i>value</i> <i>unit</i>)</code> </p> </li> <li> <p>Cron expressions - <code>cron(<i>fields</i>)</code> </p> </li> </ul> <p>At expressions are useful for one-time schedules. Specify the time, in UTC.</p> <p>For rate expressions, <i>value</i> is a positive integer and <i>unit</i> is <code>minute</code> | <code>minutes</code> | <code>hour</code> | <code>hours</code> | <code>day</code> | <code>days</code>.</p> <p>For more information about cron expressions, see <a href=\"https://en.wikipedia.org/wiki/Cron\">Cron</a>.</p>",
"PutScheduledActionRequest$ResourceId": "<p>The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> </ul>",
"RegisterScalableTargetRequest$ResourceId": "<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> </ul>",
"RegisterScalableTargetRequest$RoleARN": "<p>The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.</p> <p>With Amazon RDS resources, permissions are granted using a service-linked role. For more information, see <a href=\"http://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/application-autoscaling-service-linked-roles.html\">Service-Linked Roles for Application Auto Scaling</a>.</p> <p>For resources that are not supported using a service-linked role, this parameter is required when you register a scalable target and optional when you update one.</p>",
"ResourceIdsMaxLen1600$member": null,
"ScalableTarget$ResourceId": "<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> </ul>",
"ScalableTarget$ResourceId": "<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> </ul>",
"ScalableTarget$RoleARN": "<p>The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.</p>",
"ScalingActivity$ResourceId": "<p>The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> </ul>",
"ScalingActivity$ResourceId": "<p>The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> </ul>",
"ScalingPolicy$PolicyARN": "<p>The Amazon Resource Name (ARN) of the scaling policy.</p>",
"ScalingPolicy$ResourceId": "<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> </ul>"
"ScalingPolicy$ResourceId": "<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> </ul>",
"ScheduledAction$ScheduledActionARN": "<p>The Amazon Resource Name (ARN) of the scheduled action.</p>",
"ScheduledAction$Schedule": "<p>The schedule for this action. The following formats are supported:</p> <ul> <li> <p>At expressions - <code>at(<i>yyyy</i>-<i>mm</i>-<i>dd</i>T<i>hh</i>:<i>mm</i>:<i>ss</i>)</code> </p> </li> <li> <p>Rate expressions - <code>rate(<i>value</i> <i>unit</i>)</code> </p> </li> <li> <p>Cron expressions - <code>cron(<i>fields</i>)</code> </p> </li> </ul> <p>At expressions are useful for one-time schedules. Specify the time, in UTC.</p> <p>For rate expressions, <i>value</i> is a positive integer and <i>unit</i> is <code>minute</code> | <code>minutes</code> | <code>hour</code> | <code>hours</code> | <code>day</code> | <code>days</code>.</p> <p>For more information about cron expressions, see <a href=\"https://en.wikipedia.org/wiki/Cron\">Cron</a>.</p>",
"ScheduledAction$ResourceId": "<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> </ul>"
}
},
"ResourceIdsMaxLen1600": {
"base": null,
"refs": {
"DescribeScalableTargetsRequest$ResourceIds": "<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> </ul>",
"DescribeScalingPoliciesRequest$PolicyNames": "<p>The names of the scaling policies to describe.</p>"
"DescribeScalableTargetsRequest$ResourceIds": "<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> </ul>",
"DescribeScalingPoliciesRequest$PolicyNames": "<p>The names of the scaling policies to describe.</p>",
"DescribeScheduledActionsRequest$ScheduledActionNames": "<p>The names of the scheduled actions to describe.</p>"
}
},
"ResourceLabel": {
"base": null,
"refs": {
"PredefinedMetricSpecification$ResourceLabel": "<p>Reserved for future use.</p>"
"PredefinedMetricSpecification$ResourceLabel": "<p>Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is <code>ALBRequestCountPerTarget</code> and there is a target group attached to the Spot fleet request.</p> <p>The format is app/&lt;load-balancer-name&gt;/&lt;load-balancer-id&gt;/targetgroup/&lt;target-group-name&gt;/&lt;target-group-id&gt;, where:</p> <ul> <li> <p>app/&lt;load-balancer-name&gt;/&lt;load-balancer-id&gt; is the final portion of the load balancer ARN</p> </li> <li> <p>targetgroup/&lt;target-group-name&gt;/&lt;target-group-id&gt; is the final portion of the target group ARN.</p> </li> </ul>"
}
},
"ScalableDimension": {
"base": null,
"refs": {
"DeleteScalingPolicyRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> </ul>",
"DeregisterScalableTargetRequest$ScalableDimension": "<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> </ul>",
"DescribeScalableTargetsRequest$ScalableDimension": "<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> </ul>",
"DescribeScalingActivitiesRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> </ul>",
"DescribeScalingPoliciesRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> </ul>",
"PutScalingPolicyRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> </ul>",
"RegisterScalableTargetRequest$ScalableDimension": "<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> </ul>",
"ScalableTarget$ScalableDimension": "<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> </ul>",
"ScalingActivity$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> </ul>",
"ScalingPolicy$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> </ul>"
"DeleteScalingPolicyRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> </ul>",
"DeleteScheduledActionRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> </ul>",
"DeregisterScalableTargetRequest$ScalableDimension": "<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> </ul>",
"DescribeScalableTargetsRequest$ScalableDimension": "<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> </ul>",
"DescribeScalingActivitiesRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> </ul>",
"DescribeScalingPoliciesRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> </ul>",
"DescribeScheduledActionsRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> </ul>",
"PutScalingPolicyRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> </ul>",
"PutScheduledActionRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> </ul>",
"RegisterScalableTargetRequest$ScalableDimension": "<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> </ul>",
"ScalableTarget$ScalableDimension": "<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> </ul>",
"ScalingActivity$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> </ul>",
"ScalingPolicy$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> </ul>",
"ScheduledAction$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> </ul>"
}
},
"ScalableTarget": {
@ -335,6 +384,13 @@
"ScalableTargets$member": null
}
},
"ScalableTargetAction": {
"base": "<p>Represents the minimum and maximum capacity for a scheduled action.</p>",
"refs": {
"PutScheduledActionRequest$ScalableTargetAction": "<p>The new minimum and maximum capacity. You can set both values or just one. During the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.</p>",
"ScheduledAction$ScalableTargetAction": "<p>The new minimum and maximum capacity. You can set both values or just one. During the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.</p>"
}
},
"ScalableTargets": {
"base": null,
"refs": {
@ -368,7 +424,7 @@
"ScalingPolicies": {
"base": null,
"refs": {
"DescribeScalingPoliciesResponse$ScalingPolicies": "<p>A list of scaling policy objects.</p>"
"DescribeScalingPoliciesResponse$ScalingPolicies": "<p>Information about the scaling policies.</p>"
}
},
"ScalingPolicy": {
@ -377,19 +433,42 @@
"ScalingPolicies$member": null
}
},
"ScheduledAction": {
"base": "<p>Represents a scheduled action.</p>",
"refs": {
"ScheduledActions$member": null
}
},
"ScheduledActionName": {
"base": null,
"refs": {
"PutScheduledActionRequest$ScheduledActionName": "<p>The name of the scheduled action.</p>",
"ScheduledAction$ScheduledActionName": "<p>The name of the scheduled action.</p>"
}
},
"ScheduledActions": {
"base": null,
"refs": {
"DescribeScheduledActionsResponse$ScheduledActions": "<p>Information about the scheduled actions.</p>"
}
},
"ServiceNamespace": {
"base": null,
"refs": {
"DeleteScalingPolicyRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"DeleteScheduledActionRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"DeregisterScalableTargetRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"DescribeScalableTargetsRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"DescribeScalingActivitiesRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"DescribeScalingPoliciesRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"DescribeScheduledActionsRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"PutScalingPolicyRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"PutScheduledActionRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"RegisterScalableTargetRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"ScalableTarget$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"ScalingActivity$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"ScalingPolicy$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
"ScalingPolicy$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"ScheduledAction$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
}
},
"StepAdjustment": {
@ -421,10 +500,15 @@
"TimestampType": {
"base": null,
"refs": {
"PutScheduledActionRequest$StartTime": "<p>The date and time for the scheduled action to start.</p>",
"PutScheduledActionRequest$EndTime": "<p>The date and time for the scheduled action to end.</p>",
"ScalableTarget$CreationTime": "<p>The Unix timestamp for when the scalable target was created.</p>",
"ScalingActivity$StartTime": "<p>The Unix timestamp for when the scaling activity began.</p>",
"ScalingActivity$EndTime": "<p>The Unix timestamp for when the scaling activity ended.</p>",
"ScalingPolicy$CreationTime": "<p>The Unix timestamp for when the scaling policy was created.</p>"
"ScalingPolicy$CreationTime": "<p>The Unix timestamp for when the scaling policy was created.</p>",
"ScheduledAction$StartTime": "<p>The date and time that the action is scheduled to begin.</p>",
"ScheduledAction$EndTime": "<p>The date and time that the action is scheduled to end.</p>",
"ScheduledAction$CreationTime": "<p>The date and time that the scheduled action was created.</p>"
}
},
"ValidationException": {
@ -441,6 +525,8 @@
"DescribeScalingActivitiesResponse$NextToken": "<p>The token required to get the next set of results. This value is <code>null</code> if there are no more results to return.</p>",
"DescribeScalingPoliciesRequest$NextToken": "<p>The token for the next set of results.</p>",
"DescribeScalingPoliciesResponse$NextToken": "<p>The token required to get the next set of results. This value is <code>null</code> if there are no more results to return.</p>",
"DescribeScheduledActionsRequest$NextToken": "<p>The token for the next set of results.</p>",
"DescribeScheduledActionsResponse$NextToken": "<p>The token required to get the next set of results. This value is <code>null</code> if there are no more results to return.</p>",
"ScalingActivity$Description": "<p>A simple description of what action the scaling activity intends to accomplish.</p>",
"ScalingActivity$Cause": "<p>A simple description of what caused the scaling activity to happen.</p>",
"ScalingActivity$StatusMessage": "<p>A simple message about the current status of the scaling activity.</p>",

View File

@ -6,6 +6,7 @@
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"Amazon AppStream",
"serviceId":"AppStream",
"signatureVersion":"v4",
"signingName":"appstream",
"targetPrefix":"PhotonAdminProxyService",
@ -307,6 +308,18 @@
"input":{"shape":"ListAssociatedStacksRequest"},
"output":{"shape":"ListAssociatedStacksResult"}
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"ResourceNotFoundException"}
]
},
"StartFleet":{
"name":"StartFleet",
"http":{
@ -333,7 +346,8 @@
"errors":[
{"shape":"ResourceNotAvailableException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConcurrentModificationException"}
{"shape":"ConcurrentModificationException"},
{"shape":"IncompatibleImageException"}
]
},
"StopFleet":{
@ -363,6 +377,31 @@
{"shape":"ConcurrentModificationException"}
]
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"}
]
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"ResourceNotFoundException"}
]
},
"UpdateDirectoryConfig":{
"name":"UpdateDirectoryConfig",
"http":{
@ -443,6 +482,11 @@
"type":"list",
"member":{"shape":"Application"}
},
"AppstreamAgentVersion":{
"type":"string",
"max":100,
"min":1
},
"Arn":{
"type":"string",
"pattern":"^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$"
@ -560,7 +604,8 @@
"DisplayName":{"shape":"DisplayName"},
"VpcConfig":{"shape":"VpcConfig"},
"EnableDefaultInternetAccess":{"shape":"BooleanObject"},
"DomainJoinInfo":{"shape":"DomainJoinInfo"}
"DomainJoinInfo":{"shape":"DomainJoinInfo"},
"AppstreamAgentVersion":{"shape":"AppstreamAgentVersion"}
}
},
"CreateImageBuilderResult":{
@ -959,7 +1004,8 @@
"StateChangeReason":{"shape":"ImageStateChangeReason"},
"Applications":{"shape":"Applications"},
"CreatedTime":{"shape":"Timestamp"},
"PublicBaseImageReleasedDate":{"shape":"Timestamp"}
"PublicBaseImageReleasedDate":{"shape":"Timestamp"},
"AppstreamAgentVersion":{"shape":"AppstreamAgentVersion"}
}
},
"ImageBuilder":{
@ -979,7 +1025,8 @@
"CreatedTime":{"shape":"Timestamp"},
"EnableDefaultInternetAccess":{"shape":"BooleanObject"},
"DomainJoinInfo":{"shape":"DomainJoinInfo"},
"ImageBuilderErrors":{"shape":"ResourceErrors"}
"ImageBuilderErrors":{"shape":"ResourceErrors"},
"AppstreamAgentVersion":{"shape":"AppstreamAgentVersion"}
}
},
"ImageBuilderList":{
@ -990,6 +1037,7 @@
"type":"string",
"enum":[
"PENDING",
"UPDATING_AGENT",
"RUNNING",
"STOPPING",
"STOPPED",
@ -1099,6 +1147,19 @@
"NextToken":{"shape":"String"}
}
},
"ListTagsForResourceRequest":{
"type":"structure",
"required":["ResourceArn"],
"members":{
"ResourceArn":{"shape":"Arn"}
}
},
"ListTagsForResourceResponse":{
"type":"structure",
"members":{
"Tags":{"shape":"Tags"}
}
},
"Long":{"type":"long"},
"Metadata":{
"type":"map",
@ -1269,7 +1330,8 @@
"type":"structure",
"required":["Name"],
"members":{
"Name":{"shape":"String"}
"Name":{"shape":"String"},
"AppstreamAgentVersion":{"shape":"AppstreamAgentVersion"}
}
},
"StartImageBuilderResult":{
@ -1337,7 +1399,64 @@
"type":"list",
"member":{"shape":"String"}
},
"TagKey":{
"type":"string",
"max":128,
"min":1,
"pattern":"^(^(?!aws:).[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
},
"TagKeyList":{
"type":"list",
"member":{"shape":"TagKey"},
"max":50,
"min":1
},
"TagResourceRequest":{
"type":"structure",
"required":[
"ResourceArn",
"Tags"
],
"members":{
"ResourceArn":{"shape":"Arn"},
"Tags":{"shape":"Tags"}
}
},
"TagResourceResponse":{
"type":"structure",
"members":{
}
},
"TagValue":{
"type":"string",
"max":256,
"min":0,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
},
"Tags":{
"type":"map",
"key":{"shape":"TagKey"},
"value":{"shape":"TagValue"},
"max":50,
"min":1
},
"Timestamp":{"type":"timestamp"},
"UntagResourceRequest":{
"type":"structure",
"required":[
"ResourceArn",
"TagKeys"
],
"members":{
"ResourceArn":{"shape":"Arn"},
"TagKeys":{"shape":"TagKeyList"}
}
},
"UntagResourceResponse":{
"type":"structure",
"members":{
}
},
"UpdateDirectoryConfigRequest":{
"type":"structure",
"required":["DirectoryName"],

View File

@ -5,18 +5,18 @@
"AssociateFleet": "<p>Associates the specified fleet with the specified stack.</p>",
"CreateDirectoryConfig": "<p>Creates a directory configuration.</p>",
"CreateFleet": "<p>Creates a fleet.</p>",
"CreateImageBuilder": null,
"CreateImageBuilderStreamingURL": null,
"CreateImageBuilder": "<p>Creates an image builder.</p> <p>The initial state of the builder is <code>PENDING</code>. When it is ready, the state is <code>RUNNING</code>.</p>",
"CreateImageBuilderStreamingURL": "<p>Creates a URL to start an image builder streaming session.</p>",
"CreateStack": "<p>Creates a stack.</p>",
"CreateStreamingURL": "<p>Creates a URL to start a streaming session for the specified user.</p> <p>By default, the URL is valid only for one minute from the time that it is generated.</p>",
"CreateStreamingURL": "<p>Creates a URL to start a streaming session for the specified user.</p>",
"DeleteDirectoryConfig": "<p>Deletes the specified directory configuration.</p>",
"DeleteFleet": "<p>Deletes the specified fleet.</p>",
"DeleteImage": null,
"DeleteImageBuilder": null,
"DeleteImage": "<p>Deletes the specified image. You cannot delete an image that is currently in use. After you delete an image, you cannot provision new capacity using the image.</p>",
"DeleteImageBuilder": "<p>Deletes the specified image builder and releases the capacity.</p>",
"DeleteStack": "<p>Deletes the specified stack. After this operation completes, the environment can no longer be activated and any reservations made for the stack are released.</p>",
"DescribeDirectoryConfigs": "<p>Describes the specified directory configurations.</p>",
"DescribeFleets": "<p>Describes the specified fleets or all fleets in the account.</p>",
"DescribeImageBuilders": null,
"DescribeImageBuilders": "<p>Describes the specified image builders or all image builders in the account.</p>",
"DescribeImages": "<p>Describes the specified images or all images in the account.</p>",
"DescribeSessions": "<p>Describes the streaming sessions for the specified stack and fleet. If a user ID is provided, only the streaming sessions for only that user are returned. If an authentication type is not provided, the default is to authenticate users using a streaming URL.</p>",
"DescribeStacks": "<p>Describes the specified stacks or all stacks in the account.</p>",
@ -24,10 +24,13 @@
"ExpireSession": "<p>Stops the specified streaming session.</p>",
"ListAssociatedFleets": "<p>Lists the fleets associated with the specified stack.</p>",
"ListAssociatedStacks": "<p>Lists the stacks associated with the specified fleet.</p>",
"ListTagsForResource": "<p>Lists the tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.</p> <p>For more information about tags, see <a href=\"http://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>",
"StartFleet": "<p>Starts the specified fleet.</p>",
"StartImageBuilder": null,
"StartImageBuilder": "<p>Starts the specified image builder.</p>",
"StopFleet": "<p>Stops the specified fleet.</p>",
"StopImageBuilder": null,
"StopImageBuilder": "<p>Stops the specified image builder.</p>",
"TagResource": "<p>Adds or overwrites one or more tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.</p> <p>Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value.</p> <p>To list the current tags for your resources, use <a>ListTagsForResource</a>. To disassociate tags from your resources, use <a>UntagResource</a>.</p> <p>For more information about tags, see <a href=\"http://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>",
"UntagResource": "<p>Disassociates the specified tags from the specified AppStream 2.0 resource.</p> <p>To list the current tags for your resources, use <a>ListTagsForResource</a>.</p> <p>For more information about tags, see <a href=\"http://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>",
"UpdateDirectoryConfig": "<p>Updates the specified directory configuration.</p>",
"UpdateFleet": "<p>Updates the specified fleet.</p> <p>If the fleet is in the <code>STOPPED</code> state, you can update any attribute except the fleet name. If the fleet is in the <code>RUNNING</code> state, you can update the <code>DisplayName</code> and <code>ComputeCapacity</code> attributes. If the fleet is in the <code>STARTING</code> or <code>STOPPING</code> state, you can't update it.</p>",
"UpdateStack": "<p>Updates the specified stack.</p>"
@ -57,15 +60,27 @@
"Image$Applications": "<p>The applications associated with the image.</p>"
}
},
"AppstreamAgentVersion": {
"base": null,
"refs": {
"CreateImageBuilderRequest$AppstreamAgentVersion": "<p>The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST]. </p>",
"Image$AppstreamAgentVersion": "<p>The version of the AppStream 2.0 agent to use for instances that are launched from this image. </p>",
"ImageBuilder$AppstreamAgentVersion": "<p>The version of the AppStream 2.0 agent that is currently being used by this image builder. </p>",
"StartImageBuilderRequest$AppstreamAgentVersion": "<p>The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST]. </p>"
}
},
"Arn": {
"base": null,
"refs": {
"Fleet$Arn": "<p>The ARN for the fleet.</p>",
"Image$Arn": "<p>The ARN of the image.</p>",
"Image$BaseImageArn": "<p>The ARN of the image from which this image was created.</p>",
"ImageBuilder$Arn": null,
"ImageBuilder$ImageArn": null,
"Stack$Arn": "<p>The ARN of the stack.</p>"
"ImageBuilder$Arn": "<p>The ARN for the image builder.</p>",
"ImageBuilder$ImageArn": "<p>The ARN of the image from which this builder was created.</p>",
"ListTagsForResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>",
"Stack$Arn": "<p>The ARN of the stack.</p>",
"TagResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>",
"UntagResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>"
}
},
"AssociateFleetRequest": {
@ -98,9 +113,9 @@
"base": null,
"refs": {
"CreateFleetRequest$EnableDefaultInternetAccess": "<p>Enables or disables default internet access for the fleet.</p>",
"CreateImageBuilderRequest$EnableDefaultInternetAccess": null,
"CreateImageBuilderRequest$EnableDefaultInternetAccess": "<p>Enables or disables default internet access for the image builder.</p>",
"Fleet$EnableDefaultInternetAccess": "<p>Indicates whether default internet access is enabled for the fleet.</p>",
"ImageBuilder$EnableDefaultInternetAccess": null,
"ImageBuilder$EnableDefaultInternetAccess": "<p>Enables or disables default internet access for the image builder.</p>",
"UpdateFleetRequest$EnableDefaultInternetAccess": "<p>Enables or disables default internet access for the fleet.</p>"
}
},
@ -295,11 +310,11 @@
"Description": {
"base": null,
"refs": {
"CreateFleetRequest$Description": "<p>The description displayed to end users.</p>",
"CreateImageBuilderRequest$Description": null,
"CreateStackRequest$Description": "<p>The description displayed to end users.</p>",
"UpdateFleetRequest$Description": "<p>The description displayed to end users.</p>",
"UpdateStackRequest$Description": "<p>The description displayed to end users.</p>"
"CreateFleetRequest$Description": "<p>The description for display.</p>",
"CreateImageBuilderRequest$Description": "<p>The description for display.</p>",
"CreateStackRequest$Description": "<p>The description for display.</p>",
"UpdateFleetRequest$Description": "<p>The description for display.</p>",
"UpdateStackRequest$Description": "<p>The description for display.</p>"
}
},
"DirectoryConfig": {
@ -346,21 +361,21 @@
"DisplayName": {
"base": null,
"refs": {
"CreateFleetRequest$DisplayName": "<p>The fleet name displayed to end users.</p>",
"CreateImageBuilderRequest$DisplayName": null,
"CreateStackRequest$DisplayName": "<p>The stack name displayed to end users.</p>",
"UpdateFleetRequest$DisplayName": "<p>The fleet name displayed to end users.</p>",
"UpdateStackRequest$DisplayName": "<p>The stack name displayed to end users.</p>"
"CreateFleetRequest$DisplayName": "<p>The fleet name for display.</p>",
"CreateImageBuilderRequest$DisplayName": "<p>The image builder name for display.</p>",
"CreateStackRequest$DisplayName": "<p>The stack name for display.</p>",
"UpdateFleetRequest$DisplayName": "<p>The fleet name for display.</p>",
"UpdateStackRequest$DisplayName": "<p>The stack name for display.</p>"
}
},
"DomainJoinInfo": {
"base": "<p>Contains the information needed for streaming instances to join a domain.</p>",
"base": "<p>Contains the information needed to join a Microsoft Active Directory domain.</p>",
"refs": {
"CreateFleetRequest$DomainJoinInfo": "<p>The information needed for streaming instances to join a domain.</p>",
"CreateImageBuilderRequest$DomainJoinInfo": null,
"Fleet$DomainJoinInfo": "<p>The information needed for streaming instances to join a domain.</p>",
"ImageBuilder$DomainJoinInfo": null,
"UpdateFleetRequest$DomainJoinInfo": "<p>The information needed for streaming instances to join a domain.</p>"
"CreateFleetRequest$DomainJoinInfo": "<p>The information needed to join a Microsoft Active Directory domain.</p>",
"CreateImageBuilderRequest$DomainJoinInfo": "<p>The information needed to join a Microsoft Active Directory domain.</p>",
"Fleet$DomainJoinInfo": "<p>The information needed to join a Microsoft Active Directory domain.</p>",
"ImageBuilder$DomainJoinInfo": "<p>The information needed to join a Microsoft Active Directory domain.</p>",
"UpdateFleetRequest$DomainJoinInfo": "<p>The information needed to join a Microsoft Active Directory domain.</p>"
}
},
"ErrorMessage": {
@ -418,7 +433,7 @@
"base": null,
"refs": {
"FleetError$ErrorCode": "<p>The error code.</p>",
"ResourceError$ErrorCode": null
"ResourceError$ErrorCode": "<p>The error code.</p>"
}
},
"FleetErrors": {
@ -442,49 +457,49 @@
"FleetType": {
"base": null,
"refs": {
"CreateFleetRequest$FleetType": null,
"Fleet$FleetType": null
"CreateFleetRequest$FleetType": "<p>The fleet type.</p> <dl> <dt>ALWAYS_ON</dt> <dd> <p>Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.</p> </dd> <dt>ON_DEMAND</dt> <dd> <p>Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.</p> </dd> </dl>",
"Fleet$FleetType": "<p>The fleet type.</p> <dl> <dt>ALWAYS_ON</dt> <dd> <p>Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.</p> </dd> <dt>ON_DEMAND</dt> <dd> <p>Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.</p> </dd> </dl>"
}
},
"Image": {
"base": "<p>Describes an image.</p>",
"refs": {
"DeleteImageResult$Image": null,
"DeleteImageResult$Image": "<p>Information about the image.</p>",
"ImageList$member": null
}
},
"ImageBuilder": {
"base": null,
"base": "<p>Describes a streaming instance used for editing an image. New images are created from a snapshot through an image builder.</p>",
"refs": {
"CreateImageBuilderResult$ImageBuilder": null,
"DeleteImageBuilderResult$ImageBuilder": null,
"CreateImageBuilderResult$ImageBuilder": "<p>Information about the image builder.</p>",
"DeleteImageBuilderResult$ImageBuilder": "<p>Information about the image builder.</p>",
"ImageBuilderList$member": null,
"StartImageBuilderResult$ImageBuilder": null,
"StopImageBuilderResult$ImageBuilder": null
"StartImageBuilderResult$ImageBuilder": "<p>Information about the image builder.</p>",
"StopImageBuilderResult$ImageBuilder": "<p>Information about the image builder.</p>"
}
},
"ImageBuilderList": {
"base": null,
"refs": {
"DescribeImageBuildersResult$ImageBuilders": null
"DescribeImageBuildersResult$ImageBuilders": "<p>Information about the image builders.</p>"
}
},
"ImageBuilderState": {
"base": null,
"refs": {
"ImageBuilder$State": null
"ImageBuilder$State": "<p>The state of the image builder.</p>"
}
},
"ImageBuilderStateChangeReason": {
"base": null,
"base": "<p>Describes the reason why the last image builder state change occurred.</p>",
"refs": {
"ImageBuilder$StateChangeReason": null
"ImageBuilder$StateChangeReason": "<p>The reason why the last state change occurred.</p>"
}
},
"ImageBuilderStateChangeReasonCode": {
"base": null,
"refs": {
"ImageBuilderStateChangeReason$Code": null
"ImageBuilderStateChangeReason$Code": "<p>The state change reason code.</p>"
}
},
"ImageList": {
@ -500,7 +515,7 @@
}
},
"ImageStateChangeReason": {
"base": "<p>Describes the reason why the last state change occurred.</p>",
"base": "<p>Describes the reason why the last image state change occurred.</p>",
"refs": {
"Image$StateChangeReason": "<p>The reason why the last state change occurred.</p>"
}
@ -527,7 +542,7 @@
"CreateFleetRequest$MaxUserDurationInSeconds": "<p>The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.</p>",
"CreateFleetRequest$DisconnectTimeoutInSeconds": "<p>The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.</p>",
"DescribeDirectoryConfigsRequest$MaxResults": "<p>The maximum size of each page of results.</p>",
"DescribeImageBuildersRequest$MaxResults": null,
"DescribeImageBuildersRequest$MaxResults": "<p>The maximum size of each page of results.</p>",
"DescribeSessionsRequest$Limit": "<p>The size of each page of results. The default value is 20 and the maximum value is 50.</p>",
"Fleet$MaxUserDurationInSeconds": "<p>The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.</p>",
"Fleet$DisconnectTimeoutInSeconds": "<p>The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.</p>",
@ -570,11 +585,21 @@
"refs": {
}
},
"ListTagsForResourceRequest": {
"base": null,
"refs": {
}
},
"ListTagsForResourceResponse": {
"base": null,
"refs": {
}
},
"Long": {
"base": null,
"refs": {
"CreateImageBuilderStreamingURLRequest$Validity": null,
"CreateStreamingURLRequest$Validity": "<p>The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds.</p>"
"CreateImageBuilderStreamingURLRequest$Validity": "<p>The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 3600 seconds.</p>",
"CreateStreamingURLRequest$Validity": "<p>The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 60 seconds.</p>"
}
},
"Metadata": {
@ -587,9 +612,9 @@
"base": null,
"refs": {
"CreateFleetRequest$Name": "<p>A unique name for the fleet.</p>",
"CreateImageBuilderRequest$Name": null,
"DeleteImageBuilderRequest$Name": null,
"DeleteImageRequest$Name": null
"CreateImageBuilderRequest$Name": "<p>A unique name for the image builder.</p>",
"DeleteImageBuilderRequest$Name": "<p>The name of the image builder.</p>",
"DeleteImageRequest$Name": "<p>The name of the image.</p>"
}
},
"OperationNotPermittedException": {
@ -616,7 +641,7 @@
"base": null,
"refs": {
"Image$Platform": "<p>The operating system platform of the image.</p>",
"ImageBuilder$Platform": null
"ImageBuilder$Platform": "<p>The operating system platform of the image builder.</p>"
}
},
"ResourceAlreadyExistsException": {
@ -625,7 +650,7 @@
}
},
"ResourceError": {
"base": null,
"base": "<p>Describes a resource error.</p>",
"refs": {
"ResourceErrors$member": null
}
@ -633,7 +658,7 @@
"ResourceErrors": {
"base": null,
"refs": {
"ImageBuilder$ImageBuilderErrors": null
"ImageBuilder$ImageBuilderErrors": "<p>The image builder errors.</p>"
}
},
"ResourceIdentifier": {
@ -791,23 +816,23 @@
"base": null,
"refs": {
"Application$Name": "<p>The name of the application.</p>",
"Application$DisplayName": "<p>The application name displayed to end users.</p>",
"Application$DisplayName": "<p>The application name for display.</p>",
"Application$IconURL": "<p>The URL for the application icon. This URL might be time-limited.</p>",
"Application$LaunchPath": "<p>The path to the application executable in the instance.</p>",
"Application$LaunchParameters": "<p>The arguments that are passed to the application at launch.</p>",
"AssociateFleetRequest$FleetName": "<p>The name of the fleet.</p>",
"AssociateFleetRequest$StackName": "<p>The name of the stack.</p>",
"CreateFleetRequest$ImageName": "<p>The name of the image used by the fleet.</p>",
"CreateFleetRequest$ImageName": "<p>The name of the image used to create the fleet.</p>",
"CreateFleetRequest$InstanceType": "<p>The instance type to use when launching fleet instances. The following instance types are available:</p> <ul> <li> <p>stream.standard.medium</p> </li> <li> <p>stream.standard.large</p> </li> <li> <p>stream.compute.large</p> </li> <li> <p>stream.compute.xlarge</p> </li> <li> <p>stream.compute.2xlarge</p> </li> <li> <p>stream.compute.4xlarge</p> </li> <li> <p>stream.compute.8xlarge</p> </li> <li> <p>stream.memory.large</p> </li> <li> <p>stream.memory.xlarge</p> </li> <li> <p>stream.memory.2xlarge</p> </li> <li> <p>stream.memory.4xlarge</p> </li> <li> <p>stream.memory.8xlarge</p> </li> <li> <p>stream.graphics-design.large</p> </li> <li> <p>stream.graphics-design.xlarge</p> </li> <li> <p>stream.graphics-design.2xlarge</p> </li> <li> <p>stream.graphics-design.4xlarge</p> </li> <li> <p>stream.graphics-desktop.2xlarge</p> </li> <li> <p>stream.graphics-pro.4xlarge</p> </li> <li> <p>stream.graphics-pro.8xlarge</p> </li> <li> <p>stream.graphics-pro.16xlarge</p> </li> </ul>",
"CreateImageBuilderRequest$ImageName": null,
"CreateImageBuilderRequest$InstanceType": null,
"CreateImageBuilderStreamingURLRequest$Name": null,
"CreateImageBuilderStreamingURLResult$StreamingURL": null,
"CreateImageBuilderRequest$ImageName": "<p>The name of the image used to create the builder.</p>",
"CreateImageBuilderRequest$InstanceType": "<p>The instance type to use when launching the image builder.</p>",
"CreateImageBuilderStreamingURLRequest$Name": "<p>The name of the image builder.</p>",
"CreateImageBuilderStreamingURLResult$StreamingURL": "<p>The URL to start the AppStream 2.0 streaming session.</p>",
"CreateStackRequest$Name": "<p>The name of the stack.</p>",
"CreateStreamingURLRequest$StackName": "<p>The name of the stack.</p>",
"CreateStreamingURLRequest$FleetName": "<p>The name of the fleet.</p>",
"CreateStreamingURLRequest$ApplicationId": "<p>The ID of the application that must be launched after the session starts.</p>",
"CreateStreamingURLRequest$SessionContext": "<p>The session context of the streaming URL.</p>",
"CreateStreamingURLRequest$ApplicationId": "<p>The name of the application to launch after the session starts. This is the name that you specified as <b>Name</b> in the Image Assistant.</p>",
"CreateStreamingURLRequest$SessionContext": "<p>The session context. For more information, see <a href=\"http://docs.aws.amazon.com/appstream2/latest/developerguide/managing-stacks-fleets.html#managing-stacks-fleets-parameters\">Session Context</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>",
"CreateStreamingURLResult$StreamingURL": "<p>The URL to start the AppStream 2.0 streaming session.</p>",
"DeleteFleetRequest$Name": "<p>The name of the fleet.</p>",
"DeleteStackRequest$Name": "<p>The name of the stack.</p>",
@ -815,8 +840,8 @@
"DescribeDirectoryConfigsResult$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>",
"DescribeFleetsRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>",
"DescribeFleetsResult$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>",
"DescribeImageBuildersRequest$NextToken": null,
"DescribeImageBuildersResult$NextToken": null,
"DescribeImageBuildersRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>",
"DescribeImageBuildersResult$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>",
"DescribeSessionsRequest$StackName": "<p>The name of the stack.</p>",
"DescribeSessionsRequest$FleetName": "<p>The name of the fleet.</p>",
"DescribeSessionsRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>",
@ -827,19 +852,19 @@
"DisassociateFleetRequest$StackName": "<p>The name of the stack.</p>",
"ExpireSessionRequest$SessionId": "<p>The ID of the streaming session.</p>",
"Fleet$Name": "<p>The name of the fleet.</p>",
"Fleet$DisplayName": "<p>The fleet name displayed to end users.</p>",
"Fleet$Description": "<p>The description displayed to end users.</p>",
"Fleet$ImageName": "<p>The image used by the fleet.</p>",
"Fleet$DisplayName": "<p>The fleet name for display.</p>",
"Fleet$Description": "<p>The description for display.</p>",
"Fleet$ImageName": "<p>The name of the image used to create the fleet.</p>",
"Fleet$InstanceType": "<p>The instance type to use when launching fleet instances.</p>",
"FleetError$ErrorMessage": "<p>The error message.</p>",
"Image$Name": "<p>The name of the image.</p>",
"Image$DisplayName": "<p>The image name displayed to end users.</p>",
"Image$Description": "<p>The description displayed to end users.</p>",
"ImageBuilder$Name": null,
"ImageBuilder$Description": null,
"ImageBuilder$DisplayName": null,
"ImageBuilder$InstanceType": null,
"ImageBuilderStateChangeReason$Message": null,
"Image$DisplayName": "<p>The image name for display.</p>",
"Image$Description": "<p>The description for display.</p>",
"ImageBuilder$Name": "<p>The name of the image builder.</p>",
"ImageBuilder$Description": "<p>The description for display.</p>",
"ImageBuilder$DisplayName": "<p>The image builder name for display.</p>",
"ImageBuilder$InstanceType": "<p>The instance type for the image builder.</p>",
"ImageBuilderStateChangeReason$Message": "<p>The state change reason message.</p>",
"ImageStateChangeReason$Message": "<p>The state change reason message.</p>",
"ListAssociatedFleetsRequest$StackName": "<p>The name of the stack.</p>",
"ListAssociatedFleetsRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>",
@ -849,22 +874,22 @@
"ListAssociatedStacksResult$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>",
"Metadata$key": null,
"Metadata$value": null,
"ResourceError$ErrorMessage": null,
"ResourceError$ErrorMessage": "<p>The error message.</p>",
"SecurityGroupIdList$member": null,
"Session$Id": "<p>The ID of the streaming session.</p>",
"Session$StackName": "<p>The name of the stack for the streaming session.</p>",
"Session$FleetName": "<p>The name of the fleet for the streaming session.</p>",
"Stack$Name": "<p>The name of the stack.</p>",
"Stack$Description": "<p>The description displayed to end users.</p>",
"Stack$DisplayName": "<p>The stack name displayed to end users.</p>",
"Stack$Description": "<p>The description for display.</p>",
"Stack$DisplayName": "<p>The stack name for display.</p>",
"StackError$ErrorMessage": "<p>The error message.</p>",
"StartFleetRequest$Name": "<p>The name of the fleet.</p>",
"StartImageBuilderRequest$Name": null,
"StartImageBuilderRequest$Name": "<p>The name of the image builder.</p>",
"StopFleetRequest$Name": "<p>The name of the fleet.</p>",
"StopImageBuilderRequest$Name": null,
"StopImageBuilderRequest$Name": "<p>The name of the image builder.</p>",
"StringList$member": null,
"SubnetIdList$member": null,
"UpdateFleetRequest$ImageName": "<p>The name of the image used by the fleet.</p>",
"UpdateFleetRequest$ImageName": "<p>The name of the image used to create the fleet.</p>",
"UpdateFleetRequest$Name": "<p>A unique name for the fleet.</p>",
"UpdateFleetRequest$InstanceType": "<p>The instance type to use when launching fleet instances. The following instance types are available:</p> <ul> <li> <p>stream.standard.medium</p> </li> <li> <p>stream.standard.large</p> </li> <li> <p>stream.compute.large</p> </li> <li> <p>stream.compute.xlarge</p> </li> <li> <p>stream.compute.2xlarge</p> </li> <li> <p>stream.compute.4xlarge</p> </li> <li> <p>stream.compute.8xlarge</p> </li> <li> <p>stream.memory.large</p> </li> <li> <p>stream.memory.xlarge</p> </li> <li> <p>stream.memory.2xlarge</p> </li> <li> <p>stream.memory.4xlarge</p> </li> <li> <p>stream.memory.8xlarge</p> </li> <li> <p>stream.graphics-design.large</p> </li> <li> <p>stream.graphics-design.xlarge</p> </li> <li> <p>stream.graphics-design.2xlarge</p> </li> <li> <p>stream.graphics-design.4xlarge</p> </li> <li> <p>stream.graphics-desktop.2xlarge</p> </li> <li> <p>stream.graphics-pro.4xlarge</p> </li> <li> <p>stream.graphics-pro.8xlarge</p> </li> <li> <p>stream.graphics-pro.16xlarge</p> </li> </ul>",
"UpdateStackRequest$Name": "<p>The name of the stack.</p>"
@ -874,7 +899,7 @@
"base": null,
"refs": {
"DescribeFleetsRequest$Names": "<p>The names of the fleets to describe.</p>",
"DescribeImageBuildersRequest$Names": null,
"DescribeImageBuildersRequest$Names": "<p>The names of the image builders to describe.</p>",
"DescribeImagesRequest$Names": "<p>The names of the images to describe.</p>",
"DescribeStacksRequest$Names": "<p>The names of the stacks to describe.</p>",
"ListAssociatedFleetsResult$Names": "<p>The names of the fleets.</p>",
@ -887,20 +912,66 @@
"VpcConfig$SubnetIds": "<p>The subnets to which a network interface is established from the fleet instance.</p>"
}
},
"TagKey": {
"base": null,
"refs": {
"TagKeyList$member": null,
"Tags$key": null
}
},
"TagKeyList": {
"base": null,
"refs": {
"UntagResourceRequest$TagKeys": "<p>The tag keys for the tags to disassociate.</p>"
}
},
"TagResourceRequest": {
"base": null,
"refs": {
}
},
"TagResourceResponse": {
"base": null,
"refs": {
}
},
"TagValue": {
"base": null,
"refs": {
"Tags$value": null
}
},
"Tags": {
"base": null,
"refs": {
"ListTagsForResourceResponse$Tags": "<p>The information about the tags.</p>",
"TagResourceRequest$Tags": "<p>The tags to associate. A tag is a key-value pair (the value is optional). For example, <code>Environment=Test</code>, or, if you do not specify a value, <code>Environment=</code>. </p> <p>If you do not specify a value, we set the value to an empty string.</p>"
}
},
"Timestamp": {
"base": null,
"refs": {
"CreateImageBuilderStreamingURLResult$Expires": null,
"CreateImageBuilderStreamingURLResult$Expires": "<p>The elapsed time, in seconds after the Unix epoch, when this URL expires.</p>",
"CreateStreamingURLResult$Expires": "<p>The elapsed time, in seconds after the Unix epoch, when this URL expires.</p>",
"DirectoryConfig$CreatedTime": "<p>The time the directory configuration was created.</p>",
"Fleet$CreatedTime": "<p>The time the fleet was created.</p>",
"Image$CreatedTime": "<p>The time the image was created.</p>",
"Image$PublicBaseImageReleasedDate": "<p>The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.</p>",
"ImageBuilder$CreatedTime": null,
"ResourceError$ErrorTimestamp": null,
"ImageBuilder$CreatedTime": "<p>The time stamp when the image builder was created.</p>",
"ResourceError$ErrorTimestamp": "<p>The time the error occurred.</p>",
"Stack$CreatedTime": "<p>The time the stack was created.</p>"
}
},
"UntagResourceRequest": {
"base": null,
"refs": {
}
},
"UntagResourceResponse": {
"base": null,
"refs": {
}
},
"UpdateDirectoryConfigRequest": {
"base": null,
"refs": {
@ -948,9 +1019,9 @@
"base": "<p>Describes VPC configuration information.</p>",
"refs": {
"CreateFleetRequest$VpcConfig": "<p>The VPC configuration for the fleet.</p>",
"CreateImageBuilderRequest$VpcConfig": null,
"CreateImageBuilderRequest$VpcConfig": "<p>The VPC configuration for the image builder. You can specify only one subnet.</p>",
"Fleet$VpcConfig": "<p>The VPC configuration for the fleet.</p>",
"ImageBuilder$VpcConfig": null,
"ImageBuilder$VpcConfig": "<p>The VPC configuration of the image builder.</p>",
"UpdateFleetRequest$VpcConfig": "<p>The VPC configuration for the fleet.</p>"
}
}

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,654 @@
{
"version": "2.0",
"service": "<p>AWS AppSync provides API actions for creating and interacting with data sources using GraphQL from your application.</p>",
"operations": {
"CreateApiKey": "<p>Creates a unique key that you can distribute to clients who are executing your API.</p>",
"CreateDataSource": "<p>Creates a <code>DataSource</code> object.</p>",
"CreateGraphqlApi": "<p>Creates a <code>GraphqlApi</code> object.</p>",
"CreateResolver": "<p>Creates a <code>Resolver</code> object.</p> <p>A resolver converts incoming requests into a format that a data source can understand and converts the data source's responses into GraphQL.</p>",
"CreateType": "<p>Creates a <code>Type</code> object.</p>",
"DeleteApiKey": "<p>Deletes an API key.</p>",
"DeleteDataSource": "<p>Deletes a <code>DataSource</code> object.</p>",
"DeleteGraphqlApi": "<p>Deletes a <code>GraphqlApi</code> object.</p>",
"DeleteResolver": "<p>Deletes a <code>Resolver</code> object.</p>",
"DeleteType": "<p>Deletes a <code>Type</code> object.</p>",
"GetDataSource": "<p>Retrieves a <code>DataSource</code> object.</p>",
"GetGraphqlApi": "<p>Retrieves a <code>GraphqlApi</code> object.</p>",
"GetIntrospectionSchema": "<p>Retrieves the introspection schema for a GraphQL API.</p>",
"GetResolver": "<p>Retrieves a <code>Resolver</code> object.</p>",
"GetSchemaCreationStatus": "<p>Retrieves the current status of a schema creation operation.</p>",
"GetType": "<p>Retrieves a <code>Type</code> object.</p>",
"ListApiKeys": "<p>Lists the API keys for a given API.</p>",
"ListDataSources": "<p>Lists the data sources for a given API.</p>",
"ListGraphqlApis": "<p>Lists your GraphQL APIs.</p>",
"ListResolvers": "<p>Lists the resolvers for a given API and type.</p>",
"ListTypes": "<p>Lists the types for a given API.</p>",
"StartSchemaCreation": "<p>Adds a new schema to your GraphQL API.</p> <p>This operation is asynchronous. Use to determine when it has completed.</p>",
"UpdateDataSource": "<p>Updates a <code>DataSource</code> object.</p>",
"UpdateGraphqlApi": "<p>Updates a <code>GraphqlApi</code> object.</p>",
"UpdateResolver": "<p>Updates a <code>Resolver</code> object.</p>",
"UpdateType": "<p>Updates a <code>Type</code> object.</p>"
},
"shapes": {
"ApiKey": {
"base": "<p>Describes an API key.</p>",
"refs": {
"ApiKeys$member": null,
"CreateApiKeyResponse$apiKey": "<p>The API key.</p>"
}
},
"ApiKeyLimitExceededException": {
"base": "<p>The API key exceeded a limit. Try your request again.</p>",
"refs": {
}
},
"ApiKeys": {
"base": null,
"refs": {
"ListApiKeysResponse$apiKeys": "<p>The <code>ApiKey</code> objects.</p>"
}
},
"ApiLimitExceededException": {
"base": "<p>The GraphQL API exceeded a limit. Try your request again.</p>",
"refs": {
}
},
"AuthenticationType": {
"base": null,
"refs": {
"CreateGraphqlApiRequest$authenticationType": "<p>The authentication type: API key, IAM, or Amazon Cognito User Pools.</p>",
"GraphqlApi$authenticationType": "<p>The authentication type.</p>",
"UpdateGraphqlApiRequest$authenticationType": "<p>The new authentication type for the <code>GraphqlApi</code> object.</p>"
}
},
"BadRequestException": {
"base": "<p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again. </p>",
"refs": {
}
},
"Blob": {
"base": null,
"refs": {
"GetIntrospectionSchemaResponse$schema": "<p>The schema, in GraphQL Schema Definition Language (SDL) format.</p> <p>For more information, see the <a href=\"http://graphql.org/learn/schema/\">GraphQL SDL documentation</a>.</p>",
"StartSchemaCreationRequest$definition": "<p>The schema definition, in GraphQL schema language format.</p>"
}
},
"Boolean": {
"base": null,
"refs": {
"DynamodbDataSourceConfig$useCallerCredentials": "<p>Set to TRUE to use Amazon Cognito credentials with this data source.</p>"
}
},
"ConcurrentModificationException": {
"base": "<p>Another modification is being made. That modification must complete before you can make your change. </p>",
"refs": {
}
},
"CreateApiKeyRequest": {
"base": null,
"refs": {
}
},
"CreateApiKeyResponse": {
"base": null,
"refs": {
}
},
"CreateDataSourceRequest": {
"base": null,
"refs": {
}
},
"CreateDataSourceResponse": {
"base": null,
"refs": {
}
},
"CreateGraphqlApiRequest": {
"base": null,
"refs": {
}
},
"CreateGraphqlApiResponse": {
"base": null,
"refs": {
}
},
"CreateResolverRequest": {
"base": null,
"refs": {
}
},
"CreateResolverResponse": {
"base": null,
"refs": {
}
},
"CreateTypeRequest": {
"base": null,
"refs": {
}
},
"CreateTypeResponse": {
"base": null,
"refs": {
}
},
"DataSource": {
"base": "<p>Describes a data source.</p>",
"refs": {
"CreateDataSourceResponse$dataSource": "<p>The <code>DataSource</code> object.</p>",
"DataSources$member": null,
"GetDataSourceResponse$dataSource": "<p>The <code>DataSource</code> object.</p>",
"UpdateDataSourceResponse$dataSource": "<p>The updated <code>DataSource</code> object.</p>"
}
},
"DataSourceType": {
"base": null,
"refs": {
"CreateDataSourceRequest$type": "<p>The type of the <code>DataSource</code>.</p>",
"DataSource$type": "<p>The type of the data source.</p>",
"UpdateDataSourceRequest$type": "<p>The new data source type.</p>"
}
},
"DataSources": {
"base": null,
"refs": {
"ListDataSourcesResponse$dataSources": "<p>The <code>DataSource</code> objects.</p>"
}
},
"DefaultAction": {
"base": null,
"refs": {
"UserPoolConfig$defaultAction": "<p>The action that you want your GraphQL API to take when a request that uses Amazon Cognito User Pool authentication doesn't match the Amazon Cognito User Pool configuration.</p>"
}
},
"DeleteApiKeyRequest": {
"base": null,
"refs": {
}
},
"DeleteApiKeyResponse": {
"base": null,
"refs": {
}
},
"DeleteDataSourceRequest": {
"base": null,
"refs": {
}
},
"DeleteDataSourceResponse": {
"base": null,
"refs": {
}
},
"DeleteGraphqlApiRequest": {
"base": null,
"refs": {
}
},
"DeleteGraphqlApiResponse": {
"base": null,
"refs": {
}
},
"DeleteResolverRequest": {
"base": null,
"refs": {
}
},
"DeleteResolverResponse": {
"base": null,
"refs": {
}
},
"DeleteTypeRequest": {
"base": null,
"refs": {
}
},
"DeleteTypeResponse": {
"base": null,
"refs": {
}
},
"DynamodbDataSourceConfig": {
"base": "<p>Describes a DynamoDB data source configuration.</p>",
"refs": {
"CreateDataSourceRequest$dynamodbConfig": "<p>DynamoDB settings.</p>",
"DataSource$dynamodbConfig": "<p>DynamoDB settings.</p>",
"UpdateDataSourceRequest$dynamodbConfig": "<p>The new DynamoDB configuration.</p>"
}
},
"ElasticsearchDataSourceConfig": {
"base": "<p>Describes an Elasticsearch data source configuration.</p>",
"refs": {
"CreateDataSourceRequest$elasticsearchConfig": "<p>Amazon Elasticsearch settings.</p>",
"DataSource$elasticsearchConfig": "<p>Amazon Elasticsearch settings.</p>",
"UpdateDataSourceRequest$elasticsearchConfig": "<p>The new Elasticsearch configuration.</p>"
}
},
"ErrorMessage": {
"base": null,
"refs": {
"BadRequestException$message": null,
"ConcurrentModificationException$message": null,
"GraphQLSchemaException$message": null
}
},
"GetDataSourceRequest": {
"base": null,
"refs": {
}
},
"GetDataSourceResponse": {
"base": null,
"refs": {
}
},
"GetGraphqlApiRequest": {
"base": null,
"refs": {
}
},
"GetGraphqlApiResponse": {
"base": null,
"refs": {
}
},
"GetIntrospectionSchemaRequest": {
"base": null,
"refs": {
}
},
"GetIntrospectionSchemaResponse": {
"base": null,
"refs": {
}
},
"GetResolverRequest": {
"base": null,
"refs": {
}
},
"GetResolverResponse": {
"base": null,
"refs": {
}
},
"GetSchemaCreationStatusRequest": {
"base": null,
"refs": {
}
},
"GetSchemaCreationStatusResponse": {
"base": null,
"refs": {
}
},
"GetTypeRequest": {
"base": null,
"refs": {
}
},
"GetTypeResponse": {
"base": null,
"refs": {
}
},
"GraphQLSchemaException": {
"base": "<p>The GraphQL schema is not valid.</p>",
"refs": {
}
},
"GraphqlApi": {
"base": "<p>Describes a GraphQL API.</p>",
"refs": {
"CreateGraphqlApiResponse$graphqlApi": "<p>The <code>GraphqlApi</code>.</p>",
"GetGraphqlApiResponse$graphqlApi": "<p>The <code>GraphqlApi</code> object.</p>",
"GraphqlApis$member": null,
"UpdateGraphqlApiResponse$graphqlApi": "<p>The udpated <code>GraphqlApi</code> object.</p>"
}
},
"GraphqlApis": {
"base": null,
"refs": {
"ListGraphqlApisResponse$graphqlApis": "<p>The <code>GraphqlApi</code> objects.</p>"
}
},
"InternalFailureException": {
"base": "<p>An internal AWS AppSync error occurred. Try your request again.</p>",
"refs": {
}
},
"LambdaDataSourceConfig": {
"base": "<p>Describes a Lambda data source configuration.</p>",
"refs": {
"CreateDataSourceRequest$lambdaConfig": "<p>AWS Lambda settings.</p>",
"DataSource$lambdaConfig": "<p>Lambda settings.</p>",
"UpdateDataSourceRequest$lambdaConfig": "<p>The new Lambda configuration.</p>"
}
},
"LimitExceededException": {
"base": "<p>The request exceeded a limit. Try your request again.</p>",
"refs": {
}
},
"ListApiKeysRequest": {
"base": null,
"refs": {
}
},
"ListApiKeysResponse": {
"base": null,
"refs": {
}
},
"ListDataSourcesRequest": {
"base": null,
"refs": {
}
},
"ListDataSourcesResponse": {
"base": null,
"refs": {
}
},
"ListGraphqlApisRequest": {
"base": null,
"refs": {
}
},
"ListGraphqlApisResponse": {
"base": null,
"refs": {
}
},
"ListResolversRequest": {
"base": null,
"refs": {
}
},
"ListResolversResponse": {
"base": null,
"refs": {
}
},
"ListTypesRequest": {
"base": null,
"refs": {
}
},
"ListTypesResponse": {
"base": null,
"refs": {
}
},
"Long": {
"base": null,
"refs": {
"ApiKey$expires": "<p>The time when the API key expires.</p>"
}
},
"MapOfStringToString": {
"base": null,
"refs": {
"GraphqlApi$uris": "<p>The URIs.</p>"
}
},
"MappingTemplate": {
"base": null,
"refs": {
"CreateResolverRequest$requestMappingTemplate": "<p>The mapping template to be used for requests.</p> <p>A resolver use a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL).</p>",
"CreateResolverRequest$responseMappingTemplate": "<p>The mapping template to be used for responses from the data source.</p>",
"Resolver$requestMappingTemplate": "<p>The request mapping template.</p>",
"Resolver$responseMappingTemplate": "<p>The response mapping template.</p>",
"UpdateResolverRequest$requestMappingTemplate": "<p>The new request mapping template.</p>",
"UpdateResolverRequest$responseMappingTemplate": "<p>The new response mapping template.</p>"
}
},
"MaxResults": {
"base": null,
"refs": {
"ListApiKeysRequest$maxResults": "<p>The maximum number of results you want the request to return.</p>",
"ListDataSourcesRequest$maxResults": "<p>The maximum number of results you want the request to return.</p>",
"ListGraphqlApisRequest$maxResults": "<p>The maximum number of results you want the request to return.</p>",
"ListResolversRequest$maxResults": "<p>The maximum number of results you want the request to return.</p>",
"ListTypesRequest$maxResults": "<p>The maximum number of results you want the request to return.</p>"
}
},
"NotFoundException": {
"base": "<p>The resource specified in the request was not found. Check the resource and try again.</p>",
"refs": {
}
},
"OutputType": {
"base": null,
"refs": {
"GetIntrospectionSchemaRequest$format": "<p>The schema format: SDL or JSON.</p>"
}
},
"PaginationToken": {
"base": null,
"refs": {
"ListApiKeysRequest$nextToken": "<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>",
"ListApiKeysResponse$nextToken": "<p>An identifier to be passed in the next request to this operation to return the next set of items in the list.</p>",
"ListDataSourcesRequest$nextToken": "<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. </p>",
"ListDataSourcesResponse$nextToken": "<p>An identifier to be passed in the next request to this operation to return the next set of items in the list.</p>",
"ListGraphqlApisRequest$nextToken": "<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. </p>",
"ListGraphqlApisResponse$nextToken": "<p>An identifier to be passed in the next request to this operation to return the next set of items in the list.</p>",
"ListResolversRequest$nextToken": "<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. </p>",
"ListResolversResponse$nextToken": "<p>An identifier to be passed in the next request to this operation to return the next set of items in the list.</p>",
"ListTypesRequest$nextToken": "<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. </p>",
"ListTypesResponse$nextToken": "<p>An identifier to be passed in the next request to this operation to return the next set of items in the list.</p>"
}
},
"Resolver": {
"base": "<p>Describes a resolver.</p>",
"refs": {
"CreateResolverResponse$resolver": "<p>The <code>Resolver</code> object.</p>",
"GetResolverResponse$resolver": "<p>The <code>Resolver</code> object.</p>",
"Resolvers$member": null,
"UpdateResolverResponse$resolver": "<p>The updated <code>Resolver</code> object.</p>"
}
},
"Resolvers": {
"base": null,
"refs": {
"ListResolversResponse$resolvers": "<p>The <code>Resolver</code> objects.</p>"
}
},
"ResourceName": {
"base": null,
"refs": {
"CreateDataSourceRequest$name": "<p>A user-supplied name for the <code>DataSource</code>.</p>",
"CreateGraphqlApiRequest$name": "<p>A user-supplied name for the <code>GraphqlApi</code>.</p>",
"CreateResolverRequest$typeName": "<p>The name of the <code>Type</code>.</p>",
"CreateResolverRequest$fieldName": "<p>The name of the field to attach the resolver to.</p>",
"CreateResolverRequest$dataSourceName": "<p>The name of the data source for which the resolver is being created.</p>",
"DataSource$name": "<p>The name of the data source.</p>",
"DeleteDataSourceRequest$name": "<p>The name of the data source.</p>",
"DeleteResolverRequest$typeName": "<p>The name of the resolver type.</p>",
"DeleteResolverRequest$fieldName": "<p>The resolver field name.</p>",
"DeleteTypeRequest$typeName": "<p>The type name.</p>",
"GetDataSourceRequest$name": "<p>The name of the data source.</p>",
"GetResolverRequest$typeName": "<p>The resolver type name.</p>",
"GetResolverRequest$fieldName": "<p>The resolver field name.</p>",
"GetTypeRequest$typeName": "<p>The type name.</p>",
"GraphqlApi$name": "<p>The API name.</p>",
"Resolver$typeName": "<p>The resolver type name.</p>",
"Resolver$fieldName": "<p>The resolver field name.</p>",
"Resolver$dataSourceName": "<p>The resolver data source name.</p>",
"Type$name": "<p>The type name.</p>",
"UpdateDataSourceRequest$name": "<p>The new name for the data source.</p>",
"UpdateGraphqlApiRequest$name": "<p>The new name for the <code>GraphqlApi</code> object.</p>",
"UpdateResolverRequest$typeName": "<p>The new type name.</p>",
"UpdateResolverRequest$fieldName": "<p>The new field name.</p>",
"UpdateResolverRequest$dataSourceName": "<p>The new data source name.</p>",
"UpdateTypeRequest$typeName": "<p>The new type name.</p>"
}
},
"SchemaStatus": {
"base": null,
"refs": {
"GetSchemaCreationStatusResponse$status": "<p>The current state of the schema (PROCESSING, ACTIVE, or DELETING). Once the schema is in the ACTIVE state, you can add data.</p>",
"StartSchemaCreationResponse$status": "<p>The current state of the schema (PROCESSING, ACTIVE, or DELETING). Once the schema is in the ACTIVE state, you can add data.</p>"
}
},
"StartSchemaCreationRequest": {
"base": null,
"refs": {
}
},
"StartSchemaCreationResponse": {
"base": null,
"refs": {
}
},
"String": {
"base": null,
"refs": {
"ApiKey$id": "<p>The API key ID.</p>",
"ApiKey$description": "<p>A description of the purpose of the API key.</p>",
"ApiKeyLimitExceededException$message": null,
"ApiLimitExceededException$message": null,
"CreateApiKeyRequest$apiId": "<p>The ID for your GraphQL API.</p>",
"CreateApiKeyRequest$description": "<p>A description of the purpose of the API key.</p>",
"CreateDataSourceRequest$apiId": "<p>The API ID for the GraphQL API for the <code>DataSource</code>.</p>",
"CreateDataSourceRequest$description": "<p>A description of the <code>DataSource</code>.</p>",
"CreateDataSourceRequest$serviceRoleArn": "<p>The IAM service role ARN for the data source. The system assumes this role when accessing the data source.</p>",
"CreateResolverRequest$apiId": "<p>The ID for the GraphQL API for which the resolver is being created.</p>",
"CreateTypeRequest$apiId": "<p>The API ID.</p>",
"CreateTypeRequest$definition": "<p>The type definition, in GraphQL Schema Definition Language (SDL) format.</p> <p>For more information, see the <a href=\"http://graphql.org/learn/schema/\">GraphQL SDL documentation</a>.</p>",
"DataSource$dataSourceArn": "<p>The data source ARN.</p>",
"DataSource$description": "<p>The description of the data source.</p>",
"DataSource$serviceRoleArn": "<p>The IAM service role ARN for the data source. The system assumes this role when accessing the data source.</p>",
"DeleteApiKeyRequest$apiId": "<p>The API ID.</p>",
"DeleteApiKeyRequest$id": "<p>The ID for the API key.</p>",
"DeleteDataSourceRequest$apiId": "<p>The API ID.</p>",
"DeleteGraphqlApiRequest$apiId": "<p>The API ID.</p>",
"DeleteResolverRequest$apiId": "<p>The API ID.</p>",
"DeleteTypeRequest$apiId": "<p>The API ID.</p>",
"DynamodbDataSourceConfig$tableName": "<p>The table name.</p>",
"DynamodbDataSourceConfig$awsRegion": "<p>The AWS region.</p>",
"ElasticsearchDataSourceConfig$endpoint": "<p>The endpoint.</p>",
"ElasticsearchDataSourceConfig$awsRegion": "<p>The AWS region.</p>",
"GetDataSourceRequest$apiId": "<p>The API ID.</p>",
"GetGraphqlApiRequest$apiId": "<p>The API ID for the GraphQL API.</p>",
"GetIntrospectionSchemaRequest$apiId": "<p>The API ID.</p>",
"GetResolverRequest$apiId": "<p>The API ID.</p>",
"GetSchemaCreationStatusRequest$apiId": "<p>The API ID.</p>",
"GetSchemaCreationStatusResponse$details": "<p>Detailed information about the status of the schema creation operation.</p>",
"GetTypeRequest$apiId": "<p>The API ID.</p>",
"GraphqlApi$apiId": "<p>The API ID.</p>",
"GraphqlApi$arn": "<p>The ARN.</p>",
"InternalFailureException$message": null,
"LambdaDataSourceConfig$lambdaFunctionArn": "<p>The ARN for the Lambda function.</p>",
"LimitExceededException$message": null,
"ListApiKeysRequest$apiId": "<p>The API ID.</p>",
"ListDataSourcesRequest$apiId": "<p>The API ID.</p>",
"ListResolversRequest$apiId": "<p>The API ID.</p>",
"ListResolversRequest$typeName": "<p>The type name.</p>",
"ListTypesRequest$apiId": "<p>The API ID.</p>",
"MapOfStringToString$key": null,
"MapOfStringToString$value": null,
"NotFoundException$message": null,
"Resolver$resolverArn": "<p>The resolver ARN.</p>",
"StartSchemaCreationRequest$apiId": "<p>The API ID.</p>",
"Type$description": "<p>The type description.</p>",
"Type$arn": "<p>The type ARN.</p>",
"Type$definition": "<p>The type definition.</p>",
"UnauthorizedException$message": null,
"UpdateDataSourceRequest$apiId": "<p>The API ID.</p>",
"UpdateDataSourceRequest$description": "<p>The new description for the data source.</p>",
"UpdateDataSourceRequest$serviceRoleArn": "<p>The new service role ARN for the data source.</p>",
"UpdateGraphqlApiRequest$apiId": "<p>The API ID.</p>",
"UpdateResolverRequest$apiId": "<p>The API ID.</p>",
"UpdateTypeRequest$apiId": "<p>The API ID.</p>",
"UpdateTypeRequest$definition": "<p>The new definition.</p>",
"UserPoolConfig$userPoolId": "<p>The user pool ID.</p>",
"UserPoolConfig$awsRegion": "<p>The AWS region in which the user pool was created.</p>",
"UserPoolConfig$appIdClientRegex": "<p>A regular expression for validating the incoming Amazon Cognito User Pool app client ID.</p>"
}
},
"Type": {
"base": "<p>Describes a type.</p>",
"refs": {
"CreateTypeResponse$type": "<p>The <code>Type</code> object.</p>",
"GetTypeResponse$type": "<p>The <code>Type</code> object.</p>",
"TypeList$member": null,
"UpdateTypeResponse$type": "<p>The updated <code>Type</code> object.</p>"
}
},
"TypeDefinitionFormat": {
"base": null,
"refs": {
"CreateTypeRequest$format": "<p>The type format: SDL or JSON.</p>",
"GetTypeRequest$format": "<p>The type format: SDL or JSON.</p>",
"ListTypesRequest$format": "<p>The type format: SDL or JSON.</p>",
"Type$format": "<p>The type format: SDL or JSON.</p>",
"UpdateTypeRequest$format": "<p>The new type format: SDL or JSON.</p>"
}
},
"TypeList": {
"base": null,
"refs": {
"ListTypesResponse$types": "<p>The <code>Type</code> objects.</p>"
}
},
"UnauthorizedException": {
"base": "<p>You are not authorized to perform this operation.</p>",
"refs": {
}
},
"UpdateDataSourceRequest": {
"base": null,
"refs": {
}
},
"UpdateDataSourceResponse": {
"base": null,
"refs": {
}
},
"UpdateGraphqlApiRequest": {
"base": null,
"refs": {
}
},
"UpdateGraphqlApiResponse": {
"base": null,
"refs": {
}
},
"UpdateResolverRequest": {
"base": null,
"refs": {
}
},
"UpdateResolverResponse": {
"base": null,
"refs": {
}
},
"UpdateTypeRequest": {
"base": null,
"refs": {
}
},
"UpdateTypeResponse": {
"base": null,
"refs": {
}
},
"UserPoolConfig": {
"base": "<p>Describes an Amazon Cognito User Pool configuration.</p>",
"refs": {
"CreateGraphqlApiRequest$userPoolConfig": "<p>The Amazon Cognito User Pool configuration.</p>",
"GraphqlApi$userPoolConfig": "<p>The Amazon Cognito User Pool configuration.</p>",
"UpdateGraphqlApiRequest$userPoolConfig": "<p>The new Amazon Cognito User Pool configuration for the <code>GraphqlApi</code> object.</p>"
}
}
}
}

View File

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View File

@ -0,0 +1,4 @@
{
"pagination": {
}
}

View File

@ -876,6 +876,7 @@
"AutoScalingGroupName":{"shape":"XmlStringMaxLen255"},
"AutoScalingGroupARN":{"shape":"ResourceName"},
"LaunchConfigurationName":{"shape":"XmlStringMaxLen255"},
"LaunchTemplate":{"shape":"LaunchTemplateSpecification"},
"MinSize":{"shape":"AutoScalingGroupMinSize"},
"MaxSize":{"shape":"AutoScalingGroupMaxSize"},
"DesiredCapacity":{"shape":"AutoScalingGroupDesiredCapacity"},
@ -932,7 +933,6 @@
"AvailabilityZone",
"LifecycleState",
"HealthStatus",
"LaunchConfigurationName",
"ProtectedFromScaleIn"
],
"members":{
@ -942,6 +942,7 @@
"LifecycleState":{"shape":"XmlStringMaxLen32"},
"HealthStatus":{"shape":"XmlStringMaxLen32"},
"LaunchConfigurationName":{"shape":"XmlStringMaxLen255"},
"LaunchTemplate":{"shape":"LaunchTemplateSpecification"},
"ProtectedFromScaleIn":{"shape":"InstanceProtected"}
}
},
@ -1031,6 +1032,7 @@
"members":{
"AutoScalingGroupName":{"shape":"XmlStringMaxLen255"},
"LaunchConfigurationName":{"shape":"ResourceName"},
"LaunchTemplate":{"shape":"LaunchTemplateSpecification"},
"InstanceId":{"shape":"XmlStringMaxLen19"},
"MinSize":{"shape":"AutoScalingGroupMinSize"},
"MaxSize":{"shape":"AutoScalingGroupMaxSize"},
@ -1465,7 +1467,6 @@
"AvailabilityZone",
"LifecycleState",
"HealthStatus",
"LaunchConfigurationName",
"ProtectedFromScaleIn"
],
"members":{
@ -1474,6 +1475,7 @@
"LifecycleState":{"shape":"LifecycleState"},
"HealthStatus":{"shape":"XmlStringMaxLen32"},
"LaunchConfigurationName":{"shape":"XmlStringMaxLen255"},
"LaunchTemplate":{"shape":"LaunchTemplateSpecification"},
"ProtectedFromScaleIn":{"shape":"InstanceProtected"}
}
},
@ -1565,6 +1567,20 @@
"NextToken":{"shape":"XmlString"}
}
},
"LaunchTemplateName":{
"type":"string",
"max":128,
"min":3,
"pattern":"[a-zA-Z0-9\\(\\)\\.-/_]+"
},
"LaunchTemplateSpecification":{
"type":"structure",
"members":{
"LaunchTemplateId":{"shape":"XmlStringMaxLen255"},
"LaunchTemplateName":{"shape":"LaunchTemplateName"},
"Version":{"shape":"XmlStringMaxLen255"}
}
},
"LifecycleActionResult":{"type":"string"},
"LifecycleActionToken":{
"type":"string",
@ -1592,7 +1608,10 @@
},
"LifecycleHookSpecification":{
"type":"structure",
"required":["LifecycleHookName"],
"required":[
"LifecycleHookName",
"LifecycleTransition"
],
"members":{
"LifecycleHookName":{"shape":"AsciiStringMaxLen255"},
"LifecycleTransition":{"shape":"LifecycleTransition"},
@ -2190,6 +2209,7 @@
"members":{
"AutoScalingGroupName":{"shape":"ResourceName"},
"LaunchConfigurationName":{"shape":"ResourceName"},
"LaunchTemplate":{"shape":"LaunchTemplateSpecification"},
"MinSize":{"shape":"AutoScalingGroupMinSize"},
"MaxSize":{"shape":"AutoScalingGroupMaxSize"},
"DesiredCapacity":{"shape":"AutoScalingGroupDesiredCapacity"},

View File

@ -202,8 +202,8 @@
"AutoScalingGroupNames": {
"base": null,
"refs": {
"AutoScalingGroupNamesType$AutoScalingGroupNames": "<p>The group names. If you omit this parameter, all Auto Scaling groups are described.</p>",
"DescribeNotificationConfigurationsType$AutoScalingGroupNames": "<p>The name of the group.</p>"
"AutoScalingGroupNamesType$AutoScalingGroupNames": "<p>The names of the Auto Scaling groups. If you omit this parameter, all Auto Scaling groups are described.</p>",
"DescribeNotificationConfigurationsType$AutoScalingGroupNames": "<p>The name of the Auto Scaling group.</p>"
}
},
"AutoScalingGroupNamesType": {
@ -704,12 +704,28 @@
"refs": {
}
},
"LaunchTemplateName": {
"base": null,
"refs": {
"LaunchTemplateSpecification$LaunchTemplateName": "<p>The name of the launch template. You must specify either a template name or a template ID.</p>"
}
},
"LaunchTemplateSpecification": {
"base": "<p>Describes a launch template.</p>",
"refs": {
"AutoScalingGroup$LaunchTemplate": "<p>The launch template for the group.</p>",
"AutoScalingInstanceDetails$LaunchTemplate": "<p>The launch template for the instance.</p>",
"CreateAutoScalingGroupType$LaunchTemplate": "<p>The launch template to use to launch instances. You must specify one of the following: a launch template, a launch configuration, or an EC2 instance.</p>",
"Instance$LaunchTemplate": "<p>The launch template for the instance.</p>",
"UpdateAutoScalingGroupType$LaunchTemplate": "<p>The launch template to use to specify the updates. You must specify a launch configuration or a launch template.</p>"
}
},
"LifecycleActionResult": {
"base": null,
"refs": {
"CompleteLifecycleActionType$LifecycleActionResult": "<p>The action for the group to take. This parameter can be either <code>CONTINUE</code> or <code>ABANDON</code>.</p>",
"LifecycleHook$DefaultResult": "<p>Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are <code>CONTINUE</code> and <code>ABANDON</code>. The default value is <code>CONTINUE</code>.</p>",
"LifecycleHookSpecification$DefaultResult": "<p>Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are <code>CONTINUE</code> and <code>ABANDON</code>. The default value is <code>CONTINUE</code>.</p>",
"LifecycleHookSpecification$DefaultResult": "<p>Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are <code>CONTINUE</code> and <code>ABANDON</code>.</p>",
"PutLifecycleHookType$DefaultResult": "<p>Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either <code>CONTINUE</code> or <code>ABANDON</code>. The default value is <code>ABANDON</code>.</p>"
}
},
@ -1002,7 +1018,7 @@
"PolicyNames": {
"base": null,
"refs": {
"DescribePoliciesType$PolicyNames": "<p>One or more policy names or policy ARNs to be described. If you omit this parameter, all policy names are described. If an group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error.</p>"
"DescribePoliciesType$PolicyNames": "<p>The names of one or more policies. If you omit this parameter, all policies are described. If an group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error.</p>"
}
},
"PolicyTypes": {
@ -1108,34 +1124,34 @@
"base": null,
"refs": {
"Alarm$AlarmARN": "<p>The Amazon Resource Name (ARN) of the alarm.</p>",
"AttachInstancesQuery$AutoScalingGroupName": "<p>The name of the group.</p>",
"AttachInstancesQuery$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"AttachLoadBalancerTargetGroupsType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"AttachLoadBalancersType$AutoScalingGroupName": "<p>The name of the group.</p>",
"AutoScalingGroup$AutoScalingGroupARN": "<p>The Amazon Resource Name (ARN) of the group.</p>",
"AttachLoadBalancersType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"AutoScalingGroup$AutoScalingGroupARN": "<p>The Amazon Resource Name (ARN) of the Auto Scaling group.</p>",
"AutoScalingGroupNames$member": null,
"CompleteLifecycleActionType$AutoScalingGroupName": "<p>The name of the group for the lifecycle hook.</p>",
"CreateAutoScalingGroupType$LaunchConfigurationName": "<p>The name of the launch configuration. Alternatively, specify an EC2 instance instead of a launch configuration.</p>",
"DeleteAutoScalingGroupType$AutoScalingGroupName": "<p>The name of the group to delete.</p>",
"DeleteLifecycleHookType$AutoScalingGroupName": "<p>The name of the Auto Scaling group for the lifecycle hook.</p>",
"CompleteLifecycleActionType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"CreateAutoScalingGroupType$LaunchConfigurationName": "<p>The name of the launch configuration. You must specify one of the following: a launch configuration, a launch template, or an EC2 instance.</p>",
"DeleteAutoScalingGroupType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"DeleteLifecycleHookType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"DeleteNotificationConfigurationType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"DeleteNotificationConfigurationType$TopicARN": "<p>The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.</p>",
"DeletePolicyType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"DeletePolicyType$PolicyName": "<p>The name or Amazon Resource Name (ARN) of the policy.</p>",
"DeleteScheduledActionType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"DeleteScheduledActionType$ScheduledActionName": "<p>The name of the action to delete.</p>",
"DescribeLifecycleHooksType$AutoScalingGroupName": "<p>The name of the group.</p>",
"DescribeLifecycleHooksType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"DescribeLoadBalancerTargetGroupsRequest$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"DescribeLoadBalancersRequest$AutoScalingGroupName": "<p>The name of the group.</p>",
"DescribePoliciesType$AutoScalingGroupName": "<p>The name of the group.</p>",
"DescribeScalingActivitiesType$AutoScalingGroupName": "<p>The name of the group.</p>",
"DescribeScheduledActionsType$AutoScalingGroupName": "<p>The name of the group.</p>",
"DetachInstancesQuery$AutoScalingGroupName": "<p>The name of the group.</p>",
"DescribeLoadBalancersRequest$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"DescribePoliciesType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"DescribeScalingActivitiesType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"DescribeScheduledActionsType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"DetachInstancesQuery$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"DetachLoadBalancerTargetGroupsType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"DetachLoadBalancersType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"DisableMetricsCollectionQuery$AutoScalingGroupName": "<p>The name or Amazon Resource Name (ARN) of the group.</p>",
"EnableMetricsCollectionQuery$AutoScalingGroupName": "<p>The name or ARN of the Auto Scaling group.</p>",
"DisableMetricsCollectionQuery$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"EnableMetricsCollectionQuery$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"EnterStandbyQuery$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"ExecutePolicyType$AutoScalingGroupName": "<p>The name or Amazon Resource Name (ARN) of the Auto Scaling group.</p>",
"ExecutePolicyType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"ExecutePolicyType$PolicyName": "<p>The name or ARN of the policy.</p>",
"ExitStandbyQuery$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"LaunchConfiguration$LaunchConfigurationARN": "<p>The Amazon Resource Name (ARN) of the launch configuration.</p>",
@ -1145,25 +1161,25 @@
"LifecycleHook$NotificationTargetARN": "<p>The ARN of the target that Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.</p>",
"LifecycleHook$RoleARN": "<p>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.</p>",
"LifecycleHookSpecification$RoleARN": "<p>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.</p>",
"NotificationConfiguration$AutoScalingGroupName": "<p>The name of the group.</p>",
"NotificationConfiguration$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"NotificationConfiguration$TopicARN": "<p>The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.</p>",
"PolicyARNType$PolicyARN": "<p>The Amazon Resource Name (ARN) of the policy.</p>",
"PolicyNames$member": null,
"PutLifecycleHookType$AutoScalingGroupName": "<p>The name of the Auto Scaling group to which you want to assign the lifecycle hook.</p>",
"PutLifecycleHookType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"PutLifecycleHookType$RoleARN": "<p>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.</p> <p>This parameter is required for new lifecycle hooks, but optional when updating existing hooks.</p>",
"PutNotificationConfigurationType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"PutNotificationConfigurationType$TopicARN": "<p>The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.</p>",
"PutScalingPolicyType$AutoScalingGroupName": "<p>The name or ARN of the group.</p>",
"PutScheduledUpdateGroupActionType$AutoScalingGroupName": "<p>The name or Amazon Resource Name (ARN) of the Auto Scaling group.</p>",
"RecordLifecycleActionHeartbeatType$AutoScalingGroupName": "<p>The name of the Auto Scaling group for the hook.</p>",
"PutScalingPolicyType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"PutScheduledUpdateGroupActionType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"RecordLifecycleActionHeartbeatType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"ScalingPolicy$PolicyARN": "<p>The Amazon Resource Name (ARN) of the policy.</p>",
"ScalingProcessQuery$AutoScalingGroupName": "<p>The name or Amazon Resource Name (ARN) of the Auto Scaling group.</p>",
"ScalingProcessQuery$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"ScheduledActionNames$member": null,
"ScheduledUpdateGroupAction$ScheduledActionARN": "<p>The Amazon Resource Name (ARN) of the scheduled action.</p>",
"SetDesiredCapacityType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"SetInstanceProtectionQuery$AutoScalingGroupName": "<p>The name of the group.</p>",
"SetInstanceProtectionQuery$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"UpdateAutoScalingGroupType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"UpdateAutoScalingGroupType$LaunchConfigurationName": "<p>The name of the launch configuration.</p>"
"UpdateAutoScalingGroupType$LaunchConfigurationName": "<p>The name of the launch configuration. You must specify either a launch configuration or a launch template.</p>"
}
},
"ScalingActivityInProgressFault": {
@ -1436,7 +1452,7 @@
"Activity$Cause": "<p>The reason the activity began.</p>",
"LifecycleHook$NotificationMetadata": "<p>Additional information that you want to include any time Auto Scaling sends a message to the notification target.</p>",
"LifecycleHookSpecification$NotificationMetadata": "<p>Additional information that you want to include any time Auto Scaling sends a message to the notification target.</p>",
"PredefinedMetricSpecification$ResourceLabel": "<p>Identifies the resource associated with the metric type. The following predefined metrics are available:</p> <ul> <li> <p> <code>ASGAverageCPUUtilization</code> - average CPU utilization of the Auto Scaling group</p> </li> <li> <p> <code>ASGAverageNetworkIn</code> - average number of bytes received on all network interfaces by the Auto Scaling group</p> </li> <li> <p> <code>ASGAverageNetworkOut</code> - average number of bytes sent out on all network interfaces by the Auto Scaling group</p> </li> <li> <p> <code>ALBRequestCountPerTarget</code> - number of requests completed per target in an Application Load Balancer target group</p> </li> </ul> <p>For predefined metric types <code>ASGAverageCPUUtilization</code>, <code>ASGAverageNetworkIn</code> and <code>ASGAverageNetworkOut</code>, the parameter must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type <code>ALBRequestCountPerTarget</code>, the parameter must be specified in the format: <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i>/targetgroup/<i>target-group-name</i>/<i>target-group-id</i> </code>, where <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i> </code> is the final portion of the load balancer ARN, and <code>targetgroup/<i>target-group-name</i>/<i>target-group-id</i> </code> is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group.</p>",
"PredefinedMetricSpecification$ResourceLabel": "<p>Identifies the resource associated with the metric type. The following predefined metrics are available:</p> <ul> <li> <p> <code>ASGAverageCPUUtilization</code> - average CPU utilization of the Auto Scaling group</p> </li> <li> <p> <code>ASGAverageNetworkIn</code> - average number of bytes received on all network interfaces by the Auto Scaling group</p> </li> <li> <p> <code>ASGAverageNetworkOut</code> - average number of bytes sent out on all network interfaces by the Auto Scaling group</p> </li> <li> <p> <code>ALBRequestCountPerTarget</code> - number of requests completed per target in an Application Load Balancer target group</p> </li> </ul> <p>For predefined metric types <code>ASGAverageCPUUtilization</code>, <code>ASGAverageNetworkIn</code>, and <code>ASGAverageNetworkOut</code>, the parameter must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type <code>ALBRequestCountPerTarget</code>, the parameter must be specified in the format: <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i>/targetgroup/<i>target-group-name</i>/<i>target-group-id</i> </code>, where <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i> </code> is the final portion of the load balancer ARN, and <code>targetgroup/<i>target-group-name</i>/<i>target-group-id</i> </code> is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group.</p>",
"PutLifecycleHookType$NotificationMetadata": "<p>Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.</p>"
}
},
@ -1453,7 +1469,7 @@
"refs": {
"AutoScalingInstanceDetails$InstanceId": "<p>The ID of the instance.</p>",
"CompleteLifecycleActionType$InstanceId": "<p>The ID of the instance.</p>",
"CreateAutoScalingGroupType$InstanceId": "<p>The ID of the instance used to create a launch configuration for the group. Alternatively, specify a launch configuration instead of an EC2 instance.</p> <p>When you specify an ID of an instance, Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, with the exception of the block device mapping.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/create-asg-from-instance.html\">Create an Auto Scaling Group Using an EC2 Instance</a> in the <i>Auto Scaling User Guide</i>.</p>",
"CreateAutoScalingGroupType$InstanceId": "<p>The ID of the instance used to create a launch configuration for the group. You must specify one of the following: an EC2 instance, a launch configuration, or a launch template.</p> <p>When you specify an ID of an instance, Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, with the exception of the block device mapping.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/create-asg-from-instance.html\">Create an Auto Scaling Group Using an EC2 Instance</a> in the <i>Auto Scaling User Guide</i>.</p>",
"CreateLaunchConfigurationType$InstanceId": "<p>The ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, with the exception of the block device mapping.</p> <p>If you do not specify <code>InstanceId</code>, you must specify both <code>ImageId</code> and <code>InstanceType</code>.</p> <p>To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/create-lc-with-instanceID.html\">Create a Launch Configuration Using an EC2 Instance</a> in the <i>Auto Scaling User Guide</i>.</p>",
"Instance$InstanceId": "<p>The ID of the instance.</p>",
"InstanceIds$member": null,
@ -1478,11 +1494,11 @@
"AdjustmentType$AdjustmentType": "<p>The policy adjustment type. The valid values are <code>ChangeInCapacity</code>, <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p>",
"Alarm$AlarmName": "<p>The name of the alarm.</p>",
"AlreadyExistsFault$message": "<p/>",
"AutoScalingGroup$AutoScalingGroupName": "<p>The name of the group.</p>",
"AutoScalingGroup$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"AutoScalingGroup$LaunchConfigurationName": "<p>The name of the associated launch configuration.</p>",
"AutoScalingGroup$PlacementGroup": "<p>The name of the placement group into which you'll launch your instances, if any. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html\">Placement Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
"AutoScalingGroup$Status": "<p>The current state of the group when <a>DeleteAutoScalingGroup</a> is in progress.</p>",
"AutoScalingInstanceDetails$AutoScalingGroupName": "<p>The name of the Auto Scaling group associated with the instance.</p>",
"AutoScalingInstanceDetails$AutoScalingGroupName": "<p>The name of the Auto Scaling group for the instance.</p>",
"AutoScalingInstanceDetails$AvailabilityZone": "<p>The Availability Zone for the instance.</p>",
"AutoScalingInstanceDetails$LaunchConfigurationName": "<p>The launch configuration used to launch the instance. This value is not available if you attached the instance to the Auto Scaling group.</p>",
"AutoScalingNotificationTypes$member": null,
@ -1490,7 +1506,7 @@
"BlockDeviceMapping$VirtualName": "<p>The name of the virtual device (for example, <code>ephemeral0</code>).</p>",
"BlockDeviceMapping$DeviceName": "<p>The device name exposed to the EC2 instance (for example, <code>/dev/sdh</code> or <code>xvdh</code>).</p>",
"ClassicLinkVPCSecurityGroups$member": null,
"CreateAutoScalingGroupType$AutoScalingGroupName": "<p>The name of the group. This name must be unique within the scope of your AWS account.</p>",
"CreateAutoScalingGroupType$AutoScalingGroupName": "<p>The name of the Auto Scaling group. This name must be unique within the scope of your AWS account.</p>",
"CreateAutoScalingGroupType$PlacementGroup": "<p>The name of the placement group into which you'll launch your instances, if any. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html\">Placement Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
"CreateLaunchConfigurationType$LaunchConfigurationName": "<p>The name of the launch configuration. This name must be unique within the scope of your AWS account.</p>",
"CreateLaunchConfigurationType$ImageId": "<p>The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances.</p> <p>If you do not specify <code>InstanceId</code>, you must specify <code>ImageId</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html\">Finding an AMI</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
@ -1513,6 +1529,8 @@
"LaunchConfiguration$InstanceType": "<p>The instance type for the instances.</p>",
"LaunchConfiguration$KernelId": "<p>The ID of the kernel associated with the AMI.</p>",
"LaunchConfiguration$RamdiskId": "<p>The ID of the RAM disk associated with the AMI.</p>",
"LaunchTemplateSpecification$LaunchTemplateId": "<p>The ID of the launch template. You must specify either a template ID or a template name.</p>",
"LaunchTemplateSpecification$Version": "<p>The version number. By default, the default version of the launch template is used.</p>",
"LimitExceededFault$message": "<p/>",
"LoadBalancerNames$member": null,
"LoadBalancerState$LoadBalancerName": "<p>The name of the load balancer.</p>",
@ -1531,10 +1549,10 @@
"ResourceContentionFault$message": "<p/>",
"ResourceInUseFault$message": "<p/>",
"ScalingActivityInProgressFault$message": "<p/>",
"ScalingPolicy$AutoScalingGroupName": "<p>The name of the Auto Scaling group associated with this scaling policy.</p>",
"ScalingPolicy$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"ScalingPolicy$PolicyName": "<p>The name of the scaling policy.</p>",
"ScalingPolicy$AdjustmentType": "<p>The adjustment type, which specifies how <code>ScalingAdjustment</code> is interpreted. Valid values are <code>ChangeInCapacity</code>, <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p>",
"ScheduledUpdateGroupAction$AutoScalingGroupName": "<p>The name of the group.</p>",
"ScheduledUpdateGroupAction$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
"ScheduledUpdateGroupAction$ScheduledActionName": "<p>The name of the scheduled action.</p>",
"ScheduledUpdateGroupAction$Recurrence": "<p>The recurring schedule for the action.</p>",
"SuspendedProcess$ProcessName": "<p>The name of the suspended process.</p>",

View File

@ -221,6 +221,39 @@
}
},
"shapes":{
"ArrayJobDependency":{
"type":"string",
"enum":[
"N_TO_N",
"SEQUENTIAL"
]
},
"ArrayJobStatusSummary":{
"type":"map",
"key":{"shape":"String"},
"value":{"shape":"Integer"}
},
"ArrayProperties":{
"type":"structure",
"members":{
"size":{"shape":"Integer"}
}
},
"ArrayPropertiesDetail":{
"type":"structure",
"members":{
"statusSummary":{"shape":"ArrayJobStatusSummary"},
"size":{"shape":"Integer"},
"index":{"shape":"Integer"}
}
},
"ArrayPropertiesSummary":{
"type":"structure",
"members":{
"size":{"shape":"Integer"},
"index":{"shape":"Integer"}
}
},
"AttemptContainerDetail":{
"type":"structure",
"members":{
@ -427,6 +460,13 @@
"user":{"shape":"String"}
}
},
"ContainerSummary":{
"type":"structure",
"members":{
"exitCode":{"shape":"Integer"},
"reason":{"shape":"String"}
}
},
"CreateComputeEnvironmentRequest":{
"type":"structure",
"required":[
@ -629,7 +669,8 @@
"JobDependency":{
"type":"structure",
"members":{
"jobId":{"shape":"String"}
"jobId":{"shape":"String"},
"type":{"shape":"ArrayJobDependency"}
}
},
"JobDependencyList":{
@ -660,7 +701,8 @@
"dependsOn":{"shape":"JobDependencyList"},
"jobDefinition":{"shape":"String"},
"parameters":{"shape":"ParametersMap"},
"container":{"shape":"ContainerDetail"}
"container":{"shape":"ContainerDetail"},
"arrayProperties":{"shape":"ArrayPropertiesDetail"}
}
},
"JobDetailList":{
@ -710,7 +752,14 @@
],
"members":{
"jobId":{"shape":"String"},
"jobName":{"shape":"String"}
"jobName":{"shape":"String"},
"createdAt":{"shape":"Long"},
"status":{"shape":"JobStatus"},
"statusReason":{"shape":"String"},
"startedAt":{"shape":"Long"},
"stoppedAt":{"shape":"Long"},
"container":{"shape":"ContainerSummary"},
"arrayProperties":{"shape":"ArrayPropertiesSummary"}
}
},
"JobSummaryList":{
@ -726,9 +775,9 @@
},
"ListJobsRequest":{
"type":"structure",
"required":["jobQueue"],
"members":{
"jobQueue":{"shape":"String"},
"arrayJobId":{"shape":"String"},
"jobStatus":{"shape":"JobStatus"},
"maxResults":{"shape":"Integer"},
"nextToken":{"shape":"String"}
@ -817,6 +866,7 @@
"members":{
"jobName":{"shape":"String"},
"jobQueue":{"shape":"String"},
"arrayProperties":{"shape":"ArrayProperties"},
"dependsOn":{"shape":"JobDependencyList"},
"jobDefinition":{"shape":"String"},
"parameters":{"shape":"ParametersMap"},

View File

@ -2,8 +2,8 @@
"version": "2.0",
"service": "<p>AWS Batch enables you to run batch computing workloads on the AWS Cloud. Batch computing is a common way for developers, scientists, and engineers to access large amounts of compute resources, and AWS Batch removes the undifferentiated heavy lifting of configuring and managing the required infrastructure. AWS Batch will be familiar to users of traditional batch computing software. This service can efficiently provision resources in response to jobs submitted in order to eliminate capacity constraints, reduce compute costs, and deliver results quickly.</p> <p>As a fully managed service, AWS Batch enables developers, scientists, and engineers to run batch computing workloads of any scale. AWS Batch automatically provisions compute resources and optimizes the workload distribution based on the quantity and scale of the workloads. With AWS Batch, there is no need to install or manage batch computing software, which allows you to focus on analyzing results and solving problems. AWS Batch reduces operational complexities, saves time, and reduces costs, which makes it easy for developers, scientists, and engineers to run their batch jobs in the AWS Cloud.</p>",
"operations": {
"CancelJob": "<p>Cancels jobs in an AWS Batch job queue. Jobs that are in the <code>SUBMITTED</code>, <code>PENDING</code>, or <code>RUNNABLE</code> state are cancelled. Jobs that have progressed to <code>STARTING</code> or <code>RUNNING</code> are not cancelled (but the API operation still succeeds, even if no jobs are cancelled); these jobs must be terminated with the <a>TerminateJob</a> operation.</p>",
"CreateComputeEnvironment": "<p>Creates an AWS Batch compute environment. You can create <code>MANAGED</code> or <code>UNMANAGED</code> compute environments.</p> <p>In a managed compute environment, AWS Batch manages the compute resources within the environment, based on the compute resources that you specify. Instances launched into a managed compute environment use a recent, approved version of the Amazon ECS-optimized AMI. You can choose to use Amazon EC2 On-Demand instances in your managed compute environment, or you can use Amazon EC2 Spot instances that only launch when the Spot bid price is below a specified percentage of the On-Demand price.</p> <p>In an unmanaged compute environment, you can manage your own compute resources. This provides more compute resource configuration options, such as using a custom AMI, but you must ensure that your AMI meets the Amazon ECS container instance AMI specification. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html\">Container Instance AMIs</a> in the <i>Amazon EC2 Container Service Developer Guide</i>. After you have created your unmanaged compute environment, you can use the <a>DescribeComputeEnvironments</a> operation to find the Amazon ECS cluster that is associated with it and then manually launch your container instances into that Amazon ECS cluster. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html\">Launching an Amazon ECS Container Instance</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p>",
"CancelJob": "<p>Cancels a job in an AWS Batch job queue. Jobs that are in the <code>SUBMITTED</code>, <code>PENDING</code>, or <code>RUNNABLE</code> state are cancelled. Jobs that have progressed to <code>STARTING</code> or <code>RUNNING</code> are not cancelled (but the API operation still succeeds, even if no job is cancelled); these jobs must be terminated with the <a>TerminateJob</a> operation.</p>",
"CreateComputeEnvironment": "<p>Creates an AWS Batch compute environment. You can create <code>MANAGED</code> or <code>UNMANAGED</code> compute environments.</p> <p>In a managed compute environment, AWS Batch manages the compute resources within the environment, based on the compute resources that you specify. Instances launched into a managed compute environment use a recent, approved version of the Amazon ECS-optimized AMI. You can choose to use Amazon EC2 On-Demand Instances in your managed compute environment, or you can use Amazon EC2 Spot Instances that only launch when the Spot bid price is below a specified percentage of the On-Demand price.</p> <p>In an unmanaged compute environment, you can manage your own compute resources. This provides more compute resource configuration options, such as using a custom AMI, but you must ensure that your AMI meets the Amazon ECS container instance AMI specification. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html\">Container Instance AMIs</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. After you have created your unmanaged compute environment, you can use the <a>DescribeComputeEnvironments</a> operation to find the Amazon ECS cluster that is associated with it and then manually launch your container instances into that Amazon ECS cluster. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html\">Launching an Amazon ECS Container Instance</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>",
"CreateJobQueue": "<p>Creates an AWS Batch job queue. When you create a job queue, you associate one or more compute environments to the queue and assign an order of preference for the compute environments.</p> <p>You also set a priority to the job queue that determines the order in which the AWS Batch scheduler places jobs onto its associated compute environments. For example, if a compute environment is associated with more than one job queue, the job queue with a higher priority is given preference for scheduling jobs to that compute environment.</p>",
"DeleteComputeEnvironment": "<p>Deletes an AWS Batch compute environment.</p> <p>Before you can delete a compute environment, you must set its state to <code>DISABLED</code> with the <a>UpdateComputeEnvironment</a> API operation and disassociate it from any job queues with the <a>UpdateJobQueue</a> API operation.</p>",
"DeleteJobQueue": "<p>Deletes the specified job queue. You must first disable submissions for a queue with the <a>UpdateJobQueue</a> operation. All jobs in the queue are terminated when you delete a job queue.</p> <p>It is not necessary to disassociate compute environments from a queue before submitting a <code>DeleteJobQueue</code> request. </p>",
@ -15,11 +15,41 @@
"ListJobs": "<p>Returns a list of task jobs for a specified job queue. You can filter the results by job status with the <code>jobStatus</code> parameter. If you do not specify a status, only <code>RUNNING</code> jobs are returned.</p>",
"RegisterJobDefinition": "<p>Registers an AWS Batch job definition. </p>",
"SubmitJob": "<p>Submits an AWS Batch job from a job definition. Parameters specified during <a>SubmitJob</a> override parameters defined in the job definition. </p>",
"TerminateJob": "<p>Terminates jobs in a job queue. Jobs that are in the <code>STARTING</code> or <code>RUNNING</code> state are terminated, which causes them to transition to <code>FAILED</code>. Jobs that have not progressed to the <code>STARTING</code> state are cancelled.</p>",
"TerminateJob": "<p>Terminates a job in a job queue. Jobs that are in the <code>STARTING</code> or <code>RUNNING</code> state are terminated, which causes them to transition to <code>FAILED</code>. Jobs that have not progressed to the <code>STARTING</code> state are cancelled.</p>",
"UpdateComputeEnvironment": "<p>Updates an AWS Batch compute environment.</p>",
"UpdateJobQueue": "<p>Updates a job queue.</p>"
},
"shapes": {
"ArrayJobDependency": {
"base": null,
"refs": {
"JobDependency$type": "<p>The type of the job dependency.</p>"
}
},
"ArrayJobStatusSummary": {
"base": null,
"refs": {
"ArrayPropertiesDetail$statusSummary": "<p>A summary of the number of array job children in each available job status. This parameter is returned for parent array jobs.</p>"
}
},
"ArrayProperties": {
"base": "<p>An object representing an AWS Batch array job.</p>",
"refs": {
"SubmitJobRequest$arrayProperties": "<p>The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see <a href=\"http://docs.aws.amazon.com/batch/latest/userguide/array_jobs.html\">Array Jobs</a> in the <i>AWS Batch User Guide</i>.</p>"
}
},
"ArrayPropertiesDetail": {
"base": "<p>An object representing the array properties of a job.</p>",
"refs": {
"JobDetail$arrayProperties": "<p>The array properties of the job, if it is an array job.</p>"
}
},
"ArrayPropertiesSummary": {
"base": "<p>An object representing the array properties of a job.</p>",
"refs": {
"JobSummary$arrayProperties": "<p>The array properties of the job, if it is an array job.</p>"
}
},
"AttemptContainerDetail": {
"base": "<p>An object representing the details of a container that is part of a job attempt.</p>",
"refs": {
@ -86,7 +116,7 @@
}
},
"ClientException": {
"base": "<p>These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </p>",
"base": "<p>These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. </p>",
"refs": {
}
},
@ -111,7 +141,7 @@
"ComputeEnvironmentOrders": {
"base": null,
"refs": {
"CreateJobQueueRequest$computeEnvironmentOrder": "<p>The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment should execute a given job. Compute environments must be in the <code>VALID</code> state before you can associate them with a job queue. You can associate up to 3 compute environments with a job queue.</p>",
"CreateJobQueueRequest$computeEnvironmentOrder": "<p>The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment should execute a given job. Compute environments must be in the <code>VALID</code> state before you can associate them with a job queue. You can associate up to three compute environments with a job queue.</p>",
"JobQueueDetail$computeEnvironmentOrder": "<p>The compute environments that are attached to the job queue and the order in which job placement is preferred. Compute environments are selected for job placement in ascending order.</p>",
"UpdateJobQueueRequest$computeEnvironmentOrder": "<p>Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment should execute a given job. </p>"
}
@ -148,6 +178,12 @@
"RegisterJobDefinitionRequest$containerProperties": "<p>An object with various properties specific for container-based jobs. This parameter is required if the <code>type</code> parameter is <code>container</code>.</p>"
}
},
"ContainerSummary": {
"base": "<p>An object representing summary details of a container within a job.</p>",
"refs": {
"JobSummary$container": "<p>An object representing the details of the container that is associated with the job.</p>"
}
},
"CreateComputeEnvironmentRequest": {
"base": null,
"refs": {
@ -241,20 +277,26 @@
"EnvironmentVariables": {
"base": null,
"refs": {
"ContainerDetail$environment": "<p>The environment variables to pass to a container.</p>",
"ContainerOverrides$environment": "<p>The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition.</p>",
"ContainerProperties$environment": "<p>The environment variables to pass to a container. This parameter maps to <code>Env</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--env</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <important> <p>We do not recommend using plain text environment variables for sensitive information, such as credential data.</p> </important>"
"ContainerDetail$environment": "<p>The environment variables to pass to a container.</p> <note> <p>Environment variables must not start with <code>AWS_BATCH</code>; this naming convention is reserved for variables that are set by the AWS Batch service.</p> </note>",
"ContainerOverrides$environment": "<p>The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition.</p> <note> <p>Environment variables must not start with <code>AWS_BATCH</code>; this naming convention is reserved for variables that are set by the AWS Batch service.</p> </note>",
"ContainerProperties$environment": "<p>The environment variables to pass to a container. This parameter maps to <code>Env</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--env</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <important> <p>We do not recommend using plaintext environment variables for sensitive information, such as credential data.</p> </important> <note> <p>Environment variables must not start with <code>AWS_BATCH</code>; this naming convention is reserved for variables that are set by the AWS Batch service.</p> </note>"
}
},
"Host": {
"base": "<p>The contents of the <code>host</code> parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running.</p>",
"refs": {
"Volume$host": "<p>The contents of the <code>host</code> parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running.</p>"
"Volume$host": "<p>The contents of the <code>host</code> parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data is not guaranteed to persist after the containers associated with it stop running.</p>"
}
},
"Integer": {
"base": null,
"refs": {
"ArrayJobStatusSummary$value": null,
"ArrayProperties$size": "<p>The size of the array job.</p>",
"ArrayPropertiesDetail$size": "<p>The size of the array job. This parameter is returned for parent array jobs.</p>",
"ArrayPropertiesDetail$index": "<p>The job index within the array that is associated with this job. This parameter is returned for array job children.</p>",
"ArrayPropertiesSummary$size": "<p>The size of the array job. This parameter is returned for parent array jobs.</p>",
"ArrayPropertiesSummary$index": "<p>The job index within the array that is associated with this job. This parameter is returned for children of array jobs.</p>",
"AttemptContainerDetail$exitCode": "<p>The exit code for the job attempt. A non-zero exit code is considered a failure.</p>",
"ComputeEnvironmentOrder$order": "<p>The order of the compute environment.</p>",
"ComputeResource$minvCpus": "<p>The minimum number of EC2 vCPUs that an environment should maintain. </p>",
@ -269,8 +311,9 @@
"ContainerDetail$exitCode": "<p>The exit code to return upon completion.</p>",
"ContainerOverrides$vcpus": "<p>The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.</p>",
"ContainerOverrides$memory": "<p>The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.</p>",
"ContainerProperties$vcpus": "<p>The number of vCPUs reserved for the container. This parameter maps to <code>CpuShares</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least 1 vCPU.</p>",
"ContainerProperties$vcpus": "<p>The number of vCPUs reserved for the container. This parameter maps to <code>CpuShares</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.</p>",
"ContainerProperties$memory": "<p>The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to <code>Memory</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--memory</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. You must specify at least 4 MiB of memory for a job.</p>",
"ContainerSummary$exitCode": "<p>The exit code to return upon completion.</p>",
"CreateJobQueueRequest$priority": "<p>The priority of the job queue. Job queues with a higher priority (or a higher integer value for the <code>priority</code> parameter) are evaluated first when associated with same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of <code>10</code> is given scheduling preference over a job queue with a priority value of <code>1</code>.</p>",
"DescribeComputeEnvironmentsRequest$maxResults": "<p>The maximum number of cluster results returned by <code>DescribeComputeEnvironments</code> in paginated output. When this parameter is used, <code>DescribeComputeEnvironments</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeComputeEnvironments</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>DescribeComputeEnvironments</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>",
"DescribeJobDefinitionsRequest$maxResults": "<p>The maximum number of results returned by <code>DescribeJobDefinitions</code> in paginated output. When this parameter is used, <code>DescribeJobDefinitions</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeJobDefinitions</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>DescribeJobDefinitions</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>",
@ -279,7 +322,7 @@
"JobQueueDetail$priority": "<p>The priority of the job queue. </p>",
"ListJobsRequest$maxResults": "<p>The maximum number of results returned by <code>ListJobs</code> in paginated output. When this parameter is used, <code>ListJobs</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListJobs</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListJobs</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>",
"RegisterJobDefinitionResponse$revision": "<p>The revision of the job definition.</p>",
"RetryStrategy$attempts": "<p>The number of times to move a job to the <code>RUNNABLE</code> status. You may specify between 1 and 10 attempts. If <code>attempts</code> is greater than one, the job is retried if it fails until it has moved to <code>RUNNABLE</code> that many times.</p>",
"RetryStrategy$attempts": "<p>The number of times to move a job to the <code>RUNNABLE</code> status. You may specify between 1 and 10 attempts. If the value of <code>attempts</code> is greater than one, the job is retried if it fails until it has moved to <code>RUNNABLE</code> that many times.</p>",
"Ulimit$hardLimit": "<p>The hard limit for the <code>ulimit</code> type.</p>",
"Ulimit$softLimit": "<p>The soft limit for the <code>ulimit</code> type.</p>",
"UpdateJobQueueRequest$priority": "<p>The priority of the job queue. Job queues with a higher priority (or a higher integer value for the <code>priority</code> parameter) are evaluated first when associated with same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of <code>10</code> is given scheduling preference over a job queue with a priority value of <code>1</code>.</p>"
@ -327,7 +370,7 @@
"base": null,
"refs": {
"JobDetail$dependsOn": "<p>A list of job names or IDs on which this job depends.</p>",
"SubmitJobRequest$dependsOn": "<p>A list of job IDs on which this job depends. A job can depend upon a maximum of 20 jobs. </p>"
"SubmitJobRequest$dependsOn": "<p>A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a <code>SEQUENTIAL</code> type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an <code>N_TO_N</code> type dependency with a job ID for array jobs so that each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.</p>"
}
},
"JobDetail": {
@ -358,6 +401,7 @@
"base": null,
"refs": {
"JobDetail$status": "<p>The current status for the job.</p>",
"JobSummary$status": "<p>The current status for the job.</p>",
"ListJobsRequest$jobStatus": "<p>The job status with which to filter jobs in the specified queue. If you do not specify a status, only <code>RUNNING</code> jobs are returned.</p>"
}
},
@ -392,11 +436,14 @@
"Long": {
"base": null,
"refs": {
"AttemptDetail$startedAt": "<p>The Unix timestamp for when the attempt was started (when the task transitioned from the <code>PENDING</code> state to the <code>RUNNING</code> state).</p>",
"AttemptDetail$stoppedAt": "<p>The Unix timestamp for when the attempt was stopped (when the task transitioned from the <code>RUNNING</code> state to the <code>STOPPED</code> state).</p>",
"JobDetail$createdAt": "<p>The Unix timestamp for when the job was created (when the task entered the <code>PENDING</code> state). </p>",
"JobDetail$startedAt": "<p>The Unix timestamp for when the job was started (when the task transitioned from the <code>PENDING</code> state to the <code>RUNNING</code> state). </p>",
"JobDetail$stoppedAt": "<p>The Unix timestamp for when the job was stopped (when the task transitioned from the <code>RUNNING</code> state to the <code>STOPPED</code> state).</p>"
"AttemptDetail$startedAt": "<p>The Unix time stamp for when the attempt was started (when the attempt transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state).</p>",
"AttemptDetail$stoppedAt": "<p>The Unix time stamp for when the attempt was stopped (when the attempt transitioned from the <code>RUNNING</code> state to a terminal state, such as <code>SUCCEEDED</code> or <code>FAILED</code>).</p>",
"JobDetail$createdAt": "<p>The Unix time stamp for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the <code>SUBMITTED</code> state (at the time <a>SubmitJob</a> was called). For array child jobs, this is when the child job was spawned by its parent and entered the <code>PENDING</code> state.</p>",
"JobDetail$startedAt": "<p>The Unix time stamp for when the job was started (when the job transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state).</p>",
"JobDetail$stoppedAt": "<p>The Unix time stamp for when the job was stopped (when the job transitioned from the <code>RUNNING</code> state to a terminal state, such as <code>SUCCEEDED</code> or <code>FAILED</code>).</p>",
"JobSummary$createdAt": "<p>The Unix time stamp for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the <code>SUBMITTED</code> state (at the time <a>SubmitJob</a> was called). For array child jobs, this is when the child job was spawned by its parent and entered the <code>PENDING</code> state.</p>",
"JobSummary$startedAt": "<p>The Unix time stamp for when the job was started (when the job transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state).</p>",
"JobSummary$stoppedAt": "<p>The Unix time stamp for when the job was stopped (when the job transitioned from the <code>RUNNING</code> state to a terminal state, such as <code>SUCCEEDED</code> or <code>FAILED</code>).</p>"
}
},
"MountPoint": {
@ -448,13 +495,14 @@
"String": {
"base": null,
"refs": {
"ArrayJobStatusSummary$key": null,
"AttemptContainerDetail$containerInstanceArn": "<p>The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.</p>",
"AttemptContainerDetail$taskArn": "<p>The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the job attempt.</p>",
"AttemptContainerDetail$taskArn": "<p>The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the job attempt. Each container attempt receives a task ARN when they reach the <code>STARTING</code> status.</p>",
"AttemptContainerDetail$reason": "<p>A short (255 max characters) human-readable string to provide additional details about a running or stopped container.</p>",
"AttemptContainerDetail$logStreamName": "<p>The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is <code>/aws/batch/job</code>. Each container attempt receives a log stream name when they reach the <code>RUNNING</code> status.</p>",
"AttemptDetail$statusReason": "<p>A short, human-readable string to provide additional details about the current status of the job attempt.</p>",
"CancelJobRequest$jobId": "<p>A list of up to 100 job IDs to cancel.</p>",
"CancelJobRequest$reason": "<p>A message to attach to the job that explains the reason for cancelling it. This message is returned by future <a>DescribeJobs</a> operations on the job. This message is also recorded in the AWS Batch activity logs. </p>",
"CancelJobRequest$jobId": "<p>The AWS Batch job ID of the job to cancel.</p>",
"CancelJobRequest$reason": "<p>A message to attach to the job that explains the reason for canceling it. This message is returned by future <a>DescribeJobs</a> operations on the job. This message is also recorded in the AWS Batch activity logs. </p>",
"ClientException$message": null,
"ComputeEnvironmentDetail$computeEnvironmentName": "<p>The name of the compute environment. </p>",
"ComputeEnvironmentDetail$computeEnvironmentArn": "<p>The Amazon Resource Name (ARN) of the compute environment. </p>",
@ -471,12 +519,13 @@
"ContainerDetail$user": "<p>The user name to use inside the container.</p>",
"ContainerDetail$reason": "<p>A short (255 max characters) human-readable string to provide additional details about a running or stopped container.</p>",
"ContainerDetail$containerInstanceArn": "<p>The Amazon Resource Name (ARN) of the container instance on which the container is running.</p>",
"ContainerDetail$taskArn": "<p>The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job.</p>",
"ContainerDetail$taskArn": "<p>The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job. Each container attempt receives a task ARN when they reach the <code>STARTING</code> status.</p>",
"ContainerDetail$logStreamName": "<p>The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is <code>/aws/batch/job</code>. Each container attempt receives a log stream name when they reach the <code>RUNNING</code> status.</p>",
"ContainerProperties$image": "<p>The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with <code> <i>repository-url</i>/<i>image</i>:<i>tag</i> </code>. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to <code>Image</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>IMAGE</code> parameter of <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <ul> <li> <p>Images in Amazon ECR repositories use the full registry and repository URI (for example, <code>012345678910.dkr.ecr.&lt;region-name&gt;.amazonaws.com/&lt;repository-name&gt;</code>). </p> </li> <li> <p>Images in official repositories on Docker Hub use a single name (for example, <code>ubuntu</code> or <code>mongo</code>).</p> </li> <li> <p>Images in other repositories on Docker Hub are qualified with an organization name (for example, <code>amazon/amazon-ecs-agent</code>).</p> </li> <li> <p>Images in other online repositories are qualified further by a domain name (for example, <code>quay.io/assemblyline/ubuntu</code>).</p> </li> </ul>",
"ContainerProperties$jobRoleArn": "<p>The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.</p>",
"ContainerProperties$user": "<p>The user name to use inside the container. This parameter maps to <code>User</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--user</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>",
"CreateComputeEnvironmentRequest$computeEnvironmentName": "<p>The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, and underscores are allowed.</p>",
"ContainerSummary$reason": "<p>A short (255 max characters) human-readable string to provide additional details about a running or stopped container.</p>",
"CreateComputeEnvironmentRequest$computeEnvironmentName": "<p>The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.</p>",
"CreateComputeEnvironmentRequest$serviceRole": "<p>The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.</p> <p>If your specified role has a path other than <code>/</code>, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.</p> <note> <p>Depending on how you created your AWS Batch service role, its ARN may contain the <code>service-role</code> path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not use the <code>service-role</code> path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.</p> </note>",
"CreateComputeEnvironmentResponse$computeEnvironmentName": "<p>The name of the compute environment.</p>",
"CreateComputeEnvironmentResponse$computeEnvironmentArn": "<p>The Amazon Resource Name (ARN) of the compute environment. </p>",
@ -510,9 +559,11 @@
"JobQueueDetail$statusReason": "<p>A short, human-readable string to provide additional details about the current status of the job queue.</p>",
"JobSummary$jobId": "<p>The ID of the job.</p>",
"JobSummary$jobName": "<p>The name of the job.</p>",
"KeyValuePair$name": "<p>The name of the key value pair. For environment variables, this is the name of the environment variable.</p>",
"KeyValuePair$value": "<p>The value of the key value pair. For environment variables, this is the value of the environment variable.</p>",
"JobSummary$statusReason": "<p>A short, human-readable string to provide additional details about the current status of the job.</p>",
"KeyValuePair$name": "<p>The name of the key-value pair. For environment variables, this is the name of the environment variable.</p>",
"KeyValuePair$value": "<p>The value of the key-value pair. For environment variables, this is the value of the environment variable.</p>",
"ListJobsRequest$jobQueue": "<p>The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.</p>",
"ListJobsRequest$arrayJobId": "<p>The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.</p>",
"ListJobsRequest$nextToken": "<p>The <code>nextToken</code> value returned from a previous paginated <code>ListJobs</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</p> <note> <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note>",
"ListJobsResponse$nextToken": "<p>The <code>nextToken</code> value to include in a future <code>ListJobs</code> request. When the results of a <code>ListJobs</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>",
"MountPoint$containerPath": "<p>The path on the container at which to mount the host volume.</p>",
@ -525,14 +576,14 @@
"ServerException$message": null,
"StringList$member": null,
"SubmitJobRequest$jobName": "<p>The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. </p>",
"SubmitJobRequest$jobQueue": "<p>The job queue into which the job will be submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue. </p>",
"SubmitJobRequest$jobQueue": "<p>The job queue into which the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue. </p>",
"SubmitJobRequest$jobDefinition": "<p>The job definition used by this job. This value can be either a <code>name:revision</code> or the Amazon Resource Name (ARN) for the job definition.</p>",
"SubmitJobResponse$jobName": "<p>The name of the job. </p>",
"SubmitJobResponse$jobId": "<p>The unique identifier for the job.</p>",
"TagsMap$key": null,
"TagsMap$value": null,
"TerminateJobRequest$jobId": "<p>Job IDs to be terminated. Up to 100 jobs can be specified.</p>",
"TerminateJobRequest$reason": "<p>A message to attach to the job that explains the reason for cancelling it. This message is returned by future <a>DescribeJobs</a> operations on the job. This message is also recorded in the AWS Batch activity logs. </p>",
"TerminateJobRequest$jobId": "<p>The AWS Batch job ID of the job to terminate.</p>",
"TerminateJobRequest$reason": "<p>A message to attach to the job that explains the reason for canceling it. This message is returned by future <a>DescribeJobs</a> operations on the job. This message is also recorded in the AWS Batch activity logs. </p>",
"Ulimit$name": "<p>The <code>type</code> of the <code>ulimit</code>.</p>",
"UpdateComputeEnvironmentRequest$computeEnvironment": "<p>The name or full Amazon Resource Name (ARN) of the compute environment to update.</p>",
"UpdateComputeEnvironmentRequest$serviceRole": "<p>The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.</p> <p>If your specified role has a path other than <code>/</code>, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.</p> <note> <p>Depending on how you created your AWS Batch service role, its ARN may contain the <code>service-role</code> path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not use the <code>service-role</code> path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.</p> </note>",
@ -547,7 +598,7 @@
"StringList": {
"base": null,
"refs": {
"ComputeResource$instanceTypes": "<p>The instances types that may launched.</p>",
"ComputeResource$instanceTypes": "<p>The instances types that may be launched. You can specify instance families to launch any instance type within those families (for example, <code>c4</code> or <code>p3</code>), or you can specify specific sizes within a family (such as <code>c4.8xlarge</code>). You can also choose <code>optimal</code> to pick instance types (from the latest C, M, and R instance families) on the fly that match the demand of your job queues.</p>",
"ComputeResource$subnets": "<p>The VPC subnets into which the compute resources are launched. </p>",
"ComputeResource$securityGroupIds": "<p>The EC2 security group that is associated with instances launched in the compute environment. </p>",
"ContainerDetail$command": "<p>The command that is passed to the container. </p>",

View File

@ -219,7 +219,6 @@
"required":[
"BudgetName",
"BudgetLimit",
"CostTypes",
"TimeUnit",
"TimePeriod",
"BudgetType"
@ -275,15 +274,16 @@
},
"CostTypes":{
"type":"structure",
"required":[
"IncludeTax",
"IncludeSubscription",
"UseBlended"
],
"members":{
"IncludeTax":{"shape":"GenericBoolean"},
"IncludeSubscription":{"shape":"GenericBoolean"},
"UseBlended":{"shape":"GenericBoolean"}
"IncludeTax":{"shape":"NullableBoolean"},
"IncludeSubscription":{"shape":"NullableBoolean"},
"UseBlended":{"shape":"NullableBoolean"},
"IncludeRefund":{"shape":"NullableBoolean"},
"IncludeCredit":{"shape":"NullableBoolean"},
"IncludeUpfront":{"shape":"NullableBoolean"},
"IncludeRecurring":{"shape":"NullableBoolean"},
"IncludeOtherSubscription":{"shape":"NullableBoolean"},
"IncludeSupport":{"shape":"NullableBoolean"}
}
},
"CreateBudgetRequest":{
@ -497,7 +497,6 @@
},
"exception":true
},
"GenericBoolean":{"type":"boolean"},
"GenericString":{"type":"string"},
"GenericTimestamp":{"type":"timestamp"},
"InternalErrorException":{
@ -580,6 +579,10 @@
"type":"list",
"member":{"shape":"Notification"}
},
"NullableBoolean":{
"type":"boolean",
"box":true
},
"NumericValue":{
"type":"string",
"pattern":"[0-9]*(\\.)?[0-9]+"
@ -603,9 +606,13 @@
],
"members":{
"SubscriptionType":{"shape":"SubscriptionType"},
"Address":{"shape":"GenericString"}
"Address":{"shape":"SubscriberAddress"}
}
},
"SubscriberAddress":{
"type":"string",
"min":1
},
"Subscribers":{
"type":"list",
"member":{"shape":"Subscriber"},

View File

@ -217,14 +217,6 @@
"refs": {
}
},
"GenericBoolean": {
"base": "A generic boolean value.",
"refs": {
"CostTypes$IncludeTax": null,
"CostTypes$IncludeSubscription": null,
"CostTypes$UseBlended": null
}
},
"GenericString": {
"base": "A generic String.",
"refs": {
@ -235,8 +227,7 @@
"DescribeNotificationsForBudgetResponse$NextToken": null,
"DescribeSubscribersForNotificationRequest$NextToken": null,
"DescribeSubscribersForNotificationResponse$NextToken": null,
"DimensionValues$member": null,
"Subscriber$Address": null
"DimensionValues$member": null
}
},
"GenericTimestamp": {
@ -319,6 +310,20 @@
"DescribeNotificationsForBudgetResponse$Notifications": null
}
},
"NullableBoolean": {
"base": null,
"refs": {
"CostTypes$IncludeTax": "A boolean value whether to include tax in the cost budget.",
"CostTypes$IncludeSubscription": "A boolean value whether to include subscriptions in the cost budget.",
"CostTypes$UseBlended": "A boolean value whether to use blended costs in the cost budget.",
"CostTypes$IncludeRefund": "A boolean value whether to include refunds in the cost budget.",
"CostTypes$IncludeCredit": "A boolean value whether to include credits in the cost budget.",
"CostTypes$IncludeUpfront": "A boolean value whether to include upfront costs in the cost budget.",
"CostTypes$IncludeRecurring": "A boolean value whether to include recurring costs in the cost budget.",
"CostTypes$IncludeOtherSubscription": "A boolean value whether to include other subscription costs in the cost budget.",
"CostTypes$IncludeSupport": "A boolean value whether to include support costs in the cost budget."
}
},
"NumericValue": {
"base": "A string to represent NumericValue.",
"refs": {
@ -343,6 +348,12 @@
"UpdateSubscriberRequest$NewSubscriber": null
}
},
"SubscriberAddress": {
"base": "String containing email or sns topic for the subscriber address.",
"refs": {
"Subscriber$Address": null
}
},
"Subscribers": {
"base": "A list of subscribers.",
"refs": {

View File

@ -0,0 +1,384 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2017-10-25",
"endpointPrefix":"ce",
"jsonVersion":"1.1",
"protocol":"json",
"serviceAbbreviation":"AWS Cost Explorer",
"serviceFullName":"AWS Cost Explorer Service",
"serviceId":"Cost Explorer",
"signatureVersion":"v4",
"signingName":"ce",
"targetPrefix":"AWSInsightsIndexService",
"uid":"ce-2017-10-25"
},
"operations":{
"GetCostAndUsage":{
"name":"GetCostAndUsage",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetCostAndUsageRequest"},
"output":{"shape":"GetCostAndUsageResponse"},
"errors":[
{"shape":"LimitExceededException"}
]
},
"GetDimensionValues":{
"name":"GetDimensionValues",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetDimensionValuesRequest"},
"output":{"shape":"GetDimensionValuesResponse"},
"errors":[
{"shape":"LimitExceededException"}
]
},
"GetReservationUtilization":{
"name":"GetReservationUtilization",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetReservationUtilizationRequest"},
"output":{"shape":"GetReservationUtilizationResponse"},
"errors":[
{"shape":"LimitExceededException"}
]
},
"GetTags":{
"name":"GetTags",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetTagsRequest"},
"output":{"shape":"GetTagsResponse"},
"errors":[
{"shape":"LimitExceededException"}
]
}
},
"shapes":{
"AttributeType":{"type":"string"},
"AttributeValue":{"type":"string"},
"Attributes":{
"type":"map",
"key":{"shape":"AttributeType"},
"value":{"shape":"AttributeValue"}
},
"Context":{
"type":"string",
"enum":[
"COST_AND_USAGE",
"RESERVATIONS"
]
},
"DateInterval":{
"type":"structure",
"required":[
"Start",
"End"
],
"members":{
"Start":{"shape":"YearMonthDay"},
"End":{"shape":"YearMonthDay"}
}
},
"Dimension":{
"type":"string",
"enum":[
"AZ",
"INSTANCE_TYPE",
"LINKED_ACCOUNT",
"OPERATION",
"PURCHASE_TYPE",
"REGION",
"SERVICE",
"USAGE_TYPE",
"USAGE_TYPE_GROUP",
"RECORD_TYPE",
"OPERATING_SYSTEM",
"TENANCY",
"SCOPE",
"PLATFORM",
"SUBSCRIPTION_ID"
]
},
"DimensionValues":{
"type":"structure",
"members":{
"Key":{"shape":"Dimension"},
"Values":{"shape":"Values"}
}
},
"DimensionValuesWithAttributes":{
"type":"structure",
"members":{
"Value":{"shape":"Value"},
"Attributes":{"shape":"Attributes"}
}
},
"DimensionValuesWithAttributesList":{
"type":"list",
"member":{"shape":"DimensionValuesWithAttributes"}
},
"Entity":{"type":"string"},
"ErrorMessage":{"type":"string"},
"Estimated":{"type":"boolean"},
"Expression":{
"type":"structure",
"members":{
"Or":{"shape":"Expressions"},
"And":{"shape":"Expressions"},
"Not":{"shape":"Expression"},
"Dimensions":{"shape":"DimensionValues"},
"Tags":{"shape":"TagValues"}
}
},
"Expressions":{
"type":"list",
"member":{"shape":"Expression"}
},
"GetCostAndUsageRequest":{
"type":"structure",
"members":{
"TimePeriod":{"shape":"DateInterval"},
"Granularity":{"shape":"Granularity"},
"Filter":{"shape":"Expression"},
"Metrics":{"shape":"MetricNames"},
"GroupBy":{"shape":"GroupDefinitions"},
"NextPageToken":{"shape":"NextPageToken"}
}
},
"GetCostAndUsageResponse":{
"type":"structure",
"members":{
"NextPageToken":{"shape":"NextPageToken"},
"GroupDefinitions":{"shape":"GroupDefinitions"},
"ResultsByTime":{"shape":"ResultsByTime"}
}
},
"GetDimensionValuesRequest":{
"type":"structure",
"required":[
"TimePeriod",
"Dimension"
],
"members":{
"SearchString":{"shape":"SearchString"},
"TimePeriod":{"shape":"DateInterval"},
"Dimension":{"shape":"Dimension"},
"Context":{"shape":"Context"},
"NextPageToken":{"shape":"NextPageToken"}
}
},
"GetDimensionValuesResponse":{
"type":"structure",
"required":[
"DimensionValues",
"ReturnSize",
"TotalSize"
],
"members":{
"DimensionValues":{"shape":"DimensionValuesWithAttributesList"},
"ReturnSize":{"shape":"PageSize"},
"TotalSize":{"shape":"PageSize"},
"NextPageToken":{"shape":"NextPageToken"}
}
},
"GetReservationUtilizationRequest":{
"type":"structure",
"required":["TimePeriod"],
"members":{
"TimePeriod":{"shape":"DateInterval"},
"GroupBy":{"shape":"GroupDefinitions"},
"Granularity":{"shape":"Granularity"},
"Filter":{"shape":"Expression"},
"NextPageToken":{"shape":"NextPageToken"}
}
},
"GetReservationUtilizationResponse":{
"type":"structure",
"required":["UtilizationsByTime"],
"members":{
"UtilizationsByTime":{"shape":"UtilizationsByTime"},
"Total":{"shape":"ReservationAggregates"},
"NextPageToken":{"shape":"NextPageToken"}
}
},
"GetTagsRequest":{
"type":"structure",
"required":["TimePeriod"],
"members":{
"SearchString":{"shape":"SearchString"},
"TimePeriod":{"shape":"DateInterval"},
"TagKey":{"shape":"TagKey"},
"NextPageToken":{"shape":"NextPageToken"}
}
},
"GetTagsResponse":{
"type":"structure",
"required":[
"Tags",
"ReturnSize",
"TotalSize"
],
"members":{
"NextPageToken":{"shape":"NextPageToken"},
"Tags":{"shape":"TagList"},
"ReturnSize":{"shape":"PageSize"},
"TotalSize":{"shape":"PageSize"}
}
},
"Granularity":{
"type":"string",
"enum":[
"DAILY",
"MONTHLY"
]
},
"Group":{
"type":"structure",
"members":{
"Keys":{"shape":"Keys"},
"Metrics":{"shape":"Metrics"}
}
},
"GroupDefinition":{
"type":"structure",
"members":{
"Type":{"shape":"GroupDefinitionType"},
"Key":{"shape":"GroupDefinitionKey"}
}
},
"GroupDefinitionKey":{"type":"string"},
"GroupDefinitionType":{
"type":"string",
"enum":[
"DIMENSION",
"TAG"
]
},
"GroupDefinitions":{
"type":"list",
"member":{"shape":"GroupDefinition"}
},
"Groups":{
"type":"list",
"member":{"shape":"Group"}
},
"Key":{"type":"string"},
"Keys":{
"type":"list",
"member":{"shape":"Key"}
},
"LimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"MetricAmount":{"type":"string"},
"MetricName":{"type":"string"},
"MetricNames":{
"type":"list",
"member":{"shape":"MetricName"}
},
"MetricUnit":{"type":"string"},
"MetricValue":{
"type":"structure",
"members":{
"Amount":{"shape":"MetricAmount"},
"Unit":{"shape":"MetricUnit"}
}
},
"Metrics":{
"type":"map",
"key":{"shape":"MetricName"},
"value":{"shape":"MetricValue"}
},
"NextPageToken":{"type":"string"},
"PageSize":{"type":"integer"},
"PurchasedHours":{"type":"string"},
"ReservationAggregates":{
"type":"structure",
"members":{
"UtilizationPercentage":{"shape":"UtilizationPercentage"},
"PurchasedHours":{"shape":"PurchasedHours"},
"TotalActualHours":{"shape":"TotalActualHours"},
"UnusedHours":{"shape":"UnusedHours"}
}
},
"ReservationGroupKey":{"type":"string"},
"ReservationGroupValue":{"type":"string"},
"ReservationUtilizationGroup":{
"type":"structure",
"members":{
"Key":{"shape":"ReservationGroupKey"},
"Value":{"shape":"ReservationGroupValue"},
"Attributes":{"shape":"Attributes"},
"Utilization":{"shape":"ReservationAggregates"}
}
},
"ReservationUtilizationGroups":{
"type":"list",
"member":{"shape":"ReservationUtilizationGroup"}
},
"ResultByTime":{
"type":"structure",
"members":{
"TimePeriod":{"shape":"DateInterval"},
"Total":{"shape":"Metrics"},
"Groups":{"shape":"Groups"},
"Estimated":{"shape":"Estimated"}
}
},
"ResultsByTime":{
"type":"list",
"member":{"shape":"ResultByTime"}
},
"SearchString":{"type":"string"},
"TagKey":{"type":"string"},
"TagList":{
"type":"list",
"member":{"shape":"Entity"}
},
"TagValues":{
"type":"structure",
"members":{
"Key":{"shape":"TagKey"},
"Values":{"shape":"Values"}
}
},
"TotalActualHours":{"type":"string"},
"UnusedHours":{"type":"string"},
"UtilizationByTime":{
"type":"structure",
"members":{
"TimePeriod":{"shape":"DateInterval"},
"Groups":{"shape":"ReservationUtilizationGroups"},
"Total":{"shape":"ReservationAggregates"}
}
},
"UtilizationPercentage":{"type":"string"},
"UtilizationsByTime":{
"type":"list",
"member":{"shape":"UtilizationByTime"}
},
"Value":{"type":"string"},
"Values":{
"type":"list",
"member":{"shape":"Value"}
},
"YearMonthDay":{
"type":"string",
"pattern":"\\d{4}-\\d{2}-\\d{2}"
}
}
}

View File

@ -0,0 +1,396 @@
{
"version": "2.0",
"service": "<p>The Cost Explorer API allows you to programmatically query your cost and usage data. You can query for aggregated data such as total monthly costs or total daily usage. You can also query for granular data, such as the number of daily write operations for DynamoDB database tables in your production environment. </p> <p>Service Endpoint</p> <p>The Cost Explorer API provides the following endpoint:</p> <ul> <li> <p>https://ce.us-east-1.amazonaws.com</p> </li> </ul>",
"operations": {
"GetCostAndUsage": "<p>Retrieve cost and usage metrics for your account. You can specify which cost and usage-related metric, such as <code>BlendedCosts</code> or <code>UsageQuantity</code>, that you want the request to return. You can also filter and group your data by various dimensions, such as <code>AWS Service</code> or <code>AvailabilityZone</code>, in a specific time range. See the <code>GetDimensionValues</code> action for a complete list of the valid dimensions. Master accounts in an organization have access to all member accounts.</p>",
"GetDimensionValues": "<p>You can use <code>GetDimensionValues</code> to retrieve all available filter values for a specific filter over a period of time. You can search the dimension values for an arbitrary string. </p>",
"GetReservationUtilization": "<p>You can retrieve the Reservation utilization for your account. Master accounts in an organization have access to their associated member accounts. You can filter data by dimensions in a time period. You can use <code>GetDimensionValues</code> to determine the possible dimension values. Currently, you can group only by <code>SUBSCRIPTION_ID</code>. </p>",
"GetTags": "<p>You can query for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string. </p>"
},
"shapes": {
"AttributeType": {
"base": null,
"refs": {
"Attributes$key": null
}
},
"AttributeValue": {
"base": null,
"refs": {
"Attributes$value": null
}
},
"Attributes": {
"base": null,
"refs": {
"DimensionValuesWithAttributes$Attributes": "<p>The attribute that applies to a specific <code>Dimension</code>.</p>",
"ReservationUtilizationGroup$Attributes": "<p>The attributes for this group of RIs.</p>"
}
},
"Context": {
"base": null,
"refs": {
"GetDimensionValuesRequest$Context": "<p>The context for the call to <code>GetDimensionValues</code>. This can be <code>RESERVED_INSTANCE</code> or <code>COST_AND_USAGE</code>. The default value is <code>COST_AND_USAGE</code>. If the context is set to <code>RESERVED_INSTANCE</code>, the resulting dimension values can be used in the <code>GetReservationUtilization</code> action. If the context is set to <code>COST_AND_USAGE</code>, , the resulting dimension values can be used in the <code>GetCostAndUsage</code> operation.</p> <p>If you set the context to <code>CostAndUsage</code>, you can use the following dimensions for searching:</p> <ul> <li> <p>AZ - The Availability Zone. An example is us-east-1a.</p> </li> <li> <p>InstanceType - The type of EC2 instance. An example is m4.xlarge.</p> </li> <li> <p>LinkedAccount - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account</p> </li> <li> <p>Operation - The action performed. Examples include RunInstance and CreateBucket.</p> </li> <li> <p>PurchaseType - The reservation type of the purchase to which this usage is related. Examples include: On Demand Instances and Standard Reserved Instances</p> </li> <li> <p>Service - The AWS service such as DynamoDB.</p> </li> <li> <p>UsageType -The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues action includes a unit attribute, examples of which include GB and Hrs.</p> </li> <li> <p>UsageTypeGroup - The grouping of common usage types. An example is EC2: CloudWatch Alarms. The response for this action includes a unit attribute.</p> </li> <li> <p>RecordType - The different types of charges such as RI fees, usage costs, tax refunds, and credits</p> </li> </ul> <p>If you set the context to <code>ReservedInstance</code>, you can use the following dimensions for searching:</p> <ul> <li> <p>AZ - The Availability Zone. An example is us-east-1a.</p> </li> <li> <p>InstanceType - The type of EC2 instance. An example is m4.xlarge.</p> </li> <li> <p>LinkedAccount - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account</p> </li> <li> <p>Platform - The operating system. Examples are Windows or Linux.</p> </li> <li> <p>Region - The AWS region.</p> </li> <li> <p>Scope - The scope of a reserved instance (RI). Values are regional or a single availability zone.</p> </li> <li> <p>Tenancy - The tenancy of a resource. Examples are shared or dedicated.</p> </li> </ul>"
}
},
"DateInterval": {
"base": "<p>The time period that you want the usage and costs for. </p>",
"refs": {
"GetCostAndUsageRequest$TimePeriod": "<p>Sets the start and end dates for retrieving AWS costs. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>.</p>",
"GetDimensionValuesRequest$TimePeriod": "<p>The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>.</p>",
"GetReservationUtilizationRequest$TimePeriod": "<p>Sets the start and end dates for retrieving reserve instance (RI) utilization. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>. </p>",
"GetTagsRequest$TimePeriod": "<p>The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>.</p>",
"ResultByTime$TimePeriod": "<p>The time period covered by a result.</p>",
"UtilizationByTime$TimePeriod": "<p>The period of time over which this utilization was used.</p>"
}
},
"Dimension": {
"base": null,
"refs": {
"DimensionValues$Key": "<p>The names of the metadata types that you can use to filter and group your results. For example, <code>AZ</code> returns a list of Availability Zones.</p>",
"GetDimensionValuesRequest$Dimension": "<p>The name of the dimension. Different <code>Dimensions</code>are available for different <code>Context</code>s. For more information, see <code>Context</code>.</p>"
}
},
"DimensionValues": {
"base": "<p>The metadata that you can use to filter and group your results. You can use <code>GetDimensionValues</code> to find specific values.</p>",
"refs": {
"Expression$Dimensions": "<p>The specific <code>Dimension</code> to use for <code>Expression</code>.</p>"
}
},
"DimensionValuesWithAttributes": {
"base": "<p>The metadata of a specific type that you can use to filter and group your results. You can use <code>GetDimensionValues</code> to find specific values.</p>",
"refs": {
"DimensionValuesWithAttributesList$member": null
}
},
"DimensionValuesWithAttributesList": {
"base": null,
"refs": {
"GetDimensionValuesResponse$DimensionValues": "<p>The filters that you used to filter your request. Some dimensions are available only for a specific context:</p> <p>If you set the context to <code>CostAndUsage</code>, you can use the following dimensions for searching:</p> <ul> <li> <p>AZ - The Availability Zone. An example is us-east-1a.</p> </li> <li> <p>InstanceType - The type of EC2 instance. An example is m4.xlarge.</p> </li> <li> <p>LinkedAccount - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account</p> </li> <li> <p>Operation - The action performed. Examples include RunInstance and CreateBucket.</p> </li> <li> <p>PurchaseType - The reservation type of the purchase to which this usage is related. Examples include: On Demand Instances and Standard Reserved Instances</p> </li> <li> <p>Service - The AWS service such as DynamoDB.</p> </li> <li> <p>UsageType -The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues action includes a unit attribute, examples of which include GB and Hrs.</p> </li> <li> <p>UsageTypeGroup - The grouping of common usage types. An example is EC2: CloudWatch Alarms. The response for this action includes a unit attribute.</p> </li> <li> <p>RecordType - The different types of charges such as RI fees, usage costs, tax refunds, and credits</p> </li> </ul> <p>If you set the context to <code>ReservedInstance</code>, you can use the following dimensions for searching:</p> <ul> <li> <p>AZ - The Availability Zone. An example is us-east-1a.</p> </li> <li> <p>InstanceType - The type of EC2 instance. An example is m4.xlarge.</p> </li> <li> <p>LinkedAccount - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account</p> </li> <li> <p>Platform - The operating system. Examples are Windows or Linux.</p> </li> <li> <p>Region - The AWS region.</p> </li> <li> <p>Scope - The scope of a reserved instance (RI). Values are regional or a single availability zone.</p> </li> <li> <p>Tenancy - The tenancy of a resource. Examples are shared or dedicated.</p> </li> </ul>"
}
},
"Entity": {
"base": null,
"refs": {
"TagList$member": null
}
},
"ErrorMessage": {
"base": null,
"refs": {
"LimitExceededException$Message": null
}
},
"Estimated": {
"base": null,
"refs": {
"ResultByTime$Estimated": "<p>Whether or not this result is estimated.</p>"
}
},
"Expression": {
"base": "<p>Use <code>Expression</code> to filter by cost or by usage. There are two patterns: </p> <ul> <li> <p>Simple dimension values - You can set the dimension name and values for the filters that you plan to use. For example, you can filter for <code>InstanceType==m4.xlarge OR InstanceType==c4.large</code>. The <code>Expression</code> for that looks like this.</p> <p> <code>{ \"Dimensions\": { \"Key\": \"InstanceType\", \"Values\": [ \"m4.xlarge\", “c4.large” ] } }</code> </p> <p>The list of dimension values are OR'd together to retrieve cost or usage data. You can create <code>Expression</code> and <code>DimensionValues</code> objects using either <code>with*</code> methods or <code>set*</code> methods in multiple lines. </p> </li> <li> <p>Compound dimension values with logical operations - You can use multiple <code>Expression</code> types and the logical operators <code>AND/OR/NOT</code> to create a list of one or more <code>Expression</code> objects. This allows you to filter on more advanced options. For example, you can filter on <code>((InstanceType == m4.large OR InstanceType == m3.large) OR (Tag.Type == Type1)) AND (UsageType != DataTransfer)</code>. The <code>Expression</code> for that looks like this.</p> <p> <code>{ \"And\": [ {\"Or\": [ {\"Dimensions\": { \"Key\": \"InstanceType\", \"Values\": [ \"m4.x.large\", \"c4.large\" ] }}, {\"Tag\": { \"Key\": \"TagName\", \"Values\": [\"Value1\"] } } ]}, {\"Not\": {\"dimensions\": { \"Key\": \"UsageType\", \"Values\": [\"DataTransfer\"] }}} ] } </code> </p> <note> <p>Because each <code>Expression</code> can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that will create an error.</p> </note> <p> <code> { \"And\": [ ... ], \"DimensionValues\": { \"Dimension\": \"UsageType\", \"Values\": [ \"DataTransfer\" ] } } </code> </p> </li> </ul>",
"refs": {
"Expression$Not": "<p>Return results that don't match <code>Dimension</code>.</p>",
"Expressions$member": null,
"GetCostAndUsageRequest$Filter": "<p>Filters AWS costs by different dimensions. For example, you can specify <code>Service</code> and <code>Linked Account</code> and get the costs associated with that account's usage of that service. You can nest <code>Expression</code> objects to define any combination of dimension filters. For more information, see the <code>Expression</code> object or <code>More Examples</code>. </p>",
"GetReservationUtilizationRequest$Filter": "<p>Filters utilization data by using different dimensions. <code>GetReservationUtilization</code> uses the same <code>Expression</code> object as the other operations, but only <code>AND</code> is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.</p>"
}
},
"Expressions": {
"base": null,
"refs": {
"Expression$Or": "<p>Return results that match either <code>Dimension</code>.</p>",
"Expression$And": "<p>Return results that match both <code>Dimension</code> objects.</p>"
}
},
"GetCostAndUsageRequest": {
"base": null,
"refs": {
}
},
"GetCostAndUsageResponse": {
"base": null,
"refs": {
}
},
"GetDimensionValuesRequest": {
"base": null,
"refs": {
}
},
"GetDimensionValuesResponse": {
"base": null,
"refs": {
}
},
"GetReservationUtilizationRequest": {
"base": null,
"refs": {
}
},
"GetReservationUtilizationResponse": {
"base": null,
"refs": {
}
},
"GetTagsRequest": {
"base": null,
"refs": {
}
},
"GetTagsResponse": {
"base": null,
"refs": {
}
},
"Granularity": {
"base": null,
"refs": {
"GetCostAndUsageRequest$Granularity": "<p>Sets the AWS cost granularity to <code>MONTHLY</code> or <code>DAILY</code>.</p>",
"GetReservationUtilizationRequest$Granularity": "<p>Sets the AWS cost granularity to <code>MONTHLY</code> or <code>DAILY</code>. If both <code>GroupBy</code> and <code>granularity</code> are not set, <code>GetReservationUtilization</code> defaults to <code>DAILY</code>. If <code>GroupBy</code> is set, <code>Granularity</code> can't be set, and the response object doesn't include <code>MONTHLY</code> or <code>DAILY</code> granularity.</p>"
}
},
"Group": {
"base": "<p>One level of grouped data within the results.</p>",
"refs": {
"Groups$member": null
}
},
"GroupDefinition": {
"base": "<p>Represents a group when you specify a group by criteria, or in the response to a query with a specific grouping.</p>",
"refs": {
"GroupDefinitions$member": null
}
},
"GroupDefinitionKey": {
"base": null,
"refs": {
"GroupDefinition$Key": "<p>The string that represents a key for a specified group.</p>"
}
},
"GroupDefinitionType": {
"base": null,
"refs": {
"GroupDefinition$Type": "<p>The string that represents the type of group.</p>"
}
},
"GroupDefinitions": {
"base": null,
"refs": {
"GetCostAndUsageRequest$GroupBy": "<p>You can group AWS costs using up to two different groups, either dimensions, tag keys, or both.</p> <p>When you group by tag key, you get all tag values, including empty strings.</p> <p>Valid values are: <code>AZ</code>, <code>INSTANCE_TYPE</code>, <code>LINKED_ACCCOUNT</code>, <code>OPERATION</code>, <code>PURCHASE_TYPE</code>, <code>SERVICE</code>, <code>USAGE_TYPE</code>, <code>TAGS</code>, and <code>PLATFORM</code>.</p>",
"GetCostAndUsageResponse$GroupDefinitions": "<p>The groups specified by the the <code>Filter</code> or <code>GroupBy</code> parameters in the request.</p>",
"GetReservationUtilizationRequest$GroupBy": "<p>Groups only by <code>SubscriptionId</code>. Metadata is included.</p>"
}
},
"Groups": {
"base": null,
"refs": {
"ResultByTime$Groups": "<p>The groups that are included in this time period.</p>"
}
},
"Key": {
"base": null,
"refs": {
"Keys$member": null
}
},
"Keys": {
"base": null,
"refs": {
"Group$Keys": "<p>The keys included in this group.</p>"
}
},
"LimitExceededException": {
"base": "<p>You made too many calls in a short period of time. Try again later.</p>",
"refs": {
}
},
"MetricAmount": {
"base": null,
"refs": {
"MetricValue$Amount": "<p>The actual number that represents the metric.</p>"
}
},
"MetricName": {
"base": null,
"refs": {
"MetricNames$member": null,
"Metrics$key": null
}
},
"MetricNames": {
"base": null,
"refs": {
"GetCostAndUsageRequest$Metrics": "<p>Which metrics are returned in the query. For more information about blended and unblended rates, see https://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/. </p> <p>Valid values are <code>BlendedCost</code>, <code>UnblendedCost</code>, and <code>UsageQuantity</code>.</p> <note> <p>If you return the <code>UsageQuantity</code> metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate <code>usageQuantity</code> across all of EC2, the results aren't meaningful because EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful <code>UsageQuantity</code> metrics, filter by <code>UsageType</code> or <code>UsageTypeGroups</code>. </p> </note>"
}
},
"MetricUnit": {
"base": null,
"refs": {
"MetricValue$Unit": "<p>The unit that the metric is given in.</p>"
}
},
"MetricValue": {
"base": "<p>The aggregated value for a metric.</p>",
"refs": {
"Metrics$value": null
}
},
"Metrics": {
"base": null,
"refs": {
"Group$Metrics": "<p>The metrics included in this group.</p>",
"ResultByTime$Total": "<p>The total amount of cost or usage accrued during the time period.</p>"
}
},
"NextPageToken": {
"base": null,
"refs": {
"GetCostAndUsageRequest$NextPageToken": "<p>The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetCostAndUsageResponse$NextPageToken": "<p>The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetDimensionValuesRequest$NextPageToken": "<p>The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetDimensionValuesResponse$NextPageToken": "<p>The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetReservationUtilizationRequest$NextPageToken": "<p>The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetReservationUtilizationResponse$NextPageToken": "<p>The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetTagsRequest$NextPageToken": "<p>The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetTagsResponse$NextPageToken": "<p>The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>"
}
},
"PageSize": {
"base": null,
"refs": {
"GetDimensionValuesResponse$ReturnSize": "<p>The number of results that AWS returned at one time.</p>",
"GetDimensionValuesResponse$TotalSize": "<p>The total number of search results.</p>",
"GetTagsResponse$ReturnSize": "<p>The number of query results that AWS returns at a time.</p>",
"GetTagsResponse$TotalSize": "<p>The total number of query results.</p>"
}
},
"PurchasedHours": {
"base": null,
"refs": {
"ReservationAggregates$PurchasedHours": "<p>How many RI hours you purchased.</p>"
}
},
"ReservationAggregates": {
"base": "<p>The aggregated numbers for your RI usage.</p>",
"refs": {
"GetReservationUtilizationResponse$Total": "<p>The total amount of time that you utilized your RIs.</p>",
"ReservationUtilizationGroup$Utilization": "<p>How much you used this group of RIs.</p>",
"UtilizationByTime$Total": "<p>The total number of RI hours that were used.</p>"
}
},
"ReservationGroupKey": {
"base": null,
"refs": {
"ReservationUtilizationGroup$Key": "<p>The key for a specific RI attribute.</p>"
}
},
"ReservationGroupValue": {
"base": null,
"refs": {
"ReservationUtilizationGroup$Value": "<p>The value of a specific RI attribute.</p>"
}
},
"ReservationUtilizationGroup": {
"base": "<p>A group of RIs that share a set of attributes.</p>",
"refs": {
"ReservationUtilizationGroups$member": null
}
},
"ReservationUtilizationGroups": {
"base": null,
"refs": {
"UtilizationByTime$Groups": "<p>The groups that are included in this utilization result.</p>"
}
},
"ResultByTime": {
"base": "<p>The result that is associated with a time period.</p>",
"refs": {
"ResultsByTime$member": null
}
},
"ResultsByTime": {
"base": null,
"refs": {
"GetCostAndUsageResponse$ResultsByTime": "<p>The time period covered by the results in the response.</p>"
}
},
"SearchString": {
"base": null,
"refs": {
"GetDimensionValuesRequest$SearchString": "<p>The value that you want to search the filter values for.</p>",
"GetTagsRequest$SearchString": "<p>The value that you want to search for.</p>"
}
},
"TagKey": {
"base": null,
"refs": {
"GetTagsRequest$TagKey": "<p>The key of the tag that you want to return values for.</p>",
"TagValues$Key": "<p>The key for a tag.</p>"
}
},
"TagList": {
"base": null,
"refs": {
"GetTagsResponse$Tags": "<p>The tags that match your request.</p>"
}
},
"TagValues": {
"base": "<p>The values that are available for a tag.</p>",
"refs": {
"Expression$Tags": "<p>The specific <code>Tag</code> to use for <code>Expression</code>.</p>"
}
},
"TotalActualHours": {
"base": null,
"refs": {
"ReservationAggregates$TotalActualHours": "<p>The total number of RI hours that you used.</p>"
}
},
"UnusedHours": {
"base": null,
"refs": {
"ReservationAggregates$UnusedHours": "<p>The number of RI hours that you didn't use.</p>"
}
},
"UtilizationByTime": {
"base": "<p>The amount of utilization, in hours.</p>",
"refs": {
"UtilizationsByTime$member": null
}
},
"UtilizationPercentage": {
"base": null,
"refs": {
"ReservationAggregates$UtilizationPercentage": "<p>The percentage of RI time that you used.</p>"
}
},
"UtilizationsByTime": {
"base": null,
"refs": {
"GetReservationUtilizationResponse$UtilizationsByTime": "<p>The amount of time that you utilized your RIs.</p>"
}
},
"Value": {
"base": null,
"refs": {
"DimensionValuesWithAttributes$Value": "<p>The value of a dimension with a specific attribute.</p>",
"Values$member": null
}
},
"Values": {
"base": null,
"refs": {
"DimensionValues$Values": "<p>The metadata values that you can use to filter and group your results. You can use <code>GetDimensionValues</code> to find specific values.</p>",
"TagValues$Values": "<p>The specific value of a tag.</p>"
}
},
"YearMonthDay": {
"base": null,
"refs": {
"DateInterval$Start": "<p>The beginning of the time period that you want the usage and costs for. The start date is inclusive. For example, if <code>start</code> is <code>2017-01-01</code>, then the cost and usage data is retrieved starting at <code>2017-01-01</code> up to the end date.</p>",
"DateInterval$End": "<p>The end of the time period that you want the usage and costs for. The end date is exclusive. For example, if the <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from the start date but not including <code>2017-05-01</code>.</p>"
}
}
}
}

View File

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View File

@ -0,0 +1,4 @@
{
"pagination": {
}
}

View File

@ -541,6 +541,25 @@
{"shape":"InvalidArnException"}
]
},
"GetAppliedSchemaVersion":{
"name":"GetAppliedSchemaVersion",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/schema/getappliedschema",
"responseCode":200
},
"input":{"shape":"GetAppliedSchemaVersionRequest"},
"output":{"shape":"GetAppliedSchemaVersionResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"}
]
},
"GetDirectory":{
"name":"GetDirectory",
"http":{
@ -1247,6 +1266,47 @@
{"shape":"FacetNotFoundException"},
{"shape":"InvalidRuleException"}
]
},
"UpgradeAppliedSchema":{
"name":"UpgradeAppliedSchema",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/schema/upgradeapplied",
"responseCode":200
},
"input":{"shape":"UpgradeAppliedSchemaRequest"},
"output":{"shape":"UpgradeAppliedSchemaResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"IncompatibleSchemaException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidAttachmentException"}
]
},
"UpgradePublishedSchema":{
"name":"UpgradePublishedSchema",
"http":{
"method":"PUT",
"requestUri":"/amazonclouddirectory/2017-01-11/schema/upgradepublished",
"responseCode":200
},
"input":{"shape":"UpgradePublishedSchemaRequest"},
"output":{"shape":"UpgradePublishedSchemaResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"IncompatibleSchemaException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidAttachmentException"},
{"shape":"LimitExceededException"}
]
}
},
"shapes":{
@ -2617,6 +2677,19 @@
"error":{"httpStatusCode":400},
"exception":true
},
"GetAppliedSchemaVersionRequest":{
"type":"structure",
"required":["SchemaArn"],
"members":{
"SchemaArn":{"shape":"Arn"}
}
},
"GetAppliedSchemaVersionResponse":{
"type":"structure",
"members":{
"AppliedSchemaArn":{"shape":"Arn"}
}
},
"GetDirectoryRequest":{
"type":"structure",
"required":["DirectoryArn"],
@ -2722,6 +2795,14 @@
"IdentityAttributeOrder":{"shape":"AttributeNameList"}
}
},
"IncompatibleSchemaException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"error":{"httpStatusCode":400},
"exception":true
},
"IndexAttachment":{
"type":"structure",
"members":{
@ -2837,6 +2918,7 @@
"required":["DirectoryArn"],
"members":{
"DirectoryArn":{"shape":"Arn"},
"SchemaArn":{"shape":"Arn"},
"NextToken":{"shape":"NextToken"},
"MaxResults":{"shape":"NumberResults"}
}
@ -3208,6 +3290,7 @@
"ListPublishedSchemaArnsRequest":{
"type":"structure",
"members":{
"SchemaArn":{"shape":"Arn"},
"NextToken":{"shape":"NextToken"},
"MaxResults":{"shape":"NumberResults"}
}
@ -3452,6 +3535,7 @@
"locationName":"x-amz-data-partition"
},
"Version":{"shape":"Version"},
"MinorVersion":{"shape":"Version"},
"Name":{"shape":"SchemaName"}
}
},
@ -3894,6 +3978,45 @@
"members":{
}
},
"UpgradeAppliedSchemaRequest":{
"type":"structure",
"required":[
"PublishedSchemaArn",
"DirectoryArn"
],
"members":{
"PublishedSchemaArn":{"shape":"Arn"},
"DirectoryArn":{"shape":"Arn"},
"DryRun":{"shape":"Bool"}
}
},
"UpgradeAppliedSchemaResponse":{
"type":"structure",
"members":{
"UpgradedSchemaArn":{"shape":"Arn"},
"DirectoryArn":{"shape":"Arn"}
}
},
"UpgradePublishedSchemaRequest":{
"type":"structure",
"required":[
"DevelopmentSchemaArn",
"PublishedSchemaArn",
"MinorVersion"
],
"members":{
"DevelopmentSchemaArn":{"shape":"Arn"},
"PublishedSchemaArn":{"shape":"Arn"},
"MinorVersion":{"shape":"Version"},
"DryRun":{"shape":"Bool"}
}
},
"UpgradePublishedSchemaResponse":{
"type":"structure",
"members":{
"UpgradedSchemaArn":{"shape":"Arn"}
}
},
"ValidationException":{
"type":"structure",
"members":{

View File

@ -3,13 +3,13 @@
"service": "<fullname>Amazon Cloud Directory</fullname> <p>Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the development and management of cloud-scale web, mobile, and IoT applications. This guide describes the Cloud Directory operations that you can call programmatically and includes detailed information on data types and errors. For information about AWS Directory Services features, see <a href=\"https://aws.amazon.com/directoryservice/\">AWS Directory Service</a> and the <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/what_is.html\">AWS Directory Service Administration Guide</a>.</p>",
"operations": {
"AddFacetToObject": "<p>Adds a new <a>Facet</a> to an object.</p>",
"ApplySchema": "<p>Copies the input published schema into the <a>Directory</a> with the same name and version as that of the published schema .</p>",
"ApplySchema": "<p>Copies the input published schema, at the specified version, into the <a>Directory</a> with the same name and version as that of the published schema.</p>",
"AttachObject": "<p>Attaches an existing object to another object. An object can be accessed in two ways:</p> <ol> <li> <p>Using the path</p> </li> <li> <p>Using <code>ObjectIdentifier</code> </p> </li> </ol>",
"AttachPolicy": "<p>Attaches a policy object to a regular object. An object can have a limited number of attached policies.</p>",
"AttachToIndex": "<p>Attaches the specified object to the specified index.</p>",
"AttachTypedLink": "<p>Attaches a typed link to a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
"BatchRead": "<p>Performs all the read operations in a batch. </p>",
"BatchWrite": "<p>Performs all the write operations in a batch. Either all the operations succeed or none. Batch writes supports only object-related operations.</p>",
"BatchWrite": "<p>Performs all the write operations in a batch. Either all the operations succeed or none.</p>",
"CreateDirectory": "<p>Creates a <a>Directory</a> by copying the published schema into the directory. A directory cannot be created without a schema.</p>",
"CreateFacet": "<p>Creates a new <a>Facet</a> in a schema. Facet creation is allowed only in development or applied schemas.</p>",
"CreateIndex": "<p>Creates an index object. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_indexing.html\">Indexing</a> for more information.</p>",
@ -27,19 +27,20 @@
"DetachTypedLink": "<p>Detaches a typed link from a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
"DisableDirectory": "<p>Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.</p>",
"EnableDirectory": "<p>Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.</p>",
"GetAppliedSchemaVersion": "<p>Returns current applied schema version ARN, including the minor version in use.</p>",
"GetDirectory": "<p>Retrieves metadata about a directory.</p>",
"GetFacet": "<p>Gets details of the <a>Facet</a>, such as facet name, attributes, <a>Rule</a>s, or <code>ObjectType</code>. You can call this on all kinds of schema facets -- published, development, or applied.</p>",
"GetObjectInformation": "<p>Retrieves metadata about an object.</p>",
"GetSchemaAsJson": "<p>Retrieves a JSON representation of the schema. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_schemas.html#jsonformat\">JSON Schema Format</a> for more information.</p>",
"GetTypedLinkFacetInformation": "<p>Returns the identity attribute order for a specific <a>TypedLinkFacet</a>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
"ListAppliedSchemaArns": "<p>Lists schemas applied to a directory.</p>",
"ListAttachedIndices": "<p>Lists indices attached to an object.</p>",
"ListAppliedSchemaArns": "<p>Lists schema major versions applied to a directory. If <code>SchemaArn</code> is provided, lists the minor version.</p>",
"ListAttachedIndices": "<p>Lists indices attached to the specified object.</p>",
"ListDevelopmentSchemaArns": "<p>Retrieves each Amazon Resource Name (ARN) of schemas in the development state.</p>",
"ListDirectories": "<p>Lists directories created within an account.</p>",
"ListFacetAttributes": "<p>Retrieves attributes attached to the facet.</p>",
"ListFacetNames": "<p>Retrieves the names of facets that exist in a schema.</p>",
"ListIncomingTypedLinks": "<p>Returns a paginated list of all the incoming <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
"ListIndex": "<p>Lists objects attached to the specified index.</p>",
"ListIndex": "<p>Lists objects and indexed values attached to the index.</p>",
"ListObjectAttributes": "<p>Lists all attributes that are associated with an object. </p>",
"ListObjectChildren": "<p>Returns a paginated list of child objects that are associated with a given object.</p>",
"ListObjectParentPaths": "<p>Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#dirstructure\">Directory Structure</a>.</p> <p>Use this API to evaluate all parents for an object. The call returns all objects from the root of the directory up to the requested object. The API returns the number of paths based on user-defined <code>MaxResults</code>, in case there are multiple paths to the parent. The order of the paths and nodes returned is consistent among multiple API calls unless the objects are deleted or moved. Paths not leading to the directory root are ignored from the target object.</p>",
@ -47,12 +48,12 @@
"ListObjectPolicies": "<p>Returns policies attached to an object in pagination fashion.</p>",
"ListOutgoingTypedLinks": "<p>Returns a paginated list of all the outgoing <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
"ListPolicyAttachments": "<p>Returns all of the <code>ObjectIdentifiers</code> to which a given policy is attached.</p>",
"ListPublishedSchemaArns": "<p>Retrieves each published schema Amazon Resource Name (ARN).</p>",
"ListPublishedSchemaArns": "<p>Lists schema major versions for a published schema. If <code>SchemaArn</code> is provided, lists the minor version.</p>",
"ListTagsForResource": "<p>Returns tags for a resource. Tagging is currently supported only for directories with a limit of 50 tags per directory. All 50 tags are returned for a given directory with this API call.</p>",
"ListTypedLinkFacetAttributes": "<p>Returns a paginated list of all attribute definitions for a particular <a>TypedLinkFacet</a>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
"ListTypedLinkFacetNames": "<p>Returns a paginated list of <code>TypedLink</code> facet names for a particular schema. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
"LookupPolicy": "<p>Lists all policies from the root of the <a>Directory</a> to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the <code>ObjectIdentifier</code> for such objects. If policies are present, it returns <code>ObjectIdentifier</code>, <code>policyId</code>, and <code>policyType</code>. Paths that don't lead to the root from the target object are ignored. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p>",
"PublishSchema": "<p>Publishes a development schema with a version. If description and attributes are specified, <code>PublishSchema</code> overrides the development schema description and attributes. If not, the development schema description and attributes are used.</p>",
"PublishSchema": "<p>Publishes a development schema with a major version and a recommended minor version.</p>",
"PutSchemaFromJson": "<p>Allows a schema to be updated using JSON upload. Only available for development schemas. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_schemas.html#jsonformat\">JSON Schema Format</a> for more information.</p>",
"RemoveFacetFromObject": "<p>Removes the specified facet from the specified object.</p>",
"TagResource": "<p>An API operation for adding tags to a resource.</p>",
@ -60,7 +61,9 @@
"UpdateFacet": "<p>Does the following:</p> <ol> <li> <p>Adds new <code>Attributes</code>, <code>Rules</code>, or <code>ObjectTypes</code>.</p> </li> <li> <p>Updates existing <code>Attributes</code>, <code>Rules</code>, or <code>ObjectTypes</code>.</p> </li> <li> <p>Deletes existing <code>Attributes</code>, <code>Rules</code>, or <code>ObjectTypes</code>.</p> </li> </ol>",
"UpdateObjectAttributes": "<p>Updates a given object's attributes.</p>",
"UpdateSchema": "<p>Updates the schema name with a new name. Only development schema names can be updated.</p>",
"UpdateTypedLinkFacet": "<p>Updates a <a>TypedLinkFacet</a>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
"UpdateTypedLinkFacet": "<p>Updates a <a>TypedLinkFacet</a>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
"UpgradeAppliedSchema": "<p>Upgrades a single directory in-place using the <code>PublishedSchemaArn</code> with schema updates found in <code>MinorVersion</code>. Backwards-compatible minor version upgrades are instantaneously available for readers on all objects in the directory. Note: This is a synchronous API call and upgrades only one schema on a given directory per call. To upgrade multiple directories from one schema, you would need to call this API on each directory.</p>",
"UpgradePublishedSchema": "<p>Upgrades a published schema under a new minor version revision using the current contents of <code>DevelopmentSchemaArn</code>.</p>"
},
"shapes": {
"AccessDeniedException": {
@ -126,11 +129,14 @@
"DisableDirectoryResponse$DirectoryArn": "<p>The ARN of the directory that has been disabled.</p>",
"EnableDirectoryRequest$DirectoryArn": "<p>The ARN of the directory to enable.</p>",
"EnableDirectoryResponse$DirectoryArn": "<p>The ARN of the enabled directory.</p>",
"GetAppliedSchemaVersionRequest$SchemaArn": "<p>The ARN of the applied schema.</p>",
"GetAppliedSchemaVersionResponse$AppliedSchemaArn": "<p>Current applied schema ARN, including the minor version in use if one was provided.</p>",
"GetFacetRequest$SchemaArn": "<p>The Amazon Resource Name (ARN) that is associated with the <a>Facet</a>. For more information, see <a>arns</a>.</p>",
"GetObjectInformationRequest$DirectoryArn": "<p>The ARN of the directory being retrieved.</p>",
"GetSchemaAsJsonRequest$SchemaArn": "<p>The ARN of the schema to retrieve.</p>",
"GetTypedLinkFacetInformationRequest$SchemaArn": "<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>",
"ListAppliedSchemaArnsRequest$DirectoryArn": "<p>The ARN of the directory you are listing.</p>",
"ListAppliedSchemaArnsRequest$SchemaArn": "<p>The response for <code>ListAppliedSchemaArns</code> when this parameter is used will list all minor version ARNs for a major version.</p>",
"ListAttachedIndicesRequest$DirectoryArn": "<p>The ARN of the directory.</p>",
"ListFacetAttributesRequest$SchemaArn": "<p>The ARN of the schema where the facet resides.</p>",
"ListFacetNamesRequest$SchemaArn": "<p>The Amazon Resource Name (ARN) to retrieve facet names from.</p>",
@ -143,6 +149,7 @@
"ListObjectPoliciesRequest$DirectoryArn": "<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where objects reside. For more information, see <a>arns</a>.</p>",
"ListOutgoingTypedLinksRequest$DirectoryArn": "<p>The Amazon Resource Name (ARN) of the directory where you want to list the typed links.</p>",
"ListPolicyAttachmentsRequest$DirectoryArn": "<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where objects reside. For more information, see <a>arns</a>.</p>",
"ListPublishedSchemaArnsRequest$SchemaArn": "<p>The response for <code>ListPublishedSchemaArns</code> when this parameter is used will list all minor version ARNs for a major version.</p>",
"ListTagsForResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.</p>",
"ListTypedLinkFacetAttributesRequest$SchemaArn": "<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>",
"ListTypedLinkFacetNamesRequest$SchemaArn": "<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>",
@ -152,7 +159,7 @@
"PutSchemaFromJsonRequest$SchemaArn": "<p>The ARN of the schema to update.</p>",
"PutSchemaFromJsonResponse$Arn": "<p>The ARN of the schema to update.</p>",
"RemoveFacetFromObjectRequest$DirectoryArn": "<p>The ARN of the directory in which the object resides.</p>",
"SchemaFacet$SchemaArn": "<p>The ARN of the schema that contains the facet.</p>",
"SchemaFacet$SchemaArn": "<p>The ARN of the schema that contains the facet with no minor component. See <a>arns</a> and <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/inplaceschemaupgrade.html\">In-Place Schema Upgrade</a> for a description of when to provide minor versions.</p>",
"TagResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.</p>",
"TypedLinkSchemaAndFacetName$SchemaArn": "<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>",
"UntagResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.</p>",
@ -160,7 +167,14 @@
"UpdateObjectAttributesRequest$DirectoryArn": "<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
"UpdateSchemaRequest$SchemaArn": "<p>The Amazon Resource Name (ARN) of the development schema. For more information, see <a>arns</a>.</p>",
"UpdateSchemaResponse$SchemaArn": "<p>The ARN that is associated with the updated schema. For more information, see <a>arns</a>.</p>",
"UpdateTypedLinkFacetRequest$SchemaArn": "<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>"
"UpdateTypedLinkFacetRequest$SchemaArn": "<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>",
"UpgradeAppliedSchemaRequest$PublishedSchemaArn": "<p>The revision of the published schema to upgrade the directory to.</p>",
"UpgradeAppliedSchemaRequest$DirectoryArn": "<p>The ARN for the directory to which the upgraded schema will be applied.</p>",
"UpgradeAppliedSchemaResponse$UpgradedSchemaArn": "<p>The ARN of the upgraded schema that is returned as part of the response.</p>",
"UpgradeAppliedSchemaResponse$DirectoryArn": "<p>The ARN of the directory that is returned as part of the response.</p>",
"UpgradePublishedSchemaRequest$DevelopmentSchemaArn": "<p>The ARN of the development schema with the changes used for the upgrade.</p>",
"UpgradePublishedSchemaRequest$PublishedSchemaArn": "<p>The ARN of the published schema to be upgraded.</p>",
"UpgradePublishedSchemaResponse$UpgradedSchemaArn": "<p>The ARN of the upgraded schema that is returned as part of the response.</p>"
}
},
"Arns": {
@ -400,7 +414,7 @@
}
},
"BatchDetachPolicy": {
"base": "<p>Detaches the specified policy from the specified directory inside a <a>BatchRead</a> operation. For more information, see <a>DetachPolicy</a> and <a>BatchReadRequest$Operations</a>.</p>",
"base": "<p>Detaches the specified policy from the specified directory inside a <a>BatchWrite</a> operation. For more information, see <a>DetachPolicy</a> and <a>BatchWriteRequest$Operations</a>.</p>",
"refs": {
"BatchWriteOperation$DetachPolicy": "<p>Detaches a policy from a <a>Directory</a>.</p>"
}
@ -702,7 +716,9 @@
"BatchCreateIndex$IsUnique": "<p>Indicates whether the attribute that is being indexed has unique values or not.</p>",
"CreateIndexRequest$IsUnique": "<p>Indicates whether the attribute that is being indexed has unique values or not.</p>",
"FacetAttributeDefinition$IsImmutable": "<p>Whether the attribute is mutable or not.</p>",
"TypedLinkAttributeDefinition$IsImmutable": "<p>Whether the attribute is mutable or not.</p>"
"TypedLinkAttributeDefinition$IsImmutable": "<p>Whether the attribute is mutable or not.</p>",
"UpgradeAppliedSchemaRequest$DryRun": "<p>Used for testing whether the major version schemas are backward compatible or not. If schema compatibility fails, an exception would be thrown else the call would succeed but no changes will be saved. This parameter is optional.</p>",
"UpgradePublishedSchemaRequest$DryRun": "<p>Used for testing whether the Development schema provided is backwards compatible, or not, with the publish schema provided by the user to be upgraded. If schema compatibility fails, an exception would be thrown else the call would succeed. This parameter is optional and defaults to false.</p>"
}
},
"BooleanAttributeValue": {
@ -980,6 +996,7 @@
"FacetInUseException$Message": null,
"FacetNotFoundException$Message": null,
"FacetValidationException$Message": null,
"IncompatibleSchemaException$Message": null,
"IndexedAttributeMissingException$Message": null,
"InternalServiceException$Message": null,
"InvalidArnException$Message": null,
@ -1097,6 +1114,16 @@
"refs": {
}
},
"GetAppliedSchemaVersionRequest": {
"base": null,
"refs": {
}
},
"GetAppliedSchemaVersionResponse": {
"base": null,
"refs": {
}
},
"GetDirectoryRequest": {
"base": null,
"refs": {
@ -1147,6 +1174,11 @@
"refs": {
}
},
"IncompatibleSchemaException": {
"base": "<p>Indicates a failure occurred while performing a check for backward compatibility between the specified schema and the schema that is currently applied to the directory.</p>",
"refs": {
}
},
"IndexAttachment": {
"base": "<p>Represents an index and an attached object.</p>",
"refs": {
@ -1545,7 +1577,7 @@
"ListFacetAttributesRequest$MaxResults": "<p>The maximum number of results to retrieve.</p>",
"ListFacetNamesRequest$MaxResults": "<p>The maximum number of results to retrieve.</p>",
"ListIncomingTypedLinksRequest$MaxResults": "<p>The maximum number of results to retrieve.</p>",
"ListIndexRequest$MaxResults": "<p>The maximum number of results to retrieve from the index.</p>",
"ListIndexRequest$MaxResults": "<p>The maximum number of objects in a single page to retrieve from the index during a request. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html#limits_cd\">AWS Directory Service Limits</a>.</p>",
"ListObjectAttributesRequest$MaxResults": "<p>The maximum number of items to be retrieved in a single call. This is an approximate number.</p>",
"ListObjectChildrenRequest$MaxResults": "<p>The maximum number of items to be retrieved in a single call. This is an approximate number.</p>",
"ListObjectParentPathsRequest$MaxResults": "<p>The maximum number of items to be retrieved in a single call. This is an approximate number.</p>",
@ -1615,7 +1647,7 @@
"DetachFromIndexResponse$DetachedObjectIdentifier": "<p>The <code>ObjectIdentifier</code> of the object that was detached from the index.</p>",
"DetachObjectResponse$DetachedObjectIdentifier": "<p>The <code>ObjectIdentifier</code> that was detached from the object.</p>",
"GetObjectInformationResponse$ObjectIdentifier": "<p>The <code>ObjectIdentifier</code> of the specified object.</p>",
"IndexAttachment$ObjectIdentifier": "<p>The <code>ObjectIdentifier</code> of the object attached to the index.</p>",
"IndexAttachment$ObjectIdentifier": "<p>In response to <a>ListIndex</a>, the <code>ObjectIdentifier</code> of the object attached to the index. In response to <a>ListAttachedIndices</a>, the <code>ObjectIdentifier</code> of the index attached to the object. This field will always contain the <code>ObjectIdentifier</code> of the object on the opposite side of the attachment specified in the query.</p>",
"LinkNameToObjectIdentifierMap$value": null,
"ObjectIdentifierList$member": null,
"ObjectIdentifierToLinkNameMap$key": null,
@ -1882,12 +1914,12 @@
"SchemaFacet": {
"base": "<p>A facet.</p>",
"refs": {
"AddFacetToObjectRequest$SchemaFacet": "<p>Identifiers for the facet that you are adding to the object.</p>",
"AddFacetToObjectRequest$SchemaFacet": "<p>Identifiers for the facet that you are adding to the object. See <a>SchemaFacet</a> for details.</p>",
"BatchAddFacetToObject$SchemaFacet": "<p>Represents the facet being added to the object.</p>",
"BatchListObjectAttributes$FacetFilter": "<p>Used to filter the list of object attributes that are associated with a certain facet.</p>",
"BatchRemoveFacetFromObject$SchemaFacet": "<p>The facet to remove from the object.</p>",
"ListObjectAttributesRequest$FacetFilter": "<p>Used to filter the list of object attributes that are associated with a certain facet.</p>",
"RemoveFacetFromObjectRequest$SchemaFacet": "<p>The facet to remove.</p>",
"RemoveFacetFromObjectRequest$SchemaFacet": "<p>The facet to remove. See <a>SchemaFacet</a> for details.</p>",
"SchemaFacetList$member": null
}
},
@ -1896,8 +1928,8 @@
"refs": {
"BatchCreateObject$SchemaFacet": "<p>A list of <code>FacetArns</code> that will be associated with the object. For more information, see <a>arns</a>.</p>",
"BatchGetObjectInformationResponse$SchemaFacets": "<p>The facets attached to the specified object.</p>",
"CreateObjectRequest$SchemaFacets": "<p>A list of schema facets to be associated with the object that contains <code>SchemaArn</code> and facet name. For more information, see <a>arns</a>.</p>",
"GetObjectInformationResponse$SchemaFacets": "<p>The facets attached to the specified object.</p>"
"CreateObjectRequest$SchemaFacets": "<p>A list of schema facets to be associated with the object. Do not provide minor version components. See <a>SchemaFacet</a> for details.</p>",
"GetObjectInformationResponse$SchemaFacets": "<p>The facets attached to the specified object. Although the response does not include minor version information, the most recently applied minor version of each Facet is in effect. See <a>GetAppliedSchemaVersion</a> for details.</p>"
}
},
"SchemaJsonDocument": {
@ -2159,6 +2191,26 @@
"refs": {
}
},
"UpgradeAppliedSchemaRequest": {
"base": null,
"refs": {
}
},
"UpgradeAppliedSchemaResponse": {
"base": null,
"refs": {
}
},
"UpgradePublishedSchemaRequest": {
"base": null,
"refs": {
}
},
"UpgradePublishedSchemaResponse": {
"base": null,
"refs": {
}
},
"ValidationException": {
"base": "<p>Indicates that your request is malformed in some manner. See the exception message.</p>",
"refs": {
@ -2167,7 +2219,9 @@
"Version": {
"base": null,
"refs": {
"PublishSchemaRequest$Version": "<p>The version under which the schema will be published.</p>"
"PublishSchemaRequest$Version": "<p>The major version under which the schema will be published. Schemas have both a major and minor version associated with them.</p>",
"PublishSchemaRequest$MinorVersion": "<p>The minor version under which the schema will be published. This parameter is recommended. Schemas have both a major and minor version associated with them.</p>",
"UpgradePublishedSchemaRequest$MinorVersion": "<p>Identifies the minor version of the published schema that will be created. This parameter is NOT optional.</p>"
}
}
}

View File

@ -5,6 +5,7 @@
"endpointPrefix":"cloudformation",
"protocol":"query",
"serviceFullName":"AWS CloudFormation",
"serviceId":"CloudFormation",
"signatureVersion":"v4",
"uid":"cloudformation-2010-05-15",
"xmlNamespace":"http://cloudformation.amazonaws.com/doc/2010-05-15/"
@ -530,6 +531,26 @@
{"shape":"TokenAlreadyExistsException"}
]
},
"UpdateStackInstances":{
"name":"UpdateStackInstances",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateStackInstancesInput"},
"output":{
"shape":"UpdateStackInstancesOutput",
"resultWrapper":"UpdateStackInstancesResult"
},
"errors":[
{"shape":"StackSetNotFoundException"},
{"shape":"StackInstanceNotFoundException"},
{"shape":"OperationInProgressException"},
{"shape":"OperationIdAlreadyExistsException"},
{"shape":"StaleRequestException"},
{"shape":"InvalidOperationException"}
]
},
"UpdateStackSet":{
"name":"UpdateStackSet",
"http":{
@ -836,6 +857,7 @@
"StackSetName":{"shape":"StackSetName"},
"Accounts":{"shape":"AccountList"},
"Regions":{"shape":"RegionList"},
"ParameterOverrides":{"shape":"Parameters"},
"OperationPreferences":{"shape":"StackSetOperationPreferences"},
"OperationId":{
"shape":"ClientRequestToken",
@ -1527,7 +1549,8 @@
"members":{
"ParameterKey":{"shape":"ParameterKey"},
"ParameterValue":{"shape":"ParameterValue"},
"UsePreviousValue":{"shape":"UsePreviousValue"}
"UsePreviousValue":{"shape":"UsePreviousValue"},
"ResolvedValue":{"shape":"ParameterValue"}
}
},
"ParameterConstraints":{
@ -1799,6 +1822,7 @@
"Region":{"shape":"Region"},
"Account":{"shape":"Account"},
"StackId":{"shape":"StackId"},
"ParameterOverrides":{"shape":"Parameters"},
"Status":{"shape":"StackInstanceStatus"},
"StatusReason":{"shape":"Reason"}
}
@ -1946,8 +1970,7 @@
"StackSetName":{"type":"string"},
"StackSetNameOrId":{
"type":"string",
"min":1,
"pattern":"[a-zA-Z][-a-zA-Z0-9]*"
"pattern":"[a-zA-Z][-a-zA-Z0-9]*(?::[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12})?"
},
"StackSetNotEmptyException":{
"type":"structure",
@ -2256,6 +2279,31 @@
"ClientRequestToken":{"shape":"ClientRequestToken"}
}
},
"UpdateStackInstancesInput":{
"type":"structure",
"required":[
"StackSetName",
"Accounts",
"Regions"
],
"members":{
"StackSetName":{"shape":"StackSetName"},
"Accounts":{"shape":"AccountList"},
"Regions":{"shape":"RegionList"},
"ParameterOverrides":{"shape":"Parameters"},
"OperationPreferences":{"shape":"StackSetOperationPreferences"},
"OperationId":{
"shape":"ClientRequestToken",
"idempotencyToken":true
}
}
},
"UpdateStackInstancesOutput":{
"type":"structure",
"members":{
"OperationId":{"shape":"ClientRequestToken"}
}
},
"UpdateStackOutput":{
"type":"structure",
"members":{

View File

@ -39,6 +39,7 @@
"SignalResource": "<p>Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.</p>",
"StopStackSetOperation": "<p>Stops an in-progress operation on a stack set and its associated stack instances. </p>",
"UpdateStack": "<p>Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the <a>DescribeStacks</a> action.</p> <p>To get a copy of the template for an existing stack, you can use the <a>GetTemplate</a> action.</p> <p>For more information about creating an update template, updating a stack, and monitoring the progress of the update, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html\">Updating a Stack</a>.</p>",
"UpdateStackInstances": "<p>Updates the parameter values for stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region. </p> <p>You can only update stack instances in regions and accounts where they already exist; to create additional stack instances, use <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStackInstances.html\">CreateStackInstances</a>. </p> <p>During stack set updates, any parameters overridden for a stack instance are not updated, but retain their overridden value.</p> <p>You can only update the parameter <i>values</i> that are specified in the stack set; to add or delete a parameter itself, use <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html\">UpdateStackSet</a> to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html\">UpdateStackSet</a> to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using <code>UpdateStackInstances</code>.</p>",
"UpdateStackSet": "<p>Updates the stack set and <i>all</i> associated stack instances.</p> <p>Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent <a>CreateStackInstances</a> calls on the specified stack set use the updated stack set.</p>",
"UpdateTerminationProtection": "<p>Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html\">Protecting a Stack From Being Deleted</a> in the <i>AWS CloudFormation User Guide</i>.</p> <p> For <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html\">nested stacks</a>, termination protection is set on the root stack and cannot be changed directly on the nested stack.</p>",
"ValidateTemplate": "<p>Validates a specified template. AWS CloudFormation first checks if the template is valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. If both these checks fail, AWS CloudFormation returns a template validation error.</p>"
@ -89,7 +90,8 @@
"base": null,
"refs": {
"CreateStackInstancesInput$Accounts": "<p>The names of one or more AWS accounts that you want to create stack instances in the specified region(s) for.</p>",
"DeleteStackInstancesInput$Accounts": "<p>The names of the AWS accounts that you want to delete stack instances for.</p>"
"DeleteStackInstancesInput$Accounts": "<p>The names of the AWS accounts that you want to delete stack instances for.</p>",
"UpdateStackInstancesInput$Accounts": "<p>The names of one or more AWS accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions.</p>"
}
},
"AllowedValue": {
@ -267,6 +269,8 @@
"StackSetOperationSummary$OperationId": "<p>The unique ID of the stack set operation.</p>",
"StopStackSetOperationInput$OperationId": "<p>The ID of the stack operation. </p>",
"UpdateStackInput$ClientRequestToken": "<p>A unique identifier for this <code>UpdateStack</code> request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to update a stack with the same name. You might retry <code>UpdateStack</code> requests to ensure that AWS CloudFormation successfully received them.</p> <p>All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a <code>CreateStack</code> operation with the token <code>token1</code>, then all the <code>StackEvents</code> generated by that operation will have <code>ClientRequestToken</code> set as <code>token1</code>.</p> <p>In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format <i>Console-StackOperation-ID</i>, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>. </p>",
"UpdateStackInstancesInput$OperationId": "<p>The unique identifier for this stack set operation. </p> <p>The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them.</p> <p>If you don't specify an operation ID, the SDK generates one automatically. </p>",
"UpdateStackInstancesOutput$OperationId": "<p>The unique identifier for this stack set operation. </p>",
"UpdateStackSetInput$OperationId": "<p>The unique ID for this stack set operation. </p> <p>The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them.</p> <p>If you don't specify an operation ID, AWS CloudFormation generates one automatically.</p> <p>Repeating this stack set operation with a new operation ID retries all stack instances whose status is <code>OUTDATED</code>. </p>",
"UpdateStackSetOutput$OperationId": "<p>The unique ID for this stack set operation.</p>"
}
@ -943,7 +947,8 @@
"ParameterValue": {
"base": null,
"refs": {
"Parameter$ParameterValue": "<p>The value associated with the parameter.</p>",
"Parameter$ParameterValue": "<p>The input value associated with the parameter.</p>",
"Parameter$ResolvedValue": "<p>Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types\"> <code>SSM</code> parameter types</a> in the template.</p>",
"ParameterDeclaration$DefaultValue": "<p>The default value of the parameter.</p>",
"TemplateParameter$DefaultValue": "<p>The default value associated with the parameter.</p>"
}
@ -953,12 +958,15 @@
"refs": {
"CreateChangeSetInput$Parameters": "<p>A list of <code>Parameter</code> structures that specify input parameters for the change set. For more information, see the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html\">Parameter</a> data type.</p>",
"CreateStackInput$Parameters": "<p>A list of <code>Parameter</code> structures that specify input parameters for the stack. For more information, see the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html\">Parameter</a> data type.</p>",
"CreateStackInstancesInput$ParameterOverrides": "<p>A list of stack set parameters whose values you want to override in the selected stack instances.</p> <p>Any overridden parameter values will be applied to all stack instances in the specified accounts and regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance operations:</p> <ul> <li> <p>To override the current value for a parameter, include the parameter and specify its value.</p> </li> <li> <p>To leave a parameter set to its present value, you can do one of the following:</p> <ul> <li> <p>Do not include the parameter in the list.</p> </li> <li> <p>Include the parameter and specify <code>UsePreviousValue</code> as <code>true</code>. (You cannot specify both a value and set <code>UsePreviousValue</code> to <code>true</code>.)</p> </li> </ul> </li> <li> <p>To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.</p> </li> <li> <p>To leave all parameters set to their present values, do not specify this property at all.</p> </li> </ul> <p>During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.</p> <p>You can only override the parameter <i>values</i> that are specified in the stack set; to add or delete a parameter itself, use <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html\">UpdateStackSet</a> to update the stack set template.</p>",
"CreateStackSetInput$Parameters": "<p>The input parameters for the stack set template. </p>",
"DescribeChangeSetOutput$Parameters": "<p>A list of <code>Parameter</code> structures that describes the input parameters and their values used to create the change set. For more information, see the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html\">Parameter</a> data type.</p>",
"EstimateTemplateCostInput$Parameters": "<p>A list of <code>Parameter</code> structures that specify input parameters.</p>",
"Stack$Parameters": "<p>A list of <code>Parameter</code> structures.</p>",
"StackInstance$ParameterOverrides": "<p>A list of parameters from the stack set template whose values have been overridden in this stack instance.</p>",
"StackSet$Parameters": "<p>A list of input parameters for a stack set.</p>",
"UpdateStackInput$Parameters": "<p>A list of <code>Parameter</code> structures that specify input parameters for the stack. For more information, see the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html\">Parameter</a> data type.</p>",
"UpdateStackInstancesInput$ParameterOverrides": "<p> A list of input parameters whose values you want to update for the specified stack instances. </p> <p>Any overridden parameter values will be applied to all stack instances in the specified accounts and regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance update operations:</p> <ul> <li> <p>To override the current value for a parameter, include the parameter and specify its value.</p> </li> <li> <p>To leave a parameter set to its present value, you can do one of the following:</p> <ul> <li> <p>Do not include the parameter in the list.</p> </li> <li> <p>Include the parameter and specify <code>UsePreviousValue</code> as <code>true</code>. (You cannot specify both a value and set <code>UsePreviousValue</code> to <code>true</code>.)</p> </li> </ul> </li> <li> <p>To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.</p> </li> <li> <p>To leave all parameters set to their present values, do not specify this property at all.</p> </li> </ul> <p>During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.</p> <p>You can only override the parameter <i>values</i> that are specified in the stack set; to add or delete a parameter itself, use <code>UpdateStackSet</code> to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html\">UpdateStackSet</a> to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using <code>UpdateStackInstances</code>.</p>",
"UpdateStackSetInput$Parameters": "<p>A list of input parameters for the stack set template. </p>"
}
},
@ -1003,7 +1011,8 @@
"refs": {
"CreateStackInstancesInput$Regions": "<p>The names of one or more regions where you want to create stack instances using the specified AWS account(s). </p>",
"DeleteStackInstancesInput$Regions": "<p>The regions where you want to delete stack set instances. </p>",
"StackSetOperationPreferences$RegionOrder": "<p>The order of the regions in where you want to perform the stack operation.</p>"
"StackSetOperationPreferences$RegionOrder": "<p>The order of the regions in where you want to perform the stack operation.</p>",
"UpdateStackInstancesInput$Regions": "<p>The names of one or more regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions.</p>"
}
},
"Replacement": {
@ -1386,6 +1395,7 @@
"StackSet$StackSetName": "<p>The name that's associated with the stack set.</p>",
"StackSetSummary$StackSetName": "<p>The name of the stack set.</p>",
"StopStackSetOperationInput$StackSetName": "<p>The name or unique ID of the stack set that you want to stop the operation for.</p>",
"UpdateStackInstancesInput$StackSetName": "<p>The name or unique ID of the stack set associated with the stack instances.</p>",
"UpdateStackSetInput$StackSetName": "<p>The name or unique ID of the stack set that you want to update.</p>"
}
},
@ -1424,6 +1434,7 @@
"CreateStackInstancesInput$OperationPreferences": "<p>Preferences for how AWS CloudFormation performs this stack set operation.</p>",
"DeleteStackInstancesInput$OperationPreferences": "<p>Preferences for how AWS CloudFormation performs this stack set operation.</p>",
"StackSetOperation$OperationPreferences": "<p>The preferences for how AWS CloudFormation performs this stack set operation.</p>",
"UpdateStackInstancesInput$OperationPreferences": "<p>Preferences for how AWS CloudFormation performs this stack set operation.</p>",
"UpdateStackSetInput$OperationPreferences": "<p>Preferences for how AWS CloudFormation performs this stack set operation.</p>"
}
},
@ -1677,6 +1688,16 @@
"refs": {
}
},
"UpdateStackInstancesInput": {
"base": null,
"refs": {
}
},
"UpdateStackInstancesOutput": {
"base": null,
"refs": {
}
},
"UpdateStackOutput": {
"base": "<p>The output for an <a>UpdateStack</a> action.</p>",
"refs": {

View File

@ -233,6 +233,21 @@
{"shape":"PreconditionFailed"}
]
},
"DeleteServiceLinkedRole":{
"name":"DeleteServiceLinkedRole2017_03_25",
"http":{
"method":"DELETE",
"requestUri":"/2017-03-25/service-linked-role/{RoleName}",
"responseCode":204
},
"input":{"shape":"DeleteServiceLinkedRoleRequest"},
"errors":[
{"shape":"InvalidArgument"},
{"shape":"AccessDenied"},
{"shape":"ResourceInUse"},
{"shape":"NoSuchResource"}
]
},
"DeleteStreamingDistribution":{
"name":"DeleteStreamingDistribution2017_03_25",
"http":{
@ -1054,6 +1069,17 @@
}
}
},
"DeleteServiceLinkedRoleRequest":{
"type":"structure",
"required":["RoleName"],
"members":{
"RoleName":{
"shape":"string",
"location":"uri",
"locationName":"RoleName"
}
}
},
"DeleteStreamingDistributionRequest":{
"type":"structure",
"required":["Id"],
@ -1937,7 +1963,10 @@
"type":"string",
"enum":[
"SSLv3",
"TLSv1"
"TLSv1",
"TLSv1_2016",
"TLSv1.1_2016",
"TLSv1.2_2018"
]
},
"MissingBody":{
@ -2114,6 +2143,14 @@
"type":"string",
"pattern":"arn:aws:cloudfront::[0-9]+:.*"
},
"ResourceInUse":{
"type":"structure",
"members":{
"Message":{"shape":"string"}
},
"error":{"httpStatusCode":409},
"exception":true
},
"Restrictions":{
"type":"structure",
"required":["GeoRestriction"],

View File

@ -1,6 +1,6 @@
{
"version": "2.0",
"service": "<fullname>Amazon CloudFront</fullname> <p>This is the <i>Amazon CloudFront API Reference</i>. This guide is for developers who need detailed information about the CloudFront API actions, data types, and errors. For detailed information about CloudFront features and their associated API calls, see the <i>Amazon CloudFront Developer Guide</i>.</p>",
"service": "<fullname>Amazon CloudFront</fullname> <p>This is the <i>Amazon CloudFront API Reference</i>. This guide is for developers who need detailed information about CloudFront API actions, data types, and errors. For detailed information about CloudFront features, see the <i>Amazon CloudFront Developer Guide</i>.</p>",
"operations": {
"CreateCloudFrontOriginAccessIdentity": "<p>Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
"CreateDistribution": "<p>Creates a new web distribution. Send a <code>POST</code> request to the <code>/<i>CloudFront API version</i>/distribution</code>/<code>distribution ID</code> resource.</p>",
@ -10,6 +10,7 @@
"CreateStreamingDistributionWithTags": "<p>Create a new streaming distribution with tags.</p>",
"DeleteCloudFrontOriginAccessIdentity": "<p>Delete an origin access identity. </p>",
"DeleteDistribution": "<p>Delete a distribution. </p>",
"DeleteServiceLinkedRole": null,
"DeleteStreamingDistribution": "<p>Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.</p> <p> <b>To delete an RTMP distribution using the CloudFront API</b>:</p> <ol> <li> <p>Disable the RTMP distribution.</p> </li> <li> <p>Submit a <code>GET Streaming Distribution Config</code> request to get the current configuration and the <code>Etag</code> header for the distribution. </p> </li> <li> <p>Update the XML document that was returned in the response to your <code>GET Streaming Distribution Config</code> request to change the value of <code>Enabled</code> to <code>false</code>.</p> </li> <li> <p>Submit a <code>PUT Streaming Distribution Config</code> request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTP <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront returned when you submitted the <code>GET Streaming Distribution Config</code> request in Step 2.</p> </li> <li> <p>Review the response to the <code>PUT Streaming Distribution Config</code> request to confirm that the distribution was successfully disabled.</p> </li> <li> <p>Submit a <code>GET Streaming Distribution Config</code> request to confirm that your changes have propagated. When propagation is complete, the value of <code>Status</code> is <code>Deployed</code>.</p> </li> <li> <p>Submit a <code>DELETE Streaming Distribution</code> request. Set the value of the HTTP <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront returned when you submitted the <code>GET Streaming Distribution Config</code> request in Step 2.</p> </li> <li> <p>Review the response to your <code>DELETE Streaming Distribution</code> request to confirm that the distribution was successfully deleted.</p> </li> </ol> <p>For information about deleting a distribution using the CloudFront console, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/HowToDeleteDistribution.html\">Deleting a Distribution</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
"GetCloudFrontOriginAccessIdentity": "<p>Get the information about an origin access identity. </p>",
"GetCloudFrontOriginAccessIdentityConfig": "<p>Get the configuration information about an origin access identity. </p>",
@ -109,7 +110,7 @@
"CertificateSource": {
"base": null,
"refs": {
"ViewerCertificate$CertificateSource": "<note> <p>This field is deprecated. You can use one of the following: <code>[ACMCertificateArn</code>, <code>IAMCertificateId</code>, or <code>CloudFrontDefaultCertificate]</code>.</p> </note>"
"ViewerCertificate$CertificateSource": "<p>This field has been deprecated. Use one of the following fields instead:</p> <ul> <li> <p> <a>ViewerCertificate$ACMCertificateArn</a> </p> </li> <li> <p> <a>ViewerCertificate$IAMCertificateId</a> </p> </li> <li> <p> <a>ViewerCertificate$CloudFrontDefaultCertificate</a> </p> </li> </ul>"
}
},
"CloudFrontOriginAccessIdentity": {
@ -267,10 +268,10 @@
}
},
"DefaultCacheBehavior": {
"base": "<p>A complex type that describes the default cache behavior if you do not specify a <code>CacheBehavior</code> element or if files don't match any of the values of <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create exactly one default cache behavior.</p>",
"base": "<p>A complex type that describes the default cache behavior if you don't specify a <code>CacheBehavior</code> element or if files don't match any of the values of <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create exactly one default cache behavior.</p>",
"refs": {
"DistributionConfig$DefaultCacheBehavior": "<p>A complex type that describes the default cache behavior if you do not specify a <code>CacheBehavior</code> element or if files don't match any of the values of <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create exactly one default cache behavior.</p>",
"DistributionSummary$DefaultCacheBehavior": "<p>A complex type that describes the default cache behavior if you do not specify a <code>CacheBehavior</code> element or if files don't match any of the values of <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create exactly one default cache behavior.</p>"
"DistributionConfig$DefaultCacheBehavior": "<p>A complex type that describes the default cache behavior if you don't specify a <code>CacheBehavior</code> element or if files don't match any of the values of <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create exactly one default cache behavior.</p>",
"DistributionSummary$DefaultCacheBehavior": "<p>A complex type that describes the default cache behavior if you don't specify a <code>CacheBehavior</code> element or if files don't match any of the values of <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create exactly one default cache behavior.</p>"
}
},
"DeleteCloudFrontOriginAccessIdentityRequest": {
@ -283,6 +284,11 @@
"refs": {
}
},
"DeleteServiceLinkedRoleRequest": {
"base": null,
"refs": {
}
},
"DeleteStreamingDistributionRequest": {
"base": "<p>The request to delete a streaming distribution.</p>",
"refs": {
@ -345,7 +351,7 @@
"EventType": {
"base": null,
"refs": {
"LambdaFunctionAssociation$EventType": "<p>Specifies the event type that triggers a Lambda function invocation. Valid values are:</p> <ul> <li> <p> <code>viewer-request</code> </p> </li> <li> <p> <code>origin-request</code> </p> </li> <li> <p> <code>viewer-response</code> </p> </li> <li> <p> <code>origin-response</code> </p> </li> </ul>"
"LambdaFunctionAssociation$EventType": "<p>Specifies the event type that triggers a Lambda function invocation. You can specify the following values:</p> <ul> <li> <p> <code>viewer-request</code>: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache. </p> </li> <li> <p> <code>origin-request</code>: The function executes only when CloudFront forwards a request to your origin. When the requested object is in the edge cache, the function doesn't execute.</p> </li> <li> <p> <code>origin-response</code>: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.</p> <p>If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.</p> </li> <li> <p> <code>viewer-response</code>: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache.</p> <p>If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.</p> </li> </ul>"
}
},
"ForwardedValues": {
@ -364,7 +370,7 @@
"GeoRestrictionType": {
"base": null,
"refs": {
"GeoRestriction$RestrictionType": "<p>The method that you want to use to restrict distribution of your content by country:</p> <ul> <li> <p> <code>none</code>: No geo restriction is enabled, meaning access to content is not restricted by client geo location.</p> </li> <li> <p> <code>blacklist</code>: The <code>Location</code> elements specify the countries in which you do not want CloudFront to distribute your content.</p> </li> <li> <p> <code>whitelist</code>: The <code>Location</code> elements specify the countries in which you want CloudFront to distribute your content.</p> </li> </ul>"
"GeoRestriction$RestrictionType": "<p>The method that you want to use to restrict distribution of your content by country:</p> <ul> <li> <p> <code>none</code>: No geo restriction is enabled, meaning access to content is not restricted by client geo location.</p> </li> <li> <p> <code>blacklist</code>: The <code>Location</code> elements specify the countries in which you don't want CloudFront to distribute your content.</p> </li> <li> <p> <code>whitelist</code>: The <code>Location</code> elements specify the countries in which you want CloudFront to distribute your content.</p> </li> </ul>"
}
},
"GetCloudFrontOriginAccessIdentityConfigRequest": {
@ -440,13 +446,13 @@
"HeaderList": {
"base": null,
"refs": {
"Headers$Items": "<p>A complex type that contains one <code>Name</code> element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If <code>Quantity</code> is <code>0</code>, omit <code>Items</code>.</p>"
"Headers$Items": "<p>A list that contains one <code>Name</code> element for each header that you want CloudFront to use for caching in this cache behavior. If <code>Quantity</code> is <code>0</code>, omit <code>Items</code>.</p>"
}
},
"Headers": {
"base": "<p>A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior.</p> <p>For the headers that you specify, CloudFront also caches separate versions of a specified object based on the header values in viewer requests. For example, suppose viewer requests for <code>logo.jpg</code> contain a custom <code>Product</code> header that has a value of either <code>Acme</code> or <code>Apex</code>, and you configure CloudFront to cache your content based on values in the <code>Product</code> header. CloudFront forwards the <code>Product</code> header to the origin and caches the response from the origin once for each header value. For more information about caching based on header values, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html\">How CloudFront Forwards and Caches Headers</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
"base": "<p>A complex type that specifies the request headers, if any, that you want CloudFront to base caching on for this cache behavior. </p> <p>For the headers that you specify, CloudFront caches separate versions of a specified object based on the header values in viewer requests. For example, suppose viewer requests for <code>logo.jpg</code> contain a custom <code>product</code> header that has a value of either <code>acme</code> or <code>apex</code>, and you configure CloudFront to cache your content based on values in the <code>product</code> header. CloudFront forwards the <code>product</code> header to the origin and caches the response from the origin once for each header value. For more information about caching based on header values, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html\">How CloudFront Forwards and Caches Headers</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
"refs": {
"ForwardedValues$Headers": "<p>A complex type that specifies the <code>Headers</code>, if any, that you want CloudFront to vary upon for this cache behavior. </p>"
"ForwardedValues$Headers": "<p>A complex type that specifies the <code>Headers</code>, if any, that you want CloudFront to base caching on for this cache behavior. </p>"
}
},
"HttpVersion": {
@ -462,7 +468,7 @@
}
},
"InconsistentQuantities": {
"base": "<p>The value of <code>Quantity</code> and the size of <code>Items</code> do not match.</p>",
"base": "<p>The value of <code>Quantity</code> and the size of <code>Items</code> don't match.</p>",
"refs": {
}
},
@ -713,7 +719,7 @@
"LocationList": {
"base": null,
"refs": {
"GeoRestriction$Items": "<p> A complex type that contains a <code>Location</code> element for each country in which you want CloudFront either to distribute your content (<code>whitelist</code>) or not distribute your content (<code>blacklist</code>).</p> <p>The <code>Location</code> element is a two-letter, uppercase country code for a country that you want to include in your <code>blacklist</code> or <code>whitelist</code>. Include one <code>Location</code> element for each country.</p> <p>CloudFront and <code>MaxMind</code> both use <code>ISO 3166</code> country codes. For the current list of countries and the corresponding codes, see <code>ISO 3166-1-alpha-2</code> code on the <i>International Organization for Standardization</i> website. You can also refer to the country list in the CloudFront console, which includes both country names and codes.</p>"
"GeoRestriction$Items": "<p> A complex type that contains a <code>Location</code> element for each country in which you want CloudFront either to distribute your content (<code>whitelist</code>) or not distribute your content (<code>blacklist</code>).</p> <p>The <code>Location</code> element is a two-letter, uppercase country code for a country that you want to include in your <code>blacklist</code> or <code>whitelist</code>. Include one <code>Location</code> element for each country.</p> <p>CloudFront and <code>MaxMind</code> both use <code>ISO 3166</code> country codes. For the current list of countries and the corresponding codes, see <code>ISO 3166-1-alpha-2</code> code on the <i>International Organization for Standardization</i> website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.</p>"
}
},
"LoggingConfig": {
@ -738,11 +744,11 @@
"MinimumProtocolVersion": {
"base": null,
"refs": {
"ViewerCertificate$MinimumProtocolVersion": "<p>Specify the minimum version of the SSL/TLS protocol that you want CloudFront to use for HTTPS connections between viewers and CloudFront: <code>SSLv3</code> or <code>TLSv1</code>. CloudFront serves your objects only to viewers that support SSL/TLS version that you specify and later versions. The <code>TLSv1</code> protocol is more secure, so we recommend that you specify <code>SSLv3</code> only if your users are using browsers or devices that don't support <code>TLSv1</code>. Note the following:</p> <ul> <li> <p>If you specify &lt;CloudFrontDefaultCertificate&gt;true&lt;CloudFrontDefaultCertificate&gt;, the minimum SSL protocol version is <code>TLSv1</code> and can't be changed.</p> </li> <li> <p>If you're using a custom certificate (if you specify a value for <code>ACMCertificateArn</code> or for <code>IAMCertificateId</code>) and if you're using SNI (if you specify <code>sni-only</code> for <code>SSLSupportMethod</code>), you must specify <code>TLSv1</code> for <code>MinimumProtocolVersion</code>.</p> </li> </ul>"
"ViewerCertificate$MinimumProtocolVersion": "<p>Specify the security policy that you want CloudFront to use for HTTPS connections. A security policy determines two settings:</p> <ul> <li> <p>The minimum SSL/TLS protocol that CloudFront uses to communicate with viewers</p> </li> <li> <p>The cipher that CloudFront uses to encrypt the content that it returns to viewers</p> </li> </ul> <note> <p>On the CloudFront console, this setting is called <b>Security policy</b>.</p> </note> <p>We recommend that you specify <code>TLSv1.1_2016</code> unless your users are using browsers or devices that do not support TLSv1.1 or later.</p> <p>When both of the following are true, you must specify <code>TLSv1</code> or later for the security policy: </p> <ul> <li> <p>You're using a custom certificate: you specified a value for <code>ACMCertificateArn</code> or for <code>IAMCertificateId</code> </p> </li> <li> <p>You're using SNI: you specified <code>sni-only</code> for <code>SSLSupportMethod</code> </p> </li> </ul> <p>If you specify <code>true</code> for <code>CloudFrontDefaultCertificate</code>, CloudFront automatically sets the security policy to <code>TLSv1</code> regardless of the value that you specify for <code>MinimumProtocolVersion</code>.</p> <p>For information about the relationship between the security policy that you choose and the protocols and ciphers that CloudFront uses to communicate with viewers, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers\"> Supported SSL/TLS Protocols and Ciphers for Communication Between Viewers and CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
}
},
"MissingBody": {
"base": "<p>This operation requires a body. Ensure that the body is present and the Content-Type header is set.</p>",
"base": "<p>This operation requires a body. Ensure that the body is present and the <code>Content-Type</code> header is set.</p>",
"refs": {
}
},
@ -865,6 +871,11 @@
"UntagResourceRequest$Resource": "<p> An ARN of a CloudFront resource.</p>"
}
},
"ResourceInUse": {
"base": null,
"refs": {
}
},
"Restrictions": {
"base": "<p>A complex type that identifies ways in which you want to restrict distribution of your content.</p>",
"refs": {
@ -888,7 +899,7 @@
"SSLSupportMethod": {
"base": null,
"refs": {
"ViewerCertificate$SSLSupportMethod": "<p>If you specify a value for <code>ACMCertificateArn</code> or for <code>IAMCertificateId</code>, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for all clients or one that works for most clients:</p> <ul> <li> <p> <code>vip</code>: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you will incur additional monthly charges.</p> </li> <li> <p> <code>sni-only</code>: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. If some of your users' browsers don't support SNI, we recommend that you do one of the following:</p> <ul> <li> <p>Use the <code>vip</code> option (dedicated IP addresses) instead of <code>sni-only</code>.</p> </li> <li> <p>Use the CloudFront SSL/TLS certificate instead of a custom certificate. This requires that you use the CloudFront domain name of your distribution in the URLs for your objects, for example, <code>https://d111111abcdef8.cloudfront.net/logo.png</code>.</p> </li> <li> <p>If you can control which browser your users use, upgrade the browser to one that supports SNI.</p> </li> <li> <p>Use HTTP instead of HTTPS.</p> </li> </ul> </li> </ul> <p>Do not specify a value for <code>SSLSupportMethod</code> if you specified <code>&lt;CloudFrontDefaultCertificate&gt;true&lt;CloudFrontDefaultCertificate&gt;</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html#CNAMEsAndHTTPS.html\">Using Alternate Domain Names and HTTPS</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
"ViewerCertificate$SSLSupportMethod": "<p>If you specify a value for <a>ViewerCertificate$ACMCertificateArn</a> or for <a>ViewerCertificate$IAMCertificateId</a>, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for all clients or one that works for most clients:</p> <ul> <li> <p> <code>vip</code>: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you will incur additional monthly charges.</p> </li> <li> <p> <code>sni-only</code>: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. If some of your users' browsers don't support SNI, we recommend that you do one of the following:</p> <ul> <li> <p>Use the <code>vip</code> option (dedicated IP addresses) instead of <code>sni-only</code>.</p> </li> <li> <p>Use the CloudFront SSL/TLS certificate instead of a custom certificate. This requires that you use the CloudFront domain name of your distribution in the URLs for your objects, for example, <code>https://d111111abcdef8.cloudfront.net/logo.png</code>.</p> </li> <li> <p>If you can control which browser your users use, upgrade the browser to one that supports SNI.</p> </li> <li> <p>Use HTTP instead of HTTPS.</p> </li> </ul> </li> </ul> <p>Don't specify a value for <code>SSLSupportMethod</code> if you specified <code>&lt;CloudFrontDefaultCertificate&gt;true&lt;CloudFrontDefaultCertificate&gt;</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html#CNAMEsAndHTTPS.html\">Using Alternate Domain Names and HTTPS</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
}
},
"Signer": {
@ -1106,7 +1117,7 @@
}
},
"TrustedSignerDoesNotExist": {
"base": "<p>One or more of your trusted signers do not exist.</p>",
"base": "<p>One or more of your trusted signers don't exist.</p>",
"refs": {
}
},
@ -1155,7 +1166,7 @@
}
},
"ViewerCertificate": {
"base": "<p>A complex type that specifies the following:</p> <ul> <li> <p>Which SSL/TLS certificate to use when viewers request objects using HTTPS</p> </li> <li> <p>Whether you want CloudFront to use dedicated IP addresses or SNI when you're using alternate domain names in your object names</p> </li> <li> <p>The minimum protocol version that you want CloudFront to use when communicating with viewers</p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html\">Using an HTTPS Connection to Access Your Objects</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p>",
"base": "<p>A complex type that specifies the following:</p> <ul> <li> <p>Whether you want viewers to use HTTP or HTTPS to request your objects.</p> </li> <li> <p>If you want viewers to use HTTPS, whether you're using an alternate domain name such as <code>example.com</code> or the CloudFront domain name for your distribution, such as <code>d111111abcdef8.cloudfront.net</code>.</p> </li> <li> <p>If you're using an alternate domain name, whether AWS Certificate Manager (ACM) provided the certificate, or you purchased a certificate from a third-party certificate authority and imported it into ACM or uploaded it to the IAM certificate store.</p> </li> </ul> <p>You must specify only one of the following values: </p> <ul> <li> <p> <a>ViewerCertificate$ACMCertificateArn</a> </p> </li> <li> <p> <a>ViewerCertificate$IAMCertificateId</a> </p> </li> <li> <p> <a>ViewerCertificate$CloudFrontDefaultCertificate</a> </p> </li> </ul> <p>Don't specify <code>false</code> for <code>CloudFrontDefaultCertificate</code>.</p> <p> <b>If you want viewers to use HTTP instead of HTTPS to request your objects</b>: Specify the following value:</p> <p> <code>&lt;CloudFrontDefaultCertificate&gt;true&lt;CloudFrontDefaultCertificate&gt;</code> </p> <p>In addition, specify <code>allow-all</code> for <code>ViewerProtocolPolicy</code> for all of your cache behaviors.</p> <p> <b>If you want viewers to use HTTPS to request your objects</b>: Choose the type of certificate that you want to use based on whether you're using an alternate domain name for your objects or the CloudFront domain name:</p> <ul> <li> <p> <b>If you're using an alternate domain name, such as example.com</b>: Specify one of the following values, depending on whether ACM provided your certificate or you purchased your certificate from third-party certificate authority:</p> <ul> <li> <p> <code>&lt;ACMCertificateArn&gt;<i>ARN for ACM SSL/TLS certificate</i>&lt;ACMCertificateArn&gt;</code> where <code> <i>ARN for ACM SSL/TLS certificate</i> </code> is the ARN for the ACM SSL/TLS certificate that you want to use for this distribution.</p> </li> <li> <p> <code>&lt;IAMCertificateId&gt;<i>IAM certificate ID</i>&lt;IAMCertificateId&gt;</code> where <code> <i>IAM certificate ID</i> </code> is the ID that IAM returned when you added the certificate to the IAM certificate store.</p> </li> </ul> <p>If you specify <code>ACMCertificateArn</code> or <code>IAMCertificateId</code>, you must also specify a value for <code>SSLSupportMethod</code>.</p> <p>If you choose to use an ACM certificate or a certificate in the IAM certificate store, we recommend that you use only an alternate domain name in your object URLs (<code>https://example.com/logo.jpg</code>). If you use the domain name that is associated with your CloudFront distribution (such as <code>https://d111111abcdef8.cloudfront.net/logo.jpg</code>) and the viewer supports <code>SNI</code>, then CloudFront behaves normally. However, if the browser does not support SNI, the user's experience depends on the value that you choose for <code>SSLSupportMethod</code>:</p> <ul> <li> <p> <code>vip</code>: The viewer displays a warning because there is a mismatch between the CloudFront domain name and the domain name in your SSL/TLS certificate.</p> </li> <li> <p> <code>sni-only</code>: CloudFront drops the connection with the browser without returning the object.</p> </li> </ul> </li> <li> <p> <b>If you're using the CloudFront domain name for your distribution, such as <code>d111111abcdef8.cloudfront.net</code> </b>: Specify the following value:</p> <p> <code>&lt;CloudFrontDefaultCertificate&gt;true&lt;CloudFrontDefaultCertificate&gt; </code> </p> </li> </ul> <p>If you want viewers to use HTTPS, you must also specify one of the following values in your cache behaviors:</p> <ul> <li> <p> <code> &lt;ViewerProtocolPolicy&gt;https-only&lt;ViewerProtocolPolicy&gt;</code> </p> </li> <li> <p> <code>&lt;ViewerProtocolPolicy&gt;redirect-to-https&lt;ViewerProtocolPolicy&gt;</code> </p> </li> </ul> <p>You can also optionally require that CloudFront use HTTPS to communicate with your origin by specifying one of the following values for the applicable origins:</p> <ul> <li> <p> <code>&lt;OriginProtocolPolicy&gt;https-only&lt;OriginProtocolPolicy&gt; </code> </p> </li> <li> <p> <code>&lt;OriginProtocolPolicy&gt;match-viewer&lt;OriginProtocolPolicy&gt; </code> </p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html#CNAMEsAndHTTPS\">Using Alternate Domain Names and HTTPS</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
"refs": {
"DistributionConfig$ViewerCertificate": null,
"DistributionSummary$ViewerCertificate": null
@ -1178,20 +1189,20 @@
"DefaultCacheBehavior$SmoothStreaming": "<p>Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify <code>true</code>; if not, specify <code>false</code>. If you specify <code>true</code> for <code>SmoothStreaming</code>, you can still distribute other content using this cache behavior if the content matches the value of <code>PathPattern</code>. </p>",
"DefaultCacheBehavior$Compress": "<p>Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify <code>true</code>; if not, specify <code>false</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html\">Serving Compressed Files</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
"DistributionConfig$Enabled": "<p>From this field, you can enable or disable the selected distribution.</p> <p>If you specify <code>false</code> for <code>Enabled</code> but you specify values for <code>Bucket</code> and <code>Prefix</code>, the values are automatically deleted.</p>",
"DistributionConfig$IsIPV6Enabled": "<p>If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify <code>true</code>. If you specify <code>false</code>, CloudFront responds to IPv6 DNS requests with the DNS response code <code>NOERROR</code> and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. </p> <p>In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the <code>IpAddress</code> parameter to restrict the IP addresses that can access your content, do not enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html\">Creating a Signed URL Using a Custom Policy</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you're using an Amazon Route 53 alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:</p> <ul> <li> <p>You enable IPv6 for the distribution</p> </li> <li> <p>You're using alternate domain names in the URLs for your objects</p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html\">Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> <p>If you created a CNAME resource record set, either with Amazon Route 53 or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.</p>",
"DistributionConfig$IsIPV6Enabled": "<p>If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify <code>true</code>. If you specify <code>false</code>, CloudFront responds to IPv6 DNS requests with the DNS response code <code>NOERROR</code> and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. </p> <p>In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the <code>IpAddress</code> parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html\">Creating a Signed URL Using a Custom Policy</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you're using an Amazon Route 53 alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:</p> <ul> <li> <p>You enable IPv6 for the distribution</p> </li> <li> <p>You're using alternate domain names in the URLs for your objects</p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html\">Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> <p>If you created a CNAME resource record set, either with Amazon Route 53 or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.</p>",
"DistributionList$IsTruncated": "<p>A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the <code>Marker</code> request parameter to retrieve more distributions in the list.</p>",
"DistributionSummary$Enabled": "<p>Whether the distribution is enabled to accept user requests for content.</p>",
"DistributionSummary$IsIPV6Enabled": "<p>Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.</p>",
"ForwardedValues$QueryString": "<p>Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of <code>QueryString</code> and on the values that you specify for <code>QueryStringCacheKeys</code>, if any:</p> <p>If you specify true for <code>QueryString</code> and you don't specify any values for <code>QueryStringCacheKeys</code>, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.</p> <p>If you specify true for <code>QueryString</code> and you specify one or more values for <code>QueryStringCacheKeys</code>, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.</p> <p>If you specify false for <code>QueryString</code>, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html\">Configuring CloudFront to Cache Based on Query String Parameters</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
"InvalidationList$IsTruncated": "<p>A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the <code>Marker</code> request parameter to retrieve more invalidation batches in the list.</p>",
"LoggingConfig$Enabled": "<p>Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify <code>false</code> for <code>Enabled</code>, and specify empty <code>Bucket</code> and <code>Prefix</code> elements. If you specify <code>false</code> for <code>Enabled</code> but you specify values for <code>Bucket</code>, <code>prefix</code>, and <code>IncludeCookies</code>, the values are automatically deleted.</p>",
"LoggingConfig$IncludeCookies": "<p>Specifies whether you want CloudFront to include cookies in access logs, specify <code>true</code> for <code>IncludeCookies</code>. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify <code>false</code> for <code>IncludeCookies</code>.</p>",
"LoggingConfig$Enabled": "<p>Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify <code>false</code> for <code>Enabled</code>, and specify empty <code>Bucket</code> and <code>Prefix</code> elements. If you specify <code>false</code> for <code>Enabled</code> but you specify values for <code>Bucket</code>, <code>prefix</code>, and <code>IncludeCookies</code>, the values are automatically deleted.</p>",
"LoggingConfig$IncludeCookies": "<p>Specifies whether you want CloudFront to include cookies in access logs, specify <code>true</code> for <code>IncludeCookies</code>. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify <code>false</code> for <code>IncludeCookies</code>.</p>",
"StreamingDistributionConfig$Enabled": "<p>Whether the streaming distribution is enabled to accept user requests for content.</p>",
"StreamingDistributionList$IsTruncated": "<p>A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the <code>Marker</code> request parameter to retrieve more distributions in the list. </p>",
"StreamingDistributionSummary$Enabled": "<p>Whether the distribution is enabled to accept end user requests for content.</p>",
"StreamingLoggingConfig$Enabled": "<p>Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify <code>false</code> for <code>Enabled</code>, and specify <code>empty Bucket</code> and <code>Prefix</code> elements. If you specify <code>false</code> for <code>Enabled</code> but you specify values for <code>Bucket</code> and <code>Prefix</code>, the values are automatically deleted. </p>",
"StreamingLoggingConfig$Enabled": "<p>Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify <code>false</code> for <code>Enabled</code>, and specify <code>empty Bucket</code> and <code>Prefix</code> elements. If you specify <code>false</code> for <code>Enabled</code> but you specify values for <code>Bucket</code> and <code>Prefix</code>, the values are automatically deleted. </p>",
"TrustedSigners$Enabled": "<p>Specifies whether you want to require viewers to use signed URLs to access the files specified by <code>PathPattern</code> and <code>TargetOriginId</code>.</p>",
"ViewerCertificate$CloudFrontDefaultCertificate": null
"ViewerCertificate$CloudFrontDefaultCertificate": "<p>For information about how and when to use <code>CloudFrontDefaultCertificate</code>, see <a>ViewerCertificate</a>.</p>"
}
},
"integer": {
@ -1216,7 +1227,7 @@
"DistributionList$MaxItems": "<p>The value you provided for the <code>MaxItems</code> request parameter.</p>",
"DistributionList$Quantity": "<p>The number of distributions that were created by the current AWS account. </p>",
"GeoRestriction$Quantity": "<p>When geo restriction is <code>enabled</code>, this is the number of countries in your <code>whitelist</code> or <code>blacklist</code>. Otherwise, when it is not enabled, <code>Quantity</code> is <code>0</code>, and you can omit <code>Items</code>.</p>",
"Headers$Quantity": "<p>The number of different headers that you want CloudFront to forward to the origin for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:</p> <ul> <li> <p> <b>Forward all headers to your origin</b>: Specify <code>1</code> for <code>Quantity</code> and <code>*</code> for <code>Name</code>.</p> <important> <p>If you configure CloudFront to forward all headers to your origin, CloudFront doesn't cache the objects associated with this cache behavior. Instead, it sends every request to the origin.</p> </important> </li> <li> <p> <i>Forward a whitelist of headers you specify</i>: Specify the number of headers that you want to forward, and specify the header names in <code>Name</code> elements. CloudFront caches your objects based on the values in all of the specified headers. CloudFront also forwards the headers that it forwards by default, but it caches your objects based only on the headers that you specify. </p> </li> <li> <p> <b>Forward only the default headers</b>: Specify <code>0</code> for <code>Quantity</code> and omit <code>Items</code>. In this configuration, CloudFront doesn't cache based on the values in the request headers.</p> </li> </ul>",
"Headers$Quantity": "<p>The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:</p> <ul> <li> <p> <b>Forward all headers to your origin</b>: Specify <code>1</code> for <code>Quantity</code> and <code>*</code> for <code>Name</code>.</p> <important> <p>CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin. </p> </important> </li> <li> <p> <b>Forward a whitelist of headers you specify</b>: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in <code>Name</code> elements. CloudFront caches your objects based on the values in the specified headers.</p> </li> <li> <p> <b>Forward only the default headers</b>: Specify <code>0</code> for <code>Quantity</code> and omit <code>Items</code>. In this configuration, CloudFront doesn't cache based on the values in the request headers.</p> </li> </ul> <p>Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:</p> <ul> <li> <p> <b>S3 bucket</b>: See <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/RequestAndResponseBehaviorS3Origin.html#request-s3-removed-headers\">HTTP Request Headers That CloudFront Removes or Updates</a> </p> </li> <li> <p> <b>Custom origin</b>: See <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/RequestAndResponseBehaviorCustomOrigin.html#request-custom-headers-behavior\">HTTP Request Headers and CloudFront Behavior</a> </p> </li> </ul>",
"InvalidationList$MaxItems": "<p>The value that you provided for the <code>MaxItems</code> request parameter.</p>",
"InvalidationList$Quantity": "<p>The number of invalidation batches that were created by the current AWS account. </p>",
"KeyPairIds$Quantity": "<p>The number of active CloudFront key pairs for <code>AwsAccountNumber</code>.</p> <p>For more information, see <a>ActiveTrustedSigners</a>.</p>",
@ -1252,7 +1263,7 @@
"CNAMEAlreadyExists$Message": null,
"CacheBehavior$PathPattern": "<p>The pattern (for example, <code>images/*.jpg</code>) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.</p> <note> <p>You can optionally include a slash (<code>/</code>) at the beginning of the path pattern. For example, <code>/images/*.jpg</code>. CloudFront behavior is the same with or without the leading <code>/</code>.</p> </note> <p>The path pattern for the default cache behavior is <code>*</code> and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesPathPattern\">Path Pattern</a> in the <i> Amazon CloudFront Developer Guide</i>.</p>",
"CacheBehavior$TargetOriginId": "<p>The value of <code>ID</code> for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior.</p>",
"CloudFrontOriginAccessIdentity$Id": "<p>The ID for the origin access identity. For example: <code>E74FTE3AJFJ256A</code>. </p>",
"CloudFrontOriginAccessIdentity$Id": "<p>The ID for the origin access identity, for example, <code>E74FTE3AJFJ256A</code>. </p>",
"CloudFrontOriginAccessIdentity$S3CanonicalUserId": "<p>The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3. </p>",
"CloudFrontOriginAccessIdentityAlreadyExists$Message": null,
"CloudFrontOriginAccessIdentityConfig$CallerReference": "<p>A unique number that ensures the request can't be replayed.</p> <p>If the <code>CallerReference</code> is new (no matter the content of the <code>CloudFrontOriginAccessIdentityConfig</code> object), a new origin access identity is created.</p> <p>If the <code>CallerReference</code> is a value already sent in a previous identity request, and the content of the <code>CloudFrontOriginAccessIdentityConfig</code> is identical to the original request (ignoring white space), the response includes the same information returned to the original request. </p> <p>If the <code>CallerReference</code> is a value you already sent in a previous request to create an identity, but the content of the <code>CloudFrontOriginAccessIdentityConfig</code> is different from the original request, CloudFront returns a <code>CloudFrontOriginAccessIdentityAlreadyExists</code> error. </p>",
@ -1283,15 +1294,16 @@
"DeleteCloudFrontOriginAccessIdentityRequest$IfMatch": "<p>The value of the <code>ETag</code> header you received from a previous <code>GET</code> or <code>PUT</code> request. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"DeleteDistributionRequest$Id": "<p>The distribution ID. </p>",
"DeleteDistributionRequest$IfMatch": "<p>The value of the <code>ETag</code> header that you received when you disabled the distribution. For example: <code>E2QWRUHAPOMQZL</code>. </p>",
"DeleteServiceLinkedRoleRequest$RoleName": null,
"DeleteStreamingDistributionRequest$Id": "<p>The distribution ID. </p>",
"DeleteStreamingDistributionRequest$IfMatch": "<p>The value of the <code>ETag</code> header that you received when you disabled the streaming distribution. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"Distribution$Id": "<p>The identifier for the distribution. For example: <code>EDFDVBD632BHDS5</code>. </p>",
"Distribution$ARN": "<p>The ARN (Amazon Resource Name) for the distribution. For example: <code>arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5</code>, where <code>123456789012</code> is your AWS account ID.</p>",
"Distribution$Status": "<p>This response element indicates the current status of the distribution. When the status is <code>Deployed</code>, the distribution's information is fully propagated to all CloudFront edge locations. </p>",
"Distribution$DomainName": "<p>The domain name corresponding to the distribution. For example: <code>d604721fxaaqy9.cloudfront.net</code>. </p>",
"Distribution$DomainName": "<p>The domain name corresponding to the distribution, for example, <code>d111111abcdef8.cloudfront.net</code>. </p>",
"DistributionAlreadyExists$Message": null,
"DistributionConfig$CallerReference": "<p>A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.</p> <p>If the value of <code>CallerReference</code> is new (regardless of the content of the <code>DistributionConfig</code> object), CloudFront creates a new distribution.</p> <p>If <code>CallerReference</code> is a value you already sent in a previous request to create a distribution, and if the content of the <code>DistributionConfig</code> is identical to the original request (ignoring white space), CloudFront returns the same the response that it returned to the original request.</p> <p>If <code>CallerReference</code> is a value you already sent in a previous request to create a distribution but the content of the <code>DistributionConfig</code> is different from the original request, CloudFront returns a <code>DistributionAlreadyExists</code> error.</p>",
"DistributionConfig$DefaultRootObject": "<p>The object that you want CloudFront to request from your origin (for example, <code>index.html</code>) when a viewer requests the root URL for your distribution (<code>http://www.example.com</code>) instead of an object in your distribution (<code>http://www.example.com/product-description.html</code>). Specifying a default root object avoids exposing the contents of your distribution.</p> <p>Specify only the object name, for example, <code>index.html</code>. Do not add a <code>/</code> before the object name.</p> <p>If you don't want to specify a default root object when you create a distribution, include an empty <code>DefaultRootObject</code> element.</p> <p>To delete the default root object from an existing distribution, update the distribution configuration and include an empty <code>DefaultRootObject</code> element.</p> <p>To replace the default root object, update the distribution configuration and specify the new object.</p> <p>For more information about the default root object, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html\">Creating a Default Root Object</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
"DistributionConfig$DefaultRootObject": "<p>The object that you want CloudFront to request from your origin (for example, <code>index.html</code>) when a viewer requests the root URL for your distribution (<code>http://www.example.com</code>) instead of an object in your distribution (<code>http://www.example.com/product-description.html</code>). Specifying a default root object avoids exposing the contents of your distribution.</p> <p>Specify only the object name, for example, <code>index.html</code>. Don't add a <code>/</code> before the object name.</p> <p>If you don't want to specify a default root object when you create a distribution, include an empty <code>DefaultRootObject</code> element.</p> <p>To delete the default root object from an existing distribution, update the distribution configuration and include an empty <code>DefaultRootObject</code> element.</p> <p>To replace the default root object, update the distribution configuration and specify the new object.</p> <p>For more information about the default root object, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html\">Creating a Default Root Object</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
"DistributionConfig$Comment": "<p>Any comments you want to include about the distribution.</p> <p>If you don't want to specify a comment, include an empty <code>Comment</code> element.</p> <p>To delete an existing comment, update the distribution configuration and include an empty <code>Comment</code> element.</p> <p>To add or change a comment, update the distribution configuration and specify the new comment.</p>",
"DistributionConfig$WebACLId": "<p>A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution.</p> <p>AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about AWS WAF, see the <a href=\"http://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html\">AWS WAF Developer Guide</a>. </p>",
"DistributionList$Marker": "<p>The value you provided for the <code>Marker</code> request parameter.</p>",
@ -1300,7 +1312,7 @@
"DistributionSummary$Id": "<p>The identifier for the distribution. For example: <code>EDFDVBD632BHDS5</code>.</p>",
"DistributionSummary$ARN": "<p>The ARN (Amazon Resource Name) for the distribution. For example: <code>arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5</code>, where <code>123456789012</code> is your AWS account ID.</p>",
"DistributionSummary$Status": "<p>The current status of the distribution. When the status is <code>Deployed</code>, the distribution's information is propagated to all CloudFront edge locations.</p>",
"DistributionSummary$DomainName": "<p>The domain name that corresponds to the distribution. For example: <code>d604721fxaaqy9.cloudfront.net</code>.</p>",
"DistributionSummary$DomainName": "<p>The domain name that corresponds to the distribution, for example, <code>d111111abcdef8.cloudfront.net</code>.</p>",
"DistributionSummary$Comment": "<p>The comment originally specified when this distribution was created.</p>",
"DistributionSummary$WebACLId": "<p>The Web ACL Id (if any) associated with the distribution.</p>",
"GetCloudFrontOriginAccessIdentityConfigRequest$Id": "<p>The identity's ID. </p>",
@ -1351,7 +1363,7 @@
"InvalidationSummary$Id": "<p>The unique ID for an invalidation request.</p>",
"InvalidationSummary$Status": "<p>The status of an invalidation request.</p>",
"KeyPairIdList$member": null,
"LambdaFunctionAssociation$LambdaFunctionARN": "<p>The ARN of the Lambda function.</p>",
"LambdaFunctionAssociation$LambdaFunctionARN": "<p>The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias or $LATEST.</p>",
"ListCloudFrontOriginAccessIdentitiesRequest$Marker": "<p>Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the <code>Marker</code> to the value of the <code>NextMarker</code> from the current page's response (which is also the ID of the last identity on that page).</p>",
"ListCloudFrontOriginAccessIdentitiesRequest$MaxItems": "<p>The maximum number of origin access identities you want in the response body. </p>",
"ListDistributionsByWebACLIdRequest$Marker": "<p>Use <code>Marker</code> and <code>MaxItems</code> to control pagination of results. If you have more than <code>MaxItems</code> distributions that satisfy the request, the response includes a <code>NextMarker</code> element. To get the next page of results, submit another request. For the value of <code>Marker</code>, specify the value of <code>NextMarker</code> from the last response. (For the first request, omit <code>Marker</code>.) </p>",
@ -1366,7 +1378,7 @@
"ListStreamingDistributionsRequest$MaxItems": "<p>The value that you provided for the <code>MaxItems</code> request parameter.</p>",
"LocationList$member": null,
"LoggingConfig$Bucket": "<p>The Amazon S3 bucket to store the access logs in, for example, <code>myawslogbucket.s3.amazonaws.com</code>.</p>",
"LoggingConfig$Prefix": "<p>An optional string that you want CloudFront to prefix to the access log <code>filenames</code> for this distribution, for example, <code>myprefix/</code>. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty <code>Prefix</code> element in the <code>Logging</code> element.</p>",
"LoggingConfig$Prefix": "<p>An optional string that you want CloudFront to prefix to the access log <code>filenames</code> for this distribution, for example, <code>myprefix/</code>. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty <code>Prefix</code> element in the <code>Logging</code> element.</p>",
"MissingBody$Message": null,
"NoSuchCloudFrontOriginAccessIdentity$Message": null,
"NoSuchDistribution$Message": null,
@ -1375,13 +1387,14 @@
"NoSuchResource$Message": null,
"NoSuchStreamingDistribution$Message": null,
"Origin$Id": "<p>A unique identifier for the origin. The value of <code>Id</code> must be unique within the distribution.</p> <p>When you specify the value of <code>TargetOriginId</code> for the default cache behavior or for another cache behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the value of the <code>Id</code> element for that origin. When a request matches the path pattern for that cache behavior, CloudFront routes the request to the specified origin. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior\">Cache Behavior Settings</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
"Origin$DomainName": "<p> <b>Amazon S3 origins</b>: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, <code>myawsbucket.s3.amazonaws.com</code>.</p> <p>Constraints for Amazon S3 origins: </p> <ul> <li> <p>If you configured Amazon S3 Transfer Acceleration for your bucket, do not specify the <code>s3-accelerate</code> endpoint for <code>DomainName</code>.</p> </li> <li> <p>The bucket name must be between 3 and 63 characters long (inclusive).</p> </li> <li> <p>The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.</p> </li> <li> <p>The bucket name must not contain adjacent periods.</p> </li> </ul> <p> <b>Custom Origins</b>: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, <code>www.example.com</code>. </p> <p>Constraints for custom origins:</p> <ul> <li> <p> <code>DomainName</code> must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or underscore (_) characters.</p> </li> <li> <p>The name cannot exceed 128 characters.</p> </li> </ul>",
"Origin$DomainName": "<p> <b>Amazon S3 origins</b>: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, <code>myawsbucket.s3.amazonaws.com</code>.</p> <p>Constraints for Amazon S3 origins: </p> <ul> <li> <p>If you configured Amazon S3 Transfer Acceleration for your bucket, don't specify the <code>s3-accelerate</code> endpoint for <code>DomainName</code>.</p> </li> <li> <p>The bucket name must be between 3 and 63 characters long (inclusive).</p> </li> <li> <p>The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.</p> </li> <li> <p>The bucket name must not contain adjacent periods.</p> </li> </ul> <p> <b>Custom Origins</b>: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, <code>www.example.com</code>. </p> <p>Constraints for custom origins:</p> <ul> <li> <p> <code>DomainName</code> must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or underscore (_) characters.</p> </li> <li> <p>The name cannot exceed 128 characters.</p> </li> </ul>",
"Origin$OriginPath": "<p>An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the <code>OriginPath</code> element, specify the directory name, beginning with a <code>/</code>. CloudFront appends the directory name to the value of <code>DomainName</code>, for example, <code>example.com/production</code>. Do not include a <code>/</code> at the end of the directory name.</p> <p>For example, suppose you've specified the following values for your distribution:</p> <ul> <li> <p> <code>DomainName</code>: An Amazon S3 bucket named <code>myawsbucket</code>.</p> </li> <li> <p> <code>OriginPath</code>: <code>/production</code> </p> </li> <li> <p> <code>CNAME</code>: <code>example.com</code> </p> </li> </ul> <p>When a user enters <code>example.com/index.html</code> in a browser, CloudFront sends a request to Amazon S3 for <code>myawsbucket/production/index.html</code>.</p> <p>When a user enters <code>example.com/acme/index.html</code> in a browser, CloudFront sends a request to Amazon S3 for <code>myawsbucket/production/acme/index.html</code>.</p>",
"OriginCustomHeader$HeaderName": "<p>The name of a header that you want CloudFront to forward to your origin. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.html\">Forwarding Custom Headers to Your Origin (Web Distributions Only)</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p>",
"OriginCustomHeader$HeaderValue": "<p>The value for the header that you specified in the <code>HeaderName</code> field.</p>",
"PathList$member": null,
"PreconditionFailed$Message": null,
"QueryStringCacheKeysList$member": null,
"ResourceInUse$Message": null,
"S3Origin$DomainName": "<p>The DNS name of the Amazon S3 origin. </p>",
"S3Origin$OriginAccessIdentity": "<p>The CloudFront origin access identity to associate with the RTMP distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront.</p> <p>If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty <code>OriginAccessIdentity</code> element.</p> <p>To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty <code>OriginAccessIdentity</code> element.</p> <p>To replace the origin access identity, update the distribution configuration and specify the new origin access identity.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html\">Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p>",
"S3OriginConfig$OriginAccessIdentity": "<p>The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can <i>only</i> access objects in an Amazon S3 bucket through CloudFront. The format of the value is:</p> <p>origin-access-identity/cloudfront/<i>ID-of-origin-access-identity</i> </p> <p>where <code> <i>ID-of-origin-access-identity</i> </code> is the value that CloudFront returned in the <code>ID</code> element when you created the origin access identity.</p> <p>If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty <code>OriginAccessIdentity</code> element.</p> <p>To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty <code>OriginAccessIdentity</code> element.</p> <p>To replace the origin access identity, update the distribution configuration and specify the new origin access identity.</p> <p>For more information about the origin access identity, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
@ -1389,20 +1402,20 @@
"StreamingDistribution$Id": "<p>The identifier for the RTMP distribution. For example: <code>EGTXBD79EXAMPLE</code>.</p>",
"StreamingDistribution$ARN": null,
"StreamingDistribution$Status": "<p>The current status of the RTMP distribution. When the status is <code>Deployed</code>, the distribution's information is propagated to all CloudFront edge locations.</p>",
"StreamingDistribution$DomainName": "<p>The domain name that corresponds to the streaming distribution. For example: <code>s5c39gqb8ow64r.cloudfront.net</code>. </p>",
"StreamingDistribution$DomainName": "<p>The domain name that corresponds to the streaming distribution, for example, <code>s5c39gqb8ow64r.cloudfront.net</code>. </p>",
"StreamingDistributionAlreadyExists$Message": null,
"StreamingDistributionConfig$CallerReference": "<p>A unique number that ensures that the request can't be replayed. If the <code>CallerReference</code> is new (no matter the content of the <code>StreamingDistributionConfig</code> object), a new streaming distribution is created. If the <code>CallerReference</code> is a value that you already sent in a previous request to create a streaming distribution, and the content of the <code>StreamingDistributionConfig</code> is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the <code>CallerReference</code> is a value that you already sent in a previous request to create a streaming distribution but the content of the <code>StreamingDistributionConfig</code> is different from the original request, CloudFront returns a <code>DistributionAlreadyExists</code> error. </p>",
"StreamingDistributionConfig$Comment": "<p>Any comments you want to include about the streaming distribution. </p>",
"StreamingDistributionList$Marker": "<p>The value you provided for the <code>Marker</code> request parameter. </p>",
"StreamingDistributionList$NextMarker": "<p>If <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value you can use for the <code>Marker</code> request parameter to continue listing your RTMP distributions where they left off. </p>",
"StreamingDistributionNotDisabled$Message": null,
"StreamingDistributionSummary$Id": "<p>The identifier for the distribution. For example: <code>EDFDVBD632BHDS5</code>.</p>",
"StreamingDistributionSummary$Id": "<p>The identifier for the distribution, for example, <code>EDFDVBD632BHDS5</code>.</p>",
"StreamingDistributionSummary$ARN": "<p> The ARN (Amazon Resource Name) for the streaming distribution. For example: <code>arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5</code>, where <code>123456789012</code> is your AWS account ID.</p>",
"StreamingDistributionSummary$Status": "<p> Indicates the current status of the distribution. When the status is <code>Deployed</code>, the distribution's information is fully propagated throughout the Amazon CloudFront system.</p>",
"StreamingDistributionSummary$DomainName": "<p>The domain name corresponding to the distribution. For example: <code>d604721fxaaqy9.cloudfront.net</code>.</p>",
"StreamingDistributionSummary$DomainName": "<p>The domain name corresponding to the distribution, for example, <code>d111111abcdef8.cloudfront.net</code>.</p>",
"StreamingDistributionSummary$Comment": "<p>The comment originally specified when this distribution was created.</p>",
"StreamingLoggingConfig$Bucket": "<p>The Amazon S3 bucket to store the access logs in, for example, <code>myawslogbucket.s3.amazonaws.com</code>.</p>",
"StreamingLoggingConfig$Prefix": "<p>An optional string that you want CloudFront to prefix to the access log <code>filenames</code> for this streaming distribution, for example, <code>myprefix/</code>. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty <code>Prefix</code> element in the <code>Logging</code> element.</p>",
"StreamingLoggingConfig$Prefix": "<p>An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, <code>myprefix/</code>. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty <code>Prefix</code> element in the <code>Logging</code> element.</p>",
"TooManyCacheBehaviors$Message": null,
"TooManyCertificates$Message": null,
"TooManyCloudFrontOriginAccessIdentities$Message": null,
@ -1429,9 +1442,9 @@
"UpdateStreamingDistributionRequest$Id": "<p>The streaming distribution's id.</p>",
"UpdateStreamingDistributionRequest$IfMatch": "<p>The value of the <code>ETag</code> header that you received when retrieving the streaming distribution's configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"UpdateStreamingDistributionResult$ETag": "<p>The current version of the configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
"ViewerCertificate$IAMCertificateId": null,
"ViewerCertificate$ACMCertificateArn": null,
"ViewerCertificate$Certificate": "<p>Include one of these values to specify the following:</p> <ul> <li> <p>Whether you want viewers to use HTTP or HTTPS to request your objects.</p> </li> <li> <p>If you want viewers to use HTTPS, whether you're using an alternate domain name such as example.com or the CloudFront domain name for your distribution, such as <code>d111111abcdef8.cloudfront.net</code>.</p> </li> <li> <p>If you're using an alternate domain name, whether AWS Certificate Manager (ACM) provided the certificate, or you purchased a certificate from a third-party certificate authority and imported it into ACM or uploaded it to the IAM certificate store.</p> </li> </ul> <p>You must specify one (and only one) of the three values. Do not specify <code>false</code> for <code>CloudFrontDefaultCertificate</code>.</p> <p> <b>If you want viewers to use HTTP to request your objects</b>: Specify the following value:</p> <p> <code>&lt;CloudFrontDefaultCertificate&gt;true&lt;CloudFrontDefaultCertificate&gt;</code> </p> <p>In addition, specify <code>allow-all</code> for <code>ViewerProtocolPolicy</code> for all of your cache behaviors.</p> <p> <b>If you want viewers to use HTTPS to request your objects</b>: Choose the type of certificate that you want to use based on whether you're using an alternate domain name for your objects or the CloudFront domain name:</p> <ul> <li> <p> <b>If you're using an alternate domain name, such as example.com</b>: Specify one of the following values, depending on whether ACM provided your certificate or you purchased your certificate from third-party certificate authority:</p> <ul> <li> <p> <code>&lt;ACMCertificateArn&gt;ARN for ACM SSL/TLS certificate&lt;ACMCertificateArn&gt;</code> where ARN for ACM SSL/TLS certificate is the ARN for the ACM SSL/TLS certificate that you want to use for this distribution.</p> </li> <li> <p> <code>&lt;IAMCertificateId&gt;IAM certificate ID&lt;IAMCertificateId&gt;</code> where IAM certificate ID is the ID that IAM returned when you added the certificate to the IAM certificate store.</p> </li> </ul> <p>If you specify <code>ACMCertificateArn</code> or <code>IAMCertificateId</code>, you must also specify a value for <code>SSLSupportMethod</code>.</p> <p>If you choose to use an ACM certificate or a certificate in the IAM certificate store, we recommend that you use only an alternate domain name in your object URLs (<code>https://example.com/logo.jpg</code>). If you use the domain name that is associated with your CloudFront distribution (<code>https://d111111abcdef8.cloudfront.net/logo.jpg</code>) and the viewer supports <code>SNI</code>, then CloudFront behaves normally. However, if the browser does not support SNI, the user's experience depends on the value that you choose for <code>SSLSupportMethod</code>:</p> <ul> <li> <p> <code>vip</code>: The viewer displays a warning because there is a mismatch between the CloudFront domain name and the domain name in your SSL/TLS certificate.</p> </li> <li> <p> <code>sni-only</code>: CloudFront drops the connection with the browser without returning the object.</p> </li> </ul> </li> <li> <p> <b>If you're using the CloudFront domain name for your distribution, such as <code>d111111abcdef8.cloudfront.net</code> </b>: Specify the following value:</p> <p> <code> &lt;CloudFrontDefaultCertificate&gt;true&lt;CloudFrontDefaultCertificate&gt; </code> </p> <p>If you want viewers to use HTTPS, you must also specify one of the following values in your cache behaviors:</p> <ul> <li> <p> <code> &lt;ViewerProtocolPolicy&gt;https-only&lt;ViewerProtocolPolicy&gt; </code> </p> </li> <li> <p> <code> &lt;ViewerProtocolPolicy&gt;redirect-to-https&lt;ViewerProtocolPolicy&gt; </code> </p> </li> </ul> <p>You can also optionally require that CloudFront use HTTPS to communicate with your origin by specifying one of the following values for the applicable origins:</p> <ul> <li> <p> <code> &lt;OriginProtocolPolicy&gt;https-only&lt;OriginProtocolPolicy&gt; </code> </p> </li> <li> <p> <code> &lt;OriginProtocolPolicy&gt;match-viewer&lt;OriginProtocolPolicy&gt; </code> </p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html#CNAMEsAndHTTPS\">Using Alternate Domain Names and HTTPS</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> </li> </ul>"
"ViewerCertificate$IAMCertificateId": "<p>For information about how and when to use <code>IAMCertificateId</code>, see <a>ViewerCertificate</a>.</p>",
"ViewerCertificate$ACMCertificateArn": "<p>For information about how and when to use <code>ACMCertificateArn</code>, see <a>ViewerCertificate</a>.</p>",
"ViewerCertificate$Certificate": "<p>This field has been deprecated. Use one of the following fields instead:</p> <ul> <li> <p> <a>ViewerCertificate$ACMCertificateArn</a> </p> </li> <li> <p> <a>ViewerCertificate$IAMCertificateId</a> </p> </li> <li> <p> <a>ViewerCertificate$CloudFrontDefaultCertificate</a> </p> </li> </ul>"
}
},
"timestamp": {

View File

@ -7,6 +7,7 @@
"protocol":"json",
"serviceAbbreviation":"CloudHSM",
"serviceFullName":"Amazon CloudHSM",
"serviceId":"CloudHSM",
"signatureVersion":"v4",
"targetPrefix":"CloudHsmFrontendService",
"uid":"cloudhsm-2014-05-30"

View File

@ -1,27 +1,27 @@
{
"version": "2.0",
"service": "<fullname>AWS CloudHSM Service</fullname>",
"service": "<fullname>AWS CloudHSM Service</fullname> <p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p>",
"operations": {
"AddTagsToResource": "<p>Adds or overwrites one or more tags for the specified AWS CloudHSM resource.</p> <p>Each tag consists of a key and a value. Tag keys must be unique to each resource.</p>",
"CreateHapg": "<p>Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.</p>",
"CreateHsm": "<p>Creates an uninitialized HSM instance.</p> <p>There is an upfront fee charged for each HSM instance that you create with the <a>CreateHsm</a> operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the <a>DeleteHsm</a> operation, go to the <a href=\"https://console.aws.amazon.com/support/home#/\">AWS Support Center</a>, create a new case, and select <b>Account and Billing Support</b>.</p> <important> <p>It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the <a>DescribeHsm</a> operation. The HSM is ready to be initialized when the status changes to <code>RUNNING</code>.</p> </important>",
"CreateLunaClient": "<p>Creates an HSM client.</p>",
"DeleteHapg": "<p>Deletes a high-availability partition group.</p>",
"DeleteHsm": "<p>Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.</p>",
"DeleteLunaClient": "<p>Deletes a client.</p>",
"DescribeHapg": "<p>Retrieves information about a high-availability partition group.</p>",
"DescribeHsm": "<p>Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.</p>",
"DescribeLunaClient": "<p>Retrieves information about an HSM client.</p>",
"GetConfig": "<p>Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.</p>",
"ListAvailableZones": "<p>Lists the Availability Zones that have available AWS CloudHSM capacity.</p>",
"ListHapgs": "<p>Lists the high-availability partition groups for the account.</p> <p>This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListHapgs</a> to retrieve the next set of items.</p>",
"ListHsms": "<p>Retrieves the identifiers of all of the HSMs provisioned for the current customer.</p> <p>This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListHsms</a> to retrieve the next set of items.</p>",
"ListLunaClients": "<p>Lists all of the clients.</p> <p>This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListLunaClients</a> to retrieve the next set of items.</p>",
"ListTagsForResource": "<p>Returns a list of all tags for the specified AWS CloudHSM resource.</p>",
"ModifyHapg": "<p>Modifies an existing high-availability partition group.</p>",
"ModifyHsm": "<p>Modifies an HSM.</p> <important> <p>This operation can result in the HSM being offline for up to 15 minutes while the AWS CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure that your AWS CloudHSM service is configured for high availability, and consider executing this operation during a maintenance window.</p> </important>",
"ModifyLunaClient": "<p>Modifies the certificate used by the client.</p> <p>This action can potentially start a workflow to install the new certificate on the client's HSMs.</p>",
"RemoveTagsFromResource": "<p>Removes one or more tags from the specified AWS CloudHSM resource.</p> <p>To remove a tag, specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use <a>AddTagsToResource</a>.</p>"
"AddTagsToResource": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Adds or overwrites one or more tags for the specified AWS CloudHSM resource.</p> <p>Each tag consists of a key and a value. Tag keys must be unique to each resource.</p>",
"CreateHapg": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.</p>",
"CreateHsm": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Creates an uninitialized HSM instance.</p> <p>There is an upfront fee charged for each HSM instance that you create with the <code>CreateHsm</code> operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the <a>DeleteHsm</a> operation, go to the <a href=\"https://console.aws.amazon.com/support/home\">AWS Support Center</a>, create a new case, and select <b>Account and Billing Support</b>.</p> <important> <p>It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the <a>DescribeHsm</a> operation. The HSM is ready to be initialized when the status changes to <code>RUNNING</code>.</p> </important>",
"CreateLunaClient": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Creates an HSM client.</p>",
"DeleteHapg": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Deletes a high-availability partition group.</p>",
"DeleteHsm": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.</p>",
"DeleteLunaClient": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Deletes a client.</p>",
"DescribeHapg": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Retrieves information about a high-availability partition group.</p>",
"DescribeHsm": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.</p>",
"DescribeLunaClient": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Retrieves information about an HSM client.</p>",
"GetConfig": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.</p>",
"ListAvailableZones": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Lists the Availability Zones that have available AWS CloudHSM capacity.</p>",
"ListHapgs": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Lists the high-availability partition groups for the account.</p> <p>This operation supports pagination with the use of the <code>NextToken</code> member. If more results are available, the <code>NextToken</code> member of the response contains a token that you pass in the next call to <code>ListHapgs</code> to retrieve the next set of items.</p>",
"ListHsms": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Retrieves the identifiers of all of the HSMs provisioned for the current customer.</p> <p>This operation supports pagination with the use of the <code>NextToken</code> member. If more results are available, the <code>NextToken</code> member of the response contains a token that you pass in the next call to <code>ListHsms</code> to retrieve the next set of items.</p>",
"ListLunaClients": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Lists all of the clients.</p> <p>This operation supports pagination with the use of the <code>NextToken</code> member. If more results are available, the <code>NextToken</code> member of the response contains a token that you pass in the next call to <code>ListLunaClients</code> to retrieve the next set of items.</p>",
"ListTagsForResource": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Returns a list of all tags for the specified AWS CloudHSM resource.</p>",
"ModifyHapg": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Modifies an existing high-availability partition group.</p>",
"ModifyHsm": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Modifies an HSM.</p> <important> <p>This operation can result in the HSM being offline for up to 15 minutes while the AWS CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure that your AWS CloudHSM service is configured for high availability, and consider executing this operation during a maintenance window.</p> </important>",
"ModifyLunaClient": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Modifies the certificate used by the client.</p> <p>This action can potentially start a workflow to install the new certificate on the client's HSMs.</p>",
"RemoveTagsFromResource": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Removes one or more tags from the specified AWS CloudHSM resource.</p> <p>To remove a tag, specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use <a>AddTagsToResource</a>.</p>"
},
"shapes": {
"AZ": {
@ -132,12 +132,12 @@
}
},
"CreateHsmRequest": {
"base": "<p>Contains the inputs for the <a>CreateHsm</a> operation.</p>",
"base": "<p>Contains the inputs for the <code>CreateHsm</code> operation.</p>",
"refs": {
}
},
"CreateHsmResponse": {
"base": "<p>Contains the output of the <a>CreateHsm</a> operation.</p>",
"base": "<p>Contains the output of the <code>CreateHsm</code> operation.</p>",
"refs": {
}
},
@ -192,7 +192,7 @@
}
},
"DescribeHsmRequest": {
"base": "<p>Contains the inputs for the <a>DescribeHsm</a> operation. </p>",
"base": "<p>Contains the inputs for the <a>DescribeHsm</a> operation.</p>",
"refs": {
}
},
@ -220,7 +220,7 @@
"ExternalId": {
"base": null,
"refs": {
"CreateHsmRequest$ExternalId": "<p>The external ID from <b>IamRoleArn</b>, if present.</p>",
"CreateHsmRequest$ExternalId": "<p>The external ID from <code>IamRoleArn</code>, if present.</p>",
"ModifyHsmRequest$ExternalId": "<p>The new external ID.</p>"
}
},
@ -258,7 +258,7 @@
"refs": {
"CreateHsmResponse$HsmArn": "<p>The ARN of the HSM.</p>",
"DeleteHsmRequest$HsmArn": "<p>The ARN of the HSM to delete.</p>",
"DescribeHsmRequest$HsmArn": "<p>The ARN of the HSM. Either the <i>HsmArn</i> or the <i>SerialNumber</i> parameter must be specified.</p>",
"DescribeHsmRequest$HsmArn": "<p>The ARN of the HSM. Either the <code>HsmArn</code> or the <code>SerialNumber</code> parameter must be specified.</p>",
"DescribeHsmResponse$HsmArn": "<p>The ARN of the HSM.</p>",
"HsmList$member": null,
"ModifyHsmRequest$HsmArn": "<p>The ARN of the HSM to modify.</p>",
@ -268,16 +268,16 @@
"HsmList": {
"base": "<p>Contains a list of ARNs that identify the HSMs.</p>",
"refs": {
"DescribeHapgResponse$HsmsLastActionFailed": null,
"DescribeHapgResponse$HsmsPendingDeletion": null,
"DescribeHapgResponse$HsmsPendingRegistration": null,
"DescribeHapgResponse$HsmsLastActionFailed": "<p/>",
"DescribeHapgResponse$HsmsPendingDeletion": "<p/>",
"DescribeHapgResponse$HsmsPendingRegistration": "<p/>",
"ListHsmsResponse$HsmList": "<p>The list of ARNs that identify the HSMs.</p>"
}
},
"HsmSerialNumber": {
"base": null,
"refs": {
"DescribeHsmRequest$HsmSerialNumber": "<p>The serial number of the HSM. Either the <i>HsmArn</i> or the <i>HsmSerialNumber</i> parameter must be specified.</p>",
"DescribeHsmRequest$HsmSerialNumber": "<p>The serial number of the HSM. Either the <code>HsmArn</code> or the <code>HsmSerialNumber</code> parameter must be specified.</p>",
"DescribeHsmResponse$SerialNumber": "<p>The serial number of the HSM.</p>"
}
},
@ -345,7 +345,7 @@
}
},
"ListHsmsResponse": {
"base": "<p>Contains the output of the <a>ListHsms</a> operation.</p>",
"base": "<p>Contains the output of the <code>ListHsms</code> operation.</p>",
"refs": {
}
},
@ -402,12 +402,12 @@
"PaginationToken": {
"base": null,
"refs": {
"ListHapgsRequest$NextToken": "<p>The <i>NextToken</i> value from a previous call to <a>ListHapgs</a>. Pass null if this is the first call.</p>",
"ListHapgsResponse$NextToken": "<p>If not null, more results are available. Pass this value to <a>ListHapgs</a> to retrieve the next set of items.</p>",
"ListHsmsRequest$NextToken": "<p>The <i>NextToken</i> value from a previous call to <a>ListHsms</a>. Pass null if this is the first call.</p>",
"ListHsmsResponse$NextToken": "<p>If not null, more results are available. Pass this value to <a>ListHsms</a> to retrieve the next set of items.</p>",
"ListLunaClientsRequest$NextToken": "<p>The <i>NextToken</i> value from a previous call to <a>ListLunaClients</a>. Pass null if this is the first call.</p>",
"ListLunaClientsResponse$NextToken": "<p>If not null, more results are available. Pass this to <a>ListLunaClients</a> to retrieve the next set of items.</p>"
"ListHapgsRequest$NextToken": "<p>The <code>NextToken</code> value from a previous call to <code>ListHapgs</code>. Pass null if this is the first call.</p>",
"ListHapgsResponse$NextToken": "<p>If not null, more results are available. Pass this value to <code>ListHapgs</code> to retrieve the next set of items.</p>",
"ListHsmsRequest$NextToken": "<p>The <code>NextToken</code> value from a previous call to <code>ListHsms</code>. Pass null if this is the first call.</p>",
"ListHsmsResponse$NextToken": "<p>If not null, more results are available. Pass this value to <code>ListHsms</code> to retrieve the next set of items.</p>",
"ListLunaClientsRequest$NextToken": "<p>The <code>NextToken</code> value from a previous call to <code>ListLunaClients</code>. Pass null if this is the first call.</p>",
"ListLunaClientsResponse$NextToken": "<p>If not null, more results are available. Pass this to <code>ListLunaClients</code> to retrieve the next set of items.</p>"
}
},
"PartitionArn": {
@ -484,7 +484,7 @@
}
},
"SubscriptionType": {
"base": "<p>Specifies the type of subscription for the HSM.</p> <ul> <li><b>PRODUCTION</b> - The HSM is being used in a production environment.</li> <li><b>TRIAL</b> - The HSM is being used in a product trial.</li> </ul>",
"base": "<p>Specifies the type of subscription for the HSM.</p> <ul> <li> <p> <b>PRODUCTION</b> - The HSM is being used in a production environment.</p> </li> <li> <p> <b>TRIAL</b> - The HSM is being used in a product trial.</p> </li> </ul>",
"refs": {
"CreateHsmRequest$SubscriptionType": null,
"DescribeHsmResponse$SubscriptionType": null

View File

@ -0,0 +1,4 @@
{
"pagination": {
}
}

View File

@ -54,8 +54,8 @@
"Certificates$AwsHardwareCertificate": "<p>The HSM hardware certificate issued (signed) by AWS CloudHSM.</p>",
"Certificates$ManufacturerHardwareCertificate": "<p>The HSM hardware certificate issued (signed) by the hardware manufacturer.</p>",
"Certificates$ClusterCertificate": "<p>The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.</p>",
"InitializeClusterRequest$SignedCert": "<p>The cluster certificate issued (signed) by your issuing certificate authority (CA). The certificate must be in PEM format.</p>",
"InitializeClusterRequest$TrustAnchor": "<p>The issuing certificate of the issuing certificate authority (CA) that issued (signed) the cluster certificate. This can be a root (self-signed) certificate or a certificate chain that begins with the certificate that issued the cluster certificate and ends with a root certificate. The certificate or certificate chain must be in PEM format.</p>"
"InitializeClusterRequest$SignedCert": "<p>The cluster certificate issued (signed) by your issuing certificate authority (CA). The certificate must be in PEM format and can contain a maximum of 5000 characters.</p>",
"InitializeClusterRequest$TrustAnchor": "<p>The issuing certificate of the issuing certificate authority (CA) that issued (signed) the cluster certificate. This can be a root (self-signed) certificate or a certificate chain that begins with the certificate that issued the cluster certificate and ends with a root certificate. The certificate or certificate chain must be in PEM format and can contain a maximum of 5000 characters.</p>"
}
},
"Certificates": {

View File

@ -102,6 +102,19 @@
{"shape":"OAuthProviderException"}
]
},
"InvalidateProjectCache":{
"name":"InvalidateProjectCache",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"InvalidateProjectCacheInput"},
"output":{"shape":"InvalidateProjectCacheOutput"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
]
},
"ListBuilds":{
"name":"ListBuilds",
"http":{
@ -275,11 +288,14 @@
"phases":{"shape":"BuildPhases"},
"source":{"shape":"ProjectSource"},
"artifacts":{"shape":"BuildArtifacts"},
"cache":{"shape":"ProjectCache"},
"environment":{"shape":"ProjectEnvironment"},
"logs":{"shape":"LogsLocation"},
"timeoutInMinutes":{"shape":"WrapperInt"},
"buildComplete":{"shape":"Boolean"},
"initiator":{"shape":"String"}
"initiator":{"shape":"String"},
"vpcConfig":{"shape":"VpcConfig"},
"networkInterface":{"shape":"NetworkInterface"}
}
},
"BuildArtifacts":{
@ -341,6 +357,13 @@
"type":"list",
"member":{"shape":"BuildNotDeleted"}
},
"CacheType":{
"type":"string",
"enum":[
"NO_CACHE",
"S3"
]
},
"ComputeType":{
"type":"string",
"enum":[
@ -362,11 +385,14 @@
"description":{"shape":"ProjectDescription"},
"source":{"shape":"ProjectSource"},
"artifacts":{"shape":"ProjectArtifacts"},
"cache":{"shape":"ProjectCache"},
"environment":{"shape":"ProjectEnvironment"},
"serviceRole":{"shape":"NonEmptyString"},
"timeoutInMinutes":{"shape":"TimeOut"},
"encryptionKey":{"shape":"NonEmptyString"},
"tags":{"shape":"TagList"}
"tags":{"shape":"TagList"},
"vpcConfig":{"shape":"VpcConfig"},
"badgeEnabled":{"shape":"WrapperBoolean"}
}
},
"CreateProjectOutput":{
@ -416,7 +442,8 @@
"type":"structure",
"members":{
"name":{"shape":"String"},
"description":{"shape":"String"}
"description":{"shape":"String"},
"versions":{"shape":"ImageVersions"}
}
},
"EnvironmentImages":{
@ -472,12 +499,28 @@
"type":"list",
"member":{"shape":"EnvironmentVariable"}
},
"ImageVersions":{
"type":"list",
"member":{"shape":"String"}
},
"InvalidInputException":{
"type":"structure",
"members":{
},
"exception":true
},
"InvalidateProjectCacheInput":{
"type":"structure",
"required":["projectName"],
"members":{
"projectName":{"shape":"NonEmptyString"}
}
},
"InvalidateProjectCacheOutput":{
"type":"structure",
"members":{
}
},
"KeyInput":{
"type":"string",
"max":127,
@ -562,6 +605,13 @@
"deepLink":{"shape":"String"}
}
},
"NetworkInterface":{
"type":"structure",
"members":{
"subnetId":{"shape":"NonEmptyString"},
"networkInterfaceId":{"shape":"NonEmptyString"}
}
},
"NonEmptyString":{
"type":"string",
"min":1
@ -599,6 +649,7 @@
"description":{"shape":"ProjectDescription"},
"source":{"shape":"ProjectSource"},
"artifacts":{"shape":"ProjectArtifacts"},
"cache":{"shape":"ProjectCache"},
"environment":{"shape":"ProjectEnvironment"},
"serviceRole":{"shape":"NonEmptyString"},
"timeoutInMinutes":{"shape":"TimeOut"},
@ -606,7 +657,9 @@
"tags":{"shape":"TagList"},
"created":{"shape":"Timestamp"},
"lastModified":{"shape":"Timestamp"},
"webhook":{"shape":"Webhook"}
"webhook":{"shape":"Webhook"},
"vpcConfig":{"shape":"VpcConfig"},
"badge":{"shape":"ProjectBadge"}
}
},
"ProjectArtifacts":{
@ -621,6 +674,21 @@
"packaging":{"shape":"ArtifactPackaging"}
}
},
"ProjectBadge":{
"type":"structure",
"members":{
"badgeEnabled":{"shape":"Boolean"},
"badgeRequestUrl":{"shape":"String"}
}
},
"ProjectCache":{
"type":"structure",
"required":["type"],
"members":{
"type":{"shape":"CacheType"},
"location":{"shape":"String"}
}
},
"ProjectDescription":{
"type":"string",
"max":255,
@ -687,6 +755,11 @@
},
"exception":true
},
"SecurityGroupIds":{
"type":"list",
"member":{"shape":"NonEmptyString"},
"max":5
},
"SortOrderType":{
"type":"string",
"enum":[
@ -759,6 +832,11 @@
}
},
"String":{"type":"string"},
"Subnets":{
"type":"list",
"member":{"shape":"NonEmptyString"},
"max":16
},
"Tag":{
"type":"structure",
"members":{
@ -786,11 +864,14 @@
"description":{"shape":"ProjectDescription"},
"source":{"shape":"ProjectSource"},
"artifacts":{"shape":"ProjectArtifacts"},
"cache":{"shape":"ProjectCache"},
"environment":{"shape":"ProjectEnvironment"},
"serviceRole":{"shape":"NonEmptyString"},
"timeoutInMinutes":{"shape":"TimeOut"},
"encryptionKey":{"shape":"NonEmptyString"},
"tags":{"shape":"TagList"}
"tags":{"shape":"TagList"},
"vpcConfig":{"shape":"VpcConfig"},
"badgeEnabled":{"shape":"WrapperBoolean"}
}
},
"UpdateProjectOutput":{
@ -805,6 +886,14 @@
"min":1,
"pattern":"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=@+\\\\-]*)$"
},
"VpcConfig":{
"type":"structure",
"members":{
"vpcId":{"shape":"NonEmptyString"},
"subnets":{"shape":"Subnets"},
"securityGroupIds":{"shape":"SecurityGroupIds"}
}
},
"Webhook":{
"type":"structure",
"members":{

View File

@ -9,6 +9,7 @@
"CreateWebhook": "<p>For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository.</p> <important> <p>If you enable webhooks for an AWS CodeBuild project, and the project is used as a build step in AWS CodePipeline, then two identical builds will be created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you will be billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in CodeBuild. In the AWS CodeBuild console, clear the Webhook box. For more information, see step 9 in <a href=\"http://docs.aws.amazon.com/codebuild/latest/userguide/change-project.html#change-project-console\">Change a Build Projects Settings</a>.</p> </important>",
"DeleteProject": "<p>Deletes a build project.</p>",
"DeleteWebhook": "<p>For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, stops AWS CodeBuild from automatically rebuilding the source code every time a code change is pushed to the repository.</p>",
"InvalidateProjectCache": "<p>Resets the cache for a project.</p>",
"ListBuilds": "<p>Gets a list of build IDs, with each build ID representing a single build.</p>",
"ListBuildsForProject": "<p>Gets a list of build IDs for the specified build project, with each build ID representing a single build.</p>",
"ListCuratedEnvironmentImages": "<p>Gets information about Docker images that are managed by AWS CodeBuild.</p>",
@ -74,7 +75,8 @@
"Boolean": {
"base": null,
"refs": {
"Build$buildComplete": "<p>Whether the build has finished. True if completed; otherwise, false.</p>"
"Build$buildComplete": "<p>Whether the build has finished. True if completed; otherwise, false.</p>",
"ProjectBadge$badgeEnabled": "<p>Set this to true to generate a publicly-accessible URL for your project's build badge.</p>"
}
},
"Build": {
@ -138,6 +140,12 @@
"BatchDeleteBuildsOutput$buildsNotDeleted": "<p>Information about any builds that could not be successfully deleted.</p>"
}
},
"CacheType": {
"base": null,
"refs": {
"ProjectCache$type": "<p>The type of cache used by the build project. Valid values include:</p> <ul> <li> <p> <code>NO_CACHE</code>: The build project will not use any cache.</p> </li> <li> <p> <code>S3</code>: The build project will read and write from/to S3.</p> </li> </ul>"
}
},
"ComputeType": {
"base": null,
"refs": {
@ -245,11 +253,27 @@
"StartBuildInput$environmentVariablesOverride": "<p>A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.</p>"
}
},
"ImageVersions": {
"base": null,
"refs": {
"EnvironmentImage$versions": "<p>A list of environment image versions.</p>"
}
},
"InvalidInputException": {
"base": "<p>The input value that was provided is not valid.</p>",
"refs": {
}
},
"InvalidateProjectCacheInput": {
"base": null,
"refs": {
}
},
"InvalidateProjectCacheOutput": {
"base": null,
"refs": {
}
},
"KeyInput": {
"base": null,
"refs": {
@ -308,6 +332,12 @@
"Build$logs": "<p>Information about the build's logs in Amazon CloudWatch Logs.</p>"
}
},
"NetworkInterface": {
"base": "<p>Describes a network interface.</p>",
"refs": {
"Build$networkInterface": "<p>Describes a network interface.</p>"
}
},
"NonEmptyString": {
"base": null,
"refs": {
@ -321,17 +351,23 @@
"CreateProjectInput$encryptionKey": "<p>The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.</p> <p>You can specify either the CMK's Amazon Resource Name (ARN) or, if available, the CMK's alias (using the format <code>alias/<i>alias-name</i> </code>).</p>",
"DeleteProjectInput$name": "<p>The name of the build project.</p>",
"EnvironmentVariable$name": "<p>The name or key of the environment variable.</p>",
"InvalidateProjectCacheInput$projectName": "<p>The name of the build project that the cache will be reset for.</p>",
"ListBuildsForProjectInput$projectName": "<p>The name of the build project.</p>",
"ListProjectsInput$nextToken": "<p>During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a <i>next token</i>. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.</p>",
"NetworkInterface$subnetId": "<p>The ID of the subnet.</p>",
"NetworkInterface$networkInterfaceId": "<p>The ID of the network interface.</p>",
"Project$serviceRole": "<p>The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.</p>",
"Project$encryptionKey": "<p>The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.</p> <p>This is expressed either as the CMK's Amazon Resource Name (ARN) or, if specified, the CMK's alias (using the format <code>alias/<i>alias-name</i> </code>).</p>",
"ProjectEnvironment$image": "<p>The ID of the Docker image to use for this build project.</p>",
"ProjectNames$member": null,
"SecurityGroupIds$member": null,
"StartBuildInput$projectName": "<p>The name of the build project to start running a build.</p>",
"StopBuildInput$id": "<p>The ID of the build.</p>",
"Subnets$member": null,
"UpdateProjectInput$name": "<p>The name of the build project.</p> <note> <p>You cannot change a build project's name.</p> </note>",
"UpdateProjectInput$serviceRole": "<p>The replacement ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.</p>",
"UpdateProjectInput$encryptionKey": "<p>The replacement AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.</p> <p>You can specify either the CMK's Amazon Resource Name (ARN) or, if available, the CMK's alias (using the format <code>alias/<i>alias-name</i> </code>).</p>",
"VpcConfig$vpcId": "<p>The ID of the Amazon VPC.</p>",
"Webhook$url": "<p>The URL to the webhook.</p>"
}
},
@ -375,6 +411,21 @@
"UpdateProjectInput$artifacts": "<p>Information to be changed about the build output artifacts for the build project.</p>"
}
},
"ProjectBadge": {
"base": "<p>Information about the build badge for the build project.</p>",
"refs": {
"Project$badge": "<p>Information about the build badge for the build project.</p>"
}
},
"ProjectCache": {
"base": "<p>Information about the cache for the build project.</p>",
"refs": {
"Build$cache": "<p>Information about the cache for the build.</p>",
"CreateProjectInput$cache": "<p>Stores recently used information so that it can be quickly accessed at a later time.</p>",
"Project$cache": "<p>Information about the cache for the build project.</p>",
"UpdateProjectInput$cache": "<p>Stores recently used information so that it can be quickly accessed at a later time.</p>"
}
},
"ProjectDescription": {
"base": null,
"refs": {
@ -440,6 +491,12 @@
"refs": {
}
},
"SecurityGroupIds": {
"base": null,
"refs": {
"VpcConfig$securityGroupIds": "<p>A list of one or more security groups IDs in your Amazon VPC.</p>"
}
},
"SortOrderType": {
"base": null,
"refs": {
@ -505,6 +562,7 @@
"EnvironmentImage$name": "<p>The name of the Docker image.</p>",
"EnvironmentImage$description": "<p>The description of the Docker image.</p>",
"EnvironmentVariable$value": "<p>The value of the environment variable.</p> <important> <p>We strongly discourage using environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. Environment variables can be displayed in plain text using tools such as the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI).</p> </important>",
"ImageVersions$member": null,
"ListBuildsForProjectInput$nextToken": "<p>During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a <i>next token</i>. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.</p>",
"ListBuildsForProjectOutput$nextToken": "<p>If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a <i>next token</i>. To get the next batch of items in the list, call this operation again, adding the next token to the call.</p>",
"ListBuildsInput$nextToken": "<p>During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a <i>next token</i>. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.</p>",
@ -519,6 +577,8 @@
"ProjectArtifacts$location": "<p>Information about the build output artifact location, as follows:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, then this value will be ignored if specified, because no build output will be produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the name of the output bucket.</p> </li> </ul>",
"ProjectArtifacts$path": "<p>Along with <code>namespaceType</code> and <code>name</code>, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, then this value will be ignored if specified, because no build output will be produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the path to the output artifact. If <code>path</code> is not specified, then <code>path</code> will not be used.</p> </li> </ul> <p>For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, then the output artifact would be stored in the output bucket at <code>MyArtifacts/MyArtifact.zip</code>.</p>",
"ProjectArtifacts$name": "<p>Along with <code>path</code> and <code>namespaceType</code>, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, then this value will be ignored if specified, because no build output will be produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the name of the output artifact object.</p> </li> </ul> <p>For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, then the output artifact would be stored in <code>MyArtifacts/<i>build-ID</i>/MyArtifact.zip</code>.</p>",
"ProjectBadge$badgeRequestUrl": "<p>The publicly-accessible URL through which you can access the build badge for your project. </p>",
"ProjectCache$location": "<p>Information about the cache location, as follows: </p> <ul> <li> <p> <code>NO_CACHE</code>: This value will be ignored.</p> </li> <li> <p> <code>S3</code>: This is the S3 bucket name/prefix.</p> </li> </ul>",
"ProjectSource$location": "<p>Information about the location of the source code to be built. Valid values include:</p> <ul> <li> <p>For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, <code>location</code> should not be specified. If it is specified, AWS CodePipeline will ignore it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.</p> </li> <li> <p>For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, <code>https://git-codecommit.<i>region-ID</i>.amazonaws.com/v1/repos/<i>repo-name</i> </code>).</p> </li> <li> <p>For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, the path to the ZIP file that contains the source code (for example, <code> <i>bucket-name</i>/<i>path</i>/<i>to</i>/<i>object-name</i>.zip</code>)</p> </li> <li> <p>For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec. Also, you must connect your AWS account to your GitHub account. To do this, use the AWS CodeBuild console to begin creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub <b>Authorize application</b> page that displays, for <b>Organization access</b>, choose <b>Request access</b> next to each repository you want to allow AWS CodeBuild to have access to. Then choose <b>Authorize application</b>. (After you have connected to your GitHub account, you do not need to finish creating the build project, and you may then leave the AWS CodeBuild console.) To instruct AWS CodeBuild to then use this connection, in the <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>.</p> </li> <li> <p>For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec. Also, you must connect your AWS account to your Bitbucket account. To do this, use the AWS CodeBuild console to begin creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket <b>Confirm access to your account</b> page that displays, choose <b>Grant access</b>. (After you have connected to your Bitbucket account, you do not need to finish creating the build project, and you may then leave the AWS CodeBuild console.) To instruct AWS CodeBuild to then use this connection, in the <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>.</p> </li> </ul>",
"ProjectSource$buildspec": "<p>The build spec declaration to use for the builds in this build project.</p> <p>If this value is not specified, a build spec must be included along with the source code to be built.</p>",
"SourceAuth$resource": "<p>The resource value that applies to the specified authorization type.</p>",
@ -526,6 +586,12 @@
"StartBuildInput$buildspecOverride": "<p>A build spec declaration that overrides, for this build only, the latest one already defined in the build project.</p>"
}
},
"Subnets": {
"base": null,
"refs": {
"VpcConfig$subnets": "<p>A list of one or more subnet IDs in your Amazon VPC.</p>"
}
},
"Tag": {
"base": "<p>A tag, consisting of a key and a value.</p> <p>This tag is available for use by AWS services that support tags in AWS CodeBuild.</p>",
"refs": {
@ -576,6 +642,15 @@
"Tag$value": "<p>The tag's value.</p>"
}
},
"VpcConfig": {
"base": "<p>Information about the VPC configuration that AWS CodeBuild will access.</p>",
"refs": {
"Build$vpcConfig": "<p>If your AWS CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.</p>",
"CreateProjectInput$vpcConfig": "<p>VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.</p>",
"Project$vpcConfig": "<p>Information about the VPC configuration that AWS CodeBuild will access.</p>",
"UpdateProjectInput$vpcConfig": "<p>VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.</p>"
}
},
"Webhook": {
"base": "<p>Information about a webhook in GitHub that connects repository events to a build project in AWS CodeBuild.</p>",
"refs": {
@ -586,7 +661,9 @@
"WrapperBoolean": {
"base": null,
"refs": {
"ProjectEnvironment$privilegedMode": "<p>If set to true, enables running the Docker daemon inside a Docker container; otherwise, false or not specified (the default). This value must be set to true only if this build project will be used to build Docker images, and the specified build environment image is not one provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon will fail. Note that you must also start the Docker daemon so that your builds can interact with it as needed. One way to do this is to initialize the Docker daemon in the install phase of your build spec by running the following build commands. (Do not run the following build commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)</p> <p> <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&amp; - timeout -t 15 sh -c \"until docker info; do echo .; sleep 1; done\"</code> </p>"
"CreateProjectInput$badgeEnabled": "<p>Set this to true to generate a publicly-accessible URL for your project's build badge.</p>",
"ProjectEnvironment$privilegedMode": "<p>If set to true, enables running the Docker daemon inside a Docker container; otherwise, false or not specified (the default). This value must be set to true only if this build project will be used to build Docker images, and the specified build environment image is not one provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon will fail. Note that you must also start the Docker daemon so that your builds can interact with it as needed. One way to do this is to initialize the Docker daemon in the install phase of your build spec by running the following build commands. (Do not run the following build commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)</p> <p> <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&amp; - timeout -t 15 sh -c \"until docker info; do echo .; sleep 1; done\"</code> </p>",
"UpdateProjectInput$badgeEnabled": "<p>Set this to true to generate a publicly-accessible URL for your project's build badge.</p>"
}
},
"WrapperInt": {

File diff suppressed because it is too large Load Diff

File diff suppressed because one or more lines are too long

View File

@ -1,5 +1,20 @@
{
"pagination": {
"DescribePullRequestEvents": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken"
},
"GetCommentsForComparedCommit": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken"
},
"GetCommentsForPullRequest": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken"
},
"GetDifferences": {
"input_token": "NextToken",
"limit_key": "MaxResults",
@ -10,6 +25,11 @@
"output_token": "nextToken",
"result_key": "branches"
},
"ListPullRequests": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken"
},
"ListRepositories": {
"input_token": "nextToken",
"output_token": "nextToken",

View File

@ -7,6 +7,7 @@
"protocol":"json",
"serviceAbbreviation":"CodeDeploy",
"serviceFullName":"AWS CodeDeploy",
"serviceId":"CodeDeploy",
"signatureVersion":"v4",
"targetPrefix":"CodeDeploy_20141006",
"timestampFormat":"unixTimestamp",
@ -22,6 +23,7 @@
"input":{"shape":"AddTagsToOnPremisesInstancesInput"},
"errors":[
{"shape":"InstanceNameRequiredException"},
{"shape":"InvalidInstanceNameException"},
{"shape":"TagRequiredException"},
{"shape":"InvalidTagException"},
{"shape":"TagLimitExceededException"},
@ -151,7 +153,8 @@
{"shape":"ApplicationNameRequiredException"},
{"shape":"InvalidApplicationNameException"},
{"shape":"ApplicationAlreadyExistsException"},
{"shape":"ApplicationLimitExceededException"}
{"shape":"ApplicationLimitExceededException"},
{"shape":"InvalidComputePlatformException"}
]
},
"CreateDeployment":{
@ -179,7 +182,12 @@
{"shape":"InvalidTargetInstancesException"},
{"shape":"InvalidAutoRollbackConfigException"},
{"shape":"InvalidLoadBalancerInfoException"},
{"shape":"InvalidFileExistsBehaviorException"}
{"shape":"InvalidFileExistsBehaviorException"},
{"shape":"InvalidRoleException"},
{"shape":"InvalidAutoScalingGroupException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidUpdateOutdatedInstancesOnlyValueException"},
{"shape":"InvalidIgnoreApplicationStopFailuresValueException"}
]
},
"CreateDeploymentConfig":{
@ -195,7 +203,9 @@
{"shape":"DeploymentConfigNameRequiredException"},
{"shape":"DeploymentConfigAlreadyExistsException"},
{"shape":"InvalidMinimumHealthyHostValueException"},
{"shape":"DeploymentConfigLimitExceededException"}
{"shape":"DeploymentConfigLimitExceededException"},
{"shape":"InvalidComputePlatformException"},
{"shape":"InvalidTrafficRoutingConfigurationException"}
]
},
"CreateDeploymentGroup":{
@ -232,7 +242,8 @@
{"shape":"InvalidBlueGreenDeploymentConfigurationException"},
{"shape":"InvalidEC2TagCombinationException"},
{"shape":"InvalidOnPremisesTagCombinationException"},
{"shape":"TagSetListLimitExceededException"}
{"shape":"TagSetListLimitExceededException"},
{"shape":"InvalidInputException"}
]
},
"DeleteApplication":{
@ -277,6 +288,22 @@
{"shape":"InvalidRoleException"}
]
},
"DeleteGitHubAccountToken":{
"name":"DeleteGitHubAccountToken",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteGitHubAccountTokenInput"},
"output":{"shape":"DeleteGitHubAccountTokenOutput"},
"errors":[
{"shape":"GitHubAccountTokenNameRequiredException"},
{"shape":"GitHubAccountTokenDoesNotExistException"},
{"shape":"InvalidGitHubAccountTokenNameException"},
{"shape":"ResourceValidationException"},
{"shape":"OperationNotSupportedException"}
]
},
"DeregisterOnPremisesInstance":{
"name":"DeregisterOnPremisesInstance",
"http":{
@ -505,7 +532,8 @@
"output":{"shape":"ListGitHubAccountTokenNamesOutput"},
"errors":[
{"shape":"InvalidNextTokenException"},
{"shape":"ResourceValidationException"}
{"shape":"ResourceValidationException"},
{"shape":"OperationNotSupportedException"}
]
},
"ListOnPremisesInstances":{
@ -522,6 +550,24 @@
{"shape":"InvalidNextTokenException"}
]
},
"PutLifecycleEventHookExecutionStatus":{
"name":"PutLifecycleEventHookExecutionStatus",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutLifecycleEventHookExecutionStatusInput"},
"output":{"shape":"PutLifecycleEventHookExecutionStatusOutput"},
"errors":[
{"shape":"InvalidLifecycleEventHookExecutionStatusException"},
{"shape":"InvalidLifecycleEventHookExecutionIdException"},
{"shape":"LifecycleEventAlreadyCompletedException"},
{"shape":"DeploymentIdRequiredException"},
{"shape":"DeploymentDoesNotExistException"},
{"shape":"InvalidDeploymentIdException"},
{"shape":"UnsupportedActionForDeploymentTypeException"}
]
},
"RegisterApplicationRevision":{
"name":"RegisterApplicationRevision",
"http":{
@ -567,6 +613,7 @@
"input":{"shape":"RemoveTagsFromOnPremisesInstancesInput"},
"errors":[
{"shape":"InstanceNameRequiredException"},
{"shape":"InvalidInstanceNameException"},
{"shape":"TagRequiredException"},
{"shape":"InvalidTagException"},
{"shape":"TagLimitExceededException"},
@ -652,7 +699,8 @@
{"shape":"InvalidBlueGreenDeploymentConfigurationException"},
{"shape":"InvalidEC2TagCombinationException"},
{"shape":"InvalidOnPremisesTagCombinationException"},
{"shape":"TagSetListLimitExceededException"}
{"shape":"TagSetListLimitExceededException"},
{"shape":"InvalidInputException"}
]
}
},
@ -668,7 +716,10 @@
"instanceNames":{"shape":"InstanceNameList"}
}
},
"AdditionalDeploymentStatusInfo":{"type":"string"},
"AdditionalDeploymentStatusInfo":{
"type":"string",
"deprecated":true
},
"Alarm":{
"type":"structure",
"members":{
@ -714,7 +765,8 @@
"applicationName":{"shape":"ApplicationName"},
"createTime":{"shape":"Timestamp"},
"linkedToGitHub":{"shape":"Boolean"},
"gitHubAccountName":{"shape":"GitHubAccountTokenName"}
"gitHubAccountName":{"shape":"GitHubAccountTokenName"},
"computePlatform":{"shape":"ComputePlatform"}
}
},
"ApplicationLimitExceededException":{
@ -807,6 +859,7 @@
},
"BatchGetApplicationsInput":{
"type":"structure",
"required":["applicationNames"],
"members":{
"applicationNames":{"shape":"ApplicationsList"}
}
@ -855,6 +908,7 @@
},
"BatchGetDeploymentsInput":{
"type":"structure",
"required":["deploymentIds"],
"members":{
"deploymentIds":{"shape":"DeploymentsList"}
}
@ -867,6 +921,7 @@
},
"BatchGetOnPremisesInstancesInput":{
"type":"structure",
"required":["instanceNames"],
"members":{
"instanceNames":{"shape":"InstanceNameList"}
}
@ -910,10 +965,19 @@
"enum":[
"tar",
"tgz",
"zip"
"zip",
"YAML",
"JSON"
]
},
"CommitId":{"type":"string"},
"ComputePlatform":{
"type":"string",
"enum":[
"Server",
"Lambda"
]
},
"ContinueDeploymentInput":{
"type":"structure",
"members":{
@ -924,7 +988,8 @@
"type":"structure",
"required":["applicationName"],
"members":{
"applicationName":{"shape":"ApplicationName"}
"applicationName":{"shape":"ApplicationName"},
"computePlatform":{"shape":"ComputePlatform"}
}
},
"CreateApplicationOutput":{
@ -935,13 +1000,12 @@
},
"CreateDeploymentConfigInput":{
"type":"structure",
"required":[
"deploymentConfigName",
"minimumHealthyHosts"
],
"required":["deploymentConfigName"],
"members":{
"deploymentConfigName":{"shape":"DeploymentConfigName"},
"minimumHealthyHosts":{"shape":"MinimumHealthyHosts"}
"minimumHealthyHosts":{"shape":"MinimumHealthyHosts"},
"trafficRoutingConfig":{"shape":"TrafficRoutingConfig"},
"computePlatform":{"shape":"ComputePlatform"}
}
},
"CreateDeploymentConfigOutput":{
@ -1034,6 +1098,18 @@
"hooksNotCleanedUp":{"shape":"AutoScalingGroupList"}
}
},
"DeleteGitHubAccountTokenInput":{
"type":"structure",
"members":{
"tokenName":{"shape":"GitHubAccountTokenName"}
}
},
"DeleteGitHubAccountTokenOutput":{
"type":"structure",
"members":{
"tokenName":{"shape":"GitHubAccountTokenName"}
}
},
"DeploymentAlreadyCompletedException":{
"type":"structure",
"members":{
@ -1065,7 +1141,9 @@
"deploymentConfigId":{"shape":"DeploymentConfigId"},
"deploymentConfigName":{"shape":"DeploymentConfigName"},
"minimumHealthyHosts":{"shape":"MinimumHealthyHosts"},
"createTime":{"shape":"Timestamp"}
"createTime":{"shape":"Timestamp"},
"computePlatform":{"shape":"ComputePlatform"},
"trafficRoutingConfig":{"shape":"TrafficRoutingConfig"}
}
},
"DeploymentConfigLimitExceededException":{
@ -1137,7 +1215,8 @@
"lastSuccessfulDeployment":{"shape":"LastDeploymentInfo"},
"lastAttemptedDeployment":{"shape":"LastDeploymentInfo"},
"ec2TagSet":{"shape":"EC2TagSet"},
"onPremisesTagSet":{"shape":"OnPremisesTagSet"}
"onPremisesTagSet":{"shape":"OnPremisesTagSet"},
"computePlatform":{"shape":"ComputePlatform"}
}
},
"DeploymentGroupInfoList":{
@ -1199,7 +1278,9 @@
"blueGreenDeploymentConfiguration":{"shape":"BlueGreenDeploymentConfiguration"},
"loadBalancerInfo":{"shape":"LoadBalancerInfo"},
"additionalDeploymentStatusInfo":{"shape":"AdditionalDeploymentStatusInfo"},
"fileExistsBehavior":{"shape":"FileExistsBehavior"}
"fileExistsBehavior":{"shape":"FileExistsBehavior"},
"deploymentStatusMessages":{"shape":"DeploymentStatusMessageList"},
"computePlatform":{"shape":"ComputePlatform"}
}
},
"DeploymentIsNotInReadyStateException":{
@ -1268,6 +1349,10 @@
"type":"list",
"member":{"shape":"DeploymentStatus"}
},
"DeploymentStatusMessageList":{
"type":"list",
"member":{"shape":"ErrorMessage"}
},
"DeploymentStyle":{
"type":"structure",
"members":{
@ -1376,7 +1461,15 @@
"AGENT_ISSUE",
"AUTO_SCALING_IAM_ROLE_PERMISSIONS",
"AUTO_SCALING_CONFIGURATION",
"MANUAL_STOP"
"MANUAL_STOP",
"MISSING_BLUE_GREEN_DEPLOYMENT_CONFIGURATION",
"MISSING_ELB_INFORMATION",
"MISSING_GITHUB_TOKEN",
"ELASTIC_LOAD_BALANCING_INVALID",
"ELB_INVALID_INSTANCE",
"INVALID_LAMBDA_CONFIGURATION",
"INVALID_LAMBDA_FUNCTION",
"HOOK_EXECUTION_FAILURE"
]
},
"ErrorInformation":{
@ -1521,6 +1614,12 @@
"type":"list",
"member":{"shape":"GitHubAccountTokenName"}
},
"GitHubAccountTokenNameRequiredException":{
"type":"structure",
"members":{
},
"exception":true
},
"GitHubLocation":{
"type":"structure",
"members":{
@ -1716,6 +1815,12 @@
},
"exception":true
},
"InvalidComputePlatformException":{
"type":"structure",
"members":{
},
"exception":true
},
"InvalidDeployedStateFilterException":{
"type":"structure",
"members":{
@ -1776,6 +1881,12 @@
},
"exception":true
},
"InvalidGitHubAccountTokenNameException":{
"type":"structure",
"members":{
},
"exception":true
},
"InvalidIamSessionArnException":{
"type":"structure",
"members":{
@ -1788,6 +1899,24 @@
},
"exception":true
},
"InvalidIgnoreApplicationStopFailuresValueException":{
"type":"structure",
"members":{
},
"exception":true
},
"InvalidInputException":{
"type":"structure",
"members":{
},
"exception":true
},
"InvalidInstanceIdException":{
"type":"structure",
"members":{
},
"exception":true
},
"InvalidInstanceNameException":{
"type":"structure",
"members":{
@ -1812,6 +1941,18 @@
},
"exception":true
},
"InvalidLifecycleEventHookExecutionIdException":{
"type":"structure",
"members":{
},
"exception":true
},
"InvalidLifecycleEventHookExecutionStatusException":{
"type":"structure",
"members":{
},
"exception":true
},
"InvalidLoadBalancerInfoException":{
"type":"structure",
"members":{
@ -1896,12 +2037,24 @@
},
"exception":true
},
"InvalidTrafficRoutingConfigurationException":{
"type":"structure",
"members":{
},
"exception":true
},
"InvalidTriggerConfigException":{
"type":"structure",
"members":{
},
"exception":true
},
"InvalidUpdateOutdatedInstancesOnlyValueException":{
"type":"structure",
"members":{
},
"exception":true
},
"Key":{"type":"string"},
"LastDeploymentInfo":{
"type":"structure",
@ -1933,6 +2086,13 @@
"status":{"shape":"LifecycleEventStatus"}
}
},
"LifecycleEventAlreadyCompletedException":{
"type":"structure",
"members":{
},
"exception":true
},
"LifecycleEventHookExecutionId":{"type":"string"},
"LifecycleEventList":{
"type":"list",
"member":{"shape":"LifecycleEvent"}
@ -2130,6 +2290,36 @@
"type":"list",
"member":{"shape":"TagFilterList"}
},
"OperationNotSupportedException":{
"type":"structure",
"members":{
},
"exception":true
},
"Percentage":{"type":"integer"},
"PutLifecycleEventHookExecutionStatusInput":{
"type":"structure",
"members":{
"deploymentId":{"shape":"DeploymentId"},
"lifecycleEventHookExecutionId":{"shape":"LifecycleEventHookExecutionId"},
"status":{"shape":"LifecycleEventStatus"}
}
},
"PutLifecycleEventHookExecutionStatusOutput":{
"type":"structure",
"members":{
"lifecycleEventHookExecutionId":{"shape":"LifecycleEventHookExecutionId"}
}
},
"RawString":{
"type":"structure",
"members":{
"content":{"shape":"RawStringContent"},
"sha256":{"shape":"RawStringSha256"}
}
},
"RawStringContent":{"type":"string"},
"RawStringSha256":{"type":"string"},
"RegisterApplicationRevisionInput":{
"type":"structure",
"required":[
@ -2198,7 +2388,8 @@
"members":{
"revisionType":{"shape":"RevisionLocationType"},
"s3Location":{"shape":"S3Location"},
"gitHubLocation":{"shape":"GitHubLocation"}
"gitHubLocation":{"shape":"GitHubLocation"},
"string":{"shape":"RawString"}
}
},
"RevisionLocationList":{
@ -2209,7 +2400,8 @@
"type":"string",
"enum":[
"S3",
"GitHub"
"GitHub",
"String"
]
},
"RevisionRequiredException":{
@ -2349,6 +2541,26 @@
"ec2TagSet":{"shape":"EC2TagSet"}
}
},
"ThrottlingException":{
"type":"structure",
"members":{
},
"exception":true
},
"TimeBasedCanary":{
"type":"structure",
"members":{
"canaryPercentage":{"shape":"Percentage"},
"canaryInterval":{"shape":"WaitTimeInMins"}
}
},
"TimeBasedLinear":{
"type":"structure",
"members":{
"linearPercentage":{"shape":"Percentage"},
"linearInterval":{"shape":"WaitTimeInMins"}
}
},
"TimeRange":{
"type":"structure",
"members":{
@ -2357,6 +2569,22 @@
}
},
"Timestamp":{"type":"timestamp"},
"TrafficRoutingConfig":{
"type":"structure",
"members":{
"type":{"shape":"TrafficRoutingType"},
"timeBasedCanary":{"shape":"TimeBasedCanary"},
"timeBasedLinear":{"shape":"TimeBasedLinear"}
}
},
"TrafficRoutingType":{
"type":"string",
"enum":[
"TimeBasedCanary",
"TimeBasedLinear",
"AllAtOnce"
]
},
"TriggerConfig":{
"type":"structure",
"members":{
@ -2441,6 +2669,7 @@
}
},
"Value":{"type":"string"},
"VersionId":{"type":"string"}
"VersionId":{"type":"string"},
"WaitTimeInMins":{"type":"integer"}
}
}

View File

@ -1,6 +1,6 @@
{
"version": "2.0",
"service": "<fullname>AWS CodeDeploy</fullname> <p>AWS CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances or on-premises instances running in your own facility.</p> <p>You can deploy a nearly unlimited variety of application content, such as code, web and configuration files, executables, packages, scripts, multimedia files, and so on. AWS CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes to your existing code before you can use AWS CodeDeploy.</p> <p>AWS CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications, without many of the risks associated with error-prone manual deployments.</p> <p> <b>AWS CodeDeploy Components</b> </p> <p>Use the information in this guide to help you work with the following AWS CodeDeploy components:</p> <ul> <li> <p> <b>Application</b>: A name that uniquely identifies the application you want to deploy. AWS CodeDeploy uses this name, which functions as a container, to ensure the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment.</p> </li> <li> <p> <b>Deployment group</b>: A set of individual instances. A deployment group contains individually tagged instances, Amazon EC2 instances in Auto Scaling groups, or both. </p> </li> <li> <p> <b>Deployment configuration</b>: A set of deployment rules and deployment success and failure conditions used by AWS CodeDeploy during a deployment.</p> </li> <li> <p> <b>Deployment</b>: The process, and the components involved in the process, of installing content on one or more instances. </p> </li> <li> <p> <b>Application revisions</b>: An archive file containing source content—source code, web pages, executable files, and deployment scripts—along with an application specification file (AppSpec file). Revisions are stored in Amazon S3 buckets or GitHub repositories. For Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely identified by its commit ID.</p> </li> </ul> <p>This guide also contains information to help you get details about the instances in your deployments and to make on-premises instances available for AWS CodeDeploy deployments.</p> <p> <b>AWS CodeDeploy Information Resources</b> </p> <ul> <li> <p> <a href=\"http://docs.aws.amazon.com/codedeploy/latest/userguide\">AWS CodeDeploy User Guide</a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/codedeploy/latest/APIReference/\">AWS CodeDeploy API Reference Guide</a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/cli/latest/reference/deploy/index.html\">AWS CLI Reference for AWS CodeDeploy</a> </p> </li> <li> <p> <a href=\"https://forums.aws.amazon.com/forum.jspa?forumID=179\">AWS CodeDeploy Developer Forum</a> </p> </li> </ul>",
"service": "<fullname>AWS CodeDeploy</fullname> <p>AWS CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances running in your own facility, or serverless AWS Lambda functions.</p> <p>You can deploy a nearly unlimited variety of application content, such as an updated Lambda function, code, web and configuration files, executables, packages, scripts, multimedia files, and so on. AWS CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes to your existing code before you can use AWS CodeDeploy.</p> <p>AWS CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications, without many of the risks associated with error-prone manual deployments.</p> <p> <b>AWS CodeDeploy Components</b> </p> <p>Use the information in this guide to help you work with the following AWS CodeDeploy components:</p> <ul> <li> <p> <b>Application</b>: A name that uniquely identifies the application you want to deploy. AWS CodeDeploy uses this name, which functions as a container, to ensure the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment.</p> </li> <li> <p> <b>Deployment group</b>: A set of individual instances or CodeDeploy Lambda applications. A Lambda deployment group contains a group of applications. An EC2/On-premises deployment group contains individually tagged instances, Amazon EC2 instances in Auto Scaling groups, or both. </p> </li> <li> <p> <b>Deployment configuration</b>: A set of deployment rules and deployment success and failure conditions used by AWS CodeDeploy during a deployment.</p> </li> <li> <p> <b>Deployment</b>: The process and the components used in the process of updating a Lambda function or of installing content on one or more instances. </p> </li> <li> <p> <b>Application revisions</b>: For an AWS Lambda deployment, this is an AppSpec file that specifies the Lambda function to update and one or more functions to validate deployment lifecycle events. For an EC2/On-premises deployment, this is an archive file containing source content—source code, web pages, executable files, and deployment scripts—along with an AppSpec file. Revisions are stored in Amazon S3 buckets or GitHub repositories. For Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely identified by its commit ID.</p> </li> </ul> <p>This guide also contains information to help you get details about the instances in your deployments, to make on-premises instances available for AWS CodeDeploy deployments, and to get details about a Lambda function deployment.</p> <p> <b>AWS CodeDeploy Information Resources</b> </p> <ul> <li> <p> <a href=\"http://docs.aws.amazon.com/codedeploy/latest/userguide\">AWS CodeDeploy User Guide</a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/codedeploy/latest/APIReference/\">AWS CodeDeploy API Reference Guide</a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/cli/latest/reference/deploy/index.html\">AWS CLI Reference for AWS CodeDeploy</a> </p> </li> <li> <p> <a href=\"https://forums.aws.amazon.com/forum.jspa?forumID=179\">AWS CodeDeploy Developer Forum</a> </p> </li> </ul>",
"operations": {
"AddTagsToOnPremisesInstances": "<p>Adds tags to on-premises instances.</p>",
"BatchGetApplicationRevisions": "<p>Gets information about one or more application revisions.</p>",
@ -17,6 +17,7 @@
"DeleteApplication": "<p>Deletes an application.</p>",
"DeleteDeploymentConfig": "<p>Deletes a deployment configuration.</p> <note> <p>A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.</p> </note>",
"DeleteDeploymentGroup": "<p>Deletes a deployment group.</p>",
"DeleteGitHubAccountToken": "<p>Deletes a GitHub account connection.</p>",
"DeregisterOnPremisesInstance": "<p>Deregisters an on-premises instance.</p>",
"GetApplication": "<p>Gets information about an application.</p>",
"GetApplicationRevision": "<p>Gets information about an application revision.</p>",
@ -33,6 +34,7 @@
"ListDeployments": "<p>Lists the deployments in a deployment group for an application registered with the applicable IAM user or AWS account.</p>",
"ListGitHubAccountTokenNames": "<p>Lists the names of stored connections to GitHub accounts.</p>",
"ListOnPremisesInstances": "<p>Gets a list of names for one or more on-premises instances.</p> <p>Unless otherwise specified, both registered and deregistered on-premises instance names will be listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.</p>",
"PutLifecycleEventHookExecutionStatus": "<p>Sets the result of a Lambda validation function. The function validates one or both lifecycle events (<code>BeforeAllowTraffic</code> and <code>AfterAllowTraffic</code>) and returns <code>Succeeded</code> or <code>Failed</code>.</p>",
"RegisterApplicationRevision": "<p>Registers with AWS CodeDeploy a revision for the specified application.</p>",
"RegisterOnPremisesInstance": "<p>Registers an on-premises instance.</p> <note> <p>Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.</p> </note>",
"RemoveTagsFromOnPremisesInstances": "<p>Removes one or more tags from one or more on-premises instances.</p>",
@ -334,6 +336,17 @@
"GitHubLocation$commitId": "<p>The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.</p>"
}
},
"ComputePlatform": {
"base": null,
"refs": {
"ApplicationInfo$computePlatform": "<p>The destination platform type for deployment of the application (<code>Lambda</code> or <code>Server</code>).</p>",
"CreateApplicationInput$computePlatform": "<p> The destination platform type for the deployment (<code>Lambda</code> or <code>Server</code>).</p>",
"CreateDeploymentConfigInput$computePlatform": "<p>The destination platform type for the deployment (<code>Lambda</code> or <code>Server</code>&gt;).</p>",
"DeploymentConfigInfo$computePlatform": "<p>The destination platform type for the deployment (<code>Lambda</code> or <code>Server</code>).</p>",
"DeploymentGroupInfo$computePlatform": "<p>The destination platform type for the deployment group (<code>Lambda</code> or <code>Server</code>).</p>",
"DeploymentInfo$computePlatform": "<p>The destination platform type for the deployment (<code>Lambda</code> or <code>Server</code>).</p>"
}
},
"ContinueDeploymentInput": {
"base": null,
"refs": {
@ -399,6 +412,16 @@
"refs": {
}
},
"DeleteGitHubAccountTokenInput": {
"base": "<p>Represents the input of a DeleteGitHubAccount operation.</p>",
"refs": {
}
},
"DeleteGitHubAccountTokenOutput": {
"base": "<p>Represents the output of a DeleteGitHubAccountToken operation.</p>",
"refs": {
}
},
"DeploymentAlreadyCompletedException": {
"base": "<p>The deployment is already complete.</p>",
"refs": {
@ -550,6 +573,7 @@
"InstanceSummary$deploymentId": "<p>The deployment ID.</p>",
"LastDeploymentInfo$deploymentId": "<p>The deployment ID.</p>",
"ListDeploymentInstancesInput$deploymentId": "<p>The unique ID of a deployment.</p>",
"PutLifecycleEventHookExecutionStatusInput$deploymentId": "<p>The ID of the deployment. Pass this ID to a Lambda function that validates a deployment lifecycle event.</p>",
"RollbackInfo$rollbackDeploymentId": "<p>The ID of the deployment rollback.</p>",
"RollbackInfo$rollbackTriggeringDeploymentId": "<p>The deployment ID of the deployment that was underway and triggered a rollback deployment because it failed or was stopped.</p>",
"SkipWaitTimeForInstanceTerminationInput$deploymentId": "<p>The ID of the blue/green deployment for which you want to skip the instance termination wait time.</p>",
@ -621,6 +645,12 @@
"ListDeploymentsInput$includeOnlyStatuses": "<p>A subset of deployments to list by status:</p> <ul> <li> <p>Created: Include created deployments in the resulting list.</p> </li> <li> <p>Queued: Include queued deployments in the resulting list.</p> </li> <li> <p>In Progress: Include in-progress deployments in the resulting list.</p> </li> <li> <p>Succeeded: Include successful deployments in the resulting list.</p> </li> <li> <p>Failed: Include failed deployments in the resulting list.</p> </li> <li> <p>Stopped: Include stopped deployments in the resulting list.</p> </li> </ul>"
}
},
"DeploymentStatusMessageList": {
"base": null,
"refs": {
"DeploymentInfo$deploymentStatusMessages": "<p>Messages that contain information about the status of a deployment.</p>"
}
},
"DeploymentStyle": {
"base": "<p>Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.</p>",
"refs": {
@ -734,7 +764,7 @@
"ELBName": {
"base": null,
"refs": {
"ELBInfo$name": "<p>For blue/green deployments, the name of the load balancer that will be used to route traffic from original instances to replacement instances in a blue/green deployment. For in-place deployments, the name of the load balancer that instances are deregistered from, so they are not serving traffic during a deployment, and then re-registered with after the deployment completes.</p>"
"ELBInfo$name": "<p>For blue/green deployments, the name of the load balancer that will be used to route traffic from original instances to replacement instances in a blue/green deployment. For in-place deployments, the name of the load balancer that instances are deregistered from so they are not serving traffic during a deployment, and then re-registered with after the deployment completes.</p>"
}
},
"ETag": {
@ -761,6 +791,7 @@
"BatchGetApplicationRevisionsOutput$errorMessage": "<p>Information about errors that may have occurred during the API call.</p>",
"BatchGetDeploymentGroupsOutput$errorMessage": "<p>Information about errors that may have occurred during the API call.</p>",
"BatchGetDeploymentInstancesOutput$errorMessage": "<p>Information about errors that may have occurred during the API call.</p>",
"DeploymentStatusMessageList$member": null,
"ErrorInformation$message": "<p>An accompanying error message.</p>"
}
},
@ -857,6 +888,8 @@
"base": null,
"refs": {
"ApplicationInfo$gitHubAccountName": "<p>The name for a connection to a GitHub account.</p>",
"DeleteGitHubAccountTokenInput$tokenName": "<p>The name of the GitHub account connection to delete.</p>",
"DeleteGitHubAccountTokenOutput$tokenName": "<p>The name of the GitHub account connection that was deleted.</p>",
"GitHubAccountTokenNameList$member": null
}
},
@ -866,6 +899,11 @@
"ListGitHubAccountTokenNamesOutput$tokenNameList": "<p>A list of names of connections to GitHub accounts.</p>"
}
},
"GitHubAccountTokenNameRequiredException": {
"base": "<p>The call is missing a required GitHub account connection name.</p>",
"refs": {
}
},
"GitHubLocation": {
"base": "<p>Information about the location of application artifacts stored in GitHub.</p>",
"refs": {
@ -1087,6 +1125,11 @@
"refs": {
}
},
"InvalidComputePlatformException": {
"base": "<p>The computePlatform is invalid. The computePlatform should be <code>Lambda</code> or <code>Server</code>.</p>",
"refs": {
}
},
"InvalidDeployedStateFilterException": {
"base": "<p>The deployed state filter was specified in an invalid format.</p>",
"refs": {
@ -1137,6 +1180,11 @@
"refs": {
}
},
"InvalidGitHubAccountTokenNameException": {
"base": "<p>The format of the specified GitHub account connection name is invalid.</p>",
"refs": {
}
},
"InvalidIamSessionArnException": {
"base": "<p>The IAM session ARN was specified in an invalid format.</p>",
"refs": {
@ -1147,6 +1195,21 @@
"refs": {
}
},
"InvalidIgnoreApplicationStopFailuresValueException": {
"base": "<p>The IgnoreApplicationStopFailures value is invalid. For AWS Lambda deployments, <code>false</code> is expected. For EC2/On-premises deployments, <code>true</code> or <code>false</code> is expected.</p>",
"refs": {
}
},
"InvalidInputException": {
"base": "<p>The specified input was specified in an invalid format.</p>",
"refs": {
}
},
"InvalidInstanceIdException": {
"base": "<p> </p>",
"refs": {
}
},
"InvalidInstanceNameException": {
"base": "<p>The specified on-premises instance name was specified in an invalid format.</p>",
"refs": {
@ -1167,6 +1230,16 @@
"refs": {
}
},
"InvalidLifecycleEventHookExecutionIdException": {
"base": "<p>A lifecycle event hook is invalid. Review the <code>hooks</code> section in your AppSpec file to ensure the lifecycle events and <code>hooks</code> functions are valid.</p>",
"refs": {
}
},
"InvalidLifecycleEventHookExecutionStatusException": {
"base": "<p>The result of a Lambda validation function that verifies a lifecycle event is invalid. It should return <code>Succeeded</code> or <code>Failed</code>.</p>",
"refs": {
}
},
"InvalidLoadBalancerInfoException": {
"base": "<p>An invalid load balancer name, or no load balancer name, was specified.</p>",
"refs": {
@ -1237,11 +1310,21 @@
"refs": {
}
},
"InvalidTrafficRoutingConfigurationException": {
"base": "<p> The configuration that specifies how traffic is routed during a deployment is invalid.</p>",
"refs": {
}
},
"InvalidTriggerConfigException": {
"base": "<p>The trigger was specified in an invalid format.</p>",
"refs": {
}
},
"InvalidUpdateOutdatedInstancesOnlyValueException": {
"base": "<p>The UpdateOutdatedInstancesOnly value is invalid. For AWS Lambda deployments, <code>false</code> is expected. For EC2/On-premises deployments, <code>true</code> or <code>false</code> is expected.</p>",
"refs": {
}
},
"Key": {
"base": null,
"refs": {
@ -1269,6 +1352,18 @@
"LifecycleEventList$member": null
}
},
"LifecycleEventAlreadyCompletedException": {
"base": "<p>An attempt to return the status of an already completed lifecycle event occurred.</p>",
"refs": {
}
},
"LifecycleEventHookExecutionId": {
"base": null,
"refs": {
"PutLifecycleEventHookExecutionStatusInput$lifecycleEventHookExecutionId": "<p>The execution ID of a deployment's lifecycle hook. A deployment lifecycle hook is specified in the <code>hooks</code> section of the AppSpec file.</p>",
"PutLifecycleEventHookExecutionStatusOutput$lifecycleEventHookExecutionId": "<p>The execution ID of the lifecycle event hook. A hook is specified in the <code>hooks</code> section of the deployment's AppSpec file.</p>"
}
},
"LifecycleEventList": {
"base": null,
"refs": {
@ -1284,7 +1379,8 @@
"LifecycleEventStatus": {
"base": null,
"refs": {
"LifecycleEvent$status": "<p>The deployment lifecycle event status:</p> <ul> <li> <p>Pending: The deployment lifecycle event is pending.</p> </li> <li> <p>InProgress: The deployment lifecycle event is in progress.</p> </li> <li> <p>Succeeded: The deployment lifecycle event ran successfully.</p> </li> <li> <p>Failed: The deployment lifecycle event has failed.</p> </li> <li> <p>Skipped: The deployment lifecycle event has been skipped.</p> </li> <li> <p>Unknown: The deployment lifecycle event is unknown.</p> </li> </ul>"
"LifecycleEvent$status": "<p>The deployment lifecycle event status:</p> <ul> <li> <p>Pending: The deployment lifecycle event is pending.</p> </li> <li> <p>InProgress: The deployment lifecycle event is in progress.</p> </li> <li> <p>Succeeded: The deployment lifecycle event ran successfully.</p> </li> <li> <p>Failed: The deployment lifecycle event has failed.</p> </li> <li> <p>Skipped: The deployment lifecycle event has been skipped.</p> </li> <li> <p>Unknown: The deployment lifecycle event is unknown.</p> </li> </ul>",
"PutLifecycleEventHookExecutionStatusInput$status": "<p>The result of a Lambda function that validates a deployment lifecycle event (<code>Succeeded</code> or <code>Failed</code>).</p>"
}
},
"LifecycleHookLimitExceededException": {
@ -1470,6 +1566,46 @@
"OnPremisesTagSet$onPremisesTagSetList": "<p>A list containing other lists of on-premises instance tag groups. In order for an instance to be included in the deployment group, it must be identified by all the tag groups in the list.</p>"
}
},
"OperationNotSupportedException": {
"base": "<p>The API used does not support the deployment.</p>",
"refs": {
}
},
"Percentage": {
"base": null,
"refs": {
"TimeBasedCanary$canaryPercentage": "<p>The percentage of traffic to shift in the first increment of a <code>TimeBasedCanary</code> deployment.</p>",
"TimeBasedLinear$linearPercentage": "<p>The percentage of traffic that is shifted at the start of each increment of a <code>TimeBasedLinear</code> deployment.</p>"
}
},
"PutLifecycleEventHookExecutionStatusInput": {
"base": null,
"refs": {
}
},
"PutLifecycleEventHookExecutionStatusOutput": {
"base": null,
"refs": {
}
},
"RawString": {
"base": "<p>A revision for an AWS Lambda deployment that is a YAML-formatted or JSON-formatted string. For AWS Lambda deployments, the revision is the same as the AppSpec file.</p>",
"refs": {
"RevisionLocation$string": "<p>Information about the location of an AWS Lambda deployment revision stored as a RawString.</p>"
}
},
"RawStringContent": {
"base": null,
"refs": {
"RawString$content": "<p>The YAML-formatted or JSON-formatted revision string. It includes information about which Lambda function to update and optional Lambda functions that validate deployment lifecycle events.</p>"
}
},
"RawStringSha256": {
"base": null,
"refs": {
"RawString$sha256": "<p>The SHA256 hash value of the revision that is specified as a RawString.</p>"
}
},
"RegisterApplicationRevisionInput": {
"base": "<p>Represents the input of a RegisterApplicationRevision operation.</p>",
"refs": {
@ -1543,7 +1679,7 @@
"RevisionLocationType": {
"base": null,
"refs": {
"RevisionLocation$revisionType": "<p>The type of application revision:</p> <ul> <li> <p>S3: An application revision stored in Amazon S3.</p> </li> <li> <p>GitHub: An application revision stored in GitHub.</p> </li> </ul>"
"RevisionLocation$revisionType": "<p>The type of application revision:</p> <ul> <li> <p>S3: An application revision stored in Amazon S3.</p> </li> <li> <p>GitHub: An application revision stored in GitHub (EC2/On-premises deployments only)</p> </li> <li> <p>String: A YAML-formatted or JSON-formatted string (AWS Lambda deployments only)</p> </li> </ul>"
}
},
"RevisionRequiredException": {
@ -1587,7 +1723,7 @@
"S3Location": {
"base": "<p>Information about the location of application artifacts stored in Amazon S3.</p>",
"refs": {
"RevisionLocation$s3Location": "<p>Information about the location of application artifacts stored in Amazon S3. </p>"
"RevisionLocation$s3Location": "<p>Information about the location of a revision stored in Amazon S3. </p>"
}
},
"ScriptName": {
@ -1699,6 +1835,23 @@
"DeploymentInfo$targetInstances": "<p>Information about the instances that belong to the replacement environment in a blue/green deployment.</p>"
}
},
"ThrottlingException": {
"base": "<p>An API function was called too frequently.</p>",
"refs": {
}
},
"TimeBasedCanary": {
"base": "<p>A configuration that shifts traffic from one version of a Lambda function to another in two increments. The original and target Lambda function versions are specified in the deployment's AppSpec file.</p>",
"refs": {
"TrafficRoutingConfig$timeBasedCanary": "<p>A configuration that shifts traffic from one version of a Lambda function to another in two increments. The original and target Lambda function versions are specified in the deployment's AppSpec file.</p>"
}
},
"TimeBasedLinear": {
"base": "<p>A configuration that shifts traffic from one version of a Lambda function to another in equal increments, with an equal number of minutes between each increment. The original and target Lambda function versions are specified in the deployment's AppSpec file.</p>",
"refs": {
"TrafficRoutingConfig$timeBasedLinear": "<p>A configuration that shifts traffic from one version of a Lambda function to another in equal increments, with an equal number of minutes between each increment. The original and target Lambda function versions are specified in the deployment's AppSpec file.</p>"
}
},
"TimeRange": {
"base": "<p>Information about a time range.</p>",
"refs": {
@ -1727,6 +1880,19 @@
"TimeRange$end": "<p>The end time of the time range.</p> <note> <p>Specify null to leave the end time open-ended.</p> </note>"
}
},
"TrafficRoutingConfig": {
"base": "<p>The configuration that specifies how traffic is shifted from one version of a Lambda function to another version during an AWS Lambda deployment.</p>",
"refs": {
"CreateDeploymentConfigInput$trafficRoutingConfig": "<p>The configuration that specifies how the deployment traffic will be routed.</p>",
"DeploymentConfigInfo$trafficRoutingConfig": "<p>The configuration specifying how the deployment traffic will be routed. Only deployments with a Lambda compute platform can specify this.</p>"
}
},
"TrafficRoutingType": {
"base": null,
"refs": {
"TrafficRoutingConfig$type": "<p>The type of traffic shifting (<code>TimeBasedCanary</code> or <code>TimeBasedLinear</code>) used by a deployment configuration .</p>"
}
},
"TriggerConfig": {
"base": "<p>Information about notification triggers for the deployment group.</p>",
"refs": {
@ -1803,6 +1969,13 @@
"refs": {
"S3Location$version": "<p>A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision.</p> <p>If the version is not specified, the system will use the most recent version by default.</p>"
}
},
"WaitTimeInMins": {
"base": null,
"refs": {
"TimeBasedCanary$canaryInterval": "<p>The number of minutes between the first and second traffic shifts of a <code>TimeBasedCanary</code> deployment.</p>",
"TimeBasedLinear$linearInterval": "<p>The number of minutes between each incremental traffic shift of a <code>TimeBasedLinear</code> deployment.</p>"
}
}
}
}

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,685 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2017-11-27",
"endpointPrefix":"comprehend",
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"Amazon Comprehend",
"serviceId":"Comprehend",
"signatureVersion":"v4",
"signingName":"comprehend",
"targetPrefix":"Comprehend_20171127",
"uid":"comprehend-2017-11-27"
},
"operations":{
"BatchDetectDominantLanguage":{
"name":"BatchDetectDominantLanguage",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"BatchDetectDominantLanguageRequest"},
"output":{"shape":"BatchDetectDominantLanguageResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"TextSizeLimitExceededException"},
{"shape":"BatchSizeLimitExceededException"},
{"shape":"InternalServerException"}
]
},
"BatchDetectEntities":{
"name":"BatchDetectEntities",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"BatchDetectEntitiesRequest"},
"output":{"shape":"BatchDetectEntitiesResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"TextSizeLimitExceededException"},
{"shape":"UnsupportedLanguageException"},
{"shape":"BatchSizeLimitExceededException"},
{"shape":"InternalServerException"}
]
},
"BatchDetectKeyPhrases":{
"name":"BatchDetectKeyPhrases",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"BatchDetectKeyPhrasesRequest"},
"output":{"shape":"BatchDetectKeyPhrasesResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"TextSizeLimitExceededException"},
{"shape":"UnsupportedLanguageException"},
{"shape":"BatchSizeLimitExceededException"},
{"shape":"InternalServerException"}
]
},
"BatchDetectSentiment":{
"name":"BatchDetectSentiment",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"BatchDetectSentimentRequest"},
"output":{"shape":"BatchDetectSentimentResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"TextSizeLimitExceededException"},
{"shape":"UnsupportedLanguageException"},
{"shape":"BatchSizeLimitExceededException"},
{"shape":"InternalServerException"}
]
},
"DescribeTopicsDetectionJob":{
"name":"DescribeTopicsDetectionJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeTopicsDetectionJobRequest"},
"output":{"shape":"DescribeTopicsDetectionJobResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"JobNotFoundException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalServerException"}
]
},
"DetectDominantLanguage":{
"name":"DetectDominantLanguage",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DetectDominantLanguageRequest"},
"output":{"shape":"DetectDominantLanguageResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"TextSizeLimitExceededException"},
{"shape":"InternalServerException"}
]
},
"DetectEntities":{
"name":"DetectEntities",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DetectEntitiesRequest"},
"output":{"shape":"DetectEntitiesResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"TextSizeLimitExceededException"},
{"shape":"UnsupportedLanguageException"},
{"shape":"InternalServerException"}
]
},
"DetectKeyPhrases":{
"name":"DetectKeyPhrases",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DetectKeyPhrasesRequest"},
"output":{"shape":"DetectKeyPhrasesResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"TextSizeLimitExceededException"},
{"shape":"UnsupportedLanguageException"},
{"shape":"InternalServerException"}
]
},
"DetectSentiment":{
"name":"DetectSentiment",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DetectSentimentRequest"},
"output":{"shape":"DetectSentimentResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"TextSizeLimitExceededException"},
{"shape":"UnsupportedLanguageException"},
{"shape":"InternalServerException"}
]
},
"ListTopicsDetectionJobs":{
"name":"ListTopicsDetectionJobs",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTopicsDetectionJobsRequest"},
"output":{"shape":"ListTopicsDetectionJobsResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"InvalidFilterException"},
{"shape":"InternalServerException"}
]
},
"StartTopicsDetectionJob":{
"name":"StartTopicsDetectionJob",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartTopicsDetectionJobRequest"},
"output":{"shape":"StartTopicsDetectionJobResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"TooManyRequestsException"},
{"shape":"InternalServerException"}
]
}
},
"shapes":{
"AnyLengthString":{"type":"string"},
"BatchDetectDominantLanguageItemResult":{
"type":"structure",
"members":{
"Index":{"shape":"Integer"},
"Languages":{"shape":"ListOfDominantLanguages"}
}
},
"BatchDetectDominantLanguageRequest":{
"type":"structure",
"required":["TextList"],
"members":{
"TextList":{"shape":"StringList"}
}
},
"BatchDetectDominantLanguageResponse":{
"type":"structure",
"required":[
"ResultList",
"ErrorList"
],
"members":{
"ResultList":{"shape":"ListOfDetectDominantLanguageResult"},
"ErrorList":{"shape":"BatchItemErrorList"}
}
},
"BatchDetectEntitiesItemResult":{
"type":"structure",
"members":{
"Index":{"shape":"Integer"},
"Entities":{"shape":"ListOfEntities"}
}
},
"BatchDetectEntitiesRequest":{
"type":"structure",
"required":[
"TextList",
"LanguageCode"
],
"members":{
"TextList":{"shape":"StringList"},
"LanguageCode":{"shape":"String"}
}
},
"BatchDetectEntitiesResponse":{
"type":"structure",
"required":[
"ResultList",
"ErrorList"
],
"members":{
"ResultList":{"shape":"ListOfDetectEntitiesResult"},
"ErrorList":{"shape":"BatchItemErrorList"}
}
},
"BatchDetectKeyPhrasesItemResult":{
"type":"structure",
"members":{
"Index":{"shape":"Integer"},
"KeyPhrases":{"shape":"ListOfKeyPhrases"}
}
},
"BatchDetectKeyPhrasesRequest":{
"type":"structure",
"required":[
"TextList",
"LanguageCode"
],
"members":{
"TextList":{"shape":"StringList"},
"LanguageCode":{"shape":"String"}
}
},
"BatchDetectKeyPhrasesResponse":{
"type":"structure",
"required":[
"ResultList",
"ErrorList"
],
"members":{
"ResultList":{"shape":"ListOfDetectKeyPhrasesResult"},
"ErrorList":{"shape":"BatchItemErrorList"}
}
},
"BatchDetectSentimentItemResult":{
"type":"structure",
"members":{
"Index":{"shape":"Integer"},
"Sentiment":{"shape":"SentimentType"},
"SentimentScore":{"shape":"SentimentScore"}
}
},
"BatchDetectSentimentRequest":{
"type":"structure",
"required":[
"TextList",
"LanguageCode"
],
"members":{
"TextList":{"shape":"StringList"},
"LanguageCode":{"shape":"String"}
}
},
"BatchDetectSentimentResponse":{
"type":"structure",
"required":[
"ResultList",
"ErrorList"
],
"members":{
"ResultList":{"shape":"ListOfDetectSentimentResult"},
"ErrorList":{"shape":"BatchItemErrorList"}
}
},
"BatchItemError":{
"type":"structure",
"members":{
"Index":{"shape":"Integer"},
"ErrorCode":{"shape":"String"},
"ErrorMessage":{"shape":"String"}
}
},
"BatchItemErrorList":{
"type":"list",
"member":{"shape":"BatchItemError"}
},
"BatchSizeLimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"exception":true
},
"ClientRequestTokenString":{
"type":"string",
"max":64,
"min":1,
"pattern":"^[a-zA-Z0-9-]+$"
},
"DescribeTopicsDetectionJobRequest":{
"type":"structure",
"required":["JobId"],
"members":{
"JobId":{"shape":"JobId"}
}
},
"DescribeTopicsDetectionJobResponse":{
"type":"structure",
"members":{
"TopicsDetectionJobProperties":{"shape":"TopicsDetectionJobProperties"}
}
},
"DetectDominantLanguageRequest":{
"type":"structure",
"required":["Text"],
"members":{
"Text":{"shape":"String"}
}
},
"DetectDominantLanguageResponse":{
"type":"structure",
"members":{
"Languages":{"shape":"ListOfDominantLanguages"}
}
},
"DetectEntitiesRequest":{
"type":"structure",
"required":[
"Text",
"LanguageCode"
],
"members":{
"Text":{"shape":"String"},
"LanguageCode":{"shape":"LanguageCode"}
}
},
"DetectEntitiesResponse":{
"type":"structure",
"members":{
"Entities":{"shape":"ListOfEntities"}
}
},
"DetectKeyPhrasesRequest":{
"type":"structure",
"required":[
"Text",
"LanguageCode"
],
"members":{
"Text":{"shape":"String"},
"LanguageCode":{"shape":"LanguageCode"}
}
},
"DetectKeyPhrasesResponse":{
"type":"structure",
"members":{
"KeyPhrases":{"shape":"ListOfKeyPhrases"}
}
},
"DetectSentimentRequest":{
"type":"structure",
"required":[
"Text",
"LanguageCode"
],
"members":{
"Text":{"shape":"String"},
"LanguageCode":{"shape":"LanguageCode"}
}
},
"DetectSentimentResponse":{
"type":"structure",
"members":{
"Sentiment":{"shape":"SentimentType"},
"SentimentScore":{"shape":"SentimentScore"}
}
},
"DominantLanguage":{
"type":"structure",
"members":{
"LanguageCode":{"shape":"String"},
"Score":{"shape":"Float"}
}
},
"Entity":{
"type":"structure",
"members":{
"Score":{"shape":"Float"},
"Type":{"shape":"EntityType"},
"Text":{"shape":"String"},
"BeginOffset":{"shape":"Integer"},
"EndOffset":{"shape":"Integer"}
}
},
"EntityType":{
"type":"string",
"enum":[
"PERSON",
"LOCATION",
"ORGANIZATION",
"COMMERCIAL_ITEM",
"EVENT",
"DATE",
"QUANTITY",
"TITLE",
"OTHER"
]
},
"Float":{"type":"float"},
"IamRoleArn":{
"type":"string",
"pattern":"arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+"
},
"InputDataConfig":{
"type":"structure",
"required":["S3Uri"],
"members":{
"S3Uri":{"shape":"S3Uri"},
"InputFormat":{"shape":"InputFormat"}
}
},
"InputFormat":{
"type":"string",
"enum":[
"ONE_DOC_PER_FILE",
"ONE_DOC_PER_LINE"
]
},
"Integer":{"type":"integer"},
"InternalServerException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"exception":true,
"fault":true
},
"InvalidFilterException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"exception":true
},
"InvalidRequestException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"exception":true
},
"JobId":{
"type":"string",
"max":32,
"min":1
},
"JobName":{
"type":"string",
"max":256,
"min":1,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$"
},
"JobNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"exception":true
},
"JobStatus":{
"type":"string",
"enum":[
"SUBMITTED",
"IN_PROGRESS",
"COMPLETED",
"FAILED"
]
},
"KeyPhrase":{
"type":"structure",
"members":{
"Score":{"shape":"Float"},
"Text":{"shape":"String"},
"BeginOffset":{"shape":"Integer"},
"EndOffset":{"shape":"Integer"}
}
},
"LanguageCode":{
"type":"string",
"enum":[
"en",
"es"
]
},
"ListOfDetectDominantLanguageResult":{
"type":"list",
"member":{"shape":"BatchDetectDominantLanguageItemResult"}
},
"ListOfDetectEntitiesResult":{
"type":"list",
"member":{"shape":"BatchDetectEntitiesItemResult"}
},
"ListOfDetectKeyPhrasesResult":{
"type":"list",
"member":{"shape":"BatchDetectKeyPhrasesItemResult"}
},
"ListOfDetectSentimentResult":{
"type":"list",
"member":{"shape":"BatchDetectSentimentItemResult"}
},
"ListOfDominantLanguages":{
"type":"list",
"member":{"shape":"DominantLanguage"}
},
"ListOfEntities":{
"type":"list",
"member":{"shape":"Entity"}
},
"ListOfKeyPhrases":{
"type":"list",
"member":{"shape":"KeyPhrase"}
},
"ListTopicsDetectionJobsRequest":{
"type":"structure",
"members":{
"Filter":{"shape":"TopicsDetectionJobFilter"},
"NextToken":{"shape":"String"},
"MaxResults":{"shape":"MaxResultsInteger"}
}
},
"ListTopicsDetectionJobsResponse":{
"type":"structure",
"members":{
"TopicsDetectionJobPropertiesList":{"shape":"TopicsDetectionJobPropertiesList"},
"NextToken":{"shape":"String"}
}
},
"MaxResultsInteger":{
"type":"integer",
"max":500,
"min":1
},
"NumberOfTopicsInteger":{
"type":"integer",
"max":100,
"min":1
},
"OutputDataConfig":{
"type":"structure",
"required":["S3Uri"],
"members":{
"S3Uri":{"shape":"S3Uri"}
}
},
"S3Uri":{
"type":"string",
"max":1024,
"pattern":"s3://([^/]+)(/.*)?"
},
"SentimentScore":{
"type":"structure",
"members":{
"Positive":{"shape":"Float"},
"Negative":{"shape":"Float"},
"Neutral":{"shape":"Float"},
"Mixed":{"shape":"Float"}
}
},
"SentimentType":{
"type":"string",
"enum":[
"POSITIVE",
"NEGATIVE",
"NEUTRAL",
"MIXED"
]
},
"StartTopicsDetectionJobRequest":{
"type":"structure",
"required":[
"InputDataConfig",
"OutputDataConfig",
"DataAccessRoleArn"
],
"members":{
"InputDataConfig":{"shape":"InputDataConfig"},
"OutputDataConfig":{"shape":"OutputDataConfig"},
"DataAccessRoleArn":{"shape":"IamRoleArn"},
"JobName":{"shape":"JobName"},
"NumberOfTopics":{"shape":"NumberOfTopicsInteger"},
"ClientRequestToken":{
"shape":"ClientRequestTokenString",
"idempotencyToken":true
}
}
},
"StartTopicsDetectionJobResponse":{
"type":"structure",
"members":{
"JobId":{"shape":"JobId"},
"JobStatus":{"shape":"JobStatus"}
}
},
"String":{
"type":"string",
"min":1
},
"StringList":{
"type":"list",
"member":{"shape":"String"}
},
"TextSizeLimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"exception":true
},
"Timestamp":{"type":"timestamp"},
"TooManyRequestsException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"exception":true
},
"TopicsDetectionJobFilter":{
"type":"structure",
"members":{
"JobName":{"shape":"JobName"},
"JobStatus":{"shape":"JobStatus"},
"SubmitTimeBefore":{"shape":"Timestamp"},
"SubmitTimeAfter":{"shape":"Timestamp"}
}
},
"TopicsDetectionJobProperties":{
"type":"structure",
"members":{
"JobId":{"shape":"JobId"},
"JobName":{"shape":"JobName"},
"JobStatus":{"shape":"JobStatus"},
"Message":{"shape":"AnyLengthString"},
"SubmitTime":{"shape":"Timestamp"},
"EndTime":{"shape":"Timestamp"},
"InputDataConfig":{"shape":"InputDataConfig"},
"OutputDataConfig":{"shape":"OutputDataConfig"},
"NumberOfTopics":{"shape":"Integer"}
}
},
"TopicsDetectionJobPropertiesList":{
"type":"list",
"member":{"shape":"TopicsDetectionJobProperties"}
},
"UnsupportedLanguageException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"exception":true
}
}
}

View File

@ -0,0 +1,472 @@
{
"version": "2.0",
"service": "<p>Amazon Comprehend is an AWS service for gaining insight into the content of documents. Use these actions to determine the topics contained in your documents, the topics they discuss, the predominant sentiment expressed in them, the predominant language used, and more.</p>",
"operations": {
"BatchDetectDominantLanguage": "<p>Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see <a href=\"http://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html\">Amazon Comprehend Supported Languages</a>. </p>",
"BatchDetectEntities": "<p>Inspects the text of a batch of documents and returns information about them. For more information about entities, see <a>how-entities</a> </p>",
"BatchDetectKeyPhrases": "<p>Detects the key noun phrases found in a batch of documents.</p>",
"BatchDetectSentiment": "<p>Inspects a batch of documents and returns an inference of the prevailing sentiment, <code>POSITIVE</code>, <code>NEUTRAL</code>, <code>MIXED</code>, or <code>NEGATIVE</code>, in each one.</p>",
"DescribeTopicsDetectionJob": "<p>Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.</p>",
"DetectDominantLanguage": "<p>Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see <a href=\"http://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html\">Amazon Comprehend Supported Languages</a>. </p>",
"DetectEntities": "<p>Inspects text for entities, and returns information about them. For more information, about entities, see <a>how-entities</a>. </p>",
"DetectKeyPhrases": "<p>Detects the key noun phrases found in the text. </p>",
"DetectSentiment": "<p>Inspects text and returns an inference of the prevailing sentiment (<code>POSITIVE</code>, <code>NEUTRAL</code>, <code>MIXED</code>, or <code>NEGATIVE</code>). </p>",
"ListTopicsDetectionJobs": "<p>Gets a list of the topic detection jobs that you have submitted.</p>",
"StartTopicsDetectionJob": "<p>Starts an asynchronous topic detection job. Use the <code>DescribeTopicDetectionJob</code> operation to track the status of a job.</p>"
},
"shapes": {
"AnyLengthString": {
"base": null,
"refs": {
"TopicsDetectionJobProperties$Message": "<p>A description for the status of a job.</p>"
}
},
"BatchDetectDominantLanguageItemResult": {
"base": "<p>The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.</p>",
"refs": {
"ListOfDetectDominantLanguageResult$member": null
}
},
"BatchDetectDominantLanguageRequest": {
"base": null,
"refs": {
}
},
"BatchDetectDominantLanguageResponse": {
"base": null,
"refs": {
}
},
"BatchDetectEntitiesItemResult": {
"base": "<p>The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.</p>",
"refs": {
"ListOfDetectEntitiesResult$member": null
}
},
"BatchDetectEntitiesRequest": {
"base": null,
"refs": {
}
},
"BatchDetectEntitiesResponse": {
"base": null,
"refs": {
}
},
"BatchDetectKeyPhrasesItemResult": {
"base": "<p>The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.</p>",
"refs": {
"ListOfDetectKeyPhrasesResult$member": null
}
},
"BatchDetectKeyPhrasesRequest": {
"base": null,
"refs": {
}
},
"BatchDetectKeyPhrasesResponse": {
"base": null,
"refs": {
}
},
"BatchDetectSentimentItemResult": {
"base": "<p>The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.</p>",
"refs": {
"ListOfDetectSentimentResult$member": null
}
},
"BatchDetectSentimentRequest": {
"base": null,
"refs": {
}
},
"BatchDetectSentimentResponse": {
"base": null,
"refs": {
}
},
"BatchItemError": {
"base": "<p>Describes an error that occurred while processing a document in a batch. The operation returns on <code>BatchItemError</code> object for each document that contained an error.</p>",
"refs": {
"BatchItemErrorList$member": null
}
},
"BatchItemErrorList": {
"base": null,
"refs": {
"BatchDetectDominantLanguageResponse$ErrorList": "<p>A list containing one object for each document that contained an error. The results are sorted in ascending order by the <code>Index</code> field and match the order of the documents in the input list. If there are no errors in the batch, the <code>ErrorList</code> is empty.</p>",
"BatchDetectEntitiesResponse$ErrorList": "<p>A list containing one object for each document that contained an error. The results are sorted in ascending order by the <code>Index</code> field and match the order of the documents in the input list. If there are no errors in the batch, the <code>ErrorList</code> is empty.</p>",
"BatchDetectKeyPhrasesResponse$ErrorList": "<p>A list containing one object for each document that contained an error. The results are sorted in ascending order by the <code>Index</code> field and match the order of the documents in the input list. If there are no errors in the batch, the <code>ErrorList</code> is empty.</p>",
"BatchDetectSentimentResponse$ErrorList": "<p>A list containing one object for each document that contained an error. The results are sorted in ascending order by the <code>Index</code> field and match the order of the documents in the input list. If there are no errors in the batch, the <code>ErrorList</code> is empty.</p>"
}
},
"BatchSizeLimitExceededException": {
"base": "<p>The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.</p>",
"refs": {
}
},
"ClientRequestTokenString": {
"base": null,
"refs": {
"StartTopicsDetectionJobRequest$ClientRequestToken": "<p>A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.</p>"
}
},
"DescribeTopicsDetectionJobRequest": {
"base": null,
"refs": {
}
},
"DescribeTopicsDetectionJobResponse": {
"base": null,
"refs": {
}
},
"DetectDominantLanguageRequest": {
"base": null,
"refs": {
}
},
"DetectDominantLanguageResponse": {
"base": null,
"refs": {
}
},
"DetectEntitiesRequest": {
"base": null,
"refs": {
}
},
"DetectEntitiesResponse": {
"base": null,
"refs": {
}
},
"DetectKeyPhrasesRequest": {
"base": null,
"refs": {
}
},
"DetectKeyPhrasesResponse": {
"base": null,
"refs": {
}
},
"DetectSentimentRequest": {
"base": null,
"refs": {
}
},
"DetectSentimentResponse": {
"base": null,
"refs": {
}
},
"DominantLanguage": {
"base": "<p>Returns the code for the dominant language in the input text and the level of confidence that Amazon Comprehend has in the accuracy of the detection.</p>",
"refs": {
"ListOfDominantLanguages$member": null
}
},
"Entity": {
"base": "<p>Provides information about an entity. </p> <p> </p>",
"refs": {
"ListOfEntities$member": null
}
},
"EntityType": {
"base": null,
"refs": {
"Entity$Type": "<p>The entity's type.</p>"
}
},
"Float": {
"base": null,
"refs": {
"DominantLanguage$Score": "<p>The level of confidence that Amazon Comprehend has in the accuracy of the detection.</p>",
"Entity$Score": "<p>The level of confidence that Amazon Comprehend has in the accuracy of the detection.</p>",
"KeyPhrase$Score": "<p>The level of confidence that Amazon Comprehend has in the accuracy of the detection.</p>",
"SentimentScore$Positive": "<p>The level of confidence that Amazon Comprehend has in the accuracy of its detection of the <code>POSITIVE</code> sentiment.</p>",
"SentimentScore$Negative": "<p>The level of confidence that Amazon Comprehend has in the accuracy of its detection of the <code>NEGATIVE</code> sentiment.</p>",
"SentimentScore$Neutral": "<p>The level of confidence that Amazon Comprehend has in the accuracy of its detection of the <code>NEUTRAL</code> sentiment.</p>",
"SentimentScore$Mixed": "<p>The level of confidence that Amazon Comprehend has in the accuracy of its detection of the <code>MIXED</code> sentiment.</p>"
}
},
"IamRoleArn": {
"base": null,
"refs": {
"StartTopicsDetectionJobRequest$DataAccessRoleArn": "<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. </p>"
}
},
"InputDataConfig": {
"base": "<p>The input properties for a topic detection job.</p>",
"refs": {
"StartTopicsDetectionJobRequest$InputDataConfig": "<p>Specifies the format and location of the input data for the job.</p>",
"TopicsDetectionJobProperties$InputDataConfig": "<p>The input data configuration supplied when you created the topic detection job.</p>"
}
},
"InputFormat": {
"base": null,
"refs": {
"InputDataConfig$InputFormat": "<p>Specifies how the text in an input file should be processed:</p> <ul> <li> <p> <code>ONE_DOC_PER_FILE</code> - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.</p> </li> <li> <p> <code>ONE_DOC_PER_LINE</code> - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.</p> </li> </ul>"
}
},
"Integer": {
"base": null,
"refs": {
"BatchDetectDominantLanguageItemResult$Index": "<p>The zero-based index of the document in the input list.</p>",
"BatchDetectEntitiesItemResult$Index": "<p>The zero-based index of the document in the input list.</p>",
"BatchDetectKeyPhrasesItemResult$Index": "<p>The zero-based index of the document in the input list.</p>",
"BatchDetectSentimentItemResult$Index": "<p>The zero-based index of the document in the input list.</p>",
"BatchItemError$Index": "<p>The zero-based index of the document in the input list.</p>",
"Entity$BeginOffset": "<p>A character offset in the input text that shows where the entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A <i>code point</i> is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.</p>",
"Entity$EndOffset": "<p>A character offset in the input text that shows where the entity ends. The offset returns the position of each UTF-8 code point in the string. A <i>code point</i> is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point. </p>",
"KeyPhrase$BeginOffset": "<p>A character offset in the input text that shows where the key phrase begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A <i>code point</i> is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.</p>",
"KeyPhrase$EndOffset": "<p>A character offset in the input text where the key phrase ends. The offset returns the position of each UTF-8 code point in the string. A <code>code point</code> is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.</p>",
"TopicsDetectionJobProperties$NumberOfTopics": "<p>The number of topics to detect supplied when you created the topic detection job. The default is 10. </p>"
}
},
"InternalServerException": {
"base": "<p>An internal server error occurred. Retry your request.</p>",
"refs": {
}
},
"InvalidFilterException": {
"base": "<p>The filter specified for the <code>ListTopicDetectionJobs</code> operation is invalid. Specify a different filter.</p>",
"refs": {
}
},
"InvalidRequestException": {
"base": "<p>The request is invalid.</p>",
"refs": {
}
},
"JobId": {
"base": null,
"refs": {
"DescribeTopicsDetectionJobRequest$JobId": "<p>The identifier assigned by the user to the detection job.</p>",
"StartTopicsDetectionJobResponse$JobId": "<p>The identifier generated for the job. To get the status of the job, use this identifier with the <code>DescribeTopicDetectionJob</code> operation.</p>",
"TopicsDetectionJobProperties$JobId": "<p>The identifier assigned to the topic detection job.</p>"
}
},
"JobName": {
"base": null,
"refs": {
"StartTopicsDetectionJobRequest$JobName": "<p>The identifier of the job.</p>",
"TopicsDetectionJobFilter$JobName": "<p/>",
"TopicsDetectionJobProperties$JobName": "<p>The name of the topic detection job.</p>"
}
},
"JobNotFoundException": {
"base": "<p>The specified job was not found. Check the job ID and try again.</p>",
"refs": {
}
},
"JobStatus": {
"base": null,
"refs": {
"StartTopicsDetectionJobResponse$JobStatus": "<p>The status of the job: </p> <ul> <li> <p>SUBMITTED - The job has been received and is queued for processing.</p> </li> <li> <p>IN_PROGRESS - Amazon Comprehend is processing the job.</p> </li> <li> <p>COMPLETED - The job was successfully completed and the output is available.</p> </li> <li> <p>FAILED - The job did not complete. To get details, use the <code>DescribeTopicDetectionJob</code> operation.</p> </li> </ul>",
"TopicsDetectionJobFilter$JobStatus": "<p>Filters the list of topic detection jobs based on job status. Returns only jobs with the specified status.</p>",
"TopicsDetectionJobProperties$JobStatus": "<p>The current status of the topic detection job. If the status is <code>Failed</code>, the reason for the failure is shown in the <code>Message</code> field.</p>"
}
},
"KeyPhrase": {
"base": "<p>Describes a key noun phrase.</p>",
"refs": {
"ListOfKeyPhrases$member": null
}
},
"LanguageCode": {
"base": null,
"refs": {
"DetectEntitiesRequest$LanguageCode": "<p>The RFC 5646 language code of the input text. If the request does not specify the language code, the service detects the dominant language. If you specify a language code that the service does not support, it returns <code>UnsupportedLanguageException</code> exception. For more information about RFC 5646, see <a href=\"https://tools.ietf.org/html/rfc5646\">Tags for Identifying Languages</a> on the <i>IETF Tools</i> web site. </p>",
"DetectKeyPhrasesRequest$LanguageCode": "<p>The RFC 5646 language code for the input text. If you don't specify a language code, Amazon Comprehend detects the dominant language. If you specify the code for a language that Amazon Comprehend does not support, it returns and <code>UnsupportedLanguageException</code>. For more information about RFC 5646, see <a href=\"https://tools.ietf.org/html/rfc5646\">Tags for Identifying Languages</a> on the <i>IETF Tools</i> web site.</p>",
"DetectSentimentRequest$LanguageCode": "<p>The RFC 5646 language code for the input text. If you don't specify a language code, Amazon Comprehend detects the dominant language. If you specify the code for a language that Amazon Comprehend does not support, it returns and <code>UnsupportedLanguageException</code>. For more information about RFC 5646, see <a href=\"https://tools.ietf.org/html/rfc5646\">Tags for Identifying Languages</a> on the <i>IETF Tools</i> web site.</p>"
}
},
"ListOfDetectDominantLanguageResult": {
"base": null,
"refs": {
"BatchDetectDominantLanguageResponse$ResultList": "<p>A list of objects containing the results of the operation. The results are sorted in ascending order by the <code>Index</code> field and match the order of the documents in the input list. If all of the documents contain an error, the <code>ResultList</code> is empty.</p>"
}
},
"ListOfDetectEntitiesResult": {
"base": null,
"refs": {
"BatchDetectEntitiesResponse$ResultList": "<p>A list of objects containing the results of the operation. The results are sorted in ascending order by the <code>Index</code> field and match the order of the documents in the input list. If all of the documents contain an error, the <code>ResultList</code> is empty.</p>"
}
},
"ListOfDetectKeyPhrasesResult": {
"base": null,
"refs": {
"BatchDetectKeyPhrasesResponse$ResultList": "<p>A list of objects containing the results of the operation. The results are sorted in ascending order by the <code>Index</code> field and match the order of the documents in the input list. If all of the documents contain an error, the <code>ResultList</code> is empty.</p>"
}
},
"ListOfDetectSentimentResult": {
"base": null,
"refs": {
"BatchDetectSentimentResponse$ResultList": "<p>A list of objects containing the results of the operation. The results are sorted in ascending order by the <code>Index</code> field and match the order of the documents in the input list. If all of the documents contain an error, the <code>ResultList</code> is empty.</p>"
}
},
"ListOfDominantLanguages": {
"base": null,
"refs": {
"BatchDetectDominantLanguageItemResult$Languages": "<p>One or more <a>DominantLanguage</a> objects describing the dominant languages in the document.</p>",
"DetectDominantLanguageResponse$Languages": "<p>The languages that Amazon Comprehend detected in the input text. For each language, the response returns the RFC 5646 language code and the level of confidence that Amazon Comprehend has in the accuracy of its inference. For more information about RFC 5646, see <a href=\"https://tools.ietf.org/html/rfc5646\">Tags for Identifying Languages</a> on the <i>IETF Tools</i> web site.</p>"
}
},
"ListOfEntities": {
"base": null,
"refs": {
"BatchDetectEntitiesItemResult$Entities": "<p>One or more <a>Entity</a> objects, one for each entity detected in the document.</p>",
"DetectEntitiesResponse$Entities": "<p>A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection. For a list of entity types, see <a>how-entities</a>. </p>"
}
},
"ListOfKeyPhrases": {
"base": null,
"refs": {
"BatchDetectKeyPhrasesItemResult$KeyPhrases": "<p>One or more <a>KeyPhrase</a> objects, one for each key phrase detected in the document.</p>",
"DetectKeyPhrasesResponse$KeyPhrases": "<p>A collection of key phrases that Amazon Comprehend identified in the input text. For each key phrase, the response provides the text of the key phrase, where the key phrase begins and ends, and the level of confidence that Amazon Comprehend has in the accuracy of the detection. </p>"
}
},
"ListTopicsDetectionJobsRequest": {
"base": null,
"refs": {
}
},
"ListTopicsDetectionJobsResponse": {
"base": null,
"refs": {
}
},
"MaxResultsInteger": {
"base": null,
"refs": {
"ListTopicsDetectionJobsRequest$MaxResults": "<p>The maximum number of results to return in each page.</p>"
}
},
"NumberOfTopicsInteger": {
"base": null,
"refs": {
"StartTopicsDetectionJobRequest$NumberOfTopics": "<p>The number of topics to detect.</p>"
}
},
"OutputDataConfig": {
"base": "<p>Provides configuration parameters for the output of topic detection jobs.</p> <p/>",
"refs": {
"StartTopicsDetectionJobRequest$OutputDataConfig": "<p>Specifies where to send the output files.</p>",
"TopicsDetectionJobProperties$OutputDataConfig": "<p>The output data configuration supplied when you created the topic detection job.</p>"
}
},
"S3Uri": {
"base": null,
"refs": {
"InputDataConfig$S3Uri": "<p>The Amazon S3 URI for the input data. The URI must be in same region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files. </p> <p>For example, if you use the URI <code>S3://bucketName/prefix</code>, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.</p>",
"OutputDataConfig$S3Uri": "<p>The Amazon S3 URI where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. </p> <p>The service creates an output file called <code>output.tar.gz</code>. It is a compressed archive that contains two files, <code>topic-terms.csv</code> that lists the terms associated with each topic, and <code>doc-topics.csv</code> that lists the documents associated with each topic. For more information, see <a>topic-modeling</a>.</p>"
}
},
"SentimentScore": {
"base": "<p>Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of sentiments.</p>",
"refs": {
"BatchDetectSentimentItemResult$SentimentScore": "<p>The level of confidence that Amazon Comprehend has in the accuracy of its sentiment detection.</p>",
"DetectSentimentResponse$SentimentScore": "<p>An object that lists the sentiments, and their corresponding confidence levels.</p>"
}
},
"SentimentType": {
"base": null,
"refs": {
"BatchDetectSentimentItemResult$Sentiment": "<p>The sentiment detected in the document.</p>",
"DetectSentimentResponse$Sentiment": "<p>The inferred sentiment that Amazon Comprehend has the highest level of confidence in.</p>"
}
},
"StartTopicsDetectionJobRequest": {
"base": null,
"refs": {
}
},
"StartTopicsDetectionJobResponse": {
"base": null,
"refs": {
}
},
"String": {
"base": null,
"refs": {
"BatchDetectEntitiesRequest$LanguageCode": "<p>The language of the input documents. All documents must be in the same language.</p>",
"BatchDetectKeyPhrasesRequest$LanguageCode": "<p>The language of the input documents. All documents must be in the same language.</p>",
"BatchDetectSentimentRequest$LanguageCode": "<p>The language of the input documents. All documents must be in the same language.</p>",
"BatchItemError$ErrorCode": "<p>The numeric error code of the error.</p>",
"BatchItemError$ErrorMessage": "<p>A text description of the error.</p>",
"BatchSizeLimitExceededException$Message": null,
"DetectDominantLanguageRequest$Text": "<p>A UTF-8 text string. Each string should contain at least 20 characters and must contain fewer that 5,000 bytes of UTF-8 encoded characters.</p>",
"DetectEntitiesRequest$Text": "<p>A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.</p>",
"DetectKeyPhrasesRequest$Text": "<p>A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.</p>",
"DetectSentimentRequest$Text": "<p>A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.</p>",
"DominantLanguage$LanguageCode": "<p>The RFC 5646 language code for the dominant language. </p>",
"Entity$Text": "<p>The text of the entity.</p>",
"InternalServerException$Message": null,
"InvalidFilterException$Message": null,
"InvalidRequestException$Message": null,
"JobNotFoundException$Message": null,
"KeyPhrase$Text": "<p>The text of a key noun phrase.</p>",
"ListTopicsDetectionJobsRequest$NextToken": "<p>Identifies the next page of results to return.</p>",
"ListTopicsDetectionJobsResponse$NextToken": "<p>Identifies the next page of results to return.</p>",
"StringList$member": null,
"TextSizeLimitExceededException$Message": null,
"TooManyRequestsException$Message": null,
"UnsupportedLanguageException$Message": null
}
},
"StringList": {
"base": null,
"refs": {
"BatchDetectDominantLanguageRequest$TextList": "<p>A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document should contain at least 20 characters and must contain fewer than 5,000 bytes of UTF-8 encoded characters.</p>",
"BatchDetectEntitiesRequest$TextList": "<p>A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer than 5,000 bytes of UTF-8 encoded characters.</p>",
"BatchDetectKeyPhrasesRequest$TextList": "<p>A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.</p>",
"BatchDetectSentimentRequest$TextList": "<p>A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.</p>"
}
},
"TextSizeLimitExceededException": {
"base": "<p>The size of the input text exceeds the limit. Use a smaller document.</p>",
"refs": {
}
},
"Timestamp": {
"base": null,
"refs": {
"TopicsDetectionJobFilter$SubmitTimeBefore": "<p>Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.</p>",
"TopicsDetectionJobFilter$SubmitTimeAfter": "<p>Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.</p>",
"TopicsDetectionJobProperties$SubmitTime": "<p>The time that the topic detection job was submitted for processing.</p>",
"TopicsDetectionJobProperties$EndTime": "<p>The time that the topic detection job was completed.</p>"
}
},
"TooManyRequestsException": {
"base": "<p>The number of requests exceeds the limit. Resubmit your request later.</p>",
"refs": {
}
},
"TopicsDetectionJobFilter": {
"base": "<p>Provides information for filtering topic detection jobs. For more information, see .</p>",
"refs": {
"ListTopicsDetectionJobsRequest$Filter": "<p>Filters the jobs that are returned. Jobs can be filtered on their name, status, or the date and time that they were submitted. You can set only one filter at a time.</p>"
}
},
"TopicsDetectionJobProperties": {
"base": "<p>Provides information about a topic detection job.</p>",
"refs": {
"DescribeTopicsDetectionJobResponse$TopicsDetectionJobProperties": "<p>The list of properties for the requested job.</p>",
"TopicsDetectionJobPropertiesList$member": null
}
},
"TopicsDetectionJobPropertiesList": {
"base": null,
"refs": {
"ListTopicsDetectionJobsResponse$TopicsDetectionJobPropertiesList": "<p>A list containing the properties of each job that is returned.</p>"
}
},
"UnsupportedLanguageException": {
"base": "<p>Amazon Comprehend can't process the language of the input text. For all APIs except <code>DetectDominantLanguage</code>, Amazon Comprehend accepts only English or Spanish text. For the <code>DetectDominantLanguage</code> API, Amazon Comprehend detects 100 languages. For a list of languages, see <a>how-languages</a> </p>",
"refs": {
}
}
}
}

View File

@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}

View File

@ -0,0 +1,9 @@
{
"pagination": {
"ListTopicsDetectionJobs": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
}
}
}

View File

@ -1348,7 +1348,16 @@
"AWS::AutoScaling::AutoScalingGroup",
"AWS::AutoScaling::LaunchConfiguration",
"AWS::AutoScaling::ScalingPolicy",
"AWS::AutoScaling::ScheduledAction"
"AWS::AutoScaling::ScheduledAction",
"AWS::CodeBuild::Project",
"AWS::WAF::RateBasedRule",
"AWS::WAF::Rule",
"AWS::WAF::WebACL",
"AWS::WAFRegional::RateBasedRule",
"AWS::WAFRegional::Rule",
"AWS::WAFRegional::WebACL",
"AWS::CloudFront::Distribution",
"AWS::CloudFront::StreamingDistribution"
]
},
"ResourceTypeList":{

View File

@ -168,6 +168,32 @@
{"shape":"DirectConnectClientException"}
]
},
"CreateDirectConnectGateway":{
"name":"CreateDirectConnectGateway",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateDirectConnectGatewayRequest"},
"output":{"shape":"CreateDirectConnectGatewayResult"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
]
},
"CreateDirectConnectGatewayAssociation":{
"name":"CreateDirectConnectGatewayAssociation",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateDirectConnectGatewayAssociationRequest"},
"output":{"shape":"CreateDirectConnectGatewayAssociationResult"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
]
},
"CreateInterconnect":{
"name":"CreateInterconnect",
"http":{
@ -246,6 +272,32 @@
{"shape":"DirectConnectClientException"}
]
},
"DeleteDirectConnectGateway":{
"name":"DeleteDirectConnectGateway",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteDirectConnectGatewayRequest"},
"output":{"shape":"DeleteDirectConnectGatewayResult"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
]
},
"DeleteDirectConnectGatewayAssociation":{
"name":"DeleteDirectConnectGatewayAssociation",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteDirectConnectGatewayAssociationRequest"},
"output":{"shape":"DeleteDirectConnectGatewayAssociationResult"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
]
},
"DeleteInterconnect":{
"name":"DeleteInterconnect",
"http":{
@ -326,6 +378,45 @@
],
"deprecated":true
},
"DescribeDirectConnectGatewayAssociations":{
"name":"DescribeDirectConnectGatewayAssociations",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeDirectConnectGatewayAssociationsRequest"},
"output":{"shape":"DescribeDirectConnectGatewayAssociationsResult"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
]
},
"DescribeDirectConnectGatewayAttachments":{
"name":"DescribeDirectConnectGatewayAttachments",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeDirectConnectGatewayAttachmentsRequest"},
"output":{"shape":"DescribeDirectConnectGatewayAttachmentsResult"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
]
},
"DescribeDirectConnectGateways":{
"name":"DescribeDirectConnectGateways",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeDirectConnectGatewaysRequest"},
"output":{"shape":"DescribeDirectConnectGatewaysResult"},
"errors":[
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
]
},
"DescribeHostedConnections":{
"name":"DescribeHostedConnections",
"http":{
@ -653,13 +744,11 @@
},
"ConfirmPrivateVirtualInterfaceRequest":{
"type":"structure",
"required":[
"virtualInterfaceId",
"virtualGatewayId"
],
"required":["virtualInterfaceId"],
"members":{
"virtualInterfaceId":{"shape":"VirtualInterfaceId"},
"virtualGatewayId":{"shape":"VirtualGatewayId"}
"virtualGatewayId":{"shape":"VirtualGatewayId"},
"directConnectGatewayId":{"shape":"DirectConnectGatewayId"}
}
},
"ConfirmPrivateVirtualInterfaceResponse":{
@ -751,6 +840,37 @@
"lagId":{"shape":"LagId"}
}
},
"CreateDirectConnectGatewayAssociationRequest":{
"type":"structure",
"required":[
"directConnectGatewayId",
"virtualGatewayId"
],
"members":{
"directConnectGatewayId":{"shape":"DirectConnectGatewayId"},
"virtualGatewayId":{"shape":"VirtualGatewayId"}
}
},
"CreateDirectConnectGatewayAssociationResult":{
"type":"structure",
"members":{
"directConnectGatewayAssociation":{"shape":"DirectConnectGatewayAssociation"}
}
},
"CreateDirectConnectGatewayRequest":{
"type":"structure",
"required":["directConnectGatewayName"],
"members":{
"directConnectGatewayName":{"shape":"DirectConnectGatewayName"},
"amazonSideAsn":{"shape":"LongAsn"}
}
},
"CreateDirectConnectGatewayResult":{
"type":"structure",
"members":{
"directConnectGateway":{"shape":"DirectConnectGateway"}
}
},
"CreateInterconnectRequest":{
"type":"structure",
"required":[
@ -825,6 +945,36 @@
"connectionId":{"shape":"ConnectionId"}
}
},
"DeleteDirectConnectGatewayAssociationRequest":{
"type":"structure",
"required":[
"directConnectGatewayId",
"virtualGatewayId"
],
"members":{
"directConnectGatewayId":{"shape":"DirectConnectGatewayId"},
"virtualGatewayId":{"shape":"VirtualGatewayId"}
}
},
"DeleteDirectConnectGatewayAssociationResult":{
"type":"structure",
"members":{
"directConnectGatewayAssociation":{"shape":"DirectConnectGatewayAssociation"}
}
},
"DeleteDirectConnectGatewayRequest":{
"type":"structure",
"required":["directConnectGatewayId"],
"members":{
"directConnectGatewayId":{"shape":"DirectConnectGatewayId"}
}
},
"DeleteDirectConnectGatewayResult":{
"type":"structure",
"members":{
"directConnectGateway":{"shape":"DirectConnectGateway"}
}
},
"DeleteInterconnectRequest":{
"type":"structure",
"required":["interconnectId"],
@ -886,6 +1036,53 @@
"connectionId":{"shape":"ConnectionId"}
}
},
"DescribeDirectConnectGatewayAssociationsRequest":{
"type":"structure",
"members":{
"directConnectGatewayId":{"shape":"DirectConnectGatewayId"},
"virtualGatewayId":{"shape":"VirtualGatewayId"},
"maxResults":{"shape":"MaxResultSetSize"},
"nextToken":{"shape":"PaginationToken"}
}
},
"DescribeDirectConnectGatewayAssociationsResult":{
"type":"structure",
"members":{
"directConnectGatewayAssociations":{"shape":"DirectConnectGatewayAssociationList"},
"nextToken":{"shape":"PaginationToken"}
}
},
"DescribeDirectConnectGatewayAttachmentsRequest":{
"type":"structure",
"members":{
"directConnectGatewayId":{"shape":"DirectConnectGatewayId"},
"virtualInterfaceId":{"shape":"VirtualInterfaceId"},
"maxResults":{"shape":"MaxResultSetSize"},
"nextToken":{"shape":"PaginationToken"}
}
},
"DescribeDirectConnectGatewayAttachmentsResult":{
"type":"structure",
"members":{
"directConnectGatewayAttachments":{"shape":"DirectConnectGatewayAttachmentList"},
"nextToken":{"shape":"PaginationToken"}
}
},
"DescribeDirectConnectGatewaysRequest":{
"type":"structure",
"members":{
"directConnectGatewayId":{"shape":"DirectConnectGatewayId"},
"maxResults":{"shape":"MaxResultSetSize"},
"nextToken":{"shape":"PaginationToken"}
}
},
"DescribeDirectConnectGatewaysResult":{
"type":"structure",
"members":{
"directConnectGateways":{"shape":"DirectConnectGatewayList"},
"nextToken":{"shape":"PaginationToken"}
}
},
"DescribeHostedConnectionsRequest":{
"type":"structure",
"required":["connectionId"],
@ -956,6 +1153,80 @@
},
"exception":true
},
"DirectConnectGateway":{
"type":"structure",
"members":{
"directConnectGatewayId":{"shape":"DirectConnectGatewayId"},
"directConnectGatewayName":{"shape":"DirectConnectGatewayName"},
"amazonSideAsn":{"shape":"LongAsn"},
"ownerAccount":{"shape":"OwnerAccount"},
"directConnectGatewayState":{"shape":"DirectConnectGatewayState"},
"stateChangeError":{"shape":"StateChangeError"}
}
},
"DirectConnectGatewayAssociation":{
"type":"structure",
"members":{
"directConnectGatewayId":{"shape":"DirectConnectGatewayId"},
"virtualGatewayId":{"shape":"VirtualGatewayId"},
"virtualGatewayRegion":{"shape":"VirtualGatewayRegion"},
"virtualGatewayOwnerAccount":{"shape":"OwnerAccount"},
"associationState":{"shape":"DirectConnectGatewayAssociationState"},
"stateChangeError":{"shape":"StateChangeError"}
}
},
"DirectConnectGatewayAssociationList":{
"type":"list",
"member":{"shape":"DirectConnectGatewayAssociation"}
},
"DirectConnectGatewayAssociationState":{
"type":"string",
"enum":[
"associating",
"associated",
"disassociating",
"disassociated"
]
},
"DirectConnectGatewayAttachment":{
"type":"structure",
"members":{
"directConnectGatewayId":{"shape":"DirectConnectGatewayId"},
"virtualInterfaceId":{"shape":"VirtualInterfaceId"},
"virtualInterfaceRegion":{"shape":"VirtualInterfaceRegion"},
"virtualInterfaceOwnerAccount":{"shape":"OwnerAccount"},
"attachmentState":{"shape":"DirectConnectGatewayAttachmentState"},
"stateChangeError":{"shape":"StateChangeError"}
}
},
"DirectConnectGatewayAttachmentList":{
"type":"list",
"member":{"shape":"DirectConnectGatewayAttachment"}
},
"DirectConnectGatewayAttachmentState":{
"type":"string",
"enum":[
"attaching",
"attached",
"detaching",
"detached"
]
},
"DirectConnectGatewayId":{"type":"string"},
"DirectConnectGatewayList":{
"type":"list",
"member":{"shape":"DirectConnectGateway"}
},
"DirectConnectGatewayName":{"type":"string"},
"DirectConnectGatewayState":{
"type":"string",
"enum":[
"pending",
"available",
"deleting",
"deleted"
]
},
"DirectConnectServerException":{
"type":"structure",
"members":{
@ -1090,6 +1361,11 @@
"locations":{"shape":"LocationList"}
}
},
"LongAsn":{"type":"long"},
"MaxResultSetSize":{
"type":"integer",
"box":true
},
"NewBGPPeer":{
"type":"structure",
"members":{
@ -1105,8 +1381,7 @@
"required":[
"virtualInterfaceName",
"vlan",
"asn",
"virtualGatewayId"
"asn"
],
"members":{
"virtualInterfaceName":{"shape":"VirtualInterfaceName"},
@ -1116,7 +1391,8 @@
"amazonAddress":{"shape":"AmazonAddress"},
"customerAddress":{"shape":"CustomerAddress"},
"addressFamily":{"shape":"AddressFamily"},
"virtualGatewayId":{"shape":"VirtualGatewayId"}
"virtualGatewayId":{"shape":"VirtualGatewayId"},
"directConnectGatewayId":{"shape":"DirectConnectGatewayId"}
}
},
"NewPrivateVirtualInterfaceAllocation":{
@ -1173,6 +1449,7 @@
}
},
"OwnerAccount":{"type":"string"},
"PaginationToken":{"type":"string"},
"PartnerName":{"type":"string"},
"ProviderName":{"type":"string"},
"Region":{"type":"string"},
@ -1203,6 +1480,7 @@
"member":{"shape":"RouteFilterPrefix"}
},
"RouterConfig":{"type":"string"},
"StateChangeError":{"type":"string"},
"Tag":{
"type":"structure",
"required":["key"],
@ -1292,6 +1570,7 @@
"type":"list",
"member":{"shape":"VirtualGateway"}
},
"VirtualGatewayRegion":{"type":"string"},
"VirtualGatewayState":{"type":"string"},
"VirtualGateways":{
"type":"structure",
@ -1310,6 +1589,7 @@
"virtualInterfaceName":{"shape":"VirtualInterfaceName"},
"vlan":{"shape":"VLAN"},
"asn":{"shape":"ASN"},
"amazonSideAsn":{"shape":"LongAsn"},
"authKey":{"shape":"BGPAuthKey"},
"amazonAddress":{"shape":"AmazonAddress"},
"customerAddress":{"shape":"CustomerAddress"},
@ -1317,6 +1597,7 @@
"virtualInterfaceState":{"shape":"VirtualInterfaceState"},
"customerRouterConfig":{"shape":"RouterConfig"},
"virtualGatewayId":{"shape":"VirtualGatewayId"},
"directConnectGatewayId":{"shape":"DirectConnectGatewayId"},
"routeFilterPrefixes":{"shape":"RouteFilterPrefixList"},
"bgpPeers":{"shape":"BGPPeerList"}
}
@ -1327,6 +1608,7 @@
"member":{"shape":"VirtualInterface"}
},
"VirtualInterfaceName":{"type":"string"},
"VirtualInterfaceRegion":{"type":"string"},
"VirtualInterfaceState":{
"type":"string",
"enum":[

View File

@ -8,30 +8,37 @@
"AllocatePublicVirtualInterface": "<p>Provisions a public virtual interface to be owned by a different customer.</p> <p>The owner of a connection calls this function to provision a public virtual interface which will be owned by another AWS customer.</p> <p>Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic.</p> <p>When creating an IPv6 public virtual interface (addressFamily is 'ipv6'), the customer and amazon address fields should be left blank to use auto-assigned IPv6 space. Custom IPv6 Addresses are currently not supported.</p>",
"AssociateConnectionWithLag": "<p>Associates an existing connection with a link aggregation group (LAG). The connection is interrupted and re-established as a member of the LAG (connectivity to AWS will be interrupted). The connection must be hosted on the same AWS Direct Connect endpoint as the LAG, and its bandwidth must match the bandwidth for the LAG. You can reassociate a connection that's currently associated with a different LAG; however, if removing the connection will cause the original LAG to fall below its setting for minimum number of operational connections, the request fails.</p> <p>Any virtual interfaces that are directly associated with the connection are automatically re-associated with the LAG. If the connection was originally associated with a different LAG, the virtual interfaces remain associated with the original LAG.</p> <p>For interconnects, any hosted connections are automatically re-associated with the LAG. If the interconnect was originally associated with a different LAG, the hosted connections remain associated with the original LAG.</p>",
"AssociateHostedConnection": "<p>Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted connection with a conflicting VLAN number or IP address, the operation fails. This action temporarily interrupts the hosted connection's connectivity to AWS as it is being migrated.</p> <note> <p>This is intended for use by AWS Direct Connect partners only.</p> </note>",
"AssociateVirtualInterface": "<p>Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to AWS is temporarily interrupted as the virtual interface is being migrated. If the target connection or LAG has an associated virtual interface with a conflicting VLAN number or a conflicting IP address, the operation fails. </p> <p>Virtual interfaces associated with a hosted connection cannot be associated with a LAG; hosted connections must be migrated along with their virtual interfaces using <a>AssociateHostedConnection</a>.</p> <p>Hosted virtual interfaces (an interface for which the owner of the connection is not the owner of physical connection) can only be reassociated by the owner of the physical connection.</p>",
"AssociateVirtualInterface": "<p>Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to AWS is temporarily interrupted as the virtual interface is being migrated. If the target connection or LAG has an associated virtual interface with a conflicting VLAN number or a conflicting IP address, the operation fails. </p> <p>Virtual interfaces associated with a hosted connection cannot be associated with a LAG; hosted connections must be migrated along with their virtual interfaces using <a>AssociateHostedConnection</a>.</p> <p>In order to reassociate a virtual interface to a new connection or LAG, the requester must own either the virtual interface itself or the connection to which the virtual interface is currently associated. Additionally, the requester must own the connection or LAG to which the virtual interface will be newly associated.</p>",
"ConfirmConnection": "<p>Confirm the creation of a hosted connection on an interconnect.</p> <p>Upon creation, the hosted connection is initially in the 'Ordering' state, and will remain in this state until the owner calls ConfirmConnection to confirm creation of the hosted connection.</p>",
"ConfirmPrivateVirtualInterface": "<p>Accept ownership of a private virtual interface created by another customer.</p> <p>After the virtual interface owner calls this function, the virtual interface will be created and attached to the given virtual private gateway, and will be available for handling traffic.</p>",
"ConfirmPrivateVirtualInterface": "<p>Accept ownership of a private virtual interface created by another customer.</p> <p>After the virtual interface owner calls this function, the virtual interface will be created and attached to the given virtual private gateway or direct connect gateway, and will be available for handling traffic.</p>",
"ConfirmPublicVirtualInterface": "<p>Accept ownership of a public virtual interface created by another customer.</p> <p>After the virtual interface owner calls this function, the specified virtual interface will be created and made available for handling traffic.</p>",
"CreateBGPPeer": "<p>Creates a new BGP peer on a specified virtual interface. The BGP peer cannot be in the same address family (IPv4/IPv6) of an existing BGP peer on the virtual interface.</p> <p>You must create a BGP peer for the corresponding address family in order to access AWS resources that also use that address family.</p> <p>When creating a IPv6 BGP peer, the Amazon address and customer address fields must be left blank. IPv6 addresses are automatically assigned from Amazon's pool of IPv6 addresses; you cannot specify custom IPv6 addresses.</p> <p>For a public virtual interface, the Autonomous System Number (ASN) must be private or already whitelisted for the virtual interface.</p>",
"CreateConnection": "<p>Creates a new connection between the customer network and a specific AWS Direct Connect location.</p> <p>A connection links your internal network to an AWS Direct Connect location over a standard 1 gigabit or 10 gigabit Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. An AWS Direct Connect location provides access to Amazon Web Services in the region it is associated with. You can establish connections with AWS Direct Connect locations in multiple regions, but a connection in one region does not provide connectivity to other regions.</p> <p>You can automatically add the new connection to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new connection is allocated on the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no connection will be created.</p>",
"CreateConnection": "<p>Creates a new connection between the customer network and a specific AWS Direct Connect location.</p> <p>A connection links your internal network to an AWS Direct Connect location over a standard 1 gigabit or 10 gigabit Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. An AWS Direct Connect location provides access to Amazon Web Services in the region it is associated with. You can establish connections with AWS Direct Connect locations in multiple regions, but a connection in one region does not provide connectivity to other regions.</p> <p>To find the locations for your region, use <a>DescribeLocations</a>.</p> <p>You can automatically add the new connection to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new connection is allocated on the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no connection will be created.</p>",
"CreateDirectConnectGateway": "<p>Creates a new direct connect gateway. A direct connect gateway is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways. direct connect gateways are global and visible in any AWS region after they are created. The virtual interfaces and virtual private gateways that are connected through a direct connect gateway can be in different regions. This enables you to connect to a VPC in any region, regardless of the region in which the virtual interfaces are located, and pass traffic between them.</p>",
"CreateDirectConnectGatewayAssociation": "<p>Creates an association between a direct connect gateway and a virtual private gateway (VGW). The VGW must be attached to a VPC and must not be associated with another direct connect gateway.</p>",
"CreateInterconnect": "<p>Creates a new interconnect between a AWS Direct Connect partner's network and a specific AWS Direct Connect location.</p> <p>An interconnect is a connection which is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide sub-1Gbps AWS Direct Connect service to tier 2 customers who do not have their own connections. Like a standard connection, an interconnect links the AWS Direct Connect partner's network to an AWS Direct Connect location over a standard 1 Gbps or 10 Gbps Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect router.</p> <p>You can automatically add the new interconnect to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new interconnect is allocated on the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no interconnect will be created.</p> <p>For each end customer, the AWS Direct Connect partner provisions a connection on their interconnect by calling AllocateConnectionOnInterconnect. The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect partner.</p> <note> <p>This is intended for use by AWS Direct Connect partners only.</p> </note>",
"CreateLag": "<p>Creates a new link aggregation group (LAG) with the specified number of bundled physical connections between the customer network and a specific AWS Direct Connect location. A LAG is a logical interface that uses the Link Aggregation Control Protocol (LACP) to aggregate multiple 1 gigabit or 10 gigabit interfaces, allowing you to treat them as a single interface.</p> <p>All connections in a LAG must use the same bandwidth (for example, 10 Gbps), and must terminate at the same AWS Direct Connect endpoint.</p> <p>You can have up to 10 connections per LAG. Regardless of this limit, if you request more connections for the LAG than AWS Direct Connect can allocate on a single endpoint, no LAG is created.</p> <p>You can specify an existing physical connection or interconnect to include in the LAG (which counts towards the total number of connections). Doing so interrupts the current physical connection or hosted connections, and re-establishes them as a member of the LAG. The LAG will be created on the same AWS Direct Connect endpoint to which the connection terminates. Any virtual interfaces associated with the connection are automatically disassociated and re-associated with the LAG. The connection ID does not change.</p> <p>If the AWS account used to create a LAG is a registered AWS Direct Connect partner, the LAG is automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual interfaces cannot be directly configured.</p>",
"CreatePrivateVirtualInterface": "<p>Creates a new private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A private virtual interface supports sending traffic to a single virtual private cloud (VPC).</p>",
"CreatePublicVirtualInterface": "<p>Creates a new public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A public virtual interface supports sending traffic to public services of AWS such as Amazon Simple Storage Service (Amazon S3).</p> <p>When creating an IPv6 public virtual interface (addressFamily is 'ipv6'), the customer and amazon address fields should be left blank to use auto-assigned IPv6 space. Custom IPv6 Addresses are currently not supported.</p>",
"DeleteBGPPeer": "<p>Deletes a BGP peer on the specified virtual interface that matches the specified customer address and ASN. You cannot delete the last BGP peer from a virtual interface.</p>",
"DeleteConnection": "<p>Deletes the connection.</p> <p>Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. You need to cancel separately with the providers any services or charges for cross-connects or network circuits that connect you to the AWS Direct Connect location.</p>",
"DeleteDirectConnectGateway": "<p>Deletes a direct connect gateway. You must first delete all virtual interfaces that are attached to the direct connect gateway and disassociate all virtual private gateways that are associated with the direct connect gateway.</p>",
"DeleteDirectConnectGatewayAssociation": "<p>Deletes the association between a direct connect gateway and a virtual private gateway.</p>",
"DeleteInterconnect": "<p>Deletes the specified interconnect.</p> <note> <p>This is intended for use by AWS Direct Connect partners only.</p> </note>",
"DeleteLag": "<p>Deletes a link aggregation group (LAG). You cannot delete a LAG if it has active virtual interfaces or hosted connections.</p>",
"DeleteVirtualInterface": "<p>Deletes a virtual interface.</p>",
"DescribeConnectionLoa": "<p>Deprecated in favor of <a>DescribeLoa</a>.</p> <p>Returns the LOA-CFA for a Connection.</p> <p>The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or service provider uses when establishing your cross connect to AWS at the colocation facility. For more information, see <a href=\"http://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html\">Requesting Cross Connects at AWS Direct Connect Locations</a> in the AWS Direct Connect user guide.</p>",
"DescribeConnections": "<p>Displays all connections in this region.</p> <p>If a connection ID is provided, the call returns only that particular connection.</p>",
"DescribeConnectionsOnInterconnect": "<p>Deprecated in favor of <a>DescribeHostedConnections</a>.</p> <p>Returns a list of connections that have been provisioned on the given interconnect.</p> <note> <p>This is intended for use by AWS Direct Connect partners only.</p> </note>",
"DescribeDirectConnectGatewayAssociations": "<p>Returns a list of all direct connect gateway and virtual private gateway (VGW) associations. Either a direct connect gateway ID or a VGW ID must be provided in the request. If a direct connect gateway ID is provided, the response returns all VGWs associated with the direct connect gateway. If a VGW ID is provided, the response returns all direct connect gateways associated with the VGW. If both are provided, the response only returns the association that matches both the direct connect gateway and the VGW.</p>",
"DescribeDirectConnectGatewayAttachments": "<p>Returns a list of all direct connect gateway and virtual interface (VIF) attachments. Either a direct connect gateway ID or a VIF ID must be provided in the request. If a direct connect gateway ID is provided, the response returns all VIFs attached to the direct connect gateway. If a VIF ID is provided, the response returns all direct connect gateways attached to the VIF. If both are provided, the response only returns the attachment that matches both the direct connect gateway and the VIF.</p>",
"DescribeDirectConnectGateways": "<p>Returns a list of direct connect gateways in your account. Deleted direct connect gateways are not returned. You can provide a direct connect gateway ID in the request to return information about the specific direct connect gateway only. Otherwise, if a direct connect gateway ID is not provided, information about all of your direct connect gateways is returned. </p>",
"DescribeHostedConnections": "<p>Returns a list of hosted connections that have been provisioned on the given interconnect or link aggregation group (LAG).</p> <note> <p>This is intended for use by AWS Direct Connect partners only.</p> </note>",
"DescribeInterconnectLoa": "<p>Deprecated in favor of <a>DescribeLoa</a>.</p> <p>Returns the LOA-CFA for an Interconnect.</p> <p>The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. For more information, see <a href=\"http://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html\">Requesting Cross Connects at AWS Direct Connect Locations</a> in the AWS Direct Connect user guide.</p>",
"DescribeInterconnects": "<p>Returns a list of interconnects owned by the AWS account.</p> <p>If an interconnect ID is provided, it will only return this particular interconnect.</p>",
"DescribeLags": "<p>Describes the link aggregation groups (LAGs) in your account. </p> <p>If a LAG ID is provided, only information about the specified LAG is returned.</p>",
"DescribeLoa": "<p>Returns the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).</p> <p>The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. For more information, see <a href=\"http://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html\">Requesting Cross Connects at AWS Direct Connect Locations</a> in the AWS Direct Connect user guide.</p>",
"DescribeLocations": "<p>Returns the list of AWS Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect.</p>",
"DescribeLocations": "<p>Returns the list of AWS Direct Connect locations in the current AWS region. These are the locations that may be selected when calling <a>CreateConnection</a> or <a>CreateInterconnect</a>.</p>",
"DescribeTags": "<p>Describes the tags associated with the specified Direct Connect resources.</p>",
"DescribeVirtualGateways": "<p>Returns a list of virtual private gateways owned by the AWS account.</p> <p>You can create one or more AWS Direct Connect private virtual interfaces linking to a virtual private gateway. A virtual private gateway can be managed via Amazon Virtual Private Cloud (VPC) console or the <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-CreateVpnGateway.html\">EC2 CreateVpnGateway</a> action.</p>",
"DescribeVirtualInterfaces": "<p>Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned.</p> <p>A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.</p>",
@ -295,6 +302,26 @@
"refs": {
}
},
"CreateDirectConnectGatewayAssociationRequest": {
"base": "<p>Container for the parameters to the CreateDirectConnectGatewayAssociation operation.</p>",
"refs": {
}
},
"CreateDirectConnectGatewayAssociationResult": {
"base": "<p>Container for the response from the CreateDirectConnectGatewayAssociation API call</p>",
"refs": {
}
},
"CreateDirectConnectGatewayRequest": {
"base": "<p>Container for the parameters to the CreateDirectConnectGateway operation.</p>",
"refs": {
}
},
"CreateDirectConnectGatewayResult": {
"base": "<p>Container for the response from the CreateDirectConnectGateway API call</p>",
"refs": {
}
},
"CreateInterconnectRequest": {
"base": "<p>Container for the parameters to the CreateInterconnect operation.</p>",
"refs": {
@ -343,6 +370,26 @@
"refs": {
}
},
"DeleteDirectConnectGatewayAssociationRequest": {
"base": "<p>Container for the parameters to the DeleteDirectConnectGatewayAssociation operation.</p>",
"refs": {
}
},
"DeleteDirectConnectGatewayAssociationResult": {
"base": "<p>Container for the response from the DeleteDirectConnectGatewayAssociation API call</p>",
"refs": {
}
},
"DeleteDirectConnectGatewayRequest": {
"base": "<p>Container for the parameters to the DeleteDirectConnectGateway operation.</p>",
"refs": {
}
},
"DeleteDirectConnectGatewayResult": {
"base": "<p>Container for the response from the DeleteDirectConnectGateway API call</p>",
"refs": {
}
},
"DeleteInterconnectRequest": {
"base": "<p>Container for the parameters to the DeleteInterconnect operation.</p>",
"refs": {
@ -388,6 +435,36 @@
"refs": {
}
},
"DescribeDirectConnectGatewayAssociationsRequest": {
"base": "<p>Container for the parameters to the DescribeDirectConnectGatewayAssociations operation.</p>",
"refs": {
}
},
"DescribeDirectConnectGatewayAssociationsResult": {
"base": "<p>Container for the response from the DescribeDirectConnectGatewayAssociations API call</p>",
"refs": {
}
},
"DescribeDirectConnectGatewayAttachmentsRequest": {
"base": "<p>Container for the parameters to the DescribeDirectConnectGatewayAttachments operation.</p>",
"refs": {
}
},
"DescribeDirectConnectGatewayAttachmentsResult": {
"base": "<p>Container for the response from the DescribeDirectConnectGatewayAttachments API call</p>",
"refs": {
}
},
"DescribeDirectConnectGatewaysRequest": {
"base": "<p>Container for the parameters to the DescribeDirectConnectGateways operation.</p>",
"refs": {
}
},
"DescribeDirectConnectGatewaysResult": {
"base": "<p>Container for the response from the DescribeDirectConnectGateways API call</p>",
"refs": {
}
},
"DescribeHostedConnectionsRequest": {
"base": "<p>Container for the parameters to the DescribeHostedConnections operation.</p>",
"refs": {
@ -438,6 +515,88 @@
"refs": {
}
},
"DirectConnectGateway": {
"base": "<p>A direct connect gateway is an intermediate object that enables you to connect virtual interfaces and virtual private gateways.</p>",
"refs": {
"CreateDirectConnectGatewayResult$directConnectGateway": "<p>The direct connect gateway to be created.</p>",
"DeleteDirectConnectGatewayResult$directConnectGateway": "<p>The direct connect gateway to be deleted.</p>",
"DirectConnectGatewayList$member": null
}
},
"DirectConnectGatewayAssociation": {
"base": "<p>The association between a direct connect gateway and virtual private gateway.</p>",
"refs": {
"CreateDirectConnectGatewayAssociationResult$directConnectGatewayAssociation": "<p>The direct connect gateway association to be created.</p>",
"DeleteDirectConnectGatewayAssociationResult$directConnectGatewayAssociation": "<p>The direct connect gateway association to be deleted.</p>",
"DirectConnectGatewayAssociationList$member": null
}
},
"DirectConnectGatewayAssociationList": {
"base": "<p>A list of direct connect gateway associations.</p>",
"refs": {
"DescribeDirectConnectGatewayAssociationsResult$directConnectGatewayAssociations": "<p>Information about the direct connect gateway associations.</p>"
}
},
"DirectConnectGatewayAssociationState": {
"base": "<p>State of the direct connect gateway association.</p> <ul> <li> <p> <b>Associating</b>: The initial state after calling <a>CreateDirectConnectGatewayAssociation</a>.</p> </li> <li> <p> <b>Associated</b>: The direct connect gateway and virtual private gateway are successfully associated and ready to pass traffic.</p> </li> <li> <p> <b>Disassociating</b>: The initial state after calling <a>DeleteDirectConnectGatewayAssociation</a>.</p> </li> <li> <p> <b>Disassociated</b>: The virtual private gateway is successfully disassociated from the direct connect gateway. Traffic flow between the direct connect gateway and virtual private gateway stops.</p> </li> </ul>",
"refs": {
"DirectConnectGatewayAssociation$associationState": null
}
},
"DirectConnectGatewayAttachment": {
"base": "<p>The association between a direct connect gateway and virtual interface.</p>",
"refs": {
"DirectConnectGatewayAttachmentList$member": null
}
},
"DirectConnectGatewayAttachmentList": {
"base": "<p>A list of direct connect gateway attachments.</p>",
"refs": {
"DescribeDirectConnectGatewayAttachmentsResult$directConnectGatewayAttachments": "<p>Information about the direct connect gateway attachments.</p>"
}
},
"DirectConnectGatewayAttachmentState": {
"base": "<p>State of the direct connect gateway attachment.</p> <ul> <li> <p> <b>Attaching</b>: The initial state after a virtual interface is created using the direct connect gateway.</p> </li> <li> <p> <b>Attached</b>: The direct connect gateway and virtual interface are successfully attached and ready to pass traffic.</p> </li> <li> <p> <b>Detaching</b>: The initial state after calling <a>DeleteVirtualInterface</a> on a virtual interface that is attached to a direct connect gateway.</p> </li> <li> <p> <b>Detached</b>: The virtual interface is successfully detached from the direct connect gateway. Traffic flow between the direct connect gateway and virtual interface stops.</p> </li> </ul>",
"refs": {
"DirectConnectGatewayAttachment$attachmentState": null
}
},
"DirectConnectGatewayId": {
"base": "<p>The ID of the direct connect gateway.</p> <p>Example: \"abcd1234-dcba-5678-be23-cdef9876ab45\"</p>",
"refs": {
"ConfirmPrivateVirtualInterfaceRequest$directConnectGatewayId": "<p>ID of the direct connect gateway that will be attached to the virtual interface.</p> <p> A direct connect gateway can be managed via the AWS Direct Connect console or the <a>CreateDirectConnectGateway</a> action.</p> <p>Default: None</p>",
"CreateDirectConnectGatewayAssociationRequest$directConnectGatewayId": "<p>The ID of the direct connect gateway.</p> <p>Example: \"abcd1234-dcba-5678-be23-cdef9876ab45\"</p> <p>Default: None</p>",
"DeleteDirectConnectGatewayAssociationRequest$directConnectGatewayId": "<p>The ID of the direct connect gateway.</p> <p>Example: \"abcd1234-dcba-5678-be23-cdef9876ab45\"</p> <p>Default: None</p>",
"DeleteDirectConnectGatewayRequest$directConnectGatewayId": "<p>The ID of the direct connect gateway.</p> <p>Example: \"abcd1234-dcba-5678-be23-cdef9876ab45\"</p> <p>Default: None</p>",
"DescribeDirectConnectGatewayAssociationsRequest$directConnectGatewayId": "<p>The ID of the direct connect gateway.</p> <p>Example: \"abcd1234-dcba-5678-be23-cdef9876ab45\"</p> <p>Default: None</p>",
"DescribeDirectConnectGatewayAttachmentsRequest$directConnectGatewayId": "<p>The ID of the direct connect gateway.</p> <p>Example: \"abcd1234-dcba-5678-be23-cdef9876ab45\"</p> <p>Default: None</p>",
"DescribeDirectConnectGatewaysRequest$directConnectGatewayId": "<p>The ID of the direct connect gateway.</p> <p>Example: \"abcd1234-dcba-5678-be23-cdef9876ab45\"</p> <p>Default: None</p>",
"DirectConnectGateway$directConnectGatewayId": null,
"DirectConnectGatewayAssociation$directConnectGatewayId": null,
"DirectConnectGatewayAttachment$directConnectGatewayId": null,
"NewPrivateVirtualInterface$directConnectGatewayId": null,
"VirtualInterface$directConnectGatewayId": null
}
},
"DirectConnectGatewayList": {
"base": "<p>A list of direct connect gateways.</p>",
"refs": {
"DescribeDirectConnectGatewaysResult$directConnectGateways": "<p>Information about the direct connect gateways.</p>"
}
},
"DirectConnectGatewayName": {
"base": "<p>The name of the direct connect gateway.</p> <p>Example: \"My direct connect gateway\"</p> <p>Default: None</p>",
"refs": {
"CreateDirectConnectGatewayRequest$directConnectGatewayName": "<p>The name of the direct connect gateway.</p> <p>Example: \"My direct connect gateway\"</p> <p>Default: None</p>",
"DirectConnectGateway$directConnectGatewayName": null
}
},
"DirectConnectGatewayState": {
"base": "<p>State of the direct connect gateway.</p> <ul> <li> <p> <b>Pending</b>: The initial state after calling <a>CreateDirectConnectGateway</a>.</p> </li> <li> <p> <b>Available</b>: The direct connect gateway is ready for use.</p> </li> <li> <p> <b>Deleting</b>: The initial state after calling <a>DeleteDirectConnectGateway</a>.</p> </li> <li> <p> <b>Deleted</b>: The direct connect gateway is deleted and cannot pass traffic.</p> </li> </ul>",
"refs": {
"DirectConnectGateway$directConnectGatewayState": null
}
},
"DirectConnectServerException": {
"base": "<p>A server-side error occurred during the API call. The error message will contain additional details about the cause.</p>",
"refs": {
@ -613,6 +772,22 @@
"refs": {
}
},
"LongAsn": {
"base": null,
"refs": {
"CreateDirectConnectGatewayRequest$amazonSideAsn": "<p>The autonomous system number (ASN) for Border Gateway Protocol (BGP) to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294 </p> <p>Example: 65200</p> <p>Default: 64512</p>",
"DirectConnectGateway$amazonSideAsn": "<p>The autonomous system number (ASN) for the Amazon side of the connection.</p>",
"VirtualInterface$amazonSideAsn": "<p>The autonomous system number (ASN) for the Amazon side of the connection.</p>"
}
},
"MaxResultSetSize": {
"base": "<p>Maximum number of objects to return per page.</p>",
"refs": {
"DescribeDirectConnectGatewayAssociationsRequest$maxResults": "<p>The maximum number of direct connect gateway associations to return per page.</p> <p>Example: 15</p> <p>Default: None</p>",
"DescribeDirectConnectGatewayAttachmentsRequest$maxResults": "<p>The maximum number of direct connect gateway attachments to return per page.</p> <p>Example: 15</p> <p>Default: None</p>",
"DescribeDirectConnectGatewaysRequest$maxResults": "<p>The maximum number of direct connect gateways to return per page.</p> <p>Example: 15</p> <p>Default: None</p>"
}
},
"NewBGPPeer": {
"base": "<p>A structure containing information about a new BGP peer.</p>",
"refs": {
@ -651,10 +826,24 @@
"AllocatePrivateVirtualInterfaceRequest$ownerAccount": "<p>The AWS account that will own the new private virtual interface.</p> <p>Default: None</p>",
"AllocatePublicVirtualInterfaceRequest$ownerAccount": "<p>The AWS account that will own the new public virtual interface.</p> <p>Default: None</p>",
"Connection$ownerAccount": "<p>The AWS account that will own the new connection.</p>",
"DirectConnectGateway$ownerAccount": "<p>The AWS account ID of the owner of the direct connect gateway.</p>",
"DirectConnectGatewayAssociation$virtualGatewayOwnerAccount": "<p>The AWS account ID of the owner of the virtual private gateway.</p>",
"DirectConnectGatewayAttachment$virtualInterfaceOwnerAccount": "<p>The AWS account ID of the owner of the virtual interface.</p>",
"Lag$ownerAccount": "<p>The owner of the LAG.</p>",
"VirtualInterface$ownerAccount": "<p>The AWS account that will own the new virtual interface.</p>"
}
},
"PaginationToken": {
"base": "<p>Token to retrieve the next page of the result.</p>",
"refs": {
"DescribeDirectConnectGatewayAssociationsRequest$nextToken": "<p>The token provided in the previous describe result to retrieve the next page of the result.</p> <p>Default: None</p>",
"DescribeDirectConnectGatewayAssociationsResult$nextToken": null,
"DescribeDirectConnectGatewayAttachmentsRequest$nextToken": "<p>The token provided in the previous describe result to retrieve the next page of the result.</p> <p>Default: None</p>",
"DescribeDirectConnectGatewayAttachmentsResult$nextToken": null,
"DescribeDirectConnectGatewaysRequest$nextToken": "<p>The token provided in the previous describe result to retrieve the next page of the result.</p> <p>Default: None</p>",
"DescribeDirectConnectGatewaysResult$nextToken": null
}
},
"PartnerName": {
"base": null,
"refs": {
@ -724,6 +913,14 @@
"VirtualInterface$customerRouterConfig": "<p>Information for generating the customer router configuration.</p>"
}
},
"StateChangeError": {
"base": "<p>Error message when the state of an object fails to advance.</p>",
"refs": {
"DirectConnectGateway$stateChangeError": null,
"DirectConnectGatewayAssociation$stateChangeError": null,
"DirectConnectGatewayAttachment$stateChangeError": null
}
},
"Tag": {
"base": "<p>Information about a tag.</p>",
"refs": {
@ -809,6 +1006,10 @@
"base": "<p>The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.</p> <p>Example: vgw-123er56</p>",
"refs": {
"ConfirmPrivateVirtualInterfaceRequest$virtualGatewayId": "<p>ID of the virtual private gateway that will be attached to the virtual interface.</p> <p> A virtual private gateway can be managed via the Amazon Virtual Private Cloud (VPC) console or the <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-CreateVpnGateway.html\">EC2 CreateVpnGateway</a> action.</p> <p>Default: None</p>",
"CreateDirectConnectGatewayAssociationRequest$virtualGatewayId": "<p>The ID of the virtual private gateway.</p> <p>Example: \"vgw-abc123ef\"</p> <p>Default: None</p>",
"DeleteDirectConnectGatewayAssociationRequest$virtualGatewayId": "<p>The ID of the virtual private gateway.</p> <p>Example: \"vgw-abc123ef\"</p> <p>Default: None</p>",
"DescribeDirectConnectGatewayAssociationsRequest$virtualGatewayId": "<p>The ID of the virtual private gateway.</p> <p>Example: \"vgw-abc123ef\"</p> <p>Default: None</p>",
"DirectConnectGatewayAssociation$virtualGatewayId": null,
"NewPrivateVirtualInterface$virtualGatewayId": null,
"VirtualGateway$virtualGatewayId": null,
"VirtualInterface$virtualGatewayId": null
@ -820,6 +1021,12 @@
"VirtualGateways$virtualGateways": "<p>A list of virtual private gateways.</p>"
}
},
"VirtualGatewayRegion": {
"base": "<p>The region in which the virtual private gateway is located.</p> <p>Example: us-east-1</p>",
"refs": {
"DirectConnectGatewayAssociation$virtualGatewayRegion": null
}
},
"VirtualGatewayState": {
"base": "<p>State of the virtual private gateway.</p> <ul> <li> <p> <b>Pending</b>: This is the initial state after calling <i>CreateVpnGateway</i>.</p> </li> <li> <p> <b>Available</b>: Ready for use by a private virtual interface.</p> </li> <li> <p> <b>Deleting</b>: This is the initial state after calling <i>DeleteVpnGateway</i>.</p> </li> <li> <p> <b>Deleted</b>: In this state, a private virtual interface is unable to send traffic over this gateway.</p> </li> </ul>",
"refs": {
@ -848,7 +1055,9 @@
"CreateBGPPeerRequest$virtualInterfaceId": "<p>The ID of the virtual interface on which the BGP peer will be provisioned.</p> <p>Example: dxvif-456abc78</p> <p>Default: None</p>",
"DeleteBGPPeerRequest$virtualInterfaceId": "<p>The ID of the virtual interface from which the BGP peer will be deleted.</p> <p>Example: dxvif-456abc78</p> <p>Default: None</p>",
"DeleteVirtualInterfaceRequest$virtualInterfaceId": null,
"DescribeDirectConnectGatewayAttachmentsRequest$virtualInterfaceId": "<p>The ID of the virtual interface.</p> <p>Example: \"dxvif-abc123ef\"</p> <p>Default: None</p>",
"DescribeVirtualInterfacesRequest$virtualInterfaceId": null,
"DirectConnectGatewayAttachment$virtualInterfaceId": null,
"VirtualInterface$virtualInterfaceId": null
}
},
@ -868,6 +1077,12 @@
"VirtualInterface$virtualInterfaceName": null
}
},
"VirtualInterfaceRegion": {
"base": "<p>The region in which the virtual interface is located.</p> <p>Example: us-east-1</p>",
"refs": {
"DirectConnectGatewayAttachment$virtualInterfaceRegion": null
}
},
"VirtualInterfaceState": {
"base": "<p>State of the virtual interface.</p> <ul> <li> <p> <b>Confirming</b>: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.</p> </li> <li> <p> <b>Verifying</b>: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.</p> </li> <li> <p> <b>Pending</b>: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.</p> </li> <li> <p> <b>Available</b>: A virtual interface that is able to forward traffic.</p> </li> <li> <p> <b>Down</b>: A virtual interface that is BGP down.</p> </li> <li> <p> <b>Deleting</b>: A virtual interface is in this state immediately after calling <a>DeleteVirtualInterface</a> until it can no longer forward traffic.</p> </li> <li> <p> <b>Deleted</b>: A virtual interface that cannot forward traffic.</p> </li> <li> <p> <b>Rejected</b>: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.</p> </li> </ul>",
"refs": {

View File

@ -429,10 +429,7 @@
},
"ConfigurationTagSet":{
"type":"list",
"member":{
"shape":"ConfigurationTag",
"locationName":"item"
}
"member":{"shape":"ConfigurationTag"}
},
"Configurations":{
"type":"list",
@ -725,10 +722,7 @@
"FilterValue":{"type":"string"},
"FilterValues":{
"type":"list",
"member":{
"shape":"FilterValue",
"locationName":"item"
}
"member":{"shape":"FilterValue"}
},
"Filters":{
"type":"list",
@ -930,10 +924,7 @@
"TagKey":{"type":"string"},
"TagSet":{
"type":"list",
"member":{
"shape":"Tag",
"locationName":"item"
}
"member":{"shape":"Tag"}
},
"TagValue":{"type":"string"},
"TimeStamp":{"type":"timestamp"},

View File

@ -1,6 +1,6 @@
{
"version": "2.0",
"service": "<fullname>AWS Application Discovery Service</fullname> <p>AWS Application Discovery Service helps you plan application migration projects by automatically identifying servers, virtual machines (VMs), software, and software dependencies running in your on-premises data centers. Application Discovery Service also collects application performance data, which can help you assess the outcome of your migration. The data collected by Application Discovery Service is securely retained in an Amazon-hosted and managed database in the cloud. You can export the data as a CSV or XML file into your preferred visualization tool or cloud-migration solution to plan your migration. For more information, see the Application Discovery Service <a href=\"http://aws.amazon.com/application-discovery/faqs/\">FAQ</a>.</p> <p>Application Discovery Service offers two modes of operation.</p> <ul> <li> <p> <b>Agentless discovery</b> mode is recommended for environments that use VMware vCenter Server. This mode doesn't require you to install an agent on each host. Agentless discovery gathers server information regardless of the operating systems, which minimizes the time required for initial on-premises infrastructure assessment. Agentless discovery doesn't collect information about software and software dependencies. It also doesn't work in non-VMware environments. We recommend that you use agent-based discovery for non-VMware environments and if you want to collect information about software and software dependencies. You can also run agent-based and agentless discovery simultaneously. Use agentless discovery to quickly complete the initial infrastructure assessment and then install agents on select hosts to gather information about software and software dependencies.</p> </li> <li> <p> <b>Agent-based discovery</b> mode collects a richer set of data than agentless discovery by using Amazon software, the AWS Application Discovery Agent, which you install on one or more hosts in your data center. The agent captures infrastructure and application information, including an inventory of installed software applications, system and process performance, resource utilization, and network dependencies between workloads. The information collected by agents is secured at rest and in transit to the Application Discovery Service database in the cloud. </p> </li> </ul> <p>Application Discovery Service integrates with application discovery solutions from AWS Partner Network (APN) partners. Third-party application discovery tools can query Application Discovery Service and write to the Application Discovery Service database using a public API. You can then import the data into either a visualization tool or cloud-migration solution.</p> <important> <p>Application Discovery Service doesn't gather sensitive information. All data is handled according to the <a href=\"http://aws.amazon.com/privacy/\">AWS Privacy Policy</a>. You can operate Application Discovery Service using offline mode to inspect collected data before it is shared with the service.</p> </important> <p>Your AWS account must be granted access to Application Discovery Service, a process called <i>whitelisting</i>. This is true for AWS partners and customers alike. To request access, sign up for AWS Application Discovery Service <a href=\"http://aws.amazon.com/application-discovery/preview/\">here</a>. We send you information about how to get started.</p> <p>This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for Application Discovery Service. The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the AWS SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see <a href=\"http://aws.amazon.com/tools/#SDKs\">AWS SDKs</a>.</p> <p>This guide is intended for use with the <a href=\"http://docs.aws.amazon.com/application-discovery/latest/userguide/\"> <i>AWS Application Discovery Service User Guide</i> </a>.</p>",
"service": "<fullname>AWS Application Discovery Service</fullname> <p>AWS Application Discovery Service helps you plan application migration projects by automatically identifying servers, virtual machines (VMs), software, and software dependencies running in your on-premises data centers. Application Discovery Service also collects application performance data, which can help you assess the outcome of your migration. The data collected by Application Discovery Service is securely retained in an Amazon-hosted and managed database in the cloud. You can export the data as a CSV or XML file into your preferred visualization tool or cloud-migration solution to plan your migration. For more information, see the Application Discovery Service <a href=\"http://aws.amazon.com/application-discovery/faqs/\">FAQ</a>.</p> <p>Application Discovery Service offers two modes of operation.</p> <ul> <li> <p> <b>Agentless discovery</b> mode is recommended for environments that use VMware vCenter Server. This mode doesn't require you to install an agent on each host. Agentless discovery gathers server information regardless of the operating systems, which minimizes the time required for initial on-premises infrastructure assessment. Agentless discovery doesn't collect information about software and software dependencies. It also doesn't work in non-VMware environments. We recommend that you use agent-based discovery for non-VMware environments and if you want to collect information about software and software dependencies. You can also run agent-based and agentless discovery simultaneously. Use agentless discovery to quickly complete the initial infrastructure assessment and then install agents on select hosts to gather information about software and software dependencies.</p> </li> <li> <p> <b>Agent-based discovery</b> mode collects a richer set of data than agentless discovery by using Amazon software, the AWS Application Discovery Agent, which you install on one or more hosts in your data center. The agent captures infrastructure and application information, including an inventory of installed software applications, system and process performance, resource utilization, and network dependencies between workloads. The information collected by agents is secured at rest and in transit to the Application Discovery Service database in the cloud. </p> </li> </ul> <p>Application Discovery Service integrates with application discovery solutions from AWS Partner Network (APN) partners. Third-party application discovery tools can query Application Discovery Service and write to the Application Discovery Service database using a public API. You can then import the data into either a visualization tool or cloud-migration solution.</p> <important> <p>Application Discovery Service doesn't gather sensitive information. All data is handled according to the <a href=\"http://aws.amazon.com/privacy/\">AWS Privacy Policy</a>. You can operate Application Discovery Service using offline mode to inspect collected data before it is shared with the service.</p> </important> <p>Your AWS account must be granted access to Application Discovery Service, a process called <i>whitelisting</i>. This is true for AWS partners and customers alike. To request access, <a href=\"http://aws.amazon.com/application-discovery/how-to-start/\"> sign up for AWS Application Discovery Service</a>.</p> <p>This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for Application Discovery Service. The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the AWS SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see <a href=\"http://aws.amazon.com/tools/#SDKs\">AWS SDKs</a>.</p> <p>This guide is intended for use with the <a href=\"http://docs.aws.amazon.com/application-discovery/latest/userguide/\"> <i>AWS Application Discovery Service User Guide</i> </a>.</p>",
"operations": {
"AssociateConfigurationItemsToApplication": "<p>Associates one or more configuration items with an application.</p>",
"CreateApplication": "<p>Creates an application with the given name and description.</p>",
@ -18,7 +18,7 @@
"ListConfigurations": "<p>Retrieves a list of configuration items according to criteria that you specify in a filter. The filter criteria identifies the relationship requirements.</p>",
"ListServerNeighbors": "<p>Retrieves a list of servers that are one network hop away from a specified server.</p>",
"StartDataCollectionByAgentIds": "<p>Instructs the specified agents or connectors to start collecting data.</p>",
"StartExportTask": "<p> Begins the export of discovered data to an S3 bucket.</p> <p> If you specify <code>agentId</code> in a filter, the task exports up to 72 hours of detailed data collected by the identified Application Discovery Agent, including network, process, and performance details. A time range for exported agent data may be set by using <code>startTime</code> and <code>endTime</code>. Export of detailed agent data is limited to five concurrently running exports. </p> <p> If you do not include an <code>agentId</code> filter, summary data is exported that includes both AWS Agentless Discovery Connector data and summary data from AWS Discovery Agents. Export of summary data is limited to two exports per day. </p>",
"StartExportTask": "<p> Begins the export of discovered data to an S3 bucket.</p> <p> If you specify <code>agentIds</code> in a filter, the task exports up to 72 hours of detailed data collected by the identified Application Discovery Agent, including network, process, and performance details. A time range for exported agent data may be set by using <code>startTime</code> and <code>endTime</code>. Export of detailed agent data is limited to five concurrently running exports. </p> <p> If you do not include an <code>agentIds</code> filter, summary data is exported that includes both AWS Agentless Discovery Connector data and summary data from AWS Discovery Agents. Export of summary data is limited to two exports per day. </p>",
"StopDataCollectionByAgentIds": "<p>Instructs the specified agents or connectors to stop collecting data.</p>",
"UpdateApplication": "<p>Updates metadata about an application.</p>"
},
@ -337,7 +337,7 @@
"ExportDataFormats": {
"base": null,
"refs": {
"StartExportTaskRequest$exportDataFormat": "<p>The file format for the returned export data. Default value is <code>CSV</code>.</p>"
"StartExportTaskRequest$exportDataFormat": "<p>The file format for the returned export data. Default value is <code>CSV</code>. <b>Note:</b> <i>The</i> <code>GRAPHML</code> <i>option has been deprecated.</i> </p>"
}
},
"ExportFilter": {

View File

@ -6,6 +6,7 @@
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"AWS Database Migration Service",
"serviceId":"Database Migration Service",
"signatureVersion":"v4",
"targetPrefix":"AmazonDMSv20160101",
"uid":"dms-2016-01-01"
@ -319,6 +320,18 @@
{"shape":"ResourceNotFoundFault"}
]
},
"DescribeReplicationTaskAssessmentResults":{
"name":"DescribeReplicationTaskAssessmentResults",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeReplicationTaskAssessmentResultsMessage"},
"output":{"shape":"DescribeReplicationTaskAssessmentResultsResponse"},
"errors":[
{"shape":"ResourceNotFoundFault"}
]
},
"DescribeReplicationTasks":{
"name":"DescribeReplicationTasks",
"http":{
@ -515,6 +528,19 @@
{"shape":"InvalidResourceStateFault"}
]
},
"StartReplicationTaskAssessment":{
"name":"StartReplicationTaskAssessment",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartReplicationTaskAssessmentMessage"},
"output":{"shape":"StartReplicationTaskAssessmentResponse"},
"errors":[
{"shape":"InvalidResourceStateFault"},
{"shape":"ResourceNotFoundFault"}
]
},
"StopReplicationTask":{
"name":"StopReplicationTask",
"http":{
@ -562,10 +588,7 @@
},
"AccountQuotaList":{
"type":"list",
"member":{
"shape":"AccountQuota",
"locationName":"AccountQuota"
}
"member":{"shape":"AccountQuota"}
},
"AddTagsToResourceMessage":{
"type":"structure",
@ -623,10 +646,7 @@
},
"CertificateList":{
"type":"list",
"member":{
"shape":"Certificate",
"locationName":"Certificate"
}
"member":{"shape":"Certificate"}
},
"CertificateWallet":{"type":"blob"},
"CompressionTypeValue":{
@ -649,10 +669,7 @@
},
"ConnectionList":{
"type":"list",
"member":{
"shape":"Connection",
"locationName":"Connection"
}
"member":{"shape":"Connection"}
},
"CreateEndpointMessage":{
"type":"structure",
@ -1039,6 +1056,22 @@
"ReplicationSubnetGroups":{"shape":"ReplicationSubnetGroups"}
}
},
"DescribeReplicationTaskAssessmentResultsMessage":{
"type":"structure",
"members":{
"ReplicationTaskArn":{"shape":"String"},
"MaxRecords":{"shape":"IntegerOptional"},
"Marker":{"shape":"String"}
}
},
"DescribeReplicationTaskAssessmentResultsResponse":{
"type":"structure",
"members":{
"Marker":{"shape":"String"},
"BucketName":{"shape":"String"},
"ReplicationTaskAssessmentResults":{"shape":"ReplicationTaskAssessmentResultList"}
}
},
"DescribeReplicationTasksMessage":{
"type":"structure",
"members":{
@ -1076,7 +1109,8 @@
"members":{
"ReplicationTaskArn":{"shape":"String"},
"MaxRecords":{"shape":"IntegerOptional"},
"Marker":{"shape":"String"}
"Marker":{"shape":"String"},
"Filters":{"shape":"FilterList"}
}
},
"DescribeTableStatisticsResponse":{
@ -1127,10 +1161,7 @@
},
"EndpointList":{
"type":"list",
"member":{
"shape":"Endpoint",
"locationName":"Endpoint"
}
"member":{"shape":"Endpoint"}
},
"Event":{
"type":"structure",
@ -1144,10 +1175,7 @@
},
"EventCategoriesList":{
"type":"list",
"member":{
"shape":"String",
"locationName":"EventCategory"
}
"member":{"shape":"String"}
},
"EventCategoryGroup":{
"type":"structure",
@ -1158,17 +1186,11 @@
},
"EventCategoryGroupList":{
"type":"list",
"member":{
"shape":"EventCategoryGroup",
"locationName":"EventCategoryGroup"
}
"member":{"shape":"EventCategoryGroup"}
},
"EventList":{
"type":"list",
"member":{
"shape":"Event",
"locationName":"Event"
}
"member":{"shape":"Event"}
},
"EventSubscription":{
"type":"structure",
@ -1186,10 +1208,7 @@
},
"EventSubscriptionsList":{
"type":"list",
"member":{
"shape":"EventSubscription",
"locationName":"EventSubscription"
}
"member":{"shape":"EventSubscription"}
},
"ExceptionMessage":{"type":"string"},
"Filter":{
@ -1205,17 +1224,11 @@
},
"FilterList":{
"type":"list",
"member":{
"shape":"Filter",
"locationName":"Filter"
}
"member":{"shape":"Filter"}
},
"FilterValueList":{
"type":"list",
"member":{
"shape":"String",
"locationName":"Value"
}
"member":{"shape":"String"}
},
"ImportCertificateMessage":{
"type":"structure",
@ -1436,10 +1449,7 @@
},
"OrderableReplicationInstanceList":{
"type":"list",
"member":{
"shape":"OrderableReplicationInstance",
"locationName":"OrderableReplicationInstance"
}
"member":{"shape":"OrderableReplicationInstance"}
},
"RefreshSchemasMessage":{
"type":"structure",
@ -1550,10 +1560,7 @@
},
"ReplicationInstanceList":{
"type":"list",
"member":{
"shape":"ReplicationInstance",
"locationName":"ReplicationInstance"
}
"member":{"shape":"ReplicationInstance"}
},
"ReplicationInstancePrivateIpAddressList":{
"type":"list",
@ -1591,10 +1598,7 @@
},
"ReplicationSubnetGroups":{
"type":"list",
"member":{
"shape":"ReplicationSubnetGroup",
"locationName":"ReplicationSubnetGroup"
}
"member":{"shape":"ReplicationSubnetGroup"}
},
"ReplicationTask":{
"type":"structure",
@ -1615,12 +1619,25 @@
"ReplicationTaskStats":{"shape":"ReplicationTaskStats"}
}
},
"ReplicationTaskAssessmentResult":{
"type":"structure",
"members":{
"ReplicationTaskIdentifier":{"shape":"String"},
"ReplicationTaskArn":{"shape":"String"},
"ReplicationTaskLastAssessmentDate":{"shape":"TStamp"},
"AssessmentStatus":{"shape":"String"},
"AssessmentResultsFile":{"shape":"String"},
"AssessmentResults":{"shape":"String"},
"S3ObjectUrl":{"shape":"String"}
}
},
"ReplicationTaskAssessmentResultList":{
"type":"list",
"member":{"shape":"ReplicationTaskAssessmentResult"}
},
"ReplicationTaskList":{
"type":"list",
"member":{
"shape":"ReplicationTask",
"locationName":"ReplicationTask"
}
"member":{"shape":"ReplicationTask"}
},
"ReplicationTaskStats":{
"type":"structure",
@ -1690,15 +1707,25 @@
},
"SourceIdsList":{
"type":"list",
"member":{
"shape":"String",
"locationName":"SourceId"
}
"member":{"shape":"String"}
},
"SourceType":{
"type":"string",
"enum":["replication-instance"]
},
"StartReplicationTaskAssessmentMessage":{
"type":"structure",
"required":["ReplicationTaskArn"],
"members":{
"ReplicationTaskArn":{"shape":"String"}
}
},
"StartReplicationTaskAssessmentResponse":{
"type":"structure",
"members":{
"ReplicationTask":{"shape":"ReplicationTask"}
}
},
"StartReplicationTaskMessage":{
"type":"structure",
"required":[
@ -1763,17 +1790,11 @@
},
"SubnetIdentifierList":{
"type":"list",
"member":{
"shape":"String",
"locationName":"SubnetIdentifier"
}
"member":{"shape":"String"}
},
"SubnetList":{
"type":"list",
"member":{
"shape":"Subnet",
"locationName":"Subnet"
}
"member":{"shape":"Subnet"}
},
"SupportedEndpointType":{
"type":"structure",
@ -1785,10 +1806,7 @@
},
"SupportedEndpointTypeList":{
"type":"list",
"member":{
"shape":"SupportedEndpointType",
"locationName":"SupportedEndpointType"
}
"member":{"shape":"SupportedEndpointType"}
},
"TStamp":{"type":"timestamp"},
"TableListToReload":{
@ -1808,7 +1826,11 @@
"FullLoadCondtnlChkFailedRows":{"shape":"Long"},
"FullLoadErrorRows":{"shape":"Long"},
"LastUpdateTime":{"shape":"TStamp"},
"TableState":{"shape":"String"}
"TableState":{"shape":"String"},
"ValidationPendingRecords":{"shape":"Long"},
"ValidationFailedRecords":{"shape":"Long"},
"ValidationSuspendedRecords":{"shape":"Long"},
"ValidationState":{"shape":"String"}
}
},
"TableStatisticsList":{
@ -1831,10 +1853,7 @@
},
"TagList":{
"type":"list",
"member":{
"shape":"Tag",
"locationName":"Tag"
}
"member":{"shape":"Tag"}
},
"TestConnectionMessage":{
"type":"structure",
@ -1862,10 +1881,7 @@
},
"VpcSecurityGroupIdList":{
"type":"list",
"member":{
"shape":"String",
"locationName":"VpcSecurityGroupId"
}
"member":{"shape":"String"}
},
"VpcSecurityGroupMembership":{
"type":"structure",
@ -1876,10 +1892,7 @@
},
"VpcSecurityGroupMembershipList":{
"type":"list",
"member":{
"shape":"VpcSecurityGroupMembership",
"locationName":"VpcSecurityGroupMembership"
}
"member":{"shape":"VpcSecurityGroupMembership"}
}
}
}

View File

@ -26,9 +26,10 @@
"DescribeRefreshSchemasStatus": "<p>Returns the status of the RefreshSchemas operation.</p>",
"DescribeReplicationInstances": "<p>Returns information about replication instances for your account in the current region.</p>",
"DescribeReplicationSubnetGroups": "<p>Returns information about the replication subnet groups.</p>",
"DescribeReplicationTaskAssessmentResults": "<p>Returns the task assessment results from Amazon S3. This action always returns the latest results.</p>",
"DescribeReplicationTasks": "<p>Returns information about replication tasks for your account in the current region.</p>",
"DescribeSchemas": "<p>Returns information about the schema for the specified endpoint.</p> <p/>",
"DescribeTableStatistics": "<p>Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.</p>",
"DescribeTableStatistics": "<p>Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.</p> <p>Note that the \"last updated\" column the DMS console only indicates the time that AWS DMS last updated the table statistics record for a table. It does not indicate the time of the last update to the table.</p>",
"ImportCertificate": "<p>Uploads the specified certificate.</p>",
"ListTagsForResource": "<p>Lists all tags for an AWS DMS resource.</p>",
"ModifyEndpoint": "<p>Modifies the specified endpoint.</p>",
@ -40,6 +41,7 @@
"ReloadTables": "<p>Reloads the target database table with the source data. </p>",
"RemoveTagsFromResource": "<p>Removes metadata tags from a DMS resource.</p>",
"StartReplicationTask": "<p>Starts the replication task.</p> <p>For more information about AWS DMS tasks, see the AWS DMS user guide at <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html\"> Working with Migration Tasks </a> </p>",
"StartReplicationTaskAssessment": "<p> Starts the replication task assessment for unsupported data types in the source database. </p>",
"StopReplicationTask": "<p>Stops the replication task.</p> <p/>",
"TestConnection": "<p>Tests the connection between the replication instance and the endpoint.</p>"
},
@ -384,6 +386,16 @@
"refs": {
}
},
"DescribeReplicationTaskAssessmentResultsMessage": {
"base": "<p/>",
"refs": {
}
},
"DescribeReplicationTaskAssessmentResultsResponse": {
"base": "<p/>",
"refs": {
}
},
"DescribeReplicationTasksMessage": {
"base": "<p/>",
"refs": {
@ -533,7 +545,8 @@
"DescribeEventsMessage$Filters": "<p>Filters applied to the action.</p>",
"DescribeReplicationInstancesMessage$Filters": "<p>Filters applied to the describe action.</p> <p>Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version</p>",
"DescribeReplicationSubnetGroupsMessage$Filters": "<p>Filters applied to the describe action.</p>",
"DescribeReplicationTasksMessage$Filters": "<p>Filters applied to the describe action.</p> <p>Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn</p>"
"DescribeReplicationTasksMessage$Filters": "<p>Filters applied to the describe action.</p> <p>Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn</p>",
"DescribeTableStatisticsMessage$Filters": "<p>Filters applied to the describe table statistics action.</p> <p>Valid filter names: schema-name | table-name | table-state</p> <p>A combination of filters creates an AND condition where each record matches all specified filters.</p>"
}
},
"FilterValueList": {
@ -588,9 +601,10 @@
"DescribeOrderableReplicationInstancesMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>",
"DescribeReplicationInstancesMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>",
"DescribeReplicationSubnetGroupsMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>",
"DescribeReplicationTaskAssessmentResultsMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>",
"DescribeReplicationTasksMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>",
"DescribeSchemasMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>",
"DescribeTableStatisticsMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>",
"DescribeTableStatisticsMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 500.</p>",
"Endpoint$Port": "<p>The port value used to access the endpoint.</p>",
"ModifyEndpointMessage$Port": "<p>The port used by the endpoint database.</p>",
"ModifyReplicationInstanceMessage$AllocatedStorage": "<p>The amount of storage (in gigabytes) to be allocated for the replication instance.</p>",
@ -646,7 +660,10 @@
"TableStatistics$Ddls": "<p>The Data Definition Language (DDL) used to build and modify the structure of your tables.</p>",
"TableStatistics$FullLoadRows": "<p>The number of rows added during the Full Load operation.</p>",
"TableStatistics$FullLoadCondtnlChkFailedRows": "<p>The number of rows that failed conditional checks during the Full Load operation (valid only for DynamoDB as a target migrations).</p>",
"TableStatistics$FullLoadErrorRows": "<p>The number of rows that failed to load during the Full Load operation (valid only for DynamoDB as a target migrations).</p>"
"TableStatistics$FullLoadErrorRows": "<p>The number of rows that failed to load during the Full Load operation (valid only for DynamoDB as a target migrations).</p>",
"TableStatistics$ValidationPendingRecords": "<p>The number of records that have yet to be validated.</p>",
"TableStatistics$ValidationFailedRecords": "<p>The number of records that failed validation.</p>",
"TableStatistics$ValidationSuspendedRecords": "<p>The number of records that could not be validated.</p>"
}
},
"MigrationTypeValue": {
@ -845,10 +862,23 @@
"DeleteReplicationTaskResponse$ReplicationTask": "<p>The deleted replication task.</p>",
"ModifyReplicationTaskResponse$ReplicationTask": "<p>The replication task that was modified.</p>",
"ReplicationTaskList$member": null,
"StartReplicationTaskAssessmentResponse$ReplicationTask": "<p> The assessed replication task. </p>",
"StartReplicationTaskResponse$ReplicationTask": "<p>The replication task started.</p>",
"StopReplicationTaskResponse$ReplicationTask": "<p>The replication task stopped.</p>"
}
},
"ReplicationTaskAssessmentResult": {
"base": "<p> The task assessment report in JSON format. </p>",
"refs": {
"ReplicationTaskAssessmentResultList$member": null
}
},
"ReplicationTaskAssessmentResultList": {
"base": null,
"refs": {
"DescribeReplicationTaskAssessmentResultsResponse$ReplicationTaskAssessmentResults": "<p> The task assessment report. </p>"
}
},
"ReplicationTaskList": {
"base": null,
"refs": {
@ -922,6 +952,16 @@
"Event$SourceType": "<p> The type of AWS DMS resource that generates events. </p> <p>Valid values: replication-instance | endpoint | migration-task</p>"
}
},
"StartReplicationTaskAssessmentMessage": {
"base": "<p/>",
"refs": {
}
},
"StartReplicationTaskAssessmentResponse": {
"base": "<p/>",
"refs": {
}
},
"StartReplicationTaskMessage": {
"base": "<p/>",
"refs": {
@ -977,7 +1017,7 @@
"CreateEndpointMessage$DatabaseName": "<p>The name of the endpoint database.</p>",
"CreateEndpointMessage$ExtraConnectionAttributes": "<p>Additional attributes associated with the connection.</p>",
"CreateEndpointMessage$KmsKeyId": "<p>The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.</p>",
"CreateEndpointMessage$CertificateArn": "<p>The Amazon Resource Number (ARN) for the certificate.</p>",
"CreateEndpointMessage$CertificateArn": "<p>The Amazon Resource Name (ARN) for the certificate.</p>",
"CreateEventSubscriptionMessage$SubscriptionName": "<p>The name of the DMS event notification subscription. </p> <p>Constraints: The name must be less than 255 characters. </p>",
"CreateEventSubscriptionMessage$SnsTopicArn": "<p> The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it. </p>",
"CreateEventSubscriptionMessage$SourceType": "<p> The type of AWS DMS resource that generates the events. For example, if you want to be notified of events generated by a replication instance, you set this parameter to <code>replication-instance</code>. If this value is not specified, all events are returned. </p> <p>Valid values: replication-instance | migration-task</p>",
@ -1024,6 +1064,10 @@
"DescribeReplicationInstancesResponse$Marker": "<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>",
"DescribeReplicationSubnetGroupsMessage$Marker": "<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>",
"DescribeReplicationSubnetGroupsResponse$Marker": "<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>",
"DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn": "<p>- The Amazon Resource Name (ARN) string that uniquely identifies the task. When this input parameter is specified the API will return only one result and ignore the values of the max-records and marker parameters. </p>",
"DescribeReplicationTaskAssessmentResultsMessage$Marker": "<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>",
"DescribeReplicationTaskAssessmentResultsResponse$Marker": "<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>",
"DescribeReplicationTaskAssessmentResultsResponse$BucketName": "<p>- The Amazon S3 bucket where the task assessment report is located. </p>",
"DescribeReplicationTasksMessage$Marker": "<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>",
"DescribeReplicationTasksResponse$Marker": "<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>",
"DescribeSchemasMessage$EndpointArn": "<p>The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.</p>",
@ -1067,7 +1111,7 @@
"ModifyEndpointMessage$Username": "<p>The user name to be used to login to the endpoint database.</p>",
"ModifyEndpointMessage$ServerName": "<p>The name of the server where the endpoint database resides.</p>",
"ModifyEndpointMessage$DatabaseName": "<p>The name of the endpoint database.</p>",
"ModifyEndpointMessage$ExtraConnectionAttributes": "<p>Additional attributes associated with the connection.</p>",
"ModifyEndpointMessage$ExtraConnectionAttributes": "<p>Additional attributes associated with the connection. To reset this parameter, pass the empty string (\"\") as an argument.</p>",
"ModifyEndpointMessage$CertificateArn": "<p>The Amazon Resource Name (ARN) of the certificate used for SSL connection.</p>",
"ModifyEventSubscriptionMessage$SubscriptionName": "<p>The name of the AWS DMS event notification subscription to be modified.</p>",
"ModifyEventSubscriptionMessage$SnsTopicArn": "<p> The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.</p>",
@ -1129,6 +1173,12 @@
"ReplicationTask$LastFailureMessage": "<p>The last error (failure) message generated for the replication instance.</p>",
"ReplicationTask$StopReason": "<p>The reason the replication task was stopped.</p>",
"ReplicationTask$ReplicationTaskArn": "<p>The Amazon Resource Name (ARN) of the replication task.</p>",
"ReplicationTaskAssessmentResult$ReplicationTaskIdentifier": "<p> The replication task identifier of the task on which the task assessment was run. </p>",
"ReplicationTaskAssessmentResult$ReplicationTaskArn": "<p>The Amazon Resource Name (ARN) of the replication task. </p>",
"ReplicationTaskAssessmentResult$AssessmentStatus": "<p> The status of the task assessment. </p>",
"ReplicationTaskAssessmentResult$AssessmentResultsFile": "<p> The file containing the results of the task assessment. </p>",
"ReplicationTaskAssessmentResult$AssessmentResults": "<p> The task assessment results in JSON format. </p>",
"ReplicationTaskAssessmentResult$S3ObjectUrl": "<p> The URL of the S3 object containing the task assessment results. </p>",
"S3Settings$ServiceAccessRoleArn": "<p> The Amazon Resource Name (ARN) used by the service access IAM role. </p>",
"S3Settings$ExternalTableDefinition": "<p> </p>",
"S3Settings$CsvRowDelimiter": "<p> The delimiter used to separate rows in the source files. The default is a carriage return (\\n). </p>",
@ -1137,15 +1187,17 @@
"S3Settings$BucketName": "<p> The name of the S3 bucket. </p>",
"SchemaList$member": null,
"SourceIdsList$member": null,
"StartReplicationTaskMessage$ReplicationTaskArn": "<p>The Amazon Resource Number (ARN) of the replication task to be started.</p>",
"StopReplicationTaskMessage$ReplicationTaskArn": "<p>The Amazon Resource Number(ARN) of the replication task to be stopped.</p>",
"StartReplicationTaskAssessmentMessage$ReplicationTaskArn": "<p> The Amazon Resource Name (ARN) of the replication task. </p>",
"StartReplicationTaskMessage$ReplicationTaskArn": "<p>The Amazon Resource Name (ARN) of the replication task to be started.</p>",
"StopReplicationTaskMessage$ReplicationTaskArn": "<p>The Amazon Resource Name(ARN) of the replication task to be stopped.</p>",
"Subnet$SubnetIdentifier": "<p>The subnet identifier.</p>",
"Subnet$SubnetStatus": "<p>The status of the subnet.</p>",
"SubnetIdentifierList$member": null,
"SupportedEndpointType$EngineName": "<p>The database engine name. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, SYBASE, DYNAMODB, MONGODB, and SQLSERVER.</p>",
"TableStatistics$SchemaName": "<p>The schema name.</p>",
"TableStatistics$TableName": "<p>The name of the table.</p>",
"TableStatistics$TableState": "<p>The state of the table.</p>",
"TableStatistics$TableState": "<p>The state of the tables described.</p> <p>Valid states: Table does not exist | Before load | Full load | Table completed | Table cancelled | Table error | Table all | Table updates | Table is being reloaded</p>",
"TableStatistics$ValidationState": "<p>The validation state of the table.</p> <p>The parameter can have the following values</p> <ul> <li> <p>Not enabled—Validation is not enabled for the table in the migration task.</p> </li> <li> <p>Pending records—Some records in the table are waiting for validation.</p> </li> <li> <p>Mismatched records—Some records in the table do not match between the source and target.</p> </li> <li> <p>Suspended records—Some records in the table could not be validated.</p> </li> <li> <p>No primary key—The table could not be validated because it had no primary key.</p> </li> <li> <p>Table error—The table was not validated because it was in an error state and some data was not migrated.</p> </li> <li> <p>Validated—All rows in the table were validated. If the table is updated, the status can change from Validated.</p> </li> <li> <p>Error—The table could not be validated because of an unexpected error.</p> </li> </ul>",
"TableToReload$SchemaName": "<p>The schema name of the table to be reloaded.</p>",
"TableToReload$TableName": "<p>The table name of the table to be reloaded.</p>",
"Tag$Key": "<p>A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"dms:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").</p>",
@ -1208,6 +1260,7 @@
"ReplicationInstance$InstanceCreateTime": "<p>The time the replication instance was created.</p>",
"ReplicationTask$ReplicationTaskCreationDate": "<p>The date the replication task was created.</p>",
"ReplicationTask$ReplicationTaskStartDate": "<p>The date the replication task is scheduled to start.</p>",
"ReplicationTaskAssessmentResult$ReplicationTaskLastAssessmentDate": "<p>The date the task assessment was completed. </p>",
"StartReplicationTaskMessage$CdcStartTime": "<p>The start time for the Change Data Capture (CDC) operation.</p>",
"TableStatistics$LastUpdateTime": "<p>The last time the table was updated.</p>"
}

View File

@ -45,6 +45,11 @@
"output_token": "Marker",
"limit_key": "MaxRecords"
},
"DescribeReplicationTaskAssessmentResults": {
"input_token": "Marker",
"output_token": "Marker",
"limit_key": "MaxRecords"
},
"DescribeReplicationTasks": {
"input_token": "Marker",
"output_token": "Marker",

View File

@ -910,7 +910,8 @@
"ShortName":{"shape":"DirectoryShortName"},
"Password":{"shape":"Password"},
"Description":{"shape":"Description"},
"VpcSettings":{"shape":"DirectoryVpcSettings"}
"VpcSettings":{"shape":"DirectoryVpcSettings"},
"Edition":{"shape":"DirectoryEdition"}
}
},
"CreateMicrosoftADResult":{
@ -1165,6 +1166,7 @@
"Name":{"shape":"DirectoryName"},
"ShortName":{"shape":"DirectoryShortName"},
"Size":{"shape":"DirectorySize"},
"Edition":{"shape":"DirectoryEdition"},
"Alias":{"shape":"AliasName"},
"AccessUrl":{"shape":"AccessUrl"},
"Description":{"shape":"Description"},
@ -1186,6 +1188,13 @@
"type":"list",
"member":{"shape":"DirectoryDescription"}
},
"DirectoryEdition":{
"type":"string",
"enum":[
"Enterprise",
"Standard"
]
},
"DirectoryId":{
"type":"string",
"pattern":"^d-[0-9a-f]{10}$"

Some files were not shown because too many files have changed in this diff Show More