1
0
Fork 0
mirror of https://github.com/Luzifer/share.git synced 2024-12-20 10:31:16 +00:00

Update vendored dependencies

Signed-off-by: Knut Ahlers <knut@ahlers.me>
This commit is contained in:
Knut Ahlers 2017-12-29 23:41:14 +01:00
parent d0b62062a3
commit c043e58efb
Signed by: luzifer
GPG key ID: DC2729FDD34BE99E
374 changed files with 50218 additions and 25427 deletions

12
Gopkg.lock generated
View file

@ -10,8 +10,8 @@
[[projects]]
name = "github.com/aws/aws-sdk-go"
packages = ["aws","aws/awserr","aws/awsutil","aws/client","aws/client/metadata","aws/corehandlers","aws/credentials","aws/credentials/ec2rolecreds","aws/credentials/endpointcreds","aws/credentials/stscreds","aws/defaults","aws/ec2metadata","aws/endpoints","aws/request","aws/session","aws/signer/v4","internal/shareddefaults","private/protocol","private/protocol/query","private/protocol/query/queryutil","private/protocol/rest","private/protocol/restxml","private/protocol/xml/xmlutil","service/s3","service/sts"]
revision = "388e6676807f5968ad5eaaec0c70002f80c20b84"
version = "v1.12.39"
revision = "5db34a6d9a78f5a3c6a713197aeb6bf159458211"
version = "v1.12.54"
[[projects]]
name = "github.com/go-ini/ini"
@ -27,8 +27,8 @@
[[projects]]
name = "github.com/sirupsen/logrus"
packages = ["."]
revision = "f006c2ac4710855cf0f916dd6b77acf6b048dc6e"
version = "v1.0.3"
revision = "d682213848ed68c0a260ca37d6dd5ace8423f5ba"
version = "v1.0.4"
[[projects]]
name = "github.com/spf13/pflag"
@ -40,13 +40,13 @@
branch = "master"
name = "golang.org/x/crypto"
packages = ["ssh/terminal"]
revision = "94eea52f7b742c7cbe0b03b22f0c4c8631ece122"
revision = "95a4943f35d008beabde8c11e5075a1b714e6419"
[[projects]]
branch = "master"
name = "golang.org/x/sys"
packages = ["unix","windows"]
revision = "8b4580aae2a0dd0c231a45d3ccb8434ff533b840"
revision = "83801418e1b59fb1880e363299581ee543af32ca"
[[projects]]
branch = "v2"

View file

@ -1,3 +1,152 @@
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)
===

View file

@ -305,7 +305,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

@ -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.
@ -222,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)",
},
@ -251,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{},
@ -281,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{},
@ -306,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{},
@ -354,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{},
@ -412,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{},
@ -491,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{},
@ -502,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{},
@ -545,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{},
@ -574,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{},
@ -645,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{},
@ -698,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{},
@ -735,6 +752,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{},
@ -762,6 +780,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"},
@ -790,6 +809,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{},
@ -813,12 +833,15 @@ 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{},
@ -830,12 +853,15 @@ 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{},
@ -854,6 +880,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{},
@ -873,6 +900,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{},
@ -905,6 +933,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{},
@ -929,6 +958,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}",
@ -981,6 +1011,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{},
@ -1000,6 +1031,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{},
@ -1051,6 +1083,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{},
@ -1060,6 +1093,7 @@ var awsPartition = partition{
"glue": service{
Endpoints: endpoints{
"eu-west-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
"us-west-2": endpoint{},
@ -1119,6 +1153,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{},
@ -1156,6 +1191,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{},
@ -1183,6 +1219,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{},
@ -1202,6 +1239,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{},
@ -1236,6 +1274,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{},
@ -1315,6 +1354,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{},
@ -1343,6 +1383,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{},
@ -1393,6 +1434,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{},
@ -1412,6 +1454,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}",
@ -1433,6 +1476,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{},
@ -1510,6 +1554,7 @@ var awsPartition = partition{
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"},
@ -1566,6 +1611,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{},
@ -1592,8 +1638,10 @@ var awsPartition = partition{
"ap-southeast-2": 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{},
},
},
@ -1606,6 +1654,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{},
@ -1627,6 +1676,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{},
@ -1649,6 +1699,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}",
@ -1670,6 +1721,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{},
@ -1702,6 +1754,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{},
@ -1726,6 +1779,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"},
@ -1764,6 +1818,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{
@ -1813,6 +1868,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{},
@ -1932,6 +1988,9 @@ var awscnPartition = partition{
"cn-north-1": region{
Description: "China (Beijing)",
},
"cn-northwest-1": region{
Description: "China (Ningxia)",
},
},
Services: services{
"apigateway": service{
@ -1949,7 +2008,8 @@ var awscnPartition = partition{
},
},
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"autoscaling": service{
@ -1957,25 +2017,29 @@ 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-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"cognito-identity": service{
@ -1987,13 +2051,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{
@ -2001,7 +2067,8 @@ var awscnPartition = partition{
Protocols: []string{"http", "https"},
},
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"ec2": service{
@ -2009,7 +2076,8 @@ var awscnPartition = partition{
Protocols: []string{"http", "https"},
},
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"ec2metadata": service{
@ -2038,13 +2106,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{
@ -2052,7 +2122,8 @@ var awscnPartition = partition{
Protocols: []string{"https"},
},
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"elasticmapreduce": service{
@ -2060,14 +2131,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{},
},
},
"es": service{},
"events": service{
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"glacier": service{
@ -2075,7 +2153,8 @@ var awscnPartition = partition{
Protocols: []string{"http", "https"},
},
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"iam": service{
@ -2104,7 +2183,8 @@ var awscnPartition = partition{
"kinesis": service{
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"lambda": service{
@ -2116,7 +2196,8 @@ var awscnPartition = partition{
"logs": service{
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"monitoring": service{
@ -2124,19 +2205,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{
@ -2145,7 +2229,8 @@ var awscnPartition = partition{
SignatureVersions: []string{"s3v4"},
},
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"snowball": service{
@ -2159,7 +2244,8 @@ var awscnPartition = partition{
Protocols: []string{"http", "https"},
},
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"sqs": service{
@ -2168,13 +2254,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{
@ -2191,19 +2279,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{

View file

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

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

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

View file

@ -1,69 +0,0 @@
{
"pagination": {
"GetClassifiers": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"GetConnections": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"GetCrawlerMetrics": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"GetCrawlers": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"GetDatabases": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"GetDevEndpoints": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"GetJobRuns": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"GetJobs": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"GetPartitions": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"GetTableVersions": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"GetTables": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"GetTriggers": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"GetUserDefinedFunctions": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
}
}
}

View file

@ -1,5 +0,0 @@
{
"version": 2,
"waiters": {}
}

View file

@ -1187,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":{
@ -1448,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":{
@ -1478,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":{
@ -1866,6 +1915,13 @@
"warnings":{"shape":"ListOfString"}
}
},
"ApiKeySourceType":{
"type":"string",
"enum":[
"HEADER",
"AUTHORIZER"
]
},
"ApiKeys":{
"type":"structure",
"members":{
@ -2206,6 +2262,8 @@
"version":{"shape":"String"},
"cloneFrom":{"shape":"String"},
"binaryMediaTypes":{"shape":"ListOfString"},
"minimumCompressionSize":{"shape":"NullableInteger"},
"apiKeySource":{"shape":"ApiKeySourceType"},
"endpointConfiguration":{"shape":"EndpointConfiguration"}
}
},
@ -2229,7 +2287,8 @@
"cacheClusterSize":{"shape":"CacheClusterSize"},
"variables":{"shape":"MapOfStringToString"},
"documentationVersion":{"shape":"String"},
"canarySettings":{"shape":"CanarySettings"}
"canarySettings":{"shape":"CanarySettings"},
"tags":{"shape":"MapOfStringToString"}
}
},
"CreateUsagePlanKeyRequest":{
@ -3691,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":[
@ -4128,7 +4208,8 @@
"requestParameters":{"shape":"MapOfStringToBoolean"},
"requestModels":{"shape":"MapOfStringToString"},
"methodResponses":{"shape":"MapOfMethodResponse"},
"methodIntegration":{"shape":"Integration"}
"methodIntegration":{"shape":"Integration"},
"authorizationScopes":{"shape":"ListOfString"}
}
},
"MethodResponse":{
@ -4346,7 +4427,8 @@
"operationName":{"shape":"String"},
"requestParameters":{"shape":"MapOfStringToBoolean"},
"requestModels":{"shape":"MapOfStringToString"},
"requestValidatorId":{"shape":"String"}
"requestValidatorId":{"shape":"String"},
"authorizationScopes":{"shape":"ListOfString"}
}
},
"PutMethodResponseRequest":{
@ -4484,6 +4566,8 @@
"version":{"shape":"String"},
"warnings":{"shape":"ListOfString"},
"binaryMediaTypes":{"shape":"ListOfString"},
"minimumCompressionSize":{"shape":"NullableInteger"},
"apiKeySource":{"shape":"ApiKeySourceType"},
"endpointConfiguration":{"shape":"EndpointConfiguration"}
}
},
@ -4572,6 +4656,7 @@
"documentationVersion":{"shape":"String"},
"accessLogSettings":{"shape":"AccessLogSettings"},
"canarySettings":{"shape":"CanarySettings"},
"tags":{"shape":"MapOfStringToString"},
"createdDate":{"shape":"Timestamp"},
"lastUpdatedDate":{"shape":"Timestamp"}
}
@ -4594,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":{
@ -4713,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":{

View file

@ -79,6 +79,7 @@
"GetSdkTypes": null,
"GetStage": "<p>Gets information about a <a>Stage</a> resource.</p>",
"GetStages": "<p>Gets information about one or more <a>Stage</a> resources.</p>",
"GetTags": "<p>Gets the Tags collection for a given resource.</p>",
"GetUsage": "<p>Gets the usage data of a usage plan in a specified time interval.</p>",
"GetUsagePlan": "<p>Gets a usage plan of a given plan identifier.</p>",
"GetUsagePlanKey": "<p>Gets a usage plan key of a given key identifier.</p>",
@ -95,8 +96,10 @@
"PutMethod": "<p>Add a method to an existing <a>Resource</a> resource.</p>",
"PutMethodResponse": "<p>Adds a <a>MethodResponse</a> to an existing <a>Method</a> resource.</p>",
"PutRestApi": "<p>A feature of the API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.</p>",
"TagResource": "<p>Adds or updates Tags on a gievn resource.</p>",
"TestInvokeAuthorizer": "<p>Simulate the execution of an <a>Authorizer</a> in your <a>RestApi</a> with headers, parameters, and an incoming request body.</p> <div class=\"seeAlso\"> <a href=\"http://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html\">Enable custom authorizers</a> </div>",
"TestInvokeMethod": "<p>Simulate the execution of a <a>Method</a> in your <a>RestApi</a> with headers, parameters, and an incoming request body.</p>",
"UntagResource": "<p>Removes Tags from a given resource.</p>",
"UpdateAccount": "<p>Changes information about the current <a>Account</a> resource.</p>",
"UpdateApiKey": "<p>Changes information about an <a>ApiKey</a> resource.</p>",
"UpdateAuthorizer": "<p>Updates an existing <a>Authorizer</a> resource.</p> <div class=\"seeAlso\"><a href=\"http://docs.aws.amazon.com/cli/latest/reference/apigateway/update-authorizer.html\">AWS CLI</a></div>",
@ -143,6 +146,13 @@
"refs": {
}
},
"ApiKeySourceType": {
"base": null,
"refs": {
"CreateRestApiRequest$apiKeySource": "<p>The source of the API key for metring requests according to a usage plan. Valid values are <ul><li><code>HEADER</code> to read the API key from the <code>X-API-Key</code> header of a request. </li><li><code>AUTHORIZER</code> to read the API key from the <code>UsageIdentifierKey</code> from a custom authorizer.</li></ul> </p>",
"RestApi$apiKeySource": "<p>The source of the API key for metring requests according to a usage plan. Valid values are <ul><li><code>HEADER</code> to read the API key from the <code>X-API-Key</code> header of a request. </li><li><code>AUTHORIZER</code> to read the API key from the <code>UsageIdentifierKey</code> from a custom authorizer.</li></ul> </p>"
}
},
"ApiKeys": {
"base": "<p>Represents a collection of API keys as represented by an <a>ApiKeys</a> resource.</p> <div class=\"seeAlso\"> <a href=\"http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-api-keys.html\">Use API Keys</a> </div>",
"refs": {
@ -275,8 +285,8 @@
"ConnectionType": {
"base": null,
"refs": {
"Integration$connectionType": "<p>The type of the network connection to the integration endpoint. The valid value is <code>INTERNET</code> for connections through the public routable internet or <code>VPC_LINK</code> for private connections between API Gateway and an network load balancer in a VPC. The default value is <code>INTERNET</code>.</p>",
"PutIntegrationRequest$connectionType": "<p>The type of the network connection to the integration endpoint. The valid value is <code>INTERNET</code> for connections through the public routable internet or <code>VPC_LINK</code> for private connections between API Gateway and an network load balancer in a VPC. The default value is <code>INTERNET</code>.</p>"
"Integration$connectionType": "<p>The type of the network connection to the integration endpoint. The valid value is <code>INTERNET</code> for connections through the public routable internet or <code>VPC_LINK</code> for private connections between API Gateway and a network load balancer in a VPC. The default value is <code>INTERNET</code>.</p>",
"PutIntegrationRequest$connectionType": "<p>The type of the network connection to the integration endpoint. The valid value is <code>INTERNET</code> for connections through the public routable internet or <code>VPC_LINK</code> for private connections between API Gateway and a network load balancer in a VPC. The default value is <code>INTERNET</code>.</p>"
}
},
"ContentHandlingStrategy": {
@ -583,7 +593,7 @@
}
},
"GatewayResponse": {
"base": "<p>A gateway response of a given response type and status code, with optional response parameters and mapping templates.</p> <div class=\"remarks\"> For more information about valid gateway response types, see <a href=\"http://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html\">Gateway Response Types Supported by API Gateway</a> <div class=\"example\"> <h4>Example: Get a Gateway Response of a given response type</h4> <h5>Request</h5> <p>This example shows how to get a gateway response of the <code>MISSING_AUTHNETICATION_TOKEN</code> type.</p> <pre><code>GET /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T202516Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=1b52460e3159c1a26cff29093855d50ea141c1c5b937528fecaf60f51129697a Cache-Control: no-cache Postman-Token: 3b2a1ce9-c848-2e26-2e2f-9c2caefbed45 </code></pre> <p>The response type is specified as a URL path.</p> <h5>Response</h5> <p>The successful operation returns the <code>200 OK</code> status code and a payload similar to the following:</p> <pre><code>{ \"_links\": { \"curies\": { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html\", \"name\": \"gatewayresponse\", \"templated\": true }, \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" }, \"gatewayresponse:delete\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" } }, \"defaultResponse\": false, \"responseParameters\": { \"gatewayresponse.header.x-request-path\": \"method.request.path.petId\", \"gatewayresponse.header.Access-Control-Allow-Origin\": \"&apos;a.b.c&apos;\", \"gatewayresponse.header.x-request-query\": \"method.request.querystring.q\", \"gatewayresponse.header.x-request-header\": \"method.request.header.Accept\" }, \"responseTemplates\": { \"application/json\": \"{\\n \\\"message\\\": $context.error.messageString,\\n \\\"type\\\": \\\"$context.error.responseType\\\",\\n \\\"stage\\\": \\\"$context.stage\\\",\\n \\\"resourcePath\\\": \\\"$context.resourcePath\\\",\\n \\\"stageVariables.a\\\": \\\"$stageVariables.a\\\",\\n \\\"statusCode\\\": \\\"&apos;404&apos;\\\"\\n}\" }, \"responseType\": \"MISSING_AUTHENTICATION_TOKEN\", \"statusCode\": \"404\" }</code></pre> <p></p> </div> </div> <div class=\"seeAlso\"> <a href=\"http://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html\">Customize Gateway Responses</a> </div>",
"base": "<p>A gateway response of a given response type and status code, with optional response parameters and mapping templates.</p> <div class=\"remarks\"> For more information about valid gateway response types, see <a href=\"http://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html\">Gateway Response Types Supported by API Gateway</a> <div class=\"example\"> <h4>Example: Get a Gateway Response of a given response type</h4> <h5>Request</h5> <p>This example shows how to get a gateway response of the <code>MISSING_AUTHENTICATION_TOKEN</code> type.</p> <pre><code>GET /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T202516Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=1b52460e3159c1a26cff29093855d50ea141c1c5b937528fecaf60f51129697a Cache-Control: no-cache Postman-Token: 3b2a1ce9-c848-2e26-2e2f-9c2caefbed45 </code></pre> <p>The response type is specified as a URL path.</p> <h5>Response</h5> <p>The successful operation returns the <code>200 OK</code> status code and a payload similar to the following:</p> <pre><code>{ \"_links\": { \"curies\": { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html\", \"name\": \"gatewayresponse\", \"templated\": true }, \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" }, \"gatewayresponse:delete\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" } }, \"defaultResponse\": false, \"responseParameters\": { \"gatewayresponse.header.x-request-path\": \"method.request.path.petId\", \"gatewayresponse.header.Access-Control-Allow-Origin\": \"&apos;a.b.c&apos;\", \"gatewayresponse.header.x-request-query\": \"method.request.querystring.q\", \"gatewayresponse.header.x-request-header\": \"method.request.header.Accept\" }, \"responseTemplates\": { \"application/json\": \"{\\n \\\"message\\\": $context.error.messageString,\\n \\\"type\\\": \\\"$context.error.responseType\\\",\\n \\\"stage\\\": \\\"$context.stage\\\",\\n \\\"resourcePath\\\": \\\"$context.resourcePath\\\",\\n \\\"stageVariables.a\\\": \\\"$stageVariables.a\\\",\\n \\\"statusCode\\\": \\\"&apos;404&apos;\\\"\\n}\" }, \"responseType\": \"MISSING_AUTHENTICATION_TOKEN\", \"statusCode\": \"404\" }</code></pre> <p></p> </div> </div> <div class=\"seeAlso\"> <a href=\"http://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html\">Customize Gateway Responses</a> </div>",
"refs": {
"ListOfGatewayResponse$member": null
}
@ -798,6 +808,11 @@
"refs": {
}
},
"GetTagsRequest": {
"base": "<p>Gets the Tags collection for a given resource.</p>",
"refs": {
}
},
"GetUsagePlanKeyRequest": {
"base": "<p>The GET request to get a usage plan key of a given key identifier.</p>",
"refs": {
@ -1057,9 +1072,12 @@
"GetResourcesRequest$embed": "<p>A query parameter used to retrieve the specified resources embedded in the returned <a>Resources</a> resource in the response. This <code>embed</code> parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded <a>Method</a> resources this way. The query parameter value must be a single-valued list and contain the <code>\"methods\"</code> string. For example, <code>GET /restapis/{restapi_id}/resources?embed=methods</code>.</p>",
"Integration$cacheKeyParameters": "<p>Specifies the integration's cache key parameters.</p>",
"MapOfStringToList$value": null,
"Method$authorizationScopes": "<p>A list of authorization scopes configured on the method. The scopes are used with a <code>COGNITO_USER_POOL</code> authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.</p>",
"PutIntegrationRequest$cacheKeyParameters": "<p>Specifies a put integration input's cache key parameters.</p>",
"PutMethodRequest$authorizationScopes": "<p>A list of authorization scopes configured on the method. The scopes are used with a <code>COGNITO_USER_POOL</code> authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.</p>",
"RestApi$warnings": "<p>The warning messages reported when <code>failonwarnings</code> is turned on during API import.</p>",
"RestApi$binaryMediaTypes": "<p>The list of binary media types supported by the <a>RestApi</a>. By default, the <a>RestApi</a> supports only UTF-8-encoded text payloads.</p>",
"UntagResourceRequest$tagKeys": "<p>The Tag keys to delete.</p>",
"VpcLink$targetArns": "<p>The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.</p>"
}
},
@ -1166,6 +1184,7 @@
"CanarySettings$stageVariableOverrides": "<p>Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.</p>",
"CreateDeploymentRequest$variables": "<p>A map that defines the stage variables for the <a>Stage</a> resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match <code>[A-Za-z0-9-._~:/?#&amp;=,]+</code>.</p>",
"CreateStageRequest$variables": "<p>A map that defines the stage variables for the new <a>Stage</a> resource. Variable names can have alphanumeric and underscore characters, and the values must match <code>[A-Za-z0-9-._~:/?#&amp;=,]+</code>.</p>",
"CreateStageRequest$tags": "<p>Key/Value map of strings. Valid character set is [a-zA-Z+-=._:/]. Tag key can be up to 128 characters and must not start with \"aws:\". Tag value can be up to 256 characters.</p>",
"DeploymentCanarySettings$stageVariableOverrides": "<p>A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.</p>",
"GatewayResponse$responseParameters": "<p>Response parameters (paths, query strings and headers) of the <a>GatewayResponse</a> as a string-to-string map of key-value pairs.</p>",
"GatewayResponse$responseTemplates": "<p>Response templates of the <a>GatewayResponse</a> as a string-to-string map of key-value pairs.</p>",
@ -1188,6 +1207,9 @@
"PutMethodResponseRequest$responseModels": "<p>Specifies the <a>Model</a> resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a <a>Model</a> name as the value.</p>",
"PutRestApiRequest$parameters": "<p>Custom header parameters as part of the request. For example, to exclude <a>DocumentationParts</a> from an imported API, set <code>ignore=documentation</code> as a <code>parameters</code> value, as in the AWS CLI command of <code>aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json</code>.</p>",
"Stage$variables": "<p>A map that defines the stage variables for a <a>Stage</a> resource. Variable names can have alphanumeric and underscore characters, and the values must match <code>[A-Za-z0-9-._~:/?#&amp;=,]+</code>.</p>",
"Stage$tags": "<p>A collection of Tags associated with a given resource.</p>",
"TagResourceRequest$tags": "<p>[Required] Key/Value map of strings. Valid character set is [a-zA-Z+-=._:/]. Tag key can be up to 128 characters and must not start with \"aws:\". Tag value can be up to 256 characters.</p>",
"Tags$tags": "<p>A collection of Tags associated with a given resource.</p>",
"TestInvokeAuthorizerRequest$stageVariables": "<p>A key-value map of stage variables to simulate an invocation on a deployed <a>Stage</a>.</p>",
"TestInvokeAuthorizerRequest$additionalContext": "<p>[Optional] A key-value map of additional context variables.</p>",
"TestInvokeAuthorizerResponse$claims": "<p>The <a href=\"http://openid.net/specs/openid-connect-core-1_0.html#StandardClaims\">open identity claims</a>, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.</p>",
@ -1249,6 +1271,7 @@
"refs": {
"Authorizer$authorizerResultTtlInSeconds": "<p>The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.</p>",
"CreateAuthorizerRequest$authorizerResultTtlInSeconds": "<p>The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.</p>",
"CreateRestApiRequest$minimumCompressionSize": "<p>A nullable integer used to enable (non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable (null) compression on an API. When compression is enabled, compression or decompression are not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.</p>",
"GetApiKeysRequest$limit": "<p>The maximum number of returned results per page.</p>",
"GetAuthorizersRequest$limit": "<p>The maximum number of returned results per page.</p>",
"GetBasePathMappingsRequest$limit": "<p>The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.</p>",
@ -1263,11 +1286,13 @@
"GetResourcesRequest$limit": "<p>The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.</p>",
"GetRestApisRequest$limit": "<p>The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.</p>",
"GetSdkTypesRequest$limit": "<p>The maximum number of returned results per page.</p>",
"GetTagsRequest$limit": "<p>(Not currently supported) The maximum number of returned results per page.</p>",
"GetUsagePlanKeysRequest$limit": "<p>The maximum number of returned results per page.</p>",
"GetUsagePlansRequest$limit": "<p>The maximum number of returned results per page.</p>",
"GetUsageRequest$limit": "<p>The maximum number of returned results per page.</p>",
"GetVpcLinksRequest$limit": "<p>The maximum number of returned results per page.</p>",
"PutIntegrationRequest$timeoutInMillis": "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.</p>"
"PutIntegrationRequest$timeoutInMillis": "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.</p>",
"RestApi$minimumCompressionSize": "<p>A nullable integer used to enable (non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable (null) compression on an API. When compression is enabled, compression or decompression are not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.</p>"
}
},
"Op": {
@ -1674,6 +1699,8 @@
"GetStageRequest$stageName": "<p>The name of the <a>Stage</a> resource to get information about.</p>",
"GetStagesRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"GetStagesRequest$deploymentId": "<p>The stages' deployment identifiers.</p>",
"GetTagsRequest$resourceArn": "<p>[Required] The ARN of a resource that can be tagged. At present, <a>Stage</a> is the only taggable resource.</p>",
"GetTagsRequest$position": "<p>(Not currently supported) The current pagination position in the paged result set.</p>",
"GetUsagePlanKeyRequest$usagePlanId": "<p>The Id of the <a>UsagePlan</a> resource representing the usage plan containing the to-be-retrieved <a>UsagePlanKey</a> resource representing a plan customer.</p>",
"GetUsagePlanKeyRequest$keyId": "<p>The key Id of the to-be-retrieved <a>UsagePlanKey</a> resource representing a plan customer.</p>",
"GetUsagePlanKeysRequest$usagePlanId": "<p>The Id of the <a>UsagePlan</a> resource representing the usage plan containing the to-be-retrieved <a>UsagePlanKey</a> resource representing a plan customer.</p>",
@ -1787,6 +1814,7 @@
"Stage$documentationVersion": "<p>The version of the associated API documentation.</p>",
"StageKey$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"StageKey$stageName": "<p>The stage name associated with the stage key.</p>",
"TagResourceRequest$resourceArn": "<p>[Required] The ARN of a resource that can be tagged. At present, <a>Stage</a> is the only taggable resource.</p>",
"Template$value": "<p>The Apache <a href=\"http://velocity.apache.org/engine/devel/vtl-reference-guide.html\" target=\"_blank\">Velocity Template Language (VTL)</a> template content used for the template resource.</p>",
"TestInvokeAuthorizerRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"TestInvokeAuthorizerRequest$authorizerId": "<p>Specifies a test invoke authorizer request's <a>Authorizer</a> ID.</p>",
@ -1806,6 +1834,7 @@
"TooManyRequestsException$retryAfterSeconds": null,
"TooManyRequestsException$message": null,
"UnauthorizedException$message": null,
"UntagResourceRequest$resourceArn": "<p>[Required] The ARN of a resource that can be tagged. At present, <a>Stage</a> is the only taggable resource.</p>",
"UpdateApiKeyRequest$apiKey": "<p>The identifier of the <a>ApiKey</a> resource to be updated.</p>",
"UpdateAuthorizerRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"UpdateAuthorizerRequest$authorizerId": "<p>The identifier of the <a>Authorizer</a> resource.</p>",
@ -1866,6 +1895,16 @@
"VpcLinks$position": null
}
},
"TagResourceRequest": {
"base": "<p>Adds or updates Tags on a gievn resource.</p>",
"refs": {
}
},
"Tags": {
"base": "<p>A collection of Tags associated with a given resource.</p>",
"refs": {
}
},
"Template": {
"base": "<p>Represents a mapping template used to transform a payload.</p> <div class=\"seeAlso\"> <a href=\"http://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html#models-mappings-mappings\">Mapping Templates</a> </div>",
"refs": {
@ -1930,6 +1969,11 @@
"refs": {
}
},
"UntagResourceRequest": {
"base": "<p>Removes Tags from a given resource.</p>",
"refs": {
}
},
"UpdateAccountRequest": {
"base": "<p>Requests API Gateway to change information about the current <a>Account</a> resource.</p>",
"refs": {
@ -2068,7 +2112,7 @@
}
},
"VpcLink": {
"base": "<p>A API Gateway VPC link for a <a>RestApi</a> to access resources in an Amazon Virtual Private Cloud (VPC).</p> <div class=\"remarks\"> <p><p>To enable access to a resource in an Amazon Virtual Private Cloud through Amazon API Gateway, you, as an API developer, create a <a>VpcLink</a> resource targeted for one or more network load balancers of the VPC and then integrate an API method with a private integration that uses the <a>VpcLink</a>. The private integraiton has an integration type of <code>HTTP</code> or <code>HTTP_PROXY</code> and has a connection type of <code>VPC_LINK</code>. The integration uses the <code>connectionId</code> property to identify the <a>VpcLink</a> used.</p> </p> </div>",
"base": "<p>A API Gateway VPC link for a <a>RestApi</a> to access resources in an Amazon Virtual Private Cloud (VPC).</p> <div class=\"remarks\"> <p><p>To enable access to a resource in an Amazon Virtual Private Cloud through Amazon API Gateway, you, as an API developer, create a <a>VpcLink</a> resource targeted for one or more network load balancers of the VPC and then integrate an API method with a private integration that uses the <a>VpcLink</a>. The private integration has an integration type of <code>HTTP</code> or <code>HTTP_PROXY</code> and has a connection type of <code>VPC_LINK</code>. The integration uses the <code>connectionId</code> property to identify the <a>VpcLink</a> used.</p> </p> </div>",
"refs": {
"ListOfVpcLink$member": null
}

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>"
}
}

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

@ -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

@ -442,7 +442,8 @@
"type":"structure",
"members":{
"name":{"shape":"String"},
"description":{"shape":"String"}
"description":{"shape":"String"},
"versions":{"shape":"ImageVersions"}
}
},
"EnvironmentImages":{
@ -498,6 +499,10 @@
"type":"list",
"member":{"shape":"EnvironmentVariable"}
},
"ImageVersions":{
"type":"list",
"member":{"shape":"String"}
},
"InvalidInputException":{
"type":"structure",
"members":{

View file

@ -253,6 +253,12 @@
"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": {
@ -556,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>",
@ -636,11 +643,11 @@
}
},
"VpcConfig": {
"base": "<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>",
"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>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>",
"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>"
}
},

View file

@ -4989,6 +4989,7 @@
"UserPoolTags":{"shape":"UserPoolTagsType"},
"SmsConfigurationFailure":{"shape":"StringType"},
"EmailConfigurationFailure":{"shape":"StringType"},
"Domain":{"shape":"DomainType"},
"AdminCreateUserConfig":{"shape":"AdminCreateUserConfigType"},
"UserPoolAddOns":{"shape":"UserPoolAddOnsType"}
}

View file

@ -1189,7 +1189,8 @@
"CreateUserPoolDomainRequest$Domain": "<p>The domain string.</p>",
"DeleteUserPoolDomainRequest$Domain": "<p>The domain string.</p>",
"DescribeUserPoolDomainRequest$Domain": "<p>The domain string.</p>",
"DomainDescriptionType$Domain": "<p>The domain string.</p>"
"DomainDescriptionType$Domain": "<p>The domain string.</p>",
"UserPoolType$Domain": "<p>Holds the domain prefix if the user pool has a domain associated with it.</p>"
}
},
"DomainVersionType": {
@ -2404,7 +2405,7 @@
"base": null,
"refs": {
"AdminDisableProviderForUserRequest$UserPoolId": "<p>The user pool ID for the user pool.</p>",
"AdminGetUserResponse$PreferredMfaSetting": null,
"AdminGetUserResponse$PreferredMfaSetting": "<p>The user's preferred MFA setting.</p>",
"AdminLinkProviderForUserRequest$UserPoolId": "<p>The user pool ID for the user pool.</p>",
"AnalyticsConfigurationType$ExternalId": "<p>The external ID.</p>",
"AnalyticsMetadataType$AnalyticsEndpointId": "<p>The endpoint ID.</p>",
@ -2433,7 +2434,7 @@
"EventContextDataType$City": "<p>The user's city.</p>",
"EventContextDataType$Country": "<p>The user's country.</p>",
"EventFeedbackType$Provider": "<p>The provider.</p>",
"GetUserResponse$PreferredMfaSetting": null,
"GetUserResponse$PreferredMfaSetting": "<p>The user's preferred MFA setting.</p>",
"HttpHeader$headerName": "<p>The header name</p>",
"HttpHeader$headerValue": "<p>The header value.</p>",
"ListOfStringTypes$member": null,
@ -2675,8 +2676,8 @@
"UserMFASettingListType": {
"base": null,
"refs": {
"AdminGetUserResponse$UserMFASettingList": null,
"GetUserResponse$UserMFASettingList": null
"AdminGetUserResponse$UserMFASettingList": "<p>The list of the user's MFA settings.</p>",
"GetUserResponse$UserMFASettingList": "<p>The list of the user's MFA settings.</p>"
}
},
"UserNotConfirmedException": {

View file

@ -1349,7 +1349,15 @@
"AWS::AutoScaling::LaunchConfiguration",
"AWS::AutoScaling::ScalingPolicy",
"AWS::AutoScaling::ScheduledAction",
"AWS::CodeBuild::Project"
"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

@ -2538,6 +2538,10 @@
"PrivateIpAddress":{
"shape":"String",
"locationName":"privateIpAddress"
},
"Tags":{
"shape":"TagList",
"locationName":"tagSet"
}
}
},

View file

@ -243,7 +243,7 @@
"ReleaseAddress": "<p>Releases the specified Elastic IP address.</p> <p>[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use <a>DisassociateAddress</a>.</p> <p>[Nondefault VPC] You must use <a>DisassociateAddress</a> to disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (<code>InvalidIPAddress.InUse</code>).</p> <p>After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an <code>AuthFailure</code> error if the address is already allocated to another AWS account.</p> <p>[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it. For more information, see <a>AllocateAddress</a>.</p>",
"ReleaseHosts": "<p>When you no longer want to use an On-Demand Dedicated Host it can be released. On-Demand billing is stopped and the host goes into <code>released</code> state. The host ID of Dedicated Hosts that have been released can no longer be specified in another request, e.g., ModifyHosts. You must stop or terminate all instances on a host before it can be released.</p> <p>When Dedicated Hosts are released, it make take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated hosts. Try waiting a few minutes, and then try again.</p> <p>Released hosts will still appear in a <a>DescribeHosts</a> response.</p>",
"ReplaceIamInstanceProfileAssociation": "<p>Replaces an IAM instance profile for the specified running instance. You can use this action to change the IAM instance profile that's associated with an instance without having to disassociate the existing IAM instance profile first.</p> <p>Use <a>DescribeIamInstanceProfileAssociations</a> to get the association ID.</p>",
"ReplaceNetworkAclAssociation": "<p>Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html\">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>",
"ReplaceNetworkAclAssociation": "<p>Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html\">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> <p>This is an idempotent operation.</p>",
"ReplaceNetworkAclEntry": "<p>Replaces an entry (rule) in a network ACL. For more information about network ACLs, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html\">Network ACLs</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>",
"ReplaceRoute": "<p>Replaces an existing route within a route table in a VPC. You must provide only one of the following: Internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, or egress-only Internet gateway.</p> <p>For more information about route tables, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html\">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>",
"ReplaceRouteTableAssociation": "<p>Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html\">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> <p>You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table.</p>",
@ -3385,8 +3385,8 @@
"DescribeVolumesRequest$Filters": "<p>One or more filters.</p> <ul> <li> <p> <code>attachment.attach-time</code> - The time stamp when the attachment initiated.</p> </li> <li> <p> <code>attachment.delete-on-termination</code> - Whether the volume is deleted on instance termination.</p> </li> <li> <p> <code>attachment.device</code> - The device name specified in the block device mapping (for example, <code>/dev/sda1</code>).</p> </li> <li> <p> <code>attachment.instance-id</code> - The ID of the instance the volume is attached to.</p> </li> <li> <p> <code>attachment.status</code> - The attachment state (<code>attaching</code> | <code>attached</code> | <code>detaching</code> | <code>detached</code>).</p> </li> <li> <p> <code>availability-zone</code> - The Availability Zone in which the volume was created.</p> </li> <li> <p> <code>create-time</code> - The time stamp when the volume was created.</p> </li> <li> <p> <code>encrypted</code> - The encryption status of the volume.</p> </li> <li> <p> <code>size</code> - The size of the volume, in GiB.</p> </li> <li> <p> <code>snapshot-id</code> - The snapshot from which the volume was created.</p> </li> <li> <p> <code>status</code> - The status of the volume (<code>creating</code> | <code>available</code> | <code>in-use</code> | <code>deleting</code> | <code>deleted</code> | <code>error</code>).</p> </li> <li> <p> <code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify <code>tag:Purpose</code> for the filter name and <code>X</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</p> </li> <li> <p> <code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</p> </li> <li> <p> <code>volume-id</code> - The volume ID.</p> </li> <li> <p> <code>volume-type</code> - The Amazon EBS volume type. This can be <code>gp2</code> for General Purpose SSD, <code>io1</code> for Provisioned IOPS SSD, <code>st1</code> for Throughput Optimized HDD, <code>sc1</code> for Cold HDD, or <code>standard</code> for Magnetic volumes.</p> </li> </ul>",
"DescribeVpcClassicLinkRequest$Filters": "<p>One or more filters.</p> <ul> <li> <p> <code>is-classic-link-enabled</code> - Whether the VPC is enabled for ClassicLink (<code>true</code> | <code>false</code>).</p> </li> <li> <p> <code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify <code>tag:Purpose</code> for the filter name and <code>X</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</p> </li> <li> <p> <code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</p> </li> </ul>",
"DescribeVpcEndpointConnectionNotificationsRequest$Filters": "<p>One or more filters.</p> <ul> <li> <p> <code>connection-notification-arn</code> - The ARN of SNS topic for the notification.</p> </li> <li> <p> <code>connection-notification-id</code> - The ID of the notification.</p> </li> <li> <p> <code>connection-notification-state</code> - The state of the notification (<code>Enabled</code> | <code>Disabled</code>).</p> </li> <li> <p> <code>connection-notification-type</code> - The type of notification (<code>Topic</code>).</p> </li> <li> <p> <code>service-id</code> - The ID of the endpoint service.</p> </li> <li> <p> <code>vpc-endpoint-id</code> - The ID of the VPC endpoint.</p> </li> </ul>",
"DescribeVpcEndpointConnectionsRequest$Filters": "<p>One or more filters.</p> <ul> <li> <p> <code>customer-account-id</code> - The AWS account number of the owner of the endpoint.</p> </li> <li> <p> <code>endpoint-connection-state</code> - The state of the endpoint (<code>PendingAcceptance</code> | <code>Pending</code> | <code>Available</code> | <code>Deleting</code> | <code>Deleted</code> | <code>Rejected</code> | <code>Failed</code>).</p> </li> <li> <p> <code>vpc-endpoint-id</code> - The ID of the endpoint.</p> </li> <li> <p> <code>vpc-endpoint-service-id</code> - The ID of the service.</p> </li> </ul>",
"DescribeVpcEndpointServiceConfigurationsRequest$Filters": "<p>One or more filters.</p> <ul> <li> <p> <code>service-name</code> - The ARN of the service.</p> </li> <li> <p> <code>vpc-endpoint-service-id</code> - The ID of the service.</p> </li> <li> <p> <code>vpc-endpoint-service-state</code> - The state of the service (<code>Pending</code> | <code>Available</code> | <code>Deleting</code> | <code>Deleted</code> | <code>Failed</code>). </p> </li> </ul>",
"DescribeVpcEndpointConnectionsRequest$Filters": "<p>One or more filters.</p> <ul> <li> <p> <code>service-id</code> - The ID of the service.</p> </li> <li> <p> <code>vpc-endpoint-owner</code> - The AWS account number of the owner of the endpoint.</p> </li> <li> <p> <code>vpc-endpoint-state</code> - The state of the endpoint (<code>pendingAcceptance</code> | <code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code> | <code>rejected</code> | <code>failed</code>).</p> </li> <li> <p> <code>vpc-endpoint-id</code> - The ID of the endpoint.</p> </li> </ul>",
"DescribeVpcEndpointServiceConfigurationsRequest$Filters": "<p>One or more filters.</p> <ul> <li> <p> <code>service-name</code> - The name of the service.</p> </li> <li> <p> <code>service-id</code> - The ID of the service.</p> </li> <li> <p> <code>service-state</code> - The state of the service (<code>Pending</code> | <code>Available</code> | <code>Deleting</code> | <code>Deleted</code> | <code>Failed</code>). </p> </li> </ul>",
"DescribeVpcEndpointServicePermissionsRequest$Filters": "<p>One or more filters.</p> <ul> <li> <p> <code>principal</code> - The ARN of the principal.</p> </li> <li> <p> <code>principal-type</code> - The principal type (<code>All</code> | <code>Service</code> | <code>OrganizationUnit</code> | <code>Account</code> | <code>User</code> | <code>Role</code>).</p> </li> </ul>",
"DescribeVpcEndpointServicesRequest$Filters": "<p>One or more filters.</p> <ul> <li> <p> <code>service-name</code>: The name of the service.</p> </li> </ul>",
"DescribeVpcEndpointsRequest$Filters": "<p>One or more filters.</p> <ul> <li> <p> <code>service-name</code>: The name of the service.</p> </li> <li> <p> <code>vpc-id</code>: The ID of the VPC in which the endpoint resides.</p> </li> <li> <p> <code>vpc-endpoint-id</code>: The ID of the endpoint.</p> </li> <li> <p> <code>vpc-endpoint-state</code>: The state of the endpoint. (<code>pending</code> | <code>available</code> | <code>deleting</code> | <code>deleted</code>)</p> </li> </ul>",
@ -5471,7 +5471,7 @@
}
},
"PrefixListId": {
"base": "<p>The ID of the prefix.</p>",
"base": "<p>[EC2-VPC only] The ID of the prefix.</p>",
"refs": {
"PrefixListIdList$member": null
}
@ -5479,7 +5479,7 @@
"PrefixListIdList": {
"base": null,
"refs": {
"IpPermission$PrefixListIds": "<p>(Valid for <a>AuthorizeSecurityGroupEgress</a>, <a>RevokeSecurityGroupEgress</a> and <a>DescribeSecurityGroups</a> only) One or more prefix list IDs for an AWS service. In an <a>AuthorizeSecurityGroupEgress</a> request, this is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.</p>"
"IpPermission$PrefixListIds": "<p>(EC2-VPC only; valid for <a>AuthorizeSecurityGroupEgress</a>, <a>RevokeSecurityGroupEgress</a> and <a>DescribeSecurityGroups</a> only) One or more prefix list IDs for an AWS service. In an <a>AuthorizeSecurityGroupEgress</a> request, this is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.</p>"
}
},
"PrefixListIdSet": {
@ -8071,6 +8071,7 @@
"TagList": {
"base": null,
"refs": {
"Address$Tags": "<p>Any tags assigned to the Elastic IP address.</p>",
"ClassicLinkInstance$Tags": "<p>Any tags assigned to the instance.</p>",
"ConversionTask$Tags": "<p>Any tags assigned to the task.</p>",
"CreateTagsRequest$Tags": "<p>One or more tags. The <code>value</code> parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string. </p>",

View file

@ -804,7 +804,8 @@
"deploymentConfiguration":{"shape":"DeploymentConfiguration"},
"placementConstraints":{"shape":"PlacementConstraints"},
"placementStrategy":{"shape":"PlacementStrategies"},
"networkConfiguration":{"shape":"NetworkConfiguration"}
"networkConfiguration":{"shape":"NetworkConfiguration"},
"healthCheckGracePeriodSeconds":{"shape":"BoxedInteger"}
}
},
"CreateServiceResponse":{
@ -1519,7 +1520,8 @@
"createdAt":{"shape":"Timestamp"},
"placementConstraints":{"shape":"PlacementConstraints"},
"placementStrategy":{"shape":"PlacementStrategies"},
"networkConfiguration":{"shape":"NetworkConfiguration"}
"networkConfiguration":{"shape":"NetworkConfiguration"},
"healthCheckGracePeriodSeconds":{"shape":"BoxedInteger"}
}
},
"ServiceEvent":{
@ -1846,7 +1848,8 @@
"deploymentConfiguration":{"shape":"DeploymentConfiguration"},
"networkConfiguration":{"shape":"NetworkConfiguration"},
"platformVersion":{"shape":"String"},
"forceNewDeployment":{"shape":"Boolean"}
"forceNewDeployment":{"shape":"Boolean"},
"healthCheckGracePeriodSeconds":{"shape":"BoxedInteger"}
}
},
"UpdateServiceResponse":{

View file

@ -1,6 +1,6 @@
{
"version": "2.0",
"service": "<p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster. You can host your cluster on a serverless infrastructure that is managed by Amazon ECS by launching your services or tasks using the Fargate launch type. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage by using the EC2 launch type. For more information about launch types, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguidelaunch_types.html\">Amazon ECS Launch Types</a>.</p> <p>Amazon ECS lets you launch and stop container-based applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.</p> <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon ECS eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.</p>",
"service": "<p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster. You can host your cluster on a serverless infrastructure that is managed by Amazon ECS by launching your services or tasks using the Fargate launch type. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage by using the EC2 launch type. For more information about launch types, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html\">Amazon ECS Launch Types</a>.</p> <p>Amazon ECS lets you launch and stop container-based applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.</p> <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon ECS eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.</p>",
"operations": {
"CreateCluster": "<p>Creates a new Amazon ECS cluster. By default, your account receives a <code>default</code> cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the <code>CreateCluster</code> action.</p> <note> <p>When you call the <a>CreateCluster</a> API operation, Amazon ECS attempts to create the service-linked role for your account so that required resources in other AWS services can be managed on your behalf. However, if the IAM user that makes the call does not have permissions to create the service-linked role, it is not created. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html\">Using Service-Linked Roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </note>",
"CreateService": "<p>Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below <code>desiredCount</code>, Amazon ECS spawns another copy of the task in the specified cluster. To update an existing service, see <a>UpdateService</a>.</p> <p>In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind a load balancer. The load balancer distributes traffic across the tasks that are associated with the service. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html\">Service Load Balancing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>You can optionally specify a deployment configuration for your service. During a deployment, the service scheduler uses the <code>minimumHealthyPercent</code> and <code>maximumPercent</code> parameters to determine the deployment strategy. The deployment is triggered by changing the task definition or the desired count of a service with an <a>UpdateService</a> operation.</p> <p>The <code>minimumHealthyPercent</code> represents a lower limit on the number of your service's tasks that must remain in the <code>RUNNING</code> state during a deployment, as a percentage of the <code>desiredCount</code> (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a <code>desiredCount</code> of four tasks and a <code>minimumHealthyPercent</code> of 50%, the scheduler can stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that <i>do not</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state. Tasks for services that <i>do</i> use a load balancer are considered healthy if they are in the <code>RUNNING</code> state and the container instance they are hosted on is reported as healthy by the load balancer. The default value for <code>minimumHealthyPercent</code> is 50% in the console and 100% for the AWS CLI, the AWS SDKs, and the APIs.</p> <p>The <code>maximumPercent</code> parameter represents an upper limit on the number of your service's tasks that are allowed in the <code>RUNNING</code> or <code>PENDING</code> state during a deployment, as a percentage of the <code>desiredCount</code> (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service has a <code>desiredCount</code> of four tasks and a <code>maximumPercent</code> value of 200%, the scheduler can start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for <code>maximumPercent</code> is 200%.</p> <p>When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic:</p> <ul> <li> <p>Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).</p> </li> <li> <p>By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy) with the <code>placementStrategy</code> parameter):</p> <ul> <li> <p>Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.</p> </li> <li> <p>Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.</p> </li> </ul> </li> </ul>",
@ -25,7 +25,7 @@
"PutAttributes": "<p>Create or update an attribute on an Amazon ECS resource. If the attribute does not exist, it is created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use <a>DeleteAttributes</a>. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes\">Attributes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>",
"RegisterContainerInstance": "<note> <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p> </note> <p>Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.</p>",
"RegisterTaskDefinition": "<p>Registers a new task definition from the supplied <code>family</code> and <code>containerDefinitions</code>. Optionally, you can add data volumes to your containers with the <code>volumes</code> parameter. For more information about task definition parameters and defaults, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html\">Amazon ECS Task Definitions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>You can specify an IAM role for your task with the <code>taskRoleArn</code> parameter. When you specify an IAM role for a task, its containers can then use the latest versions of the AWS CLI or SDKs to make API requests to the AWS services that are specified in the IAM policy associated with the role. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html\">IAM Roles for Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>You can specify a Docker networking mode for the containers in your task definition with the <code>networkMode</code> parameter. The available network modes correspond to those described in <a href=\"https://docs.docker.com/engine/reference/run/#/network-settings\">Network settings</a> in the Docker run reference. If you specify the <code>awsvpc</code> network mode, the task is allocated an Elastic Network Interface, and you must specify a <a>NetworkConfiguration</a> when you create a service or run a task with the task definition. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html\">Task Networking</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>",
"RunTask": "<p>Starts a new task using the specified task definition.</p> <p>You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html\">Scheduling Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>Alternatively, you can use <a>StartTask</a> to use your own scheduler or place tasks manually on specific container instances.</p>",
"RunTask": "<p>Starts a new task using the specified task definition.</p> <p>You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html\">Scheduling Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>Alternatively, you can use <a>StartTask</a> to use your own scheduler or place tasks manually on specific container instances.</p> <p>The Amazon ECS API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. You should keep this in mind when you carry out an API command that immediately follows a previous API command.</p> <p>To manage eventual consistency, you can do the following:</p> <ul> <li> <p>Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time, and increasing gradually up to five minutes of wait time.</p> </li> <li> <p>Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.</p> </li> </ul>",
"StartTask": "<p>Starts a new task from the specified task definition on the specified container instance or instances.</p> <p>Alternatively, you can use <a>RunTask</a> to place tasks for you. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html\">Scheduling Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>",
"StopTask": "<p>Stops a running task.</p> <p>When <a>StopTask</a> is called on a task, the equivalent of <code>docker stop</code> is issued to the containers running in the task. This results in a <code>SIGTERM</code> and a default 30-second timeout, after which <code>SIGKILL</code> is sent and the containers are forcibly stopped. If the container handles the <code>SIGTERM</code> gracefully and exits within 30 seconds from receiving it, no <code>SIGKILL</code> is sent.</p> <note> <p>The default 30-second timeout can be configured on the Amazon ECS container agent with the <code>ECS_CONTAINER_STOP_TIMEOUT</code> variable. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html\">Amazon ECS Container Agent Configuration</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </note>",
"SubmitContainerStateChange": "<note> <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p> </note> <p>Sent to acknowledge that a container changed states.</p>",
@ -129,9 +129,9 @@
"base": null,
"refs": {
"ContainerDefinition$essential": "<p>If the <code>essential</code> parameter of a container is marked as <code>true</code>, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the <code>essential</code> parameter of a container is marked as <code>false</code>, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.</p> <p>All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html\">Application Architecture</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>",
"ContainerDefinition$disableNetworking": "<p>When this parameter is true, networking is disabled within the container. This parameter maps to <code>NetworkDisabled</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a>.</p>",
"ContainerDefinition$privileged": "<p>When this parameter is true, the container is given elevated privileges on the host container instance (similar to the <code>root</code> user). This parameter maps to <code>Privileged</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--privileged</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>",
"ContainerDefinition$readonlyRootFilesystem": "<p>When this parameter is true, the container is given read-only access to its root file system. This parameter maps to <code>ReadonlyRootfs</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--read-only</code> option to <code>docker run</code>.</p>",
"ContainerDefinition$disableNetworking": "<p>When this parameter is true, networking is disabled within the container. This parameter maps to <code>NetworkDisabled</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>",
"ContainerDefinition$privileged": "<p>When this parameter is true, the container is given elevated privileges on the host container instance (similar to the <code>root</code> user). This parameter maps to <code>Privileged</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--privileged</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>This parameter is not supported for Windows containers or tasks using the Fargate launch type.</p> </note>",
"ContainerDefinition$readonlyRootFilesystem": "<p>When this parameter is true, the container is given read-only access to its root file system. This parameter maps to <code>ReadonlyRootfs</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--read-only</code> option to <code>docker run</code>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>",
"DeregisterContainerInstanceRequest$force": "<p>Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the <code>force</code> option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible. </p> <p>Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group.</p>",
"LinuxParameters$initProcessEnabled": "<p>Run an <code>init</code> process inside the container that forwards signals and reaps processes. This parameter maps to the <code>--init</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: <code>sudo docker version | grep \"Server API version\"</code> </p>",
"MountPoint$readOnly": "<p>If this value is <code>true</code>, the container has read-only access to the volume. If this value is <code>false</code>, then the container can write to the volume. The default value is <code>false</code>.</p>",
@ -143,12 +143,13 @@
"refs": {
"Container$exitCode": "<p>The exit code returned from the container.</p>",
"ContainerDefinition$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.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--memory</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>If your containers will be part of a task using the Fargate launch type, this field is optional and the only requirement is that the total amount of memory reserved for all containers within a task be lower than the task <code>memory</code> value.</p> <p>For containers that will be part of a task using the EC2 launch type, you must specify a non-zero integer for one or both of <code>memory</code> or <code>memoryReservation</code> in container definitions. If you specify both, <code>memory</code> must be greater than <code>memoryReservation</code>. If you specify <code>memoryReservation</code>, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of <code>memory</code> is used.</p> <p>The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. </p>",
"ContainerDefinition$memoryReservation": "<p>The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit; however, your container can consume more memory when it needs to, up to either the hard limit specified with the <code>memory</code> parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to <code>MemoryReservation</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--memory-reservation</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>You must specify a non-zero integer for one or both of <code>memory</code> or <code>memoryReservation</code> in container definitions. If you specify both, <code>memory</code> must be greater than <code>memoryReservation</code>. If you specify <code>memoryReservation</code>, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of <code>memory</code> is used.</p> <p>For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a <code>memoryReservation</code> of 128 MiB, and a <code>memory</code> hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.</p>",
"ContainerDefinition$memoryReservation": "<p>The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit; however, your container can consume more memory when it needs to, up to either the hard limit specified with the <code>memory</code> parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to <code>MemoryReservation</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--memory-reservation</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>You must specify a non-zero integer for one or both of <code>memory</code> or <code>memoryReservation</code> in container definitions. If you specify both, <code>memory</code> must be greater than <code>memoryReservation</code>. If you specify <code>memoryReservation</code>, then that value is subtracted from the available memory resources for the container instance on which the container is placed; otherwise, the value of <code>memory</code> is used.</p> <p>For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a <code>memoryReservation</code> of 128 MiB, and a <code>memory</code> hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.</p> <p>The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. </p>",
"ContainerOverride$cpu": "<p>The number of <code>cpu</code> units reserved for the container, instead of the default value from the task definition. You must also specify a container name.</p>",
"ContainerOverride$memory": "<p>The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.</p>",
"ContainerOverride$memoryReservation": "<p>The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.</p>",
"ContainerStateChange$exitCode": "<p>The exit code for the container, if the state change is a result of the container exiting.</p>",
"CreateServiceRequest$desiredCount": "<p>The number of instantiations of the specified task definition to place and keep running on your cluster.</p>",
"CreateServiceRequest$healthCheckGracePeriodSeconds": "<p>The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to ELB health checks, you can specify a health check grace period of up to 1,800 seconds during which the ECS service scheduler will ignore ELB health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.</p>",
"DeploymentConfiguration$maximumPercent": "<p>The upper limit (as a percentage of the service's <code>desiredCount</code>) of the number of tasks that are allowed in the <code>RUNNING</code> or <code>PENDING</code> state in a service during a deployment. The maximum number of tasks during a deployment is the <code>desiredCount</code> multiplied by <code>maximumPercent</code>/100, rounded down to the nearest integer value.</p>",
"DeploymentConfiguration$minimumHealthyPercent": "<p>The lower limit (as a percentage of the service's <code>desiredCount</code>) of the number of running tasks that must remain in the <code>RUNNING</code> state in a service during a deployment. The minimum number of healthy tasks during a deployment is the <code>desiredCount</code> multiplied by <code>minimumHealthyPercent</code>/100, rounded up to the nearest integer value.</p>",
"ListAttributesRequest$maxResults": "<p>The maximum number of cluster results returned by <code>ListAttributes</code> in paginated output. When this parameter is used, <code>ListAttributes</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>ListAttributes</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>ListAttributes</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>",
@ -161,11 +162,13 @@
"LoadBalancer$containerPort": "<p>The port on the container to associate with the load balancer. This port must correspond to a <code>containerPort</code> in the service's task definition. Your container instances must allow ingress traffic on the <code>hostPort</code> of the port mapping.</p>",
"NetworkBinding$containerPort": "<p>The port number on the container that is used with the network binding.</p>",
"NetworkBinding$hostPort": "<p>The port number on the host that is used with the network binding.</p>",
"PortMapping$containerPort": "<p>The port number on the container that is bound to the user-specified or automatically assigned host port.</p> <p>If using containers in a task with the Fargate launch type, exposed ports should be specified using <code>containerPort</code>.</p> <p>If using containers in a task with the EC2 launch type and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range (for more information, see <code>hostPort</code>). Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.</p>",
"PortMapping$hostPort": "<p>The port number on the container instance to reserve for your container.</p> <p>If using containers in a task with the Fargate launch type, the <code>hostPort</code> can either be left blank or needs to be the same value as the <code>containerPort</code>.</p> <p>If using containers in a task with the EC2 launch type, you can specify a non-reserved host port for your container port mapping, or you can omit the <code>hostPort</code> (or set it to <code>0</code>) while specifying a <code>containerPort</code> and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.</p> <p>The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under <code>/proc/sys/net/ipv4/ip_local_port_range</code>; if this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. You should not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.</p> <note> <p>The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.</p> </note> <p>The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678 and 51679. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released). The current reserved ports are displayed in the <code>remainingResources</code> of <a>DescribeContainerInstances</a> output, and a container instance may have up to 100 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward the 100 reserved ports limit).</p>",
"PortMapping$containerPort": "<p>The port number on the container that is bound to the user-specified or automatically assigned host port.</p> <p>If using containers in a task with the <code>awsvpc</code> or <code>host</code> network mode, exposed ports should be specified using <code>containerPort</code>.</p> <p>If using containers in a task with the <code>bridge</code> network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range (for more information, see <code>hostPort</code>). Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.</p>",
"PortMapping$hostPort": "<p>The port number on the container instance to reserve for your container.</p> <p>If using containers in a task with the <code>awsvpc</code> or <code>host</code> network mode, the <code>hostPort</code> can either be left blank or needs to be the same value as the <code>containerPort</code>.</p> <p>If using containers in a task with the <code>bridge</code> network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the <code>hostPort</code> (or set it to <code>0</code>) while specifying a <code>containerPort</code> and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.</p> <p>The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under <code>/proc/sys/net/ipv4/ip_local_port_range</code>; if this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. You should not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.</p> <note> <p>The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.</p> </note> <p>The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678 and 51679. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released). The current reserved ports are displayed in the <code>remainingResources</code> of <a>DescribeContainerInstances</a> output, and a container instance may have up to 100 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward the 100 reserved ports limit).</p>",
"RunTaskRequest$count": "<p>The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.</p>",
"Service$healthCheckGracePeriodSeconds": "<p>The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.</p>",
"SubmitContainerStateChangeRequest$exitCode": "<p>The exit code returned for the state change request.</p>",
"UpdateServiceRequest$desiredCount": "<p>The number of instantiations of the task to place and keep running in your service.</p>"
"UpdateServiceRequest$desiredCount": "<p>The number of instantiations of the task to place and keep running in your service.</p>",
"UpdateServiceRequest$healthCheckGracePeriodSeconds": "<p>The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to ELB health checks, you can specify a health check grace period of up to 1,800 seconds during which the ECS service scheduler will ignore ELB health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.</p>"
}
},
"ClientException": {
@ -205,7 +208,7 @@
"ClusterFieldList": {
"base": null,
"refs": {
"DescribeClustersRequest$include": "<p>Additional information about your clusters to be separated by launch type, including:</p> <ul> <li> <p>runningEC2TasksCount</p> </li> <li> <p>RunningFargateTasksCount</p> </li> <li> <p>pendingEC2TasksCount</p> </li> <li> <p>pendingFargateTasksCount</p> </li> <li> <p>activeEC2ServiceCount</p> </li> <li> <p>activeFargateServiceCount</p> </li> <li> <p>drainingEC2ServiceCount</p> </li> <li> <p>drainingFargateServiceCount</p> </li> </ul>"
"DescribeClustersRequest$include": "<p>Additional information about your clusters to be separated by launch type, including:</p> <ul> <li> <p>runningEC2TasksCount</p> </li> <li> <p>runningFargateTasksCount</p> </li> <li> <p>pendingEC2TasksCount</p> </li> <li> <p>pendingFargateTasksCount</p> </li> <li> <p>activeEC2ServiceCount</p> </li> <li> <p>activeFargateServiceCount</p> </li> <li> <p>drainingEC2ServiceCount</p> </li> <li> <p>drainingFargateServiceCount</p> </li> </ul>"
}
},
"ClusterNotFoundException": {
@ -537,13 +540,13 @@
"HostEntryList": {
"base": null,
"refs": {
"ContainerDefinition$extraHosts": "<p>A list of hostnames and IP address mappings to append to the <code>/etc/hosts</code> file on the container. If using the Fargate launch type, this may be used to list non-Fargate hosts you want the container to talk to. This parameter maps to <code>ExtraHosts</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--add-host</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
"ContainerDefinition$extraHosts": "<p>A list of hostnames and IP address mappings to append to the <code>/etc/hosts</code> file on the container. If using the Fargate launch type, this may be used to list non-Fargate hosts you want the container to talk to. This parameter maps to <code>ExtraHosts</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--add-host</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>"
}
},
"HostVolumeProperties": {
"base": "<p>Details on a container instance host volume.</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> <p>If you are using the Fargate launch type, the <code>host</code> parameter is not supported.</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, but the data is not guaranteed to persist after the containers associated with it stop running.</p> <p>Windows containers can mount whole directories on the same drive as <code>$env:ProgramData</code>. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. For example, you can mount <code>C:\\my\\path:C:\\my\\path</code> and <code>D:\\:D:\\</code>, but not <code>D:\\my\\path:C:\\my\\path</code> or <code>D:\\:C:\\my\\path</code>.</p>"
}
},
"Integer": {
@ -553,7 +556,7 @@
"Cluster$runningTasksCount": "<p>The number of tasks in the cluster that are in the <code>RUNNING</code> state.</p>",
"Cluster$pendingTasksCount": "<p>The number of tasks in the cluster that are in the <code>PENDING</code> state.</p>",
"Cluster$activeServicesCount": "<p>The number of services that are running on the cluster in an <code>ACTIVE</code> state. You can view these services with <a>ListServices</a>.</p>",
"ContainerDefinition$cpu": "<p>The number of <code>cpu</code> units reserved for the container. If your containers will be part of a task using the Fargate launch type, this field is optional and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task <code>cpu</code> value.</p> <p>For containers that will be part of a task using the EC2 launch type, a container instance has 1,024 <code>cpu</code> units for every CPU core. This parameter specifies the minimum amount of CPU to reserve for a container, and containers share unallocated CPU units with other containers on the instance with the same ratio as their allocated amount. This parameter maps to <code>CpuShares</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the <a href=\"http://aws.amazon.com/ec2/instance-types/\">Amazon EC2 Instances</a> detail page by 1,024.</p> </note> <p>For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.</p> <p>The Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see <a href=\"https://docs.docker.com/engine/reference/run/#cpu-share-constraint\">CPU share constraint</a> in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:</p> <ul> <li> <p> <b>Agent versions less than or equal to 1.1.0:</b> Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 2 CPU shares.</p> </li> <li> <p> <b>Agent versions greater than or equal to 1.2.0:</b> Null, zero, and CPU values of 1 are passed to Docker as 2.</p> </li> </ul>",
"ContainerDefinition$cpu": "<p>The number of <code>cpu</code> units 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.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level <code>cpu</code> value.</p> <note> <p>You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the <a href=\"http://aws.amazon.com/ec2/instance-types/\">Amazon EC2 Instances</a> detail page by 1,024.</p> </note> <p>For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.</p> <p>Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.</p> <p>On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see <a href=\"https://docs.docker.com/engine/reference/run/#cpu-share-constraint\">CPU share constraint</a> in the Docker documentation. The minimum valid CPU share value that the Linux kernel will allow is 2; however, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:</p> <ul> <li> <p> <b>Agent versions less than or equal to 1.1.0:</b> Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to 2 CPU shares.</p> </li> <li> <p> <b>Agent versions greater than or equal to 1.2.0:</b> Null, zero, and CPU values of 1 are passed to Docker as 2.</p> </li> </ul> <p>On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition.</p>",
"ContainerInstance$runningTasksCount": "<p>The number of tasks on the container instance that are in the <code>RUNNING</code> status.</p>",
"ContainerInstance$pendingTasksCount": "<p>The number of tasks on the container instance that are in the <code>PENDING</code> status.</p>",
"Deployment$desiredCount": "<p>The most recent desired count of tasks that was specified for the service to deploy or maintain.</p>",
@ -602,7 +605,7 @@
"LinuxParameters": {
"base": "<p>Linux-specific options that are applied to the container, such as Linux <a>KernelCapabilities</a>.</p>",
"refs": {
"ContainerDefinition$linuxParameters": "<p>Linux-specific modifications that are applied to the container, such as Linux <a>KernelCapabilities</a>. This field is not valid for containers in tasks using the Fargate launch type.</p>"
"ContainerDefinition$linuxParameters": "<p>Linux-specific modifications that are applied to the container, such as Linux <a>KernelCapabilities</a>.</p> <note> <p>This parameter is not supported for Windows containers or tasks using the Fargate launch type.</p> </note>"
}
},
"ListAttributesRequest": {
@ -728,7 +731,7 @@
"MountPointList": {
"base": null,
"refs": {
"ContainerDefinition$mountPoints": "<p>The mount points for data volumes in your container.</p> <p>If using the Fargate launch type, the <code>sourceVolume</code> parameter is not supported.</p> <p>This parameter maps to <code>Volumes</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--volume</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
"ContainerDefinition$mountPoints": "<p>The mount points for data volumes in your container.</p> <p>This parameter maps to <code>Volumes</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--volume</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>Windows containers can mount whole directories on the same drive as <code>$env:ProgramData</code>. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.</p>"
}
},
"NetworkBinding": {
@ -771,8 +774,8 @@
"NetworkMode": {
"base": null,
"refs": {
"RegisterTaskDefinitionRequest$networkMode": "<p>The Docker networking mode to use for the containers in the task. The valid values are <code>none</code>, <code>bridge</code>, <code>awsvpc</code>, and <code>host</code>. The default Docker network mode is <code>bridge</code>. If using the Fargate launch type, the <code>awsvpc</code> network mode is required. If using the EC2 launch type, any network mode can be used. If the network mode is set to <code>none</code>, you can't specify port mappings in your container definitions, and the task's containers do not have external connectivity. The <code>host</code> and <code>awsvpc</code> network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the <code>bridge</code> mode.</p> <p>With the <code>host</code> and <code>awsvpc</code> network modes, exposed container ports are mapped directly to the corresponding host port (for the <code>host</code> network mode) or the attached elastic network interface port (for the <code>awsvpc</code> network mode), so you cannot take advantage of dynamic host port mappings. </p> <p>If the network mode is <code>awsvpc</code>, the task is allocated an Elastic Network Interface, and you must specify a <a>NetworkConfiguration</a> when you create a service or run a task with the task definition. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html\">Task Networking</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>If the network mode is <code>host</code>, you can't run multiple instantiations of the same task on a single container instance when port mappings are used.</p> <p>For more information, see <a href=\"https://docs.docker.com/engine/reference/run/#network-settings\">Network settings</a> in the <i>Docker run reference</i>.</p>",
"TaskDefinition$networkMode": "<p>The Docker networking mode to use for the containers in the task. The valid values are <code>none</code>, <code>bridge</code>, <code>awsvpc</code>, and <code>host</code>. The default Docker network mode is <code>bridge</code>. If using the Fargate launch type, the <code>awsvpc</code> network mode is required. If using the EC2 launch type, any network mode can be used. If the network mode is set to <code>none</code>, you can't specify port mappings in your container definitions, and the task's containers do not have external connectivity. The <code>host</code> and <code>awsvpc</code> network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the <code>bridge</code> mode.</p> <p>With the <code>host</code> and <code>awsvpc</code> network modes, exposed container ports are mapped directly to the corresponding host port (for the <code>host</code> network mode) or the attached elastic network interface port (for the <code>awsvpc</code> network mode), so you cannot take advantage of dynamic host port mappings. </p> <p>If the network mode is <code>awsvpc</code>, the task is allocated an Elastic Network Interface, and you must specify a <a>NetworkConfiguration</a> when you create a service or run a task with the task definition. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguidetask-networking.html\">Task Networking</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>If the network mode is <code>host</code>, you can't run multiple instantiations of the same task on a single container instance when port mappings are used.</p> <p>For more information, see <a href=\"https://docs.docker.com/engine/reference/run/#network-settings\">Network settings</a> in the <i>Docker run reference</i>.</p>"
"RegisterTaskDefinitionRequest$networkMode": "<p>The Docker networking mode to use for the containers in the task. The valid values are <code>none</code>, <code>bridge</code>, <code>awsvpc</code>, and <code>host</code>. The default Docker network mode is <code>bridge</code>. If using the Fargate launch type, the <code>awsvpc</code> network mode is required. If using the EC2 launch type, any network mode can be used. If the network mode is set to <code>none</code>, you can't specify port mappings in your container definitions, and the task's containers do not have external connectivity. The <code>host</code> and <code>awsvpc</code> network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the <code>bridge</code> mode.</p> <p>With the <code>host</code> and <code>awsvpc</code> network modes, exposed container ports are mapped directly to the corresponding host port (for the <code>host</code> network mode) or the attached elastic network interface port (for the <code>awsvpc</code> network mode), so you cannot take advantage of dynamic host port mappings. </p> <p>If the network mode is <code>awsvpc</code>, the task is allocated an Elastic Network Interface, and you must specify a <a>NetworkConfiguration</a> when you create a service or run a task with the task definition. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html\">Task Networking</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>If the network mode is <code>host</code>, you can't run multiple instantiations of the same task on a single container instance when port mappings are used.</p> <p>Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode.</p> <p>For more information, see <a href=\"https://docs.docker.com/engine/reference/run/#network-settings\">Network settings</a> in the <i>Docker run reference</i>.</p>",
"TaskDefinition$networkMode": "<p>The Docker networking mode to use for the containers in the task. The valid values are <code>none</code>, <code>bridge</code>, <code>awsvpc</code>, and <code>host</code>. The default Docker network mode is <code>bridge</code>. If using the Fargate launch type, the <code>awsvpc</code> network mode is required. If using the EC2 launch type, any network mode can be used. If the network mode is set to <code>none</code>, you can't specify port mappings in your container definitions, and the task's containers do not have external connectivity. The <code>host</code> and <code>awsvpc</code> network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the <code>bridge</code> mode.</p> <p>With the <code>host</code> and <code>awsvpc</code> network modes, exposed container ports are mapped directly to the corresponding host port (for the <code>host</code> network mode) or the attached elastic network interface port (for the <code>awsvpc</code> network mode), so you cannot take advantage of dynamic host port mappings. </p> <p>If the network mode is <code>awsvpc</code>, the task is allocated an Elastic Network Interface, and you must specify a <a>NetworkConfiguration</a> when you create a service or run a task with the task definition. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html\">Task Networking</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <note> <p>Currently, only the Amazon ECS-optimized AMI, other Amazon Linux variants with the <code>ecs-init</code> package, or AWS Fargate infrastructure support the <code>awsvpc</code> network mode. </p> </note> <p>If the network mode is <code>host</code>, you can't run multiple instantiations of the same task on a single container instance when port mappings are used.</p> <p>Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <code>&lt;default&gt;</code> network mode object. </p> <p>For more information, see <a href=\"https://docs.docker.com/engine/reference/run/#network-settings\">Network settings</a> in the <i>Docker run reference</i>.</p>"
}
},
"NoUpdateAvailableException": {
@ -831,7 +834,7 @@
}
},
"PortMapping": {
"base": "<p>Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.</p> <p>If using containers in a task with the Fargate launch type, exposed ports should be specified using <code>containerPort</code>. The <code>hostPort</code> can be left blank or it must be the same value as the <code>containerPort</code>.</p> <p>After a task reaches the <code>RUNNING</code> status, manual and automatic host and container port assignments are visible in the <code>networkBindings</code> section of <a>DescribeTasks</a> API responses.</p>",
"base": "<p>Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.</p> <p>If using containers in a task with the <code>awsvpc</code> or <code>host</code> network mode, exposed ports should be specified using <code>containerPort</code>. The <code>hostPort</code> can be left blank or it must be the same value as the <code>containerPort</code>.</p> <p>After a task reaches the <code>RUNNING</code> status, manual and automatic host and container port assignments are visible in the <code>networkBindings</code> section of <a>DescribeTasks</a> API responses.</p>",
"refs": {
"PortMappingList$member": null
}
@ -839,7 +842,7 @@
"PortMappingList": {
"base": null,
"refs": {
"ContainerDefinition$portMappings": "<p>The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.</p> <p>If using containers in a task with the Fargate, exposed ports should be specified using <code>containerPort</code>. The <code>hostPort</code> can be left blank or it must be the same value as the <code>containerPort</code>.</p> <p>This parameter maps to <code>PortBindings</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--publish</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. If the network mode of a task definition is set to <code>none</code>, then you can't specify port mappings. If the network mode of a task definition is set to <code>host</code>, then host ports must either be undefined or they must match the container port in the port mapping.</p> <note> <p>After a task reaches the <code>RUNNING</code> status, manual and automatic host and container port assignments are visible in the <b>Network Bindings</b> section of a container description for a selected task in the Amazon ECS console, or the <code>networkBindings</code> section <a>DescribeTasks</a> responses.</p> </note>"
"ContainerDefinition$portMappings": "<p>The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.</p> <p>For task definitions that use the <code>awsvpc</code> network mode, you should only specify the <code>containerPort</code>. The <code>hostPort</code> can be left blank or it must be the same value as the <code>containerPort</code>.</p> <p>Port mappings on Windows use the <code>NetNAT</code> gateway address rather than <code>localhost</code>. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. </p> <p>This parameter maps to <code>PortBindings</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--publish</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. If the network mode of a task definition is set to <code>none</code>, then you can't specify port mappings. If the network mode of a task definition is set to <code>host</code>, then host ports must either be undefined or they must match the container port in the port mapping.</p> <note> <p>After a task reaches the <code>RUNNING</code> status, manual and automatic host and container port assignments are visible in the <b>Network Bindings</b> section of a container description for a selected task in the Amazon ECS console, or the <code>networkBindings</code> section <a>DescribeTasks</a> responses.</p> </note>"
}
},
"PutAttributesRequest": {
@ -999,7 +1002,7 @@
"ContainerDefinition$name": "<p>The name of a container. If you are linking multiple containers together in a task definition, the <code>name</code> of one container can be entered in the <code>links</code> of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This parameter maps to <code>name</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--name</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. </p>",
"ContainerDefinition$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 either <code> <i>repository-url</i>/<i>image</i>:<i>tag</i> </code> or <code> <i>repository-url</i>/<i>image</i>@<i>digest</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.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">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 can be specified by either using the full <code>registry/repository:tag</code> or <code>registry/repository@digest</code>. For example, <code>012345678910.dkr.ecr.&lt;region-name&gt;.amazonaws.com/&lt;repository-name&gt;:latest</code> or <code>012345678910.dkr.ecr.&lt;region-name&gt;.amazonaws.com/&lt;repository-name&gt;@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE</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>",
"ContainerDefinition$hostname": "<p>The hostname to use for your container. This parameter maps to <code>Hostname</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--hostname</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>",
"ContainerDefinition$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.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--user</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>",
"ContainerDefinition$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.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--user</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>",
"ContainerDefinition$workingDirectory": "<p>The working directory in which to run commands inside the container. This parameter maps to <code>WorkingDir</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--workdir</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>",
"ContainerInstance$containerInstanceArn": "<p>The Amazon Resource Name (ARN) of the container instance. The ARN contains the <code>arn:aws:ecs</code> namespace, followed by the region of the container instance, the AWS account ID of the container instance owner, the <code>container-instance</code> namespace, and then the container instance ID. For example, <code>arn:aws:ecs:<i>region</i>:<i>aws_account_id</i>:container-instance/<i>container_instance_ID</i> </code>.</p>",
"ContainerInstance$ec2InstanceId": "<p>The EC2 instance ID of the container instance.</p>",
@ -1042,7 +1045,7 @@
"Failure$reason": "<p>The reason for the failure.</p>",
"HostEntry$hostname": "<p>The hostname to use in the <code>/etc/hosts</code> entry.</p>",
"HostEntry$ipAddress": "<p>The IP address to use in the <code>/etc/hosts</code> entry.</p>",
"HostVolumeProperties$sourcePath": "<p>The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the <code>host</code> parameter contains a <code>sourcePath</code> file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the <code>sourcePath</code> value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.</p> <p>If you are using the Fargate launch type, the <code>host</code> parameter is not supported.</p>",
"HostVolumeProperties$sourcePath": "<p>The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the <code>host</code> parameter contains a <code>sourcePath</code> file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the <code>sourcePath</code> value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.</p> <p>If you are using the Fargate launch type, the <code>sourcePath</code> parameter is not supported.</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>",
"ListAttributesRequest$cluster": "<p>The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.</p>",
@ -1077,7 +1080,7 @@
"LoadBalancer$containerName": "<p>The name of the container (as it appears in a container definition) to associate with the load balancer.</p>",
"LogConfigurationOptionsMap$key": null,
"LogConfigurationOptionsMap$value": null,
"MountPoint$sourceVolume": "<p>The name of the volume to mount. If using the Fargate launch type, the <code>sourceVolume</code> parameter is not supported.</p>",
"MountPoint$sourceVolume": "<p>The name of the volume to mount.</p>",
"MountPoint$containerPath": "<p>The path on the container to mount the host volume at.</p>",
"NetworkBinding$bindIP": "<p>The IP address that the container is bound to on the container instance.</p>",
"NetworkInterface$attachmentId": "<p>The attachment ID for the network interface.</p>",
@ -1093,8 +1096,8 @@
"RegisterTaskDefinitionRequest$family": "<p>You must specify a <code>family</code> for a task definition, which allows you to track multiple versions of the same task definition. The <code>family</code> is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.</p>",
"RegisterTaskDefinitionRequest$taskRoleArn": "<p>The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html\">IAM Roles for Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>",
"RegisterTaskDefinitionRequest$executionRoleArn": "<p>The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.</p>",
"RegisterTaskDefinitionRequest$cpu": "<p>The number of <code>cpu</code> units used by the task. If using the EC2 launch type, this field is optional and any value can be used. If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the <code>memory</code> parameter:</p> <ul> <li> <p>256 (.25 vCPU) - Available <code>memory</code> values: 512MB, 1GB, 2GB</p> </li> <li> <p>512 (.5 vCPU) - Available <code>memory</code> values: 1GB, 2GB, 3GB, 4GB</p> </li> <li> <p>1024 (1 vCPU) - Available <code>memory</code> values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB</p> </li> <li> <p>2048 (2 vCPU) - Available <code>memory</code> values: Between 4GB and 16GB in 1GB increments</p> </li> <li> <p>4096 (4 vCPU) - Available <code>memory</code> values: Between 8GB and 30GB in 1GB increments</p> </li> </ul>",
"RegisterTaskDefinitionRequest$memory": "<p>The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the <code>cpu</code> parameter:</p> <ul> <li> <p>512MB, 1GB, 2GB - Available <code>cpu</code> values: 256 (.25 vCPU)</p> </li> <li> <p>1GB, 2GB, 3GB, 4GB - Available <code>cpu</code> values: 512 (.5 vCPU)</p> </li> <li> <p>2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB - Available <code>cpu</code> values: 1024 (1 vCPU)</p> </li> <li> <p>Between 4GB and 16GB in 1GB increments - Available <code>cpu</code> values: 2048 (2 vCPU)</p> </li> <li> <p>Between 8GB and 30GB in 1GB increments - Available <code>cpu</code> values: 4096 (4 vCPU)</p> </li> </ul>",
"RegisterTaskDefinitionRequest$cpu": "<p>The number of <code>cpu</code> units used by the task. If using the EC2 launch type, this field is optional and any value can be used.</p> <note> <p>Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.</p> </note> <p>If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the <code>memory</code> parameter:</p> <ul> <li> <p>256 (.25 vCPU) - Available <code>memory</code> values: 0.5GB, 1GB, 2GB</p> </li> <li> <p>512 (.5 vCPU) - Available <code>memory</code> values: 1GB, 2GB, 3GB, 4GB</p> </li> <li> <p>1024 (1 vCPU) - Available <code>memory</code> values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB</p> </li> <li> <p>2048 (2 vCPU) - Available <code>memory</code> values: Between 4GB and 16GB in 1GB increments</p> </li> <li> <p>4096 (4 vCPU) - Available <code>memory</code> values: Between 8GB and 30GB in 1GB increments</p> </li> </ul>",
"RegisterTaskDefinitionRequest$memory": "<p>The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used.</p> <note> <p>Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.</p> </note> <p>If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the <code>cpu</code> parameter:</p> <ul> <li> <p>0.5GB, 1GB, 2GB - Available <code>cpu</code> values: 256 (.25 vCPU)</p> </li> <li> <p>1GB, 2GB, 3GB, 4GB - Available <code>cpu</code> values: 512 (.5 vCPU)</p> </li> <li> <p>2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB - Available <code>cpu</code> values: 1024 (1 vCPU)</p> </li> <li> <p>Between 4GB and 16GB in 1GB increments - Available <code>cpu</code> values: 2048 (2 vCPU)</p> </li> <li> <p>Between 8GB and 30GB in 1GB increments - Available <code>cpu</code> values: 4096 (4 vCPU)</p> </li> </ul>",
"Resource$name": "<p>The name of the resource, such as <code>cpu</code>, <code>memory</code>, <code>ports</code>, or a user-defined resource.</p>",
"Resource$type": "<p>The type of the resource, such as <code>INTEGER</code>, <code>DOUBLE</code>, <code>LONG</code>, or <code>STRINGSET</code>.</p>",
"RunTaskRequest$cluster": "<p>The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed.</p>",
@ -1137,18 +1140,18 @@
"Task$containerInstanceArn": "<p>The ARN of the container instances that host the task.</p>",
"Task$lastStatus": "<p>The last known status of the task.</p>",
"Task$desiredStatus": "<p>The desired status of the task.</p>",
"Task$cpu": "<p>The number of <code>cpu</code> units used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the <code>memory</code> parameter:</p> <ul> <li> <p>256 (.25 vCPU) - Available <code>memory</code> values: 512MB, 1GB, 2GB</p> </li> <li> <p>512 (.5 vCPU) - Available <code>memory</code> values: 1GB, 2GB, 3GB, 4GB</p> </li> <li> <p>1024 (1 vCPU) - Available <code>memory</code> values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB</p> </li> <li> <p>2048 (2 vCPU) - Available <code>memory</code> values: Between 4GB and 16GB in 1GB increments</p> </li> <li> <p>4096 (4 vCPU) - Available <code>memory</code> values: Between 8GB and 30GB in 1GB increments</p> </li> </ul>",
"Task$memory": "<p>The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the <code>cpu</code> parameter:</p> <ul> <li> <p>512MB, 1GB, 2GB - Available <code>cpu</code> values: 256 (.25 vCPU)</p> </li> <li> <p>1GB, 2GB, 3GB, 4GB - Available <code>cpu</code> values: 512 (.5 vCPU)</p> </li> <li> <p>2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB - Available <code>cpu</code> values: 1024 (1 vCPU)</p> </li> <li> <p>Between 4GB and 16GB in 1GB increments - Available <code>cpu</code> values: 2048 (2 vCPU)</p> </li> <li> <p>Between 8GB and 30GB in 1GB increments - Available <code>cpu</code> values: 4096 (4 vCPU)</p> </li> </ul>",
"Task$cpu": "<p>The number of <code>cpu</code> units used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the <code>memory</code> parameter:</p> <ul> <li> <p>256 (.25 vCPU) - Available <code>memory</code> values: 0.5GB, 1GB, 2GB</p> </li> <li> <p>512 (.5 vCPU) - Available <code>memory</code> values: 1GB, 2GB, 3GB, 4GB</p> </li> <li> <p>1024 (1 vCPU) - Available <code>memory</code> values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB</p> </li> <li> <p>2048 (2 vCPU) - Available <code>memory</code> values: Between 4GB and 16GB in 1GB increments</p> </li> <li> <p>4096 (4 vCPU) - Available <code>memory</code> values: Between 8GB and 30GB in 1GB increments</p> </li> </ul>",
"Task$memory": "<p>The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the <code>cpu</code> parameter:</p> <ul> <li> <p>0.5GB, 1GB, 2GB - Available <code>cpu</code> values: 256 (.25 vCPU)</p> </li> <li> <p>1GB, 2GB, 3GB, 4GB - Available <code>cpu</code> values: 512 (.5 vCPU)</p> </li> <li> <p>2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB - Available <code>cpu</code> values: 1024 (1 vCPU)</p> </li> <li> <p>Between 4GB and 16GB in 1GB increments - Available <code>cpu</code> values: 2048 (2 vCPU)</p> </li> <li> <p>Between 8GB and 30GB in 1GB increments - Available <code>cpu</code> values: 4096 (4 vCPU)</p> </li> </ul>",
"Task$startedBy": "<p>The tag specified when a task is started. If the task is started by an Amazon ECS service, then the <code>startedBy</code> parameter contains the deployment ID of the service that starts it.</p>",
"Task$stoppedReason": "<p>The reason the task was stopped.</p>",
"Task$group": "<p>The name of the task group associated with the task.</p>",
"Task$platformVersion": "<p>The platform version on which your task is running. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">AWS Fargate Platform Versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>",
"TaskDefinition$taskDefinitionArn": "<p>The full Amazon Resource Name (ARN) of the task definition.</p>",
"TaskDefinition$family": "<p>The family of your task definition, used as the definition name.</p>",
"TaskDefinition$taskRoleArn": "<p>The ARN of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.</p>",
"TaskDefinition$taskRoleArn": "<p>The ARN of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.</p> <p>IAM roles for tasks on Windows require that the <code>-EnableTaskIAMRole</code> option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take advantage of the feature. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html\">Windows IAM Roles for Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>",
"TaskDefinition$executionRoleArn": "<p>The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.</p>",
"TaskDefinition$cpu": "<p>The number of <code>cpu</code> units used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the <code>memory</code> parameter:</p> <ul> <li> <p>256 (.25 vCPU) - Available <code>memory</code> values: 512MB, 1GB, 2GB</p> </li> <li> <p>512 (.5 vCPU) - Available <code>memory</code> values: 1GB, 2GB, 3GB, 4GB</p> </li> <li> <p>1024 (1 vCPU) - Available <code>memory</code> values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB</p> </li> <li> <p>2048 (2 vCPU) - Available <code>memory</code> values: Between 4GB and 16GB in 1GB increments</p> </li> <li> <p>4096 (4 vCPU) - Available <code>memory</code> values: Between 8GB and 30GB in 1GB increments</p> </li> </ul>",
"TaskDefinition$memory": "<p>The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the <code>cpu</code> parameter:</p> <ul> <li> <p>512MB, 1GB, 2GB - Available <code>cpu</code> values: 256 (.25 vCPU)</p> </li> <li> <p>1GB, 2GB, 3GB, 4GB - Available <code>cpu</code> values: 512 (.5 vCPU)</p> </li> <li> <p>2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB - Available <code>cpu</code> values: 1024 (1 vCPU)</p> </li> <li> <p>Between 4GB and 16GB in 1GB increments - Available <code>cpu</code> values: 2048 (2 vCPU)</p> </li> <li> <p>Between 8GB and 30GB in 1GB increments - Available <code>cpu</code> values: 4096 (4 vCPU)</p> </li> </ul>",
"TaskDefinition$cpu": "<p>The number of <code>cpu</code> units used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the <code>memory</code> parameter:</p> <ul> <li> <p>256 (.25 vCPU) - Available <code>memory</code> values: 0.5GB, 1GB, 2GB</p> </li> <li> <p>512 (.5 vCPU) - Available <code>memory</code> values: 1GB, 2GB, 3GB, 4GB</p> </li> <li> <p>1024 (1 vCPU) - Available <code>memory</code> values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB</p> </li> <li> <p>2048 (2 vCPU) - Available <code>memory</code> values: Between 4GB and 16GB in 1GB increments</p> </li> <li> <p>4096 (4 vCPU) - Available <code>memory</code> values: Between 8GB and 30GB in 1GB increments</p> </li> </ul>",
"TaskDefinition$memory": "<p>The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the <code>cpu</code> parameter:</p> <ul> <li> <p>0.5GB, 1GB, 2GB - Available <code>cpu</code> values: 256 (.25 vCPU)</p> </li> <li> <p>1GB, 2GB, 3GB, 4GB - Available <code>cpu</code> values: 512 (.5 vCPU)</p> </li> <li> <p>2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB - Available <code>cpu</code> values: 1024 (1 vCPU)</p> </li> <li> <p>Between 4GB and 16GB in 1GB increments - Available <code>cpu</code> values: 2048 (2 vCPU)</p> </li> <li> <p>Between 8GB and 30GB in 1GB increments - Available <code>cpu</code> values: 4096 (4 vCPU)</p> </li> </ul>",
"TaskDefinitionPlacementConstraint$expression": "<p>A cluster query language expression to apply to the constraint. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html\">Cluster Query Language</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>",
"TaskOverride$taskRoleArn": "<p>The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.</p>",
"TaskOverride$executionRoleArn": "<p>The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.</p>",
@ -1171,12 +1174,12 @@
"refs": {
"AwsVpcConfiguration$subnets": "<p>The subnets associated with the task or service.</p>",
"AwsVpcConfiguration$securityGroups": "<p>The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used.</p>",
"ContainerDefinition$links": "<p>The <code>link</code> parameter allows containers to communicate with each other without the need for port mappings, using the <code>name</code> parameter and optionally, an <code>alias</code> for the link. This construct is analogous to <code>name:alias</code> in Docker links. This field is not valid for containers in tasks using the Fargate launch type. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed for each <code>name</code> and <code>alias</code>. For more information on linking Docker containers, see <a href=\"https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/\">https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/</a>. This parameter maps to <code>Links</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--link</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <important> <p>Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.</p> </important>",
"ContainerDefinition$links": "<p>The <code>link</code> parameter allows containers to communicate with each other without the need for port mappings. Only supported if the network mode of a task definition is set to <code>bridge</code>. The <code>name:internalName</code> construct is analogous to <code>name:alias</code> in Docker links. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. For more information about linking Docker containers, go to <a href=\"https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/\">https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/</a>. This parameter maps to <code>Links</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--link</code> option to <a href=\"https://docs.docker.com/engine/reference/commandline/run/\"> <code>docker run</code> </a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note> <important> <p>Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.</p> </important>",
"ContainerDefinition$entryPoint": "<important> <p>Early versions of the Amazon ECS container agent do not properly handle <code>entryPoint</code> parameters. If you have problems using <code>entryPoint</code>, update your container agent or enter your commands and arguments as <code>command</code> array items instead.</p> </important> <p>The entry point that is passed to the container. This parameter maps to <code>Entrypoint</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--entrypoint</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. For more information, see <a href=\"https://docs.docker.com/engine/reference/builder/#entrypoint\">https://docs.docker.com/engine/reference/builder/#entrypoint</a>.</p>",
"ContainerDefinition$command": "<p>The command that is passed to the container. This parameter maps to <code>Cmd</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>COMMAND</code> parameter to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. For more information, see <a href=\"https://docs.docker.com/engine/reference/builder/#cmd\">https://docs.docker.com/engine/reference/builder/#cmd</a>.</p>",
"ContainerDefinition$dnsServers": "<p>A list of DNS servers that are presented to the container. This parameter maps to <code>Dns</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--dns</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>",
"ContainerDefinition$dnsSearchDomains": "<p>A list of DNS search domains that are presented to the container. This parameter maps to <code>DnsSearch</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--dns-search</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>",
"ContainerDefinition$dockerSecurityOptions": "<p>A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.</p> <p>This parameter maps to <code>SecurityOpt</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--security-opt</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>The Amazon ECS container agent running on a container instance must register with the <code>ECS_SELINUX_CAPABLE=true</code> or <code>ECS_APPARMOR_CAPABLE=true</code> environment variables before containers placed on that instance can use these security options. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html\">Amazon ECS Container Agent Configuration</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </note>",
"ContainerDefinition$dnsServers": "<p>A list of DNS servers that are presented to the container. This parameter maps to <code>Dns</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--dns</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>",
"ContainerDefinition$dnsSearchDomains": "<p>A list of DNS search domains that are presented to the container. This parameter maps to <code>DnsSearch</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--dns-search</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>This parameter is not supported for Windows containers.</p> </note>",
"ContainerDefinition$dockerSecurityOptions": "<p>A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.</p> <p>This parameter maps to <code>SecurityOpt</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--security-opt</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>The Amazon ECS container agent running on a container instance must register with the <code>ECS_SELINUX_CAPABLE=true</code> or <code>ECS_APPARMOR_CAPABLE=true</code> environment variables before containers placed on that instance can use these security options. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html\">Amazon ECS Container Agent Configuration</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>This parameter is not supported for Windows containers.</p> </note>",
"ContainerOverride$command": "<p>The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.</p>",
"DescribeClustersRequest$clusters": "<p>A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.</p>",
"DescribeContainerInstancesRequest$containerInstances": "<p>A list of container instance IDs or full ARN entries.</p>",
@ -1327,7 +1330,7 @@
"UlimitList": {
"base": null,
"refs": {
"ContainerDefinition$ulimits": "<p>A list of <code>ulimits</code> to set in the container. This parameter maps to <code>Ulimits</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--ulimit</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. Valid naming values are displayed in the <a>Ulimit</a> data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: <code>sudo docker version | grep \"Server API version\"</code> </p>"
"ContainerDefinition$ulimits": "<p>A list of <code>ulimits</code> to set in the container. This parameter maps to <code>Ulimits</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/\">Docker Remote API</a> and the <code>--ulimit</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. Valid naming values are displayed in the <a>Ulimit</a> data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: <code>sudo docker version | grep \"Server API version\"</code> </p> <note> <p>This parameter is not supported for Windows containers.</p> </note>"
}
},
"UlimitName": {

View file

@ -11,7 +11,7 @@
"CreateConfigurationTemplate": "<p>Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings.</p> <p>Related Topics</p> <ul> <li> <p> <a>DescribeConfigurationOptions</a> </p> </li> <li> <p> <a>DescribeConfigurationSettings</a> </p> </li> <li> <p> <a>ListAvailableSolutionStacks</a> </p> </li> </ul>",
"CreateEnvironment": "<p>Launches an environment for the specified application using the specified configuration.</p>",
"CreatePlatformVersion": "<p>Create a new version of your custom platform.</p>",
"CreateStorageLocation": "<p>Creates the Amazon S3 storage location for the account.</p> <p>This location is used to store user log files.</p>",
"CreateStorageLocation": "<p>Creates a bucket in Amazon S3 to store application versions, logs, and other files used by Elastic Beanstalk environments. The Elastic Beanstalk console and EB CLI call this API the first time you create an environment in a region. If the storage location already exists, <code>CreateStorageLocation</code> still returns the bucket name but does not create a new bucket.</p>",
"DeleteApplication": "<p>Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.</p> <note> <p>You cannot delete an application that has a running environment.</p> </note>",
"DeleteApplicationVersion": "<p>Deletes the specified version from the specified application.</p> <note> <p>You cannot delete an application version that is associated with a running environment.</p> </note>",
"DeleteConfigurationTemplate": "<p>Deletes the specified configuration template.</p> <note> <p>When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running environment.</p> </note>",
@ -31,7 +31,7 @@
"DescribePlatformVersion": "<p>Describes the version of the platform.</p>",
"ListAvailableSolutionStacks": "<p>Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.</p>",
"ListPlatformVersions": "<p>Lists the available platforms.</p>",
"ListTagsForResource": "<p>Returns the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs.</p> <p>Currently, Elastic Beanstalk only supports tagging Elastic Beanstalk environments.</p>",
"ListTagsForResource": "<p>Returns the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs.</p> <p>Currently, Elastic Beanstalk only supports tagging of Elastic Beanstalk environments. For details about environment tagging, see <a href=\"http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features.tagging.html\">Tagging Resources in Your Elastic Beanstalk Environment</a>.</p>",
"RebuildEnvironment": "<p>Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart.</p>",
"RequestEnvironmentInfo": "<p>Initiates a request to compile the specified type of information of the deployed environment.</p> <p> Setting the <code>InfoType</code> to <code>tail</code> compiles the last lines from the application server log files of every Amazon EC2 instance in your environment. </p> <p> Setting the <code>InfoType</code> to <code>bundle</code> compresses the application server log files for every Amazon EC2 instance into a <code>.zip</code> file. Legacy and .NET containers do not support bundle logs. </p> <p> Use <a>RetrieveEnvironmentInfo</a> to obtain the set of logs. </p> <p>Related Topics</p> <ul> <li> <p> <a>RetrieveEnvironmentInfo</a> </p> </li> </ul>",
"RestartAppServer": "<p>Causes the environment to restart the application container server running on each Amazon EC2 instance.</p>",
@ -43,7 +43,7 @@
"UpdateApplicationVersion": "<p>Updates the specified application version to have the specified properties.</p> <note> <p>If a property (for example, <code>description</code>) is not provided, the value remains unchanged. To clear properties, specify an empty string.</p> </note>",
"UpdateConfigurationTemplate": "<p>Updates the specified configuration template to have the specified properties or configuration option values.</p> <note> <p>If a property (for example, <code>ApplicationName</code>) is not provided, its value remains unchanged. To clear such properties, specify an empty string.</p> </note> <p>Related Topics</p> <ul> <li> <p> <a>DescribeConfigurationOptions</a> </p> </li> </ul>",
"UpdateEnvironment": "<p>Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.</p> <p> Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an <code>InvalidParameterCombination</code> error. </p> <p> When updating the configuration settings to a new template or individual settings, a draft configuration is created and <a>DescribeConfigurationSettings</a> for this environment returns two setting descriptions with different <code>DeploymentStatus</code> values. </p>",
"UpdateTagsForResource": "<p>Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed: <code>TagsToAdd</code> for tags to add or update, and <code>TagsToRemove</code>.</p> <p>Currently, Elastic Beanstalk only supports tagging of Elastic Beanstalk environments.</p>",
"UpdateTagsForResource": "<p>Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed: <code>TagsToAdd</code> for tags to add or update, and <code>TagsToRemove</code>.</p> <p>Currently, Elastic Beanstalk only supports tagging of Elastic Beanstalk environments. For details about environment tagging, see <a href=\"http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/using-features.tagging.html\">Tagging Resources in Your Elastic Beanstalk Environment</a>.</p> <p>If you create a custom IAM user policy to control permission to this operation, specify one of the following two virtual actions (or both) instead of the API operation name:</p> <dl> <dt>elasticbeanstalk:AddTags</dt> <dd> <p>Controls permission to call <code>UpdateTagsForResource</code> and pass a list of tags to add in the <code>TagsToAdd</code> parameter.</p> </dd> <dt>elasticbeanstalk:RemoveTags</dt> <dd> <p>Controls permission to call <code>UpdateTagsForResource</code> and pass a list of tag keys to remove in the <code>TagsToRemove</code> parameter.</p> </dd> </dl> <p>For details about creating a custom user policy, see <a href=\"http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/AWSHowTo.iam.managed-policies.html#AWSHowTo.iam.policies\">Creating a Custom User Policy</a>.</p>",
"ValidateConfigurationSettings": "<p>Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.</p> <p>This action returns a list of messages indicating any errors or warnings associated with the selection of option values.</p>"
},
"shapes": {
@ -200,7 +200,7 @@
"ApplicationVersionProccess": {
"base": null,
"refs": {
"CreateApplicationVersionMessage$Process": "<p>Preprocesses and validates the environment manifest and configuration files in the source bundle. Validating configuration files can identify issues prior to deploying the application version to an environment.</p>"
"CreateApplicationVersionMessage$Process": "<p>Preprocesses and validates the environment manifest (<code>env.yaml</code>) and configuration files (<code>*.config</code> files in the <code>.ebextensions</code> folder) in the source bundle. Validating configuration files can identify issues prior to deploying the application version to an environment.</p> <note> <p>The <code>Process</code> option validates Elastic Beanstalk configuration files. It doesn't validate your application's configuration files, like proxy server or Docker configuration.</p> </note>"
}
},
"ApplicationVersionStatus": {
@ -1299,7 +1299,7 @@
"refs": {
"ConfigurationOptionsDescription$PlatformArn": "<p>The ARN of the platform.</p>",
"ConfigurationSettingsDescription$PlatformArn": "<p>The ARN of the platform.</p>",
"CreateConfigurationTemplateMessage$PlatformArn": "<p>The ARN of the custome platform.</p>",
"CreateConfigurationTemplateMessage$PlatformArn": "<p>The ARN of the custom platform.</p>",
"CreateEnvironmentMessage$PlatformArn": "<p>The ARN of the platform.</p>",
"DeletePlatformVersionRequest$PlatformArn": "<p>The ARN of the version of the custom platform.</p>",
"DescribeConfigurationOptionsMessage$PlatformArn": "<p>The ARN of the custom platform.</p>",

View file

@ -84,6 +84,20 @@
{"shape":"InvalidTrackingOptionsException"}
]
},
"CreateCustomVerificationEmailTemplate":{
"name":"CreateCustomVerificationEmailTemplate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateCustomVerificationEmailTemplateRequest"},
"errors":[
{"shape":"CustomVerificationEmailTemplateAlreadyExistsException"},
{"shape":"FromEmailAddressNotVerifiedException"},
{"shape":"CustomVerificationEmailInvalidContentException"},
{"shape":"LimitExceededException"}
]
},
"CreateReceiptFilter":{
"name":"CreateReceiptFilter",
"http":{
@ -201,6 +215,14 @@
{"shape":"TrackingOptionsDoesNotExistException"}
]
},
"DeleteCustomVerificationEmailTemplate":{
"name":"DeleteCustomVerificationEmailTemplate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteCustomVerificationEmailTemplateRequest"}
},
"DeleteIdentity":{
"name":"DeleteIdentity",
"http":{
@ -356,6 +378,21 @@
"resultWrapper":"GetAccountSendingEnabledResult"
}
},
"GetCustomVerificationEmailTemplate":{
"name":"GetCustomVerificationEmailTemplate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetCustomVerificationEmailTemplateRequest"},
"output":{
"shape":"GetCustomVerificationEmailTemplateResponse",
"resultWrapper":"GetCustomVerificationEmailTemplateResult"
},
"errors":[
{"shape":"CustomVerificationEmailTemplateDoesNotExistException"}
]
},
"GetIdentityDkimAttributes":{
"name":"GetIdentityDkimAttributes",
"http":{
@ -465,6 +502,18 @@
"resultWrapper":"ListConfigurationSetsResult"
}
},
"ListCustomVerificationEmailTemplates":{
"name":"ListCustomVerificationEmailTemplates",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListCustomVerificationEmailTemplatesRequest"},
"output":{
"shape":"ListCustomVerificationEmailTemplatesResponse",
"resultWrapper":"ListCustomVerificationEmailTemplatesResult"
}
},
"ListIdentities":{
"name":"ListIdentities",
"http":{
@ -602,6 +651,25 @@
{"shape":"AccountSendingPausedException"}
]
},
"SendCustomVerificationEmail":{
"name":"SendCustomVerificationEmail",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SendCustomVerificationEmailRequest"},
"output":{
"shape":"SendCustomVerificationEmailResponse",
"resultWrapper":"SendCustomVerificationEmailResult"
},
"errors":[
{"shape":"MessageRejected"},
{"shape":"ConfigurationSetDoesNotExistException"},
{"shape":"CustomVerificationEmailTemplateDoesNotExistException"},
{"shape":"FromEmailAddressNotVerifiedException"},
{"shape":"ProductionAccessNotGrantedException"}
]
},
"SendEmail":{
"name":"SendEmail",
"http":{
@ -834,6 +902,19 @@
{"shape":"InvalidTrackingOptionsException"}
]
},
"UpdateCustomVerificationEmailTemplate":{
"name":"UpdateCustomVerificationEmailTemplate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateCustomVerificationEmailTemplateRequest"},
"errors":[
{"shape":"CustomVerificationEmailTemplateDoesNotExistException"},
{"shape":"FromEmailAddressNotVerifiedException"},
{"shape":"CustomVerificationEmailInvalidContentException"}
]
},
"UpdateReceiptRule":{
"name":"UpdateReceiptRule",
"http":{
@ -1225,6 +1306,25 @@
"members":{
}
},
"CreateCustomVerificationEmailTemplateRequest":{
"type":"structure",
"required":[
"TemplateName",
"FromEmailAddress",
"TemplateSubject",
"TemplateContent",
"SuccessRedirectionURL",
"FailureRedirectionURL"
],
"members":{
"TemplateName":{"shape":"TemplateName"},
"FromEmailAddress":{"shape":"FromAddress"},
"TemplateSubject":{"shape":"Subject"},
"TemplateContent":{"shape":"TemplateContent"},
"SuccessRedirectionURL":{"shape":"SuccessRedirectionURL"},
"FailureRedirectionURL":{"shape":"FailureRedirectionURL"}
}
},
"CreateReceiptFilterRequest":{
"type":"structure",
"required":["Filter"],
@ -1288,6 +1388,55 @@
]
},
"CustomRedirectDomain":{"type":"string"},
"CustomVerificationEmailInvalidContentException":{
"type":"structure",
"members":{
},
"error":{
"code":"CustomVerificationEmailInvalidContent",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"CustomVerificationEmailTemplate":{
"type":"structure",
"members":{
"TemplateName":{"shape":"TemplateName"},
"FromEmailAddress":{"shape":"FromAddress"},
"TemplateSubject":{"shape":"Subject"},
"SuccessRedirectionURL":{"shape":"SuccessRedirectionURL"},
"FailureRedirectionURL":{"shape":"FailureRedirectionURL"}
}
},
"CustomVerificationEmailTemplateAlreadyExistsException":{
"type":"structure",
"members":{
"CustomVerificationEmailTemplateName":{"shape":"TemplateName"}
},
"error":{
"code":"CustomVerificationEmailTemplateAlreadyExists",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"CustomVerificationEmailTemplateDoesNotExistException":{
"type":"structure",
"members":{
"CustomVerificationEmailTemplateName":{"shape":"TemplateName"}
},
"error":{
"code":"CustomVerificationEmailTemplateDoesNotExist",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"CustomVerificationEmailTemplates":{
"type":"list",
"member":{"shape":"CustomVerificationEmailTemplate"}
},
"DefaultDimensionValue":{"type":"string"},
"DeleteConfigurationSetEventDestinationRequest":{
"type":"structure",
@ -1329,6 +1478,13 @@
"members":{
}
},
"DeleteCustomVerificationEmailTemplateRequest":{
"type":"structure",
"required":["TemplateName"],
"members":{
"TemplateName":{"shape":"TemplateName"}
}
},
"DeleteIdentityPolicyRequest":{
"type":"structure",
"required":[
@ -1594,12 +1750,44 @@
},
"ExtensionFieldName":{"type":"string"},
"ExtensionFieldValue":{"type":"string"},
"FailureRedirectionURL":{"type":"string"},
"FromAddress":{"type":"string"},
"FromEmailAddressNotVerifiedException":{
"type":"structure",
"members":{
"FromEmailAddress":{"shape":"FromAddress"}
},
"error":{
"code":"FromEmailAddressNotVerified",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"GetAccountSendingEnabledResponse":{
"type":"structure",
"members":{
"Enabled":{"shape":"Enabled"}
}
},
"GetCustomVerificationEmailTemplateRequest":{
"type":"structure",
"required":["TemplateName"],
"members":{
"TemplateName":{"shape":"TemplateName"}
}
},
"GetCustomVerificationEmailTemplateResponse":{
"type":"structure",
"members":{
"TemplateName":{"shape":"TemplateName"},
"FromEmailAddress":{"shape":"FromAddress"},
"TemplateSubject":{"shape":"Subject"},
"TemplateContent":{"shape":"TemplateContent"},
"SuccessRedirectionURL":{"shape":"SuccessRedirectionURL"},
"FailureRedirectionURL":{"shape":"FailureRedirectionURL"}
}
},
"GetIdentityDkimAttributesRequest":{
"type":"structure",
"required":["Identities"],
@ -1953,6 +2141,20 @@
"NextToken":{"shape":"NextToken"}
}
},
"ListCustomVerificationEmailTemplatesRequest":{
"type":"structure",
"members":{
"NextToken":{"shape":"NextToken"},
"MaxResults":{"shape":"MaxResults"}
}
},
"ListCustomVerificationEmailTemplatesResponse":{
"type":"structure",
"members":{
"CustomVerificationEmailTemplates":{"shape":"CustomVerificationEmailTemplates"},
"NextToken":{"shape":"NextToken"}
}
},
"ListIdentitiesRequest":{
"type":"structure",
"members":{
@ -2046,6 +2248,12 @@
},
"Max24HourSend":{"type":"double"},
"MaxItems":{"type":"integer"},
"MaxResults":{
"type":"integer",
"box":true,
"max":50,
"min":1
},
"MaxSendRate":{"type":"double"},
"Message":{
"type":"structure",
@ -2142,6 +2350,17 @@
"type":"list",
"member":{"shape":"PolicyName"}
},
"ProductionAccessNotGrantedException":{
"type":"structure",
"members":{
},
"error":{
"code":"ProductionAccessNotGranted",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"PutIdentityPolicyRequest":{
"type":"structure",
"required":[
@ -2408,6 +2627,24 @@
"Status":{"shape":"BulkEmailDestinationStatusList"}
}
},
"SendCustomVerificationEmailRequest":{
"type":"structure",
"required":[
"EmailAddress",
"TemplateName"
],
"members":{
"EmailAddress":{"shape":"Address"},
"TemplateName":{"shape":"TemplateName"},
"ConfigurationSetName":{"shape":"ConfigurationSetName"}
}
},
"SendCustomVerificationEmailResponse":{
"type":"structure",
"members":{
"MessageId":{"shape":"MessageId"}
}
},
"SendDataPoint":{
"type":"structure",
"members":{
@ -2620,7 +2857,9 @@
"type":"string",
"enum":["RuleSet"]
},
"Subject":{"type":"string"},
"SubjectPart":{"type":"string"},
"SuccessRedirectionURL":{"type":"string"},
"Template":{
"type":"structure",
"required":["TemplateName"],
@ -2631,6 +2870,7 @@
"HtmlPart":{"shape":"HtmlPart"}
}
},
"TemplateContent":{"type":"string"},
"TemplateData":{
"type":"string",
"max":262144
@ -2775,6 +3015,18 @@
"members":{
}
},
"UpdateCustomVerificationEmailTemplateRequest":{
"type":"structure",
"required":["TemplateName"],
"members":{
"TemplateName":{"shape":"TemplateName"},
"FromEmailAddress":{"shape":"FromAddress"},
"TemplateSubject":{"shape":"Subject"},
"TemplateContent":{"shape":"TemplateContent"},
"SuccessRedirectionURL":{"shape":"SuccessRedirectionURL"},
"FailureRedirectionURL":{"shape":"FailureRedirectionURL"}
}
},
"UpdateReceiptRuleRequest":{
"type":"structure",
"required":[

View file

@ -6,6 +6,7 @@
"CreateConfigurationSet": "<p>Creates a configuration set.</p> <p>Configuration sets enable you to publish email sending events. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p> <p>You can execute this operation no more than once per second.</p>",
"CreateConfigurationSetEventDestination": "<p>Creates a configuration set event destination.</p> <note> <p>When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).</p> </note> <p>An event destination is the AWS service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p> <p>You can execute this operation no more than once per second.</p>",
"CreateConfigurationSetTrackingOptions": "<p>Creates an association between a configuration set and a custom domain for open and click event tracking. </p> <p>By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using configuration sets, see <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html\">Configuring Custom Domains to Handle Open and Click Tracking</a> in the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html\">Amazon SES Developer Guide</a>.</p>",
"CreateCustomVerificationEmailTemplate": "<p>Creates a new custom verification email template.</p> <p>For more information about custom verification email templates, see <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html\">Using Custom Verification Email Templates</a> in the <i>Amazon SES Developer Guide</i>.</p> <p>You can execute this operation no more than once per second.</p>",
"CreateReceiptFilter": "<p>Creates a new IP address filter.</p> <p>For information about setting up IP address filters, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-ip-filters.html\">Amazon SES Developer Guide</a>.</p> <p>You can execute this operation no more than once per second.</p>",
"CreateReceiptRule": "<p>Creates a receipt rule.</p> <p>For information about setting up receipt rules, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html\">Amazon SES Developer Guide</a>.</p> <p>You can execute this operation no more than once per second.</p>",
"CreateReceiptRuleSet": "<p>Creates an empty receipt rule set.</p> <p>For information about setting up receipt rule sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rule-set.html\">Amazon SES Developer Guide</a>.</p> <p>You can execute this operation no more than once per second.</p>",
@ -13,6 +14,7 @@
"DeleteConfigurationSet": "<p>Deletes a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p> <p>You can execute this operation no more than once per second.</p>",
"DeleteConfigurationSetEventDestination": "<p>Deletes a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Amazon SES Developer Guide</a>.</p> <p>You can execute this operation no more than once per second.</p>",
"DeleteConfigurationSetTrackingOptions": "<p>Deletes an association between a configuration set and a custom domain for open and click event tracking.</p> <p>By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using configuration sets, see <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html\">Configuring Custom Domains to Handle Open and Click Tracking</a> in the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html\">Amazon SES Developer Guide</a>.</p> <note> <p>Deleting this kind of association will result in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains.</p> </note>",
"DeleteCustomVerificationEmailTemplate": "<p>Deletes an existing custom verification email template. </p> <p>For more information about custom verification email templates, see <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html\">Using Custom Verification Email Templates</a> in the <i>Amazon SES Developer Guide</i>.</p> <p>You can execute this operation no more than once per second.</p>",
"DeleteIdentity": "<p>Deletes the specified identity (an email address or a domain) from the list of verified identities.</p> <p>You can execute this operation no more than once per second.</p>",
"DeleteIdentityPolicy": "<p>Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist.</p> <note> <p>This API is for the identity owner only. If you have not verified the identity, this API will return an error.</p> </note> <p>Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>.</p> <p>You can execute this operation no more than once per second.</p>",
"DeleteReceiptFilter": "<p>Deletes the specified IP address filter.</p> <p>For information about managing IP address filters, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html\">Amazon SES Developer Guide</a>.</p> <p>You can execute this operation no more than once per second.</p>",
@ -25,6 +27,7 @@
"DescribeReceiptRule": "<p>Returns the details of the specified receipt rule.</p> <p>For information about setting up receipt rules, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-receipt-rules.html\">Amazon SES Developer Guide</a>.</p> <p>You can execute this operation no more than once per second.</p>",
"DescribeReceiptRuleSet": "<p>Returns the details of the specified receipt rule set.</p> <p>For information about managing receipt rule sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html\">Amazon SES Developer Guide</a>.</p> <p>You can execute this operation no more than once per second.</p>",
"GetAccountSendingEnabled": "<p>Returns the email sending status of the Amazon SES account.</p> <p>You can execute this operation no more than once per second.</p>",
"GetCustomVerificationEmailTemplate": "<p>Returns the custom email verification template for the template name you specify.</p> <p>For more information about custom verification email templates, see <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html\">Using Custom Verification Email Templates</a> in the <i>Amazon SES Developer Guide</i>.</p> <p>You can execute this operation no more than once per second.</p>",
"GetIdentityDkimAttributes": "<p>Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published.</p> <p>This operation takes a list of identities as input and returns the following information for each:</p> <ul> <li> <p>Whether Easy DKIM signing is enabled or disabled.</p> </li> <li> <p>A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address.</p> </li> <li> <p>Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses.</p> </li> </ul> <p>This operation is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time.</p> <p>For more information about creating DNS records using DKIM tokens, go to the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim-dns-records.html\">Amazon SES Developer Guide</a>.</p>",
"GetIdentityMailFromDomainAttributes": "<p>Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains).</p> <p>This operation is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 identities at a time.</p>",
"GetIdentityNotificationAttributes": "<p>Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.</p> <p>This operation is throttled at one request per second and can only get notification attributes for up to 100 identities at a time.</p> <p>For more information about using notifications with Amazon SES, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html\">Amazon SES Developer Guide</a>.</p>",
@ -34,6 +37,7 @@
"GetSendStatistics": "<p>Provides sending statistics for the Amazon SES account. The result is a list of data points, representing the last two weeks of sending activity. Each data point in the list contains statistics for a 15-minute period of time.</p> <p>You can execute this operation no more than once per second.</p>",
"GetTemplate": "<p>Displays the template object (which includes the Subject line, HTML part and text part) for the template you specify.</p> <p>You can execute this operation no more than once per second.</p>",
"ListConfigurationSets": "<p>Provides a list of the configuration sets associated with your Amazon SES account. For information about using configuration sets, see <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-sending-activity.html\">Monitoring Your Amazon SES Sending Activity</a> in the <i>Amazon SES Developer Guide.</i> </p> <p>You can execute this operation no more than once per second. This operation will return up to 1,000 configuration sets each time it is run. If your Amazon SES account has more than 1,000 configuration sets, this operation will also return a NextToken element. You can then execute the <code>ListConfigurationSets</code> operation again, passing the <code>NextToken</code> parameter and the value of the NextToken element to retrieve additional results.</p>",
"ListCustomVerificationEmailTemplates": "<p>Lists the existing custom verification email templates for your account.</p> <p>For more information about custom verification email templates, see <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html\">Using Custom Verification Email Templates</a> in the <i>Amazon SES Developer Guide</i>.</p> <p>You can execute this operation no more than once per second.</p>",
"ListIdentities": "<p>Returns a list containing all of the identities (email addresses and domains) for your AWS account, regardless of verification status.</p> <p>You can execute this operation no more than once per second.</p>",
"ListIdentityPolicies": "<p>Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This API returns only a list. If you want the actual policy content, you can use <code>GetIdentityPolicies</code>.</p> <note> <p>This API is for the identity owner only. If you have not verified the identity, this API will return an error.</p> </note> <p>Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>.</p> <p>You can execute this operation no more than once per second.</p>",
"ListReceiptFilters": "<p>Lists the IP address filters associated with your AWS account.</p> <p>For information about managing IP address filters, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-ip-filters.html\">Amazon SES Developer Guide</a>.</p> <p>You can execute this operation no more than once per second.</p>",
@ -44,6 +48,7 @@
"ReorderReceiptRuleSet": "<p>Reorders the receipt rules within a receipt rule set.</p> <note> <p>All of the rules in the rule set must be represented in this request. That is, this API will return an error if the reorder request doesn't explicitly position all of the rules.</p> </note> <p>For information about managing receipt rule sets, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rule-sets.html\">Amazon SES Developer Guide</a>.</p> <p>You can execute this operation no more than once per second.</p>",
"SendBounce": "<p>Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it.</p> <note> <p>You cannot use this API to send generic bounces for mail that was not received by Amazon SES.</p> </note> <p>For information about receiving email through Amazon SES, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email.html\">Amazon SES Developer Guide</a>.</p> <p>You can execute this operation no more than once per second.</p>",
"SendBulkTemplatedEmail": "<p>Composes an email message to multiple destinations. The message body is created using an email template.</p> <p>In order to send email using the <code>SendBulkTemplatedEmail</code> operation, your call to the API must meet the following requirements:</p> <ul> <li> <p>The call must refer to an existing email template. You can create email templates using the <a>CreateTemplate</a> operation.</p> </li> <li> <p>The message must be sent from a verified email address or domain.</p> </li> <li> <p>If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html\">Verifying Email Addresses and Domains</a> in the <i>Amazon SES Developer Guide.</i> </p> </li> <li> <p>The total size of the message, including attachments, must be less than 10 MB.</p> </li> <li> <p>Each <code>Destination</code> parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format <i>UserName@[SubDomain.]Domain.TopLevelDomain</i>), the entire message will be rejected, even if the message contains other recipients that are valid.</p> </li> </ul>",
"SendCustomVerificationEmail": "<p>Adds an email address to the list of identities for your Amazon SES account and attempts to verify it. As a result of executing this operation, a customized verification email is sent to the specified address.</p> <p>To use this operation, you must first create a custom verification email template. For more information about creating and using custom verification email templates, see <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html\">Using Custom Verification Email Templates</a> in the <i>Amazon SES Developer Guide</i>.</p> <p>You can execute this operation no more than once per second.</p>",
"SendEmail": "<p>Composes an email message and immediately queues it for sending. In order to send email using the <code>SendEmail</code> operation, your message must meet the following requirements:</p> <ul> <li> <p>The message must be sent from a verified email address or domain. If you attempt to send email using a non-verified address or domain, the operation will result in an \"Email address not verified\" error. </p> </li> <li> <p>If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html\">Verifying Email Addresses and Domains</a> in the <i>Amazon SES Developer Guide.</i> </p> </li> <li> <p>The total size of the message, including attachments, must be smaller than 10 MB.</p> </li> <li> <p>The message must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format <i>UserName@[SubDomain.]Domain.TopLevelDomain</i>), the entire message will be rejected, even if the message contains other recipients that are valid.</p> </li> <li> <p>The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the <code>SendEmail</code> operation several times to send the message to each group.</p> </li> </ul> <important> <p>For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your <i>sending quota</i>). For more information about sending quotas in Amazon SES, see <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html\">Managing Your Amazon SES Sending Limits</a> in the <i>Amazon SES Developer Guide.</i> </p> </important>",
"SendRawEmail": "<p>Composes an email message and immediately queues it for sending. When calling this operation, you may specify the message headers as well as the content. The <code>SendRawEmail</code> operation is particularly useful for sending multipart MIME emails (such as those that contain both a plain-text and an HTML version). </p> <p>In order to send email using the <code>SendRawEmail</code> operation, your message must meet the following requirements:</p> <ul> <li> <p>The message must be sent from a verified email address or domain. If you attempt to send email using a non-verified address or domain, the operation will result in an \"Email address not verified\" error. </p> </li> <li> <p>If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html\">Verifying Email Addresses and Domains</a> in the <i>Amazon SES Developer Guide.</i> </p> </li> <li> <p>The total size of the message, including attachments, must be smaller than 10 MB.</p> </li> <li> <p>The message must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format <i>UserName@[SubDomain.]Domain.TopLevelDomain</i>), the entire message will be rejected, even if the message contains other recipients that are valid.</p> </li> <li> <p>The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the <code>SendRawEmail</code> operation several times to send the message to each group.</p> </li> </ul> <important> <p>For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your <i>sending quota</i>). For more information about sending quotas in Amazon SES, see <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html\">Managing Your Amazon SES Sending Limits</a> in the <i>Amazon SES Developer Guide.</i> </p> </important> <p>Additionally, keep the following considerations in mind when using the <code>SendRawEmail</code> operation:</p> <ul> <li> <p>Although you can customize the message headers when using the <code>SendRawEmail</code> operation, Amazon SES will automatically apply its own <code>Message-ID</code> and <code>Date</code> headers; if you passed these headers when creating the message, they will be overwritten by the values that Amazon SES provides.</p> </li> <li> <p>If you are using sending authorization to send on behalf of another user, <code>SendRawEmail</code> enables you to specify the cross-account identity for the email's Source, From, and Return-Path parameters in one of two ways: you can pass optional parameters <code>SourceArn</code>, <code>FromArn</code>, and/or <code>ReturnPathArn</code> to the API, or you can include the following X-headers in the header of your raw email:</p> <ul> <li> <p> <code>X-SES-SOURCE-ARN</code> </p> </li> <li> <p> <code>X-SES-FROM-ARN</code> </p> </li> <li> <p> <code>X-SES-RETURN-PATH-ARN</code> </p> </li> </ul> <important> <p>Do not include these X-headers in the DKIM signature; Amazon SES will remove them before sending the email.</p> </important> <p>For most common sending authorization scenarios, we recommend that you specify the <code>SourceIdentityArn</code> parameter and not the <code>FromIdentityArn</code> or <code>ReturnPathIdentityArn</code> parameters. If you only specify the <code>SourceIdentityArn</code> parameter, Amazon SES will set the From and Return Path addresses to the identity specified in <code>SourceIdentityArn</code>. For more information about sending authorization, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Using Sending Authorization with Amazon SES</a> in the <i>Amazon SES Developer Guide.</i> </p> </li> </ul>",
"SendTemplatedEmail": "<p>Composes an email message using an email template and immediately queues it for sending.</p> <p>In order to send email using the <code>SendTemplatedEmail</code> operation, your call to the API must meet the following requirements:</p> <ul> <li> <p>The call must refer to an existing email template. You can create email templates using the <a>CreateTemplate</a> operation.</p> </li> <li> <p>The message must be sent from a verified email address or domain.</p> </li> <li> <p>If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html\">Verifying Email Addresses and Domains</a> in the <i>Amazon SES Developer Guide.</i> </p> </li> <li> <p>The total size of the message, including attachments, must be less than 10 MB.</p> </li> <li> <p>Calls to the <code>SendTemplatedEmail</code> operation may only include one <code>Destination</code> parameter. A destination is a set of recipients who will receive the same version of the email. The <code>Destination</code> parameter can include up to 50 recipients, across the To:, CC: and BCC: fields.</p> </li> <li> <p>The <code>Destination</code> parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format <i>UserName@[SubDomain.]Domain.TopLevelDomain</i>), the entire message will be rejected, even if the message contains other recipients that are valid.</p> </li> </ul>",
@ -60,12 +65,13 @@
"UpdateConfigurationSetReputationMetricsEnabled": "<p>Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set. Reputation metrics include bounce and complaint rates. These metrics are published to Amazon CloudWatch. By using Amazon CloudWatch, you can create alarms when bounce or complaint rates exceed a certain threshold.</p> <p>You can execute this operation no more than once per second.</p>",
"UpdateConfigurationSetSendingEnabled": "<p>Enables or disables email sending for messages sent using a specific configuration set. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending for a configuration set when the reputation metrics for that configuration set (such as your bounce on complaint rate) reach certain thresholds.</p> <p>You can execute this operation no more than once per second.</p>",
"UpdateConfigurationSetTrackingOptions": "<p>Modifies an association between a configuration set and a custom domain for open and click event tracking. </p> <p>By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using configuration sets, see <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/configure-custom-open-click-domains.html\">Configuring Custom Domains to Handle Open and Click Tracking</a> in the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/Welcome.html\">Amazon SES Developer Guide</a>.</p>",
"UpdateCustomVerificationEmailTemplate": "<p>Updates an existing custom verification email template.</p> <p>For more information about custom verification email templates, see <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html\">Using Custom Verification Email Templates</a> in the <i>Amazon SES Developer Guide</i>.</p> <p>You can execute this operation no more than once per second.</p>",
"UpdateReceiptRule": "<p>Updates a receipt rule.</p> <p>For information about managing receipt rules, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-managing-receipt-rules.html\">Amazon SES Developer Guide</a>.</p> <p>You can execute this operation no more than once per second.</p>",
"UpdateTemplate": "<p>Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-personalized-email-api.html\">Amazon SES Developer Guide</a>.</p> <p>You can execute this operation no more than once per second.</p>",
"VerifyDomainDkim": "<p>Returns a set of DKIM tokens for a domain. DKIM <i>tokens</i> are character strings that represent your domain's identity. Using these tokens, you will need to create DNS CNAME records that point to DKIM public keys hosted by Amazon SES. Amazon Web Services will eventually detect that you have updated your DNS records; this detection process may take up to 72 hours. Upon successful detection, Amazon SES will be able to DKIM-sign email originating from that domain.</p> <p>You can execute this operation no more than once per second.</p> <p>To enable or disable Easy DKIM signing for a domain, use the <code>SetIdentityDkimEnabled</code> operation.</p> <p>For more information about creating DNS records using DKIM tokens, go to the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim-dns-records.html\">Amazon SES Developer Guide</a>.</p>",
"VerifyDomainIdentity": "<p>Adds a domain to the list of identities for your Amazon SES account and attempts to verify it. For more information about verifying domains, see <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html\">Verifying Email Addresses and Domains</a> in the <i>Amazon SES Developer Guide.</i> </p> <p>You can execute this operation no more than once per second.</p>",
"VerifyEmailAddress": "<p>Deprecated. Use the <code>VerifyEmailIdentity</code> operation to verify a new email address.</p>",
"VerifyEmailIdentity": "<p>Adds an email address to the list of identities for your Amazon SES account and attempts to verify it. This operation causes a confirmation email message to be sent to the specified address.</p> <p>You can execute this operation no more than once per second.</p>"
"VerifyEmailIdentity": "<p>Adds an email address to the list of identities for your Amazon SES account and attempts to verify it. As a result of executing this operation, a verification email is sent to the specified address.</p> <p>You can execute this operation no more than once per second.</p>"
},
"shapes": {
"AccountSendingPausedException": {
@ -88,12 +94,13 @@
"DeleteVerifiedEmailAddressRequest$EmailAddress": "<p>An email address to be removed from the list of verified addresses.</p>",
"RecipientDsnFields$FinalRecipient": "<p>The email address that the message was ultimately delivered to. This corresponds to the <code>Final-Recipient</code> in the DSN. If not specified, <code>FinalRecipient</code> will be set to the <code>Recipient</code> specified in the <code>BouncedRecipientInfo</code> structure. Either <code>FinalRecipient</code> or the recipient in <code>BouncedRecipientInfo</code> must be a recipient of the original bounced message.</p> <note> <p>Do not prepend the <code>FinalRecipient</code> email address with <code>rfc 822;</code>, as described in <a href=\"https://tools.ietf.org/html/rfc3798\">RFC 3798</a>.</p> </note>",
"SendBounceRequest$BounceSender": "<p>The address to use in the \"From\" header of the bounce message. This must be an identity that you have verified with Amazon SES.</p>",
"SendBulkTemplatedEmailRequest$Source": "<p>The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html\">Amazon SES Developer Guide</a>.</p> <p>If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the <code>SourceArn</code> parameter. For more information about sending authorization, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>.</p> <p> In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: <code>=?charset?encoding?encoded-text?=</code>. For more information, see <a href=\"https://tools.ietf.org/html/rfc2047\">RFC 2047</a>. </p>",
"SendBulkTemplatedEmailRequest$Source": "<p>The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html\">Amazon SES Developer Guide</a>.</p> <p>If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the <code>SourceArn</code> parameter. For more information about sending authorization, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>.</p> <note> <p>Amazon SES does not support the SMTPUTF8 extension, as described in <a href=\"https://tools.ietf.org/html/rfc6531\">RFC6531</a>. For this reason, the <i>local part</i> of a source email address (the part of the email address that precedes the @ sign) may only contain <a href=\"https://en.wikipedia.org/wiki/Email_address#Local-part\">7-bit ASCII characters</a>. If the <i>domain part</i> of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in <a href=\"https://tools.ietf.org/html/rfc3492.html\">RFC3492</a>. The sender name (also known as the <i>friendly name</i>) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in <a href=\"https://tools.ietf.org/html/rfc2047\">RFC 2047</a>. MIME encoded-word syntax uses the following form: <code>=?charset?encoding?encoded-text?=</code>.</p> </note>",
"SendBulkTemplatedEmailRequest$ReturnPath": "<p>The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the <code>ReturnPath</code> parameter. The <code>ReturnPath</code> parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. </p>",
"SendEmailRequest$Source": "<p>The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html\">Amazon SES Developer Guide</a>.</p> <p>If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the <code>SourceArn</code> parameter. For more information about sending authorization, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>.</p> <p> In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: <code>=?charset?encoding?encoded-text?=</code>. For more information, see <a href=\"https://tools.ietf.org/html/rfc2047\">RFC 2047</a>. </p>",
"SendCustomVerificationEmailRequest$EmailAddress": "<p>The email address to verify.</p>",
"SendEmailRequest$Source": "<p>The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html\">Amazon SES Developer Guide</a>.</p> <p>If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the <code>SourceArn</code> parameter. For more information about sending authorization, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>.</p> <note> <p>Amazon SES does not support the SMTPUTF8 extension, as described in <a href=\"https://tools.ietf.org/html/rfc6531\">RFC6531</a>. For this reason, the <i>local part</i> of a source email address (the part of the email address that precedes the @ sign) may only contain <a href=\"https://en.wikipedia.org/wiki/Email_address#Local-part\">7-bit ASCII characters</a>. If the <i>domain part</i> of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in <a href=\"https://tools.ietf.org/html/rfc3492.html\">RFC3492</a>. The sender name (also known as the <i>friendly name</i>) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in <a href=\"https://tools.ietf.org/html/rfc2047\">RFC 2047</a>. MIME encoded-word syntax uses the following form: <code>=?charset?encoding?encoded-text?=</code>.</p> </note>",
"SendEmailRequest$ReturnPath": "<p>The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the <code>ReturnPath</code> parameter. The <code>ReturnPath</code> parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. </p>",
"SendRawEmailRequest$Source": "<p>The identity's email address. If you do not provide a value for this parameter, you must specify a \"From\" address in the raw text of the message. (You can also specify both.)</p> <p> By default, the string must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: <code>=?charset?encoding?encoded-text?=</code>. For more information, see <a href=\"https://tools.ietf.org/html/rfc2047\">RFC 2047</a>. </p> <note> <p>If you specify the <code>Source</code> parameter and have feedback forwarding enabled, then bounces and complaints will be sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message.</p> </note>",
"SendTemplatedEmailRequest$Source": "<p>The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html\">Amazon SES Developer Guide</a>.</p> <p>If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the <code>SourceArn</code> parameter. For more information about sending authorization, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>.</p> <p> In all cases, the email address must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: <code>=?charset?encoding?encoded-text?=</code>. For more information, see <a href=\"https://tools.ietf.org/html/rfc2047\">RFC 2047</a>. </p>",
"SendRawEmailRequest$Source": "<p>The identity's email address. If you do not provide a value for this parameter, you must specify a \"From\" address in the raw text of the message. (You can also specify both.)</p> <note> <p>Amazon SES does not support the SMTPUTF8 extension, as described in<a href=\"https://tools.ietf.org/html/rfc6531\">RFC6531</a>. For this reason, the <i>local part</i> of a source email address (the part of the email address that precedes the @ sign) may only contain <a href=\"https://en.wikipedia.org/wiki/Email_address#Local-part\">7-bit ASCII characters</a>. If the <i>domain part</i> of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in <a href=\"https://tools.ietf.org/html/rfc3492.html\">RFC3492</a>. The sender name (also known as the <i>friendly name</i>) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in <a href=\"https://tools.ietf.org/html/rfc2047\">RFC 2047</a>. MIME encoded-word syntax uses the following form: <code>=?charset?encoding?encoded-text?=</code>.</p> </note> <p>If you specify the <code>Source</code> parameter and have feedback forwarding enabled, then bounces and complaints will be sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message.</p>",
"SendTemplatedEmailRequest$Source": "<p>The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html\">Amazon SES Developer Guide</a>.</p> <p>If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the <code>SourceArn</code> parameter. For more information about sending authorization, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>.</p> <note> <p>Amazon SES does not support the SMTPUTF8 extension, as described in <a href=\"https://tools.ietf.org/html/rfc6531\">RFC6531</a>. For this reason, the <i>local part</i> of a source email address (the part of the email address that precedes the @ sign) may only contain <a href=\"https://en.wikipedia.org/wiki/Email_address#Local-part\">7-bit ASCII characters</a>. If the <i>domain part</i> of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in <a href=\"https://tools.ietf.org/html/rfc3492.html\">RFC3492</a>. The sender name (also known as the <i>friendly name</i>) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in<a href=\"https://tools.ietf.org/html/rfc2047\">RFC 2047</a>. MIME encoded-word syntax uses the following form: <code>=?charset?encoding?encoded-text?=</code>.</p> </note>",
"SendTemplatedEmailRequest$ReturnPath": "<p>The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the <code>ReturnPath</code> parameter. The <code>ReturnPath</code> parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. </p>",
"VerifyEmailAddressRequest$EmailAddress": "<p>The email address to be verified.</p>",
"VerifyEmailIdentityRequest$EmailAddress": "<p>The email address to be verified.</p>"
@ -334,6 +341,7 @@
"InvalidFirehoseDestinationException$ConfigurationSetName": "<p>Indicates that the configuration set does not exist.</p>",
"InvalidSNSDestinationException$ConfigurationSetName": "<p>Indicates that the configuration set does not exist.</p>",
"SendBulkTemplatedEmailRequest$ConfigurationSetName": "<p>The name of the configuration set to use when you send an email using <code>SendBulkTemplatedEmail</code>.</p>",
"SendCustomVerificationEmailRequest$ConfigurationSetName": "<p>Name of a configuration set to use when sending the verification email.</p>",
"SendEmailRequest$ConfigurationSetName": "<p>The name of the configuration set to use when you send an email using <code>SendEmail</code>.</p>",
"SendRawEmailRequest$ConfigurationSetName": "<p>The name of the configuration set to use when you send an email using <code>SendRawEmail</code>.</p>",
"SendTemplatedEmailRequest$ConfigurationSetName": "<p>The name of the configuration set to use when you send an email using <code>SendTemplatedEmail</code>.</p>",
@ -403,6 +411,11 @@
"refs": {
}
},
"CreateCustomVerificationEmailTemplateRequest": {
"base": "<p>Represents a request to create a custom verification email template.</p>",
"refs": {
}
},
"CreateReceiptFilterRequest": {
"base": "<p>Represents a request to create a new IP address filter. You use IP address filters when you receive email with Amazon SES. For more information, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html\">Amazon SES Developer Guide</a>.</p>",
"refs": {
@ -455,10 +468,37 @@
"TrackingOptions$CustomRedirectDomain": "<p>The custom subdomain that will be used to redirect email recipients to the Amazon SES event tracking domain.</p>"
}
},
"CustomVerificationEmailInvalidContentException": {
"base": "<p>Indicates that custom verification email template provided content is invalid.</p>",
"refs": {
}
},
"CustomVerificationEmailTemplate": {
"base": "<p>Contains information about a custom verification email template.</p>",
"refs": {
"CustomVerificationEmailTemplates$member": null
}
},
"CustomVerificationEmailTemplateAlreadyExistsException": {
"base": "<p>Indicates that a custom verification email template with the name you specified already exists.</p>",
"refs": {
}
},
"CustomVerificationEmailTemplateDoesNotExistException": {
"base": "<p>Indicates that a custom verification email template with the name you specified does not exist.</p>",
"refs": {
}
},
"CustomVerificationEmailTemplates": {
"base": null,
"refs": {
"ListCustomVerificationEmailTemplatesResponse$CustomVerificationEmailTemplates": "<p>A list of the custom verification email templates that exist in your account.</p>"
}
},
"DefaultDimensionValue": {
"base": null,
"refs": {
"CloudWatchDimensionConfiguration$DefaultDimensionValue": "<p>The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. The default value must:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).</p> </li> <li> <p>Contain less than 256 characters.</p> </li> </ul>"
"CloudWatchDimensionConfiguration$DefaultDimensionValue": "<p>The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. The default value must:</p> <ul> <li> <p>This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).</p> </li> <li> <p>Contain less than 256 characters.</p> </li> </ul>"
}
},
"DeleteConfigurationSetEventDestinationRequest": {
@ -491,6 +531,11 @@
"refs": {
}
},
"DeleteCustomVerificationEmailTemplateRequest": {
"base": "<p>Represents a request to delete an existing custom verification email template.</p>",
"refs": {
}
},
"DeleteIdentityPolicyRequest": {
"base": "<p>Represents a request to delete a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>.</p>",
"refs": {
@ -597,7 +642,7 @@
}
},
"Destination": {
"base": "<p>Represents the destination of the message, consisting of To:, CC:, and BCC: fields.</p> <p> By default, the string must be 7-bit ASCII. If the text must contain any other characters, then you must use MIME encoded-word syntax (RFC 2047) instead of a literal string. MIME encoded-word syntax uses the following form: <code>=?charset?encoding?encoded-text?=</code>. For more information, see <a href=\"https://tools.ietf.org/html/rfc2047\">RFC 2047</a>. </p>",
"base": "<p>Represents the destination of the message, consisting of To:, CC:, and BCC: fields.</p> <note> <p>Amazon SES does not support the SMTPUTF8 extension, as described in <a href=\"https://tools.ietf.org/html/rfc6531\">RFC6531</a>. For this reason, the <i>local part</i> of a destination email address (the part of the email address that precedes the @ sign) may only contain <a href=\"https://en.wikipedia.org/wiki/Email_address#Local-part\">7-bit ASCII characters</a>. If the <i>domain part</i> of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in <a href=\"https://tools.ietf.org/html/rfc3492.html\">RFC3492</a>.</p> </note>",
"refs": {
"BulkEmailDestination$Destination": null,
"SendEmailRequest$Destination": "<p>The destination for this email, composed of To:, CC:, and BCC: fields.</p>",
@ -613,7 +658,7 @@
"DimensionName": {
"base": null,
"refs": {
"CloudWatchDimensionConfiguration$DimensionName": "<p>The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).</p> </li> <li> <p>Contain less than 256 characters.</p> </li> </ul>"
"CloudWatchDimensionConfiguration$DimensionName": "<p>The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must:</p> <ul> <li> <p>This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).</p> </li> <li> <p>Contain less than 256 characters.</p> </li> </ul>"
}
},
"DimensionValueSource": {
@ -697,7 +742,7 @@
"base": null,
"refs": {
"DeleteConfigurationSetEventDestinationRequest$EventDestinationName": "<p>The name of the event destination to delete.</p>",
"EventDestination$Name": "<p>The name of the event destination. The name must:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).</p> </li> <li> <p>Contain less than 64 characters.</p> </li> </ul>",
"EventDestination$Name": "<p>The name of the event destination. The name must:</p> <ul> <li> <p>This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).</p> </li> <li> <p>Contain less than 64 characters.</p> </li> </ul>",
"EventDestinationAlreadyExistsException$EventDestinationName": "<p>Indicates that the event destination does not exist.</p>",
"EventDestinationDoesNotExistException$EventDestinationName": "<p>Indicates that the event destination does not exist.</p>",
"InvalidCloudWatchDestinationException$EventDestinationName": "<p>Indicates that the event destination does not exist.</p>",
@ -754,11 +799,45 @@
"ExtensionField$Value": "<p>The value of the header to add. Must be less than 2048 characters, and must not contain newline characters (\"\\r\" or \"\\n\").</p>"
}
},
"FailureRedirectionURL": {
"base": null,
"refs": {
"CreateCustomVerificationEmailTemplateRequest$FailureRedirectionURL": "<p>The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.</p>",
"CustomVerificationEmailTemplate$FailureRedirectionURL": "<p>The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.</p>",
"GetCustomVerificationEmailTemplateResponse$FailureRedirectionURL": "<p>The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.</p>",
"UpdateCustomVerificationEmailTemplateRequest$FailureRedirectionURL": "<p>The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.</p>"
}
},
"FromAddress": {
"base": null,
"refs": {
"CreateCustomVerificationEmailTemplateRequest$FromEmailAddress": "<p>The email address that the custom verification email is sent from.</p>",
"CustomVerificationEmailTemplate$FromEmailAddress": "<p>The email address that the custom verification email is sent from.</p>",
"FromEmailAddressNotVerifiedException$FromEmailAddress": "<p>Indicates that the from email address associated with the custom verification email template is not verified.</p>",
"GetCustomVerificationEmailTemplateResponse$FromEmailAddress": "<p>The email address that the custom verification email is sent from.</p>",
"UpdateCustomVerificationEmailTemplateRequest$FromEmailAddress": "<p>The email address that the custom verification email is sent from.</p>"
}
},
"FromEmailAddressNotVerifiedException": {
"base": "<p>Indicates that the sender address specified for a custom verification email is not verified, and is therefore not eligible to send the custom verification email. </p>",
"refs": {
}
},
"GetAccountSendingEnabledResponse": {
"base": "<p>Represents a request to return the email sending status for your Amazon SES account.</p>",
"refs": {
}
},
"GetCustomVerificationEmailTemplateRequest": {
"base": "<p>Represents a request to retrieve an existing custom verification email template.</p>",
"refs": {
}
},
"GetCustomVerificationEmailTemplateResponse": {
"base": "<p>The content of the custom verification email template.</p>",
"refs": {
}
},
"GetIdentityDkimAttributesRequest": {
"base": "<p>Represents a request for the status of Amazon SES Easy DKIM signing for an identity. For domain identities, this request also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES successfully verified that these tokens were published. For more information about Easy DKIM, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html\">Amazon SES Developer Guide</a>.</p>",
"refs": {
@ -1007,6 +1086,16 @@
"refs": {
}
},
"ListCustomVerificationEmailTemplatesRequest": {
"base": "<p>Represents a request to list the existing custom verification email templates for your account.</p> <p>For more information about custom verification email templates, see <a href=\"https://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html\">Using Custom Verification Email Templates</a> in the <i>Amazon SES Developer Guide</i>.</p>",
"refs": {
}
},
"ListCustomVerificationEmailTemplatesResponse": {
"base": "<p>A paginated list of custom verification email templates.</p>",
"refs": {
}
},
"ListIdentitiesRequest": {
"base": "<p>Represents a request to return a list of all identities (email addresses and domains) that you have attempted to verify under your AWS account, regardless of verification status.</p>",
"refs": {
@ -1094,6 +1183,12 @@
"ListTemplatesRequest$MaxItems": "<p>The maximum number of templates to return. This value must be at least 1 and less than or equal to 10. If you do not specify a value, or if you specify a value less than 1 or greater than 10, the operation will return up to 10 results.</p>"
}
},
"MaxResults": {
"base": null,
"refs": {
"ListCustomVerificationEmailTemplatesRequest$MaxResults": "<p>The maximum number of custom verification email templates to return. This value must be at least 1 and less than or equal to 50. If you do not specify a value, or if you specify a value less than 1 or greater than 50, the operation will return up to 50 results.</p>"
}
},
"MaxSendRate": {
"base": null,
"refs": {
@ -1124,6 +1219,7 @@
"BulkEmailDestinationStatus$MessageId": "<p>The unique message identifier returned from the <code>SendBulkTemplatedEmail</code> operation.</p>",
"SendBounceRequest$OriginalMessageId": "<p>The message ID of the message to be bounced.</p>",
"SendBounceResponse$MessageId": "<p>The message ID of the bounce message.</p>",
"SendCustomVerificationEmailResponse$MessageId": "<p>The unique message identifier returned from the <code>SendCustomVerificationEmail</code> operation.</p>",
"SendEmailResponse$MessageId": "<p>The unique message identifier returned from the <code>SendEmail</code> action. </p>",
"SendRawEmailResponse$MessageId": "<p>The unique message identifier returned from the <code>SendRawEmail</code> action. </p>",
"SendTemplatedEmailResponse$MessageId": "<p>The unique message identifier returned from the <code>SendTemplatedEmail</code> action. </p>"
@ -1153,13 +1249,13 @@
"MessageTagName": {
"base": null,
"refs": {
"MessageTag$Name": "<p>The name of the tag. The name must:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).</p> </li> <li> <p>Contain less than 256 characters.</p> </li> </ul>"
"MessageTag$Name": "<p>The name of the tag. The name must:</p> <ul> <li> <p>This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).</p> </li> <li> <p>Contain less than 256 characters.</p> </li> </ul>"
}
},
"MessageTagValue": {
"base": null,
"refs": {
"MessageTag$Value": "<p>The value of the tag. The value must:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).</p> </li> <li> <p>Contain less than 256 characters.</p> </li> </ul>"
"MessageTag$Value": "<p>The value of the tag. The value must:</p> <ul> <li> <p>This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).</p> </li> <li> <p>Contain less than 256 characters.</p> </li> </ul>"
}
},
"MissingRenderingAttributeException": {
@ -1172,12 +1268,14 @@
"refs": {
"ListConfigurationSetsRequest$NextToken": "<p>A token returned from a previous call to <code>ListConfigurationSets</code> to indicate the position of the configuration set in the configuration set list.</p>",
"ListConfigurationSetsResponse$NextToken": "<p>A token indicating that there are additional configuration sets available to be listed. Pass this token to successive calls of <code>ListConfigurationSets</code>. </p>",
"ListCustomVerificationEmailTemplatesRequest$NextToken": "<p>An array the contains the name and creation time stamp for each template in your Amazon SES account.</p>",
"ListCustomVerificationEmailTemplatesResponse$NextToken": "<p>A token indicating that there are additional custom verification email templates available to be listed. Pass this token to a subsequent call to <code>ListTemplates</code> to retrieve the next 50 custom verification email templates.</p>",
"ListIdentitiesRequest$NextToken": "<p>The token to use for pagination.</p>",
"ListIdentitiesResponse$NextToken": "<p>The token used for pagination.</p>",
"ListReceiptRuleSetsRequest$NextToken": "<p>A token returned from a previous call to <code>ListReceiptRuleSets</code> to indicate the position in the receipt rule set list.</p>",
"ListReceiptRuleSetsResponse$NextToken": "<p>A token indicating that there are additional receipt rule sets available to be listed. Pass this token to successive calls of <code>ListReceiptRuleSets</code> to retrieve up to 100 receipt rule sets at a time.</p>",
"ListTemplatesRequest$NextToken": "<p>The token to use for pagination.</p>",
"ListTemplatesResponse$NextToken": "<p>The token to use for pagination.</p>"
"ListTemplatesRequest$NextToken": "<p>A token returned from a previous call to <code>ListTemplates</code> to indicate the position in the list of email templates.</p>",
"ListTemplatesResponse$NextToken": "<p>A token indicating that there are additional email templates available to be listed. Pass this token to a subsequent call to <code>ListTemplates</code> to retrieve the next 50 email templates.</p>"
}
},
"NotificationAttributes": {
@ -1231,6 +1329,11 @@
"ListIdentityPoliciesResponse$PolicyNames": "<p>A list of names of policies that apply to the specified identity.</p>"
}
},
"ProductionAccessNotGrantedException": {
"base": "<p>Indicates that the account has not been granted production access.</p>",
"refs": {
}
},
"PutIdentityPolicyRequest": {
"base": "<p>Represents a request to add or update a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization.html\">Amazon SES Developer Guide</a>.</p>",
"refs": {
@ -1282,7 +1385,7 @@
"base": null,
"refs": {
"DeleteReceiptFilterRequest$FilterName": "<p>The name of the IP address filter to delete.</p>",
"ReceiptFilter$Name": "<p>The name of the IP address filter. The name must:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).</p> </li> <li> <p>Start and end with a letter or number.</p> </li> <li> <p>Contain less than 64 characters.</p> </li> </ul>"
"ReceiptFilter$Name": "<p>The name of the IP address filter. The name must:</p> <ul> <li> <p>This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).</p> </li> <li> <p>Start and end with a letter or number.</p> </li> <li> <p>Contain less than 64 characters.</p> </li> </ul>"
}
},
"ReceiptFilterPolicy": {
@ -1312,7 +1415,7 @@
"CreateReceiptRuleRequest$After": "<p>The name of an existing rule after which the new rule will be placed. If this parameter is null, the new rule will be inserted at the beginning of the rule list.</p>",
"DeleteReceiptRuleRequest$RuleName": "<p>The name of the receipt rule to delete.</p>",
"DescribeReceiptRuleRequest$RuleName": "<p>The name of the receipt rule.</p>",
"ReceiptRule$Name": "<p>The name of the receipt rule. The name must:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).</p> </li> <li> <p>Start and end with a letter or number.</p> </li> <li> <p>Contain less than 64 characters.</p> </li> </ul>",
"ReceiptRule$Name": "<p>The name of the receipt rule. The name must:</p> <ul> <li> <p>This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).</p> </li> <li> <p>Start and end with a letter or number.</p> </li> <li> <p>Contain less than 64 characters.</p> </li> </ul>",
"ReceiptRuleNamesList$member": null,
"SetReceiptRulePositionRequest$RuleName": "<p>The name of the receipt rule to reposition.</p>",
"SetReceiptRulePositionRequest$After": "<p>The name of the receipt rule after which to place the specified receipt rule.</p>"
@ -1335,15 +1438,15 @@
"ReceiptRuleSetName": {
"base": null,
"refs": {
"CloneReceiptRuleSetRequest$RuleSetName": "<p>The name of the rule set to create. The name must:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).</p> </li> <li> <p>Start and end with a letter or number.</p> </li> <li> <p>Contain less than 64 characters.</p> </li> </ul>",
"CloneReceiptRuleSetRequest$RuleSetName": "<p>The name of the rule set to create. The name must:</p> <ul> <li> <p>This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).</p> </li> <li> <p>Start and end with a letter or number.</p> </li> <li> <p>Contain less than 64 characters.</p> </li> </ul>",
"CloneReceiptRuleSetRequest$OriginalRuleSetName": "<p>The name of the rule set to clone.</p>",
"CreateReceiptRuleRequest$RuleSetName": "<p>The name of the rule set that the receipt rule will be added to.</p>",
"CreateReceiptRuleSetRequest$RuleSetName": "<p>The name of the rule set to create. The name must:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).</p> </li> <li> <p>Start and end with a letter or number.</p> </li> <li> <p>Contain less than 64 characters.</p> </li> </ul>",
"CreateReceiptRuleSetRequest$RuleSetName": "<p>The name of the rule set to create. The name must:</p> <ul> <li> <p>This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).</p> </li> <li> <p>Start and end with a letter or number.</p> </li> <li> <p>Contain less than 64 characters.</p> </li> </ul>",
"DeleteReceiptRuleRequest$RuleSetName": "<p>The name of the receipt rule set that contains the receipt rule to delete.</p>",
"DeleteReceiptRuleSetRequest$RuleSetName": "<p>The name of the receipt rule set to delete.</p>",
"DescribeReceiptRuleRequest$RuleSetName": "<p>The name of the receipt rule set that the receipt rule belongs to.</p>",
"DescribeReceiptRuleSetRequest$RuleSetName": "<p>The name of the receipt rule set to describe.</p>",
"ReceiptRuleSetMetadata$Name": "<p>The name of the receipt rule set. The name must:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-).</p> </li> <li> <p>Start and end with a letter or number.</p> </li> <li> <p>Contain less than 64 characters.</p> </li> </ul>",
"ReceiptRuleSetMetadata$Name": "<p>The name of the receipt rule set. The name must:</p> <ul> <li> <p>This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).</p> </li> <li> <p>Start and end with a letter or number.</p> </li> <li> <p>Contain less than 64 characters.</p> </li> </ul>",
"ReorderReceiptRuleSetRequest$RuleSetName": "<p>The name of the receipt rule set to reorder.</p>",
"SetActiveReceiptRuleSetRequest$RuleSetName": "<p>The name of the receipt rule set to make active. Setting this value to null disables all email receiving.</p>",
"SetReceiptRulePositionRequest$RuleSetName": "<p>The name of the receipt rule set that contains the receipt rule to reposition.</p>",
@ -1491,6 +1594,16 @@
"refs": {
}
},
"SendCustomVerificationEmailRequest": {
"base": "<p>Represents a request to send a custom verification email to a specified recipient.</p>",
"refs": {
}
},
"SendCustomVerificationEmailResponse": {
"base": "<p>The response received when attempting to send the custom verification email.</p>",
"refs": {
}
},
"SendDataPoint": {
"base": "<p>Represents sending statistics data. Each <code>SendDataPoint</code> contains statistics for a 15-minute period of sending activity. </p>",
"refs": {
@ -1621,12 +1734,30 @@
"StopAction$Scope": "<p>The name of the RuleSet that is being stopped.</p>"
}
},
"Subject": {
"base": null,
"refs": {
"CreateCustomVerificationEmailTemplateRequest$TemplateSubject": "<p>The subject line of the custom verification email.</p>",
"CustomVerificationEmailTemplate$TemplateSubject": "<p>The subject line of the custom verification email.</p>",
"GetCustomVerificationEmailTemplateResponse$TemplateSubject": "<p>The subject line of the custom verification email.</p>",
"UpdateCustomVerificationEmailTemplateRequest$TemplateSubject": "<p>The subject line of the custom verification email.</p>"
}
},
"SubjectPart": {
"base": null,
"refs": {
"Template$SubjectPart": "<p>The subject line of the email.</p>"
}
},
"SuccessRedirectionURL": {
"base": null,
"refs": {
"CreateCustomVerificationEmailTemplateRequest$SuccessRedirectionURL": "<p>The URL that the recipient of the verification email is sent to if his or her address is successfully verified.</p>",
"CustomVerificationEmailTemplate$SuccessRedirectionURL": "<p>The URL that the recipient of the verification email is sent to if his or her address is successfully verified.</p>",
"GetCustomVerificationEmailTemplateResponse$SuccessRedirectionURL": "<p>The URL that the recipient of the verification email is sent to if his or her address is successfully verified.</p>",
"UpdateCustomVerificationEmailTemplateRequest$SuccessRedirectionURL": "<p>The URL that the recipient of the verification email is sent to if his or her address is successfully verified.</p>"
}
},
"Template": {
"base": "<p>The content of the email, composed of a subject line, an HTML part, and a text-only part.</p>",
"refs": {
@ -1635,6 +1766,14 @@
"UpdateTemplateRequest$Template": null
}
},
"TemplateContent": {
"base": null,
"refs": {
"CreateCustomVerificationEmailTemplateRequest$TemplateContent": "<p>The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html#custom-verification-emails-faq\">Custom Verification Email Frequently Asked Questions</a> in the <i>Amazon SES Developer Guide</i>.</p>",
"GetCustomVerificationEmailTemplateResponse$TemplateContent": "<p>The content of the custom verification email.</p>",
"UpdateCustomVerificationEmailTemplateRequest$TemplateContent": "<p>The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/custom-verification-emails.html#custom-verification-emails-faq\">Custom Verification Email Frequently Asked Questions</a> in the <i>Amazon SES Developer Guide</i>.</p>"
}
},
"TemplateData": {
"base": null,
"refs": {
@ -1650,7 +1789,7 @@
}
},
"TemplateMetadata": {
"base": "<p>Information about an email template.</p>",
"base": "<p>Contains information about an email template.</p>",
"refs": {
"TemplateMetadataList$member": null
}
@ -1658,23 +1797,32 @@
"TemplateMetadataList": {
"base": null,
"refs": {
"ListTemplatesResponse$TemplatesMetadata": "<p>An array the contains the name of creation time stamp for each template in your Amazon SES account.</p>"
"ListTemplatesResponse$TemplatesMetadata": "<p>An array the contains the name and creation time stamp for each template in your Amazon SES account.</p>"
}
},
"TemplateName": {
"base": null,
"refs": {
"CreateCustomVerificationEmailTemplateRequest$TemplateName": "<p>The name of the custom verification email template.</p>",
"CustomVerificationEmailTemplate$TemplateName": "<p>The name of the custom verification email template.</p>",
"CustomVerificationEmailTemplateAlreadyExistsException$CustomVerificationEmailTemplateName": "<p>Indicates that the provided custom verification email template with the specified template name already exists.</p>",
"CustomVerificationEmailTemplateDoesNotExistException$CustomVerificationEmailTemplateName": "<p>Indicates that the provided custom verification email template does not exist.</p>",
"DeleteCustomVerificationEmailTemplateRequest$TemplateName": "<p>The name of the custom verification email template that you want to delete.</p>",
"DeleteTemplateRequest$TemplateName": "<p>The name of the template to be deleted.</p>",
"GetCustomVerificationEmailTemplateRequest$TemplateName": "<p>The name of the custom verification email template that you want to retrieve.</p>",
"GetCustomVerificationEmailTemplateResponse$TemplateName": "<p>The name of the custom verification email template.</p>",
"GetTemplateRequest$TemplateName": "<p>The name of the template you want to retrieve.</p>",
"InvalidRenderingParameterException$TemplateName": null,
"InvalidTemplateException$TemplateName": null,
"MissingRenderingAttributeException$TemplateName": null,
"SendBulkTemplatedEmailRequest$Template": "<p>The template to use when sending this email.</p>",
"SendCustomVerificationEmailRequest$TemplateName": "<p>The name of the custom verification email template to use when sending the verification email.</p>",
"SendTemplatedEmailRequest$Template": "<p>The template to use when sending this email.</p>",
"Template$TemplateName": "<p>The name of the template. You will refer to this name when you send email using the <code>SendTemplatedEmail</code> or <code>SendBulkTemplatedEmail</code> operations.</p>",
"TemplateDoesNotExistException$TemplateName": null,
"TemplateMetadata$Name": "<p>The name of the template.</p>",
"TestRenderTemplateRequest$TemplateName": "<p>The name of the template that you want to render.</p>"
"TestRenderTemplateRequest$TemplateName": "<p>The name of the template that you want to render.</p>",
"UpdateCustomVerificationEmailTemplateRequest$TemplateName": "<p>The name of the custom verification email template that you want to update.</p>"
}
},
"TestRenderTemplateRequest": {
@ -1760,6 +1908,11 @@
"refs": {
}
},
"UpdateCustomVerificationEmailTemplateRequest": {
"base": "<p>Represents a request to update an existing custom verification email template.</p>",
"refs": {
}
},
"UpdateReceiptRuleRequest": {
"base": "<p>Represents a request to update a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the <a href=\"http://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-concepts.html\">Amazon SES Developer Guide</a>.</p>",
"refs": {

View file

@ -1,5 +1,10 @@
{
"pagination": {
"ListCustomVerificationEmailTemplates": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken"
},
"ListIdentities": {
"input_token": "NextToken",
"limit_key": "MaxItems",

View file

@ -288,6 +288,7 @@
"AccessPolicies":{"shape":"PolicyDocument"},
"SnapshotOptions":{"shape":"SnapshotOptions"},
"VPCOptions":{"shape":"VPCOptions"},
"EncryptionAtRestOptions":{"shape":"EncryptionAtRestOptions"},
"AdvancedOptions":{"shape":"AdvancedOptions"},
"LogPublishingOptions":{"shape":"LogPublishingOptions"}
}
@ -523,6 +524,7 @@
"AccessPolicies":{"shape":"AccessPoliciesStatus"},
"SnapshotOptions":{"shape":"SnapshotOptionsStatus"},
"VPCOptions":{"shape":"VPCDerivedInfoStatus"},
"EncryptionAtRestOptions":{"shape":"EncryptionAtRestOptionsStatus"},
"AdvancedOptions":{"shape":"AdvancedOptionsStatus"},
"LogPublishingOptions":{"shape":"LogPublishingOptionsStatus"}
}
@ -550,6 +552,7 @@
"AccessPolicies":{"shape":"PolicyDocument"},
"SnapshotOptions":{"shape":"SnapshotOptions"},
"VPCOptions":{"shape":"VPCDerivedInfo"},
"EncryptionAtRestOptions":{"shape":"EncryptionAtRestOptions"},
"AdvancedOptions":{"shape":"AdvancedOptions"},
"LogPublishingOptions":{"shape":"LogPublishingOptions"}
}
@ -578,6 +581,24 @@
}
},
"ElasticsearchVersionString":{"type":"string"},
"EncryptionAtRestOptions":{
"type":"structure",
"members":{
"Enabled":{"shape":"Boolean"},
"KmsKeyId":{"shape":"KmsKeyId"}
}
},
"EncryptionAtRestOptionsStatus":{
"type":"structure",
"required":[
"Options",
"Status"
],
"members":{
"Options":{"shape":"EncryptionAtRestOptions"},
"Status":{"shape":"OptionStatus"}
}
},
"EndpointsMap":{
"type":"map",
"key":{"shape":"String"},
@ -613,6 +634,11 @@
"error":{"httpStatusCode":409},
"exception":true
},
"KmsKeyId":{
"type":"string",
"max":500,
"min":1
},
"LimitExceededException":{
"type":"structure",
"members":{

View file

@ -79,6 +79,7 @@
"ElasticsearchDomainStatus$Created": "<p>The domain creation status. <code>True</code> if the creation of an Elasticsearch domain is complete. <code>False</code> if domain creation is still in progress.</p>",
"ElasticsearchDomainStatus$Deleted": "<p>The domain deletion status. <code>True</code> if a delete request has been received for the domain but resource cleanup is still in progress. <code>False</code> if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.</p>",
"ElasticsearchDomainStatus$Processing": "<p>The status of the Elasticsearch domain configuration. <code>True</code> if Amazon Elasticsearch Service is processing configuration changes. <code>False</code> if the configuration is active.</p>",
"EncryptionAtRestOptions$Enabled": "<p>Specifies the option to enable Encryption At Rest.</p>",
"LogPublishingOption$Enabled": "<p> Specifies whether given log publishing option is enabled or not.</p>",
"OptionStatus$PendingDeletion": "<p>Indicates whether the Elasticsearch domain is being deleted.</p>"
}
@ -283,6 +284,20 @@
"ListElasticsearchInstanceTypesRequest$ElasticsearchVersion": "<p>Version of Elasticsearch for which list of supported elasticsearch instance types are needed. </p>"
}
},
"EncryptionAtRestOptions": {
"base": "<p>Specifies the Encryption At Rest Options.</p>",
"refs": {
"CreateElasticsearchDomainRequest$EncryptionAtRestOptions": "<p>Specifies the Encryption At Rest Options.</p>",
"ElasticsearchDomainStatus$EncryptionAtRestOptions": "<p> Specifies the status of the <code>EncryptionAtRestOptions</code>.</p>",
"EncryptionAtRestOptionsStatus$Options": "<p> Specifies the Encryption At Rest options for the specified Elasticsearch domain.</p>"
}
},
"EncryptionAtRestOptionsStatus": {
"base": "<p> Status of the Encryption At Rest options for the specified Elasticsearch domain.</p>",
"refs": {
"ElasticsearchDomainConfig$EncryptionAtRestOptions": "<p>Specifies the <code>EncryptionAtRestOptions</code> for the Elasticsearch domain.</p>"
}
},
"EndpointsMap": {
"base": null,
"refs": {
@ -333,6 +348,12 @@
"refs": {
}
},
"KmsKeyId": {
"base": null,
"refs": {
"EncryptionAtRestOptions$KmsKeyId": "<p> Specifies the KMS Key ID for Encryption At Rest options.</p>"
}
},
"LimitExceededException": {
"base": "<p>An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.</p>",
"refs": {
@ -474,6 +495,7 @@
"EBSOptionsStatus$Status": "<p> Specifies the status of the EBS options for the specified Elasticsearch domain.</p>",
"ElasticsearchClusterConfigStatus$Status": "<p> Specifies the status of the configuration for the specified Elasticsearch domain.</p>",
"ElasticsearchVersionStatus$Status": "<p> Specifies the status of the Elasticsearch version options for the specified Elasticsearch domain.</p>",
"EncryptionAtRestOptionsStatus$Status": "<p> Specifies the status of the Encryption At Rest options for the specified Elasticsearch domain.</p>",
"LogPublishingOptionsStatus$Status": "<p>The status of the log publishing options for the Elasticsearch domain. See <code>OptionStatus</code> for the status information that's included. </p>",
"SnapshotOptionsStatus$Status": "<p>Specifies the status of a daily automated snapshot.</p>",
"VPCDerivedInfoStatus$Status": "<p> Specifies the status of the VPC options for the specified Elasticsearch domain.</p>"

View file

@ -576,7 +576,8 @@
"type":"string",
"enum":[
"HEALTHY",
"UNHEALTHY"
"UNHEALTHY",
"UNKNOWN"
]
},
"AgentHealthCode":{
@ -617,8 +618,14 @@
"type":"structure",
"required":["agentId"],
"members":{
"hostname":{"shape":"Hostname"},
"agentId":{"shape":"AgentId"},
"autoScalingGroup":{"shape":"AutoScalingGroup"}
"autoScalingGroup":{"shape":"AutoScalingGroup"},
"agentHealth":{"shape":"AgentHealth"},
"agentVersion":{"shape":"AgentVersion"},
"operatingSystem":{"shape":"OperatingSystem"},
"kernelVersion":{"shape":"KernelVersion"},
"ipv4Address":{"shape":"Ipv4Address"}
}
},
"AgentPreviewList":{
@ -627,6 +634,11 @@
"max":100,
"min":0
},
"AgentVersion":{
"type":"string",
"max":128,
"min":1
},
"AgentsAlreadyRunningAssessmentException":{
"type":"structure",
"required":[
@ -1482,6 +1494,11 @@
"max":50,
"min":0
},
"KernelVersion":{
"type":"string",
"max":128,
"min":1
},
"LimitExceededErrorCode":{
"type":"string",
"enum":[
@ -1706,6 +1723,11 @@
"type":"integer",
"min":0
},
"OperatingSystem":{
"type":"string",
"max":256,
"min":1
},
"PaginationToken":{
"type":"string",
"max":300,

View file

@ -3,8 +3,8 @@
"service": "<fullname>Amazon Inspector</fullname> <p>Amazon Inspector enables you to analyze the behavior of your AWS resources and to identify potential security issues. For more information, see <a href=\"http://docs.aws.amazon.com/inspector/latest/userguide/inspector_introduction.html\"> Amazon Inspector User Guide</a>.</p>",
"operations": {
"AddAttributesToFindings": "<p>Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.</p>",
"CreateAssessmentTarget": "<p>Creates a new assessment target using the ARN of the resource group that is generated by <a>CreateResourceGroup</a>. You can create up to 50 assessment targets per AWS account. You can run up to 500 concurrent agents per AWS account. For more information, see <a href=\"http://docs.aws.amazon.com/inspector/latest/userguide/inspector_applications.html\"> Amazon Inspector Assessment Targets</a>.</p>",
"CreateAssessmentTemplate": "<p>Creates an assessment template for the assessment target that is specified by the ARN of the assessment target.</p>",
"CreateAssessmentTarget": "<p>Creates a new assessment target using the ARN of the resource group that is generated by <a>CreateResourceGroup</a>. If the <a href=\"https://docs.aws.amazon.com/inspector/latest/userguide/inspector_slr.html\">service-linked role</a> isnt already registered, also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments. You can create up to 50 assessment targets per AWS account. You can run up to 500 concurrent agents per AWS account. For more information, see <a href=\"http://docs.aws.amazon.com/inspector/latest/userguide/inspector_applications.html\"> Amazon Inspector Assessment Targets</a>.</p>",
"CreateAssessmentTemplate": "<p>Creates an assessment template for the assessment target that is specified by the ARN of the assessment target. If the <a href=\"https://docs.aws.amazon.com/inspector/latest/userguide/inspector_slr.html\">service-linked role</a> isnt already registered, also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments.</p>",
"CreateResourceGroup": "<p>Creates a resource group using the specified set of tags (key and value pairs) that are used to select the EC2 instances to be included in an Amazon Inspector assessment target. The created resource group is then used to create an Amazon Inspector assessment target. For more information, see <a>CreateAssessmentTarget</a>.</p>",
"DeleteAssessmentRun": "<p>Deletes the assessment run that is specified by the ARN of the assessment run.</p>",
"DeleteAssessmentTarget": "<p>Deletes the assessment target that is specified by the ARN of the assessment target.</p>",
@ -27,7 +27,7 @@
"ListRulesPackages": "<p>Lists all available Amazon Inspector rules packages.</p>",
"ListTagsForResource": "<p>Lists all tags associated with an assessment template.</p>",
"PreviewAgents": "<p>Previews the agents installed on the EC2 instances that are part of the specified assessment target.</p>",
"RegisterCrossAccountAccessRole": "<p>Registers the IAM role that Amazon Inspector uses to list your EC2 instances at the start of the assessment run or when you call the <a>PreviewAgents</a> action.</p>",
"RegisterCrossAccountAccessRole": "<p>Registers the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments.</p>",
"RemoveAttributesFromFindings": "<p>Removes entire attributes (key and value pairs) from the findings that are specified by the ARNs of the findings where an attribute with the specified key exists.</p>",
"SetTagsForResource": "<p>Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template.</p>",
"StartAssessmentRun": "<p>Starts the assessment run specified by the ARN of the assessment template. For this API to function properly, you must not exceed the limit of running up to 500 concurrent agents per AWS account.</p>",
@ -87,6 +87,7 @@
"base": null,
"refs": {
"AgentHealthList$member": null,
"AgentPreview$agentHealth": "<p>The health status of the Amazon Inspector Agent.</p>",
"AssessmentRunAgent$agentHealth": "<p>The current health state of the agent.</p>"
}
},
@ -137,6 +138,12 @@
"PreviewAgentsResponse$agentPreviews": "<p>The resulting list of agents.</p>"
}
},
"AgentVersion": {
"base": null,
"refs": {
"AgentPreview$agentVersion": "<p>The version of the Amazon Inspector Agent.</p>"
}
},
"AgentsAlreadyRunningAssessmentException": {
"base": "<p>You started an assessment run, but one of the instances is already participating in another assessment run.</p>",
"refs": {
@ -187,7 +194,7 @@
"ListReturnedArnList$member": null,
"ListTagsForResourceRequest$resourceArn": "<p>The ARN that specifies the assessment template whose tags you want to list.</p>",
"PreviewAgentsRequest$previewAgentsArn": "<p>The ARN of the assessment target whose agents you want to preview.</p>",
"RegisterCrossAccountAccessRoleRequest$roleArn": "<p>The ARN of the IAM role that Amazon Inspector uses to list your EC2 instances during the assessment run or when you call the <a>PreviewAgents</a> action. </p>",
"RegisterCrossAccountAccessRoleRequest$roleArn": "<p>The ARN of the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments. </p>",
"ResourceGroup$arn": "<p>The ARN of the resource group.</p>",
"RulesPackage$arn": "<p>The ARN of the rules package.</p>",
"SetTagsForResourceRequest$resourceArn": "<p>The ARN of the assessment template that you want to set tags to.</p>",
@ -692,6 +699,7 @@
"Hostname": {
"base": null,
"refs": {
"AgentPreview$hostname": "<p>The hostname of the EC2 instance on which the Amazon Inspector Agent is installed.</p>",
"AssetAttributes$hostname": "<p>The hostname of the EC2 instance where the finding is generated.</p>"
}
},
@ -746,6 +754,7 @@
"Ipv4Address": {
"base": null,
"refs": {
"AgentPreview$ipv4Address": "<p>The IP address of the EC2 instance on which the Amazon Inspector Agent is installed.</p>",
"Ipv4AddressList$member": null
}
},
@ -755,6 +764,12 @@
"AssetAttributes$ipv4Addresses": "<p>The list of IP v4 addresses of the EC2 instance where the finding is generated.</p>"
}
},
"KernelVersion": {
"base": null,
"refs": {
"AgentPreview$kernelVersion": "<p>The kernel version of the operating system running on the EC2 instance on which the Amazon Inspector Agent is installed.</p>"
}
},
"LimitExceededErrorCode": {
"base": null,
"refs": {
@ -941,6 +956,12 @@
"InspectorServiceAttributes$schemaVersion": "<p>The schema version of this data type.</p>"
}
},
"OperatingSystem": {
"base": null,
"refs": {
"AgentPreview$operatingSystem": "<p>The operating system running on the EC2 instance on which the Amazon Inspector Agent is installed.</p>"
}
},
"PaginationToken": {
"base": null,
"refs": {

View file

@ -227,6 +227,24 @@
{"shape":"InternalFailureException"}
]
},
"CreateOTAUpdate":{
"name":"CreateOTAUpdate",
"http":{
"method":"POST",
"requestUri":"/otaUpdates/{otaUpdateId}"
},
"input":{"shape":"CreateOTAUpdateRequest"},
"output":{"shape":"CreateOTAUpdateResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceAlreadyExistsException"},
{"shape":"ThrottlingException"},
{"shape":"UnauthorizedException"},
{"shape":"InternalFailureException"},
{"shape":"ServiceUnavailableException"}
]
},
"CreatePolicy":{
"name":"CreatePolicy",
"http":{
@ -282,6 +300,24 @@
{"shape":"InternalFailureException"}
]
},
"CreateStream":{
"name":"CreateStream",
"http":{
"method":"POST",
"requestUri":"/streams/{streamId}"
},
"input":{"shape":"CreateStreamRequest"},
"output":{"shape":"CreateStreamResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceAlreadyExistsException"},
{"shape":"ThrottlingException"},
{"shape":"UnauthorizedException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalFailureException"}
]
},
"CreateThing":{
"name":"CreateThing",
"http":{
@ -401,6 +437,23 @@
{"shape":"ResourceNotFoundException"}
]
},
"DeleteOTAUpdate":{
"name":"DeleteOTAUpdate",
"http":{
"method":"DELETE",
"requestUri":"/otaUpdates/{otaUpdateId}"
},
"input":{"shape":"DeleteOTAUpdateRequest"},
"output":{"shape":"DeleteOTAUpdateResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"UnauthorizedException"},
{"shape":"InternalFailureException"},
{"shape":"ServiceUnavailableException"}
]
},
"DeletePolicy":{
"name":"DeletePolicy",
"http":{
@ -469,6 +522,24 @@
{"shape":"ResourceNotFoundException"}
]
},
"DeleteStream":{
"name":"DeleteStream",
"http":{
"method":"DELETE",
"requestUri":"/streams/{streamId}"
},
"input":{"shape":"DeleteStreamRequest"},
"output":{"shape":"DeleteStreamResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"DeleteConflictException"},
{"shape":"InvalidRequestException"},
{"shape":"ThrottlingException"},
{"shape":"UnauthorizedException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalFailureException"}
]
},
"DeleteThing":{
"name":"DeleteThing",
"http":{
@ -723,6 +794,23 @@
{"shape":"ResourceNotFoundException"}
]
},
"DescribeStream":{
"name":"DescribeStream",
"http":{
"method":"GET",
"requestUri":"/streams/{streamId}"
},
"input":{"shape":"DescribeStreamRequest"},
"output":{"shape":"DescribeStreamResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"UnauthorizedException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalFailureException"}
]
},
"DescribeThing":{
"name":"DescribeThing",
"http":{
@ -929,6 +1017,23 @@
{"shape":"ServiceUnavailableException"}
]
},
"GetOTAUpdate":{
"name":"GetOTAUpdate",
"http":{
"method":"GET",
"requestUri":"/otaUpdates/{otaUpdateId}"
},
"input":{"shape":"GetOTAUpdateRequest"},
"output":{"shape":"GetOTAUpdateResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ThrottlingException"},
{"shape":"UnauthorizedException"},
{"shape":"InternalFailureException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ResourceNotFoundException"}
]
},
"GetPolicy":{
"name":"GetPolicy",
"http":{
@ -1151,6 +1256,22 @@
{"shape":"ServiceUnavailableException"}
]
},
"ListOTAUpdates":{
"name":"ListOTAUpdates",
"http":{
"method":"GET",
"requestUri":"/otaUpdates"
},
"input":{"shape":"ListOTAUpdatesRequest"},
"output":{"shape":"ListOTAUpdatesResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ThrottlingException"},
{"shape":"UnauthorizedException"},
{"shape":"InternalFailureException"},
{"shape":"ServiceUnavailableException"}
]
},
"ListOutgoingCertificates":{
"name":"ListOutgoingCertificates",
"http":{
@ -1269,6 +1390,22 @@
{"shape":"InternalFailureException"}
]
},
"ListStreams":{
"name":"ListStreams",
"http":{
"method":"GET",
"requestUri":"/streams"
},
"input":{"shape":"ListStreamsRequest"},
"output":{"shape":"ListStreamsResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ThrottlingException"},
{"shape":"UnauthorizedException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalFailureException"}
]
},
"ListTargetsForPolicy":{
"name":"ListTargetsForPolicy",
"http":{
@ -1818,6 +1955,23 @@
{"shape":"InternalFailureException"}
]
},
"UpdateStream":{
"name":"UpdateStream",
"http":{
"method":"PUT",
"requestUri":"/streams/{streamId}"
},
"input":{"shape":"UpdateStreamRequest"},
"output":{"shape":"UpdateStreamResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"UnauthorizedException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InternalFailureException"}
]
},
"UpdateThing":{
"name":"UpdateThing",
"http":{
@ -1932,6 +2086,11 @@
"members":{
}
},
"AdditionalParameterMap":{
"type":"map",
"key":{"shape":"Key"},
"value":{"shape":"Value"}
},
"AlarmName":{"type":"string"},
"AllowAutoRegistration":{"type":"boolean"},
"Allowed":{
@ -2045,6 +2204,11 @@
"key":{"shape":"AttributeName"},
"value":{"shape":"AttributeValue"}
},
"AttributesMap":{
"type":"map",
"key":{"shape":"Key"},
"value":{"shape":"Value"}
},
"AuthDecision":{
"type":"string",
"enum":[
@ -2131,6 +2295,8 @@
"pattern":"[0-9]{12}"
},
"AwsArn":{"type":"string"},
"AwsIotJobArn":{"type":"string"},
"AwsIotJobId":{"type":"string"},
"AwsIotSqlVersion":{"type":"string"},
"Boolean":{"type":"boolean"},
"BucketName":{"type":"string"},
@ -2250,6 +2416,7 @@
"min":64,
"pattern":"(0x)?[a-fA-F0-9]+"
},
"CertificateName":{"type":"string"},
"CertificatePem":{
"type":"string",
"max":65536,
@ -2334,6 +2501,29 @@
"metricTimestamp":{"shape":"MetricTimestamp"}
}
},
"Code":{"type":"string"},
"CodeSigning":{
"type":"structure",
"members":{
"awsSignerJobId":{"shape":"SigningJobId"},
"customCodeSigning":{"shape":"CustomCodeSigning"}
}
},
"CodeSigningCertificateChain":{
"type":"structure",
"members":{
"stream":{"shape":"Stream"},
"certificateName":{"shape":"CertificateName"},
"inlineDocument":{"shape":"InlineDocument"}
}
},
"CodeSigningSignature":{
"type":"structure",
"members":{
"stream":{"shape":"Stream"},
"inlineDocument":{"shape":"Signature"}
}
},
"CognitoIdentityPoolId":{"type":"string"},
"Comment":{
"type":"string",
@ -2451,6 +2641,38 @@
"keyPair":{"shape":"KeyPair"}
}
},
"CreateOTAUpdateRequest":{
"type":"structure",
"required":[
"otaUpdateId",
"targets",
"files",
"roleArn"
],
"members":{
"otaUpdateId":{
"shape":"OTAUpdateId",
"location":"uri",
"locationName":"otaUpdateId"
},
"description":{"shape":"OTAUpdateDescription"},
"targets":{"shape":"Targets"},
"targetSelection":{"shape":"TargetSelection"},
"files":{"shape":"OTAUpdateFiles"},
"roleArn":{"shape":"RoleArn"},
"additionalParameters":{"shape":"AdditionalParameterMap"}
}
},
"CreateOTAUpdateResponse":{
"type":"structure",
"members":{
"otaUpdateId":{"shape":"OTAUpdateId"},
"awsIotJobId":{"shape":"AwsIotJobId"},
"otaUpdateArn":{"shape":"OTAUpdateArn"},
"awsIotJobArn":{"shape":"AwsIotJobArn"},
"otaUpdateStatus":{"shape":"OTAUpdateStatus"}
}
},
"CreatePolicyRequest":{
"type":"structure",
"required":[
@ -2527,6 +2749,33 @@
"roleAliasArn":{"shape":"RoleAliasArn"}
}
},
"CreateStreamRequest":{
"type":"structure",
"required":[
"streamId",
"files",
"roleArn"
],
"members":{
"streamId":{
"shape":"StreamId",
"location":"uri",
"locationName":"streamId"
},
"description":{"shape":"StreamDescription"},
"files":{"shape":"StreamFiles"},
"roleArn":{"shape":"RoleArn"}
}
},
"CreateStreamResponse":{
"type":"structure",
"members":{
"streamId":{"shape":"StreamId"},
"streamArn":{"shape":"StreamArn"},
"description":{"shape":"StreamDescription"},
"streamVersion":{"shape":"StreamVersion"}
}
},
"CreateThingGroupRequest":{
"type":"structure",
"required":["thingGroupName"],
@ -2612,6 +2861,15 @@
"max":3600,
"min":900
},
"CustomCodeSigning":{
"type":"structure",
"members":{
"signature":{"shape":"CodeSigningSignature"},
"certificateChain":{"shape":"CodeSigningCertificateChain"},
"hashAlgorithm":{"shape":"HashAlgorithm"},
"signatureAlgorithm":{"shape":"SignatureAlgorithm"}
}
},
"DateType":{"type":"timestamp"},
"DeleteAuthorizerRequest":{
"type":"structure",
@ -2669,6 +2927,22 @@
"error":{"httpStatusCode":409},
"exception":true
},
"DeleteOTAUpdateRequest":{
"type":"structure",
"required":["otaUpdateId"],
"members":{
"otaUpdateId":{
"shape":"OTAUpdateId",
"location":"uri",
"locationName":"otaUpdateId"
}
}
},
"DeleteOTAUpdateResponse":{
"type":"structure",
"members":{
}
},
"DeletePolicyRequest":{
"type":"structure",
"required":["policyName"],
@ -2725,6 +2999,22 @@
"members":{
}
},
"DeleteStreamRequest":{
"type":"structure",
"required":["streamId"],
"members":{
"streamId":{
"shape":"StreamId",
"location":"uri",
"locationName":"streamId"
}
}
},
"DeleteStreamResponse":{
"type":"structure",
"members":{
}
},
"DeleteThingGroupRequest":{
"type":"structure",
"required":["thingGroupName"],
@ -3015,6 +3305,23 @@
"roleAliasDescription":{"shape":"RoleAliasDescription"}
}
},
"DescribeStreamRequest":{
"type":"structure",
"required":["streamId"],
"members":{
"streamId":{
"shape":"StreamId",
"location":"uri",
"locationName":"streamId"
}
}
},
"DescribeStreamResponse":{
"type":"structure",
"members":{
"streamInfo":{"shape":"StreamInfo"}
}
},
"DescribeThingGroupRequest":{
"type":"structure",
"required":["thingGroupName"],
@ -3283,6 +3590,13 @@
"Enabled":{"type":"boolean"},
"EndpointAddress":{"type":"string"},
"EndpointType":{"type":"string"},
"ErrorInfo":{
"type":"structure",
"members":{
"code":{"shape":"Code"},
"message":{"shape":"OTAUpdateErrorMessage"}
}
},
"ErrorMessage":{
"type":"string",
"max":2048
@ -3318,6 +3632,12 @@
}
},
"FailedThings":{"type":"integer"},
"FileId":{
"type":"integer",
"max":255,
"min":0
},
"FileName":{"type":"string"},
"FirehoseAction":{
"type":"structure",
"required":[
@ -3400,6 +3720,23 @@
"logLevel":{"shape":"LogLevel"}
}
},
"GetOTAUpdateRequest":{
"type":"structure",
"required":["otaUpdateId"],
"members":{
"otaUpdateId":{
"shape":"OTAUpdateId",
"location":"uri",
"locationName":"otaUpdateId"
}
}
},
"GetOTAUpdateResponse":{
"type":"structure",
"members":{
"otaUpdateInfo":{"shape":"OTAUpdateInfo"}
}
},
"GetPolicyRequest":{
"type":"structure",
"required":["policyName"],
@ -3498,6 +3835,7 @@
"groupArn":{"shape":"ThingGroupArn"}
}
},
"HashAlgorithm":{"type":"string"},
"HashKeyField":{"type":"string"},
"HashKeyValue":{"type":"string"},
"ImplicitDeny":{
@ -3534,6 +3872,7 @@
"REBUILDING"
]
},
"InlineDocument":{"type":"string"},
"InternalException":{
"type":"structure",
"members":{
@ -4071,6 +4410,33 @@
"nextToken":{"shape":"NextToken"}
}
},
"ListOTAUpdatesRequest":{
"type":"structure",
"members":{
"maxResults":{
"shape":"MaxResults",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"NextToken",
"location":"querystring",
"locationName":"nextToken"
},
"otaUpdateStatus":{
"shape":"OTAUpdateStatus",
"location":"querystring",
"locationName":"otaUpdateStatus"
}
}
},
"ListOTAUpdatesResponse":{
"type":"structure",
"members":{
"otaUpdates":{"shape":"OTAUpdatesSummary"},
"nextToken":{"shape":"NextToken"}
}
},
"ListOutgoingCertificatesRequest":{
"type":"structure",
"members":{
@ -4263,6 +4629,33 @@
"nextMarker":{"shape":"Marker"}
}
},
"ListStreamsRequest":{
"type":"structure",
"members":{
"maxResults":{
"shape":"MaxResults",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"NextToken",
"location":"querystring",
"locationName":"nextToken"
},
"ascendingOrder":{
"shape":"AscendingOrder",
"location":"querystring",
"locationName":"isAscendingOrder"
}
}
},
"ListStreamsResponse":{
"type":"structure",
"members":{
"streams":{"shape":"StreamsSummary"},
"nextToken":{"shape":"NextToken"}
}
},
"ListTargetsForPolicyRequest":{
"type":"structure",
"required":["policyName"],
@ -4655,6 +5048,11 @@
"max":1000,
"min":1
},
"MaxResults":{
"type":"integer",
"max":250,
"min":1
},
"Message":{
"type":"string",
"max":128
@ -4685,6 +5083,75 @@
"error":{"httpStatusCode":404},
"exception":true
},
"OTAUpdateArn":{"type":"string"},
"OTAUpdateDescription":{
"type":"string",
"max":2028,
"pattern":"[^\\p{C}]+"
},
"OTAUpdateErrorMessage":{"type":"string"},
"OTAUpdateFile":{
"type":"structure",
"members":{
"fileName":{"shape":"FileName"},
"fileVersion":{"shape":"OTAUpdateFileVersion"},
"fileSource":{"shape":"Stream"},
"codeSigning":{"shape":"CodeSigning"},
"attributes":{"shape":"AttributesMap"}
}
},
"OTAUpdateFileVersion":{"type":"string"},
"OTAUpdateFiles":{
"type":"list",
"member":{"shape":"OTAUpdateFile"},
"max":10,
"min":1
},
"OTAUpdateId":{
"type":"string",
"max":128,
"min":1,
"pattern":"[a-zA-Z0-9_-]+"
},
"OTAUpdateInfo":{
"type":"structure",
"members":{
"otaUpdateId":{"shape":"OTAUpdateId"},
"otaUpdateArn":{"shape":"OTAUpdateArn"},
"creationDate":{"shape":"DateType"},
"lastModifiedDate":{"shape":"DateType"},
"description":{"shape":"OTAUpdateDescription"},
"targets":{"shape":"Targets"},
"targetSelection":{"shape":"TargetSelection"},
"otaUpdateFiles":{"shape":"OTAUpdateFiles"},
"otaUpdateStatus":{"shape":"OTAUpdateStatus"},
"awsIotJobId":{"shape":"AwsIotJobId"},
"awsIotJobArn":{"shape":"AwsIotJobArn"},
"errorInfo":{"shape":"ErrorInfo"},
"additionalParameters":{"shape":"AdditionalParameterMap"}
}
},
"OTAUpdateStatus":{
"type":"string",
"enum":[
"CREATE_PENDING",
"CREATE_IN_PROGRESS",
"CREATE_COMPLETE",
"CREATE_FAILED"
]
},
"OTAUpdateSummary":{
"type":"structure",
"members":{
"otaUpdateId":{"shape":"OTAUpdateId"},
"otaUpdateArn":{"shape":"OTAUpdateArn"},
"creationDate":{"shape":"DateType"}
}
},
"OTAUpdatesSummary":{
"type":"list",
"member":{"shape":"OTAUpdateSummary"}
},
"OptionalVersion":{"type":"long"},
"OutgoingCertificate":{
"type":"structure",
@ -5095,6 +5562,10 @@
"cannedAcl":{"shape":"CannedAccessControlList"}
}
},
"S3Bucket":{
"type":"string",
"min":1
},
"S3FileUrl":{
"type":"string",
"max":65535
@ -5103,6 +5574,23 @@
"type":"list",
"member":{"shape":"S3FileUrl"}
},
"S3Key":{
"type":"string",
"min":1
},
"S3Location":{
"type":"structure",
"required":[
"bucket",
"key"
],
"members":{
"bucket":{"shape":"S3Bucket"},
"key":{"shape":"S3Key"},
"version":{"shape":"S3Version"}
}
},
"S3Version":{"type":"string"},
"SQL":{"type":"string"},
"SalesforceAction":{
"type":"structure",
@ -5219,6 +5707,9 @@
"disableAllLogs":{"shape":"DisableAllLogs"}
}
},
"Signature":{"type":"blob"},
"SignatureAlgorithm":{"type":"string"},
"SigningJobId":{"type":"string"},
"SkyfallMaxResults":{
"type":"integer",
"max":250,
@ -5305,9 +5796,73 @@
"members":{
}
},
"Stream":{
"type":"structure",
"members":{
"streamId":{"shape":"StreamId"},
"fileId":{"shape":"FileId"}
}
},
"StreamArn":{"type":"string"},
"StreamDescription":{
"type":"string",
"max":2028,
"pattern":"[^\\p{C}]+"
},
"StreamFile":{
"type":"structure",
"members":{
"fileId":{"shape":"FileId"},
"s3Location":{"shape":"S3Location"}
}
},
"StreamFiles":{
"type":"list",
"member":{"shape":"StreamFile"},
"max":10,
"min":1
},
"StreamId":{
"type":"string",
"max":128,
"min":1,
"pattern":"[a-zA-Z0-9_-]+"
},
"StreamInfo":{
"type":"structure",
"members":{
"streamId":{"shape":"StreamId"},
"streamArn":{"shape":"StreamArn"},
"streamVersion":{"shape":"StreamVersion"},
"description":{"shape":"StreamDescription"},
"files":{"shape":"StreamFiles"},
"createdAt":{"shape":"DateType"},
"lastUpdatedAt":{"shape":"DateType"},
"roleArn":{"shape":"RoleArn"}
}
},
"StreamName":{"type":"string"},
"StreamSummary":{
"type":"structure",
"members":{
"streamId":{"shape":"StreamId"},
"streamArn":{"shape":"StreamArn"},
"streamVersion":{"shape":"StreamVersion"},
"description":{"shape":"StreamDescription"}
}
},
"StreamVersion":{
"type":"integer",
"max":65535,
"min":0
},
"StreamsSummary":{
"type":"list",
"member":{"shape":"StreamSummary"}
},
"SucceededThings":{"type":"integer"},
"TableName":{"type":"string"},
"Target":{"type":"string"},
"TargetArn":{"type":"string"},
"TargetSelection":{
"type":"string",
@ -5316,6 +5871,11 @@
"SNAPSHOT"
]
},
"Targets":{
"type":"list",
"member":{"shape":"Target"},
"min":1
},
"TaskId":{
"type":"string",
"max":40
@ -5551,7 +6111,8 @@
"createdAt":{"shape":"CreatedAtDate"},
"actions":{"shape":"ActionList"},
"ruleDisabled":{"shape":"IsDisabled"},
"awsIotSqlVersion":{"shape":"AwsIotSqlVersion"}
"awsIotSqlVersion":{"shape":"AwsIotSqlVersion"},
"errorAction":{"shape":"Action"}
}
},
"TopicRuleList":{
@ -5579,7 +6140,8 @@
"description":{"shape":"Description"},
"actions":{"shape":"ActionList"},
"ruleDisabled":{"shape":"IsDisabled"},
"awsIotSqlVersion":{"shape":"AwsIotSqlVersion"}
"awsIotSqlVersion":{"shape":"AwsIotSqlVersion"},
"errorAction":{"shape":"Action"}
}
},
"TransferAlreadyCompletedException":{
@ -5749,6 +6311,29 @@
"roleAliasArn":{"shape":"RoleAliasArn"}
}
},
"UpdateStreamRequest":{
"type":"structure",
"required":["streamId"],
"members":{
"streamId":{
"shape":"StreamId",
"location":"uri",
"locationName":"streamId"
},
"description":{"shape":"StreamDescription"},
"files":{"shape":"StreamFiles"},
"roleArn":{"shape":"RoleArn"}
}
},
"UpdateStreamResponse":{
"type":"structure",
"members":{
"streamId":{"shape":"StreamId"},
"streamArn":{"shape":"StreamArn"},
"description":{"shape":"StreamDescription"},
"streamVersion":{"shape":"StreamVersion"}
}
},
"UpdateThingGroupRequest":{
"type":"structure",
"required":[

View file

@ -15,9 +15,11 @@
"CreateCertificateFromCsr": "<p>Creates an X.509 certificate using the specified certificate signing request.</p> <p> <b>Note:</b> The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384 curves. </p> <p> <b>Note:</b> Reusing the same certificate signing request (CSR) results in a distinct certificate.</p> <p>You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs.</p> <p>Assuming a set of CSRs are located inside of the directory my-csr-directory:</p> <p>On Linux and OS X, the command is:</p> <p>$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}</p> <p>This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR.</p> <p>The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process:</p> <p>$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}</p> <p>On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:</p> <p>&gt; ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}</p> <p>On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:</p> <p>&gt; forfiles /p my-csr-directory /c \"cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path\"</p>",
"CreateJob": "<p>Creates a job.</p>",
"CreateKeysAndCertificate": "<p>Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.</p> <p> <b>Note</b> This is the only time AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location.</p>",
"CreateOTAUpdate": "<p>Creates an AWS IoT OTAUpdate on a target group of things or groups.</p>",
"CreatePolicy": "<p>Creates an AWS IoT policy.</p> <p>The created policy is the default version for the policy. This operation creates a policy version with a version identifier of <b>1</b> and sets <b>1</b> as the policy's default version.</p>",
"CreatePolicyVersion": "<p>Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use <a>DeletePolicyVersion</a> to delete an existing version before you create a new one.</p> <p>Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).</p>",
"CreateRoleAlias": "<p>Creates a role alias.</p>",
"CreateStream": "<p>Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream. The total size of a file associated with the stream cannot exceed more than 2 MB. The stream will be created with version 0. If a stream is created with the same streamID as a stream that existed and was deleted within last 90 days, we will resurrect that old stream by incrementing the version by 1.</p>",
"CreateThing": "<p>Creates a thing record in the thing registry.</p>",
"CreateThingGroup": "<p>Create a thing group.</p>",
"CreateThingType": "<p>Creates a new thing type.</p>",
@ -25,10 +27,12 @@
"DeleteAuthorizer": "<p>Deletes an authorizer.</p>",
"DeleteCACertificate": "<p>Deletes a registered CA certificate.</p>",
"DeleteCertificate": "<p>Deletes the specified certificate.</p> <p>A certificate cannot be deleted if it has a policy attached to it or if its status is set to ACTIVE. To delete a certificate, first use the <a>DetachPrincipalPolicy</a> API to detach all policies. Next, use the <a>UpdateCertificate</a> API to set the certificate to the INACTIVE status.</p>",
"DeleteOTAUpdate": "<p>Delete an OTA update.</p>",
"DeletePolicy": "<p>Deletes the specified policy.</p> <p>A policy cannot be deleted if it has non-default versions or it is attached to any certificate.</p> <p>To delete a policy, use the DeletePolicyVersion API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy.</p> <p>When a policy is deleted using DeletePolicy, its default version is deleted with it.</p>",
"DeletePolicyVersion": "<p>Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this API. To delete the default version of a policy, use <a>DeletePolicy</a>. To find out which version of a policy is marked as the default version, use ListPolicyVersions.</p>",
"DeleteRegistrationCode": "<p>Deletes a CA certificate registration code.</p>",
"DeleteRoleAlias": "<p>Deletes a role alias</p>",
"DeleteStream": "<p>Deletes a stream.</p>",
"DeleteThing": "<p>Deletes the specified thing.</p>",
"DeleteThingGroup": "<p>Deletes a thing group.</p>",
"DeleteThingType": "<p>Deletes the specified thing type . You cannot delete a thing type if it has things associated with it. To delete a thing type, first mark it as deprecated by calling <a>DeprecateThingType</a>, then remove any associated things by calling <a>UpdateThing</a> to change the thing type on any associated thing, and finally use <a>DeleteThingType</a> to delete the thing type.</p>",
@ -37,7 +41,7 @@
"DeprecateThingType": "<p>Deprecates a thing type. You can not associate new things with deprecated thing type.</p>",
"DescribeAuthorizer": "<p>Describes an authorizer.</p>",
"DescribeCACertificate": "<p>Describes a registered CA certificate.</p>",
"DescribeCertificate": "<p>Gets information about the specified certificate. You may specify the certificate using either its ID or PEM.</p>",
"DescribeCertificate": "<p>Gets information about the specified certificate.</p>",
"DescribeDefaultAuthorizer": "<p>Describes the default authorizer.</p>",
"DescribeEndpoint": "<p>Returns a unique endpoint specific to the AWS account making the call.</p>",
"DescribeEventConfigurations": "<p>Describes event configurations.</p>",
@ -45,6 +49,7 @@
"DescribeJob": "<p>Describes a job.</p>",
"DescribeJobExecution": "<p>Describes a job execution.</p>",
"DescribeRoleAlias": "<p>Describes a role alias.</p>",
"DescribeStream": "<p>Gets information about a stream.</p>",
"DescribeThing": "<p>Gets information about the specified thing.</p>",
"DescribeThingGroup": "<p>Describe a thing group.</p>",
"DescribeThingRegistrationTask": "<p>Describes a bulk thing provisioning task.</p>",
@ -58,6 +63,7 @@
"GetIndexingConfiguration": "<p>Gets the search configuration.</p>",
"GetJobDocument": "<p>Gets a job document.</p>",
"GetLoggingOptions": "<p>Gets the logging options.</p>",
"GetOTAUpdate": "<p>Gets an OTA update.</p>",
"GetPolicy": "<p>Gets information about the specified policy with the policy document of the default version.</p>",
"GetPolicyVersion": "<p>Gets information about the specified policy version.</p>",
"GetRegistrationCode": "<p>Gets a registration code used to register a CA certificate with AWS IoT.</p>",
@ -72,6 +78,7 @@
"ListJobExecutionsForJob": "<p>Lists the job executions for a job.</p>",
"ListJobExecutionsForThing": "<p>Lists the job executions for the specified thing.</p>",
"ListJobs": "<p>Lists jobs.</p>",
"ListOTAUpdates": "<p>Lists OTA updates.</p>",
"ListOutgoingCertificates": "<p>Lists certificates that are being transferred but not yet accepted.</p>",
"ListPolicies": "<p>Lists your policies.</p>",
"ListPolicyPrincipals": "<p>Lists the principals associated with the specified policy.</p> <p> <b>Note:</b> This API is deprecated. Please use <a>ListTargetsForPolicy</a> instead.</p>",
@ -79,6 +86,7 @@
"ListPrincipalPolicies": "<p>Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in <a href=\"http://docs.aws.amazon.com/cognitoidentity/latest/APIReference/API_GetCredentialsForIdentity.html#API_GetCredentialsForIdentity_RequestSyntax\">AmazonCognito Identity format</a>.</p> <p> <b>Note:</b> This API is deprecated. Please use <a>ListAttachedPolicies</a> instead.</p>",
"ListPrincipalThings": "<p>Lists the things associated with the specified principal.</p>",
"ListRoleAliases": "<p>Lists the role aliases registered in your account.</p>",
"ListStreams": "<p>Lists all of the streams in your AWS account.</p>",
"ListTargetsForPolicy": "<p>List targets for the specified policy.</p>",
"ListThingGroups": "<p>List the thing groups in your account.</p>",
"ListThingGroupsForThing": "<p>List the thing groups to which the specified thing belongs.</p>",
@ -113,6 +121,7 @@
"UpdateEventConfigurations": "<p>Updates the event configurations.</p>",
"UpdateIndexingConfiguration": "<p>Updates the search configuration.</p>",
"UpdateRoleAlias": "<p>Updates a role alias.</p>",
"UpdateStream": "<p>Updates an existing stream. The stream version will be incremented by one.</p>",
"UpdateThing": "<p>Updates the data for a thing.</p>",
"UpdateThingGroup": "<p>Update a thing group.</p>",
"UpdateThingGroupsForThing": "<p>Updates the groups to which the thing belongs.</p>"
@ -126,7 +135,9 @@
"Action": {
"base": "<p>Describes the actions associated with a rule.</p>",
"refs": {
"ActionList$member": null
"ActionList$member": null,
"TopicRule$errorAction": "<p>The action to perform when an error occurs.</p>",
"TopicRulePayload$errorAction": "<p>The action to take when an error occurs.</p>"
}
},
"ActionList": {
@ -152,6 +163,13 @@
"refs": {
}
},
"AdditionalParameterMap": {
"base": null,
"refs": {
"CreateOTAUpdateRequest$additionalParameters": "<p>A list of additional OTA update parameters which are name-value pairs.</p>",
"OTAUpdateInfo$additionalParameters": "<p>A collection of name/value pairs</p>"
}
},
"AlarmName": {
"base": null,
"refs": {
@ -181,7 +199,8 @@
"ListPoliciesRequest$ascendingOrder": "<p>Specifies the order for results. If true, the results are returned in ascending creation order.</p>",
"ListPolicyPrincipalsRequest$ascendingOrder": "<p>Specifies the order for results. If true, the results are returned in ascending creation order.</p>",
"ListPrincipalPoliciesRequest$ascendingOrder": "<p>Specifies the order for results. If true, results are returned in ascending creation order.</p>",
"ListRoleAliasesRequest$ascendingOrder": "<p>Return the list of role aliases in ascending alphabetical order.</p>"
"ListRoleAliasesRequest$ascendingOrder": "<p>Return the list of role aliases in ascending alphabetical order.</p>",
"ListStreamsRequest$ascendingOrder": "<p>Set to true to return the list of streams in ascending order.</p>"
}
},
"AssociateTargetsWithJobRequest": {
@ -246,6 +265,12 @@
"ThingDocument$attributes": "<p>The attributes.</p>"
}
},
"AttributesMap": {
"base": null,
"refs": {
"OTAUpdateFile$attributes": "<p>A list of name/attribute pairs.</p>"
}
},
"AuthDecision": {
"base": null,
"refs": {
@ -378,6 +403,20 @@
"SqsAction$roleArn": "<p>The ARN of the IAM role that grants access.</p>"
}
},
"AwsIotJobArn": {
"base": null,
"refs": {
"CreateOTAUpdateResponse$awsIotJobArn": "<p>The AWS IoT job ARN associated with the OTA update.</p>",
"OTAUpdateInfo$awsIotJobArn": "<p>The AWS IoT job ARN associated with the OTA update.</p>"
}
},
"AwsIotJobId": {
"base": null,
"refs": {
"CreateOTAUpdateResponse$awsIotJobId": "<p>The AWS IoT job ID associated with the OTA update.</p>",
"OTAUpdateInfo$awsIotJobId": "<p>The AWS IoT job ID associated with the OTA update.</p>"
}
},
"AwsIotSqlVersion": {
"base": null,
"refs": {
@ -508,6 +547,12 @@
"UpdateCertificateRequest$certificateId": "<p>The ID of the certificate.</p>"
}
},
"CertificateName": {
"base": null,
"refs": {
"CodeSigningCertificateChain$certificateName": "<p>The name of the certificate.</p>"
}
},
"CertificatePem": {
"base": "<p>The PEM of a certificate.</p>",
"refs": {
@ -583,6 +628,30 @@
"Action$cloudwatchMetric": "<p>Capture a CloudWatch metric.</p>"
}
},
"Code": {
"base": null,
"refs": {
"ErrorInfo$code": "<p>The error code.</p>"
}
},
"CodeSigning": {
"base": "<p>Describes the method to use when code signing a file.</p>",
"refs": {
"OTAUpdateFile$codeSigning": "<p>The code signing method of the file.</p>"
}
},
"CodeSigningCertificateChain": {
"base": "<p>Describes the certificate chain being used when code signing a file.</p>",
"refs": {
"CustomCodeSigning$certificateChain": "<p>The certificate chain.</p>"
}
},
"CodeSigningSignature": {
"base": "<p>Describes the signature for a file.</p>",
"refs": {
"CustomCodeSigning$signature": "<p>The signature for the file.</p>"
}
},
"CognitoIdentityPoolId": {
"base": null,
"refs": {
@ -656,6 +725,16 @@
"refs": {
}
},
"CreateOTAUpdateRequest": {
"base": null,
"refs": {
}
},
"CreateOTAUpdateResponse": {
"base": null,
"refs": {
}
},
"CreatePolicyRequest": {
"base": "<p>The input for the CreatePolicy operation.</p>",
"refs": {
@ -686,6 +765,16 @@
"refs": {
}
},
"CreateStreamRequest": {
"base": null,
"refs": {
}
},
"CreateStreamResponse": {
"base": null,
"refs": {
}
},
"CreateThingGroupRequest": {
"base": null,
"refs": {
@ -745,6 +834,12 @@
"UpdateRoleAliasRequest$credentialDurationSeconds": "<p>The number of seconds the credential will be valid.</p>"
}
},
"CustomCodeSigning": {
"base": "<p>Describes a custom method used to code sign a file.</p>",
"refs": {
"CodeSigning$customCodeSigning": "<p>A custom method for code signing a file.</p>"
}
},
"DateType": {
"base": null,
"refs": {
@ -767,11 +862,16 @@
"JobSummary$createdAt": "<p>The time, in milliseconds since the epoch, when the job was created.</p>",
"JobSummary$lastUpdatedAt": "<p>The time, in milliseconds since the epoch, when the job was last updated.</p>",
"JobSummary$completedAt": "<p>The time, in milliseconds since the epoch, when the job completed.</p>",
"OTAUpdateInfo$creationDate": "<p>The date when the OTA update was created.</p>",
"OTAUpdateInfo$lastModifiedDate": "<p>The date when the OTA update was last updated.</p>",
"OTAUpdateSummary$creationDate": "<p>The date when the OTA update was created.</p>",
"OutgoingCertificate$transferDate": "<p>The date the transfer was initiated.</p>",
"OutgoingCertificate$creationDate": "<p>The certificate creation date.</p>",
"PolicyVersion$createDate": "<p>The date and time the policy was created.</p>",
"RoleAliasDescription$creationDate": "<p>The UNIX timestamp of when the role alias was created.</p>",
"RoleAliasDescription$lastModifiedDate": "<p>The UNIX timestamp of when the role alias was last modified.</p>",
"StreamInfo$createdAt": "<p>The date when the stream was created.</p>",
"StreamInfo$lastUpdatedAt": "<p>The date when the stream was last updated.</p>",
"TransferData$transferDate": "<p>The date the transfer took place.</p>",
"TransferData$acceptDate": "<p>The date the transfer was accepted.</p>",
"TransferData$rejectDate": "<p>The date the transfer was rejected.</p>"
@ -807,6 +907,16 @@
"refs": {
}
},
"DeleteOTAUpdateRequest": {
"base": null,
"refs": {
}
},
"DeleteOTAUpdateResponse": {
"base": null,
"refs": {
}
},
"DeletePolicyRequest": {
"base": "<p>The input for the DeletePolicy operation.</p>",
"refs": {
@ -837,6 +947,16 @@
"refs": {
}
},
"DeleteStreamRequest": {
"base": null,
"refs": {
}
},
"DeleteStreamResponse": {
"base": null,
"refs": {
}
},
"DeleteThingGroupRequest": {
"base": null,
"refs": {
@ -1005,6 +1125,16 @@
"refs": {
}
},
"DescribeStreamRequest": {
"base": null,
"refs": {
}
},
"DescribeStreamResponse": {
"base": null,
"refs": {
}
},
"DescribeThingGroupRequest": {
"base": null,
"refs": {
@ -1192,6 +1322,12 @@
"DescribeEndpointRequest$endpointType": "<p>The endpoint type.</p>"
}
},
"ErrorInfo": {
"base": "<p>Error information.</p>",
"refs": {
"OTAUpdateInfo$errorInfo": "<p>Error information associated with the OTA update.</p>"
}
},
"ErrorMessage": {
"base": null,
"refs": {
@ -1237,6 +1373,19 @@
"JobProcessDetails$numberOfFailedThings": "<p>The number of things that failed executing the job.</p>"
}
},
"FileId": {
"base": null,
"refs": {
"Stream$fileId": "<p>The ID of a file associated with a stream.</p>",
"StreamFile$fileId": "<p>The file ID.</p>"
}
},
"FileName": {
"base": null,
"refs": {
"OTAUpdateFile$fileName": "<p>The name of the file.</p>"
}
},
"FirehoseAction": {
"base": "<p>Describes an action that writes data to an Amazon Kinesis Firehose stream.</p>",
"refs": {
@ -1313,6 +1462,16 @@
"refs": {
}
},
"GetOTAUpdateRequest": {
"base": null,
"refs": {
}
},
"GetOTAUpdateResponse": {
"base": null,
"refs": {
}
},
"GetPolicyRequest": {
"base": "<p>The input for the GetPolicy operation.</p>",
"refs": {
@ -1369,6 +1528,12 @@
"ThingGroupNameAndArnList$member": null
}
},
"HashAlgorithm": {
"base": null,
"refs": {
"CustomCodeSigning$hashAlgorithm": "<p>The hash algorithm used to code sign the file.</p>"
}
},
"HashKeyField": {
"base": null,
"refs": {
@ -1425,6 +1590,12 @@
"DescribeIndexResponse$indexStatus": "<p>The index status.</p>"
}
},
"InlineDocument": {
"base": null,
"refs": {
"CodeSigningCertificateChain$inlineDocument": "<p>A base64 encoded binary representation of the code signing certificate chain.</p>"
}
},
"InternalException": {
"base": "<p>An unexpected error has occurred.</p>",
"refs": {
@ -1641,6 +1812,8 @@
"Key": {
"base": null,
"refs": {
"AdditionalParameterMap$key": null,
"AttributesMap$key": null,
"S3Action$key": "<p>The object key.</p>"
}
},
@ -1784,6 +1957,16 @@
"refs": {
}
},
"ListOTAUpdatesRequest": {
"base": null,
"refs": {
}
},
"ListOTAUpdatesResponse": {
"base": null,
"refs": {
}
},
"ListOutgoingCertificatesRequest": {
"base": "<p>The input to the ListOutgoingCertificates operation.</p>",
"refs": {
@ -1854,6 +2037,16 @@
"refs": {
}
},
"ListStreamsRequest": {
"base": null,
"refs": {
}
},
"ListStreamsResponse": {
"base": null,
"refs": {
}
},
"ListTargetsForPolicyRequest": {
"base": null,
"refs": {
@ -2053,6 +2246,13 @@
"JobExecutionsRolloutConfig$maximumPerMinute": "<p>The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.</p>"
}
},
"MaxResults": {
"base": null,
"refs": {
"ListOTAUpdatesRequest$maxResults": "<p>The maximum number of results to return at one time.</p>",
"ListStreamsRequest$maxResults": "<p>The maximum number of results to return at a time.</p>"
}
},
"Message": {
"base": null,
"refs": {
@ -2122,8 +2322,12 @@
"ListJobExecutionsForThingResponse$nextToken": "<p>The token for the next set of results, or <b>null</b> if there are no additional results.</p>",
"ListJobsRequest$nextToken": "<p>The token to retrieve the next set of results.</p>",
"ListJobsResponse$nextToken": "<p>The token for the next set of results, or <b>null</b> if there are no additional results.</p>",
"ListOTAUpdatesRequest$nextToken": "<p>A token used to retreive the next set of results.</p>",
"ListOTAUpdatesResponse$nextToken": "<p>A token to use to get the next set of results.</p>",
"ListPrincipalThingsRequest$nextToken": "<p>The token used to get the next set of results, or <b>null</b> if there are no additional results.</p>",
"ListPrincipalThingsResponse$nextToken": "<p>The token used to get the next set of results, or <b>null</b> if there are no additional results.</p>",
"ListStreamsRequest$nextToken": "<p>A token used to get the next set of results.</p>",
"ListStreamsResponse$nextToken": "<p>A token used to get the next set of results.</p>",
"ListThingGroupsForThingRequest$nextToken": "<p>The token used to get the next set of results, or <b>null</b> if there are no additional results.</p>",
"ListThingGroupsForThingResponse$nextToken": "<p>The token used to get the next set of results, or <b>null</b> if there are no additional results.</p>",
"ListThingGroupsRequest$nextToken": "<p>The token used to get the next set of results, or <b>null</b> if there are no additional results.</p>",
@ -2151,6 +2355,83 @@
"refs": {
}
},
"OTAUpdateArn": {
"base": null,
"refs": {
"CreateOTAUpdateResponse$otaUpdateArn": "<p>The OTA update ARN.</p>",
"OTAUpdateInfo$otaUpdateArn": "<p>The OTA update ARN.</p>",
"OTAUpdateSummary$otaUpdateArn": "<p>The OTA update ARN.</p>"
}
},
"OTAUpdateDescription": {
"base": null,
"refs": {
"CreateOTAUpdateRequest$description": "<p>The description of the OTA update.</p>",
"OTAUpdateInfo$description": "<p>A description of the OTA update.</p>"
}
},
"OTAUpdateErrorMessage": {
"base": null,
"refs": {
"ErrorInfo$message": "<p>The error message.</p>"
}
},
"OTAUpdateFile": {
"base": "<p>Describes a file to be associated with an OTA update.</p>",
"refs": {
"OTAUpdateFiles$member": null
}
},
"OTAUpdateFileVersion": {
"base": null,
"refs": {
"OTAUpdateFile$fileVersion": "<p>The file version.</p>"
}
},
"OTAUpdateFiles": {
"base": null,
"refs": {
"CreateOTAUpdateRequest$files": "<p>The files to be streamed by the OTA update.</p>",
"OTAUpdateInfo$otaUpdateFiles": "<p>A list of files associated with the OTA update.</p>"
}
},
"OTAUpdateId": {
"base": null,
"refs": {
"CreateOTAUpdateRequest$otaUpdateId": "<p>The ID of the OTA update to be created.</p>",
"CreateOTAUpdateResponse$otaUpdateId": "<p>The OTA update ID.</p>",
"DeleteOTAUpdateRequest$otaUpdateId": "<p>The OTA update ID to delete.</p>",
"GetOTAUpdateRequest$otaUpdateId": "<p>The OTA update ID.</p>",
"OTAUpdateInfo$otaUpdateId": "<p>The OTA update ID.</p>",
"OTAUpdateSummary$otaUpdateId": "<p>The OTA update ID.</p>"
}
},
"OTAUpdateInfo": {
"base": "<p>Information about an OTA update.</p>",
"refs": {
"GetOTAUpdateResponse$otaUpdateInfo": "<p>The OTA update info.</p>"
}
},
"OTAUpdateStatus": {
"base": null,
"refs": {
"CreateOTAUpdateResponse$otaUpdateStatus": "<p>The OTA update status.</p>",
"ListOTAUpdatesRequest$otaUpdateStatus": "<p>The OTA update job status.</p>",
"OTAUpdateInfo$otaUpdateStatus": "<p>The status of the OTA update.</p>"
}
},
"OTAUpdateSummary": {
"base": "<p>An OTA update summary.</p>",
"refs": {
"OTAUpdatesSummary$member": null
}
},
"OTAUpdatesSummary": {
"base": null,
"refs": {
"ListOTAUpdatesResponse$otaUpdates": "<p>A list of OTA update jobs.</p>"
}
},
"OptionalVersion": {
"base": null,
"refs": {
@ -2695,13 +2976,17 @@
"RoleArn": {
"base": null,
"refs": {
"CreateOTAUpdateRequest$roleArn": "<p>The IAM role that allows access to the AWS IoT Jobs service.</p>",
"CreateRoleAliasRequest$roleArn": "<p>The role ARN.</p>",
"CreateStreamRequest$roleArn": "<p>An IAM role that allows the IoT service principal assumes to access your S3 files.</p>",
"DescribeThingRegistrationTaskResponse$roleArn": "<p>The role ARN that grants access to the input file bucket.</p>",
"PresignedUrlConfig$roleArn": "<p>The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.</p>",
"RegistrationConfig$roleArn": "<p>The ARN of the role.</p>",
"RoleAliasDescription$roleArn": "<p>The role ARN.</p>",
"StartThingRegistrationTaskRequest$roleArn": "<p>The IAM role ARN that grants permission the input file.</p>",
"UpdateRoleAliasRequest$roleArn": "<p>The role ARN.</p>"
"StreamInfo$roleArn": "<p>An IAM role AWS IoT assumes to access your S3 files.</p>",
"UpdateRoleAliasRequest$roleArn": "<p>The role ARN.</p>",
"UpdateStreamRequest$roleArn": "<p>An IAM role that allows the IoT service principal assumes to access your S3 files.</p>"
}
},
"RuleArn": {
@ -2730,6 +3015,12 @@
"Action$s3": "<p>Write to an Amazon S3 bucket.</p>"
}
},
"S3Bucket": {
"base": null,
"refs": {
"S3Location$bucket": "<p>The S3 bucket that contains the file to stream.</p>"
}
},
"S3FileUrl": {
"base": null,
"refs": {
@ -2742,6 +3033,24 @@
"ListThingRegistrationTaskReportsResponse$resourceLinks": "<p>Links to the task resources.</p>"
}
},
"S3Key": {
"base": null,
"refs": {
"S3Location$key": "<p>The name of the file within the S3 bucket to stream.</p>"
}
},
"S3Location": {
"base": "<p>The location in S3 the contains the files to stream.</p>",
"refs": {
"StreamFile$s3Location": "<p>The location of the file in S3.</p>"
}
},
"S3Version": {
"base": null,
"refs": {
"S3Location$version": "<p>The file version.</p>"
}
},
"SQL": {
"base": null,
"refs": {
@ -2846,6 +3155,24 @@
"refs": {
}
},
"Signature": {
"base": null,
"refs": {
"CodeSigningSignature$inlineDocument": "<p>A base64 encoded binary representation of the code signing signature.</p>"
}
},
"SignatureAlgorithm": {
"base": null,
"refs": {
"CustomCodeSigning$signatureAlgorithm": "<p>The signature algorithm used to code sign the file.</p>"
}
},
"SigningJobId": {
"base": null,
"refs": {
"CodeSigning$awsSignerJobId": "<p>The ID of the AWSSignerJob which was created to sign the file.</p>"
}
},
"SkyfallMaxResults": {
"base": null,
"refs": {
@ -2908,12 +3235,95 @@
"refs": {
}
},
"Stream": {
"base": "<p>Describes a group of files that can be streamed.</p>",
"refs": {
"CodeSigningCertificateChain$stream": "<p>A stream of the certificate chain files.</p>",
"CodeSigningSignature$stream": "<p>A stream of the code signing signature.</p>",
"OTAUpdateFile$fileSource": "<p>The source of the file.</p>"
}
},
"StreamArn": {
"base": null,
"refs": {
"CreateStreamResponse$streamArn": "<p>The stream ARN.</p>",
"StreamInfo$streamArn": "<p>The stream ARN.</p>",
"StreamSummary$streamArn": "<p>The stream ARN.</p>",
"UpdateStreamResponse$streamArn": "<p>The stream ARN.</p>"
}
},
"StreamDescription": {
"base": null,
"refs": {
"CreateStreamRequest$description": "<p>A description of the stream.</p>",
"CreateStreamResponse$description": "<p>A description of the stream.</p>",
"StreamInfo$description": "<p>The description of the stream.</p>",
"StreamSummary$description": "<p>A description of the stream.</p>",
"UpdateStreamRequest$description": "<p>The description of the stream.</p>",
"UpdateStreamResponse$description": "<p>A description of the stream.</p>"
}
},
"StreamFile": {
"base": "<p>Represents a file to stream.</p>",
"refs": {
"StreamFiles$member": null
}
},
"StreamFiles": {
"base": null,
"refs": {
"CreateStreamRequest$files": "<p>The files to stream.</p>",
"StreamInfo$files": "<p>The files to stream.</p>",
"UpdateStreamRequest$files": "<p>The files associated with the stream.</p>"
}
},
"StreamId": {
"base": null,
"refs": {
"CreateStreamRequest$streamId": "<p>The stream ID.</p>",
"CreateStreamResponse$streamId": "<p>The stream ID.</p>",
"DeleteStreamRequest$streamId": "<p>The stream ID.</p>",
"DescribeStreamRequest$streamId": "<p>The stream ID.</p>",
"Stream$streamId": "<p>The stream ID.</p>",
"StreamInfo$streamId": "<p>The stream ID.</p>",
"StreamSummary$streamId": "<p>The stream ID.</p>",
"UpdateStreamRequest$streamId": "<p>The stream ID.</p>",
"UpdateStreamResponse$streamId": "<p>The stream ID.</p>"
}
},
"StreamInfo": {
"base": "<p>Information about a stream.</p>",
"refs": {
"DescribeStreamResponse$streamInfo": "<p>Information about the stream.</p>"
}
},
"StreamName": {
"base": null,
"refs": {
"KinesisAction$streamName": "<p>The name of the Amazon Kinesis stream.</p>"
}
},
"StreamSummary": {
"base": "<p>A summary of a stream.</p>",
"refs": {
"StreamsSummary$member": null
}
},
"StreamVersion": {
"base": null,
"refs": {
"CreateStreamResponse$streamVersion": "<p>The version of the stream.</p>",
"StreamInfo$streamVersion": "<p>The stream version.</p>",
"StreamSummary$streamVersion": "<p>The stream version.</p>",
"UpdateStreamResponse$streamVersion": "<p>The stream version.</p>"
}
},
"StreamsSummary": {
"base": null,
"refs": {
"ListStreamsResponse$streams": "<p>A list of streams.</p>"
}
},
"SucceededThings": {
"base": null,
"refs": {
@ -2927,6 +3337,12 @@
"PutItemInput$tableName": "<p>The table where the message data will be written</p>"
}
},
"Target": {
"base": null,
"refs": {
"Targets$member": null
}
},
"TargetArn": {
"base": null,
"refs": {
@ -2937,9 +3353,18 @@
"base": null,
"refs": {
"CreateJobRequest$targetSelection": "<p>Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.</p>",
"CreateOTAUpdateRequest$targetSelection": "<p>Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.</p>",
"Job$targetSelection": "<p>Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group. </p>",
"JobSummary$targetSelection": "<p>Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.</p>",
"ListJobsRequest$targetSelection": "<p>Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group. </p>"
"ListJobsRequest$targetSelection": "<p>Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group. </p>",
"OTAUpdateInfo$targetSelection": "<p>Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group. </p>"
}
},
"Targets": {
"base": null,
"refs": {
"CreateOTAUpdateRequest$targets": "<p>The targeted devices to receive OTA updates.</p>",
"OTAUpdateInfo$targets": "<p>The targets of the OTA update.</p>"
}
},
"TaskId": {
@ -3375,6 +3800,16 @@
"refs": {
}
},
"UpdateStreamRequest": {
"base": null,
"refs": {
}
},
"UpdateStreamResponse": {
"base": null,
"refs": {
}
},
"UpdateThingGroupRequest": {
"base": null,
"refs": {
@ -3414,6 +3849,8 @@
"Value": {
"base": null,
"refs": {
"AdditionalParameterMap$value": null,
"AttributesMap$value": null,
"Parameters$value": null
}
},

View file

@ -7,6 +7,7 @@
"protocol":"json",
"serviceAbbreviation":"Kinesis Analytics",
"serviceFullName":"Amazon Kinesis Analytics",
"serviceId":"Kinesis Analytics",
"signatureVersion":"v4",
"targetPrefix":"KinesisAnalytics_20150814",
"timestampFormat":"unixTimestamp",
@ -958,6 +959,31 @@
"RoleARNUpdate":{"shape":"RoleARN"}
}
},
"LambdaOutput":{
"type":"structure",
"required":[
"ResourceARN",
"RoleARN"
],
"members":{
"ResourceARN":{"shape":"ResourceARN"},
"RoleARN":{"shape":"RoleARN"}
}
},
"LambdaOutputDescription":{
"type":"structure",
"members":{
"ResourceARN":{"shape":"ResourceARN"},
"RoleARN":{"shape":"RoleARN"}
}
},
"LambdaOutputUpdate":{
"type":"structure",
"members":{
"ResourceARNUpdate":{"shape":"ResourceARN"},
"RoleARNUpdate":{"shape":"RoleARN"}
}
},
"LimitExceededException":{
"type":"structure",
"members":{
@ -1011,6 +1037,7 @@
"Name":{"shape":"InAppStreamName"},
"KinesisStreamsOutput":{"shape":"KinesisStreamsOutput"},
"KinesisFirehoseOutput":{"shape":"KinesisFirehoseOutput"},
"LambdaOutput":{"shape":"LambdaOutput"},
"DestinationSchema":{"shape":"DestinationSchema"}
}
},
@ -1021,6 +1048,7 @@
"Name":{"shape":"InAppStreamName"},
"KinesisStreamsOutputDescription":{"shape":"KinesisStreamsOutputDescription"},
"KinesisFirehoseOutputDescription":{"shape":"KinesisFirehoseOutputDescription"},
"LambdaOutputDescription":{"shape":"LambdaOutputDescription"},
"DestinationSchema":{"shape":"DestinationSchema"}
}
},
@ -1036,6 +1064,7 @@
"NameUpdate":{"shape":"InAppStreamName"},
"KinesisStreamsOutputUpdate":{"shape":"KinesisStreamsOutputUpdate"},
"KinesisFirehoseOutputUpdate":{"shape":"KinesisFirehoseOutputUpdate"},
"LambdaOutputUpdate":{"shape":"LambdaOutputUpdate"},
"DestinationSchemaUpdate":{"shape":"DestinationSchema"}
}
},

View file

@ -5,16 +5,16 @@
"AddApplicationCloudWatchLoggingOption": "<p>Adds a CloudWatch log stream to monitor application configuration errors. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html\">Working with Amazon CloudWatch Logs</a>.</p>",
"AddApplicationInput": "<p> Adds a streaming source to your Amazon Kinesis application. For conceptual information, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html\">Configuring Application Input</a>. </p> <p>You can add a streaming source either when you create an application or you can use this operation to add a streaming source after you create an application. For more information, see <a>CreateApplication</a>.</p> <p>Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the <a>DescribeApplication</a> operation to find the current application version. </p> <p>This operation requires permissions to perform the <code>kinesisanalytics:AddApplicationInput</code> action.</p>",
"AddApplicationInputProcessingConfiguration": "<p>Adds an <a>InputProcessingConfiguration</a> to an application. An input processor preprocesses records on the input stream before the application's SQL code executes. Currently, the only input processor available is <a href=\"https://aws.amazon.com/documentation/lambda/\">AWS Lambda</a>.</p>",
"AddApplicationOutput": "<p>Adds an external destination to your Amazon Kinesis Analytics application.</p> <p>If you want Amazon Kinesis Analytics to deliver data from an in-application stream within your application to an external destination (such as an Amazon Kinesis stream or a Firehose delivery stream), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination.</p> <p> You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. For conceptual information, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html\">Understanding Application Output (Destination)</a>. </p> <p> Note that any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the <a>DescribeApplication</a> operation to find the current application version.</p> <p>For the limits on the number of application inputs and outputs you can configure, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html\">Limits</a>.</p> <p>This operation requires permissions to perform the <code>kinesisanalytics:AddApplicationOutput</code> action.</p>",
"AddApplicationOutput": "<p>Adds an external destination to your Amazon Kinesis Analytics application.</p> <p>If you want Amazon Kinesis Analytics to deliver data from an in-application stream within your application to an external destination (such as an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an Amazon Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination.</p> <p> You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. For conceptual information, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html\">Understanding Application Output (Destination)</a>. </p> <p> Note that any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the <a>DescribeApplication</a> operation to find the current application version.</p> <p>For the limits on the number of application inputs and outputs you can configure, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html\">Limits</a>.</p> <p>This operation requires permissions to perform the <code>kinesisanalytics:AddApplicationOutput</code> action.</p>",
"AddApplicationReferenceDataSource": "<p>Adds a reference data source to an existing application.</p> <p>Amazon Kinesis Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in Amazon S3 object maps to columns in the resulting in-application table.</p> <p> For conceptual information, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html\">Configuring Application Input</a>. For the limits on data sources you can add to your application, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html\">Limits</a>. </p> <p> This operation requires permissions to perform the <code>kinesisanalytics:AddApplicationOutput</code> action. </p>",
"CreateApplication": "<p> Creates an Amazon Kinesis Analytics application. You can configure each application with one streaming source as input, application code to process the input, and up to five streaming destinations where you want Amazon Kinesis Analytics to write the output data from your application. For an overview, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works.html\">How it Works</a>. </p> <p>In the input configuration, you map the streaming source to an in-application stream, which you can think of as a constantly updating table. In the mapping, you must provide a schema for the in-application stream and map each data column in the in-application stream to a data element in the streaming source.</p> <p>Your application code is one or more SQL statements that read input data, transform it, and generate output. Your application code can create one or more SQL artifacts like SQL streams or pumps.</p> <p>In the output configuration, you can configure the application to write data from in-application streams created in your applications to up to five streaming destinations.</p> <p> To read data from your source stream or write data to destination streams, Amazon Kinesis Analytics needs your permissions. You grant these permissions by creating IAM roles. This operation requires permissions to perform the <code>kinesisanalytics:CreateApplication</code> action. </p> <p> For introductory exercises to create an Amazon Kinesis Analytics application, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/getting-started.html\">Getting Started</a>. </p>",
"CreateApplication": "<p> Creates an Amazon Kinesis Analytics application. You can configure each application with one streaming source as input, application code to process the input, and up to three destinations where you want Amazon Kinesis Analytics to write the output data from your application. For an overview, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works.html\">How it Works</a>. </p> <p>In the input configuration, you map the streaming source to an in-application stream, which you can think of as a constantly updating table. In the mapping, you must provide a schema for the in-application stream and map each data column in the in-application stream to a data element in the streaming source.</p> <p>Your application code is one or more SQL statements that read input data, transform it, and generate output. Your application code can create one or more SQL artifacts like SQL streams or pumps.</p> <p>In the output configuration, you can configure the application to write data from in-application streams created in your applications to up to three destinations.</p> <p> To read data from your source stream or write data to destination streams, Amazon Kinesis Analytics needs your permissions. You grant these permissions by creating IAM roles. This operation requires permissions to perform the <code>kinesisanalytics:CreateApplication</code> action. </p> <p> For introductory exercises to create an Amazon Kinesis Analytics application, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/getting-started.html\">Getting Started</a>. </p>",
"DeleteApplication": "<p>Deletes the specified application. Amazon Kinesis Analytics halts application execution and deletes the application, including any application artifacts (such as in-application streams, reference table, and application code).</p> <p>This operation requires permissions to perform the <code>kinesisanalytics:DeleteApplication</code> action.</p>",
"DeleteApplicationCloudWatchLoggingOption": "<p>Deletes a CloudWatch log stream from an application. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/cloudwatch-logs.html\">Working with Amazon CloudWatch Logs</a>.</p>",
"DeleteApplicationInputProcessingConfiguration": "<p>Deletes an <a>InputProcessingConfiguration</a> from an input.</p>",
"DeleteApplicationOutput": "<p>Deletes output destination configuration from your application configuration. Amazon Kinesis Analytics will no longer write data from the corresponding in-application stream to the external output destination.</p> <p>This operation requires permissions to perform the <code>kinesisanalytics:DeleteApplicationOutput</code> action.</p>",
"DeleteApplicationReferenceDataSource": "<p>Deletes a reference data source configuration from the specified application configuration.</p> <p>If the application is running, Amazon Kinesis Analytics immediately removes the in-application table that you created using the <a>AddApplicationReferenceDataSource</a> operation. </p> <p>This operation requires permissions to perform the <code>kinesisanalytics.DeleteApplicationReferenceDataSource</code> action.</p>",
"DescribeApplication": "<p>Returns information about a specific Amazon Kinesis Analytics application.</p> <p>If you want to retrieve a list of all applications in your account, use the <a>ListApplications</a> operation.</p> <p>This operation requires permissions to perform the <code>kinesisanalytics:DescribeApplication</code> action. You can use <code>DescribeApplication</code> to get the current application versionId, which you need to call other operations such as <code>Update</code>. </p>",
"DiscoverInputSchema": "<p>Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose delivery stream). In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema.</p> <p> You can use the inferred schema when configuring a streaming source for your application. For conceptual information, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html\">Configuring Application Input</a>. Note that when you create an application using the Amazon Kinesis Analytics console, the console uses this operation to infer a schema and show it in the console user interface. </p> <p> This operation requires permissions to perform the <code>kinesisanalytics:DiscoverInputSchema</code> action. </p>",
"DiscoverInputSchema": "<p>Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose delivery stream) or S3 object. In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema.</p> <p> You can use the inferred schema when configuring a streaming source for your application. For conceptual information, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html\">Configuring Application Input</a>. Note that when you create an application using the Amazon Kinesis Analytics console, the console uses this operation to infer a schema and show it in the console user interface. </p> <p> This operation requires permissions to perform the <code>kinesisanalytics:DiscoverInputSchema</code> action. </p>",
"ListApplications": "<p>Returns a list of Amazon Kinesis Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If the response returns the <code>HasMoreApplications</code> value as true, you can send another request by adding the <code>ExclusiveStartApplicationName</code> in the request body, and set the value of this to the last application name from the previous response. </p> <p>If you want detailed information about a specific application, use <a>DescribeApplication</a>.</p> <p>This operation requires permissions to perform the <code>kinesisanalytics:ListApplications</code> action.</p>",
"StartApplication": "<p>Starts the specified Amazon Kinesis Analytics application. After creating an application, you must exclusively call this operation to start your application.</p> <p>After the application starts, it begins consuming the input data, processes it, and writes the output to the configured destination.</p> <p> The application status must be <code>READY</code> for you to start an application. You can get the application status in the console or using the <a>DescribeApplication</a> operation.</p> <p>After you start the application, you can stop the application from processing the input by calling the <a>StopApplication</a> operation.</p> <p>This operation requires permissions to perform the <code>kinesisanalytics:StartApplication</code> action.</p>",
"StopApplication": "<p>Stops the application from processing input data. You can stop an application only if it is in the running state. You can use the <a>DescribeApplication</a> operation to find the application state. After the application is stopped, Amazon Kinesis Analytics stops reading data from the input, the application stops processing data, and there is no output written to the destination. </p> <p>This operation requires permissions to perform the <code>kinesisanalytics:StopApplication</code> action.</p>",
@ -76,7 +76,7 @@
"refs": {
"ApplicationDetail$ApplicationCode": "<p>Returns the application code that you provided to perform data analysis on any of the in-application streams in your application.</p>",
"ApplicationUpdate$ApplicationCodeUpdate": "<p>Describes application code updates.</p>",
"CreateApplicationRequest$ApplicationCode": "<p>One or more SQL statements that read input data, transform it, and generate output. For example, you can write a SQL statement that reads data from one in-application stream, generates a running average of the number of advertisement clicks by vendor, and insert resulting rows in another in-application stream using pumps. For more inforamtion about the typical pattern, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-app-code.html\">Application Code</a>. </p> <p>You can provide such series of SQL statements, where output of one statement can be used as the input for the next statement. You store intermediate results by creating in-application streams and pumps.</p> <p>Note that the application code must create the streams with names specified in the <code>Outputs</code>. For example, if your <code>Outputs</code> defines output streams named <code>ExampleOutputStream1</code> and <code>ExampleOutputStream2</code>, then your application code must create these streams. </p>"
"CreateApplicationRequest$ApplicationCode": "<p>One or more SQL statements that read input data, transform it, and generate output. For example, you can write a SQL statement that reads data from one in-application stream, generates a running average of the number of advertisement clicks by vendor, and insert resulting rows in another in-application stream using pumps. For more information about the typical pattern, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-app-code.html\">Application Code</a>. </p> <p>You can provide such series of SQL statements, where output of one statement can be used as the input for the next statement. You store intermediate results by creating in-application streams and pumps.</p> <p>Note that the application code must create the streams with names specified in the <code>Outputs</code>. For example, if your <code>Outputs</code> defines output streams named <code>ExampleOutputStream1</code> and <code>ExampleOutputStream2</code>, then your application code must create these streams. </p>"
}
},
"ApplicationDescription": {
@ -147,7 +147,7 @@
"AddApplicationCloudWatchLoggingOptionRequest$CurrentApplicationVersionId": "<p>The version ID of the Kinesis Analytics application.</p>",
"AddApplicationInputProcessingConfigurationRequest$CurrentApplicationVersionId": "<p>Version of the application to which you want to add the input processing configuration. You can use the <a>DescribeApplication</a> operation to get the current application version. If the version specified is not the current version, the <code>ConcurrentModificationException</code> is returned.</p>",
"AddApplicationInputRequest$CurrentApplicationVersionId": "<p>Current version of your Amazon Kinesis Analytics application. You can use the <a>DescribeApplication</a> operation to find the current application version.</p>",
"AddApplicationOutputRequest$CurrentApplicationVersionId": "<p>Version of the application to which you want add the output configuration. You can use the <a>DescribeApplication</a> operation to get the current application version. If the version specified is not the current version, the <code>ConcurrentModificationException</code> is returned. </p>",
"AddApplicationOutputRequest$CurrentApplicationVersionId": "<p>Version of the application to which you want to add the output configuration. You can use the <a>DescribeApplication</a> operation to get the current application version. If the version specified is not the current version, the <code>ConcurrentModificationException</code> is returned. </p>",
"AddApplicationReferenceDataSourceRequest$CurrentApplicationVersionId": "<p>Version of the application for which you are adding the reference data source. You can use the <a>DescribeApplication</a> operation to get the current application version. If the version specified is not the current version, the <code>ConcurrentModificationException</code> is returned.</p>",
"ApplicationDetail$ApplicationVersionId": "<p>Provides the current application version.</p>",
"DeleteApplicationCloudWatchLoggingOptionRequest$CurrentApplicationVersionId": "<p>The version ID of the Kinesis Analytics application.</p>",
@ -166,7 +166,7 @@
"BucketARN": {
"base": null,
"refs": {
"S3Configuration$BucketARN": null,
"S3Configuration$BucketARN": "<p>ARN of the S3 bucket that contains the data.</p>",
"S3ReferenceDataSource$BucketARN": "<p>Amazon Resource Name (ARN) of the S3 bucket.</p>",
"S3ReferenceDataSourceDescription$BucketARN": "<p>Amazon Resource Name (ARN) of the S3 bucket.</p>",
"S3ReferenceDataSourceUpdate$BucketARNUpdate": "<p>Amazon Resource Name (ARN) of the S3 bucket.</p>"
@ -298,9 +298,9 @@
"DestinationSchema": {
"base": "<p>Describes the data format when records are written to the destination. For more information, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html\">Configuring Application Output</a>. </p>",
"refs": {
"Output$DestinationSchema": null,
"Output$DestinationSchema": "<p>Describes the data format when records are written to the destination. For more information, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html\">Configuring Application Output</a>.</p>",
"OutputDescription$DestinationSchema": "<p>Data format used for writing data to the destination.</p>",
"OutputUpdate$DestinationSchemaUpdate": null
"OutputUpdate$DestinationSchemaUpdate": "<p>Describes the data format when records are written to the destination. For more information, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-output.html\">Configuring Application Output</a>.</p>"
}
},
"DiscoverInputSchemaRequest": {
@ -331,7 +331,7 @@
"FileKey": {
"base": null,
"refs": {
"S3Configuration$FileKey": null,
"S3Configuration$FileKey": "<p>The name of the object that contains the data.</p>",
"S3ReferenceDataSource$FileKey": "<p>Object key name containing reference data.</p>",
"S3ReferenceDataSourceDescription$FileKey": "<p>Amazon S3 object key name.</p>",
"S3ReferenceDataSourceUpdate$FileKeyUpdate": "<p>Object key name.</p>"
@ -340,11 +340,11 @@
"Id": {
"base": null,
"refs": {
"AddApplicationInputProcessingConfigurationRequest$InputId": "<p>The ID of the input configuration to which to add the input configuration. You can get a list of the input IDs for an application using the <a>DescribeApplication</a> operation.</p>",
"AddApplicationInputProcessingConfigurationRequest$InputId": "<p>The ID of the input configuration to add the input processing configuration to. You can get a list of the input IDs for an application using the <a>DescribeApplication</a> operation.</p>",
"CloudWatchLoggingOptionDescription$CloudWatchLoggingOptionId": "<p>ID of the CloudWatch logging option description.</p>",
"CloudWatchLoggingOptionUpdate$CloudWatchLoggingOptionId": "<p>ID of the CloudWatch logging option to update</p>",
"DeleteApplicationCloudWatchLoggingOptionRequest$CloudWatchLoggingOptionId": "<p>The <code>CloudWatchLoggingOptionId</code> of the CloudWatch logging option to delete. You can use the <a>DescribeApplication</a> operation to get the <code>CloudWatchLoggingOptionId</code>. </p>",
"DeleteApplicationInputProcessingConfigurationRequest$InputId": "<p>The ID of the input configuration from which to delete the input configuration. You can get a list of the input IDs for an application using the <a>DescribeApplication</a> operation.</p>",
"DeleteApplicationCloudWatchLoggingOptionRequest$CloudWatchLoggingOptionId": "<p>The <code>CloudWatchLoggingOptionId</code> of the CloudWatch logging option to delete. You can get the <code>CloudWatchLoggingOptionId</code> by using the <a>DescribeApplication</a> operation. </p>",
"DeleteApplicationInputProcessingConfigurationRequest$InputId": "<p>The ID of the input configuration from which to delete the input processing configuration. You can get a list of the input IDs for an application by using the <a>DescribeApplication</a> operation.</p>",
"DeleteApplicationOutputRequest$OutputId": "<p>The ID of the configuration to delete. Each output configuration that is added to the application, either when the application is created or later using the <a>AddApplicationOutput</a> operation, has a unique ID. You need to provide the ID to uniquely identify the output configuration that you want to delete from the application configuration. You can use the <a>DescribeApplication</a> operation to get the specific <code>OutputId</code>. </p>",
"DeleteApplicationReferenceDataSourceRequest$ReferenceId": "<p>ID of the reference data source. When you add a reference data source to your application using the <a>AddApplicationReferenceDataSource</a>, Amazon Kinesis Analytics assigns an ID. You can use the <a>DescribeApplication</a> operation to get the reference ID. </p>",
"InputConfiguration$Id": "<p>Input source ID. You can get this ID by calling the <a>DescribeApplication</a> operation.</p>",
@ -360,7 +360,7 @@
"base": null,
"refs": {
"InAppStreamNames$member": null,
"Input$NamePrefix": "<p>Name prefix to use when creating in-application stream. Suppose you specify a prefix \"MyInApplicationStream\". Amazon Kinesis Analytics will then create one or more (as per the <code>InputParallelism</code> count you specified) in-application streams with names \"MyInApplicationStream_001\", \"MyInApplicationStream_002\" and so on. </p>",
"Input$NamePrefix": "<p>Name prefix to use when creating an in-application stream. Suppose that you specify a prefix \"MyInApplicationStream.\" Amazon Kinesis Analytics then creates one or more (as per the <code>InputParallelism</code> count you specified) in-application streams with names \"MyInApplicationStream_001,\" \"MyInApplicationStream_002,\" and so on. </p>",
"InputDescription$NamePrefix": "<p>In-application name prefix.</p>",
"InputUpdate$NamePrefixUpdate": "<p>Name prefix for in-application streams that Amazon Kinesis Analytics creates for the specific streaming source.</p>",
"Output$Name": "<p>Name of the in-application stream.</p>",
@ -414,13 +414,13 @@
}
},
"InputLambdaProcessor": {
"base": "<p>An object that contains the ARN of the <a href=\"https://aws.amazon.com/documentation/lambda/\">AWS Lambda</a> function that is used to preprocess records in the stream, and the ARN of the IAM role used to access the AWS Lambda function. </p>",
"base": "<p>An object that contains the Amazon Resource Name (ARN) of the <a href=\"https://aws.amazon.com/documentation/lambda/\">AWS Lambda</a> function that is used to preprocess records in the stream, and the ARN of the IAM role that is used to access the AWS Lambda function. </p>",
"refs": {
"InputProcessingConfiguration$InputLambdaProcessor": "<p>The <a>InputLambdaProcessor</a> that is used to preprocess the records in the stream prior to being processed by your application code.</p>"
"InputProcessingConfiguration$InputLambdaProcessor": "<p>The <a>InputLambdaProcessor</a> that is used to preprocess the records in the stream before being processed by your application code.</p>"
}
},
"InputLambdaProcessorDescription": {
"base": "<p>An object that contains the ARN of the <a href=\"https://aws.amazon.com/documentation/lambda/\">AWS Lambda</a> function that is used to preprocess records in the stream, and the ARN of the IAM role used to access the AWS Lambda expression.</p>",
"base": "<p>An object that contains the Amazon Resource Name (ARN) of the <a href=\"https://aws.amazon.com/documentation/lambda/\">AWS Lambda</a> function that is used to preprocess records in the stream, and the ARN of the IAM role that is used to access the AWS Lambda expression.</p>",
"refs": {
"InputProcessingConfigurationDescription$InputLambdaProcessorDescription": "<p>Provides configuration information about the associated <a>InputLambdaProcessorDescription</a>.</p>"
}
@ -434,7 +434,7 @@
"InputParallelism": {
"base": "<p>Describes the number of in-application streams to create for a given streaming source. For information about parallelism, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html\">Configuring Application Input</a>. </p>",
"refs": {
"Input$InputParallelism": "<p>Describes the number of in-application streams to create. </p> <p>Data from your source will be routed to these in-application input streams.</p> <p> (see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html\">Configuring Application Input</a>.</p>",
"Input$InputParallelism": "<p>Describes the number of in-application streams to create. </p> <p>Data from your source is routed to these in-application input streams.</p> <p> (see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/how-it-works-input.html\">Configuring Application Input</a>.</p>",
"InputDescription$InputParallelism": "<p>Describes the configured parallelism (number of in-application streams mapped to the streaming source).</p>"
}
},
@ -452,11 +452,11 @@
}
},
"InputProcessingConfiguration": {
"base": "<p>Provides a description of a processor that is used to preprocess the records in the stream prior to being processed by your application code. Currently, the only input processor available is <a href=\"https://aws.amazon.com/documentation/lambda/\">AWS Lambda</a>.</p>",
"base": "<p>Provides a description of a processor that is used to preprocess the records in the stream before being processed by your application code. Currently, the only input processor available is <a href=\"https://aws.amazon.com/documentation/lambda/\">AWS Lambda</a>.</p>",
"refs": {
"AddApplicationInputProcessingConfigurationRequest$InputProcessingConfiguration": "<p>The <a>InputProcessingConfiguration</a> to add to the application.</p>",
"DiscoverInputSchemaRequest$InputProcessingConfiguration": "<p>The <a>InputProcessingConfiguration</a> to use to preprocess the records before discovering the schema of the records.</p>",
"Input$InputProcessingConfiguration": "<p>The <a>InputProcessingConfiguration</a> for the Input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is <a>InputLambdaProcessor</a>.</p>"
"Input$InputProcessingConfiguration": "<p>The <a>InputProcessingConfiguration</a> for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is <a>InputLambdaProcessor</a>.</p>"
}
},
"InputProcessingConfigurationDescription": {
@ -480,7 +480,7 @@
"InputStartingPosition": {
"base": null,
"refs": {
"InputStartingPositionConfiguration$InputStartingPosition": "<p>The starting position on the stream.</p> <ul> <li> <p> <code>NOW</code> - Start reading just after the most recent record in the stream, start at the request timestamp that the customer issued.</p> </li> <li> <p> <code>TRIM_HORIZON</code> - Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Firehose delivery stream.</p> </li> <li> <p> <code>LAST_STOPPED_POINT</code> - Resume reading from where the application last stopped reading.</p> </li> </ul>"
"InputStartingPositionConfiguration$InputStartingPosition": "<p>The starting position on the stream.</p> <ul> <li> <p> <code>NOW</code> - Start reading just after the most recent record in the stream, start at the request time stamp that the customer issued.</p> </li> <li> <p> <code>TRIM_HORIZON</code> - Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Firehose delivery stream.</p> </li> <li> <p> <code>LAST_STOPPED_POINT</code> - Resume reading from where the application last stopped reading.</p> </li> </ul>"
}
},
"InputStartingPositionConfiguration": {
@ -506,7 +506,7 @@
"Inputs": {
"base": null,
"refs": {
"CreateApplicationRequest$Inputs": "<p>Use this parameter to configure the application input.</p> <p>You can configure your application to receive input from a single streaming source. In this configuration, you map this streaming source to an in-application stream that is created. Your application code can then query the in-application stream like a table (you can think of it as a constantly updating table).</p> <p>For the streaming source, you provide its Amazon Resource Name (ARN) and format of data on the stream (for example, JSON, CSV, etc). You also must provide an IAM role that Amazon Kinesis Analytics can assume to read this stream on your behalf.</p> <p>To create the in-application stream, you need to specify a schema to transform your data into a schematized version used in SQL. In the schema, you provide the necessary mapping of the data elements in the streaming source to record columns in the in-app stream.</p>"
"CreateApplicationRequest$Inputs": "<p>Use this parameter to configure the application input.</p> <p>You can configure your application to receive input from a single streaming source. In this configuration, you map this streaming source to an in-application stream that is created. Your application code can then query the in-application stream like a table (you can think of it as a constantly updating table).</p> <p>For the streaming source, you provide its Amazon Resource Name (ARN) and format of data on the stream (for example, JSON, CSV, etc.). You also must provide an IAM role that Amazon Kinesis Analytics can assume to read this stream on your behalf.</p> <p>To create the in-application stream, you need to specify a schema to transform your data into a schematized version used in SQL. In the schema, you provide the necessary mapping of the data elements in the streaming source to record columns in the in-app stream.</p>"
}
},
"InvalidApplicationConfigurationException": {
@ -526,21 +526,21 @@
}
},
"KinesisFirehoseInput": {
"base": "<p> Identifies an Amazon Kinesis Firehose delivery stream as the streaming source. You provide the Firehose delivery stream's Amazon Resource Name (ARN) and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf.</p>",
"base": "<p> Identifies an Amazon Kinesis Firehose delivery stream as the streaming source. You provide the delivery stream's Amazon Resource Name (ARN) and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf.</p>",
"refs": {
"Input$KinesisFirehoseInput": "<p>If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the Firehose delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.</p> <p>Note: Either <code>KinesisStreamsInput</code> or <code>KinesisFirehoseInput</code> is required.</p>"
"Input$KinesisFirehoseInput": "<p>If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.</p> <p>Note: Either <code>KinesisStreamsInput</code> or <code>KinesisFirehoseInput</code> is required.</p>"
}
},
"KinesisFirehoseInputDescription": {
"base": "<p> Describes the Amazon Kinesis Firehose delivery stream that is configured as the streaming source in the application input configuration. </p>",
"refs": {
"InputDescription$KinesisFirehoseInputDescription": "<p>If an Amazon Kinesis Firehose delivery stream is configured as a streaming source, provides the Firehose delivery stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.</p>"
"InputDescription$KinesisFirehoseInputDescription": "<p>If an Amazon Kinesis Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.</p>"
}
},
"KinesisFirehoseInputUpdate": {
"base": "<p>When updating application input configuration, provides information about an Amazon Kinesis Firehose delivery stream as the streaming source.</p>",
"refs": {
"InputUpdate$KinesisFirehoseInputUpdate": "<p>If an Amazon Kinesis Firehose delivery stream is the streaming source to be updated, provides an updated stream Amazon Resource Name (ARN) and IAM role ARN.</p>"
"InputUpdate$KinesisFirehoseInputUpdate": "<p>If an Amazon Kinesis Firehose delivery stream is the streaming source to be updated, provides an updated stream ARN and IAM role ARN.</p>"
}
},
"KinesisFirehoseOutput": {
@ -558,11 +558,11 @@
"KinesisFirehoseOutputUpdate": {
"base": "<p> When updating an output configuration using the <a>UpdateApplication</a> operation, provides information about an Amazon Kinesis Firehose delivery stream configured as the destination. </p>",
"refs": {
"OutputUpdate$KinesisFirehoseOutputUpdate": "<p>Describes a Amazon Kinesis Firehose delivery stream as the destination for the output.</p>"
"OutputUpdate$KinesisFirehoseOutputUpdate": "<p>Describes an Amazon Kinesis Firehose delivery stream as the destination for the output.</p>"
}
},
"KinesisStreamsInput": {
"base": "<p> Identifies an Amazon Kinesis stream as the streaming source. You provide the stream's ARN and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf.</p>",
"base": "<p> Identifies an Amazon Kinesis stream as the streaming source. You provide the stream's Amazon Resource Name (ARN) and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf.</p>",
"refs": {
"Input$KinesisStreamsInput": "<p>If the streaming source is an Amazon Kinesis stream, identifies the stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.</p> <p>Note: Either <code>KinesisStreamsInput</code> or <code>KinesisFirehoseInput</code> is required.</p>"
}
@ -570,17 +570,17 @@
"KinesisStreamsInputDescription": {
"base": "<p> Describes the Amazon Kinesis stream that is configured as the streaming source in the application input configuration. </p>",
"refs": {
"InputDescription$KinesisStreamsInputDescription": "<p>If an Amazon Kinesis stream is configured as streaming source, provides Amazon Kinesis stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.</p>"
"InputDescription$KinesisStreamsInputDescription": "<p>If an Amazon Kinesis stream is configured as streaming source, provides Amazon Kinesis stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.</p>"
}
},
"KinesisStreamsInputUpdate": {
"base": "<p>When updating application input configuration, provides information about an Amazon Kinesis stream as the streaming source.</p>",
"refs": {
"InputUpdate$KinesisStreamsInputUpdate": "<p>If a Amazon Kinesis stream is the streaming source to be updated, provides an updated stream ARN and IAM role ARN.</p>"
"InputUpdate$KinesisStreamsInputUpdate": "<p>If an Amazon Kinesis stream is the streaming source to be updated, provides an updated stream Amazon Resource Name (ARN) and IAM role ARN.</p>"
}
},
"KinesisStreamsOutput": {
"base": "<p>When configuring application output, identifies a Amazon Kinesis stream as the destination. You provide the stream Amazon Resource Name (ARN) and also an IAM role ARN that Amazon Kinesis Analytics can use to write to the stream on your behalf.</p>",
"base": "<p>When configuring application output, identifies an Amazon Kinesis stream as the destination. You provide the stream Amazon Resource Name (ARN) and also an IAM role ARN that Amazon Kinesis Analytics can use to write to the stream on your behalf.</p>",
"refs": {
"Output$KinesisStreamsOutput": "<p>Identifies an Amazon Kinesis stream as the destination.</p>"
}
@ -597,6 +597,24 @@
"OutputUpdate$KinesisStreamsOutputUpdate": "<p>Describes an Amazon Kinesis stream as the destination for the output.</p>"
}
},
"LambdaOutput": {
"base": "<p>When configuring application output, identifies an AWS Lambda function as the destination. You provide the function Amazon Resource Name (ARN) and also an IAM role ARN that Amazon Kinesis Analytics can use to write to the function on your behalf. </p>",
"refs": {
"Output$LambdaOutput": "<p>Identifies an AWS Lambda function as the destination.</p>"
}
},
"LambdaOutputDescription": {
"base": "<p>For an application output, describes the AWS Lambda function configured as its destination. </p>",
"refs": {
"OutputDescription$LambdaOutputDescription": "<p>Describes the AWS Lambda function configured as the destination where output is written.</p>"
}
},
"LambdaOutputUpdate": {
"base": "<p>When updating an output configuration using the <a>UpdateApplication</a> operation, provides information about an AWS Lambda function configured as the destination.</p>",
"refs": {
"OutputUpdate$LambdaOutputUpdate": "<p>Describes an AWS Lambda function as the destination for the output.</p>"
}
},
"LimitExceededException": {
"base": "<p>Exceeded the number of applications allowed.</p>",
"refs": {
@ -629,13 +647,13 @@
"MappingParameters": {
"base": "<p>When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.</p>",
"refs": {
"RecordFormat$MappingParameters": null
"RecordFormat$MappingParameters": "<p>When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.</p>"
}
},
"Output": {
"base": "<p> Describes application output configuration in which you identify an in-application stream and a destination where you want the in-application stream data to be written. The destination can be an Amazon Kinesis stream or an Amazon Kinesis Firehose delivery stream. </p> <p/> <p>For limits on how many destinations an application can write and other limitations, see <a href=\"http://docs.aws.amazon.com/kinesisanalytics/latest/dev/limits.html\">Limits</a>. </p>",
"refs": {
"AddApplicationOutputRequest$Output": "<p>An array of objects, each describing one output configuration. In the output configuration, you specify the name of an in-application stream, a destination (that is, an Amazon Kinesis stream or an Amazon Kinesis Firehose delivery stream), and record the formation to use when writing to the destination.</p>",
"AddApplicationOutputRequest$Output": "<p>An array of objects, each describing one output configuration. In the output configuration, you specify the name of an in-application stream, a destination (that is, an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an Amazon Lambda function), and record the formation to use when writing to the destination.</p>",
"Outputs$member": null
}
},
@ -666,7 +684,7 @@
"Outputs": {
"base": null,
"refs": {
"CreateApplicationRequest$Outputs": "<p>You can configure application output to write data from any of the in-application streams to up to five destinations.</p> <p>These destinations can be Amazon Kinesis streams, Amazon Kinesis Firehose delivery streams, or both.</p> <p>In the configuration, you specify the in-application stream name, the destination stream Amazon Resource Name (ARN), and the format to use when writing data. You must also provide an IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf.</p> <p>In the output configuration, you also provide the output stream Amazon Resource Name (ARN) and the format of data in the stream (for example, JSON, CSV). You also must provide an IAM role that Amazon Kinesis Analytics can assume to write to this stream on your behalf.</p>"
"CreateApplicationRequest$Outputs": "<p>You can configure application output to write data from any of the in-application streams to up to three destinations.</p> <p>These destinations can be Amazon Kinesis streams, Amazon Kinesis Firehose delivery streams, Amazon Lambda destinations, or any combination of the three.</p> <p>In the configuration, you specify the in-application stream name, the destination stream or Lambda function Amazon Resource Name (ARN), and the format to use when writing data. You must also provide an IAM role that Amazon Kinesis Analytics can assume to write to the destination stream or Lambda function on your behalf.</p> <p>In the output configuration, you also provide the output stream or Lambda function ARN. For stream destinations, you provide the format of data in the stream (for example, JSON, CSV). You also must provide an IAM role that Amazon Kinesis Analytics can assume to write to the stream or Lambda function on your behalf.</p>"
}
},
"ParsedInputRecord": {
@ -821,10 +839,10 @@
"DiscoverInputSchemaRequest$ResourceARN": "<p>Amazon Resource Name (ARN) of the streaming source.</p>",
"InputLambdaProcessor$ResourceARN": "<p>The ARN of the <a href=\"https://aws.amazon.com/documentation/lambda/\">AWS Lambda</a> function that operates on records in the stream.</p>",
"InputLambdaProcessorDescription$ResourceARN": "<p>The ARN of the <a href=\"https://aws.amazon.com/documentation/lambda/\">AWS Lambda</a> function that is used to preprocess the records in the stream.</p>",
"InputLambdaProcessorUpdate$ResourceARNUpdate": "<p>The ARN of the new <a href=\"https://aws.amazon.com/documentation/lambda/\">AWS Lambda</a> function that is used to preprocess the records in the stream.</p>",
"KinesisFirehoseInput$ResourceARN": "<p>ARN of the input Firehose delivery stream.</p>",
"InputLambdaProcessorUpdate$ResourceARNUpdate": "<p>The Amazon Resource Name (ARN) of the new <a href=\"https://aws.amazon.com/documentation/lambda/\">AWS Lambda</a> function that is used to preprocess the records in the stream.</p>",
"KinesisFirehoseInput$ResourceARN": "<p>ARN of the input delivery stream.</p>",
"KinesisFirehoseInputDescription$ResourceARN": "<p>Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.</p>",
"KinesisFirehoseInputUpdate$ResourceARNUpdate": "<p>ARN of the input Amazon Kinesis Firehose delivery stream to read.</p>",
"KinesisFirehoseInputUpdate$ResourceARNUpdate": "<p>Amazon Resource Name (ARN) of the input Amazon Kinesis Firehose delivery stream to read.</p>",
"KinesisFirehoseOutput$ResourceARN": "<p>ARN of the destination Amazon Kinesis Firehose delivery stream to write to.</p>",
"KinesisFirehoseOutputDescription$ResourceARN": "<p>Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.</p>",
"KinesisFirehoseOutputUpdate$ResourceARNUpdate": "<p>Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream to write to.</p>",
@ -833,7 +851,10 @@
"KinesisStreamsInputUpdate$ResourceARNUpdate": "<p>Amazon Resource Name (ARN) of the input Amazon Kinesis stream to read.</p>",
"KinesisStreamsOutput$ResourceARN": "<p>ARN of the destination Amazon Kinesis stream to write to.</p>",
"KinesisStreamsOutputDescription$ResourceARN": "<p>Amazon Resource Name (ARN) of the Amazon Kinesis stream.</p>",
"KinesisStreamsOutputUpdate$ResourceARNUpdate": "<p>Amazon Resource Name (ARN) of the Amazon Kinesis stream where you want to write the output.</p>"
"KinesisStreamsOutputUpdate$ResourceARNUpdate": "<p>Amazon Resource Name (ARN) of the Amazon Kinesis stream where you want to write the output.</p>",
"LambdaOutput$ResourceARN": "<p>Amazon Resource Name (ARN) of the destination Lambda function to write to.</p>",
"LambdaOutputDescription$ResourceARN": "<p>Amazon Resource Name (ARN) of the destination Lambda function.</p>",
"LambdaOutputUpdate$ResourceARNUpdate": "<p>Amazon Resource Name (ARN) of the destination Lambda function.</p>"
}
},
"ResourceInUseException": {
@ -858,12 +879,12 @@
"CloudWatchLoggingOptionDescription$RoleARN": "<p>IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role used must have the <code>PutLogEvents</code> policy action enabled.</p>",
"CloudWatchLoggingOptionUpdate$RoleARNUpdate": "<p>IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role used must have the <code>PutLogEvents</code> policy action enabled.</p>",
"DiscoverInputSchemaRequest$RoleARN": "<p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf.</p>",
"InputLambdaProcessor$RoleARN": "<p>The ARN of the IAM role used to access the AWS Lambda function.</p>",
"InputLambdaProcessorDescription$RoleARN": "<p>The ARN of the IAM role used to access the AWS Lambda function.</p>",
"InputLambdaProcessorUpdate$RoleARNUpdate": "<p>The ARN of the new IAM role used to access the AWS Lambda function.</p>",
"InputLambdaProcessor$RoleARN": "<p>The ARN of the IAM role that is used to access the AWS Lambda function.</p>",
"InputLambdaProcessorDescription$RoleARN": "<p>The ARN of the IAM role that is used to access the AWS Lambda function.</p>",
"InputLambdaProcessorUpdate$RoleARNUpdate": "<p>The ARN of the new IAM role that is used to access the AWS Lambda function.</p>",
"KinesisFirehoseInput$RoleARN": "<p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to make sure the role has necessary permissions to access the stream.</p>",
"KinesisFirehoseInputDescription$RoleARN": "<p>ARN of the IAM role that Amazon Kinesis Analytics assumes to access the stream.</p>",
"KinesisFirehoseInputUpdate$RoleARNUpdate": "<p>Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant necessary permissions to this role.</p>",
"KinesisFirehoseInputUpdate$RoleARNUpdate": "<p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant necessary permissions to this role.</p>",
"KinesisFirehoseOutput$RoleARN": "<p>ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role.</p>",
"KinesisFirehoseOutputDescription$RoleARN": "<p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.</p>",
"KinesisFirehoseOutputUpdate$RoleARNUpdate": "<p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant necessary permissions to this role.</p>",
@ -873,22 +894,25 @@
"KinesisStreamsOutput$RoleARN": "<p>ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role.</p>",
"KinesisStreamsOutputDescription$RoleARN": "<p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.</p>",
"KinesisStreamsOutputUpdate$RoleARNUpdate": "<p>ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.</p>",
"S3Configuration$RoleARN": null,
"LambdaOutput$RoleARN": "<p>ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function on your behalf. You need to grant the necessary permissions to this role. </p>",
"LambdaOutputDescription$RoleARN": "<p>ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function.</p>",
"LambdaOutputUpdate$RoleARNUpdate": "<p>ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function on your behalf. You need to grant the necessary permissions to this role. </p>",
"S3Configuration$RoleARN": "<p>IAM ARN of the role used to access the data.</p>",
"S3ReferenceDataSource$ReferenceRoleARN": "<p>ARN of the IAM role that the service can assume to read data on your behalf. This role must have permission for the <code>s3:GetObject</code> action on the object and trust policy that allows Amazon Kinesis Analytics service principal to assume this role.</p>",
"S3ReferenceDataSourceDescription$ReferenceRoleARN": "<p>ARN of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.</p>",
"S3ReferenceDataSourceUpdate$ReferenceRoleARNUpdate": "<p>ARN of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application.</p>"
}
},
"S3Configuration": {
"base": null,
"base": "<p>Provides a description of an Amazon S3 data source, including the Amazon Resource Name (ARN) of the S3 bucket, the ARN of the IAM role that is used to access the bucket, and the name of the S3 object that contains the data.</p>",
"refs": {
"DiscoverInputSchemaRequest$S3Configuration": null
"DiscoverInputSchemaRequest$S3Configuration": "<p>Specify this parameter to discover a schema from data in an S3 object.</p>"
}
},
"S3ReferenceDataSource": {
"base": "<p>Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf.</p> <p>An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the <a>UpdateApplication</a> operation to trigger reloading of data into your application.</p>",
"refs": {
"ReferenceDataSource$S3ReferenceDataSource": null
"ReferenceDataSource$S3ReferenceDataSource": "<p>Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf. An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the <a>UpdateApplication</a> operation to trigger reloading of data into your application. </p>"
}
},
"S3ReferenceDataSourceDescription": {
@ -914,9 +938,9 @@
"DiscoverInputSchemaResponse$InputSchema": "<p>Schema inferred from the streaming source. It identifies the format of the data in the streaming source and how each data element maps to corresponding columns in the in-application stream that you can create.</p>",
"Input$InputSchema": "<p>Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.</p> <p>Also used to describe the format of the reference data source.</p>",
"InputDescription$InputSchema": "<p>Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created. </p>",
"ReferenceDataSource$ReferenceSchema": null,
"ReferenceDataSourceDescription$ReferenceSchema": null,
"ReferenceDataSourceUpdate$ReferenceSchemaUpdate": null
"ReferenceDataSource$ReferenceSchema": "<p>Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.</p>",
"ReferenceDataSourceDescription$ReferenceSchema": "<p>Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.</p>",
"ReferenceDataSourceUpdate$ReferenceSchemaUpdate": "<p>Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream. </p>"
}
},
"StartApplicationRequest": {
@ -942,8 +966,8 @@
"Timestamp": {
"base": null,
"refs": {
"ApplicationDetail$CreateTimestamp": "<p>Timestamp when the application version was created.</p>",
"ApplicationDetail$LastUpdateTimestamp": "<p>Timestamp when the application was last updated.</p>",
"ApplicationDetail$CreateTimestamp": "<p>Time stamp when the application version was created.</p>",
"ApplicationDetail$LastUpdateTimestamp": "<p>Time stamp when the application was last updated.</p>",
"DeleteApplicationRequest$CreateTimestamp": "<p> You can use the <code>DescribeApplication</code> operation to get this value. </p>"
}
},

View file

@ -572,13 +572,13 @@
"type":"string",
"max":100,
"min":1,
"pattern":"^[a-zA-Z]+((_[a-zA-Z]+)*|([a-zA-Z]+_)*|_)"
"pattern":"^([A-Za-z]_?)+$"
},
"AliasNameOrListAll":{
"type":"string",
"max":100,
"min":1,
"pattern":"^(-|^[a-zA-Z]+((_[a-zA-Z]+)*|([a-zA-Z]+_)*))$"
"pattern":"^(-|^([A-Za-z]_?)+$)$"
},
"BadRequestException":{
"type":"structure",
@ -614,7 +614,9 @@
"botName":{"shape":"BotName"},
"createdDate":{"shape":"Timestamp"},
"type":{"shape":"ChannelType"},
"botConfiguration":{"shape":"ChannelConfigurationMap"}
"botConfiguration":{"shape":"ChannelConfigurationMap"},
"status":{"shape":"ChannelStatus"},
"failureReason":{"shape":"String"}
}
},
"BotChannelAssociationList":{
@ -625,7 +627,7 @@
"type":"string",
"max":100,
"min":1,
"pattern":"^[a-zA-Z]+((_[a-zA-Z]+)*|([a-zA-Z]+_)*|_)"
"pattern":"^([A-Za-z]_?)+$"
},
"BotMetadata":{
"type":"structure",
@ -646,7 +648,7 @@
"type":"string",
"max":50,
"min":2,
"pattern":"^[a-zA-Z]+((_[a-zA-Z]+)*|([a-zA-Z]+_)*|_)"
"pattern":"^([A-Za-z]_?)+$"
},
"BotVersions":{
"type":"list",
@ -696,6 +698,14 @@
"min":1,
"sensitive":true
},
"ChannelStatus":{
"type":"string",
"enum":[
"IN_PROGRESS",
"CREATED",
"FAILED"
]
},
"ChannelType":{
"type":"string",
"enum":[
@ -829,7 +839,7 @@
"type":"string",
"max":100,
"min":1,
"pattern":"^([a-zA-Z]|AMAZON.)+((_[a-zA-Z]+)*|([a-zA-Z]+_)*|_)"
"pattern":"^((AMAZON\\.)_?|[A-Za-z]_?)+"
},
"DeleteBotAliasRequest":{
"type":"structure",
@ -1139,7 +1149,9 @@
"botName":{"shape":"BotName"},
"createdDate":{"shape":"Timestamp"},
"type":{"shape":"ChannelType"},
"botConfiguration":{"shape":"ChannelConfigurationMap"}
"botConfiguration":{"shape":"ChannelConfigurationMap"},
"status":{"shape":"ChannelStatus"},
"failureReason":{"shape":"String"}
}
},
"GetBotChannelAssociationsRequest":{
@ -1649,7 +1661,7 @@
"type":"string",
"max":100,
"min":1,
"pattern":"^[a-zA-Z]+((_[a-zA-Z]+)*|([a-zA-Z]+_)*|_)"
"pattern":"^([A-Za-z]_?)+$"
},
"IntentUtteranceList":{
"type":"list",
@ -2011,7 +2023,7 @@
"type":"string",
"max":100,
"min":1,
"pattern":"^[a-zA-Z]+(((_|.)[a-zA-Z]+)*|([a-zA-Z]+(_|.))*|(_|.))"
"pattern":"^([A-Za-z](-|_|.)?)+$"
},
"SlotTypeMetadata":{
"type":"structure",
@ -2031,7 +2043,7 @@
"type":"string",
"max":100,
"min":1,
"pattern":"^[a-zA-Z]+((_[a-zA-Z]+)*|([a-zA-Z]+_)*|_)"
"pattern":"^([A-Za-z]_?)+$"
},
"SlotUtteranceList":{
"type":"list",

View file

@ -13,7 +13,7 @@
"DeleteIntentVersion": "<p>Deletes a specific version of an intent. To delete all versions of a intent, use the <a>DeleteIntent</a> operation. </p> <p>This operation requires permissions for the <code>lex:DeleteIntentVersion</code> action.</p>",
"DeleteSlotType": "<p>Deletes all versions of the slot type, including the <code>$LATEST</code> version. To delete a specific version of the slot type, use the <a>DeleteSlotTypeVersion</a> operation.</p> <p> You can delete a version of a slot type only if it is not referenced. To delete a slot type that is referred to in one or more intents, you must remove those references first. </p> <note> <p> If you get the <code>ResourceInUseException</code> exception, the exception provides an example reference that shows the intent where the slot type is referenced. To remove the reference to the slot type, either update the intent or delete it. If you get the same exception when you attempt to delete the slot type again, repeat until the slot type has no references and the <code>DeleteSlotType</code> call is successful. </p> </note> <p>This operation requires permission for the <code>lex:DeleteSlotType</code> action.</p>",
"DeleteSlotTypeVersion": "<p>Deletes a specific version of a slot type. To delete all versions of a slot type, use the <a>DeleteSlotType</a> operation. </p> <p>This operation requires permissions for the <code>lex:DeleteSlotTypeVersion</code> action.</p>",
"DeleteUtterances": "<p>Deletes stored utterances.</p> <p>Amazon Lex stores the utterances that users send to your bot unless the <code>childDirected</code> field in the bot is set to <code>true</code>. Utterances are stored for 15 days for use with the <a>GetUtterancesView</a> operation, and then stored indefinately for use in improving the ability of your bot to respond to user input.</p> <p>Use the <code>DeleteStoredUtterances</code> operation to manually delete stored utterances for a specific user.</p> <p>This operation requires permissions for the <code>lex:DeleteUtterances</code> action.</p>",
"DeleteUtterances": "<p>Deletes stored utterances.</p> <p>Amazon Lex stores the utterances that users send to your bot unless the <code>childDirected</code> field in the bot is set to <code>true</code>. Utterances are stored for 15 days for use with the <a>GetUtterancesView</a> operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input.</p> <p>Use the <code>DeleteStoredUtterances</code> operation to manually delete stored utterances for a specific user.</p> <p>This operation requires permissions for the <code>lex:DeleteUtterances</code> action.</p>",
"GetBot": "<p>Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias. </p> <p> This operation requires permissions for the <code>lex:GetBot</code> action. </p>",
"GetBotAlias": "<p>Returns information about an Amazon Lex bot alias. For more information about aliases, see <a>versioning-aliases</a>.</p> <p>This operation requires permissions for the <code>lex:GetBotAlias</code> action.</p>",
"GetBotAliases": "<p>Returns a list of aliases for a specified Amazon Lex bot.</p> <p>This operation requires permissions for the <code>lex:GetBotAliases</code> action.</p>",
@ -34,8 +34,8 @@
"GetUtterancesView": "<p>Use the <code>GetUtterancesView</code> operation to get information about the utterances that your users have made to your bot. You can use this list to tune the utterances that your bot responds to.</p> <p>For example, say that you have created a bot to order flowers. After your users have used your bot for a while, use the <code>GetUtterancesView</code> operation to see the requests that they have made and whether they have been successful. You might find that the utterance \"I want flowers\" is not being recognized. You could add this utterance to the <code>OrderFlowers</code> intent so that your bot recognizes that utterance.</p> <p>After you publish a new version of a bot, you can get information about the old version and the new so that you can compare the performance across the two versions. </p> <p>Data is available for the last 15 days. You can request information for up to 5 versions in each request. The response contains information about a maximum of 100 utterances for each version.</p> <p>If the bot's <code>childDirected</code> field is set to <code>true</code>, utterances for the bot are not stored and cannot be retrieved with the <code>GetUtterancesView</code> operation. For more information, see <a>PutBot</a>.</p> <p>This operation requires permissions for the <code>lex:GetUtterancesView</code> action.</p>",
"PutBot": "<p>Creates an Amazon Lex conversational bot or replaces an existing bot. When you create or update a bot you are only required to specify a name. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with a name only, the bot is created or updated but Amazon Lex returns the <code/> response <code>FAILED</code>. You can build the bot after you add one or more intents. For more information about Amazon Lex bots, see <a>how-it-works</a>. </p> <p>If you specify the name of an existing bot, the fields in the request replace the existing values in the <code>$LATEST</code> version of the bot. Amazon Lex removes any fields that you don't provide values for in the request, except for the <code>idleTTLInSeconds</code> and <code>privacySettings</code> fields, which are set to their default values. If you don't specify values for required fields, Amazon Lex throws an exception.</p> <p>This operation requires permissions for the <code>lex:PutBot</code> action. For more information, see <a>auth-and-access-control</a>.</p>",
"PutBotAlias": "<p>Creates an alias for the specified version of the bot or replaces an alias for the specified bot. To change the version of the bot that the alias points to, replace the alias. For more information about aliases, see <a>versioning-aliases</a>.</p> <p>This operation requires permissions for the <code>lex:PutBotAlias</code> action. </p>",
"PutIntent": "<p>Creates an intent or replaces an existing intent.</p> <p>To define the interaction between the user and your bot, you use one or more intents. For a pizza ordering bot, for example, you would create an <code>OrderPizza</code> intent. </p> <p>To create an intent or replace an existing intent, you must provide the following:</p> <ul> <li> <p>Intent name. For example, <code>OrderPizza</code>.</p> </li> <li> <p>Sample utterances. For example, \"Can I order a pizza, please.\" and \"I want to order a pizza.\"</p> </li> <li> <p>Information to be gathered. You specify slot types for the information that your bot will request from the user. You can specify standard slot types, such as a date or a time, or custom slot types such as the size and crust of a pizza.</p> </li> <li> <p>How the intent will be fulfilled. You can provide a Lambda function or configure the intent to return the intent information to the client application. If you use a Lambda function, when all of the intent information is available, Amazon Lex invokes your Lambda function. If you configure your intent to return the intent information to the client application. </p> </li> </ul> <p>You can specify other optional information in the request, such as:</p> <ul> <li> <p>A confirmation prompt to ask the user to confirm an intent. For example, \"Shall I order your pizza?\"</p> </li> <li> <p>A conclusion statement to send to the user after the intent has been fulfilled. For example, \"I placed your pizza order.\"</p> </li> <li> <p>A follow-up prompt that asks the user for additional activity. For example, asking \"Do you want to order a drink with your pizza?\"</p> </li> </ul> <p>If you specify an existing intent name to update the intent, Amazon Lex replaces the values in the <code>$LATEST</code> version of the slot type with the values in the request. Amazon Lex removes fields that you don't provide in the request. If you don't specify the required fields, Amazon Lex throws an exception.</p> <p>For more information, see <a>how-it-works</a>.</p> <p>This operation requires permissions for the <code>lex:PutIntent</code> action.</p>",
"PutSlotType": "<p>Creates a custom slot type or replaces an existing custom slot type.</p> <p>To create a custom slot type, specify a name for the slot type and a set of enumeration values, which are the values that a slot of this type can assume. For more information, see <a>how-it-works</a>.</p> <p>If you specify the name of an existing slot type, the fields in the request replace the existing values in the <code>$LATEST</code> version of the slot type. Amazon Lex removes the fields that you don't provide in the request. If you don't specify required fields, Amazon Lex throws an exception.</p> <p>This operation requires permissions for the <code>lex:PutSlotType</code> action.</p>"
"PutIntent": "<p>Creates an intent or replaces an existing intent.</p> <p>To define the interaction between the user and your bot, you use one or more intents. For a pizza ordering bot, for example, you would create an <code>OrderPizza</code> intent. </p> <p>To create an intent or replace an existing intent, you must provide the following:</p> <ul> <li> <p>Intent name. For example, <code>OrderPizza</code>.</p> </li> <li> <p>Sample utterances. For example, \"Can I order a pizza, please.\" and \"I want to order a pizza.\"</p> </li> <li> <p>Information to be gathered. You specify slot types for the information that your bot will request from the user. You can specify standard slot types, such as a date or a time, or custom slot types such as the size and crust of a pizza.</p> </li> <li> <p>How the intent will be fulfilled. You can provide a Lambda function or configure the intent to return the intent information to the client application. If you use a Lambda function, when all of the intent information is available, Amazon Lex invokes your Lambda function. If you configure your intent to return the intent information to the client application. </p> </li> </ul> <p>You can specify other optional information in the request, such as:</p> <ul> <li> <p>A confirmation prompt to ask the user to confirm an intent. For example, \"Shall I order your pizza?\"</p> </li> <li> <p>A conclusion statement to send to the user after the intent has been fulfilled. For example, \"I placed your pizza order.\"</p> </li> <li> <p>A follow-up prompt that asks the user for additional activity. For example, asking \"Do you want to order a drink with your pizza?\"</p> </li> </ul> <p>If you specify an existing intent name to update the intent, Amazon Lex replaces the values in the <code>$LATEST</code> version of the intent with the values in the request. Amazon Lex removes fields that you don't provide in the request. If you don't specify the required fields, Amazon Lex throws an exception. When you update the <code>$LATEST</code> version of an intent, the <code>status</code> field of any bot that uses the <code>$LATEST</code> version of the intent is set to <code>NOT_BUILT</code>.</p> <p>For more information, see <a>how-it-works</a>.</p> <p>This operation requires permissions for the <code>lex:PutIntent</code> action.</p>",
"PutSlotType": "<p>Creates a custom slot type or replaces an existing custom slot type.</p> <p>To create a custom slot type, specify a name for the slot type and a set of enumeration values, which are the values that a slot of this type can assume. For more information, see <a>how-it-works</a>.</p> <p>If you specify the name of an existing slot type, the fields in the request replace the existing values in the <code>$LATEST</code> version of the slot type. Amazon Lex removes the fields that you don't provide in the request. If you don't specify required fields, Amazon Lex throws an exception. When you update the <code>$LATEST</code> version of a slot type, if a bot uses the <code>$LATEST</code> version of an intent that contains the slot type, the bot's <code>status</code> field is set to <code>NOT_BUILT</code>.</p> <p>This operation requires permissions for the <code>lex:PutSlotType</code> action.</p>"
},
"shapes": {
"AliasName": {
@ -219,6 +219,13 @@
"GetBotChannelAssociationResponse$botConfiguration": "<p>Provides information that the messaging platform needs to communicate with the Amazon Lex bot.</p>"
}
},
"ChannelStatus": {
"base": null,
"refs": {
"BotChannelAssociation$status": "<p>The status of the bot channel. </p> <ul> <li> <p> <code>CREATED</code> - The channel has been created and is ready for use.</p> </li> <li> <p> <code>IN_PROGRESS</code> - Channel creation is in progress.</p> </li> <li> <p> <code>FAILED</code> - There was an error creating the channel. For information about the reason for the failure, see the <code>failureReason</code> field.</p> </li> </ul>",
"GetBotChannelAssociationResponse$status": "<p>The status of the bot channel. </p> <ul> <li> <p> <code>CREATED</code> - The channel has been created and is ready for use.</p> </li> <li> <p> <code>IN_PROGRESS</code> - Channel creation is in progress.</p> </li> <li> <p> <code>FAILED</code> - There was an error creating the channel. For information about the reason for the failure, see the <code>failureReason</code> field.</p> </li> </ul>"
}
},
"ChannelType": {
"base": null,
"refs": {
@ -1012,6 +1019,7 @@
"refs": {
"BadRequestException$message": null,
"BotAliasMetadata$checksum": "<p>Checksum of the bot alias.</p>",
"BotChannelAssociation$failureReason": "<p>If <code>status</code> is <code>FAILED</code>, Amazon Lex provides the reason that it failed to create the association.</p>",
"BuiltinIntentSlot$name": "<p>A list of the slots defined for the intent.</p>",
"ChannelConfigurationMap$key": null,
"ChannelConfigurationMap$value": null,
@ -1025,6 +1033,7 @@
"CreateSlotTypeVersionRequest$checksum": "<p>Checksum for the <code>$LATEST</code> version of the slot type that you want to publish. If you specify a checksum and the <code>$LATEST</code> version of the slot type has a different checksum, Amazon Lex returns a <code>PreconditionFailedException</code> exception and doesn't publish the new version. If you don't specify a checksum, Amazon Lex publishes the <code>$LATEST</code> version.</p>",
"CreateSlotTypeVersionResponse$checksum": "<p>Checksum of the <code>$LATEST</code> version of the slot type.</p>",
"GetBotAliasResponse$checksum": "<p>Checksum of the bot alias.</p>",
"GetBotChannelAssociationResponse$failureReason": "<p>If <code>status</code> is <code>FAILED</code>, Amazon Lex provides the reason that it failed to create the association.</p>",
"GetBotRequest$versionOrAlias": "<p>The version or alias of the bot.</p>",
"GetBotResponse$failureReason": "<p>If <code>status</code> is <code>FAILED</code>, Amazon Lex explains why it failed to build the bot.</p>",
"GetBotResponse$voiceId": "<p>The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see <a>PutBot</a>.</p>",

View file

@ -3,7 +3,7 @@
"service": "<p>An AWS Elemental MediaStore asset is an object, similar to an object in the Amazon S3 service. Objects are the fundamental entities that are stored in AWS Elemental MediaStore.</p>",
"operations": {
"DeleteObject": "<p>Deletes an object at the specified path.</p>",
"DescribeObject": "<p>Gets the header for an object at the specified path.</p>",
"DescribeObject": "<p>Gets the headers for an object at the specified path.</p>",
"GetObject": "<p>Downloads the object at the specified path.</p>",
"ListItems": "<p>Provides a list of metadata entries about folders and objects in the specified folder.</p>",
"PutObject": "<p>Uploads an object to the specified path. Object sizes are limited to 10 MB.</p>"
@ -160,8 +160,8 @@
"PayloadBlob": {
"base": null,
"refs": {
"GetObjectResponse$Body": "<p>The path to the file outside of the container. The file name can include or omit an extension. </p> <p>Example 1: If the file is stored on a remote server that has been mounted to the workstation on which the REST API command is being run, the path could be the absolute path <code> \\mount\\assets\\mlaw.avi</code> or the relative path <code>..\\..\\mount\\assets\\movies\\premium\\mlaw.avi</code>.</p> <p>Example 2: If the file is stored on a remote server that is not mounted, the path could be <code>https:\\\\192.0.2.15\\movies\\premium\\mlaw.avi</code>.</p>",
"PutObjectRequest$Body": "<p>The path to the file outside of the container. The file name can include or omit an extension. </p> <p>Example 1: If the file is stored on a remote server that has been mounted to the workstation on which the REST API command is being run, the path could be the absolute path <code> \\mount\\assets\\mlaw.avi</code> or the relative path <code>..\\..\\mount\\assets\\movies\\premium\\mlaw.avi</code>.</p> <p>Example 2: If the file is stored on a remote server that is not mounted, the path could be <code>https:\\\\192.0.2.15\\movies\\premium\\mlaw.avi</code>.</p>"
"GetObjectResponse$Body": "<p>The bytes of the object. </p>",
"PutObjectRequest$Body": "<p>The bytes to be stored. </p>"
}
},
"PutObjectRequest": {

View file

@ -366,6 +366,10 @@
"type":"list",
"member":{"shape":"Datapoint"}
},
"DatapointsToAlarm":{
"type":"integer",
"min":1
},
"DeleteAlarmsInput":{
"type":"structure",
"required":["AlarmNames"],
@ -375,6 +379,7 @@
},
"DeleteDashboardsInput":{
"type":"structure",
"required":["DashboardNames"],
"members":{
"DashboardNames":{"shape":"DashboardNames"}
}
@ -526,6 +531,7 @@
"FaultDescription":{"type":"string"},
"GetDashboardInput":{
"type":"structure",
"required":["DashboardName"],
"members":{
"DashboardName":{"shape":"DashboardName"}
}
@ -733,6 +739,7 @@
"Period":{"shape":"Period"},
"Unit":{"shape":"StandardUnit"},
"EvaluationPeriods":{"shape":"EvaluationPeriods"},
"DatapointsToAlarm":{"shape":"DatapointsToAlarm"},
"Threshold":{"shape":"Threshold"},
"ComparisonOperator":{"shape":"ComparisonOperator"},
"TreatMissingData":{"shape":"TreatMissingData"},
@ -762,7 +769,8 @@
"ComparisonOperator",
"ExtendedStatistic",
"TreatMissingData",
"EvaluateLowSampleCountPercentile"
"EvaluateLowSampleCountPercentile",
"DatapointsToAlarm"
]
},
"MetricAlarms":{
@ -825,6 +833,10 @@
},
"PutDashboardInput":{
"type":"structure",
"required":[
"DashboardName",
"DashboardBody"
],
"members":{
"DashboardName":{"shape":"DashboardName"},
"DashboardBody":{"shape":"DashboardBody"}
@ -862,6 +874,7 @@
"Period":{"shape":"Period"},
"Unit":{"shape":"StandardUnit"},
"EvaluationPeriods":{"shape":"EvaluationPeriods"},
"DatapointsToAlarm":{"shape":"DatapointsToAlarm"},
"Threshold":{"shape":"Threshold"},
"ComparisonOperator":{"shape":"ComparisonOperator"},
"TreatMissingData":{"shape":"TreatMissingData"},

View file

@ -14,7 +14,7 @@
"ListDashboards": "<p>Returns a list of the dashboards for your account. If you include <code>DashboardNamePrefix</code>, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed. </p>",
"ListMetrics": "<p>List the specified metrics. You can use the returned metrics with <a>GetMetricStatistics</a> to obtain statistical data.</p> <p>Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.</p> <p>After you create a metric, allow up to fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using <a>GetMetricStatistics</a>.</p>",
"PutDashboard": "<p>Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.</p> <p>You can have up to 500 dashboards per account. All dashboards in your account are global, not region-specific.</p> <p>A simple way to create a dashboard using <code>PutDashboard</code> is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use <code>GetDashboard</code>, and then use the data returned within <code>DashboardBody</code> as the template for the new dashboard when you call <code>PutDashboard</code>.</p> <p>When you create a dashboard with <code>PutDashboard</code>, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the <code>DashboardBody</code> script or the CloudFormation template used to create the dashboard.</p>",
"PutMetricAlarm": "<p>Creates or updates an alarm and associates it with the specified metric. Optionally, this operation can associate one or more Amazon SNS resources with the alarm.</p> <p>When this operation creates an alarm, the alarm state is immediately set to <code>INSUFFICIENT_DATA</code>. The alarm is evaluated and its state is set appropriately. Any actions associated with the state are then executed.</p> <p>When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.</p> <p>If you are an IAM user, you must have Amazon EC2 permissions for some operations:</p> <ul> <li> <p> <code>ec2:DescribeInstanceStatus</code> and <code>ec2:DescribeInstances</code> for all alarms on EC2 instance status metrics</p> </li> <li> <p> <code>ec2:StopInstances</code> for alarms with stop actions</p> </li> <li> <p> <code>ec2:TerminateInstances</code> for alarms with terminate actions</p> </li> <li> <p> <code>ec2:DescribeInstanceRecoveryAttribute</code> and <code>ec2:RecoverInstances</code> for alarms with recover actions</p> </li> </ul> <p>If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm, but the stop or terminate actions are not performed. However, if you are later granted the required permissions, the alarm actions that you created earlier are performed.</p> <p>If you are using an IAM role (for example, an EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies.</p> <p>If you are using temporary security credentials granted using AWS STS, you cannot stop or terminate an EC2 instance using alarm actions.</p> <p>You must create at least one stop, terminate, or reboot alarm using either the Amazon EC2 or CloudWatch consoles to create the <b>EC2ActionsAccess</b> IAM role. After this IAM role is created, you can create stop, terminate, or reboot alarms using a command-line interface or API.</p>",
"PutMetricAlarm": "<p>Creates or updates an alarm and associates it with the specified metric. Optionally, this operation can associate one or more Amazon SNS resources with the alarm.</p> <p>When this operation creates an alarm, the alarm state is immediately set to <code>INSUFFICIENT_DATA</code>. The alarm is evaluated and its state is set appropriately. Any actions associated with the state are then executed.</p> <p>When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.</p> <p>If you are an IAM user, you must have Amazon EC2 permissions for some operations:</p> <ul> <li> <p> <code>iam:CreateServiceLinkedRole</code> for all alarms with EC2 actions</p> </li> <li> <p> <code>ec2:DescribeInstanceStatus</code> and <code>ec2:DescribeInstances</code> for all alarms on EC2 instance status metrics</p> </li> <li> <p> <code>ec2:StopInstances</code> for alarms with stop actions</p> </li> <li> <p> <code>ec2:TerminateInstances</code> for alarms with terminate actions</p> </li> <li> <p> <code>ec2:DescribeInstanceRecoveryAttribute</code> and <code>ec2:RecoverInstances</code> for alarms with recover actions</p> </li> </ul> <p>If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm, but the stop or terminate actions are not performed. However, if you are later granted the required permissions, the alarm actions that you created earlier are performed.</p> <p>If you are using an IAM role (for example, an EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies.</p> <p>If you are using temporary security credentials granted using AWS STS, you cannot stop or terminate an EC2 instance using alarm actions.</p> <p>You must create at least one stop, terminate, or reboot alarm using either the Amazon EC2 or CloudWatch consoles to create the <b>EC2ActionsAccess</b> IAM role. After this IAM role is created, you can create stop, terminate, or reboot alarms using a command-line interface or API.</p>",
"PutMetricData": "<p>Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to <a>ListMetrics</a>.</p> <p>Each <code>PutMetricData</code> request is limited to 40 KB in size for HTTP POST requests.</p> <p>Although the <code>Value</code> parameter accepts numbers of type <code>Double</code>, CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.</p> <p>You can use up to 10 dimensions per metric to further clarify what data the metric collects. For more information about specifying dimensions, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html\">Publishing Metrics</a> in the <i>Amazon CloudWatch User Guide</i>.</p> <p>Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for <a>GetMetricStatistics</a> from the time they are submitted.</p> <p>CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:</p> <ul> <li> <p>The SampleCount value of the statistic set is 1</p> </li> <li> <p>The Min and the Max values of the statistic set are equal</p> </li> </ul>",
"SetAlarmState": "<p>Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to <code>ALARM</code> sends an SNS message. The alarm returns to its actual state (often within seconds). Because the alarm state change happens quickly, it is typically only visible in the alarm's <b>History</b> tab in the Amazon CloudWatch console or through <a>DescribeAlarmHistory</a>.</p>"
},
@ -109,7 +109,7 @@
"base": null,
"refs": {
"GetDashboardOutput$DashboardBody": "<p>The detailed information about the dashboard, including what widgets are included and their location on the dashboard. For more information about the <code>DashboardBody</code> syntax, see <a>CloudWatch-Dashboard-Body-Structure</a>. </p>",
"PutDashboardInput$DashboardBody": "<p>The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard.</p> <p>For more information about the syntax, see <a>CloudWatch-Dashboard-Body-Structure</a>.</p>"
"PutDashboardInput$DashboardBody": "<p>The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard. This parameter is required.</p> <p>For more information about the syntax, see <a>CloudWatch-Dashboard-Body-Structure</a>.</p>"
}
},
"DashboardEntries": {
@ -143,7 +143,7 @@
"DashboardNames$member": null,
"GetDashboardInput$DashboardName": "<p>The name of the dashboard to be described.</p>",
"GetDashboardOutput$DashboardName": "<p>The name of the dashboard.</p>",
"PutDashboardInput$DashboardName": "<p>The name of the dashboard. If a dashboard with this name already exists, this call modifies that dashboard, replacing its current contents. Otherwise, a new dashboard is created. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, \"-\", and \"_\".</p>"
"PutDashboardInput$DashboardName": "<p>The name of the dashboard. If a dashboard with this name already exists, this call modifies that dashboard, replacing its current contents. Otherwise, a new dashboard is created. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, \"-\", and \"_\". This parameter is required.</p>"
}
},
"DashboardNamePrefix": {
@ -155,7 +155,7 @@
"DashboardNames": {
"base": null,
"refs": {
"DeleteDashboardsInput$DashboardNames": "<p>The dashboards to be deleted.</p>"
"DeleteDashboardsInput$DashboardNames": "<p>The dashboards to be deleted. This parameter is required.</p>"
}
},
"DashboardNotFoundError": {
@ -216,6 +216,13 @@
"GetMetricStatisticsOutput$Datapoints": "<p>The data points for the specified metric.</p>"
}
},
"DatapointsToAlarm": {
"base": null,
"refs": {
"MetricAlarm$DatapointsToAlarm": "<p>The number of datapoints that must be breaching to trigger the alarm.</p>",
"PutMetricAlarmInput$DatapointsToAlarm": "<p>The number of datapoints that must be breaching to trigger the alarm.</p>"
}
},
"DeleteAlarmsInput": {
"base": null,
"refs": {
@ -344,7 +351,7 @@
"DescribeAlarmsForMetricInput$ExtendedStatistic": "<p>The percentile statistic for the metric. Specify a value between p0.0 and p100.</p>",
"ExtendedStatistics$member": null,
"MetricAlarm$ExtendedStatistic": "<p>The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.</p>",
"PutMetricAlarmInput$ExtendedStatistic": "<p>The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.</p>"
"PutMetricAlarmInput$ExtendedStatistic": "<p>The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100. When you call <code>PutMetricAlarm</code>, you must specify either <code>Statistic</code> or <code>ExtendedStatistic,</code> but not both.</p>"
}
},
"ExtendedStatistics": {
@ -587,9 +594,9 @@
"MetricAlarm$OKActions": "<p>The actions to execute when this alarm transitions to the <code>OK</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>",
"MetricAlarm$AlarmActions": "<p>The actions to execute when this alarm transitions to the <code>ALARM</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>",
"MetricAlarm$InsufficientDataActions": "<p>The actions to execute when this alarm transitions to the <code>INSUFFICIENT_DATA</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p>",
"PutMetricAlarmInput$OKActions": "<p>The actions to execute when this alarm transitions to an <code>OK</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p> <p>Valid Values: arn:aws:automate:<i>region</i>:ec2:stop | arn:aws:automate:<i>region</i>:ec2:terminate | arn:aws:automate:<i>region</i>:ec2:recover</p> <p>Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{<i>customer-account</i>}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{<i>customer-account</i>}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{<i>customer-account</i>}:action/actions/AWS_EC2.InstanceId.Reboot/1.0</p>",
"PutMetricAlarmInput$AlarmActions": "<p>The actions to execute when this alarm transitions to the <code>ALARM</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p> <p>Valid Values: arn:aws:automate:<i>region</i>:ec2:stop | arn:aws:automate:<i>region</i>:ec2:terminate | arn:aws:automate:<i>region</i>:ec2:recover</p> <p>Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{<i>customer-account</i>}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{<i>customer-account</i>}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{<i>customer-account</i>}:action/actions/AWS_EC2.InstanceId.Reboot/1.0</p>",
"PutMetricAlarmInput$InsufficientDataActions": "<p>The actions to execute when this alarm transitions to the <code>INSUFFICIENT_DATA</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p> <p>Valid Values: arn:aws:automate:<i>region</i>:ec2:stop | arn:aws:automate:<i>region</i>:ec2:terminate | arn:aws:automate:<i>region</i>:ec2:recover</p> <p>Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{<i>customer-account</i>}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{<i>customer-account</i>}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{<i>customer-account</i>}:action/actions/AWS_EC2.InstanceId.Reboot/1.0</p>"
"PutMetricAlarmInput$OKActions": "<p>The actions to execute when this alarm transitions to an <code>OK</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p> <p>Valid Values: arn:aws:automate:<i>region</i>:ec2:stop | arn:aws:automate:<i>region</i>:ec2:terminate | arn:aws:automate:<i>region</i>:ec2:recover | arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> | arn:aws:autoscaling:<i>region</i>:<i>account-id</i>:scalingPolicy:<i>policy-id</i> autoScalingGroupName/<i>group-friendly-name</i>:policyName/<i>policy-friendly-name</i> </p> <p>Valid Values (for use with IAM roles): arn:aws:swf:<i>region</i>:{<i>account-id</i>}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:<i>region</i>:{<i>account-id</i>}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:<i>region</i>:{<i>account-id</i>}:action/actions/AWS_EC2.InstanceId.Reboot/1.0</p>",
"PutMetricAlarmInput$AlarmActions": "<p>The actions to execute when this alarm transitions to the <code>ALARM</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p> <p>Valid Values: arn:aws:automate:<i>region</i>:ec2:stop | arn:aws:automate:<i>region</i>:ec2:terminate | arn:aws:automate:<i>region</i>:ec2:recover | arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> | arn:aws:autoscaling:<i>region</i>:<i>account-id</i>:scalingPolicy:<i>policy-id</i> autoScalingGroupName/<i>group-friendly-name</i>:policyName/<i>policy-friendly-name</i> </p> <p>Valid Values (for use with IAM roles): arn:aws:swf:<i>region</i>:{<i>account-id</i>}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:<i>region</i>:{<i>account-id</i>}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:<i>region</i>:{<i>account-id</i>}:action/actions/AWS_EC2.InstanceId.Reboot/1.0</p>",
"PutMetricAlarmInput$InsufficientDataActions": "<p>The actions to execute when this alarm transitions to the <code>INSUFFICIENT_DATA</code> state from any other state. Each action is specified as an Amazon Resource Name (ARN).</p> <p>Valid Values: arn:aws:automate:<i>region</i>:ec2:stop | arn:aws:automate:<i>region</i>:ec2:terminate | arn:aws:automate:<i>region</i>:ec2:recover | arn:aws:sns:<i>region</i>:<i>account-id</i>:<i>sns-topic-name</i> | arn:aws:autoscaling:<i>region</i>:<i>account-id</i>:scalingPolicy:<i>policy-id</i> autoScalingGroupName/<i>group-friendly-name</i>:policyName/<i>policy-friendly-name</i> </p> <p>Valid Values (for use with IAM roles): arn:aws:swf:<i>region</i>:{<i>account-id</i>}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:<i>region</i>:{<i>account-id</i>}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:<i>region</i>:{<i>account-id</i>}:action/actions/AWS_EC2.InstanceId.Reboot/1.0</p>"
}
},
"ResourceName": {
@ -652,7 +659,7 @@
"refs": {
"DescribeAlarmsForMetricInput$Statistic": "<p>The statistic for the metric, other than percentiles. For percentile statistics, use <code>ExtendedStatistics</code>.</p>",
"MetricAlarm$Statistic": "<p>The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use <code>ExtendedStatistic</code>.</p>",
"PutMetricAlarmInput$Statistic": "<p>The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use <code>ExtendedStatistic</code>.</p>",
"PutMetricAlarmInput$Statistic": "<p>The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use <code>ExtendedStatistic</code>. When you call <code>PutMetricAlarm</code>, you must specify either <code>Statistic</code> or <code>ExtendedStatistic,</code> but not both.</p>",
"Statistics$member": null
}
},

View file

@ -7,6 +7,7 @@
"protocol":"rest-xml",
"serviceAbbreviation":"Route 53",
"serviceFullName":"Amazon Route 53",
"serviceId":"Route 53",
"signatureVersion":"v4",
"uid":"route53-2013-04-01"
},
@ -1101,6 +1102,7 @@
"eu-central-1",
"eu-west-1",
"eu-west-2",
"eu-west-3",
"ap-south-1",
"ap-southeast-1",
"ap-southeast-2",
@ -3176,6 +3178,7 @@
"ca-central-1",
"eu-west-1",
"eu-west-2",
"eu-west-3",
"eu-central-1",
"ap-southeast-1",
"ap-southeast-2",
@ -3183,6 +3186,7 @@
"ap-northeast-2",
"sa-east-1",
"cn-north-1",
"cn-northwest-1",
"ap-south-1"
],
"max":64,
@ -3724,6 +3728,7 @@
"us-west-2",
"eu-west-1",
"eu-west-2",
"eu-west-3",
"eu-central-1",
"ap-southeast-1",
"ap-southeast-2",

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,18 @@
{
"version": 1,
"defaultRegion": "us-east-1",
"testCases": [
{
"operationName": "ListHostedZones",
"input": {},
"errorExpectedFromService": false
},
{
"operationName": "GetHostedZone",
"input": {
"Id": "fake-zone"
},
"errorExpectedFromService": true
}
]
}

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