extern/rclone
1
0
Fork 0
mirror of https://github.com/rclone/rclone.git synced 2025-08-09 21:57:59 +02:00
Code Issues Packages Projects Releases Wiki Activity

vendor: update all dependencies

Browse Source 
* Update all dependencies
  * Remove all `[[constraint]]` from Gopkg.toml
  * Add in the minimum number of `[[override]]` to build
  * Remove go get of github.com/inconshreveable/mousetrap as it is vendored
  * Update docs with new policy on constraints
This commit is contained in:
Nick Craig-Wood
2018-05-02 17:09:45 +01:00
parent 21383877df
commit 6427029c4e
4902 changed files with 1443417 additions and 227283 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
vendor/github.com/aws/aws-sdk-go/.travis.yml generated vendored
View File

@ -1,19 +1,44 @@
language: go
sudo: required
go:
- 1.5.x
- 1.6.x
- 1.7.x
- 1.8.x
- 1.9.x
- 1.10.x
- tip
# Use Go 1.5's vendoring experiment for 1.5 tests.
env:
- GO15VENDOREXPERIMENT=1
matrix:
allow_failures:
- go: tip
- go: 1.6.x
os: linux
include:
- os: linux
sudo: required
go: 1.5.x
# Use Go 1.5's vendoring experiment for 1.5 tests.
env: GO15VENDOREXPERIMENT=1
- os: linux
sudo: required
go: 1.6.x
- os: linux
sudo: required
go: 1.7.x
- os: linux
sudo: required
go: 1.8.x
- os: linux
sudo: required
go: 1.9.x
- os: linux
sudo: required
go: 1.10.x
- os: linux
sudo: required
go: tip
- os: osx
go: 1.7.x
- os: osx
go: 1.8.x
- os: osx
go: 1.9.x
- os: osx
go: 1.10.x
- os: osx
go: tip
install:
- make get-deps
@ -21,10 +46,6 @@ install:
script:
- make unit-with-race-cover
matrix:
allow_failures:
- go: tip
branches:
only:
- master

294
vendor/github.com/aws/aws-sdk-go/CHANGELOG.md generated vendored
View File

@ -1,3 +1,297 @@
Release v1.13.42 (2018-05-04)
===
### Service Client Updates
* `service/guardduty`: Updates service API, documentation, and paginators
* Amazon GuardDuty is adding five new API operations for creating and managing filters. For each filter, you can specify a criteria and an action. The action you specify is applied to findings that match the specified criteria.
Release v1.13.41 (2018-05-03)
===
### Service Client Updates
* `service/appsync`: Updates service API and documentation
* `service/config`: Updates service API and documentation
* `aws/endpoints`: Updated Regions and Endpoints metadata.
* `service/secretsmanager`: Updates service documentation
* Documentation updates for secretsmanager
Release v1.13.40 (2018-05-02)
===
### Service Client Updates
* `service/acm`: Updates service documentation
* Documentation updates for acm
* `service/codepipeline`: Updates service API and documentation
* Added support for webhooks with accompanying definitions as needed in the AWS CodePipeline API Guide.
* `service/ec2`: Updates service API and documentation
* Amazon EC2 Fleet is a new feature that simplifies the provisioning of Amazon EC2 capacity across different EC2 instance types, Availability Zones, and the On-Demand, Reserved Instance, and Spot Instance purchase models. With a single API call, you can now provision capacity to achieve desired scale, performance, and cost.
* `service/ssm`: Updates service API and documentation
* Added support for new parameter, DocumentVersion, for SendCommand API. Users can now specify version of SSM document to be executed on the target(s).
Release v1.13.39 (2018-04-30)
===
### Service Client Updates
* `service/alexaforbusiness`: Updates service API, documentation, and paginators
* `service/dynamodb`: Updates service API and documentation
* Adds two new APIs UpdateGlobalTableSettings and DescribeGlobalTableSettings. This update introduces new constraints in the CreateGlobalTable and UpdateGlobalTable APIs . Tables must have the same write capacity units. If Global Secondary Indexes exist then they must have the same write capacity units and key schema.
* `service/guardduty`: Updates service API and documentation
* You can disable the email notification when inviting GuardDuty members using the disableEmailNotification parameter in the InviteMembers operation.
* `service/route53domains`: Updates service API and documentation
* This release adds a SubmittedSince attribute to the ListOperations API, so you can list operations that were submitted after a specified date and time.
* `service/sagemaker`: Updates service API and documentation
* SageMaker has added support for VPC configuration for both Endpoints and Training Jobs. This allows you to connect from the instances running the Endpoint or Training Job to your VPC and any resources reachable in the VPC rather than being restricted to resources that were internet accessible.
* `service/workspaces`: Updates service API and documentation
* Added new IP Access Control APIs, an API to change the state of a Workspace, and the ADMIN_MAINTENANCE WorkSpace state. With the new IP Access Control APIs, you can now create/delete IP Access Control Groups, add/delete/update rules for IP Access Control Groups, Associate/Disassociate IP Access Control Groups to/from a WorkSpaces Directory, and Describe IP Based Access Control Groups.
Release v1.13.38 (2018-04-26)
===
### Service Client Updates
* `aws/endpoints`: Updated Regions and Endpoints metadata.
* `service/glacier`: Updates service documentation
* Documentation updates for Glacier to fix a broken link
* `service/secretsmanager`: Updates service documentation
* Documentation updates for secretsmanager
Release v1.13.37 (2018-04-25)
===
### Service Client Updates
* `service/codedeploy`: Updates service API and documentation
* AWS CodeDeploy has a new exception that indicates when a GitHub token is not valid.
* `service/rekognition`: Updates service documentation
* Documentation updates for Amazon Rekognition.
* `service/xray`: Updates service API and documentation
* Added PutEncryptionConfig and GetEncryptionConfig APIs for managing data encryption settings. Use PutEncryptionConfig to configure X-Ray to use an AWS Key Management Service customer master key to encrypt trace data at rest.
Release v1.13.36 (2018-04-24)
===
### Service Client Updates
* `service/elasticbeanstalk`: Updates service API and documentation
* Support tracking Elastic Beanstalk resources in AWS Config.
* `service/secretsmanager`: Updates service documentation
* Documentation updates for secretsmanager
Release v1.13.35 (2018-04-23)
===
### Service Client Updates
* `service/autoscaling-plans`: Updates service API and documentation
* `service/iot`: Updates service API and documentation
* Add IotAnalyticsAction which sends message data to an AWS IoT Analytics channel
* `service/iotanalytics`: Adds new service
### SDK Enhancements
* `aws/endpoints`: Add Get Region description to endpoints package ([#1909](https://github.com/aws/aws-sdk-go/pull/1909))
* Adds exposing the description field of the endpoints Region struct.
* Fixes [#1194](https://github.com/aws/aws-sdk-go/issues/1194)
### SDK Bugs
* Fix XML unmarshaler not correctly unmarshaling list of timestamp values ([#1894](https://github.com/aws/aws-sdk-go/pull/1894))
* Fixes a bug in the XML unmarshaler that would incorrectly try to unmarshal "time.Time" parameters that did not have the struct tag type on them. This would occur for nested lists like CloudWatch's GetMetricDataResponse MetricDataResults timestamp parameters.
* Fixes [#1892](https://github.com/aws/aws-sdk-go/issues/1892)
Release v1.13.34 (2018-04-20)
===
### Service Client Updates
* `service/firehose`: Updates service API and documentation
* With this release, Amazon Kinesis Data Firehose allows you to tag your delivery streams. Tags are metadata that you can create and use to manage your delivery streams. For more information about tagging, see AWS Tagging Strategies. For technical documentation, look for the tagging operations in the Amazon Kinesis Firehose API reference.
* `service/medialive`: Updates service API and documentation
* With AWS Elemental MediaLive you can now output live channels as RTMP (Real-Time Messaging Protocol) and RTMPS as the encrypted version of the protocol (Secure, over SSL/TLS). RTMP is the preferred protocol for sending live streams to popular social platforms which means you can send live channel content to social and sharing platforms in a secure and reliable way while continuing to stream to your own website, app or network.
Release v1.13.33 (2018-04-19)
===
### Service Client Updates
* `service/ce`: Updates service API and documentation
* `service/codepipeline`: Updates service API and documentation
* Added new SourceRevision structure to Execution Summary with accompanying definitions as needed in the AWS CodePipeline API Guide.
* `service/devicefarm`: Updates service API and documentation
* Adding support for VPCEndpoint feature. Allows customers to be able to access their private endpoints/services running in their VPC during test automation.
* `service/ec2`: Updates service API and documentation
* Added support for customers to see the time at which a Dedicated Host was allocated or released.
* `service/rds`: Updates service API and documentation
* The ModifyDBCluster operation now includes an EngineVersion parameter. You can use this to upgrade the engine for a clustered database.
* `service/secretsmanager`: Updates service documentation and examples
* Documentation updates
* `service/ssm`: Updates service API and documentation
* Added new APIs DeleteInventory and DescribeInventoryDeletions, for customers to delete their custom inventory data.
Release v1.13.32 (2018-04-10)
===
### Service Client Updates
* `service/dms`: Updates service API and documentation
* Native Change Data Capture start point and task recovery support in Database Migration Service.
* `aws/endpoints`: Updated Regions and Endpoints metadata.
* `service/glue`: Updates service API and documentation
* "AWS Glue now supports timeout values for ETL jobs. With this release, all new ETL jobs have a default timeout value of 48 hours. AWS Glue also now supports the ability to start a schedule or job events trigger when it is created."
* `service/mediapackage`: Updates service API and documentation
* Adds a new OriginEndpoint package type CmafPackage in MediaPackage. Origin endpoints can now be configured to use the Common Media Application Format (CMAF) media streaming format. This version of CmafPackage only supports HTTP Live Streaming (HLS) manifests with fragmented MP4.
* `service/ssm`: Updates service API and documentation
* Added TooManyUpdates exception for AddTagsToResource and RemoveTagsFromResource API
* `service/workmail`: Updates service API, documentation, and paginators
* Amazon WorkMail adds the ability to grant users and groups with "Full Access", "Send As" and "Send on Behalf" permissions on a given mailbox.
Release v1.13.31 (2018-04-09)
===
### Service Client Updates
* `service/clouddirectory`: Updates service API and documentation
* Cloud Directory customers can fetch attributes within a facet on an object with the new GetObjectAttributes API and can fetch attributes from multiple facets or objects with the BatchGetObjectAttributes operation.
* `aws/endpoints`: Updated Regions and Endpoints metadata.
Release v1.13.30 (2018-04-06)
===
### Service Client Updates
* `service/batch`: Updates service API and documentation
* Support for Timeout in SubmitJob and RegisterJobDefinition
Release v1.13.29 (2018-04-05)
===
### Service Client Updates
* `aws/endpoints`: Updated Regions and Endpoints metadata.
* `service/ssm`: Updates service documentation
Release v1.13.28 (2018-04-04)
===
### Service Client Updates
* `service/acm`: Updates service API and documentation
* AWS Certificate Manager has added support for AWS Certificate Manager Private Certificate Authority (CA). Customers can now request private certificates with the RequestCertificate API, and also export private certificates with the ExportCertificate API.
* `service/acm-pca`: Adds new service
* `service/config`: Updates service API and documentation
* `service/fms`: Adds new service
* `service/monitoring`: Updates service API and documentation
* The new GetMetricData API enables you to collect batch amounts of metric data and optionally perform math expressions on the data. With one GetMetricData call you can retrieve as many as 100 different metrics and a total of 100,800 data points.
* `service/s3`: Updates service API and documentation
* ONEZONE_IA storage class stores object data in only one Availability Zone at a lower price than STANDARD_IA. This SDK release provides API support for this new storage class.
* `service/sagemaker`: Updates service API and documentation
* SageMaker is now supporting many additional instance types in previously supported families for Notebooks, Training Jobs, and Endpoints. Training Jobs and Endpoints now support instances in the m5 family in addition to the previously supported instance families. For specific instance types supported please see the documentation for the SageMaker API.
* `service/secretsmanager`: Adds new service
* AWS Secrets Manager enables you to easily create and manage the secrets that you use in your customer-facing apps. Instead of embedding credentials into your source code, you can dynamically query Secrets Manager from your app whenever you need credentials. You can automatically and frequently rotate your secrets without having to deploy updates to your apps. All secret values are encrypted when they're at rest with AWS KMS, and while they're in transit with HTTPS and TLS.
* `service/transcribe`: Updates service API, documentation, and paginators
Release v1.13.27 (2018-04-03)
===
### Service Client Updates
* `service/devicefarm`: Updates service API and documentation
* Added Private Device Management feature. Customers can now manage their private devices efficiently - view their status, set labels and apply profiles on them. Customers can also schedule automated tests and remote access sessions on individual instances in their private device fleet.
* `service/lambda`: Updates service API and documentation
* added nodejs8.10 as a valid runtime
* `service/translate`: Updates service API and documentation
Release v1.13.26 (2018-04-02)
===
### Service Client Updates
* `service/apigateway`: Updates service API and documentation
* Amazon API Gateway now supports resource policies for APIs making it easier to set access controls for invoking APIs.
* `service/cloudfront`: Adds new service
* You can now use a new Amazon CloudFront capability called Field-Level Encryption to further enhance the security of sensitive data, such as credit card numbers or personally identifiable information (PII) like social security numbers. CloudFront's field-level encryption further encrypts sensitive data in an HTTPS form using field-specific encryption keys (which you supply) before a POST request is forwarded to your origin. This ensures that sensitive data can only be decrypted and viewed by certain components or services in your application stack. Field-level encryption is easy to setup. Simply configure the fields that have to be further encrypted by CloudFront using the public keys you specify and you can reduce attack surface for your sensitive data.
* `service/es`: Updates service API and documentation
* This adds Amazon Cognito authentication support to Kibana.
Release v1.13.25 (2018-03-30)
===
### Service Client Updates
* `service/acm`: Updates service API and documentation
* Documentation updates for acm
* `service/connect`: Adds new service
* `aws/endpoints`: Updated Regions and Endpoints metadata.
Release v1.13.24 (2018-03-29)
===
### Service Client Updates
* `service/alexaforbusiness`: Updates service API, documentation, and paginators
* `service/cloudformation`: Updates service API and documentation
* Enabling resource level permission control for StackSets APIs. Adding support for customers to use customized AdministrationRole to create security boundaries between different users.
* `aws/endpoints`: Updated Regions and Endpoints metadata.
* `service/greengrass`: Updates service API and documentation
* Greengrass APIs now support creating Machine Learning resource types and configuring binary data as the input payload for Greengrass Lambda functions.
* `service/ssm`: Updates service API
* This Patch Manager release supports creating patch baselines for CentOS.
Release v1.13.23 (2018-03-28)
===
### Service Client Updates
* `aws/endpoints`: Updated Regions and Endpoints metadata.
* `service/iam`: Updates service API and documentation
* Add support for Longer Role Sessions. Four APIs manage max session duration: GetRole, ListRoles, CreateRole, and the new API UpdateRole. The max session duration integer attribute is measured in seconds.
* `service/mturk-requester`: Updates service API and documentation
* `service/sts`: Updates service API and documentation
* Change utilizes the Max Session Duration attribute introduced for IAM Roles and allows STS customers to request session duration up to the Max Session Duration of 12 hours from AssumeRole based APIs.
Release v1.13.22 (2018-03-27)
===
### Service Client Updates
* `service/acm`: Updates service API and documentation
* AWS Certificate Manager has added support for customers to disable Certificate Transparency logging on a per-certificate basis.
* `aws/endpoints`: Updated Regions and Endpoints metadata.
Release v1.13.21 (2018-03-26)
===
### Service Client Updates
* `service/dynamodb`: Updates service API and documentation
* Point-in-time recovery (PITR) provides continuous backups of your DynamoDB table data. With PITR, you do not have to worry about creating, maintaining, or scheduling backups. You enable PITR on your table and your backup is available for restore at any point in time from the moment you enable it, up to a maximum of the 35 preceding days. PITR provides continuous backups until you explicitly disable it. For more information, see the Amazon DynamoDB Developer Guide.
Release v1.13.20 (2018-03-23)
===
### Service Client Updates
* `service/rds`: Updates service documentation
* Documentation updates for RDS
Release v1.13.19 (2018-03-22)
===
### Service Client Updates
* `service/appstream`: Updates service API and documentation
* Feedback URL allows admins to provide a feedback link or a survey link for collecting user feedback while streaming sessions. When a feedback link is provided, streaming users will see a "Send Feedback" choice in their streaming session toolbar. On selecting this choice, user will be redirected to the link provided in a new browser tab. If a feedback link is not provided, users will not see the "Send Feedback" option.
* `service/codebuild`: Updates service API and documentation
* Adding support for branch filtering when using webhooks with AWS CodeBuild.
* `service/ecs`: Updates service API and documentation
* Amazon Elastic Container Service (ECS) now includes integrated Service Discovery using Route 53 Auto Naming. Customers can now specify a Route 53 Auto Naming service as part of an ECS service. ECS will register task IPs with Route 53, making them available via DNS in your VPC.
* `aws/endpoints`: Updated Regions and Endpoints metadata.
### SDK Bugs
* `aws/endpoints`: Use service metadata for fallback signing name ([#1854](https://github.com/aws/aws-sdk-go/pull/1854))
* Updates the SDK's endpoint resolution to fallback deriving the service's signing name from the service's modeled metadata in addition the the endpoints modeled data.
* Fixes [#1850](https://github.com/aws/aws-sdk-go/issues/1850)
Release v1.13.18 (2018-03-21)
===
### Service Client Updates
* `service/serverlessrepo`: Updates service documentation
Release v1.13.17 (2018-03-20)
===
### Service Client Updates
* `service/ce`: Updates service API and documentation
* `service/config`: Updates service API and documentation
* `service/ecs`: Updates service API and documentation
* Amazon ECS users can now mount a temporary volume in memory in containers and specify the shared memory that a container can use through the use of docker's 'tmpfs' and 'shm-size' features respectively. These fields can be specified under linuxParameters in ContainerDefinition in the Task Definition Template.
* `service/elasticbeanstalk`: Updates service documentation
* Documentation updates for the new Elastic Beanstalk API DescribeAccountAttributes.
* `aws/endpoints`: Updated Regions and Endpoints metadata.
* `service/events`: Updates service API and documentation
* Added SQS FIFO queue target support
* `service/glue`: Updates service API and documentation
* API Updates for DevEndpoint: PublicKey is now optional for CreateDevEndpoint. The new DevEndpoint field PrivateAddress will be populated for DevEndpoints associated with a VPC.
* `service/medialive`: Updates service API and documentation
* AWS Elemental MediaLive has added support for updating Inputs and Input Security Groups. You can update Input Security Groups at any time and it will update all channels using that Input Security Group. Inputs can be updated as long as they are not attached to a currently running channel.
Release v1.13.16 (2018-03-16)
===

2
vendor/github.com/aws/aws-sdk-go/README.md generated vendored
View File

@ -6,7 +6,7 @@ aws-sdk-go is the official AWS SDK for the Go programming language.
Checkout our [release notes](https://github.com/aws/aws-sdk-go/releases) for information about the latest bug fixes, updates, and features added to the SDK.
We [announced](https://aws.amazon.com/blogs/developer/aws-sdk-for-go-2-0-developer-preview/) the Developer Preview for the [v2 AWS SDK for Go](). The v2 SDK is available at https://github.com/aws/aws-sdk-go-v2, and `go get github.com/aws/aws-sdk-go-v2` via `go get`. Check out the v2 SDK's [changes and updates](https://github.com/aws/aws-sdk-go-v2/blob/master/CHANGELOG.md), and let us know what you think. We want your feedback.
We [announced](https://aws.amazon.com/blogs/developer/aws-sdk-for-go-2-0-developer-preview/) the Developer Preview for the [v2 AWS SDK for Go](https://github.com/aws/aws-sdk-go-v2). The v2 SDK is available at https://github.com/aws/aws-sdk-go-v2, and `go get github.com/aws/aws-sdk-go-v2` via `go get`. Check out the v2 SDK's [changes and updates](https://github.com/aws/aws-sdk-go-v2/blob/master/CHANGELOG.md), and let us know what you think. We want your feedback.
## Installing

6
vendor/github.com/aws/aws-sdk-go/aws/client/client.go generated vendored
View File

@ -15,6 +15,12 @@ type Config struct {
Endpoint string
SigningRegion string
SigningName string
// States that the signing name did not come from a modeled source but
// was derived based on other data. Used by service client constructors
// to determine if the signin name can be overriden based on metadata the
// service has.
SigningNameDerived bool
}
// ConfigProvider provides a generic way for a service client to receive

23
vendor/github.com/aws/aws-sdk-go/aws/endpoints/decode.go generated vendored
View File

@ -4,7 +4,6 @@ import (
"encoding/json"
"fmt"
"io"
"os"
"github.com/aws/aws-sdk-go/aws/awserr"
)
@ -85,8 +84,6 @@ func decodeV3Endpoints(modelDef modelDefinition, opts DecodeModelOptions) (Resol
custAddEC2Metadata(p)
custAddS3DualStack(p)
custRmIotDataService(p)
custFixRuntimeSagemakerSigningName(p)
}
return ps, nil
@ -125,26 +122,6 @@ func custRmIotDataService(p *partition) {
delete(p.Services, "data.iot")
}
func custFixRuntimeSagemakerSigningName(p *partition) {
// Workaround for aws/aws-sdk-go#1836
s, ok := p.Services["runtime.sagemaker"]
if !ok {
return
}
if len(s.Defaults.CredentialScope.Service) != 0 {
fmt.Fprintf(os.Stderr, "runtime.sagemaker signing name already set, ignoring override.\n")
// If the value is already set don't override
return
}
s.Defaults.CredentialScope.Service = "sagemaker"
fmt.Fprintf(os.Stderr, "sagemaker signing name not set, overriding.\n")
p.Services["runtime.sagemaker"] = s
}
type decodeModelError struct {
awsError
}

128
vendor/github.com/aws/aws-sdk-go/aws/endpoints/defaults.go generated vendored
View File

@ -47,6 +47,7 @@ const (
const (
A4bServiceID = "a4b" // A4b.
AcmServiceID = "acm" // Acm.
AcmPcaServiceID = "acm-pca" // AcmPca.
ApiPricingServiceID = "api.pricing" // ApiPricing.
ApigatewayServiceID = "apigateway" // Apigateway.
ApplicationAutoscalingServiceID = "application-autoscaling" // ApplicationAutoscaling.
@ -99,6 +100,7 @@ const (
EsServiceID = "es" // Es.
EventsServiceID = "events" // Events.
FirehoseServiceID = "firehose" // Firehose.
FmsServiceID = "fms" // Fms.
GameliftServiceID = "gamelift" // Gamelift.
GlacierServiceID = "glacier" // Glacier.
GlueServiceID = "glue" // Glue.
@ -143,6 +145,7 @@ const (
S3ServiceID = "s3" // S3.
SagemakerServiceID = "sagemaker" // Sagemaker.
SdbServiceID = "sdb" // Sdb.
SecretsmanagerServiceID = "secretsmanager" // Secretsmanager.
ServerlessrepoServiceID = "serverlessrepo" // Serverlessrepo.
ServicecatalogServiceID = "servicecatalog" // Servicecatalog.
ServicediscoveryServiceID = "servicediscovery" // Servicediscovery.
@ -287,6 +290,22 @@ var awsPartition = partition{
"us-west-2": endpoint{},
},
},
"acm-pca": service{
Defaults: endpoint{
Protocols: []string{"https"},
},
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{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
"us-west-2": endpoint{},
},
},
"api.pricing": service{
Defaults: endpoint{
CredentialScope: credentialScope{
@ -584,16 +603,43 @@ var awsPartition = partition{
Endpoints: endpoints{
"ap-northeast-1": endpoint{},
"ap-northeast-2": endpoint{},
"ap-south-1": endpoint{},
"ap-southeast-1": endpoint{},
"ap-southeast-2": endpoint{},
"ca-central-1": endpoint{},
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
"us-west-1": endpoint{},
"us-west-2": endpoint{},
"us-east-1-fips": endpoint{
Hostname: "codebuild-fips.us-east-1.amazonaws.com",
CredentialScope: credentialScope{
Region: "us-east-1",
},
},
"us-east-2": endpoint{},
"us-east-2-fips": endpoint{
Hostname: "codebuild-fips.us-east-2.amazonaws.com",
CredentialScope: credentialScope{
Region: "us-east-2",
},
},
"us-west-1": endpoint{},
"us-west-1-fips": endpoint{
Hostname: "codebuild-fips.us-west-1.amazonaws.com",
CredentialScope: credentialScope{
Region: "us-west-1",
},
},
"us-west-2": endpoint{},
"us-west-2-fips": endpoint{
Hostname: "codebuild-fips.us-west-2.amazonaws.com",
CredentialScope: credentialScope{
Region: "us-west-2",
},
},
},
},
"codecommit": service{
@ -608,6 +654,7 @@ var awsPartition = partition{
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -777,6 +824,7 @@ var awsPartition = partition{
"eu-west-1": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
"us-west-1": endpoint{},
"us-west-2": endpoint{},
},
@ -1002,6 +1050,7 @@ var awsPartition = partition{
"eu-west-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
"us-west-1": endpoint{},
"us-west-2": endpoint{},
},
},
@ -1139,6 +1188,15 @@ var awsPartition = partition{
"us-west-2": endpoint{},
},
},
"fms": service{
Defaults: endpoint{
Protocols: []string{"https"},
},
Endpoints: endpoints{
"us-east-1": endpoint{},
"us-west-2": endpoint{},
},
},
"gamelift": service{
Endpoints: endpoints{
@ -1183,6 +1241,10 @@ var awsPartition = partition{
Endpoints: endpoints{
"ap-northeast-1": endpoint{},
"ap-south-1": endpoint{},
"ap-southeast-1": endpoint{},
"ap-southeast-2": endpoint{},
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
@ -1217,6 +1279,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{},
@ -1422,12 +1485,17 @@ 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{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
"us-west-1": endpoint{},
"us-west-2": endpoint{},
},
@ -1447,11 +1515,13 @@ var awsPartition = partition{
Endpoints: endpoints{
"ap-northeast-1": endpoint{},
"ap-northeast-2": endpoint{},
"ap-southeast-1": endpoint{},
"ap-southeast-2": endpoint{},
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-3": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-west-2": endpoint{},
},
@ -1501,6 +1571,7 @@ var awsPartition = partition{
Endpoints: endpoints{
"eu-west-1": endpoint{},
"us-east-1": endpoint{},
"us-west-2": endpoint{},
},
},
"monitoring": service{
@ -1712,14 +1783,11 @@ var awsPartition = partition{
Endpoints: endpoints{
"eu-west-1": endpoint{},
"us-east-1": endpoint{},
"us-west-2": endpoint{},
},
},
"runtime.sagemaker": service{
Defaults: endpoint{
CredentialScope: credentialScope{
Service: "sagemaker",
},
},
Endpoints: endpoints{
"eu-west-1": endpoint{},
"us-east-1": endpoint{},
@ -1813,6 +1881,25 @@ var awsPartition = partition{
"us-west-2": endpoint{},
},
},
"secretsmanager": service{
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{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-east-2": endpoint{},
"us-west-1": endpoint{},
"us-west-2": endpoint{},
},
},
"serverlessrepo": service{
Defaults: endpoint{
Protocols: []string{"https"},
@ -1907,12 +1994,14 @@ var awsPartition = partition{
"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{},
@ -1924,6 +2013,7 @@ var awsPartition = partition{
Endpoints: endpoints{
"ap-northeast-1": endpoint{},
"ap-south-1": endpoint{},
"ap-southeast-1": endpoint{},
"ap-southeast-2": endpoint{},
"ca-central-1": endpoint{},
"eu-central-1": endpoint{},
@ -2233,11 +2323,14 @@ 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{},
"eu-central-1": endpoint{},
"eu-west-1": endpoint{},
"eu-west-2": endpoint{},
"sa-east-1": endpoint{},
"us-east-1": endpoint{},
"us-west-2": endpoint{},
},
@ -2536,7 +2629,8 @@ var awscnPartition = partition{
"sms": service{
Endpoints: endpoints{
"cn-north-1": endpoint{},
"cn-north-1": endpoint{},
"cn-northwest-1": endpoint{},
},
},
"snowball": service{
@ -2671,6 +2765,16 @@ var awsusgovPartition = partition{
"us-gov-west-1": endpoint{},
},
},
"cloudhsmv2": service{
Defaults: endpoint{
CredentialScope: credentialScope{
Service: "cloudhsm",
},
},
Endpoints: endpoints{
"us-gov-west-1": endpoint{},
},
},
"cloudtrail": service{
Endpoints: endpoints{
@ -2919,6 +3023,12 @@ var awsusgovPartition = partition{
"us-gov-west-1": endpoint{},
},
},
"storagegateway": service{
Endpoints: endpoints{
"us-gov-west-1": endpoint{},
},
},
"streams.dynamodb": service{
Defaults: endpoint{
CredentialScope: credentialScope{

22
vendor/github.com/aws/aws-sdk-go/aws/endpoints/endpoints.go generated vendored
View File

@ -206,10 +206,11 @@ func (p Partition) EndpointFor(service, region string, opts ...func(*Options)) (
// enumerating over the regions in a partition.
func (p Partition) Regions() map[string]Region {
rs := map[string]Region{}
for id := range p.p.Regions {
for id, r := range p.p.Regions {
rs[id] = Region{
id: id,
p: p.p,
id: id,
desc: r.Description,
p: p.p,
}
}
@ -240,6 +241,10 @@ type Region struct {
// ID returns the region's identifier.
func (r Region) ID() string { return r.id }
// Description returns the region's description. The region description
// is free text, it can be empty, and it may change between SDK releases.
func (r Region) Description() string { return r.desc }
// ResolveEndpoint resolves an endpoint from the context of the region given
// a service. See Partition.EndpointFor for usage and errors that can be returned.
func (r Region) ResolveEndpoint(service string, opts ...func(*Options)) (ResolvedEndpoint, error) {
@ -284,10 +289,11 @@ func (s Service) ResolveEndpoint(region string, opts ...func(*Options)) (Resolve
func (s Service) Regions() map[string]Region {
rs := map[string]Region{}
for id := range s.p.Services[s.id].Endpoints {
if _, ok := s.p.Regions[id]; ok {
if r, ok := s.p.Regions[id]; ok {
rs[id] = Region{
id: id,
p: s.p,
id: id,
desc: r.Description,
p: s.p,
}
}
}
@ -347,6 +353,10 @@ type ResolvedEndpoint struct {
// The service name that should be used for signing requests.
SigningName string
// States that the signing name for this endpoint was derived from metadata
// passed in, but was not explicitly modeled.
SigningNameDerived bool
// The signing method that should be used for signing requests.
SigningMethod string
}

7
vendor/github.com/aws/aws-sdk-go/aws/endpoints/endpoints_test.go generated vendored
View File

@ -65,6 +65,10 @@ func TestEnumRegionServices(t *testing.T) {
t.Errorf("expect %q region ID, got %q", e, a)
}
if a, e := r.Description(), "region description"; a != e {
t.Errorf("expect %q region Description, got %q", e, a)
}
ss := r.Services()
if a, e := len(ss), 1; a != e {
t.Errorf("expect %d services for us-east-1, got %d", e, a)
@ -291,6 +295,9 @@ func TestRegionsForService(t *testing.T) {
if _, ok := expect[id]; !ok {
t.Errorf("expect %s region to be found", id)
}
if a, e := r.Description(), expect[id].desc; a != e {
t.Errorf("expect %q region Description, got %q", e, a)
}
}
}

12
vendor/github.com/aws/aws-sdk-go/aws/endpoints/v3model.go generated vendored
View File

@ -226,16 +226,20 @@ func (e endpoint) resolve(service, region, dnsSuffix string, defs []endpoint, op
if len(signingRegion) == 0 {
signingRegion = region
}
signingName := e.CredentialScope.Service
var signingNameDerived bool
if len(signingName) == 0 {
signingName = service
signingNameDerived = true
}
return ResolvedEndpoint{
URL: u,
SigningRegion: signingRegion,
SigningName: signingName,
SigningMethod: getByPriority(e.SignatureVersions, signerPriority, defaultSigner),
URL: u,
SigningRegion: signingRegion,
SigningName: signingName,
SigningNameDerived: signingNameDerived,
SigningMethod: getByPriority(e.SignatureVersions, signerPriority, defaultSigner),
}
}

343
vendor/github.com/aws/aws-sdk-go/aws/endpoints/v3model_test.go generated vendored
View File

@ -2,10 +2,9 @@ package endpoints
import (
"encoding/json"
"reflect"
"regexp"
"testing"
"github.com/stretchr/testify/assert"
)
func TestUnmarshalRegionRegex(t *testing.T) {
@ -16,12 +15,18 @@ func TestUnmarshalRegionRegex(t *testing.T) {
p := partition{}
err := json.Unmarshal(input, &p)
assert.NoError(t, err)
if err != nil {
t.Fatalf("expect no error, got %v", err)
}
expectRegexp, err := regexp.Compile(`^(us|eu|ap|sa|ca)\-\w+\-\d+$`)
assert.NoError(t, err)
if err != nil {
t.Fatalf("expect no error, got %v", err)
}
assert.Equal(t, expectRegexp.String(), p.RegionRegex.Regexp.String())
if e, a := expectRegexp.String(), p.RegionRegex.Regexp.String(); e != a {
t.Errorf("expect %v, got %v", e, a)
}
}
func TestUnmarshalRegion(t *testing.T) {
@ -37,16 +42,28 @@ func TestUnmarshalRegion(t *testing.T) {
rs := regions{}
err := json.Unmarshal(input, &rs)
assert.NoError(t, err)
if err != nil {
t.Fatalf("expect no error, got %v", err)
}
assert.Len(t, rs, 2)
if e, a := 2, len(rs); e != a {
t.Errorf("expect %v len, got %v", e, a)
}
r, ok := rs["aws-global"]
assert.True(t, ok)
assert.Equal(t, "AWS partition-global endpoint", r.Description)
if !ok {
t.Errorf("expect found, was not")
}
if e, a := "AWS partition-global endpoint", r.Description; e != a {
t.Errorf("expect %v, got %v", e, a)
}
r, ok = rs["us-east-1"]
assert.True(t, ok)
assert.Equal(t, "US East (N. Virginia)", r.Description)
if !ok {
t.Errorf("expect found, was not")
}
if e, a := "US East (N. Virginia)", r.Description; e != a {
t.Errorf("expect %v, got %v", e, a)
}
}
func TestUnmarshalServices(t *testing.T) {
@ -75,23 +92,45 @@ func TestUnmarshalServices(t *testing.T) {
ss := services{}
err := json.Unmarshal(input, &ss)
assert.NoError(t, err)
if err != nil {
t.Fatalf("expect no error, got %v", err)
}
assert.Len(t, ss, 3)
if e, a := 3, len(ss); e != a {
t.Errorf("expect %v len, got %v", e, a)
}
s, ok := ss["acm"]
assert.True(t, ok)
assert.Len(t, s.Endpoints, 1)
assert.Equal(t, boxedBoolUnset, s.IsRegionalized)
if !ok {
t.Errorf("expect found, was not")
}
if e, a := 1, len(s.Endpoints); e != a {
t.Errorf("expect %v len, got %v", e, a)
}
if e, a := boxedBoolUnset, s.IsRegionalized; e != a {
t.Errorf("expect %v, got %v", e, a)
}
s, ok = ss["apigateway"]
assert.True(t, ok)
assert.Len(t, s.Endpoints, 2)
assert.Equal(t, boxedTrue, s.IsRegionalized)
if !ok {
t.Errorf("expect found, was not")
}
if e, a := 2, len(s.Endpoints); e != a {
t.Errorf("expect %v len, got %v", e, a)
}
if e, a := boxedTrue, s.IsRegionalized; e != a {
t.Errorf("expect %v, got %v", e, a)
}
s, ok = ss["notRegionalized"]
assert.True(t, ok)
assert.Len(t, s.Endpoints, 2)
assert.Equal(t, boxedFalse, s.IsRegionalized)
if !ok {
t.Errorf("expect found, was not")
}
if e, a := 2, len(s.Endpoints); e != a {
t.Errorf("expect %v len, got %v", e, a)
}
if e, a := boxedFalse, s.IsRegionalized; e != a {
t.Errorf("expect %v, got %v", e, a)
}
}
func TestUnmarshalEndpoints(t *testing.T) {
@ -115,16 +154,32 @@ func TestUnmarshalEndpoints(t *testing.T) {
es := endpoints{}
err := json.Unmarshal(inputs, &es)
assert.NoError(t, err)
if err != nil {
t.Fatalf("expect no error, got %v", err)
}
assert.Len(t, es, 2)
if e, a := 2, len(es); e != a {
t.Errorf("expect %v len, got %v", e, a)
}
s, ok := es["aws-global"]
assert.True(t, ok)
assert.Equal(t, "cloudfront.amazonaws.com", s.Hostname)
assert.Equal(t, []string{"http", "https"}, s.Protocols)
assert.Equal(t, []string{"v4"}, s.SignatureVersions)
assert.Equal(t, credentialScope{"us-east-1", "serviceName"}, s.CredentialScope)
assert.Equal(t, "commonName", s.SSLCommonName)
if !ok {
t.Errorf("expect found, was not")
}
if e, a := "cloudfront.amazonaws.com", s.Hostname; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := []string{"http", "https"}, s.Protocols; !reflect.DeepEqual(e, a) {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := []string{"v4"}, s.SignatureVersions; !reflect.DeepEqual(e, a) {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := (credentialScope{"us-east-1", "serviceName"}), s.CredentialScope; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := "commonName", s.SSLCommonName; e != a {
t.Errorf("expect %v, got %v", e, a)
}
}
func TestEndpointResolve(t *testing.T) {
@ -155,10 +210,18 @@ func TestEndpointResolve(t *testing.T) {
defs, Options{},
)
assert.Equal(t, "https://service.region.dnsSuffix", resolved.URL)
assert.Equal(t, "signing_service", resolved.SigningName)
assert.Equal(t, "signing_region", resolved.SigningRegion)
assert.Equal(t, "v4", resolved.SigningMethod)
if e, a := "https://service.region.dnsSuffix", resolved.URL; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := "signing_service", resolved.SigningName; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := "signing_region", resolved.SigningRegion; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := "v4", resolved.SigningMethod; e != a {
t.Errorf("expect %v, got %v", e, a)
}
}
func TestEndpointMergeIn(t *testing.T) {
@ -185,7 +248,9 @@ func TestEndpointMergeIn(t *testing.T) {
},
})
assert.Equal(t, expected, actual)
if e, a := expected, actual; !reflect.DeepEqual(e, a) {
t.Errorf("expect %v, got %v", e, a)
}
}
var testPartitions = partitions{
@ -213,6 +278,11 @@ var testPartitions = partitions{
Services: services{
"s3": service{},
"service1": service{
Defaults: endpoint{
CredentialScope: credentialScope{
Service: "service1",
},
},
Endpoints: endpoints{
"us-east-1": {},
"us-west-2": {
@ -221,7 +291,13 @@ var testPartitions = partitions{
},
},
},
"service2": service{},
"service2": service{
Defaults: endpoint{
CredentialScope: credentialScope{
Service: "service2",
},
},
},
"httpService": service{
Defaults: endpoint{
Protocols: []string{"http"},
@ -246,109 +322,220 @@ var testPartitions = partitions{
func TestResolveEndpoint(t *testing.T) {
resolved, err := testPartitions.EndpointFor("service2", "us-west-2")
assert.NoError(t, err)
assert.Equal(t, "https://service2.us-west-2.amazonaws.com", resolved.URL)
assert.Equal(t, "us-west-2", resolved.SigningRegion)
assert.Equal(t, "service2", resolved.SigningName)
if err != nil {
t.Fatalf("expect no error, got %v", err)
}
if e, a := "https://service2.us-west-2.amazonaws.com", resolved.URL; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := "us-west-2", resolved.SigningRegion; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := "service2", resolved.SigningName; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if resolved.SigningNameDerived {
t.Errorf("expect the signing name not to be derived, but was")
}
}
func TestResolveEndpoint_DisableSSL(t *testing.T) {
resolved, err := testPartitions.EndpointFor("service2", "us-west-2", DisableSSLOption)
assert.NoError(t, err)
assert.Equal(t, "http://service2.us-west-2.amazonaws.com", resolved.URL)
assert.Equal(t, "us-west-2", resolved.SigningRegion)
assert.Equal(t, "service2", resolved.SigningName)
if err != nil {
t.Fatalf("expect no error, got %v", err)
}
if e, a := "http://service2.us-west-2.amazonaws.com", resolved.URL; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := "us-west-2", resolved.SigningRegion; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := "service2", resolved.SigningName; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if resolved.SigningNameDerived {
t.Errorf("expect the signing name not to be derived, but was")
}
}
func TestResolveEndpoint_UseDualStack(t *testing.T) {
resolved, err := testPartitions.EndpointFor("service1", "us-west-2", UseDualStackOption)
assert.NoError(t, err)
assert.Equal(t, "https://service1.dualstack.us-west-2.amazonaws.com", resolved.URL)
assert.Equal(t, "us-west-2", resolved.SigningRegion)
assert.Equal(t, "service1", resolved.SigningName)
if err != nil {
t.Fatalf("expect no error, got %v", err)
}
if e, a := "https://service1.dualstack.us-west-2.amazonaws.com", resolved.URL; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := "us-west-2", resolved.SigningRegion; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := "service1", resolved.SigningName; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if resolved.SigningNameDerived {
t.Errorf("expect the signing name not to be derived, but was")
}
}
func TestResolveEndpoint_HTTPProtocol(t *testing.T) {
resolved, err := testPartitions.EndpointFor("httpService", "us-west-2")
assert.NoError(t, err)
assert.Equal(t, "http://httpService.us-west-2.amazonaws.com", resolved.URL)
assert.Equal(t, "us-west-2", resolved.SigningRegion)
assert.Equal(t, "httpService", resolved.SigningName)
if err != nil {
t.Fatalf("expect no error, got %v", err)
}
if e, a := "http://httpService.us-west-2.amazonaws.com", resolved.URL; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := "us-west-2", resolved.SigningRegion; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := "httpService", resolved.SigningName; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if !resolved.SigningNameDerived {
t.Errorf("expect the signing name to be derived")
}
}
func TestResolveEndpoint_UnknownService(t *testing.T) {
_, err := testPartitions.EndpointFor("unknownservice", "us-west-2")
assert.Error(t, err)
if err == nil {
t.Errorf("expect error, got none")
}
_, ok := err.(UnknownServiceError)
assert.True(t, ok, "expect error to be UnknownServiceError")
if !ok {
t.Errorf("expect error to be UnknownServiceError")
}
}
func TestResolveEndpoint_ResolveUnknownService(t *testing.T) {
resolved, err := testPartitions.EndpointFor("unknown-service", "us-region-1",
ResolveUnknownServiceOption)
assert.NoError(t, err)
if err != nil {
t.Fatalf("expect no error, got %v", err)
}
assert.Equal(t, "https://unknown-service.us-region-1.amazonaws.com", resolved.URL)
assert.Equal(t, "us-region-1", resolved.SigningRegion)
assert.Equal(t, "unknown-service", resolved.SigningName)
if e, a := "https://unknown-service.us-region-1.amazonaws.com", resolved.URL; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := "us-region-1", resolved.SigningRegion; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := "unknown-service", resolved.SigningName; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if !resolved.SigningNameDerived {
t.Errorf("expect the signing name to be derived")
}
}
func TestResolveEndpoint_UnknownMatchedRegion(t *testing.T) {
resolved, err := testPartitions.EndpointFor("service2", "us-region-1")
assert.NoError(t, err)
assert.Equal(t, "https://service2.us-region-1.amazonaws.com", resolved.URL)
assert.Equal(t, "us-region-1", resolved.SigningRegion)
assert.Equal(t, "service2", resolved.SigningName)
if err != nil {
t.Fatalf("expect no error, got %v", err)
}
if e, a := "https://service2.us-region-1.amazonaws.com", resolved.URL; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := "us-region-1", resolved.SigningRegion; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := "service2", resolved.SigningName; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if resolved.SigningNameDerived {
t.Errorf("expect the signing name not to be derived, but was")
}
}
func TestResolveEndpoint_UnknownRegion(t *testing.T) {
resolved, err := testPartitions.EndpointFor("service2", "unknownregion")
assert.NoError(t, err)
assert.Equal(t, "https://service2.unknownregion.amazonaws.com", resolved.URL)
assert.Equal(t, "unknownregion", resolved.SigningRegion)
assert.Equal(t, "service2", resolved.SigningName)
if err != nil {
t.Fatalf("expect no error, got %v", err)
}
if e, a := "https://service2.unknownregion.amazonaws.com", resolved.URL; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := "unknownregion", resolved.SigningRegion; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := "service2", resolved.SigningName; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if resolved.SigningNameDerived {
t.Errorf("expect the signing name not to be derived, but was")
}
}
func TestResolveEndpoint_StrictPartitionUnknownEndpoint(t *testing.T) {
_, err := testPartitions[0].EndpointFor("service2", "unknownregion", StrictMatchingOption)
assert.Error(t, err)
if err == nil {
t.Errorf("expect error, got none")
}
_, ok := err.(UnknownEndpointError)
assert.True(t, ok, "expect error to be UnknownEndpointError")
if !ok {
t.Errorf("expect error to be UnknownEndpointError")
}
}
func TestResolveEndpoint_StrictPartitionsUnknownEndpoint(t *testing.T) {
_, err := testPartitions.EndpointFor("service2", "us-region-1", StrictMatchingOption)
assert.Error(t, err)
if err == nil {
t.Errorf("expect error, got none")
}
_, ok := err.(UnknownEndpointError)
assert.True(t, ok, "expect error to be UnknownEndpointError")
if !ok {
t.Errorf("expect error to be UnknownEndpointError")
}
}
func TestResolveEndpoint_NotRegionalized(t *testing.T) {
resolved, err := testPartitions.EndpointFor("globalService", "us-west-2")
assert.NoError(t, err)
assert.Equal(t, "https://globalService.amazonaws.com", resolved.URL)
assert.Equal(t, "us-east-1", resolved.SigningRegion)
assert.Equal(t, "globalService", resolved.SigningName)
if err != nil {
t.Fatalf("expect no error, got %v", err)
}
if e, a := "https://globalService.amazonaws.com", resolved.URL; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := "us-east-1", resolved.SigningRegion; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := "globalService", resolved.SigningName; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if !resolved.SigningNameDerived {
t.Errorf("expect the signing name to be derived")
}
}
func TestResolveEndpoint_AwsGlobal(t *testing.T) {
resolved, err := testPartitions.EndpointFor("globalService", "aws-global")
assert.NoError(t, err)
assert.Equal(t, "https://globalService.amazonaws.com", resolved.URL)
assert.Equal(t, "us-east-1", resolved.SigningRegion)
assert.Equal(t, "globalService", resolved.SigningName)
if err != nil {
t.Fatalf("expect no error, got %v", err)
}
if e, a := "https://globalService.amazonaws.com", resolved.URL; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := "us-east-1", resolved.SigningRegion; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if e, a := "globalService", resolved.SigningName; e != a {
t.Errorf("expect %v, got %v", e, a)
}
if !resolved.SigningNameDerived {
t.Errorf("expect the signing name to be derived")
}
}

2
vendor/github.com/aws/aws-sdk-go/aws/request/request.go generated vendored
View File

@ -342,7 +342,7 @@ func debugLogReqError(r *Request, stage string, retrying bool, err error) {
// Build will build the request's object so it can be signed and sent
// to the service. Build will also validate all the request's parameters.
// Anny additional build Handlers set on this request will be run
// Any additional build Handlers set on this request will be run
// in the order they were set.
//
// The request will only be built once. Multiple calls to build will have

22
vendor/github.com/aws/aws-sdk-go/aws/session/session.go generated vendored
View File

@ -571,11 +571,12 @@ func (s *Session) clientConfigWithErr(serviceName string, cfgs ...*aws.Config) (
}
return client.Config{
Config: s.Config,
Handlers: s.Handlers,
Endpoint: resolved.URL,
SigningRegion: resolved.SigningRegion,
SigningName: resolved.SigningName,
Config: s.Config,
Handlers: s.Handlers,
Endpoint: resolved.URL,
SigningRegion: resolved.SigningRegion,
SigningNameDerived: resolved.SigningNameDerived,
SigningName: resolved.SigningName,
}, err
}
@ -595,10 +596,11 @@ func (s *Session) ClientConfigNoResolveEndpoint(cfgs ...*aws.Config) client.Conf
}
return client.Config{
Config: s.Config,
Handlers: s.Handlers,
Endpoint: resolved.URL,
SigningRegion: resolved.SigningRegion,
SigningName: resolved.SigningName,
Config: s.Config,
Handlers: s.Handlers,
Endpoint: resolved.URL,
SigningRegion: resolved.SigningRegion,
SigningNameDerived: resolved.SigningNameDerived,
SigningName: resolved.SigningName,
}
}

2
vendor/github.com/aws/aws-sdk-go/aws/version.go generated vendored
View File

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

7
vendor/github.com/aws/aws-sdk-go/awstesting/integration/smoke/autoscalingplans/autoscalingplans.feature generated vendored Normal file
View File

@ -0,0 +1,7 @@
# language: en
@autoscalingplans @client
Feature: AWS Auto Scaling Plans
Scenario: Making a request
When I call the "DescribeScalingPlans" API
Then the request should be successful

16
vendor/github.com/aws/aws-sdk-go/awstesting/integration/smoke/autoscalingplans/client.go generated vendored Normal file
View File

@ -0,0 +1,16 @@
// +build integration
//Package autoscalingplans provides gucumber integration tests support.
package autoscalingplans
import (
"github.com/aws/aws-sdk-go/awstesting/integration/smoke"
"github.com/aws/aws-sdk-go/service/autoscalingplans"
"github.com/gucumber/gucumber"
)
func init() {
gucumber.Before("@autoscalingplans", func() {
gucumber.World["client"] = autoscalingplans.New(smoke.Session)
})
}

16
vendor/github.com/aws/aws-sdk-go/awstesting/integration/smoke/mediastore/client.go generated vendored Normal file
View File

@ -0,0 +1,16 @@
// +build integration
//Package mediastore provides gucumber integration tests support.
package mediastore
import (
"github.com/aws/aws-sdk-go/awstesting/integration/smoke"
"github.com/aws/aws-sdk-go/service/mediastore"
"github.com/gucumber/gucumber"
)
func init() {
gucumber.Before("@mediastore", func() {
gucumber.World["client"] = mediastore.New(smoke.Session)
})
}

7
vendor/github.com/aws/aws-sdk-go/awstesting/integration/smoke/mediastore/mediastore.feature generated vendored Normal file
View File

@ -0,0 +1,7 @@
# language: en
@mediastore @client
Feature: AWS Elemental MediaStore
Scenario: Making a request
When I call the "ListContainers" API
Then the request should be successful

34
vendor/github.com/aws/aws-sdk-go/awstesting/integration/smoke/mediastoredata/client.go generated vendored Normal file
View File

@ -0,0 +1,34 @@
// +build integration
//Package mediastoredata provides gucumber integration tests support.
package mediastoredata
import (
"fmt"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/awstesting/integration/smoke"
"github.com/aws/aws-sdk-go/service/mediastore"
"github.com/aws/aws-sdk-go/service/mediastoredata"
"github.com/gucumber/gucumber"
)
func init() {
const containerName = "awsgosdkteamintegcontainer"
gucumber.Before("@mediastoredata", func() {
mediastoreSvc := mediastore.New(smoke.Session)
resp, err := mediastoreSvc.DescribeContainer(&mediastore.DescribeContainerInput{
ContainerName: aws.String(containerName),
})
if err != nil {
gucumber.World["error"] = fmt.Errorf("failed to get mediastore container endpoint for test, %v", err)
return
}
gucumber.World["client"] = mediastoredata.New(smoke.Session, &aws.Config{
Endpoint: resp.Container.Endpoint,
})
})
}

7
vendor/github.com/aws/aws-sdk-go/awstesting/integration/smoke/mediastoredata/mediastoredata.feature generated vendored Normal file
View File

@ -0,0 +1,7 @@
# language: en
@mediastoredata @client
Feature: AWS Elemental MediaStore Data Plane
Scenario: Making a request
When I call the "ListItems" API
Then the request should be successful

16
vendor/github.com/aws/aws-sdk-go/awstesting/integration/smoke/mobile/client.go generated vendored Normal file
View File

@ -0,0 +1,16 @@
// +build integration
//Package mobile provides gucumber integration tests support.
package mobile
import (
"github.com/aws/aws-sdk-go/awstesting/integration/smoke"
"github.com/aws/aws-sdk-go/service/mobile"
"github.com/gucumber/gucumber"
)
func init() {
gucumber.Before("@mobile", func() {
gucumber.World["client"] = mobile.New(smoke.Session)
})
}

7
vendor/github.com/aws/aws-sdk-go/awstesting/integration/smoke/mobile/mobile.feature generated vendored Normal file
View File

@ -0,0 +1,7 @@
# language: en
@mobile @client
Feature: AWS Mobile
Scenario: Making a request
When I call the "ListBundles" API
Then the request should be successful

26
vendor/github.com/aws/aws-sdk-go/example/service/s3/sync/README.md generated vendored Normal file
View File

@ -0,0 +1,26 @@
# Example
sync will upload a given directory to Amazon S3 using the upload iterator interface defined in the
s3manager package. This example uses a path that is specified during runtime to walk and build keys
to upload to Amazon S3. It will use the keys to upload the files/folders to Amazon S3.
# Usage
```sh
sync <params>
-region <region> // required
-bucket <bucket> // required
-path <path> // required
```
```sh
go run -tags example sync.go
-region <region> // required
-bucket <bucket> // required
-path <path> // required
```
Output:
```
success
```

112
vendor/github.com/aws/aws-sdk-go/example/service/s3/sync/sync.go generated vendored Normal file
View File

@ -0,0 +1,112 @@
// +build example
package main
import (
"flag"
"fmt"
"os"
"path/filepath"
"strings"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/session"
"github.com/aws/aws-sdk-go/service/s3/s3manager"
)
// SyncFolderIterator is used to upload a given folder
// to Amazon S3.
type SyncFolderIterator struct {
bucket string
fileInfos []fileInfo
err error
}
type fileInfo struct {
key string
fullpath string
}
// NewSyncFolderIterator will walk the path, and store the key and full path
// of the object to be uploaded. This will return a new SyncFolderIterator
// with the data provided from walking the path.
func NewSyncFolderIterator(path, bucket string) *SyncFolderIterator {
metadata := []fileInfo{}
filepath.Walk(path, func(p string, info os.FileInfo, err error) error {
if !info.IsDir() {
key := strings.TrimPrefix(p, path)
metadata = append(metadata, fileInfo{key, p})
}
return nil
})
return &SyncFolderIterator{
bucket,
metadata,
nil,
}
}
// Next will determine whether or not there is any remaining files to
// be uploaded.
func (iter *SyncFolderIterator) Next() bool {
return len(iter.fileInfos) > 0
}
// Err returns any error when os.Open is called.
func (iter *SyncFolderIterator) Err() error {
return iter.err
}
// UploadObject will prep the new upload object by open that file and constructing a new
// s3manager.UploadInput.
func (iter *SyncFolderIterator) UploadObject() s3manager.BatchUploadObject {
fi := iter.fileInfos[0]
iter.fileInfos = iter.fileInfos[1:]
body, err := os.Open(fi.fullpath)
if err != nil {
iter.err = err
}
input := s3manager.UploadInput{
Bucket: &iter.bucket,
Key: &fi.key,
Body: body,
}
return s3manager.BatchUploadObject{
&input,
nil,
}
}
// Upload a directory to a given bucket
//
// Usage:
// sync <params>
// -region <region> // required
// -bucket <bucket> // required
// -path <path> // required
func main() {
bucketPtr := flag.String("bucket", "", "bucket to upload to")
regionPtr := flag.String("region", "", "region to be used when making requests")
pathPtr := flag.String("path", "", "path of directory to be synced")
flag.Parse()
sess := session.New(&aws.Config{
Region: regionPtr,
})
uploader := s3manager.NewUploader(sess)
iter := NewSyncFolderIterator(*pathPtr, *bucketPtr)
if err := uploader.UploadWithIterator(aws.BackgroundContext(), iter); err != nil {
fmt.Fprintf(os.Stderr, "unexpected error has occured: %v", err)
}
if err := iter.Err(); err != nil {
fmt.Fprintf(os.Stderr, "unexpected error occured during file walking: %v", err)
}
fmt.Println("Success")
}

905
vendor/github.com/aws/aws-sdk-go/models/apis/acm-pca/2017-08-22/api-2.json generated vendored Normal file
View File

@ -0,0 +1,905 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2017-08-22",
"endpointPrefix":"acm-pca",
"jsonVersion":"1.1",
"protocol":"json",
"serviceAbbreviation":"ACM-PCA",
"serviceFullName":"AWS Certificate Manager Private Certificate Authority",
"serviceId":"ACM PCA",
"signatureVersion":"v4",
"targetPrefix":"ACMPrivateCA",
"uid":"acm-pca-2017-08-22"
},
"operations":{
"CreateCertificateAuthority":{
"name":"CreateCertificateAuthority",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateCertificateAuthorityRequest"},
"output":{"shape":"CreateCertificateAuthorityResponse"},
"errors":[
{"shape":"InvalidArgsException"},
{"shape":"InvalidPolicyException"},
{"shape":"LimitExceededException"}
],
"idempotent":true
},
"CreateCertificateAuthorityAuditReport":{
"name":"CreateCertificateAuthorityAuditReport",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateCertificateAuthorityAuditReportRequest"},
"output":{"shape":"CreateCertificateAuthorityAuditReportResponse"},
"errors":[
{"shape":"RequestInProgressException"},
{"shape":"RequestFailedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"},
{"shape":"InvalidArgsException"},
{"shape":"InvalidStateException"}
],
"idempotent":true
},
"DeleteCertificateAuthority":{
"name":"DeleteCertificateAuthority",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteCertificateAuthorityRequest"},
"errors":[
{"shape":"ConcurrentModificationException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"},
{"shape":"InvalidStateException"}
]
},
"DescribeCertificateAuthority":{
"name":"DescribeCertificateAuthority",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeCertificateAuthorityRequest"},
"output":{"shape":"DescribeCertificateAuthorityResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"}
]
},
"DescribeCertificateAuthorityAuditReport":{
"name":"DescribeCertificateAuthorityAuditReport",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeCertificateAuthorityAuditReportRequest"},
"output":{"shape":"DescribeCertificateAuthorityAuditReportResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArgsException"}
]
},
"GetCertificate":{
"name":"GetCertificate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetCertificateRequest"},
"output":{"shape":"GetCertificateResponse"},
"errors":[
{"shape":"RequestInProgressException"},
{"shape":"RequestFailedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"},
{"shape":"InvalidStateException"}
]
},
"GetCertificateAuthorityCertificate":{
"name":"GetCertificateAuthorityCertificate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetCertificateAuthorityCertificateRequest"},
"output":{"shape":"GetCertificateAuthorityCertificateResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidStateException"},
{"shape":"InvalidArnException"}
]
},
"GetCertificateAuthorityCsr":{
"name":"GetCertificateAuthorityCsr",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetCertificateAuthorityCsrRequest"},
"output":{"shape":"GetCertificateAuthorityCsrResponse"},
"errors":[
{"shape":"RequestInProgressException"},
{"shape":"RequestFailedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"}
]
},
"ImportCertificateAuthorityCertificate":{
"name":"ImportCertificateAuthorityCertificate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ImportCertificateAuthorityCertificateRequest"},
"errors":[
{"shape":"ConcurrentModificationException"},
{"shape":"RequestInProgressException"},
{"shape":"RequestFailedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"},
{"shape":"MalformedCertificateException"},
{"shape":"CertificateMismatchException"}
]
},
"IssueCertificate":{
"name":"IssueCertificate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"IssueCertificateRequest"},
"output":{"shape":"IssueCertificateResponse"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidStateException"},
{"shape":"InvalidArnException"},
{"shape":"InvalidArgsException"},
{"shape":"MalformedCSRException"}
],
"idempotent":true
},
"ListCertificateAuthorities":{
"name":"ListCertificateAuthorities",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListCertificateAuthoritiesRequest"},
"output":{"shape":"ListCertificateAuthoritiesResponse"},
"errors":[
{"shape":"InvalidNextTokenException"}
]
},
"ListTags":{
"name":"ListTags",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTagsRequest"},
"output":{"shape":"ListTagsResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"}
]
},
"RevokeCertificate":{
"name":"RevokeCertificate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RevokeCertificateRequest"},
"errors":[
{"shape":"ConcurrentModificationException"},
{"shape":"InvalidArnException"},
{"shape":"InvalidStateException"},
{"shape":"ResourceNotFoundException"},
{"shape":"RequestAlreadyProcessedException"},
{"shape":"RequestInProgressException"},
{"shape":"RequestFailedException"}
]
},
"TagCertificateAuthority":{
"name":"TagCertificateAuthority",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"TagCertificateAuthorityRequest"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"},
{"shape":"InvalidTagException"},
{"shape":"TooManyTagsException"}
]
},
"UntagCertificateAuthority":{
"name":"UntagCertificateAuthority",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UntagCertificateAuthorityRequest"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"},
{"shape":"InvalidTagException"}
]
},
"UpdateCertificateAuthority":{
"name":"UpdateCertificateAuthority",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateCertificateAuthorityRequest"},
"errors":[
{"shape":"ConcurrentModificationException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArgsException"},
{"shape":"InvalidArnException"},
{"shape":"InvalidStateException"},
{"shape":"InvalidPolicyException"}
]
}
},
"shapes":{
"ASN1Subject":{
"type":"structure",
"members":{
"Country":{"shape":"CountryCodeString"},
"Organization":{"shape":"String64"},
"OrganizationalUnit":{"shape":"String64"},
"DistinguishedNameQualifier":{"shape":"DistinguishedNameQualifierString"},
"State":{"shape":"String128"},
"CommonName":{"shape":"String64"},
"SerialNumber":{"shape":"String64"},
"Locality":{"shape":"String128"},
"Title":{"shape":"String64"},
"Surname":{"shape":"String40"},
"GivenName":{"shape":"String16"},
"Initials":{"shape":"String5"},
"Pseudonym":{"shape":"String128"},
"GenerationQualifier":{"shape":"String3"}
}
},
"Arn":{
"type":"string",
"max":200,
"min":5,
"pattern":"arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=/,.@-]+)*"
},
"AuditReportId":{
"type":"string",
"max":36,
"min":36,
"pattern":"[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}"
},
"AuditReportResponseFormat":{
"type":"string",
"enum":[
"JSON",
"CSV"
]
},
"AuditReportStatus":{
"type":"string",
"enum":[
"CREATING",
"SUCCESS",
"FAILED"
]
},
"Boolean":{"type":"boolean"},
"CertificateAuthorities":{
"type":"list",
"member":{"shape":"CertificateAuthority"}
},
"CertificateAuthority":{
"type":"structure",
"members":{
"Arn":{"shape":"Arn"},
"CreatedAt":{"shape":"TStamp"},
"LastStateChangeAt":{"shape":"TStamp"},
"Type":{"shape":"CertificateAuthorityType"},
"Serial":{"shape":"String"},
"Status":{"shape":"CertificateAuthorityStatus"},
"NotBefore":{"shape":"TStamp"},
"NotAfter":{"shape":"TStamp"},
"FailureReason":{"shape":"FailureReason"},
"CertificateAuthorityConfiguration":{"shape":"CertificateAuthorityConfiguration"},
"RevocationConfiguration":{"shape":"RevocationConfiguration"}
}
},
"CertificateAuthorityConfiguration":{
"type":"structure",
"required":[
"KeyAlgorithm",
"SigningAlgorithm",
"Subject"
],
"members":{
"KeyAlgorithm":{"shape":"KeyAlgorithm"},
"SigningAlgorithm":{"shape":"SigningAlgorithm"},
"Subject":{"shape":"ASN1Subject"}
}
},
"CertificateAuthorityStatus":{
"type":"string",
"enum":[
"CREATING",
"PENDING_CERTIFICATE",
"ACTIVE",
"DISABLED",
"EXPIRED",
"FAILED"
]
},
"CertificateAuthorityType":{
"type":"string",
"enum":["SUBORDINATE"]
},
"CertificateBody":{"type":"string"},
"CertificateBodyBlob":{
"type":"blob",
"max":32768,
"min":1
},
"CertificateChain":{"type":"string"},
"CertificateChainBlob":{
"type":"blob",
"max":2097152,
"min":0
},
"CertificateMismatchException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"ConcurrentModificationException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"CountryCodeString":{
"type":"string",
"pattern":"[A-Za-z]{2}"
},
"CreateCertificateAuthorityAuditReportRequest":{
"type":"structure",
"required":[
"CertificateAuthorityArn",
"S3BucketName",
"AuditReportResponseFormat"
],
"members":{
"CertificateAuthorityArn":{"shape":"Arn"},
"S3BucketName":{"shape":"String"},
"AuditReportResponseFormat":{"shape":"AuditReportResponseFormat"}
}
},
"CreateCertificateAuthorityAuditReportResponse":{
"type":"structure",
"members":{
"AuditReportId":{"shape":"AuditReportId"},
"S3Key":{"shape":"String"}
}
},
"CreateCertificateAuthorityRequest":{
"type":"structure",
"required":[
"CertificateAuthorityConfiguration",
"CertificateAuthorityType"
],
"members":{
"CertificateAuthorityConfiguration":{"shape":"CertificateAuthorityConfiguration"},
"RevocationConfiguration":{"shape":"RevocationConfiguration"},
"CertificateAuthorityType":{"shape":"CertificateAuthorityType"},
"IdempotencyToken":{"shape":"IdempotencyToken"}
}
},
"CreateCertificateAuthorityResponse":{
"type":"structure",
"members":{
"CertificateAuthorityArn":{"shape":"Arn"}
}
},
"CrlConfiguration":{
"type":"structure",
"required":["Enabled"],
"members":{
"Enabled":{
"shape":"Boolean",
"box":true
},
"ExpirationInDays":{
"shape":"Integer1To5000",
"box":true
},
"CustomCname":{"shape":"String253"},
"S3BucketName":{"shape":"String3To255"}
}
},
"CsrBlob":{
"type":"blob",
"max":32768,
"min":1
},
"CsrBody":{"type":"string"},
"DeleteCertificateAuthorityRequest":{
"type":"structure",
"required":["CertificateAuthorityArn"],
"members":{
"CertificateAuthorityArn":{"shape":"Arn"}
}
},
"DescribeCertificateAuthorityAuditReportRequest":{
"type":"structure",
"required":[
"CertificateAuthorityArn",
"AuditReportId"
],
"members":{
"CertificateAuthorityArn":{"shape":"Arn"},
"AuditReportId":{"shape":"AuditReportId"}
}
},
"DescribeCertificateAuthorityAuditReportResponse":{
"type":"structure",
"members":{
"AuditReportStatus":{"shape":"AuditReportStatus"},
"S3BucketName":{"shape":"String"},
"S3Key":{"shape":"String"},
"CreatedAt":{"shape":"TStamp"}
}
},
"DescribeCertificateAuthorityRequest":{
"type":"structure",
"required":["CertificateAuthorityArn"],
"members":{
"CertificateAuthorityArn":{"shape":"Arn"}
}
},
"DescribeCertificateAuthorityResponse":{
"type":"structure",
"members":{
"CertificateAuthority":{"shape":"CertificateAuthority"}
}
},
"DistinguishedNameQualifierString":{
"type":"string",
"max":64,
"min":0,
"pattern":"[a-zA-Z0-9'()+-.?:/= ]*"
},
"FailureReason":{
"type":"string",
"enum":[
"REQUEST_TIMED_OUT",
"UNSUPPORTED_ALGORITHM",
"OTHER"
]
},
"GetCertificateAuthorityCertificateRequest":{
"type":"structure",
"required":["CertificateAuthorityArn"],
"members":{
"CertificateAuthorityArn":{"shape":"Arn"}
}
},
"GetCertificateAuthorityCertificateResponse":{
"type":"structure",
"members":{
"Certificate":{"shape":"CertificateBody"},
"CertificateChain":{"shape":"CertificateChain"}
}
},
"GetCertificateAuthorityCsrRequest":{
"type":"structure",
"required":["CertificateAuthorityArn"],
"members":{
"CertificateAuthorityArn":{"shape":"Arn"}
}
},
"GetCertificateAuthorityCsrResponse":{
"type":"structure",
"members":{
"Csr":{"shape":"CsrBody"}
}
},
"GetCertificateRequest":{
"type":"structure",
"required":[
"CertificateAuthorityArn",
"CertificateArn"
],
"members":{
"CertificateAuthorityArn":{"shape":"Arn"},
"CertificateArn":{"shape":"Arn"}
}
},
"GetCertificateResponse":{
"type":"structure",
"members":{
"Certificate":{"shape":"CertificateBody"},
"CertificateChain":{"shape":"CertificateChain"}
}
},
"IdempotencyToken":{
"type":"string",
"max":36,
"min":1,
"pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*"
},
"ImportCertificateAuthorityCertificateRequest":{
"type":"structure",
"required":[
"CertificateAuthorityArn",
"Certificate",
"CertificateChain"
],
"members":{
"CertificateAuthorityArn":{"shape":"Arn"},
"Certificate":{"shape":"CertificateBodyBlob"},
"CertificateChain":{"shape":"CertificateChainBlob"}
}
},
"Integer1To5000":{
"type":"integer",
"max":5000,
"min":1
},
"InvalidArgsException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"InvalidArnException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"InvalidNextTokenException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"InvalidPolicyException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"InvalidStateException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"InvalidTagException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"IssueCertificateRequest":{
"type":"structure",
"required":[
"CertificateAuthorityArn",
"Csr",
"SigningAlgorithm",
"Validity"
],
"members":{
"CertificateAuthorityArn":{"shape":"Arn"},
"Csr":{"shape":"CsrBlob"},
"SigningAlgorithm":{"shape":"SigningAlgorithm"},
"Validity":{"shape":"Validity"},
"IdempotencyToken":{"shape":"IdempotencyToken"}
}
},
"IssueCertificateResponse":{
"type":"structure",
"members":{
"CertificateArn":{"shape":"Arn"}
}
},
"KeyAlgorithm":{
"type":"string",
"enum":[
"RSA_2048",
"RSA_4096",
"EC_prime256v1",
"EC_secp384r1"
]
},
"LimitExceededException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"ListCertificateAuthoritiesRequest":{
"type":"structure",
"members":{
"NextToken":{"shape":"NextToken"},
"MaxResults":{"shape":"MaxResults"}
}
},
"ListCertificateAuthoritiesResponse":{
"type":"structure",
"members":{
"CertificateAuthorities":{"shape":"CertificateAuthorities"},
"NextToken":{"shape":"NextToken"}
}
},
"ListTagsRequest":{
"type":"structure",
"required":["CertificateAuthorityArn"],
"members":{
"CertificateAuthorityArn":{"shape":"Arn"},
"NextToken":{"shape":"NextToken"},
"MaxResults":{"shape":"MaxResults"}
}
},
"ListTagsResponse":{
"type":"structure",
"members":{
"Tags":{"shape":"TagList"},
"NextToken":{"shape":"NextToken"}
}
},
"MalformedCSRException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"MalformedCertificateException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"MaxResults":{
"type":"integer",
"max":1000,
"min":1
},
"NextToken":{
"type":"string",
"max":500,
"min":1
},
"PositiveLong":{
"type":"long",
"min":1
},
"RequestAlreadyProcessedException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"RequestFailedException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"RequestInProgressException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"RevocationConfiguration":{
"type":"structure",
"members":{
"CrlConfiguration":{"shape":"CrlConfiguration"}
}
},
"RevocationReason":{
"type":"string",
"enum":[
"UNSPECIFIED",
"KEY_COMPROMISE",
"CERTIFICATE_AUTHORITY_COMPROMISE",
"AFFILIATION_CHANGED",
"SUPERSEDED",
"CESSATION_OF_OPERATION",
"PRIVILEGE_WITHDRAWN",
"A_A_COMPROMISE"
]
},
"RevokeCertificateRequest":{
"type":"structure",
"required":[
"CertificateAuthorityArn",
"CertificateSerial",
"RevocationReason"
],
"members":{
"CertificateAuthorityArn":{"shape":"Arn"},
"CertificateSerial":{"shape":"String128"},
"RevocationReason":{"shape":"RevocationReason"}
}
},
"SigningAlgorithm":{
"type":"string",
"enum":[
"SHA256WITHECDSA",
"SHA384WITHECDSA",
"SHA512WITHECDSA",
"SHA256WITHRSA",
"SHA384WITHRSA",
"SHA512WITHRSA"
]
},
"String":{"type":"string"},
"String128":{
"type":"string",
"max":128,
"min":0
},
"String16":{
"type":"string",
"max":16,
"min":0
},
"String253":{
"type":"string",
"max":253,
"min":0
},
"String3":{
"type":"string",
"max":3,
"min":0
},
"String3To255":{
"type":"string",
"max":255,
"min":3
},
"String40":{
"type":"string",
"max":40,
"min":0
},
"String5":{
"type":"string",
"max":5,
"min":0
},
"String64":{
"type":"string",
"max":64,
"min":0
},
"TStamp":{"type":"timestamp"},
"Tag":{
"type":"structure",
"required":["Key"],
"members":{
"Key":{"shape":"TagKey"},
"Value":{"shape":"TagValue"}
}
},
"TagCertificateAuthorityRequest":{
"type":"structure",
"required":[
"CertificateAuthorityArn",
"Tags"
],
"members":{
"CertificateAuthorityArn":{"shape":"Arn"},
"Tags":{"shape":"TagList"}
}
},
"TagKey":{
"type":"string",
"max":128,
"min":1,
"pattern":"[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*"
},
"TagList":{
"type":"list",
"member":{"shape":"Tag"},
"max":50,
"min":1
},
"TagValue":{
"type":"string",
"max":256,
"min":0,
"pattern":"[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*"
},
"TooManyTagsException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"UntagCertificateAuthorityRequest":{
"type":"structure",
"required":[
"CertificateAuthorityArn",
"Tags"
],
"members":{
"CertificateAuthorityArn":{"shape":"Arn"},
"Tags":{"shape":"TagList"}
}
},
"UpdateCertificateAuthorityRequest":{
"type":"structure",
"required":["CertificateAuthorityArn"],
"members":{
"CertificateAuthorityArn":{"shape":"Arn"},
"RevocationConfiguration":{"shape":"RevocationConfiguration"},
"Status":{"shape":"CertificateAuthorityStatus"}
}
},
"Validity":{
"type":"structure",
"required":[
"Value",
"Type"
],
"members":{
"Value":{
"shape":"PositiveLong",
"box":true
},
"Type":{"shape":"ValidityPeriodType"}
}
},
"ValidityPeriodType":{
"type":"string",
"enum":[
"END_DATE",
"ABSOLUTE",
"DAYS",
"MONTHS",
"YEARS"
]
}
}
}

575
vendor/github.com/aws/aws-sdk-go/models/apis/acm-pca/2017-08-22/docs-2.json generated vendored Normal file
View File

@ -0,0 +1,575 @@
{
"version": "2.0",
"service": "<p>You can use the ACM PCA API to create a private certificate authority (CA). You must first call the <a>CreateCertificateAuthority</a> function. If successful, the function returns an Amazon Resource Name (ARN) for your private CA. Use this ARN as input to the <a>GetCertificateAuthorityCsr</a> function to retrieve the certificate signing request (CSR) for your private CA certificate. Sign the CSR using the root or an intermediate CA in your on-premises PKI hierarchy, and call the <a>ImportCertificateAuthorityCertificate</a> to import your signed private CA certificate into ACM PCA. </p> <p>Use your private CA to issue and revoke certificates. These are private certificates that identify and secure client computers, servers, applications, services, devices, and users over SSLS/TLS connections within your organization. Call the <a>IssueCertificate</a> function to issue a certificate. Call the <a>RevokeCertificate</a> function to revoke a certificate. </p> <note> <p>Certificates issued by your private CA can be trusted only within your organization, not publicly.</p> </note> <p>Your private CA can optionally create a certificate revocation list (CRL) to track the certificates you revoke. To create a CRL, you must specify a <a>RevocationConfiguration</a> object when you call the <a>CreateCertificateAuthority</a> function. ACM PCA writes the CRL to an S3 bucket that you specify. You must specify a bucket policy that grants ACM PCA write permission. </p> <p>You can also call the <a>CreateCertificateAuthorityAuditReport</a> to create an optional audit report that lists every time the CA private key is used. The private key is used for signing when the <b>IssueCertificate</b> or <b>RevokeCertificate</b> function is called. </p>",
"operations": {
"CreateCertificateAuthority": "<p>Creates a private subordinate certificate authority (CA). You must specify the CA configuration, the revocation configuration, the CA type, and an optional idempotency token. The CA configuration specifies the name of the algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses to sign, and X.500 subject information. The CRL (certificate revocation list) configuration specifies the CRL expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this function returns the Amazon Resource Name (ARN) of the CA.</p>",
"CreateCertificateAuthorityAuditReport": "<p>Creates an audit report that lists every time that the your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The <a>IssueCertificate</a> and <a>RevokeCertificate</a> functions use the private key. You can generate a new report every 30 minutes.</p>",
"DeleteCertificateAuthority": "<p>Deletes the private certificate authority (CA) that you created or started to create by calling the <a>CreateCertificateAuthority</a> function. This action requires that you enter an ARN (Amazon Resource Name) for the private CA that you want to delete. You can find the ARN by calling the <a>ListCertificateAuthorities</a> function. You can delete the CA if you are waiting for it to be created (the <b>Status</b> field of the <a>CertificateAuthority</a> is <code>CREATING</code>) or if the CA has been created but you haven't yet imported the signed certificate (the <b>Status</b> is <code>PENDING_CERTIFICATE</code>) into ACM PCA. If you've already imported the certificate, you cannot delete the CA unless it has been disabled for more than 30 days. To disable a CA, call the <a>UpdateCertificateAuthority</a> function and set the <b>CertificateAuthorityStatus</b> argument to <code>DISABLED</code>. </p>",
"DescribeCertificateAuthority": "<p>Lists information about your private certificate authority (CA). You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following: </p> <ul> <li> <p> <b>CREATING:</b> ACM PCA is creating your private certificate authority.</p> </li> <li> <p> <b>PENDING_CERTIFICATE:</b> The certificate is pending. You must use your on-premises root or subordinate CA to sign your private CA CSR and then import it into PCA. </p> </li> <li> <p> <b>ACTIVE:</b> Your private CA is active.</p> </li> <li> <p> <b>DISABLED:</b> Your private CA has been disabled.</p> </li> <li> <p> <b>EXPIRED:</b> Your private CA certificate has expired.</p> </li> <li> <p> <b>FAILED:</b> Your private CA has failed. Your CA can fail for problems such a network outage or backend AWS failure or other errors. A failed CA can never return to the pending state. You must create a new CA. </p> </li> </ul>",
"DescribeCertificateAuthorityAuditReport": "<p>Lists information about a specific audit report created by calling the <a>CreateCertificateAuthorityAuditReport</a> function. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the <a>IssueCertificate</a> function or the <a>RevokeCertificate</a> function. </p>",
"GetCertificate": "<p>Retrieves a certificate from your private CA. The ARN of the certificate is returned when you call the <a>IssueCertificate</a> function. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the <b>GetCertificate</b> function. You can retrieve the certificate if it is in the <b>ISSUED</b> state. You can call the <a>CreateCertificateAuthorityAuditReport</a> function to create a report that contains information about all of the certificates issued and revoked by your private CA. </p>",
"GetCertificateAuthorityCertificate": "<p>Retrieves the certificate and certificate chain for your private certificate authority (CA). Both the certificate and the chain are base64 PEM-encoded. The chain does not include the CA certificate. Each certificate in the chain signs the one before it. </p>",
"GetCertificateAuthorityCsr": "<p>Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the <a>CreateCertificateAuthority</a> function. Take the CSR to your on-premises X.509 infrastructure and sign it by using your root or a subordinate CA. Then import the signed certificate back into ACM PCA by calling the <a>ImportCertificateAuthorityCertificate</a> function. The CSR is returned as a base64 PEM-encoded string. </p>",
"ImportCertificateAuthorityCertificate": "<p>Imports your signed private CA certificate into ACM PCA. Before you can call this function, you must create the private certificate authority by calling the <a>CreateCertificateAuthority</a> function. You must then generate a certificate signing request (CSR) by calling the <a>GetCertificateAuthorityCsr</a> function. Take the CSR to your on-premises CA and use the root certificate or a subordinate certificate to sign it. Create a certificate chain and copy the signed certificate and the certificate chain to your working directory. </p> <note> <p>Your certificate chain must not include the private CA certificate that you are importing.</p> </note> <note> <p>Your on-premises CA certificate must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built. </p> </note> <note> <p>The chain must be PEM-encoded.</p> </note>",
"IssueCertificate": "<p>Uses your private certificate authority (CA) to issue a client certificate. This function returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the <a>GetCertificate</a> function and specifying the ARN. </p> <note> <p>You cannot use the ACM <b>ListCertificateAuthorities</b> function to retrieve the ARNs of the certificates that you issue by using ACM PCA.</p> </note>",
"ListCertificateAuthorities": "<p>Lists the private certificate authorities that you created by using the <a>CreateCertificateAuthority</a> function.</p>",
"ListTags": "<p>Lists the tags, if any, that are associated with your private CA. Tags are labels that you can use to identify and organize your CAs. Each tag consists of a key and an optional value. Call the <a>TagCertificateAuthority</a> function to add one or more tags to your CA. Call the <a>UntagCertificateAuthority</a> function to remove tags. </p>",
"RevokeCertificate": "<p>Revokes a certificate that you issued by calling the <a>IssueCertificate</a> function. If you enable a certificate revocation list (CRL) when you create or update your private CA, information about the revoked certificates will be included in the CRL. ACM PCA writes the CRL to an S3 bucket that you specify. For more information about revocation, see the <a>CrlConfiguration</a> structure. ACM PCA also writes revocation information to the audit report. For more information, see <a>CreateCertificateAuthorityAuditReport</a>. </p>",
"TagCertificateAuthority": "<p>Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. You specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one private CA if you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs if you want to filter for a common relationship among those CAs. To remove one or more tags, use the <a>UntagCertificateAuthority</a> function. Call the <a>ListTags</a> function to see what tags are associated with your CA. </p>",
"UntagCertificateAuthority": "<p>Remove one or more tags from your private CA. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. To add tags to a private CA, use the <a>TagCertificateAuthority</a>. Call the <a>ListTags</a> function to see what tags are associated with your CA. </p>",
"UpdateCertificateAuthority": "<p>Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the <b> <code>ACTIVE</code> </b> or <b> <code>DISABLED</code> </b> state before you can update it. You can disable a private CA that is in the <b> <code>ACTIVE</code> </b> state or make a CA that is in the <b> <code>DISABLED</code> </b> state active again.</p>"
},
"shapes": {
"ASN1Subject": {
"base": "<p>Contains information about the certificate subject. The certificate can be one issued by your private certificate authority (CA) or it can be your private CA certificate. The <b>Subject</b> field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The <b>Subject</b> must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate. The DN must be unique for each for each entity, but your private CA can issue more than one certificate with the same DN to the same entity. </p>",
"refs": {
"CertificateAuthorityConfiguration$Subject": "<p>Structure that contains X.500 distinguished name information for your private CA.</p>"
}
},
"Arn": {
"base": null,
"refs": {
"CertificateAuthority$Arn": "<p>Amazon Resource Name (ARN) for your private certificate authority (CA). The format is <code> <i>12345678-1234-1234-1234-123456789012</i> </code>.</p>",
"CreateCertificateAuthorityAuditReportRequest$CertificateAuthorityArn": "<p>Amazon Resource Name (ARN) of the CA to be audited. This is of the form:</p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>.</p>",
"CreateCertificateAuthorityResponse$CertificateAuthorityArn": "<p>If successful, the Amazon Resource Name (ARN) of the certificate authority (CA). This is of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>",
"DeleteCertificateAuthorityRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>",
"DescribeCertificateAuthorityAuditReportRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) of the private CA. This must be of the form:</p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>",
"DescribeCertificateAuthorityRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>",
"GetCertificateAuthorityCertificateRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) of your private CA. This is of the form:</p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>",
"GetCertificateAuthorityCsrRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called the <a>CreateCertificateAuthority</a> function. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
"GetCertificateRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>",
"GetCertificateRequest$CertificateArn": "<p>The ARN of the issued certificate. The ARN contains the certificate serial number and must be in the following form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>/certificate/<i>286535153982981100925020015808220737245</i> </code> </p>",
"ImportCertificateAuthorityCertificateRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
"IssueCertificateRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form:</p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
"IssueCertificateResponse$CertificateArn": "<p>The Amazon Resource Name (ARN) of the issued certificate and the certificate serial number. This is of the form:</p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>/certificate/<i>286535153982981100925020015808220737245</i> </code> </p>",
"ListTagsRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called the <a>CreateCertificateAuthority</a> function. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
"RevokeCertificateRequest$CertificateAuthorityArn": "<p>Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:</p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
"TagCertificateAuthorityRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
"UntagCertificateAuthorityRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
"UpdateCertificateAuthorityRequest$CertificateAuthorityArn": "<p>Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:</p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>"
}
},
"AuditReportId": {
"base": null,
"refs": {
"CreateCertificateAuthorityAuditReportResponse$AuditReportId": "<p>An alphanumeric string that contains a report identifier.</p>",
"DescribeCertificateAuthorityAuditReportRequest$AuditReportId": "<p>The report ID returned by calling the <a>CreateCertificateAuthorityAuditReport</a> function.</p>"
}
},
"AuditReportResponseFormat": {
"base": null,
"refs": {
"CreateCertificateAuthorityAuditReportRequest$AuditReportResponseFormat": "<p>Format in which to create the report. This can be either <b>JSON</b> or <b>CSV</b>.</p>"
}
},
"AuditReportStatus": {
"base": null,
"refs": {
"DescribeCertificateAuthorityAuditReportResponse$AuditReportStatus": "<p>Specifies whether report creation is in progress, has succeeded, or has failed.</p>"
}
},
"Boolean": {
"base": null,
"refs": {
"CrlConfiguration$Enabled": "<p>Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. You can use this value to enable certificate revocation for a new CA when you call the <a>CreateCertificateAuthority</a> function or for an existing CA when you call the <a>UpdateCertificateAuthority</a> function. </p>"
}
},
"CertificateAuthorities": {
"base": null,
"refs": {
"ListCertificateAuthoritiesResponse$CertificateAuthorities": "<p>Summary information about each certificate authority you have created.</p>"
}
},
"CertificateAuthority": {
"base": "<p>Contains information about your private certificate authority (CA). Your private CA can issue and revoke X.509 digital certificates. Digital certificates verify that the entity named in the certificate <b>Subject</b> field owns or controls the public key contained in the <b>Subject Public Key Info</b> field. Call the <a>CreateCertificateAuthority</a> function to create your private CA. You must then call the <a>GetCertificateAuthorityCertificate</a> function to retrieve a private CA certificate signing request (CSR). Take the CSR to your on-premises CA and sign it with the root CA certificate or a subordinate certificate. Call the <a>ImportCertificateAuthorityCertificate</a> function to import the signed certificate into AWS Certificate Manager (ACM). </p>",
"refs": {
"CertificateAuthorities$member": null,
"DescribeCertificateAuthorityResponse$CertificateAuthority": "<p>A <a>CertificateAuthority</a> structure that contains information about your private CA.</p>"
}
},
"CertificateAuthorityConfiguration": {
"base": "<p>Contains configuration information for your private certificate authority (CA). This includes information about the class of public key algorithm and the key pair that your private CA creates when it issues a certificate, the signature algorithm it uses used when issuing certificates, and its X.500 distinguished name. You must specify this information when you call the <a>CreateCertificateAuthority</a> function. </p>",
"refs": {
"CertificateAuthority$CertificateAuthorityConfiguration": "<p>Your private CA configuration.</p>",
"CreateCertificateAuthorityRequest$CertificateAuthorityConfiguration": "<p>Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject information.</p>"
}
},
"CertificateAuthorityStatus": {
"base": null,
"refs": {
"CertificateAuthority$Status": "<p>Status of your private CA.</p>",
"UpdateCertificateAuthorityRequest$Status": "<p>Status of your private CA.</p>"
}
},
"CertificateAuthorityType": {
"base": null,
"refs": {
"CertificateAuthority$Type": "<p>Type of your private CA.</p>",
"CreateCertificateAuthorityRequest$CertificateAuthorityType": "<p>The type of the certificate authority. Currently, this must be <b>SUBORDINATE</b>.</p>"
}
},
"CertificateBody": {
"base": null,
"refs": {
"GetCertificateAuthorityCertificateResponse$Certificate": "<p>Base64-encoded certificate authority (CA) certificate.</p>",
"GetCertificateResponse$Certificate": "<p>The base64 PEM-encoded certificate specified by the <code>CertificateArn</code> parameter.</p>"
}
},
"CertificateBodyBlob": {
"base": null,
"refs": {
"ImportCertificateAuthorityCertificateRequest$Certificate": "<p>The PEM-encoded certificate for your private CA. This must be signed by using your on-premises CA.</p>"
}
},
"CertificateChain": {
"base": null,
"refs": {
"GetCertificateAuthorityCertificateResponse$CertificateChain": "<p>Base64-encoded certificate chain that includes any intermediate certificates and chains up to root on-premises certificate that you used to sign your private CA certificate. The chain does not include your private CA certificate. </p>",
"GetCertificateResponse$CertificateChain": "<p>The base64 PEM-encoded certificate chain that chains up to the on-premises root CA certificate that you used to sign your private CA certificate. </p>"
}
},
"CertificateChainBlob": {
"base": null,
"refs": {
"ImportCertificateAuthorityCertificateRequest$CertificateChain": "<p>A PEM-encoded file that contains all of your certificates, other than the certificate you're importing, chaining up to your root CA. Your on-premises root certificate is the last in the chain, and each certificate in the chain signs the one preceding. </p>"
}
},
"CertificateMismatchException": {
"base": "<p>The certificate authority certificate you are importing does not comply with conditions specified in the certificate that signed it.</p>",
"refs": {
}
},
"ConcurrentModificationException": {
"base": "<p>A previous update to your private CA is still ongoing.</p>",
"refs": {
}
},
"CountryCodeString": {
"base": null,
"refs": {
"ASN1Subject$Country": "<p>Two digit code that specifies the country in which the certificate subject located.</p>"
}
},
"CreateCertificateAuthorityAuditReportRequest": {
"base": null,
"refs": {
}
},
"CreateCertificateAuthorityAuditReportResponse": {
"base": null,
"refs": {
}
},
"CreateCertificateAuthorityRequest": {
"base": null,
"refs": {
}
},
"CreateCertificateAuthorityResponse": {
"base": null,
"refs": {
}
},
"CrlConfiguration": {
"base": "<p>Contains configuration information for a certificate revocation list (CRL). Your private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You can enable CRLs for your new or an existing private CA by setting the <b>Enabled</b> parameter to <code>true</code>. Your private CA writes CRLs to an S3 bucket that you specify in the <b>S3BucketName</b> parameter. You can hide the name of your bucket by specifying a value for the <b>CustomCname</b> parameter. Your private CA copies the CNAME or the S3 bucket name to the <b>CRL Distribution Points</b> extension of each certificate it issues. Your S3 bucket policy must give write permission to ACM PCA. </p> <p>Your private CA uses the value in the <b>ExpirationInDays</b> parameter to calculate the <b>nextUpdate</b> field in the CRL. The CRL is refreshed at 1/2 the age of next update or when a certificate is revoked. When a certificate is revoked, it is recorded in the next CRL that is generated and in the next audit report. Only time valid certificates are listed in the CRL. Expired certificates are not included. </p> <p>CRLs contain the following fields:</p> <ul> <li> <p> <b>Version</b>: The current version number defined in RFC 5280 is V2. The integer value is 0x1. </p> </li> <li> <p> <b>Signature Algorithm</b>: The name of the algorithm used to sign the CRL.</p> </li> <li> <p> <b>Issuer</b>: The X.500 distinguished name of your private CA that issued the CRL.</p> </li> <li> <p> <b>Last Update</b>: The issue date and time of this CRL.</p> </li> <li> <p> <b>Next Update</b>: The day and time by which the next CRL will be issued.</p> </li> <li> <p> <b>Revoked Certificates</b>: List of revoked certificates. Each list item contains the following information.</p> <ul> <li> <p> <b>Serial Number</b>: The serial number, in hexadecimal format, of the revoked certificate.</p> </li> <li> <p> <b>Revocation Date</b>: Date and time the certificate was revoked.</p> </li> <li> <p> <b>CRL Entry Extensions</b>: Optional extensions for the CRL entry.</p> <ul> <li> <p> <b>X509v3 CRL Reason Code</b>: Reason the certificate was revoked.</p> </li> </ul> </li> </ul> </li> <li> <p> <b>CRL Extensions</b>: Optional extensions for the CRL.</p> <ul> <li> <p> <b>X509v3 Authority Key Identifier</b>: Identifies the public key associated with the private key used to sign the certificate.</p> </li> <li> <p> <b>X509v3 CRL Number:</b>: Decimal sequence number for the CRL.</p> </li> </ul> </li> <li> <p> <b>Signature Algorithm</b>: Algorithm used by your private CA to sign the CRL.</p> </li> <li> <p> <b>Signature Value</b>: Signature computed over the CRL.</p> </li> </ul> <p>Certificate revocation lists created by ACM PCA are DER-encoded. You can use the following OpenSSL command to list a CRL.</p> <p> <code>openssl crl -inform DER -text -in <i>crl_path</i> -noout</code> </p>",
"refs": {
"RevocationConfiguration$CrlConfiguration": "<p>Configuration of the certificate revocation list (CRL), if any, maintained by your private CA.</p>"
}
},
"CsrBlob": {
"base": null,
"refs": {
"IssueCertificateRequest$Csr": "<p>The certificate signing request (CSR) for the certificate you want to issue. You can use the following OpenSSL command to create the CSR and a 2048 bit RSA private key. </p> <p> <code>openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr</code> </p> <p>If you have a configuration file, you can use the following OpenSSL command. The <code>usr_cert</code> block in the configuration file contains your X509 version 3 extensions. </p> <p> <code>openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days -365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr</code> </p>"
}
},
"CsrBody": {
"base": null,
"refs": {
"GetCertificateAuthorityCsrResponse$Csr": "<p>The base64 PEM-encoded certificate signing request (CSR) for your private CA certificate.</p>"
}
},
"DeleteCertificateAuthorityRequest": {
"base": null,
"refs": {
}
},
"DescribeCertificateAuthorityAuditReportRequest": {
"base": null,
"refs": {
}
},
"DescribeCertificateAuthorityAuditReportResponse": {
"base": null,
"refs": {
}
},
"DescribeCertificateAuthorityRequest": {
"base": null,
"refs": {
}
},
"DescribeCertificateAuthorityResponse": {
"base": null,
"refs": {
}
},
"DistinguishedNameQualifierString": {
"base": null,
"refs": {
"ASN1Subject$DistinguishedNameQualifier": "<p>Disambiguating information for the certificate subject.</p>"
}
},
"FailureReason": {
"base": null,
"refs": {
"CertificateAuthority$FailureReason": "<p>Reason the request to create your private CA failed.</p>"
}
},
"GetCertificateAuthorityCertificateRequest": {
"base": null,
"refs": {
}
},
"GetCertificateAuthorityCertificateResponse": {
"base": null,
"refs": {
}
},
"GetCertificateAuthorityCsrRequest": {
"base": null,
"refs": {
}
},
"GetCertificateAuthorityCsrResponse": {
"base": null,
"refs": {
}
},
"GetCertificateRequest": {
"base": null,
"refs": {
}
},
"GetCertificateResponse": {
"base": null,
"refs": {
}
},
"IdempotencyToken": {
"base": null,
"refs": {
"CreateCertificateAuthorityRequest$IdempotencyToken": "<p>Alphanumeric string that can be used to distinguish between calls to <b>CreateCertificateAuthority</b>. Idempotency tokens time out after five minutes. Therefore, if you call <b>CreateCertificateAuthority</b> multiple times with the same idempotency token within a five minute period, ACM PCA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, however, ACM PCA recognizes that you are requesting multiple certificates.</p>",
"IssueCertificateRequest$IdempotencyToken": "<p>Custom string that can be used to distinguish between calls to the <b>IssueCertificate</b> function. Idempotency tokens time out after one hour. Therefore, if you call <b>IssueCertificate</b> multiple times with the same idempotency token within 5 minutes, ACM PCA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificates.</p>"
}
},
"ImportCertificateAuthorityCertificateRequest": {
"base": null,
"refs": {
}
},
"Integer1To5000": {
"base": null,
"refs": {
"CrlConfiguration$ExpirationInDays": "<p>Number of days until a certificate expires.</p>"
}
},
"InvalidArgsException": {
"base": "<p>One or more of the specified arguments was not valid.</p>",
"refs": {
}
},
"InvalidArnException": {
"base": "<p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>",
"refs": {
}
},
"InvalidNextTokenException": {
"base": "<p>The token specified in the <code>NextToken</code> argument is not valid. Use the token returned from your previous call to <a>ListCertificateAuthorities</a>.</p>",
"refs": {
}
},
"InvalidPolicyException": {
"base": "<p>The S3 bucket policy is not valid. The policy must give ACM PCA rights to read from and write to the bucket and find the bucket location.</p>",
"refs": {
}
},
"InvalidStateException": {
"base": "<p>The private CA is in a state during which a report cannot be generated.</p>",
"refs": {
}
},
"InvalidTagException": {
"base": "<p>The tag associated with the CA is not valid. The invalid argument is contained in the message field.</p>",
"refs": {
}
},
"IssueCertificateRequest": {
"base": null,
"refs": {
}
},
"IssueCertificateResponse": {
"base": null,
"refs": {
}
},
"KeyAlgorithm": {
"base": null,
"refs": {
"CertificateAuthorityConfiguration$KeyAlgorithm": "<p>Type of the public key algorithm and size, in bits, of the key pair that your key pair creates when it issues a certificate.</p>"
}
},
"LimitExceededException": {
"base": "<p>An ACM PCA limit has been exceeded. See the exception message returned to determine the limit that was exceeded.</p>",
"refs": {
}
},
"ListCertificateAuthoritiesRequest": {
"base": null,
"refs": {
}
},
"ListCertificateAuthoritiesResponse": {
"base": null,
"refs": {
}
},
"ListTagsRequest": {
"base": null,
"refs": {
}
},
"ListTagsResponse": {
"base": null,
"refs": {
}
},
"MalformedCSRException": {
"base": "<p>The certificate signing request is invalid.</p>",
"refs": {
}
},
"MalformedCertificateException": {
"base": "<p>One or more fields in the certificate are invalid.</p>",
"refs": {
}
},
"MaxResults": {
"base": null,
"refs": {
"ListCertificateAuthoritiesRequest$MaxResults": "<p>Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the <code>NextToken</code> element is sent in the response. Use this <code>NextToken</code> value in a subsequent request to retrieve additional items.</p>",
"ListTagsRequest$MaxResults": "<p>Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the <b>NextToken</b> element is sent in the response. Use this <b>NextToken</b> value in a subsequent request to retrieve additional items.</p>"
}
},
"NextToken": {
"base": null,
"refs": {
"ListCertificateAuthoritiesRequest$NextToken": "<p>Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the <code>NextToken</code> parameter from the response you just received.</p>",
"ListCertificateAuthoritiesResponse$NextToken": "<p>When the list is truncated, this value is present and should be used for the <code>NextToken</code> parameter in a subsequent pagination request.</p>",
"ListTagsRequest$NextToken": "<p>Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of <b>NextToken</b> from the response you just received.</p>",
"ListTagsResponse$NextToken": "<p>When the list is truncated, this value is present and should be used for the <b>NextToken</b> parameter in a subsequent pagination request. </p>"
}
},
"PositiveLong": {
"base": null,
"refs": {
"Validity$Value": "<p>Time period.</p>"
}
},
"RequestAlreadyProcessedException": {
"base": "<p>Your request has already been completed.</p>",
"refs": {
}
},
"RequestFailedException": {
"base": "<p>The request has failed for an unspecified reason.</p>",
"refs": {
}
},
"RequestInProgressException": {
"base": "<p>Your request is already in progress.</p>",
"refs": {
}
},
"ResourceNotFoundException": {
"base": "<p>A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.</p>",
"refs": {
}
},
"RevocationConfiguration": {
"base": "<p>Certificate revocation information used by the <a>CreateCertificateAuthority</a> and <a>UpdateCertificateAuthority</a> functions. Your private certificate authority (CA) can create and maintain a certificate revocation list (CRL). A CRL contains information about certificates revoked by your CA. For more information, see <a>RevokeCertificate</a>.</p>",
"refs": {
"CertificateAuthority$RevocationConfiguration": "<p>Information about the certificate revocation list (CRL) created and maintained by your private CA. </p>",
"CreateCertificateAuthorityRequest$RevocationConfiguration": "<p>Contains a Boolean value that you can use to enable a certification revocation list (CRL) for the CA, the name of the S3 bucket to which ACM PCA will write the CRL, and an optional CNAME alias that you can use to hide the name of your bucket in the <b>CRL Distribution Points</b> extension of your CA certificate. For more information, see the <a>CrlConfiguration</a> structure. </p>",
"UpdateCertificateAuthorityRequest$RevocationConfiguration": "<p>Revocation information for your private CA.</p>"
}
},
"RevocationReason": {
"base": null,
"refs": {
"RevokeCertificateRequest$RevocationReason": "<p>Specifies why you revoked the certificate.</p>"
}
},
"RevokeCertificateRequest": {
"base": null,
"refs": {
}
},
"SigningAlgorithm": {
"base": null,
"refs": {
"CertificateAuthorityConfiguration$SigningAlgorithm": "<p>Name of the algorithm your private CA uses to sign certificate requests.</p>",
"IssueCertificateRequest$SigningAlgorithm": "<p>The name of the algorithm that will be used to sign the certificate to be issued.</p>"
}
},
"String": {
"base": null,
"refs": {
"CertificateAuthority$Serial": "<p>Serial number of your private CA.</p>",
"CertificateMismatchException$message": null,
"ConcurrentModificationException$message": null,
"CreateCertificateAuthorityAuditReportRequest$S3BucketName": "<p>Name of the S3 bucket that will contain the audit report.</p>",
"CreateCertificateAuthorityAuditReportResponse$S3Key": "<p>The <b>key</b> that uniquely identifies the report file in your S3 bucket.</p>",
"DescribeCertificateAuthorityAuditReportResponse$S3BucketName": "<p>Name of the S3 bucket that contains the report.</p>",
"DescribeCertificateAuthorityAuditReportResponse$S3Key": "<p>S3 <b>key</b> that uniquely identifies the report file in your S3 bucket.</p>",
"InvalidArgsException$message": null,
"InvalidArnException$message": null,
"InvalidNextTokenException$message": null,
"InvalidPolicyException$message": null,
"InvalidStateException$message": null,
"InvalidTagException$message": null,
"LimitExceededException$message": null,
"MalformedCSRException$message": null,
"MalformedCertificateException$message": null,
"RequestAlreadyProcessedException$message": null,
"RequestFailedException$message": null,
"RequestInProgressException$message": null,
"ResourceNotFoundException$message": null,
"TooManyTagsException$message": null
}
},
"String128": {
"base": null,
"refs": {
"ASN1Subject$State": "<p>State in which the subject of the certificate is located.</p>",
"ASN1Subject$Locality": "<p>The locality (such as a city or town) in which the certificate subject is located.</p>",
"ASN1Subject$Pseudonym": "<p>Typically a shortened version of a longer <b>GivenName</b>. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza.</p>",
"RevokeCertificateRequest$CertificateSerial": "<p>Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling <a>GetCertificate</a> with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The <b>GetCertificate</b> function retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number. </p> <p> <code>openssl x509 -in <i>file_path</i> -text -noout</code> </p> <p>You can also copy the serial number from the console or use the <a href=\"http://docs.aws.amazon.comacm/latest/APIReferenceAPI_DescribeCertificate.html\">DescribeCertificate</a> function in the <i>AWS Certificate Manager API Reference</i>. </p>"
}
},
"String16": {
"base": null,
"refs": {
"ASN1Subject$GivenName": "<p>First name.</p>"
}
},
"String253": {
"base": null,
"refs": {
"CrlConfiguration$CustomCname": "<p>Name inserted into the certificate <b>CRL Distribution Points</b> extension that enables the use of an alias for the CRL distribution point. Use this value if you don't want the name of your S3 bucket to be public.</p>"
}
},
"String3": {
"base": null,
"refs": {
"ASN1Subject$GenerationQualifier": "<p>Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.</p>"
}
},
"String3To255": {
"base": null,
"refs": {
"CrlConfiguration$S3BucketName": "<p>Name of the S3 bucket that contains the CRL. If you do not provide a value for the <b>CustomCname</b> argument, the name of your S3 bucket is placed into the <b>CRL Distribution Points</b> extension of the issued certificate. You can change the name of your bucket by calling the <a>UpdateCertificateAuthority</a> function. You must specify a bucket policy that allows ACM PCA to write the CRL to your bucket.</p>"
}
},
"String40": {
"base": null,
"refs": {
"ASN1Subject$Surname": "<p>Family name. In the US and the UK for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.</p>"
}
},
"String5": {
"base": null,
"refs": {
"ASN1Subject$Initials": "<p>Concatenation that typically contains the first letter of the <b>GivenName</b>, the first letter of the middle name if one exists, and the first letter of the <b>SurName</b>.</p>"
}
},
"String64": {
"base": null,
"refs": {
"ASN1Subject$Organization": "<p>Legal name of the organization with which the certificate subject is affiliated. </p>",
"ASN1Subject$OrganizationalUnit": "<p>A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.</p>",
"ASN1Subject$CommonName": "<p>Fully qualified domain name (FQDN) associated with the certificate subject.</p>",
"ASN1Subject$SerialNumber": "<p>The certificate serial number.</p>",
"ASN1Subject$Title": "<p>A title such as Mr. or Ms. which is pre-pended to the name to refer formally to the certificate subject.</p>"
}
},
"TStamp": {
"base": null,
"refs": {
"CertificateAuthority$CreatedAt": "<p>Date and time at which your private CA was created.</p>",
"CertificateAuthority$LastStateChangeAt": "<p>Date and time at which your private CA was last updated.</p>",
"CertificateAuthority$NotBefore": "<p>Date and time before which your private CA certificate is not valid.</p>",
"CertificateAuthority$NotAfter": "<p>Date and time after which your private CA certificate is not valid.</p>",
"DescribeCertificateAuthorityAuditReportResponse$CreatedAt": "<p>The date and time at which the report was created.</p>"
}
},
"Tag": {
"base": "<p>Tags are labels that you can use to identify and organize your private CAs. Each tag consists of a key and an optional value. You can associate up to 50 tags with a private CA. To add one or more tags to a private CA, call the <a>TagCertificateAuthority</a> function. To remove a tag, call the <a>UntagCertificateAuthority</a> function. </p>",
"refs": {
"TagList$member": null
}
},
"TagCertificateAuthorityRequest": {
"base": null,
"refs": {
}
},
"TagKey": {
"base": null,
"refs": {
"Tag$Key": "<p>Key (name) of the tag.</p>"
}
},
"TagList": {
"base": null,
"refs": {
"ListTagsResponse$Tags": "<p>The tags associated with your private CA.</p>",
"TagCertificateAuthorityRequest$Tags": "<p>List of tags to be associated with the CA.</p>",
"UntagCertificateAuthorityRequest$Tags": "<p>List of tags to be removed from the CA.</p>"
}
},
"TagValue": {
"base": null,
"refs": {
"Tag$Value": "<p>Value of the tag.</p>"
}
},
"TooManyTagsException": {
"base": "<p>You can associate up to 50 tags with a private CA. Exception information is contained in the exception message field.</p>",
"refs": {
}
},
"UntagCertificateAuthorityRequest": {
"base": null,
"refs": {
}
},
"UpdateCertificateAuthorityRequest": {
"base": null,
"refs": {
}
},
"Validity": {
"base": "<p>Length of time for which the certificate issued by your private certificate authority (CA), or by the private CA itself, is valid in days, months, or years. You can issue a certificate by calling the <a>IssueCertificate</a> function.</p>",
"refs": {
"IssueCertificateRequest$Validity": "<p>The type of the validity period.</p>"
}
},
"ValidityPeriodType": {
"base": null,
"refs": {
"Validity$Type": "<p>Specifies whether the <code>Value</code> parameter represents days, months, or years.</p>"
}
}
}
}

5
vendor/github.com/aws/aws-sdk-go/models/apis/acm-pca/2017-08-22/examples-1.json generated vendored Normal file
View File

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

4
vendor/github.com/aws/aws-sdk-go/models/apis/acm-pca/2017-08-22/paginators-1.json generated vendored Normal file
View File

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

113
vendor/github.com/aws/aws-sdk-go/models/apis/acm/2015-12-08/api-2.json generated vendored
View File

@ -7,6 +7,7 @@
"protocol":"json",
"serviceAbbreviation":"ACM",
"serviceFullName":"AWS Certificate Manager",
"serviceId":"ACM",
"signatureVersion":"v4",
"targetPrefix":"CertificateManager",
"uid":"acm-2015-12-08"
@ -52,6 +53,20 @@
{"shape":"InvalidArnException"}
]
},
"ExportCertificate":{
"name":"ExportCertificate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ExportCertificateRequest"},
"output":{"shape":"ExportCertificateResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"RequestInProgressException"},
{"shape":"InvalidArnException"}
]
},
"GetCertificate":{
"name":"GetCertificate",
"http":{
@ -124,7 +139,8 @@
"output":{"shape":"RequestCertificateResponse"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"InvalidDomainValidationOptionsException"}
{"shape":"InvalidDomainValidationOptionsException"},
{"shape":"InvalidArnException"}
]
},
"ResendValidationEmail":{
@ -140,6 +156,20 @@
{"shape":"InvalidArnException"},
{"shape":"InvalidDomainValidationOptionsException"}
]
},
"UpdateCertificateOptions":{
"name":"UpdateCertificateOptions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateCertificateOptionsRequest"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidStateException"},
{"shape":"InvalidArnException"}
]
}
},
"shapes":{
@ -207,7 +237,16 @@
"Type":{"shape":"CertificateType"},
"RenewalSummary":{"shape":"RenewalSummary"},
"KeyUsages":{"shape":"KeyUsageList"},
"ExtendedKeyUsages":{"shape":"ExtendedKeyUsageList"}
"ExtendedKeyUsages":{"shape":"ExtendedKeyUsageList"},
"CertificateAuthorityArn":{"shape":"Arn"},
"RenewalEligibility":{"shape":"RenewalEligibility"},
"Options":{"shape":"CertificateOptions"}
}
},
"CertificateOptions":{
"type":"structure",
"members":{
"CertificateTransparencyLoggingPreference":{"shape":"CertificateTransparencyLoggingPreference"}
}
},
"CertificateStatus":{
@ -237,11 +276,19 @@
"type":"list",
"member":{"shape":"CertificateSummary"}
},
"CertificateTransparencyLoggingPreference":{
"type":"string",
"enum":[
"ENABLED",
"DISABLED"
]
},
"CertificateType":{
"type":"string",
"enum":[
"IMPORTED",
"AMAZON_ISSUED"
"AMAZON_ISSUED",
"PRIVATE"
]
},
"DeleteCertificateRequest":{
@ -319,6 +366,25 @@
"max":100,
"min":1
},
"ExportCertificateRequest":{
"type":"structure",
"required":[
"CertificateArn",
"Passphrase"
],
"members":{
"CertificateArn":{"shape":"Arn"},
"Passphrase":{"shape":"PassphraseBlob"}
}
},
"ExportCertificateResponse":{
"type":"structure",
"members":{
"Certificate":{"shape":"CertificateBody"},
"CertificateChain":{"shape":"CertificateChain"},
"PrivateKey":{"shape":"PrivateKey"}
}
},
"ExtendedKeyUsage":{
"type":"structure",
"members":{
@ -359,6 +425,12 @@
"DOMAIN_NOT_ALLOWED",
"INVALID_PUBLIC_DOMAIN",
"CAA_ERROR",
"PCA_LIMIT_EXCEEDED",
"PCA_INVALID_ARN",
"PCA_INVALID_STATE",
"PCA_REQUEST_FAILED",
"PCA_RESOURCE_NOT_FOUND",
"PCA_INVALID_ARGS",
"OTHER"
]
},
@ -533,6 +605,19 @@
"min":1,
"pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*"
},
"PassphraseBlob":{
"type":"blob",
"max":128,
"min":4,
"sensitive":true
},
"PrivateKey":{
"type":"string",
"max":524288,
"min":1,
"pattern":"-{5}BEGIN PRIVATE KEY-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END PRIVATE KEY-{5}(\\u000D?\\u000A)?",
"sensitive":true
},
"PrivateKeyBlob":{
"type":"blob",
"max":524288,
@ -554,6 +639,13 @@
"Tags":{"shape":"TagList"}
}
},
"RenewalEligibility":{
"type":"string",
"enum":[
"ELIGIBLE",
"INELIGIBLE"
]
},
"RenewalStatus":{
"type":"string",
"enum":[
@ -582,7 +674,9 @@
"ValidationMethod":{"shape":"ValidationMethod"},
"SubjectAlternativeNames":{"shape":"DomainList"},
"IdempotencyToken":{"shape":"IdempotencyToken"},
"DomainValidationOptions":{"shape":"DomainValidationOptionList"}
"DomainValidationOptions":{"shape":"DomainValidationOptionList"},
"Options":{"shape":"CertificateOptions"},
"CertificateAuthorityArn":{"shape":"Arn"}
}
},
"RequestCertificateResponse":{
@ -688,6 +782,17 @@
},
"exception":true
},
"UpdateCertificateOptionsRequest":{
"type":"structure",
"required":[
"CertificateArn",
"Options"
],
"members":{
"CertificateArn":{"shape":"Arn"},
"Options":{"shape":"CertificateOptions"}
}
},
"ValidationEmailList":{
"type":"list",
"member":{"shape":"String"}

97
vendor/github.com/aws/aws-sdk-go/models/apis/acm/2015-12-08/docs-2.json generated vendored
View File

@ -2,16 +2,18 @@
"version": "2.0",
"service": "<fullname>AWS Certificate Manager</fullname> <p>Welcome to the AWS Certificate Manager (ACM) API documentation.</p> <p>You can use ACM to manage SSL/TLS certificates for your AWS-based websites and applications. For general information about using ACM, see the <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/\"> <i>AWS Certificate Manager User Guide</i> </a>.</p>",
"operations": {
"AddTagsToCertificate": "<p>Adds one or more tags to an ACM Certificate. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a <code>key</code> and an optional <code>value</code>. You specify the certificate on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. </p> <p>You can apply a tag to just one certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM Certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/tags.html\">Tagging ACM Certificates</a>. </p> <p>To remove one or more tags, use the <a>RemoveTagsFromCertificate</a> action. To view all of the tags that have been applied to the certificate, use the <a>ListTagsForCertificate</a> action. </p>",
"DeleteCertificate": "<p>Deletes a certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list that can be displayed by calling the <a>ListCertificates</a> action or be retrieved by calling the <a>GetCertificate</a> action. The certificate will not be available for use by AWS services integrated with ACM. </p> <note> <p>You cannot delete an ACM Certificate that is being used by another AWS service. To delete a certificate that is in use, the certificate association must first be removed.</p> </note>",
"DescribeCertificate": "<p>Returns detailed metadata about the specified ACM Certificate.</p>",
"AddTagsToCertificate": "<p>Adds one or more tags to an ACM certificate. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a <code>key</code> and an optional <code>value</code>. You specify the certificate on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. </p> <p>You can apply a tag to just one certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/tags.html\">Tagging ACM certificates</a>. </p> <p>To remove one or more tags, use the <a>RemoveTagsFromCertificate</a> action. To view all of the tags that have been applied to the certificate, use the <a>ListTagsForCertificate</a> action. </p>",
"DeleteCertificate": "<p>Deletes a certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list that can be displayed by calling the <a>ListCertificates</a> action or be retrieved by calling the <a>GetCertificate</a> action. The certificate will not be available for use by AWS services integrated with ACM. </p> <note> <p>You cannot delete an ACM certificate that is being used by another AWS service. To delete a certificate that is in use, the certificate association must first be removed.</p> </note>",
"DescribeCertificate": "<p>Returns detailed metadata about the specified ACM certificate.</p>",
"ExportCertificate": "<p>Exports a private certificate issued by a private certificate authority (CA) for use anywhere. You can export the certificate, the certificate chain, and the encrypted private key associated with the public key embedded in the certificate. You must store the private key securely. The private key is a 2048 bit RSA key. You must provide a passphrase for the private key when exporting it. You can use the following OpenSSL command to decrypt it later. Provide the passphrase when prompted. </p> <p> <code>openssl rsa -in encrypted_key.pem -out decrypted_key.pem</code> </p>",
"GetCertificate": "<p>Retrieves a certificate specified by an ARN and its certificate chain . The chain is an ordered list of certificates that contains the end entity certificate, intermediate certificates of subordinate CAs, and the root certificate in that order. The certificate and certificate chain are base64 encoded. If you want to decode the certificate to see the individual fields, you can use OpenSSL.</p>",
"ImportCertificate": "<p>Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with ACM. Note that <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-services.html\">integrated services</a> allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html\">Importing Certificates</a> in the <i>AWS Certificate Manager User Guide</i>. </p> <note> <p>ACM does not provide <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html\">managed renewal</a> for certificates that you import.</p> </note> <p>Note the following guidelines when importing third party certificates:</p> <ul> <li> <p>You must enter the private key that matches the certificate you are importing.</p> </li> <li> <p>The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase.</p> </li> <li> <p>If the certificate you are importing is not self-signed, you must enter its certificate chain.</p> </li> <li> <p>If a certificate chain is included, the issuer must be the subject of one of the certificates in the chain.</p> </li> <li> <p>The certificate, private key, and certificate chain must be PEM-encoded.</p> </li> <li> <p>The current time must be between the <code>Not Before</code> and <code>Not After</code> certificate fields.</p> </li> <li> <p>The <code>Issuer</code> field must not be empty.</p> </li> <li> <p>The OCSP authority URL, if present, must not exceed 1000 characters.</p> </li> <li> <p>To import a new certificate, omit the <code>CertificateArn</code> argument. Include this argument only when you want to replace a previously imported certificate.</p> </li> <li> <p>When you import a certificate by using the CLI or one of the SDKs, you must specify the certificate, the certificate chain, and the private key by their file names preceded by <code>file://</code>. For example, you can specify a certificate saved in the <code>C:\\temp</code> folder as <code>file://C:\\temp\\certificate_to_import.pem</code>. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs. </p> </li> </ul> <p>This operation returns the <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> of the imported certificate.</p>",
"ImportCertificate": "<p>Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with ACM. Note that <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-services.html\">integrated services</a> allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html\">Importing Certificates</a> in the <i>AWS Certificate Manager User Guide</i>. </p> <note> <p>ACM does not provide <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html\">managed renewal</a> for certificates that you import.</p> </note> <p>Note the following guidelines when importing third party certificates:</p> <ul> <li> <p>You must enter the private key that matches the certificate you are importing.</p> </li> <li> <p>The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase.</p> </li> <li> <p>If the certificate you are importing is not self-signed, you must enter its certificate chain.</p> </li> <li> <p>If a certificate chain is included, the issuer must be the subject of one of the certificates in the chain.</p> </li> <li> <p>The certificate, private key, and certificate chain must be PEM-encoded.</p> </li> <li> <p>The current time must be between the <code>Not Before</code> and <code>Not After</code> certificate fields.</p> </li> <li> <p>The <code>Issuer</code> field must not be empty.</p> </li> <li> <p>The OCSP authority URL, if present, must not exceed 1000 characters.</p> </li> <li> <p>To import a new certificate, omit the <code>CertificateArn</code> argument. Include this argument only when you want to replace a previously imported certificate.</p> </li> <li> <p>When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the private key by their file names preceded by <code>file://</code>. For example, you can specify a certificate saved in the <code>C:\\temp</code> folder as <code>file://C:\\temp\\certificate_to_import.pem</code>. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs. </p> </li> <li> <p>When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using. </p> </li> </ul> <p>This operation returns the <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> of the imported certificate.</p>",
"ListCertificates": "<p>Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate. </p>",
"ListTagsForCertificate": "<p>Lists the tags that have been applied to the ACM Certificate. Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM Certificate, use the <a>AddTagsToCertificate</a> action. To delete a tag, use the <a>RemoveTagsFromCertificate</a> action. </p>",
"RemoveTagsFromCertificate": "<p>Remove one or more tags from an ACM Certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. </p> <p>To add tags to a certificate, use the <a>AddTagsToCertificate</a> action. To view all of the tags that have been applied to a specific ACM Certificate, use the <a>ListTagsForCertificate</a> action. </p>",
"RequestCertificate": "<p>Requests an ACM Certificate for use with other AWS services. To request an ACM Certificate, you must specify the fully qualified domain name (FQDN) for your site in the <code>DomainName</code> parameter. You can also specify additional FQDNs in the <code>SubjectAlternativeNames</code> parameter if users can reach your site by using other names. </p> <p>For each domain name you specify, email is sent to the domain owner to request approval to issue the certificate. Email is sent to three registered contact addresses in the WHOIS database and to five common system administration addresses formed from the <code>DomainName</code> you enter or the optional <code>ValidationDomain</code> parameter. For more information, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate.html\">Validate Domain Ownership</a>. </p> <p>After receiving approval from the domain owner, the ACM Certificate is issued. For more information, see the <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/\">AWS Certificate Manager User Guide</a>. </p>",
"ResendValidationEmail": "<p>Resends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM Certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking <b>I Approve</b>. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM Certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate. For more information about setting up your contact email addresses, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/setup-email.html\">Configure Email for your Domain</a>. </p>"
"ListTagsForCertificate": "<p>Lists the tags that have been applied to the ACM certificate. Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM certificate, use the <a>AddTagsToCertificate</a> action. To delete a tag, use the <a>RemoveTagsFromCertificate</a> action. </p>",
"RemoveTagsFromCertificate": "<p>Remove one or more tags from an ACM certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. </p> <p>To add tags to a certificate, use the <a>AddTagsToCertificate</a> action. To view all of the tags that have been applied to a specific ACM certificate, use the <a>ListTagsForCertificate</a> action. </p>",
"RequestCertificate": "<p>Requests an ACM certificate for use with other AWS services. To request an ACM certificate, you must specify a fully qualified domain name (FQDN) in the <code>DomainName</code> parameter. You can also specify additional FQDNs in the <code>SubjectAlternativeNames</code> parameter. </p> <p>If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html\">DNS validation</a> or <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html\">email validation</a>. We recommend that you use DNS validation. ACM issues public certificates after receiving approval from the domain owner. </p>",
"ResendValidationEmail": "<p>Resends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking <b>I Approve</b>. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate. For more information about setting up your contact email addresses, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/setup-email.html\">Configure Email for your Domain</a>. </p>",
"UpdateCertificateOptions": "<p>Updates a certificate. Currently, you can use this function to specify whether to opt in to or out of recording your certificate in a certificate transparency log. For more information, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency\"> Opting Out of Certificate Transparency Logging</a>. </p>"
},
"shapes": {
"AddTagsToCertificateRequest": {
@ -22,24 +24,29 @@
"Arn": {
"base": null,
"refs": {
"AddTagsToCertificateRequest$CertificateArn": "<p>String that contains the ARN of the ACM Certificate to which the tag is to be applied. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>. </p>",
"AddTagsToCertificateRequest$CertificateArn": "<p>String that contains the ARN of the ACM certificate to which the tag is to be applied. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>. </p>",
"CertificateDetail$CertificateArn": "<p>The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>",
"CertificateDetail$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) of the ACM PCA private certificate authority (CA) that issued the certificate. This has the following format: </p> <p> <code>arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012</code> </p>",
"CertificateSummary$CertificateArn": "<p>Amazon Resource Name (ARN) of the certificate. This is of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>. </p>",
"DeleteCertificateRequest$CertificateArn": "<p>String that contains the ARN of the ACM Certificate to be deleted. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>",
"DescribeCertificateRequest$CertificateArn": "<p>The Amazon Resource Name (ARN) of the ACM Certificate. The ARN must have the following form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>",
"DeleteCertificateRequest$CertificateArn": "<p>String that contains the ARN of the ACM certificate to be deleted. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>",
"DescribeCertificateRequest$CertificateArn": "<p>The Amazon Resource Name (ARN) of the ACM certificate. The ARN must have the following form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>",
"ExportCertificateRequest$CertificateArn": "<p>An Amazon Resource Name (ARN) of the issued certificate. This must be of the form:</p> <p> <code>arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012</code> </p>",
"GetCertificateRequest$CertificateArn": "<p>String that contains a certificate ARN in the following format:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>",
"ImportCertificateRequest$CertificateArn": "<p>The <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> of an imported certificate to replace. To import a new certificate, omit this field. </p>",
"ImportCertificateResponse$CertificateArn": "<p>The <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> of the imported certificate.</p>",
"ListTagsForCertificateRequest$CertificateArn": "<p>String that contains the ARN of the ACM Certificate for which you want to list the tags. This must have the following form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>. </p>",
"ListTagsForCertificateRequest$CertificateArn": "<p>String that contains the ARN of the ACM certificate for which you want to list the tags. This must have the following form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>. </p>",
"RemoveTagsFromCertificateRequest$CertificateArn": "<p>String that contains the ARN of the ACM Certificate with one or more tags that you want to remove. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>. </p>",
"RequestCertificateRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate. For more information about private CAs, see the <a href=\"http://docs.aws.amazon.com/acm-pca/latest/userguide/PcaWelcome.html\">AWS Certificate Manager Private Certificate Authority (PCA)</a> user guide. The ARN must have the following form: </p> <p> <code>arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012</code> </p>",
"RequestCertificateResponse$CertificateArn": "<p>String that contains the ARN of the issued certificate. This must be of the form:</p> <p> <code>arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p>",
"ResendValidationEmailRequest$CertificateArn": "<p>String that contains the ARN of the requested certificate. The certificate ARN is generated and returned by the <a>RequestCertificate</a> action as soon as the request is made. By default, using this parameter causes email to be sent to all top-level domains you specified in the certificate request. The ARN must be of the form: </p> <p> <code>arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p>"
"ResendValidationEmailRequest$CertificateArn": "<p>String that contains the ARN of the requested certificate. The certificate ARN is generated and returned by the <a>RequestCertificate</a> action as soon as the request is made. By default, using this parameter causes email to be sent to all top-level domains you specified in the certificate request. The ARN must be of the form: </p> <p> <code>arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p>",
"UpdateCertificateOptionsRequest$CertificateArn": "<p>ARN of the requested certificate to update. This must be of the form:</p> <p> <code>arn:aws:acm:us-east-1:<i>account</i>:certificate/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>"
}
},
"CertificateBody": {
"base": null,
"refs": {
"GetCertificateResponse$Certificate": "<p>String that contains the ACM Certificate represented by the ARN specified at input.</p>"
"ExportCertificateResponse$Certificate": "<p>The base64 PEM-encoded certificate.</p>",
"GetCertificateResponse$Certificate": "<p>String that contains the ACM certificate represented by the ARN specified at input.</p>"
}
},
"CertificateBodyBlob": {
@ -51,6 +58,7 @@
"CertificateChain": {
"base": null,
"refs": {
"ExportCertificateResponse$CertificateChain": "<p>The base64 PEM-encoded certificate chain. This does not include the certificate that you are exporting.</p>",
"GetCertificateResponse$CertificateChain": "<p>The certificate chain that contains the root certificate issued by the certificate authority (CA).</p>"
}
},
@ -66,6 +74,14 @@
"DescribeCertificateResponse$Certificate": "<p>Metadata about an ACM certificate.</p>"
}
},
"CertificateOptions": {
"base": "<p>Structure that contains options for your certificate. Currently, you can use this only to specify whether to opt in to or out of certificate transparency logging. Some browsers require that public certificates issued for your domain be recorded in a log. Certificates that are not logged typically generate a browser error. Transparency makes it possible for you to detect SSL/TLS certificates that have been mistakenly or maliciously issued for your domain. For general information, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-concepts.html#concept-transparency\">Certificate Transparency Logging</a>. </p>",
"refs": {
"CertificateDetail$Options": "<p>Value that specifies whether to add the certificate to a transparency log. Certificate transparency makes it possible to detect SSL certificates that have been mistakenly or maliciously issued. A browser might respond to certificate that has not been logged by showing an error message. The logs are cryptographically secure. </p>",
"RequestCertificateRequest$Options": "<p>Currently, you can use this parameter to specify whether to add the certificate to a certificate transparency log. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser. For more information, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency\">Opting Out of Certificate Transparency Logging</a>.</p>",
"UpdateCertificateOptionsRequest$Options": "<p>Use to update the options for your certificate. Currently, you can specify whether to add your certificate to a transparency log. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser. </p>"
}
},
"CertificateStatus": {
"base": null,
"refs": {
@ -88,7 +104,13 @@
"CertificateSummaryList": {
"base": null,
"refs": {
"ListCertificatesResponse$CertificateSummaryList": "<p>A list of ACM Certificates.</p>"
"ListCertificatesResponse$CertificateSummaryList": "<p>A list of ACM certificates.</p>"
}
},
"CertificateTransparencyLoggingPreference": {
"base": null,
"refs": {
"CertificateOptions$CertificateTransparencyLoggingPreference": "<p>You can opt out of certificate transparency logging by specifying the <code>DISABLED</code> option. Opt in by specifying <code>ENABLED</code>. </p>"
}
},
"CertificateType": {
@ -116,7 +138,7 @@
"base": null,
"refs": {
"CertificateDetail$SubjectAlternativeNames": "<p>One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website. </p>",
"RequestCertificateRequest$SubjectAlternativeNames": "<p>Additional FQDNs to be included in the Subject Alternative Name extension of the ACM Certificate. For example, add the name www.example.net to a certificate for which the <code>DomainName</code> field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM Certificate is 100. However, the initial limit is 10 domain names. If you need more than 10 names, you must request a limit increase. For more information, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html\">Limits</a>.</p> <p> The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples: </p> <ul> <li> <p> <code>(63 octets).(63 octets).(63 octets).(61 octets)</code> is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.</p> </li> <li> <p> <code>(64 octets).(63 octets).(63 octets).(61 octets)</code> is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets.</p> </li> <li> <p> <code>(63 octets).(63 octets).(63 octets).(62 octets)</code> is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.</p> </li> </ul>"
"RequestCertificateRequest$SubjectAlternativeNames": "<p>Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, add the name www.example.net to a certificate for which the <code>DomainName</code> field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM certificate is 100. However, the initial limit is 10 domain names. If you need more than 10 names, you must request a limit increase. For more information, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html\">Limits</a>.</p> <p> The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples: </p> <ul> <li> <p> <code>(63 octets).(63 octets).(63 octets).(61 octets)</code> is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.</p> </li> <li> <p> <code>(64 octets).(63 octets).(63 octets).(61 octets)</code> is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets.</p> </li> <li> <p> <code>(63 octets).(63 octets).(63 octets).(62 octets)</code> is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.</p> </li> </ul>"
}
},
"DomainNameString": {
@ -129,7 +151,7 @@
"DomainValidation$ValidationDomain": "<p>The domain name that ACM used to send domain validation emails.</p>",
"DomainValidationOption$DomainName": "<p>A fully qualified domain name (FQDN) in the certificate request.</p>",
"DomainValidationOption$ValidationDomain": "<p>The domain name that you want ACM to use to send you validation emails. This domain name is the suffix of the email addresses that you want ACM to use. This must be the same as the <code>DomainName</code> value or a superdomain of the <code>DomainName</code> value. For example, if you request a certificate for <code>testing.example.com</code>, you can specify <code>example.com</code> for this value. In that case, ACM sends domain validation emails to the following five addresses:</p> <ul> <li> <p>admin@example.com</p> </li> <li> <p>administrator@example.com</p> </li> <li> <p>hostmaster@example.com</p> </li> <li> <p>postmaster@example.com</p> </li> <li> <p>webmaster@example.com</p> </li> </ul>",
"RequestCertificateRequest$DomainName": "<p> Fully qualified domain name (FQDN), such as www.example.com, of the site that you want to secure with an ACM Certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com. </p> <p> The first domain name you enter cannot exceed 63 octets, including periods. Each subsequent Subject Alternative Name (SAN), however, can be up to 253 octets in length. </p>",
"RequestCertificateRequest$DomainName": "<p> Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com. </p> <p> The first domain name you enter cannot exceed 63 octets, including periods. Each subsequent Subject Alternative Name (SAN), however, can be up to 253 octets in length. </p>",
"ResendValidationEmailRequest$Domain": "<p>The fully qualified domain name (FQDN) of the certificate that needs to be validated.</p>",
"ResendValidationEmailRequest$ValidationDomain": "<p>The base validation domain that will act as the suffix of the email addresses that are used to send the emails. This must be the same as the <code>Domain</code> value or a superdomain of the <code>Domain</code> value. For example, if you requested a certificate for <code>site.subdomain.example.com</code> and specify a <b>ValidationDomain</b> of <code>subdomain.example.com</code>, ACM sends email to the domain registrant, technical contact, and administrative contact in WHOIS and the following five addresses:</p> <ul> <li> <p>admin@subdomain.example.com</p> </li> <li> <p>administrator@subdomain.example.com</p> </li> <li> <p>hostmaster@subdomain.example.com</p> </li> <li> <p>postmaster@subdomain.example.com</p> </li> <li> <p>webmaster@subdomain.example.com</p> </li> </ul>"
}
@ -165,6 +187,16 @@
"RequestCertificateRequest$DomainValidationOptions": "<p>The domain name that you want ACM to use to send you emails so that you can validate domain ownership.</p>"
}
},
"ExportCertificateRequest": {
"base": null,
"refs": {
}
},
"ExportCertificateResponse": {
"base": null,
"refs": {
}
},
"ExtendedKeyUsage": {
"base": "<p>The Extended Key Usage X.509 v3 extension defines one or more purposes for which the public key can be used. This is in addition to or in place of the basic purposes specified by the Key Usage extension. </p>",
"refs": {
@ -245,7 +277,7 @@
}
},
"InvalidStateException": {
"base": "<p>Processing has reached an invalid state. For example, this exception can occur if the specified domain is not using email validation, or the current certificate status does not permit the requested operation. See the exception message returned by ACM to determine which state is not valid.</p>",
"base": "<p>Processing has reached an invalid state.</p>",
"refs": {
}
},
@ -293,7 +325,7 @@
}
},
"LimitExceededException": {
"base": "<p>An ACM limit has been exceeded. For example, you may have input more domains than are allowed or you've requested too many certificates for your account. See the exception message returned by ACM to determine which limit you have violated. For more information about ACM limits, see the <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html\">Limits</a> topic.</p>",
"base": "<p>An ACM limit has been exceeded.</p>",
"refs": {
}
},
@ -330,6 +362,18 @@
"ListCertificatesResponse$NextToken": "<p>When the list is truncated, this value is present and contains the value to use for the <code>NextToken</code> parameter in a subsequent pagination request.</p>"
}
},
"PassphraseBlob": {
"base": null,
"refs": {
"ExportCertificateRequest$Passphrase": "<p>Passphrase to associate with the encrypted exported private key. If you want to later decrypt the private key, you must have the passphrase. You can use the following OpenSSL command to decrypt a private key: </p> <p> <code>openssl rsa -in encrypted_key.pem -out decrypted_key.pem</code> </p>"
}
},
"PrivateKey": {
"base": null,
"refs": {
"ExportCertificateResponse$PrivateKey": "<p>The PEM-encoded private key associated with the public key in the certificate.</p>"
}
},
"PrivateKeyBlob": {
"base": null,
"refs": {
@ -347,6 +391,12 @@
"refs": {
}
},
"RenewalEligibility": {
"base": null,
"refs": {
"CertificateDetail$RenewalEligibility": "<p>Specifies whether the certificate is eligible for renewal.</p>"
}
},
"RenewalStatus": {
"base": null,
"refs": {
@ -385,7 +435,7 @@
}
},
"ResourceNotFoundException": {
"base": "<p>The specified certificate cannot be found in the caller's account, or the caller's account cannot be found.</p>",
"base": "<p>The specified certificate cannot be found in the caller's account or the caller's account cannot be found.</p>",
"refs": {
}
},
@ -466,6 +516,11 @@
"refs": {
}
},
"UpdateCertificateOptionsRequest": {
"base": null,
"refs": {
}
},
"ValidationEmailList": {
"base": null,
"refs": {
@ -476,7 +531,7 @@
"base": null,
"refs": {
"DomainValidation$ValidationMethod": "<p>Specifies the domain validation method.</p>",
"RequestCertificateRequest$ValidationMethod": "<p>The method you want to use to validate your domain.</p>"
"RequestCertificateRequest$ValidationMethod": "<p>The method you want to use if you are requesting a public certificate to validate that you own or control domain. You can <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html\">validate with DNS</a> or <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html\">validate with email</a>. We recommend that you use DNS validation. </p>"
}
}
}

18
vendor/github.com/aws/aws-sdk-go/models/apis/acm/2015-12-08/smoke.json generated vendored Normal file
View File

@ -0,0 +1,18 @@
{
"version": 1,
"defaultRegion": "us-west-2",
"testCases": [
{
"operationName": "ListCertificates",
"input": {},
"errorExpectedFromService": false
},
{
"operationName": "GetCertificate",
"input": {
"CertificateArn": "arn:aws:acm:region:123456789012:certificate\/12345678-1234-1234-1234-123456789012"
},
"errorExpectedFromService": true
}
]
}

449
vendor/github.com/aws/aws-sdk-go/models/apis/alexaforbusiness/2017-11-09/api-2.json generated vendored
View File

@ -11,6 +11,18 @@
"uid":"alexaforbusiness-2017-11-09"
},
"operations":{
"AssociateContactWithAddressBook":{
"name":"AssociateContactWithAddressBook",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AssociateContactWithAddressBookRequest"},
"output":{"shape":"AssociateContactWithAddressBookResponse"},
"errors":[
{"shape":"LimitExceededException"}
]
},
"AssociateDeviceWithRoom":{
"name":"AssociateDeviceWithRoom",
"http":{
@ -32,6 +44,32 @@
"input":{"shape":"AssociateSkillGroupWithRoomRequest"},
"output":{"shape":"AssociateSkillGroupWithRoomResponse"}
},
"CreateAddressBook":{
"name":"CreateAddressBook",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateAddressBookRequest"},
"output":{"shape":"CreateAddressBookResponse"},
"errors":[
{"shape":"AlreadyExistsException"},
{"shape":"LimitExceededException"}
]
},
"CreateContact":{
"name":"CreateContact",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateContactRequest"},
"output":{"shape":"CreateContactResponse"},
"errors":[
{"shape":"AlreadyExistsException"},
{"shape":"LimitExceededException"}
]
},
"CreateProfile":{
"name":"CreateProfile",
"http":{
@ -84,6 +122,30 @@
{"shape":"LimitExceededException"}
]
},
"DeleteAddressBook":{
"name":"DeleteAddressBook",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteAddressBookRequest"},
"output":{"shape":"DeleteAddressBookResponse"},
"errors":[
{"shape":"NotFoundException"}
]
},
"DeleteContact":{
"name":"DeleteContact",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteContactRequest"},
"output":{"shape":"DeleteContactResponse"},
"errors":[
{"shape":"NotFoundException"}
]
},
"DeleteProfile":{
"name":"DeleteProfile",
"http":{
@ -141,6 +203,15 @@
{"shape":"NotFoundException"}
]
},
"DisassociateContactFromAddressBook":{
"name":"DisassociateContactFromAddressBook",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisassociateContactFromAddressBookRequest"},
"output":{"shape":"DisassociateContactFromAddressBookResponse"}
},
"DisassociateDeviceFromRoom":{
"name":"DisassociateDeviceFromRoom",
"http":{
@ -159,6 +230,30 @@
"input":{"shape":"DisassociateSkillGroupFromRoomRequest"},
"output":{"shape":"DisassociateSkillGroupFromRoomResponse"}
},
"GetAddressBook":{
"name":"GetAddressBook",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetAddressBookRequest"},
"output":{"shape":"GetAddressBookResponse"},
"errors":[
{"shape":"NotFoundException"}
]
},
"GetContact":{
"name":"GetContact",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetContactRequest"},
"output":{"shape":"GetContactResponse"},
"errors":[
{"shape":"NotFoundException"}
]
},
"GetDevice":{
"name":"GetDevice",
"http":{
@ -219,6 +314,18 @@
{"shape":"NotFoundException"}
]
},
"ListDeviceEvents":{
"name":"ListDeviceEvents",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListDeviceEventsRequest"},
"output":{"shape":"ListDeviceEventsResponse"},
"errors":[
{"shape":"NotFoundException"}
]
},
"ListSkills":{
"name":"ListSkills",
"http":{
@ -273,6 +380,24 @@
{"shape":"NotFoundException"}
]
},
"SearchAddressBooks":{
"name":"SearchAddressBooks",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SearchAddressBooksRequest"},
"output":{"shape":"SearchAddressBooksResponse"}
},
"SearchContacts":{
"name":"SearchContacts",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SearchContactsRequest"},
"output":{"shape":"SearchContactsResponse"}
},
"SearchDevices":{
"name":"SearchDevices",
"http":{
@ -364,6 +489,31 @@
{"shape":"NotFoundException"}
]
},
"UpdateAddressBook":{
"name":"UpdateAddressBook",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateAddressBookRequest"},
"output":{"shape":"UpdateAddressBookResponse"},
"errors":[
{"shape":"NotFoundException"},
{"shape":"NameInUseException"}
]
},
"UpdateContact":{
"name":"UpdateContact",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateContactRequest"},
"output":{"shape":"UpdateContactResponse"},
"errors":[
{"shape":"NotFoundException"}
]
},
"UpdateDevice":{
"name":"UpdateDevice",
"http":{
@ -422,6 +572,38 @@
"max":500,
"min":1
},
"AddressBook":{
"type":"structure",
"members":{
"AddressBookArn":{"shape":"Arn"},
"Name":{"shape":"AddressBookName"},
"Description":{"shape":"AddressBookDescription"}
}
},
"AddressBookData":{
"type":"structure",
"members":{
"AddressBookArn":{"shape":"Arn"},
"Name":{"shape":"AddressBookName"},
"Description":{"shape":"AddressBookDescription"}
}
},
"AddressBookDataList":{
"type":"list",
"member":{"shape":"AddressBookData"}
},
"AddressBookDescription":{
"type":"string",
"max":200,
"min":1,
"pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*"
},
"AddressBookName":{
"type":"string",
"max":100,
"min":1,
"pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*"
},
"AlreadyExistsException":{
"type":"structure",
"members":{
@ -433,6 +615,22 @@
"type":"string",
"pattern":"arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}"
},
"AssociateContactWithAddressBookRequest":{
"type":"structure",
"required":[
"ContactArn",
"AddressBookArn"
],
"members":{
"ContactArn":{"shape":"Arn"},
"AddressBookArn":{"shape":"Arn"}
}
},
"AssociateContactWithAddressBookResponse":{
"type":"structure",
"members":{
}
},
"AssociateDeviceWithRoomRequest":{
"type":"structure",
"members":{
@ -464,6 +662,84 @@
"min":10,
"pattern":"[a-zA-Z0-9][a-zA-Z0-9_-]*"
},
"ConnectionStatus":{
"type":"string",
"enum":[
"ONLINE",
"OFFLINE"
]
},
"Contact":{
"type":"structure",
"members":{
"ContactArn":{"shape":"Arn"},
"DisplayName":{"shape":"ContactName"},
"FirstName":{"shape":"ContactName"},
"LastName":{"shape":"ContactName"},
"PhoneNumber":{"shape":"E164PhoneNumber"}
}
},
"ContactData":{
"type":"structure",
"members":{
"ContactArn":{"shape":"Arn"},
"DisplayName":{"shape":"ContactName"},
"FirstName":{"shape":"ContactName"},
"LastName":{"shape":"ContactName"},
"PhoneNumber":{"shape":"E164PhoneNumber"}
}
},
"ContactDataList":{
"type":"list",
"member":{"shape":"ContactData"}
},
"ContactName":{
"type":"string",
"max":100,
"min":1,
"pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*"
},
"CreateAddressBookRequest":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{"shape":"AddressBookName"},
"Description":{"shape":"AddressBookDescription"},
"ClientRequestToken":{
"shape":"ClientRequestToken",
"idempotencyToken":true
}
}
},
"CreateAddressBookResponse":{
"type":"structure",
"members":{
"AddressBookArn":{"shape":"Arn"}
}
},
"CreateContactRequest":{
"type":"structure",
"required":[
"FirstName",
"PhoneNumber"
],
"members":{
"DisplayName":{"shape":"ContactName"},
"FirstName":{"shape":"ContactName"},
"LastName":{"shape":"ContactName"},
"PhoneNumber":{"shape":"E164PhoneNumber"},
"ClientRequestToken":{
"shape":"ClientRequestToken",
"idempotencyToken":true
}
}
},
"CreateContactResponse":{
"type":"structure",
"members":{
"ContactArn":{"shape":"Arn"}
}
},
"CreateProfileRequest":{
"type":"structure",
"required":[
@ -556,6 +832,30 @@
"UserArn":{"shape":"Arn"}
}
},
"DeleteAddressBookRequest":{
"type":"structure",
"required":["AddressBookArn"],
"members":{
"AddressBookArn":{"shape":"Arn"}
}
},
"DeleteAddressBookResponse":{
"type":"structure",
"members":{
}
},
"DeleteContactRequest":{
"type":"structure",
"required":["ContactArn"],
"members":{
"ContactArn":{"shape":"Arn"}
}
},
"DeleteContactResponse":{
"type":"structure",
"members":{
}
},
"DeleteProfileRequest":{
"type":"structure",
"members":{
@ -652,6 +952,23 @@
"type":"list",
"member":{"shape":"DeviceData"}
},
"DeviceEvent":{
"type":"structure",
"members":{
"Type":{"shape":"DeviceEventType"},
"Value":{"shape":"DeviceEventValue"},
"Timestamp":{"shape":"Timestamp"}
}
},
"DeviceEventList":{
"type":"list",
"member":{"shape":"DeviceEvent"}
},
"DeviceEventType":{
"type":"string",
"enum":["CONNECTION_STATUS"]
},
"DeviceEventValue":{"type":"string"},
"DeviceName":{
"type":"string",
"max":100,
@ -690,13 +1007,30 @@
"DeviceStatusInfo":{
"type":"structure",
"members":{
"DeviceStatusDetails":{"shape":"DeviceStatusDetails"}
"DeviceStatusDetails":{"shape":"DeviceStatusDetails"},
"ConnectionStatus":{"shape":"ConnectionStatus"}
}
},
"DeviceType":{
"type":"string",
"pattern":"[a-zA-Z0-9]{1,200}"
},
"DisassociateContactFromAddressBookRequest":{
"type":"structure",
"required":[
"ContactArn",
"AddressBookArn"
],
"members":{
"ContactArn":{"shape":"Arn"},
"AddressBookArn":{"shape":"Arn"}
}
},
"DisassociateContactFromAddressBookResponse":{
"type":"structure",
"members":{
}
},
"DisassociateDeviceFromRoomRequest":{
"type":"structure",
"members":{
@ -727,6 +1061,10 @@
"IMPERIAL"
]
},
"E164PhoneNumber":{
"type":"string",
"pattern":"^\\+\\d{8,}$"
},
"Email":{
"type":"string",
"max":128,
@ -744,6 +1082,7 @@
"INITIALIZED",
"PENDING",
"REGISTERED",
"DISASSOCIATING",
"DEREGISTERING"
]
},
@ -794,6 +1133,32 @@
"member":{"shape":"FilterValue"},
"max":5
},
"GetAddressBookRequest":{
"type":"structure",
"required":["AddressBookArn"],
"members":{
"AddressBookArn":{"shape":"Arn"}
}
},
"GetAddressBookResponse":{
"type":"structure",
"members":{
"AddressBook":{"shape":"AddressBook"}
}
},
"GetContactRequest":{
"type":"structure",
"required":["ContactArn"],
"members":{
"ContactArn":{"shape":"Arn"}
}
},
"GetContactResponse":{
"type":"structure",
"members":{
"Contact":{"shape":"Contact"}
}
},
"GetDeviceRequest":{
"type":"structure",
"members":{
@ -874,6 +1239,23 @@
},
"exception":true
},
"ListDeviceEventsRequest":{
"type":"structure",
"required":["DeviceArn"],
"members":{
"DeviceArn":{"shape":"Arn"},
"EventType":{"shape":"DeviceEventType"},
"NextToken":{"shape":"NextToken"},
"MaxResults":{"shape":"MaxResults"}
}
},
"ListDeviceEventsResponse":{
"type":"structure",
"members":{
"DeviceEvents":{"shape":"DeviceEventList"},
"NextToken":{"shape":"NextToken"}
}
},
"ListSkillsRequest":{
"type":"structure",
"members":{
@ -1091,6 +1473,40 @@
"type":"list",
"member":{"shape":"RoomSkillParameter"}
},
"SearchAddressBooksRequest":{
"type":"structure",
"members":{
"Filters":{"shape":"FilterList"},
"SortCriteria":{"shape":"SortList"},
"NextToken":{"shape":"NextToken"},
"MaxResults":{"shape":"MaxResults"}
}
},
"SearchAddressBooksResponse":{
"type":"structure",
"members":{
"AddressBooks":{"shape":"AddressBookDataList"},
"NextToken":{"shape":"NextToken"},
"TotalCount":{"shape":"TotalCount"}
}
},
"SearchContactsRequest":{
"type":"structure",
"members":{
"Filters":{"shape":"FilterList"},
"SortCriteria":{"shape":"SortList"},
"NextToken":{"shape":"NextToken"},
"MaxResults":{"shape":"MaxResults"}
}
},
"SearchContactsResponse":{
"type":"structure",
"members":{
"Contacts":{"shape":"ContactDataList"},
"NextToken":{"shape":"NextToken"},
"TotalCount":{"shape":"TotalCount"}
}
},
"SearchDevicesRequest":{
"type":"structure",
"members":{
@ -1339,6 +1755,7 @@
"CELSIUS"
]
},
"Timestamp":{"type":"timestamp"},
"Timezone":{
"type":"string",
"max":100,
@ -1361,6 +1778,36 @@
"members":{
}
},
"UpdateAddressBookRequest":{
"type":"structure",
"required":["AddressBookArn"],
"members":{
"AddressBookArn":{"shape":"Arn"},
"Name":{"shape":"AddressBookName"},
"Description":{"shape":"AddressBookDescription"}
}
},
"UpdateAddressBookResponse":{
"type":"structure",
"members":{
}
},
"UpdateContactRequest":{
"type":"structure",
"required":["ContactArn"],
"members":{
"ContactArn":{"shape":"Arn"},
"DisplayName":{"shape":"ContactName"},
"FirstName":{"shape":"ContactName"},
"LastName":{"shape":"ContactName"},
"PhoneNumber":{"shape":"E164PhoneNumber"}
}
},
"UpdateContactResponse":{
"type":"structure",
"members":{
}
},
"UpdateDeviceRequest":{
"type":"structure",
"members":{

308
vendor/github.com/aws/aws-sdk-go/models/apis/alexaforbusiness/2017-11-09/docs-2.json generated vendored
View File

@ -1,39 +1,52 @@
{
"version": "2.0",
"service": "<p>Alexa for Business makes it easy for you to use Alexa in your organization. Alexa for Business gives you the tools you need to manage Alexa devices, enroll your users, and assign skills, at scale. You can build your own context-aware voice skills using the Alexa Skills Kit, and the Alexa for Business APIs, and you can make these available as private skills for your organization. Alexa for Business also makes it easy to voice-enable your products and services, providing context-aware voice experiences for your customers.</p>",
"service": "<p>Alexa for Business makes it easy for you to use Alexa in your organization. Alexa for Business gives you the tools you need for managing Alexa devices, enroll your users, and assign skills, at scale. You can build your own context-aware voice skills using the Alexa Skills Kit and the Alexa for Business API operations. You can make also these available as private skills for your organization. Alexa for Business makes it easy to voice-enable your products and services, providing context-aware voice experiences for your customers.</p>",
"operations": {
"AssociateDeviceWithRoom": "<p>Associates a device to a given room. This applies all the settings from the room profile to the device, and all the skills in any skill groups added to that room. This operation requires the device to be online, or a manual sync is required. </p>",
"AssociateSkillGroupWithRoom": "<p>Associates a skill group to a given room. This enables all skills in the associated skill group on all devices in the room.</p>",
"AssociateContactWithAddressBook": "<p>Associates a contact with a given address book.</p>",
"AssociateDeviceWithRoom": "<p>Associates a device with a given room. This applies all the settings from the room profile to the device, and all the skills in any skill groups added to that room. This operation requires the device to be online, or else a manual sync is required. </p>",
"AssociateSkillGroupWithRoom": "<p>Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.</p>",
"CreateAddressBook": "<p>Creates an address book with the specified details.</p>",
"CreateContact": "<p>Creates a contact with the specified details.</p>",
"CreateProfile": "<p>Creates a new room profile with the specified details.</p>",
"CreateRoom": "<p>Creates a room with the specified details.</p>",
"CreateSkillGroup": "<p>Creates a skill group with a specified name and description.</p>",
"CreateUser": "<p>Creates a user.</p>",
"DeleteAddressBook": "<p>Deletes an address book by the address book ARN.</p>",
"DeleteContact": "<p>Deletes a contact by the contact ARN.</p>",
"DeleteProfile": "<p>Deletes a room profile by the profile ARN.</p>",
"DeleteRoom": "<p>Deletes a room by the room ARN.</p>",
"DeleteRoomSkillParameter": "<p>Deletes room skill parameter details by room, skill, and parameter key ID.</p>",
"DeleteSkillGroup": "<p>Deletes a skill group by skill group ARN.</p>",
"DeleteUser": "<p>Deletes a specified user by user ARN and enrollment ARN.</p>",
"DisassociateContactFromAddressBook": "<p>Disassociates a contact from a given address book.</p>",
"DisassociateDeviceFromRoom": "<p>Disassociates a device from its current room. The device continues to be connected to the Wi-Fi network and is still registered to the account. The device settings and skills are removed from the room.</p>",
"DisassociateSkillGroupFromRoom": "<p>Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.</p>",
"GetAddressBook": "<p>Gets address the book details by the address book ARN.</p>",
"GetContact": "<p>Gets the contact details by the contact ARN.</p>",
"GetDevice": "<p>Gets the details of a device by device ARN.</p>",
"GetProfile": "<p>Gets the details of a room profile by profile ARN.</p>",
"GetRoom": "<p>Gets room details by room ARN.</p>",
"GetRoomSkillParameter": "<p>Gets room skill parameter details by room, skill, and parameter key ARN.</p>",
"GetSkillGroup": "<p>Gets skill group details by skill group ARN.</p>",
"ListDeviceEvents": "<p>Lists the Device Event history for up to 30 days. If EventType isn't specified in the request, this returns a list of all device events in reverse chronological order. If EventType is specified, this returns a list of device events for that EventType in reverse chronological order. </p>",
"ListSkills": "<p>Lists all enabled skills in a specific skill group.</p>",
"ListTags": "<p>Lists all tags for a specific resource.</p>",
"PutRoomSkillParameter": "<p>Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.</p>",
"ResolveRoom": "<p>Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.</p>",
"RevokeInvitation": "<p>Revokes an invitation and invalidates the enrollment URL.</p>",
"SearchAddressBooks": "<p>Searches address books and lists the ones that meet a set of filter and sort criteria.</p>",
"SearchContacts": "<p>Searches contacts and lists the ones that meet a set of filter and sort criteria.</p>",
"SearchDevices": "<p>Searches devices and lists the ones that meet a set of filter criteria.</p>",
"SearchProfiles": "<p>Searches room profiles and lists the ones that meet a set of filter criteria.</p>",
"SearchRooms": "<p>Searches rooms and lists the ones that meet a set of filter and sort criteria.</p>",
"SearchSkillGroups": "<p>Searches skill groups and lists the ones that meet a set of filter and sort criteria.</p>",
"SearchUsers": "<p>Searches users and lists the ones that meet a set of filter and sort criteria.</p>",
"SendInvitation": "<p>Sends an enrollment invitation email with a URL to a user. The URL is valid for 72 hours or until you call this operation again, whichever comes first. </p>",
"StartDeviceSync": "<p>Resets a device and its account to the known default settings by clearing all information and settings set by previous users.</p>",
"StartDeviceSync": "<p>Resets a device and its account to the known default settings, by clearing all information and settings set by previous users.</p>",
"TagResource": "<p>Adds metadata tags to a specified resource.</p>",
"UntagResource": "<p>Removes metadata tags from a specified resource.</p>",
"UpdateAddressBook": "<p>Updates address book details by the address book ARN.</p>",
"UpdateContact": "<p>Updates the contact details by the contact ARN.</p>",
"UpdateDevice": "<p>Updates the device name by device ARN.</p>",
"UpdateProfile": "<p>Updates an existing room profile by room profile ARN.</p>",
"UpdateRoom": "<p>Updates room details by room ARN.</p>",
@ -49,6 +62,42 @@
"UpdateProfileRequest$Address": "<p>The updated address for the room profile.</p>"
}
},
"AddressBook": {
"base": "<p>An address book with attributes.</p>",
"refs": {
"GetAddressBookResponse$AddressBook": "<p>The details of the requested address book.</p>"
}
},
"AddressBookData": {
"base": "<p>Information related to an address book.</p>",
"refs": {
"AddressBookDataList$member": null
}
},
"AddressBookDataList": {
"base": null,
"refs": {
"SearchAddressBooksResponse$AddressBooks": "<p>The address books that meet the specified set of filter criteria, in sort order.</p>"
}
},
"AddressBookDescription": {
"base": null,
"refs": {
"AddressBook$Description": "<p>The description of the address book.</p>",
"AddressBookData$Description": "<p>The description of the address book.</p>",
"CreateAddressBookRequest$Description": "<p>The description of the address book.</p>",
"UpdateAddressBookRequest$Description": "<p>The updated description of the room.</p>"
}
},
"AddressBookName": {
"base": null,
"refs": {
"AddressBook$Name": "<p>The name of the address book.</p>",
"AddressBookData$Name": "<p>The name of the address book.</p>",
"CreateAddressBookRequest$Name": "<p>The name of the address book.</p>",
"UpdateAddressBookRequest$Name": "<p>The updated name of the room.</p>"
}
},
"AlreadyExistsException": {
"base": "<p>The resource being created already exists. HTTP Status Code: 400</p>",
"refs": {
@ -57,15 +106,25 @@
"Arn": {
"base": null,
"refs": {
"AddressBook$AddressBookArn": "<p>The ARN of the address book.</p>",
"AddressBookData$AddressBookArn": "<p>The ARN of the address book.</p>",
"AssociateContactWithAddressBookRequest$ContactArn": "<p>The ARN of the contact to associate with an address book.</p>",
"AssociateContactWithAddressBookRequest$AddressBookArn": "<p>The ARN of the address book with which to associate the contact.</p>",
"AssociateDeviceWithRoomRequest$DeviceArn": "<p>The ARN of the device to associate to a room. Required.</p>",
"AssociateDeviceWithRoomRequest$RoomArn": "<p>The ARN of the room with which to associate the device. Required.</p>",
"AssociateSkillGroupWithRoomRequest$SkillGroupArn": "<p>The ARN of the skill group to associate with a room. Required.</p>",
"AssociateSkillGroupWithRoomRequest$RoomArn": "<p>The ARN of the room with which to associate the skill group. Required.</p>",
"Contact$ContactArn": "<p>The ARN of the contact.</p>",
"ContactData$ContactArn": "<p>The ARN of the contact.</p>",
"CreateAddressBookResponse$AddressBookArn": "<p>The ARN of the newly created address book.</p>",
"CreateContactResponse$ContactArn": "<p>The ARN of the newly created address book.</p>",
"CreateProfileResponse$ProfileArn": "<p>The ARN of the newly created room profile in the response.</p>",
"CreateRoomRequest$ProfileArn": "<p>The profile ARN for the room.</p>",
"CreateRoomResponse$RoomArn": "<p>The ARN of the newly created room in the response.</p>",
"CreateSkillGroupResponse$SkillGroupArn": "<p>The ARN of the newly created skill group in the response.</p>",
"CreateUserResponse$UserArn": "<p>The ARN of the newly created user in the response.</p>",
"DeleteAddressBookRequest$AddressBookArn": "<p>The ARN of the address book to delete.</p>",
"DeleteContactRequest$ContactArn": "<p>The ARN of the contact to delete.</p>",
"DeleteProfileRequest$ProfileArn": "<p>The ARN of the room profile to delete. Required.</p>",
"DeleteRoomRequest$RoomArn": "<p>The ARN of the room to delete. Required.</p>",
"DeleteRoomSkillParameterRequest$RoomArn": "<p>The ARN of the room from which to remove the room skill parameter details.</p>",
@ -75,14 +134,19 @@
"Device$RoomArn": "<p>The room ARN of a device.</p>",
"DeviceData$DeviceArn": "<p>The ARN of a device.</p>",
"DeviceData$RoomArn": "<p>The room ARN associated with a device.</p>",
"DisassociateContactFromAddressBookRequest$ContactArn": "<p>The ARN of the contact to disassociate from an address book.</p>",
"DisassociateContactFromAddressBookRequest$AddressBookArn": "<p>The ARN of the address from which to disassociate the contact.</p>",
"DisassociateDeviceFromRoomRequest$DeviceArn": "<p>The ARN of the device to disassociate from a room. Required.</p>",
"DisassociateSkillGroupFromRoomRequest$SkillGroupArn": "<p>The ARN of the skill group to disassociate from a room. Required.</p>",
"DisassociateSkillGroupFromRoomRequest$RoomArn": "<p>The ARN of the room from which the skill group is to be disassociated. Required.</p>",
"GetAddressBookRequest$AddressBookArn": "<p>The ARN of the address book for which to request details.</p>",
"GetContactRequest$ContactArn": "<p>The ARN of the contact for which to request details.</p>",
"GetDeviceRequest$DeviceArn": "<p>The ARN of the device for which to request details. Required.</p>",
"GetProfileRequest$ProfileArn": "<p>The ARN of the room profile for which to request details. Required.</p>",
"GetRoomRequest$RoomArn": "<p>The ARN of the room for which to request details. Required.</p>",
"GetRoomSkillParameterRequest$RoomArn": "<p>The ARN of the room from which to get the room skill parameter details. </p>",
"GetSkillGroupRequest$SkillGroupArn": "<p>The ARN of the skill group for which to get details. Required.</p>",
"ListDeviceEventsRequest$DeviceArn": "<p>The ARN of a device.</p>",
"ListSkillsRequest$SkillGroupArn": "<p>The ARN of the skill group for which to list enabled skills. Required.</p>",
"ListTagsRequest$Arn": "<p>The ARN of the specific resource for which to list tags. Required.</p>",
"Profile$ProfileArn": "<p>The ARN of a room profile.</p>",
@ -101,6 +165,8 @@
"StartDeviceSyncRequest$DeviceArn": "<p>The ARN of the device to sync. Required.</p>",
"TagResourceRequest$Arn": "<p>The ARN of the resource to which to add metadata tags. Required. </p>",
"UntagResourceRequest$Arn": "<p>The ARN of the resource from which to remove metadata tags. Required. </p>",
"UpdateAddressBookRequest$AddressBookArn": "<p>The ARN of the room to update.</p>",
"UpdateContactRequest$ContactArn": "<p>The ARN of the contact to update.</p>",
"UpdateDeviceRequest$DeviceArn": "<p>The ARN of the device to update. Required.</p>",
"UpdateProfileRequest$ProfileArn": "<p>The ARN of the room profile to update. Required.</p>",
"UpdateRoomRequest$RoomArn": "<p>The ARN of the room to update. </p>",
@ -109,6 +175,16 @@
"UserData$UserArn": "<p>The ARN of a user.</p>"
}
},
"AssociateContactWithAddressBookRequest": {
"base": null,
"refs": {
}
},
"AssociateContactWithAddressBookResponse": {
"base": null,
"refs": {
}
},
"AssociateDeviceWithRoomRequest": {
"base": null,
"refs": {
@ -143,6 +219,8 @@
"ClientRequestToken": {
"base": "User specified token that is used to support idempotency during Create Resource",
"refs": {
"CreateAddressBookRequest$ClientRequestToken": "<p>A unique, user-specified identifier for the request that ensures idempotency.</p>",
"CreateContactRequest$ClientRequestToken": "<p>A unique, user-specified identifier for this request that ensures idempotency.</p>",
"CreateProfileRequest$ClientRequestToken": "<p>The user-specified token that is used during the creation of a profile.</p>",
"CreateRoomRequest$ClientRequestToken": "<p>A unique, user-specified identifier for this request that ensures idempotency. </p>",
"CreateSkillGroupRequest$ClientRequestToken": "<p>A unique, user-specified identifier for this request that ensures idempotency. </p>",
@ -150,6 +228,67 @@
"ResourceInUseException$ClientRequestToken": null
}
},
"ConnectionStatus": {
"base": null,
"refs": {
"DeviceStatusInfo$ConnectionStatus": "<p>The latest available information about the connection status of a device. </p>"
}
},
"Contact": {
"base": "<p>A contact with attributes.</p>",
"refs": {
"GetContactResponse$Contact": "<p>The details of the requested contact.</p>"
}
},
"ContactData": {
"base": "<p>Information related to a contact.</p>",
"refs": {
"ContactDataList$member": null
}
},
"ContactDataList": {
"base": null,
"refs": {
"SearchContactsResponse$Contacts": "<p>The contacts that meet the specified set of filter criteria, in sort order.</p>"
}
},
"ContactName": {
"base": null,
"refs": {
"Contact$DisplayName": "<p>The name of the contact to display on the console.</p>",
"Contact$FirstName": "<p>The first name of the contact, used to call the contact on the device.</p>",
"Contact$LastName": "<p>The last name of the contact, used to call the contact on the device.</p>",
"ContactData$DisplayName": "<p>The name of the contact to display on the console.</p>",
"ContactData$FirstName": "<p>The first name of the contact, used to call the contact on the device.</p>",
"ContactData$LastName": "<p>The last name of the contact, used to call the contact on the device.</p>",
"CreateContactRequest$DisplayName": "<p>The name of the contact to display on the console.</p>",
"CreateContactRequest$FirstName": "<p>The first name of the contact that is used to call the contact on the device.</p>",
"CreateContactRequest$LastName": "<p>The last name of the contact that is used to call the contact on the device.</p>",
"UpdateContactRequest$DisplayName": "<p>The updated display name of the contact.</p>",
"UpdateContactRequest$FirstName": "<p>The updated first name of the contact.</p>",
"UpdateContactRequest$LastName": "<p>The updated last name of the contact.</p>"
}
},
"CreateAddressBookRequest": {
"base": null,
"refs": {
}
},
"CreateAddressBookResponse": {
"base": null,
"refs": {
}
},
"CreateContactRequest": {
"base": null,
"refs": {
}
},
"CreateContactResponse": {
"base": null,
"refs": {
}
},
"CreateProfileRequest": {
"base": null,
"refs": {
@ -190,6 +329,26 @@
"refs": {
}
},
"DeleteAddressBookRequest": {
"base": null,
"refs": {
}
},
"DeleteAddressBookResponse": {
"base": null,
"refs": {
}
},
"DeleteContactRequest": {
"base": null,
"refs": {
}
},
"DeleteContactResponse": {
"base": null,
"refs": {
}
},
"DeleteProfileRequest": {
"base": null,
"refs": {
@ -258,6 +417,31 @@
"SearchDevicesResponse$Devices": "<p>The devices that meet the specified set of filter criteria, in sort order.</p>"
}
},
"DeviceEvent": {
"base": "<p>The list of device events.</p>",
"refs": {
"DeviceEventList$member": null
}
},
"DeviceEventList": {
"base": null,
"refs": {
"ListDeviceEventsResponse$DeviceEvents": "<p/>"
}
},
"DeviceEventType": {
"base": null,
"refs": {
"DeviceEvent$Type": "<p>The type of device event.</p>",
"ListDeviceEventsRequest$EventType": "<p>The event type to filter device events.</p>"
}
},
"DeviceEventValue": {
"base": null,
"refs": {
"DeviceEvent$Value": "<p>The value of the event.</p>"
}
},
"DeviceName": {
"base": null,
"refs": {
@ -276,7 +460,7 @@
"DeviceStatus": {
"base": null,
"refs": {
"Device$DeviceStatus": "<p>The status of a device. If the status is not READY, check the DeviceStatusInfo for details.</p>",
"Device$DeviceStatus": "<p>The status of a device. If the status is not READY, check the DeviceStatusInfo value for details.</p>",
"DeviceData$DeviceStatus": "<p>The status of a device.</p>"
}
},
@ -312,6 +496,16 @@
"DeviceData$DeviceType": "<p>The type of a device.</p>"
}
},
"DisassociateContactFromAddressBookRequest": {
"base": null,
"refs": {
}
},
"DisassociateContactFromAddressBookResponse": {
"base": null,
"refs": {
}
},
"DisassociateDeviceFromRoomRequest": {
"base": null,
"refs": {
@ -341,6 +535,15 @@
"UpdateProfileRequest$DistanceUnit": "<p>The updated distance unit for the room profile.</p>"
}
},
"E164PhoneNumber": {
"base": null,
"refs": {
"Contact$PhoneNumber": "<p>The phone number of the contact.</p>",
"ContactData$PhoneNumber": "<p>The phone number of the contact.</p>",
"CreateContactRequest$PhoneNumber": "<p>The phone number of the contact in E.164 format.</p>",
"UpdateContactRequest$PhoneNumber": "<p>The updated phone number of the contact.</p>"
}
},
"Email": {
"base": null,
"refs": {
@ -400,7 +603,9 @@
"FilterList": {
"base": null,
"refs": {
"SearchDevicesRequest$Filters": "<p>The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, and UnassociatedOnly.</p>",
"SearchAddressBooksRequest$Filters": "<p>The filters to use to list a specified set of address books. The supported filter key is AddressBookName.</p>",
"SearchContactsRequest$Filters": "<p>The filters to use to list a specified set of address books. The supported filter keys are DisplayName, FirstName, LastName, and AddressBookArns.</p>",
"SearchDevicesRequest$Filters": "<p>The filters to use to list a specified set of devices. Supported filter keys are DeviceName, DeviceStatus, DeviceStatusDetailCode, RoomName, DeviceType, DeviceSerialNumber, UnassociatedOnly, and ConnectionStatus (ONLINE and OFFLINE).</p>",
"SearchProfilesRequest$Filters": "<p>The filters to use to list a specified set of room profiles. Supported filter keys are ProfileName and Address. Required. </p>",
"SearchRoomsRequest$Filters": "<p>The filters to use to list a specified set of rooms. The supported filter keys are RoomName and ProfileName.</p>",
"SearchSkillGroupsRequest$Filters": "<p>The filters to use to list a specified set of skill groups. The supported filter key is SkillGroupName. </p>",
@ -419,6 +624,26 @@
"Filter$Values": "<p>The values of a filter.</p>"
}
},
"GetAddressBookRequest": {
"base": null,
"refs": {
}
},
"GetAddressBookResponse": {
"base": null,
"refs": {
}
},
"GetContactRequest": {
"base": null,
"refs": {
}
},
"GetContactResponse": {
"base": null,
"refs": {
}
},
"GetDeviceRequest": {
"base": null,
"refs": {
@ -479,6 +704,16 @@
"refs": {
}
},
"ListDeviceEventsRequest": {
"base": null,
"refs": {
}
},
"ListDeviceEventsResponse": {
"base": null,
"refs": {
}
},
"ListSkillsRequest": {
"base": null,
"refs": {
@ -509,7 +744,10 @@
"MaxResults": {
"base": null,
"refs": {
"ListDeviceEventsRequest$MaxResults": "<p>The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. Required. </p>",
"ListTagsRequest$MaxResults": "<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p>",
"SearchAddressBooksRequest$MaxResults": "<p>The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.</p>",
"SearchContactsRequest$MaxResults": "<p>The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.</p>",
"SearchDevicesRequest$MaxResults": "<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p>",
"SearchProfilesRequest$MaxResults": "<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p>",
"SearchRoomsRequest$MaxResults": "<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved. </p>",
@ -533,10 +771,16 @@
"NextToken": {
"base": null,
"refs": {
"ListDeviceEventsRequest$NextToken": "<p>An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.</p>",
"ListDeviceEventsResponse$NextToken": "<p/>",
"ListSkillsRequest$NextToken": "<p>An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by <code>MaxResults</code>. Required.</p>",
"ListSkillsResponse$NextToken": "<p>The token returned to indicate that there is more data available.</p>",
"ListTagsRequest$NextToken": "<p>An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by <code>MaxResults</code>. </p>",
"ListTagsResponse$NextToken": "<p>The token returned to indicate that there is more data available.</p>",
"SearchAddressBooksRequest$NextToken": "<p>An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.</p>",
"SearchAddressBooksResponse$NextToken": "<p>The token returned to indicate that there is more data available.</p>",
"SearchContactsRequest$NextToken": "<p>An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response only includes results beyond the token, up to the value specified by MaxResults.</p>",
"SearchContactsResponse$NextToken": "<p>The token returned to indicate that there is more data available.</p>",
"SearchDevicesRequest$NextToken": "<p>An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by <code>MaxResults</code>.</p>",
"SearchDevicesResponse$NextToken": "<p>The token returned to indicate that there is more data available.</p>",
"SearchProfilesRequest$NextToken": "<p>An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by <code>MaxResults</code>.</p>",
@ -692,6 +936,26 @@
"ResolveRoomResponse$RoomSkillParameters": "<p>Response to get the room profile request. Required.</p>"
}
},
"SearchAddressBooksRequest": {
"base": null,
"refs": {
}
},
"SearchAddressBooksResponse": {
"base": null,
"refs": {
}
},
"SearchContactsRequest": {
"base": null,
"refs": {
}
},
"SearchContactsResponse": {
"base": null,
"refs": {
}
},
"SearchDevicesRequest": {
"base": null,
"refs": {
@ -844,7 +1108,9 @@
"SortList": {
"base": null,
"refs": {
"SearchDevicesRequest$SortCriteria": "<p>The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, and DeviceSerialNumber.</p>",
"SearchAddressBooksRequest$SortCriteria": "<p>The sort order to use in listing the specified set of address books. The supported sort key is AddressBookName.</p>",
"SearchContactsRequest$SortCriteria": "<p>The sort order to use in listing the specified set of contacts. The supported sort keys are DisplayName, FirstName, and LastName.</p>",
"SearchDevicesRequest$SortCriteria": "<p>The sort order to use in listing the specified set of devices. Supported sort keys are DeviceName, DeviceStatus, RoomName, DeviceType, DeviceSerialNumber, and ConnectionStatus.</p>",
"SearchProfilesRequest$SortCriteria": "<p>The sort order to use in listing the specified set of room profiles. Supported sort keys are ProfileName and Address.</p>",
"SearchRoomsRequest$SortCriteria": "<p>The sort order to use in listing the specified set of rooms. The supported sort keys are RoomName and ProfileName.</p>",
"SearchSkillGroupsRequest$SortCriteria": "<p>The sort order to use in listing the specified set of skill groups. The supported sort key is SkillGroupName. </p>",
@ -920,6 +1186,12 @@
"UpdateProfileRequest$TemperatureUnit": "<p>The updated temperature unit for the room profile.</p>"
}
},
"Timestamp": {
"base": null,
"refs": {
"DeviceEvent$Timestamp": "<p>The time (in epoch) when the event occurred. </p>"
}
},
"Timezone": {
"base": null,
"refs": {
@ -932,6 +1204,8 @@
"TotalCount": {
"base": null,
"refs": {
"SearchAddressBooksResponse$TotalCount": "<p>The total number of address books returned.</p>",
"SearchContactsResponse$TotalCount": "<p>The total number of contacts returned.</p>",
"SearchDevicesResponse$TotalCount": "<p>The total number of devices returned.</p>",
"SearchProfilesResponse$TotalCount": "<p>The total number of room profiles returned.</p>",
"SearchRoomsResponse$TotalCount": "<p>The total number of rooms returned.</p>",
@ -949,6 +1223,26 @@
"refs": {
}
},
"UpdateAddressBookRequest": {
"base": null,
"refs": {
}
},
"UpdateAddressBookResponse": {
"base": null,
"refs": {
}
},
"UpdateContactRequest": {
"base": null,
"refs": {
}
},
"UpdateContactResponse": {
"base": null,
"refs": {
}
},
"UpdateDeviceRequest": {
"base": null,
"refs": {

15
vendor/github.com/aws/aws-sdk-go/models/apis/alexaforbusiness/2017-11-09/paginators-1.json generated vendored
View File

@ -1,5 +1,10 @@
{
"pagination": {
"ListDeviceEvents": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"ListSkills": {
"input_token": "NextToken",
"output_token": "NextToken",
@ -10,6 +15,16 @@
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"SearchAddressBooks": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"SearchContacts": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"SearchDevices": {
"input_token": "NextToken",
"output_token": "NextToken",

6
vendor/github.com/aws/aws-sdk-go/models/apis/apigateway/2015-07-09/api-2.json generated vendored
View File

@ -2264,7 +2264,8 @@
"binaryMediaTypes":{"shape":"ListOfString"},
"minimumCompressionSize":{"shape":"NullableInteger"},
"apiKeySource":{"shape":"ApiKeySourceType"},
"endpointConfiguration":{"shape":"EndpointConfiguration"}
"endpointConfiguration":{"shape":"EndpointConfiguration"},
"policy":{"shape":"String"}
}
},
"CreateStageRequest":{
@ -4568,7 +4569,8 @@
"binaryMediaTypes":{"shape":"ListOfString"},
"minimumCompressionSize":{"shape":"NullableInteger"},
"apiKeySource":{"shape":"ApiKeySourceType"},
"endpointConfiguration":{"shape":"EndpointConfiguration"}
"endpointConfiguration":{"shape":"EndpointConfiguration"},
"policy":{"shape":"String"}
}
},
"RestApis":{

452
vendor/github.com/aws/aws-sdk-go/models/apis/apigateway/2015-07-09/docs-2.json generated vendored
View File

@ -79,7 +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>",
"GetTags": "<p>Gets the <a>Tags</a> 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>",
@ -96,10 +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>",
"TagResource": "<p>Adds or updates a tag on a given 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>",
"UntagResource": "<p>Removes a tag 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>",
@ -149,8 +149,8 @@
"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>"
"CreateRestApiRequest$apiKeySource": "<p>The source of the API key for metering 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 metering 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": {
@ -177,9 +177,9 @@
}
},
"AuthorizerType": {
"base": "<p>[Required] The authorizer type. Valid values are <code>TOKEN</code> for a Lambda function using a single authorization token submitted in a custom header, <code>REQUEST</code> for a Lambda function using incoming request parameters, and <code>COGNITO_USER_POOLS</code> for using an Amazon Cognito user pool.</p>",
"base": "<p>The authorizer type. Valid values are <code>TOKEN</code> for a Lambda function using a single authorization token submitted in a custom header, <code>REQUEST</code> for a Lambda function using incoming request parameters, and <code>COGNITO_USER_POOLS</code> for using an Amazon Cognito user pool.</p>",
"refs": {
"Authorizer$type": "<p>[Required] The authorizer type. Valid values are <code>TOKEN</code> for a Lambda function using a single authorization token submitted in a custom header, <code>REQUEST</code> for a Lambda function using incoming request parameters, and <code>COGNITO_USER_POOLS</code> for using an Amazon Cognito user pool.</p>",
"Authorizer$type": "<p>The authorizer type. Valid values are <code>TOKEN</code> for a Lambda function using a single authorization token submitted in a custom header, <code>REQUEST</code> for a Lambda function using incoming request parameters, and <code>COGNITO_USER_POOLS</code> for using an Amazon Cognito user pool.</p>",
"CreateAuthorizerRequest$type": "<p>[Required] The authorizer type. Valid values are <code>TOKEN</code> for a Lambda function using a single authorization token submitted in a custom header, <code>REQUEST</code> for a Lambda function using incoming request parameters, and <code>COGNITO_USER_POOLS</code> for using an Amazon Cognito user pool.</p>"
}
},
@ -210,8 +210,8 @@
"ExportResponse$body": "<p>The binary blob response to <a>GetExport</a>, which contains the export.</p>",
"ImportApiKeysRequest$body": "<p>The payload of the POST request to import API keys. For the payload format, see <a href=\"http://docs.aws.amazon.com/apigateway/latest/developerguide/api-key-file-format.html\">API Key File Format</a>.</p>",
"ImportDocumentationPartsRequest$body": "<p>[Required] Raw byte array representing the to-be-imported documentation parts. To import from a Swagger file, this is a JSON object.</p>",
"ImportRestApiRequest$body": "<p>The POST request body containing external API definitions. Currently, only Swagger definition JSON files are supported. The maximum size of the API definition file is 2MB.</p>",
"PutRestApiRequest$body": "<p>The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported. The maximum size of the API definition file is 2MB.</p>",
"ImportRestApiRequest$body": "<p>[Required] The POST request body containing external API definitions. Currently, only Swagger definition JSON files are supported. The maximum size of the API definition file is 2MB.</p>",
"PutRestApiRequest$body": "<p>[Required] The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported. The maximum size of the API definition file is 2MB.</p>",
"SdkResponse$body": "<p>The binary blob response to <a>GetSdk</a>, which contains the generated SDK.</p>"
}
},
@ -522,7 +522,7 @@
"DocumentationPartType": {
"base": null,
"refs": {
"DocumentationPartLocation$type": "<p>The type of API entity to which the documentation content applies. It is a valid and required field for API entity types of <code>API</code>, <code>AUTHORIZER</code>, <code>MODEL</code>, <code>RESOURCE</code>, <code>METHOD</code>, <code>PATH_PARAMETER</code>, <code>QUERY_PARAMETER</code>, <code>REQUEST_HEADER</code>, <code>REQUEST_BODY</code>, <code>RESPONSE</code>, <code>RESPONSE_HEADER</code>, and <code>RESPONSE_BODY</code>. Content inheritance does not apply to any entity of the <code>API</code>, <code>AUTHORIZER</code>, <code>METHOD</code>, <code>MODEL</code>, <code>REQUEST_BODY</code>, or <code>RESOURCE</code> type.</p>",
"DocumentationPartLocation$type": "<p>[Required] The type of API entity to which the documentation content applies. Valid values are <code>API</code>, <code>AUTHORIZER</code>, <code>MODEL</code>, <code>RESOURCE</code>, <code>METHOD</code>, <code>PATH_PARAMETER</code>, <code>QUERY_PARAMETER</code>, <code>REQUEST_HEADER</code>, <code>REQUEST_BODY</code>, <code>RESPONSE</code>, <code>RESPONSE_HEADER</code>, and <code>RESPONSE_BODY</code>. Content inheritance does not apply to any entity of the <code>API</code>, <code>AUTHORIZER</code>, <code>METHOD</code>, <code>MODEL</code>, <code>REQUEST_BODY</code>, or <code>RESOURCE</code> type.</p>",
"GetDocumentationPartsRequest$type": "<p>The type of API entities of the to-be-retrieved documentation parts. </p>"
}
},
@ -601,11 +601,11 @@
"GatewayResponseType": {
"base": null,
"refs": {
"DeleteGatewayResponseRequest$responseType": "<p><p>The response type of the associated <a>GatewayResponse</a>. Valid values are <ul><li>ACCESS_DENIED</li><li>API_CONFIGURATION_ERROR</li><li>AUTHORIZER_FAILURE</li><li> AUTHORIZER_CONFIGURATION_ERROR</li><li>BAD_REQUEST_PARAMETERS</li><li>BAD_REQUEST_BODY</li><li>DEFAULT_4XX</li><li>DEFAULT_5XX</li><li>EXPIRED_TOKEN</li><li>INVALID_SIGNATURE</li><li>INTEGRATION_FAILURE</li><li>INTEGRATION_TIMEOUT</li><li>INVALID_API_KEY</li><li>MISSING_AUTHENTICATION_TOKEN</li><li> QUOTA_EXCEEDED</li><li>REQUEST_TOO_LARGE</li><li>RESOURCE_NOT_FOUND</li><li>THROTTLED</li><li>UNAUTHORIZED</li><li>UNSUPPORTED_MEDIA_TYPES</li></ul> </p></p>",
"GatewayResponse$responseType": "<p>The response type of the associated <a>GatewayResponse</a>. Valid values are <ul><li>ACCESS_DENIED</li><li>API_CONFIGURATION_ERROR</li><li>AUTHORIZER_FAILURE</li><li> AUTHORIZER_CONFIGURATION_ERROR</li><li>BAD_REQUEST_PARAMETERS</li><li>BAD_REQUEST_BODY</li><li>DEFAULT_4XX</li><li>DEFAULT_5XX</li><li>EXPIRED_TOKEN</li><li>INVALID_SIGNATURE</li><li>INTEGRATION_FAILURE</li><li>INTEGRATION_TIMEOUT</li><li>INVALID_API_KEY</li><li>MISSING_AUTHENTICATION_TOKEN</li><li> QUOTA_EXCEEDED</li><li>REQUEST_TOO_LARGE</li><li>RESOURCE_NOT_FOUND</li><li>THROTTLED</li><li>UNAUTHORIZED</li><li>UNSUPPORTED_MEDIA_TYPES</li></ul> </p>",
"GetGatewayResponseRequest$responseType": "<p><p>The response type of the associated <a>GatewayResponse</a>. Valid values are <ul><li>ACCESS_DENIED</li><li>API_CONFIGURATION_ERROR</li><li>AUTHORIZER_FAILURE</li><li> AUTHORIZER_CONFIGURATION_ERROR</li><li>BAD_REQUEST_PARAMETERS</li><li>BAD_REQUEST_BODY</li><li>DEFAULT_4XX</li><li>DEFAULT_5XX</li><li>EXPIRED_TOKEN</li><li>INVALID_SIGNATURE</li><li>INTEGRATION_FAILURE</li><li>INTEGRATION_TIMEOUT</li><li>INVALID_API_KEY</li><li>MISSING_AUTHENTICATION_TOKEN</li><li> QUOTA_EXCEEDED</li><li>REQUEST_TOO_LARGE</li><li>RESOURCE_NOT_FOUND</li><li>THROTTLED</li><li>UNAUTHORIZED</li><li>UNSUPPORTED_MEDIA_TYPES</li></ul> </p></p>",
"PutGatewayResponseRequest$responseType": "<p><p>The response type of the associated <a>GatewayResponse</a>. Valid values are <ul><li>ACCESS_DENIED</li><li>API_CONFIGURATION_ERROR</li><li>AUTHORIZER_FAILURE</li><li> AUTHORIZER_CONFIGURATION_ERROR</li><li>BAD_REQUEST_PARAMETERS</li><li>BAD_REQUEST_BODY</li><li>DEFAULT_4XX</li><li>DEFAULT_5XX</li><li>EXPIRED_TOKEN</li><li>INVALID_SIGNATURE</li><li>INTEGRATION_FAILURE</li><li>INTEGRATION_TIMEOUT</li><li>INVALID_API_KEY</li><li>MISSING_AUTHENTICATION_TOKEN</li><li> QUOTA_EXCEEDED</li><li>REQUEST_TOO_LARGE</li><li>RESOURCE_NOT_FOUND</li><li>THROTTLED</li><li>UNAUTHORIZED</li><li>UNSUPPORTED_MEDIA_TYPES</li></ul> </p></p>",
"UpdateGatewayResponseRequest$responseType": "<p><p>The response type of the associated <a>GatewayResponse</a>. Valid values are <ul><li>ACCESS_DENIED</li><li>API_CONFIGURATION_ERROR</li><li>AUTHORIZER_FAILURE</li><li> AUTHORIZER_CONFIGURATION_ERROR</li><li>BAD_REQUEST_PARAMETERS</li><li>BAD_REQUEST_BODY</li><li>DEFAULT_4XX</li><li>DEFAULT_5XX</li><li>EXPIRED_TOKEN</li><li>INVALID_SIGNATURE</li><li>INTEGRATION_FAILURE</li><li>INTEGRATION_TIMEOUT</li><li>INVALID_API_KEY</li><li>MISSING_AUTHENTICATION_TOKEN</li><li> QUOTA_EXCEEDED</li><li>REQUEST_TOO_LARGE</li><li>RESOURCE_NOT_FOUND</li><li>THROTTLED</li><li>UNAUTHORIZED</li><li>UNSUPPORTED_MEDIA_TYPES</li></ul> </p></p>"
"DeleteGatewayResponseRequest$responseType": "<p>[Required] <p>The response type of the associated <a>GatewayResponse</a>. Valid values are <ul><li>ACCESS_DENIED</li><li>API_CONFIGURATION_ERROR</li><li>AUTHORIZER_FAILURE</li><li> AUTHORIZER_CONFIGURATION_ERROR</li><li>BAD_REQUEST_PARAMETERS</li><li>BAD_REQUEST_BODY</li><li>DEFAULT_4XX</li><li>DEFAULT_5XX</li><li>EXPIRED_TOKEN</li><li>INVALID_SIGNATURE</li><li>INTEGRATION_FAILURE</li><li>INTEGRATION_TIMEOUT</li><li>INVALID_API_KEY</li><li>MISSING_AUTHENTICATION_TOKEN</li><li> QUOTA_EXCEEDED</li><li>REQUEST_TOO_LARGE</li><li>RESOURCE_NOT_FOUND</li><li>THROTTLED</li><li>UNAUTHORIZED</li><li>UNSUPPORTED_MEDIA_TYPE</li></ul> </p></p>",
"GatewayResponse$responseType": "<p>The response type of the associated <a>GatewayResponse</a>. Valid values are <ul><li>ACCESS_DENIED</li><li>API_CONFIGURATION_ERROR</li><li>AUTHORIZER_FAILURE</li><li> AUTHORIZER_CONFIGURATION_ERROR</li><li>BAD_REQUEST_PARAMETERS</li><li>BAD_REQUEST_BODY</li><li>DEFAULT_4XX</li><li>DEFAULT_5XX</li><li>EXPIRED_TOKEN</li><li>INVALID_SIGNATURE</li><li>INTEGRATION_FAILURE</li><li>INTEGRATION_TIMEOUT</li><li>INVALID_API_KEY</li><li>MISSING_AUTHENTICATION_TOKEN</li><li> QUOTA_EXCEEDED</li><li>REQUEST_TOO_LARGE</li><li>RESOURCE_NOT_FOUND</li><li>THROTTLED</li><li>UNAUTHORIZED</li><li>UNSUPPORTED_MEDIA_TYPE</li></ul> </p>",
"GetGatewayResponseRequest$responseType": "<p>[Required] <p>The response type of the associated <a>GatewayResponse</a>. Valid values are <ul><li>ACCESS_DENIED</li><li>API_CONFIGURATION_ERROR</li><li>AUTHORIZER_FAILURE</li><li> AUTHORIZER_CONFIGURATION_ERROR</li><li>BAD_REQUEST_PARAMETERS</li><li>BAD_REQUEST_BODY</li><li>DEFAULT_4XX</li><li>DEFAULT_5XX</li><li>EXPIRED_TOKEN</li><li>INVALID_SIGNATURE</li><li>INTEGRATION_FAILURE</li><li>INTEGRATION_TIMEOUT</li><li>INVALID_API_KEY</li><li>MISSING_AUTHENTICATION_TOKEN</li><li> QUOTA_EXCEEDED</li><li>REQUEST_TOO_LARGE</li><li>RESOURCE_NOT_FOUND</li><li>THROTTLED</li><li>UNAUTHORIZED</li><li>UNSUPPORTED_MEDIA_TYPE</li></ul> </p></p>",
"PutGatewayResponseRequest$responseType": "<p>[Required] <p>The response type of the associated <a>GatewayResponse</a>. Valid values are <ul><li>ACCESS_DENIED</li><li>API_CONFIGURATION_ERROR</li><li>AUTHORIZER_FAILURE</li><li> AUTHORIZER_CONFIGURATION_ERROR</li><li>BAD_REQUEST_PARAMETERS</li><li>BAD_REQUEST_BODY</li><li>DEFAULT_4XX</li><li>DEFAULT_5XX</li><li>EXPIRED_TOKEN</li><li>INVALID_SIGNATURE</li><li>INTEGRATION_FAILURE</li><li>INTEGRATION_TIMEOUT</li><li>INVALID_API_KEY</li><li>MISSING_AUTHENTICATION_TOKEN</li><li> QUOTA_EXCEEDED</li><li>REQUEST_TOO_LARGE</li><li>RESOURCE_NOT_FOUND</li><li>THROTTLED</li><li>UNAUTHORIZED</li><li>UNSUPPORTED_MEDIA_TYPE</li></ul> </p></p>",
"UpdateGatewayResponseRequest$responseType": "<p>[Required] <p>The response type of the associated <a>GatewayResponse</a>. Valid values are <ul><li>ACCESS_DENIED</li><li>API_CONFIGURATION_ERROR</li><li>AUTHORIZER_FAILURE</li><li> AUTHORIZER_CONFIGURATION_ERROR</li><li>BAD_REQUEST_PARAMETERS</li><li>BAD_REQUEST_BODY</li><li>DEFAULT_4XX</li><li>DEFAULT_5XX</li><li>EXPIRED_TOKEN</li><li>INVALID_SIGNATURE</li><li>INTEGRATION_FAILURE</li><li>INTEGRATION_TIMEOUT</li><li>INVALID_API_KEY</li><li>MISSING_AUTHENTICATION_TOKEN</li><li> QUOTA_EXCEEDED</li><li>REQUEST_TOO_LARGE</li><li>RESOURCE_NOT_FOUND</li><li>THROTTLED</li><li>UNAUTHORIZED</li><li>UNSUPPORTED_MEDIA_TYPE</li></ul> </p></p>"
}
},
"GatewayResponses": {
@ -809,7 +809,7 @@
}
},
"GetTagsRequest": {
"base": "<p>Gets the Tags collection for a given resource.</p>",
"base": "<p>Gets the <a>Tags</a> collection for a given resource.</p>",
"refs": {
}
},
@ -892,7 +892,7 @@
"base": "<p>The integration type. The valid value is <code>HTTP</code> for integrating an API method with an HTTP backend; <code>AWS</code> with any AWS service endpoints; <code>MOCK</code> for testing without actually invoking the backend; <code>HTTP_PROXY</code> for integrating with the HTTP proxy integration; <code>AWS_PROXY</code> for integrating with the Lambda proxy integration. </p>",
"refs": {
"Integration$type": "<p>Specifies an API method integration type. The valid value is one of the following:</p> <ul> <li><code>AWS</code>: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.</li> <li><code>AWS_PROXY</code>: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.</li> <li><code>HTTP</code>: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.</li> <li><code>HTTP_PROXY</code>: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.</li> <li><code>MOCK</code>: for integrating the API method request with API Gateway as a \"loop-back\" endpoint without invoking any backend.</li> </ul> <p>For the HTTP and HTTP proxy integrations, each integration can specify a protocol (<code>http/https</code>), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a <code>connectionType</code> of <code>VPC_LINK</code> is referred to as a private integration and uses a <a>VpcLink</a> to connect API Gateway to a network load balancer of a VPC.</p>",
"PutIntegrationRequest$type": "<p>Specifies a put integration input's type.</p>"
"PutIntegrationRequest$type": "<p>[Required] Specifies a put integration input's type.</p>"
}
},
"LimitExceededException": {
@ -1072,12 +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>",
"Method$authorizationScopes": "<p>A list of authorization scopes configured on the method. The scopes are used with a <code>COGNITO_USER_POOLS</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>",
"PutMethodRequest$authorizationScopes": "<p>A list of authorization scopes configured on the method. The scopes are used with a <code>COGNITO_USER_POOLS</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>",
"UntagResourceRequest$tagKeys": "<p>[Required] 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>"
}
},
@ -1184,7 +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>",
"CreateStageRequest$tags": "<p>The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The 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>",
@ -1207,9 +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>",
"Stage$tags": "<p>The collection of tags. Each tag element is associated with a given resource.</p>",
"TagResourceRequest$tags": "<p>[Required] The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with <code>aws:</code>. The tag value can be up to 256 characters.</p>",
"Tags$tags": "<p>The collection of tags. Each tag element is 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>",
@ -1271,28 +1271,28 @@
"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>",
"GetClientCertificatesRequest$limit": "<p>The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.</p>",
"GetDeploymentsRequest$limit": "<p>The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.</p>",
"GetDocumentationPartsRequest$limit": "<p>The maximum number of returned results per page.</p>",
"GetDocumentationVersionsRequest$limit": "<p>The maximum number of returned results per page.</p>",
"GetDomainNamesRequest$limit": "<p>The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.</p>",
"GetGatewayResponsesRequest$limit": "<p>The maximum number of returned results per page. The <a>GatewayResponses</a> collection does not support pagination and the limit does not apply here.</p>",
"GetModelsRequest$limit": "<p>The maximum number of returned results per page. The value is 25 by default and could be between 1 - 500.</p>",
"GetRequestValidatorsRequest$limit": "<p>The maximum number of returned results per page.</p>",
"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>",
"CreateRestApiRequest$minimumCompressionSize": "<p>A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is 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. The default value is 25 and the maximum value is 500.</p>",
"GetAuthorizersRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
"GetBasePathMappingsRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
"GetClientCertificatesRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
"GetDeploymentsRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
"GetDocumentationPartsRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
"GetDocumentationVersionsRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
"GetDomainNamesRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
"GetGatewayResponsesRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The <a>GatewayResponses</a> collection does not support pagination and the limit does not apply here.</p>",
"GetModelsRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
"GetRequestValidatorsRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
"GetResourcesRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
"GetRestApisRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
"GetSdkTypesRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
"GetTagsRequest$limit": "<p>(Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
"GetUsagePlanKeysRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
"GetUsagePlansRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
"GetUsageRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</p>",
"GetVpcLinksRequest$limit": "<p>The maximum number of returned results per page. The default value is 25 and the maximum value is 500.</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>"
"RestApi$minimumCompressionSize": "<p>A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is 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": {
@ -1449,18 +1449,18 @@
"StatusCode": {
"base": "<p>The status code.</p>",
"refs": {
"DeleteIntegrationResponseRequest$statusCode": "<p>Specifies a delete integration response request's status code.</p>",
"DeleteMethodResponseRequest$statusCode": "<p>The status code identifier for the <a>MethodResponse</a> resource.</p>",
"DeleteIntegrationResponseRequest$statusCode": "<p>[Required] Specifies a delete integration response request's status code.</p>",
"DeleteMethodResponseRequest$statusCode": "<p>[Required] The status code identifier for the <a>MethodResponse</a> resource.</p>",
"GatewayResponse$statusCode": "<p>The HTTP status code for this <a>GatewayResponse</a>.</p>",
"GetIntegrationResponseRequest$statusCode": "<p>Specifies a get integration response request's status code.</p>",
"GetMethodResponseRequest$statusCode": "<p>The status code for the <a>MethodResponse</a> resource.</p>",
"GetIntegrationResponseRequest$statusCode": "<p>[Required] Specifies a get integration response request's status code.</p>",
"GetMethodResponseRequest$statusCode": "<p>[Required] The status code for the <a>MethodResponse</a> resource.</p>",
"IntegrationResponse$statusCode": "<p>Specifies the status code that is used to map the integration response to an existing <a>MethodResponse</a>.</p>",
"MethodResponse$statusCode": "<p>The method response's status code.</p>",
"PutGatewayResponseRequest$statusCode": "The HTTP status code of the <a>GatewayResponse</a>.",
"PutIntegrationResponseRequest$statusCode": "<p>Specifies the status code that is used to map the integration response to an existing <a>MethodResponse</a>.</p>",
"PutMethodResponseRequest$statusCode": "<p>The method response's status code.</p>",
"UpdateIntegrationResponseRequest$statusCode": "<p>Specifies an update integration response request's status code.</p>",
"UpdateMethodResponseRequest$statusCode": "<p>The status code for the <a>MethodResponse</a> resource.</p>"
"PutIntegrationResponseRequest$statusCode": "<p>[Required] Specifies the status code that is used to map the integration response to an existing <a>MethodResponse</a>.</p>",
"PutMethodResponseRequest$statusCode": "<p>[Required] The method response's status code.</p>",
"UpdateIntegrationResponseRequest$statusCode": "<p>[Required] Specifies an update integration response request's status code.</p>",
"UpdateMethodResponseRequest$statusCode": "<p>[Required] The status code for the <a>MethodResponse</a> resource.</p>"
}
},
"String": {
@ -1483,8 +1483,8 @@
"Authorizer$authType": "<p>Optional customer-defined field, used in Swagger imports and exports without functional impact.</p>",
"Authorizer$authorizerUri": "<p>Specifies the authorizer's Uniform Resource Identifier (URI). For <code>TOKEN</code> or <code>REQUEST</code> authorizers, this must be a well-formed Lambda function URI, for example, <code>arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations</code>. In general, the URI has this form <code>arn:aws:apigateway:{region}:lambda:path/{service_api}</code>, where <code>{region}</code> is the same as the region hosting the Lambda function, <code>path</code> indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial <code>/</code>. For Lambda functions, this is usually of the form <code>/2015-03-31/functions/[FunctionARN]/invocations</code>.</p>",
"Authorizer$authorizerCredentials": "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.</p>",
"Authorizer$identitySource": "<p>The identity source for which authorization is requested. <ul><li>For a <code>TOKEN</code> authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is <code>Auth</code>, the header mapping expression is <code>method.request.header.Auth</code>.</li><li>For the <code>REQUEST</code> authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an <code>Auth</code> header, a <code>Name</code> query string parameter are defined as identity sources, this value is <code>method.request.header.Auth, method.request.querystring.Name</code>. These parameters will be used to derive the authorization caching key and to perform runtime validation of the <code>REQUEST</code> authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.</li><li>For a <code>COGNITO_USER_POOLS</code> authorizer, this property is not used.</li></ul></p>",
"Authorizer$identityValidationExpression": "<p>A validation expression for the incoming identity token. For <code>TOKEN</code> authorizers, this value is a regular expression. API Gateway will match the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the <code>REQUEST</code> authorizer.</p>",
"Authorizer$identitySource": "<p>The identity source for which authorization is requested. <ul><li>For a <code>TOKEN</code> or <code>COGNITO_USER_POOLS</code> authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is <code>Auth</code>, the header mapping expression is <code>method.request.header.Auth</code>.</li><li>For the <code>REQUEST</code> authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an <code>Auth</code> header, a <code>Name</code> query string parameter are defined as identity sources, this value is <code>method.request.header.Auth, method.request.querystring.Name</code>. These parameters will be used to derive the authorization caching key and to perform runtime validation of the <code>REQUEST</code> authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.</li></ul></p>",
"Authorizer$identityValidationExpression": "<p>A validation expression for the incoming identity token. For <code>TOKEN</code> authorizers, this value is a regular expression. API Gateway will match the <code>aud</code> field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the <code>REQUEST</code> authorizer.</p>",
"Authorizers$position": null,
"BadRequestException$message": null,
"BasePathMapping$basePath": "<p>The base path name that callers of the API must provide as part of the URL after the domain name.</p>",
@ -1501,18 +1501,18 @@
"CreateApiKeyRequest$description": "<p>The description of the <a>ApiKey</a>.</p>",
"CreateApiKeyRequest$value": "<p>Specifies a value of the API key.</p>",
"CreateApiKeyRequest$customerId": "<p>An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.</p>",
"CreateAuthorizerRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"CreateAuthorizerRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"CreateAuthorizerRequest$name": "<p>[Required] The name of the authorizer.</p>",
"CreateAuthorizerRequest$authType": "<p>Optional customer-defined field, used in Swagger imports and exports without functional impact.</p>",
"CreateAuthorizerRequest$authorizerUri": "<p>Specifies the authorizer's Uniform Resource Identifier (URI). For <code>TOKEN</code> or <code>REQUEST</code> authorizers, this must be a well-formed Lambda function URI, for example, <code>arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations</code>. In general, the URI has this form <code>arn:aws:apigateway:{region}:lambda:path/{service_api}</code>, where <code>{region}</code> is the same as the region hosting the Lambda function, <code>path</code> indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial <code>/</code>. For Lambda functions, this is usually of the form <code>/2015-03-31/functions/[FunctionARN]/invocations</code>.</p>",
"CreateAuthorizerRequest$authorizerCredentials": "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.</p>",
"CreateAuthorizerRequest$identitySource": "<p>The identity source for which authorization is requested. <ul><li>For a <code>TOKEN</code> authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is <code>Auth</code>, the header mapping expression is <code>method.request.header.Auth</code>.</li><li>For the <code>REQUEST</code> authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an <code>Auth</code> header, a <code>Name</code> query string parameter are defined as identity sources, this value is <code>method.request.header.Auth, method.request.querystring.Name</code>. These parameters will be used to derive the authorization caching key and to perform runtime validation of the <code>REQUEST</code> authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.</li><li>For a <code>COGNITO_USER_POOLS</code> authorizer, this property is not used.</li></ul></p>",
"CreateAuthorizerRequest$identityValidationExpression": "<p>A validation expression for the incoming identity token. For <code>TOKEN</code> authorizers, this value is a regular expression. API Gateway will match the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the <code>REQUEST</code> authorizer.</p>",
"CreateBasePathMappingRequest$domainName": "<p>The domain name of the <a>BasePathMapping</a> resource to create.</p>",
"CreateAuthorizerRequest$identitySource": "<p>The identity source for which authorization is requested. <ul><li>For a <code>TOKEN</code> or <code>COGNITO_USER_POOLS</code> authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is <code>Auth</code>, the header mapping expression is <code>method.request.header.Auth</code>.</li><li>For the <code>REQUEST</code> authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an <code>Auth</code> header, a <code>Name</code> query string parameter are defined as identity sources, this value is <code>method.request.header.Auth, method.request.querystring.Name</code>. These parameters will be used to derive the authorization caching key and to perform runtime validation of the <code>REQUEST</code> authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.</li></ul></p>",
"CreateAuthorizerRequest$identityValidationExpression": "<p>A validation expression for the incoming identity token. For <code>TOKEN</code> authorizers, this value is a regular expression. API Gateway will match the <code>aud</code> field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the <code>REQUEST</code> authorizer.</p>",
"CreateBasePathMappingRequest$domainName": "<p>[Required] The domain name of the <a>BasePathMapping</a> resource to create.</p>",
"CreateBasePathMappingRequest$basePath": "<p>The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Leave this blank if you do not want callers to specify a base path name after the domain name.</p>",
"CreateBasePathMappingRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"CreateBasePathMappingRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"CreateBasePathMappingRequest$stage": "<p>The name of the API's stage that you want to use for this mapping. Leave this blank if you do not want callers to explicitly specify the stage name after any base path name.</p>",
"CreateDeploymentRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"CreateDeploymentRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"CreateDeploymentRequest$stageName": "<p>The name of the <a>Stage</a> resource for the <a>Deployment</a> resource to create.</p>",
"CreateDeploymentRequest$stageDescription": "<p>The description of the <a>Stage</a> resource for the <a>Deployment</a> resource to create.</p>",
"CreateDeploymentRequest$description": "<p>The description for the <a>Deployment</a> resource to create.</p>",
@ -1522,7 +1522,7 @@
"CreateDocumentationVersionRequest$documentationVersion": "<p>[Required] The version identifier of the new snapshot.</p>",
"CreateDocumentationVersionRequest$stageName": "<p>The stage name to be associated with the new documentation snapshot.</p>",
"CreateDocumentationVersionRequest$description": "<p>A description about the new documentation snapshot.</p>",
"CreateDomainNameRequest$domainName": "<p>(Required) The name of the <a>DomainName</a> resource.</p>",
"CreateDomainNameRequest$domainName": "<p>[Required] The name of the <a>DomainName</a> resource.</p>",
"CreateDomainNameRequest$certificateName": "<p>The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.</p>",
"CreateDomainNameRequest$certificateBody": "<p>[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.</p>",
"CreateDomainNameRequest$certificatePrivateKey": "<p>[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.</p>",
@ -1530,70 +1530,71 @@
"CreateDomainNameRequest$certificateArn": "<p>The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.</p>",
"CreateDomainNameRequest$regionalCertificateName": "<p>The user-friendly name of the certificate that will be used by regional endpoint for this domain name.</p>",
"CreateDomainNameRequest$regionalCertificateArn": "<p>The reference to an AWS-managed certificate that will be used by regional endpoint for this domain name. AWS Certificate Manager is the only supported source.</p>",
"CreateModelRequest$restApiId": "<p>The <a>RestApi</a> identifier under which the <a>Model</a> will be created.</p>",
"CreateModelRequest$name": "<p>The name of the model. Must be alphanumeric.</p>",
"CreateModelRequest$restApiId": "<p>[Required] The <a>RestApi</a> identifier under which the <a>Model</a> will be created.</p>",
"CreateModelRequest$name": "<p>[Required] The name of the model. Must be alphanumeric.</p>",
"CreateModelRequest$description": "<p>The description of the model.</p>",
"CreateModelRequest$schema": "<p>The schema for the model. For <code>application/json</code> models, this should be <a href=\"http://json-schema.org/documentation.html\" target=\"_blank\">JSON-schema draft v4</a> model.</p>",
"CreateModelRequest$contentType": "<p>The content-type for the model.</p>",
"CreateRequestValidatorRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"CreateModelRequest$schema": "<p>The schema for the model. For <code>application/json</code> models, this should be <a href=\"https://tools.ietf.org/html/draft-zyp-json-schema-04\" target=\"_blank\">JSON schema draft 4</a> model.</p>",
"CreateModelRequest$contentType": "<p>[Required] The content-type for the model.</p>",
"CreateRequestValidatorRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"CreateRequestValidatorRequest$name": "<p>The name of the to-be-created <a>RequestValidator</a>.</p>",
"CreateResourceRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"CreateResourceRequest$parentId": "<p>The parent resource's identifier.</p>",
"CreateResourceRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"CreateResourceRequest$parentId": "<p>[Required] The parent resource's identifier.</p>",
"CreateResourceRequest$pathPart": "<p>The last path segment for this resource.</p>",
"CreateRestApiRequest$name": "<p>The name of the <a>RestApi</a>.</p>",
"CreateRestApiRequest$name": "<p>[Required] The name of the <a>RestApi</a>.</p>",
"CreateRestApiRequest$description": "<p>The description of the <a>RestApi</a>.</p>",
"CreateRestApiRequest$version": "<p>A version identifier for the API.</p>",
"CreateRestApiRequest$cloneFrom": "<p>The ID of the <a>RestApi</a> that you want to clone from.</p>",
"CreateStageRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"CreateRestApiRequest$policy": "A stringified JSON policy document that applies to this RestApi regardless of the caller and <a>Method</a> configuration.",
"CreateStageRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"CreateStageRequest$stageName": "<p>[Required] The name for the <a>Stage</a> resource.</p>",
"CreateStageRequest$deploymentId": "<p>[Required] The identifier of the <a>Deployment</a> resource for the <a>Stage</a> resource.</p>",
"CreateStageRequest$description": "<p>The description of the <a>Stage</a> resource.</p>",
"CreateStageRequest$documentationVersion": "<p>The version of the associated API documentation.</p>",
"CreateUsagePlanKeyRequest$usagePlanId": "<p>The Id of the <a>UsagePlan</a> resource representing the usage plan containing the to-be-created <a>UsagePlanKey</a> resource representing a plan customer.</p>",
"CreateUsagePlanKeyRequest$keyId": "<p>The identifier of a <a>UsagePlanKey</a> resource for a plan customer.</p>",
"CreateUsagePlanKeyRequest$keyType": "<p>The type of a <a>UsagePlanKey</a> resource for a plan customer.</p>",
"CreateUsagePlanRequest$name": "<p>The name of the usage plan.</p>",
"CreateUsagePlanKeyRequest$usagePlanId": "<p>[Required] The Id of the <a>UsagePlan</a> resource representing the usage plan containing the to-be-created <a>UsagePlanKey</a> resource representing a plan customer.</p>",
"CreateUsagePlanKeyRequest$keyId": "<p>[Required] The identifier of a <a>UsagePlanKey</a> resource for a plan customer.</p>",
"CreateUsagePlanKeyRequest$keyType": "<p>[Required] The type of a <a>UsagePlanKey</a> resource for a plan customer.</p>",
"CreateUsagePlanRequest$name": "<p>[Required] The name of the usage plan.</p>",
"CreateUsagePlanRequest$description": "<p>The description of the usage plan.</p>",
"CreateVpcLinkRequest$name": "<p>[Required] The name used to label and identify the VPC link.</p>",
"CreateVpcLinkRequest$description": "<p>The description of the VPC link.</p>",
"DeleteApiKeyRequest$apiKey": "<p>The identifier of the <a>ApiKey</a> resource to be deleted.</p>",
"DeleteAuthorizerRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"DeleteAuthorizerRequest$authorizerId": "<p>The identifier of the <a>Authorizer</a> resource.</p>",
"DeleteBasePathMappingRequest$domainName": "<p>The domain name of the <a>BasePathMapping</a> resource to delete.</p>",
"DeleteBasePathMappingRequest$basePath": "<p>The base path name of the <a>BasePathMapping</a> resource to delete.</p>",
"DeleteClientCertificateRequest$clientCertificateId": "<p>The identifier of the <a>ClientCertificate</a> resource to be deleted.</p>",
"DeleteDeploymentRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"DeleteDeploymentRequest$deploymentId": "<p>The identifier of the <a>Deployment</a> resource to delete.</p>",
"DeleteApiKeyRequest$apiKey": "<p>[Required] The identifier of the <a>ApiKey</a> resource to be deleted.</p>",
"DeleteAuthorizerRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"DeleteAuthorizerRequest$authorizerId": "<p>[Required] The identifier of the <a>Authorizer</a> resource.</p>",
"DeleteBasePathMappingRequest$domainName": "<p>[Required] The domain name of the <a>BasePathMapping</a> resource to delete.</p>",
"DeleteBasePathMappingRequest$basePath": "<p>[Required] The base path name of the <a>BasePathMapping</a> resource to delete.</p>",
"DeleteClientCertificateRequest$clientCertificateId": "<p>[Required] The identifier of the <a>ClientCertificate</a> resource to be deleted.</p>",
"DeleteDeploymentRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"DeleteDeploymentRequest$deploymentId": "<p>[Required] The identifier of the <a>Deployment</a> resource to delete.</p>",
"DeleteDocumentationPartRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"DeleteDocumentationPartRequest$documentationPartId": "<p>[Required] The identifier of the to-be-deleted documentation part.</p>",
"DeleteDocumentationVersionRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"DeleteDocumentationVersionRequest$documentationVersion": "<p>[Required] The version identifier of a to-be-deleted documentation snapshot.</p>",
"DeleteDomainNameRequest$domainName": "<p>The name of the <a>DomainName</a> resource to be deleted.</p>",
"DeleteGatewayResponseRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"DeleteIntegrationRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"DeleteIntegrationRequest$resourceId": "<p>Specifies a delete integration request's resource identifier.</p>",
"DeleteIntegrationRequest$httpMethod": "<p>Specifies a delete integration request's HTTP method.</p>",
"DeleteIntegrationResponseRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"DeleteIntegrationResponseRequest$resourceId": "<p>Specifies a delete integration response request's resource identifier.</p>",
"DeleteIntegrationResponseRequest$httpMethod": "<p>Specifies a delete integration response request's HTTP method.</p>",
"DeleteMethodRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"DeleteMethodRequest$resourceId": "<p>The <a>Resource</a> identifier for the <a>Method</a> resource.</p>",
"DeleteMethodRequest$httpMethod": "<p>The HTTP verb of the <a>Method</a> resource.</p>",
"DeleteMethodResponseRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"DeleteMethodResponseRequest$resourceId": "<p>The <a>Resource</a> identifier for the <a>MethodResponse</a> resource.</p>",
"DeleteMethodResponseRequest$httpMethod": "<p>The HTTP verb of the <a>Method</a> resource.</p>",
"DeleteModelRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"DeleteModelRequest$modelName": "<p>The name of the model to delete.</p>",
"DeleteRequestValidatorRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"DeleteDomainNameRequest$domainName": "<p>[Required] The name of the <a>DomainName</a> resource to be deleted.</p>",
"DeleteGatewayResponseRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"DeleteIntegrationRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"DeleteIntegrationRequest$resourceId": "<p>[Required] Specifies a delete integration request's resource identifier.</p>",
"DeleteIntegrationRequest$httpMethod": "<p>[Required] Specifies a delete integration request's HTTP method.</p>",
"DeleteIntegrationResponseRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"DeleteIntegrationResponseRequest$resourceId": "<p>[Required] Specifies a delete integration response request's resource identifier.</p>",
"DeleteIntegrationResponseRequest$httpMethod": "<p>[Required] Specifies a delete integration response request's HTTP method.</p>",
"DeleteMethodRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"DeleteMethodRequest$resourceId": "<p>[Required] The <a>Resource</a> identifier for the <a>Method</a> resource.</p>",
"DeleteMethodRequest$httpMethod": "<p>[Required] The HTTP verb of the <a>Method</a> resource.</p>",
"DeleteMethodResponseRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"DeleteMethodResponseRequest$resourceId": "<p>[Required] The <a>Resource</a> identifier for the <a>MethodResponse</a> resource.</p>",
"DeleteMethodResponseRequest$httpMethod": "<p>[Required] The HTTP verb of the <a>Method</a> resource.</p>",
"DeleteModelRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"DeleteModelRequest$modelName": "<p>[Required] The name of the model to delete.</p>",
"DeleteRequestValidatorRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"DeleteRequestValidatorRequest$requestValidatorId": "<p>[Required] The identifier of the <a>RequestValidator</a> to be deleted.</p>",
"DeleteResourceRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"DeleteResourceRequest$resourceId": "<p>The identifier of the <a>Resource</a> resource.</p>",
"DeleteRestApiRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"DeleteStageRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"DeleteStageRequest$stageName": "<p>The name of the <a>Stage</a> resource to delete.</p>",
"DeleteUsagePlanKeyRequest$usagePlanId": "<p>The Id of the <a>UsagePlan</a> resource representing the usage plan containing the to-be-deleted <a>UsagePlanKey</a> resource representing a plan customer.</p>",
"DeleteUsagePlanKeyRequest$keyId": "<p>The Id of the <a>UsagePlanKey</a> resource to be deleted.</p>",
"DeleteUsagePlanRequest$usagePlanId": "<p>The Id of the to-be-deleted usage plan.</p>",
"DeleteResourceRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"DeleteResourceRequest$resourceId": "<p>[Required] The identifier of the <a>Resource</a> resource.</p>",
"DeleteRestApiRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"DeleteStageRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"DeleteStageRequest$stageName": "<p>[Required] The name of the <a>Stage</a> resource to delete.</p>",
"DeleteUsagePlanKeyRequest$usagePlanId": "<p>[Required] The Id of the <a>UsagePlan</a> resource representing the usage plan containing the to-be-deleted <a>UsagePlanKey</a> resource representing a plan customer.</p>",
"DeleteUsagePlanKeyRequest$keyId": "<p>[Required] The Id of the <a>UsagePlanKey</a> resource to be deleted.</p>",
"DeleteUsagePlanRequest$usagePlanId": "<p>[Required] The Id of the to-be-deleted usage plan.</p>",
"DeleteVpcLinkRequest$vpcLinkId": "<p>[Required] The identifier of the <a>VpcLink</a>. It is used in an <a>Integration</a> to reference this <a>VpcLink</a>.</p>",
"Deployment$id": "<p>The identifier for the deployment resource.</p>",
"Deployment$description": "<p>The description for the deployment resource.</p>",
@ -1607,7 +1608,7 @@
"DocumentationVersion$version": "<p>The version identifier of the API documentation snapshot.</p>",
"DocumentationVersion$description": "<p>The description of the API documentation snapshot.</p>",
"DocumentationVersions$position": null,
"DomainName$domainName": "<p>The name of the <a>DomainName</a> resource.</p>",
"DomainName$domainName": "<p>The custom domain name as an API host name, for example, <code>my-api.example.com</code>.</p>",
"DomainName$certificateName": "<p>The name of the certificate that will be used by edge-optimized endpoint for this domain name.</p>",
"DomainName$certificateArn": "<p>The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.</p>",
"DomainName$regionalDomainName": "<p>The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.</p>",
@ -1621,27 +1622,27 @@
"ExportResponse$contentDisposition": "<p>The content-disposition header value in the HTTP response.</p>",
"FlushStageAuthorizersCacheRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"FlushStageAuthorizersCacheRequest$stageName": "<p>The name of the stage to flush.</p>",
"FlushStageCacheRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"FlushStageCacheRequest$stageName": "<p>The name of the stage to flush its cache.</p>",
"FlushStageCacheRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"FlushStageCacheRequest$stageName": "<p>[Required] The name of the stage to flush its cache.</p>",
"GatewayResponses$position": null,
"GenerateClientCertificateRequest$description": "<p>The description of the <a>ClientCertificate</a>.</p>",
"GetApiKeyRequest$apiKey": "<p>The identifier of the <a>ApiKey</a> resource.</p>",
"GetApiKeyRequest$apiKey": "<p>[Required] The identifier of the <a>ApiKey</a> resource.</p>",
"GetApiKeysRequest$position": "<p>The current pagination position in the paged result set.</p>",
"GetApiKeysRequest$nameQuery": "<p>The name of queried API keys.</p>",
"GetApiKeysRequest$customerId": "<p>The identifier of a customer in AWS Marketplace or an external system, such as a developer portal.</p>",
"GetAuthorizerRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"GetAuthorizerRequest$authorizerId": "<p>The identifier of the <a>Authorizer</a> resource.</p>",
"GetAuthorizersRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"GetAuthorizerRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"GetAuthorizerRequest$authorizerId": "<p>[Required] The identifier of the <a>Authorizer</a> resource.</p>",
"GetAuthorizersRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"GetAuthorizersRequest$position": "<p>The current pagination position in the paged result set.</p>",
"GetBasePathMappingRequest$domainName": "<p>The domain name of the <a>BasePathMapping</a> resource to be described.</p>",
"GetBasePathMappingRequest$basePath": "<p>The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Leave this blank if you do not want callers to specify any base path name after the domain name.</p>",
"GetBasePathMappingsRequest$domainName": "<p>The domain name of a <a>BasePathMapping</a> resource.</p>",
"GetBasePathMappingRequest$domainName": "<p>[Required] The domain name of the <a>BasePathMapping</a> resource to be described.</p>",
"GetBasePathMappingRequest$basePath": "<p>[Required] The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Leave this blank if you do not want callers to specify any base path name after the domain name.</p>",
"GetBasePathMappingsRequest$domainName": "<p>[Required] The domain name of a <a>BasePathMapping</a> resource.</p>",
"GetBasePathMappingsRequest$position": "<p>The current pagination position in the paged result set.</p>",
"GetClientCertificateRequest$clientCertificateId": "<p>The identifier of the <a>ClientCertificate</a> resource to be described.</p>",
"GetClientCertificateRequest$clientCertificateId": "<p>[Required] The identifier of the <a>ClientCertificate</a> resource to be described.</p>",
"GetClientCertificatesRequest$position": "<p>The current pagination position in the paged result set.</p>",
"GetDeploymentRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"GetDeploymentRequest$deploymentId": "<p>The identifier of the <a>Deployment</a> resource to get information about.</p>",
"GetDeploymentsRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"GetDeploymentRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"GetDeploymentRequest$deploymentId": "<p>[Required] The identifier of the <a>Deployment</a> resource to get information about.</p>",
"GetDeploymentsRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"GetDeploymentsRequest$position": "<p>The current pagination position in the paged result set.</p>",
"GetDocumentationPartRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"GetDocumentationPartRequest$documentationPartId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
@ -1653,66 +1654,66 @@
"GetDocumentationVersionRequest$documentationVersion": "<p>[Required] The version identifier of the to-be-retrieved documentation snapshot.</p>",
"GetDocumentationVersionsRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"GetDocumentationVersionsRequest$position": "<p>The current pagination position in the paged result set.</p>",
"GetDomainNameRequest$domainName": "<p>The name of the <a>DomainName</a> resource.</p>",
"GetDomainNameRequest$domainName": "<p>[Required] The name of the <a>DomainName</a> resource.</p>",
"GetDomainNamesRequest$position": "<p>The current pagination position in the paged result set.</p>",
"GetExportRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"GetExportRequest$stageName": "<p>The name of the <a>Stage</a> that will be exported.</p>",
"GetExportRequest$exportType": "<p>The type of export. Currently only 'swagger' is supported.</p>",
"GetExportRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"GetExportRequest$stageName": "<p>[Required] The name of the <a>Stage</a> that will be exported.</p>",
"GetExportRequest$exportType": "<p>[Required] The type of export. Currently only 'swagger' is supported.</p>",
"GetExportRequest$accepts": "<p>The content-type of the export, for example <code>application/json</code>. Currently <code>application/json</code> and <code>application/yaml</code> are supported for <code>exportType</code> of <code>swagger</code>. This should be specified in the <code>Accept</code> header for direct API requests.</p>",
"GetGatewayResponseRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"GetGatewayResponsesRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"GetGatewayResponseRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"GetGatewayResponsesRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"GetGatewayResponsesRequest$position": "<p>The current pagination position in the paged result set. The <a>GatewayResponse</a> collection does not support pagination and the position does not apply here.</p>",
"GetIntegrationRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"GetIntegrationRequest$resourceId": "<p>Specifies a get integration request's resource identifier</p>",
"GetIntegrationRequest$httpMethod": "<p>Specifies a get integration request's HTTP method.</p>",
"GetIntegrationResponseRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"GetIntegrationResponseRequest$resourceId": "<p>Specifies a get integration response request's resource identifier.</p>",
"GetIntegrationResponseRequest$httpMethod": "<p>Specifies a get integration response request's HTTP method.</p>",
"GetMethodRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"GetMethodRequest$resourceId": "<p>The <a>Resource</a> identifier for the <a>Method</a> resource.</p>",
"GetMethodRequest$httpMethod": "<p>Specifies the method request's HTTP method type.</p>",
"GetMethodResponseRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"GetMethodResponseRequest$resourceId": "<p>The <a>Resource</a> identifier for the <a>MethodResponse</a> resource.</p>",
"GetMethodResponseRequest$httpMethod": "<p>The HTTP verb of the <a>Method</a> resource.</p>",
"GetModelRequest$restApiId": "<p>The <a>RestApi</a> identifier under which the <a>Model</a> exists.</p>",
"GetModelRequest$modelName": "<p>The name of the model as an identifier.</p>",
"GetModelTemplateRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"GetModelTemplateRequest$modelName": "<p>The name of the model for which to generate a template.</p>",
"GetModelsRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"GetIntegrationRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"GetIntegrationRequest$resourceId": "<p>[Required] Specifies a get integration request's resource identifier</p>",
"GetIntegrationRequest$httpMethod": "<p>[Required] Specifies a get integration request's HTTP method.</p>",
"GetIntegrationResponseRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"GetIntegrationResponseRequest$resourceId": "<p>[Required] Specifies a get integration response request's resource identifier.</p>",
"GetIntegrationResponseRequest$httpMethod": "<p>[Required] Specifies a get integration response request's HTTP method.</p>",
"GetMethodRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"GetMethodRequest$resourceId": "<p>[Required] The <a>Resource</a> identifier for the <a>Method</a> resource.</p>",
"GetMethodRequest$httpMethod": "<p>[Required] Specifies the method request's HTTP method type.</p>",
"GetMethodResponseRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"GetMethodResponseRequest$resourceId": "<p>[Required] The <a>Resource</a> identifier for the <a>MethodResponse</a> resource.</p>",
"GetMethodResponseRequest$httpMethod": "<p>[Required] The HTTP verb of the <a>Method</a> resource.</p>",
"GetModelRequest$restApiId": "<p>[Required] The <a>RestApi</a> identifier under which the <a>Model</a> exists.</p>",
"GetModelRequest$modelName": "<p>[Required] The name of the model as an identifier.</p>",
"GetModelTemplateRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"GetModelTemplateRequest$modelName": "<p>[Required] The name of the model for which to generate a template.</p>",
"GetModelsRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"GetModelsRequest$position": "<p>The current pagination position in the paged result set.</p>",
"GetRequestValidatorRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"GetRequestValidatorRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"GetRequestValidatorRequest$requestValidatorId": "<p>[Required] The identifier of the <a>RequestValidator</a> to be retrieved.</p>",
"GetRequestValidatorsRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"GetRequestValidatorsRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"GetRequestValidatorsRequest$position": "<p>The current pagination position in the paged result set.</p>",
"GetResourceRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"GetResourceRequest$resourceId": "<p>The identifier for the <a>Resource</a> resource.</p>",
"GetResourcesRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"GetResourceRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"GetResourceRequest$resourceId": "<p>[Required] The identifier for the <a>Resource</a> resource.</p>",
"GetResourcesRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"GetResourcesRequest$position": "<p>The current pagination position in the paged result set.</p>",
"GetRestApiRequest$restApiId": "<p>The identifier of the <a>RestApi</a> resource.</p>",
"GetRestApiRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"GetRestApisRequest$position": "<p>The current pagination position in the paged result set.</p>",
"GetSdkRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"GetSdkRequest$stageName": "<p>The name of the <a>Stage</a> that the SDK will use.</p>",
"GetSdkRequest$sdkType": "<p>The language for the generated SDK. Currently <code>java</code>, <code>javascript</code>, <code>android</code>, <code>objectivec</code> (for iOS), <code>swift</code> (for iOS), and <code>ruby</code> are supported.</p>",
"GetSdkTypeRequest$id": "<p>The identifier of the queried <a>SdkType</a> instance.</p>",
"GetSdkRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"GetSdkRequest$stageName": "<p>[Required] The name of the <a>Stage</a> that the SDK will use.</p>",
"GetSdkRequest$sdkType": "<p>[Required] The language for the generated SDK. Currently <code>java</code>, <code>javascript</code>, <code>android</code>, <code>objectivec</code> (for iOS), <code>swift</code> (for iOS), and <code>ruby</code> are supported.</p>",
"GetSdkTypeRequest$id": "<p>[Required] The identifier of the queried <a>SdkType</a> instance.</p>",
"GetSdkTypesRequest$position": "<p>The current pagination position in the paged result set.</p>",
"GetStageRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"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>",
"GetStageRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"GetStageRequest$stageName": "<p>[Required] The name of the <a>Stage</a> resource to get information about.</p>",
"GetStagesRequest$restApiId": "<p>[Required] 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$resourceArn": "<p>[Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded. 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>",
"GetUsagePlanKeyRequest$usagePlanId": "<p>[Required] 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>[Required] The key Id of the to-be-retrieved <a>UsagePlanKey</a> resource representing a plan customer.</p>",
"GetUsagePlanKeysRequest$usagePlanId": "<p>[Required] 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>",
"GetUsagePlanKeysRequest$position": "<p>The current pagination position in the paged result set.</p>",
"GetUsagePlanKeysRequest$nameQuery": "<p>A query parameter specifying the name of the to-be-returned usage plan keys.</p>",
"GetUsagePlanRequest$usagePlanId": "<p>The identifier of the <a>UsagePlan</a> resource to be retrieved.</p>",
"GetUsagePlanRequest$usagePlanId": "<p>[Required] The identifier of the <a>UsagePlan</a> resource to be retrieved.</p>",
"GetUsagePlansRequest$position": "<p>The current pagination position in the paged result set.</p>",
"GetUsagePlansRequest$keyId": "<p>The identifier of the API key associated with the usage plans.</p>",
"GetUsageRequest$usagePlanId": "<p>The Id of the usage plan associated with the usage data.</p>",
"GetUsageRequest$usagePlanId": "<p>[Required] The Id of the usage plan associated with the usage data.</p>",
"GetUsageRequest$keyId": "<p>The Id of the API key associated with the resultant usage data.</p>",
"GetUsageRequest$startDate": "<p>The starting date (e.g., 2016-01-01) of the usage data.</p>",
"GetUsageRequest$endDate": "<p>The ending date (e.g., 2016-12-31) of the usage data.</p>",
"GetUsageRequest$startDate": "<p>[Required] The starting date (e.g., 2016-01-01) of the usage data.</p>",
"GetUsageRequest$endDate": "<p>[Required] The ending date (e.g., 2016-12-31) of the usage data.</p>",
"GetUsageRequest$position": "<p>The current pagination position in the paged result set.</p>",
"GetVpcLinkRequest$vpcLinkId": "<p>[Required] The identifier of the <a>VpcLink</a>. It is used in an <a>Integration</a> to reference this <a>VpcLink</a>.</p>",
"GetVpcLinksRequest$position": "<p>The current pagination position in the paged result set.</p>",
@ -1749,7 +1750,7 @@
"Model$id": "<p>The identifier for the model resource.</p>",
"Model$name": "<p>The name of the model. Must be an alphanumeric string.</p>",
"Model$description": "<p>The description of the model.</p>",
"Model$schema": "<p>The schema for the model. For <code>application/json</code> models, this should be <a href=\"http://json-schema.org/documentation.html\" target=\"_blank\">JSON-schema draft v4</a> model. Do not include \"\\*/\" characters in the description of any properties because such \"\\*/\" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.</p>",
"Model$schema": "<p>The schema for the model. For <code>application/json</code> models, this should be <a href=\"https://tools.ietf.org/html/draft-zyp-json-schema-04\" target=\"_blank\">JSON schema draft 4</a> model. Do not include \"\\*/\" characters in the description of any properties because such \"\\*/\" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.</p>",
"Model$contentType": "<p>The content-type for the model.</p>",
"Models$position": null,
"NotFoundException$message": null,
@ -1757,31 +1758,31 @@
"PatchOperation$value": "<p>The new target value of the update operation. It is applicable for the <code>add</code> or <code>replace</code> operation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., '{\"a\": ...}'. In a Windows shell, see <a href=\"http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json\">Using JSON for Parameters</a>.</p>",
"PatchOperation$from": "<p>The <code>copy</code> update operation's source as identified by a <code>JSON-Pointer</code> value referencing the location within the targeted resource to copy the value from. For example, to promote a canary deployment, you copy the canary deployment ID to the affiliated deployment ID by calling a PATCH request on a <a>Stage</a> resource with <code>\"op\":\"copy\"</code>, <code>\"from\":\"/canarySettings/deploymentId\"</code> and <code>\"path\":\"/deploymentId\"</code>.</p>",
"PathToMapOfMethodSnapshot$key": null,
"PutGatewayResponseRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"PutIntegrationRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"PutIntegrationRequest$resourceId": "<p>Specifies a put integration request's resource ID.</p>",
"PutIntegrationRequest$httpMethod": "<p>Specifies a put integration request's HTTP method.</p>",
"PutGatewayResponseRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"PutIntegrationRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"PutIntegrationRequest$resourceId": "<p>[Required] Specifies a put integration request's resource ID.</p>",
"PutIntegrationRequest$httpMethod": "<p>[Required] Specifies a put integration request's HTTP method.</p>",
"PutIntegrationRequest$integrationHttpMethod": "<p>Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.</p>",
"PutIntegrationRequest$uri": "<p>Specifies Uniform Resource Identifier (URI) of the integration endpoint.</p> <ul> <li><p> For <code>HTTP</code> or <code>HTTP_PROXY</code> integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the <a target=\"_blank\" href=\"https://en.wikipedia.org/wiki/Uniform_Resource_Identifier\">RFC-3986 specification</a>, for either standard integration, where <code>connectionType</code> is not <code>VPC_LINK</code>, or private integration, where <code>connectionType</code> is <code>VPC_LINK</code>. For a private HTTP integration, the URI is not used for routing. </p> </li> <li><p> For <code>AWS</code> or <code>AWS_PROXY</code> integrations, the URI is of the form <code>arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}</code>. Here, <code>{Region}</code> is the API Gateway region (e.g., <code>us-east-1</code>); <code>{service}</code> is the name of the integrated AWS service (e.g., <code>s3</code>); and <code>{subdomain}</code> is a designated subdomain supported by certain AWS service for fast host-name lookup. <code>action</code> can be used for an AWS service action-based API, using an <code>Action={name}&amp;{p1}={v1}&amp;p2={v2}...</code> query string. The ensuing <code>{service_api}</code> refers to a supported action <code>{name}</code> plus any required input parameters. Alternatively, <code>path</code> can be used for an AWS service path-based API. The ensuing <code>service_api</code> refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of <code><a href=\"http://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html\">GetObject</a></code>, the <code>uri</code> can be either <code>arn:aws:apigateway:us-west-2:s3:action/GetObject&amp;Bucket={bucket}&amp;Key={key}</code> or <code>arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}</code></p> </li></ul>",
"PutIntegrationRequest$connectionId": "<p>The (<a href=\"http://docs.aws.amazon.com/apigateway/api-reference/resource/vpc-link/#id\"><code>id</code></a>) of the <a>VpcLink</a> used for the integration when <code>connectionType=VPC_LINK</code> and undefined, otherwise.</p>",
"PutIntegrationRequest$credentials": "<p>Specifies whether credentials are required for a put integration.</p>",
"PutIntegrationRequest$passthroughBehavior": "<p>Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the <code>requestTemplates</code> property on the Integration resource. There are three valid values: <code>WHEN_NO_MATCH</code>, <code>WHEN_NO_TEMPLATES</code>, and <code>NEVER</code>. </p> <ul> <li><p><code>WHEN_NO_MATCH</code> passes the request body for unmapped content types through to the integration back end without transformation.</p></li> <li><p><code>NEVER</code> rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.</p></li> <li><p><code>WHEN_NO_TEMPLATES</code> allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.</p></li> </ul>",
"PutIntegrationRequest$cacheNamespace": "<p>Specifies a put integration input's cache namespace.</p>",
"PutIntegrationResponseRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"PutIntegrationResponseRequest$resourceId": "<p>Specifies a put integration response request's resource identifier.</p>",
"PutIntegrationResponseRequest$httpMethod": "<p>Specifies a put integration response request's HTTP method.</p>",
"PutIntegrationResponseRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"PutIntegrationResponseRequest$resourceId": "<p>[Required] Specifies a put integration response request's resource identifier.</p>",
"PutIntegrationResponseRequest$httpMethod": "<p>[Required] Specifies a put integration response request's HTTP method.</p>",
"PutIntegrationResponseRequest$selectionPattern": "<p>Specifies the selection pattern of a put integration response.</p>",
"PutMethodRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"PutMethodRequest$resourceId": "<p>The <a>Resource</a> identifier for the new <a>Method</a> resource.</p>",
"PutMethodRequest$httpMethod": "<p>Specifies the method request's HTTP method type.</p>",
"PutMethodRequest$authorizationType": "<p>The method's authorization type. Valid values are <code>NONE</code> for open access, <code>AWS_IAM</code> for using AWS IAM permissions, <code>CUSTOM</code> for using a custom authorizer, or <code>COGNITO_USER_POOLS</code> for using a Cognito user pool.</p>",
"PutMethodRequest$authorizerId": "<p>Specifies the identifier of an <a>Authorizer</a> to use on this Method, if the type is CUSTOM.</p>",
"PutMethodRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"PutMethodRequest$resourceId": "<p>[Required] The <a>Resource</a> identifier for the new <a>Method</a> resource.</p>",
"PutMethodRequest$httpMethod": "<p>[Required] Specifies the method request's HTTP method type.</p>",
"PutMethodRequest$authorizationType": "<p>[Required] The method's authorization type. Valid values are <code>NONE</code> for open access, <code>AWS_IAM</code> for using AWS IAM permissions, <code>CUSTOM</code> for using a custom authorizer, or <code>COGNITO_USER_POOLS</code> for using a Cognito user pool.</p>",
"PutMethodRequest$authorizerId": "<p>Specifies the identifier of an <a>Authorizer</a> to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.</p>",
"PutMethodRequest$operationName": "<p>A human-friendly operation identifier for the method. For example, you can assign the <code>operationName</code> of <code>ListPets</code> for the <code>GET /pets</code> method in <a href=\"http://petstore-demo-endpoint.execute-api.com/petstore/pets\">PetStore</a> example.</p>",
"PutMethodRequest$requestValidatorId": "<p>The identifier of a <a>RequestValidator</a> for validating the method request.</p>",
"PutMethodResponseRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"PutMethodResponseRequest$resourceId": "<p>The <a>Resource</a> identifier for the <a>Method</a> resource.</p>",
"PutMethodResponseRequest$httpMethod": "<p>The HTTP verb of the <a>Method</a> resource.</p>",
"PutRestApiRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"PutMethodResponseRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"PutMethodResponseRequest$resourceId": "<p>[Required] The <a>Resource</a> identifier for the <a>Method</a> resource.</p>",
"PutMethodResponseRequest$httpMethod": "<p>[Required] The HTTP verb of the <a>Method</a> resource.</p>",
"PutRestApiRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"RequestValidator$id": "<p>The identifier of this <a>RequestValidator</a>.</p>",
"RequestValidator$name": "<p>The name of this <a>RequestValidator</a></p>",
"RequestValidators$position": null,
@ -1794,6 +1795,7 @@
"RestApi$name": "<p>The API's name.</p>",
"RestApi$description": "<p>The API's description.</p>",
"RestApi$version": "<p>A version identifier for the API.</p>",
"RestApi$policy": "A stringified JSON policy document that applies to this RestApi regardless of the caller and <a>Method</a> configuration.",
"RestApis$position": null,
"SdkConfigurationProperty$name": "<p>The name of a an <a>SdkType</a> configuration property.</p>",
"SdkConfigurationProperty$friendlyName": "<p>The user-friendly name of an <a>SdkType</a> configuration property.</p>",
@ -1814,18 +1816,18 @@
"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>",
"TagResourceRequest$resourceArn": "<p>[Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded. 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>",
"TestInvokeAuthorizerRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"TestInvokeAuthorizerRequest$authorizerId": "<p>[Required] Specifies a test invoke authorizer request's <a>Authorizer</a> ID.</p>",
"TestInvokeAuthorizerRequest$pathWithQueryString": "<p>[Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.</p>",
"TestInvokeAuthorizerRequest$body": "<p>[Optional] The simulated request body of an incoming invocation request.</p>",
"TestInvokeAuthorizerResponse$log": "<p>The API Gateway execution log for the test authorizer request.</p>",
"TestInvokeAuthorizerResponse$principalId": "<p>The principal identity returned by the <a>Authorizer</a></p>",
"TestInvokeAuthorizerResponse$policy": "<p>The JSON policy document returned by the <a>Authorizer</a></p>",
"TestInvokeMethodRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"TestInvokeMethodRequest$resourceId": "<p>Specifies a test invoke method request's resource ID.</p>",
"TestInvokeMethodRequest$httpMethod": "<p>Specifies a test invoke method request's HTTP method.</p>",
"TestInvokeMethodRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"TestInvokeMethodRequest$resourceId": "<p>[Required] Specifies a test invoke method request's resource ID.</p>",
"TestInvokeMethodRequest$httpMethod": "<p>[Required] Specifies a test invoke method request's HTTP method.</p>",
"TestInvokeMethodRequest$pathWithQueryString": "<p>The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.</p>",
"TestInvokeMethodRequest$body": "<p>The simulated request body of an incoming invocation request.</p>",
"TestInvokeMethodRequest$clientCertificateId": "<p>A <a>ClientCertificate</a> identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.</p>",
@ -1834,45 +1836,45 @@
"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>",
"UpdateBasePathMappingRequest$domainName": "<p>The domain name of the <a>BasePathMapping</a> resource to change.</p>",
"UpdateBasePathMappingRequest$basePath": "<p>The base path of the <a>BasePathMapping</a> resource to change.</p>",
"UpdateClientCertificateRequest$clientCertificateId": "<p>The identifier of the <a>ClientCertificate</a> resource to be updated.</p>",
"UpdateDeploymentRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"UntagResourceRequest$resourceArn": "<p>[Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded. At present, <a>Stage</a> is the only taggable resource.</p>",
"UpdateApiKeyRequest$apiKey": "<p>[Required] The identifier of the <a>ApiKey</a> resource to be updated.</p>",
"UpdateAuthorizerRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"UpdateAuthorizerRequest$authorizerId": "<p>[Required] The identifier of the <a>Authorizer</a> resource.</p>",
"UpdateBasePathMappingRequest$domainName": "<p>[Required] The domain name of the <a>BasePathMapping</a> resource to change.</p>",
"UpdateBasePathMappingRequest$basePath": "<p>[Required] The base path of the <a>BasePathMapping</a> resource to change.</p>",
"UpdateClientCertificateRequest$clientCertificateId": "<p>[Required] The identifier of the <a>ClientCertificate</a> resource to be updated.</p>",
"UpdateDeploymentRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"UpdateDeploymentRequest$deploymentId": "<p>The replacement identifier for the <a>Deployment</a> resource to change information about.</p>",
"UpdateDocumentationPartRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"UpdateDocumentationPartRequest$documentationPartId": "<p>[Required] The identifier of the to-be-updated documentation part.</p>",
"UpdateDocumentationVersionRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>..</p>",
"UpdateDocumentationVersionRequest$documentationVersion": "<p>[Required] The version identifier of the to-be-updated documentation version.</p>",
"UpdateDomainNameRequest$domainName": "<p>The name of the <a>DomainName</a> resource to be changed.</p>",
"UpdateGatewayResponseRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"UpdateIntegrationRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"UpdateIntegrationRequest$resourceId": "<p>Represents an update integration request's resource identifier.</p>",
"UpdateIntegrationRequest$httpMethod": "<p>Represents an update integration request's HTTP method.</p>",
"UpdateIntegrationResponseRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"UpdateIntegrationResponseRequest$resourceId": "<p>Specifies an update integration response request's resource identifier.</p>",
"UpdateIntegrationResponseRequest$httpMethod": "<p>Specifies an update integration response request's HTTP method.</p>",
"UpdateMethodRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"UpdateMethodRequest$resourceId": "<p>The <a>Resource</a> identifier for the <a>Method</a> resource.</p>",
"UpdateMethodRequest$httpMethod": "<p>The HTTP verb of the <a>Method</a> resource.</p>",
"UpdateMethodResponseRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"UpdateMethodResponseRequest$resourceId": "<p>The <a>Resource</a> identifier for the <a>MethodResponse</a> resource.</p>",
"UpdateMethodResponseRequest$httpMethod": "<p>The HTTP verb of the <a>Method</a> resource.</p>",
"UpdateModelRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"UpdateModelRequest$modelName": "<p>The name of the model to update.</p>",
"UpdateRequestValidatorRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"UpdateDomainNameRequest$domainName": "<p>[Required] The name of the <a>DomainName</a> resource to be changed.</p>",
"UpdateGatewayResponseRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"UpdateIntegrationRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"UpdateIntegrationRequest$resourceId": "<p>[Required] Represents an update integration request's resource identifier.</p>",
"UpdateIntegrationRequest$httpMethod": "<p>[Required] Represents an update integration request's HTTP method.</p>",
"UpdateIntegrationResponseRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"UpdateIntegrationResponseRequest$resourceId": "<p>[Required] Specifies an update integration response request's resource identifier.</p>",
"UpdateIntegrationResponseRequest$httpMethod": "<p>[Required] Specifies an update integration response request's HTTP method.</p>",
"UpdateMethodRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"UpdateMethodRequest$resourceId": "<p>[Required] The <a>Resource</a> identifier for the <a>Method</a> resource.</p>",
"UpdateMethodRequest$httpMethod": "<p>[Required] The HTTP verb of the <a>Method</a> resource.</p>",
"UpdateMethodResponseRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"UpdateMethodResponseRequest$resourceId": "<p>[Required] The <a>Resource</a> identifier for the <a>MethodResponse</a> resource.</p>",
"UpdateMethodResponseRequest$httpMethod": "<p>[Required] The HTTP verb of the <a>Method</a> resource.</p>",
"UpdateModelRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"UpdateModelRequest$modelName": "<p>[Required] The name of the model to update.</p>",
"UpdateRequestValidatorRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"UpdateRequestValidatorRequest$requestValidatorId": "<p>[Required] The identifier of <a>RequestValidator</a> to be updated.</p>",
"UpdateResourceRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"UpdateResourceRequest$resourceId": "<p>The identifier of the <a>Resource</a> resource.</p>",
"UpdateRestApiRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"UpdateStageRequest$restApiId": "<p>The string identifier of the associated <a>RestApi</a>.</p>",
"UpdateStageRequest$stageName": "<p>The name of the <a>Stage</a> resource to change information about.</p>",
"UpdateUsagePlanRequest$usagePlanId": "<p>The Id of the to-be-updated usage plan.</p>",
"UpdateUsageRequest$usagePlanId": "<p>The Id of the usage plan associated with the usage data.</p>",
"UpdateUsageRequest$keyId": "<p>The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.</p>",
"UpdateResourceRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"UpdateResourceRequest$resourceId": "<p>[Required] The identifier of the <a>Resource</a> resource.</p>",
"UpdateRestApiRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"UpdateStageRequest$restApiId": "<p>[Required] The string identifier of the associated <a>RestApi</a>.</p>",
"UpdateStageRequest$stageName": "<p>[Required] The name of the <a>Stage</a> resource to change information about.</p>",
"UpdateUsagePlanRequest$usagePlanId": "<p>[Required] The Id of the to-be-updated usage plan.</p>",
"UpdateUsageRequest$usagePlanId": "<p>[Required] The Id of the usage plan associated with the usage data.</p>",
"UpdateUsageRequest$keyId": "<p>[Required] The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.</p>",
"UpdateVpcLinkRequest$vpcLinkId": "<p>[Required] The identifier of the <a>VpcLink</a>. It is used in an <a>Integration</a> to reference this <a>VpcLink</a>.</p>",
"Usage$usagePlanId": "<p>The plan Id associated with this usage data.</p>",
"Usage$startDate": "<p>The starting date of the usage data.</p>",
@ -1896,12 +1898,12 @@
}
},
"TagResourceRequest": {
"base": "<p>Adds or updates Tags on a gievn resource.</p>",
"base": "<p>Adds or updates a tag on a given resource.</p>",
"refs": {
}
},
"Tags": {
"base": "<p>A collection of Tags associated with a given resource.</p>",
"base": "<p>The collection of tags. Each tag element is associated with a given resource.</p>",
"refs": {
}
},
@ -1970,7 +1972,7 @@
}
},
"UntagResourceRequest": {
"base": "<p>Removes Tags from a given resource.</p>",
"base": "<p>Removes a tag from a given resource.</p>",
"refs": {
}
},

33
vendor/github.com/aws/aws-sdk-go/models/apis/appstream/2016-12-01/api-2.json generated vendored
View File

@ -23,6 +23,7 @@
"output":{"shape":"AssociateFleetResult"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"InvalidAccountStatusException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConcurrentModificationException"},
{"shape":"IncompatibleImageException"},
@ -42,6 +43,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceNotAvailableException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidAccountStatusException"},
{"shape":"IncompatibleImageException"}
]
},
@ -55,7 +57,8 @@
"output":{"shape":"CreateDirectoryConfigResult"},
"errors":[
{"shape":"ResourceAlreadyExistsException"},
{"shape":"LimitExceededException"}
{"shape":"LimitExceededException"},
{"shape":"InvalidAccountStatusException"}
]
},
"CreateFleet":{
@ -71,6 +74,7 @@
{"shape":"ResourceNotAvailableException"},
{"shape":"ResourceNotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidAccountStatusException"},
{"shape":"InvalidRoleException"},
{"shape":"ConcurrentModificationException"},
{"shape":"InvalidParameterCombinationException"},
@ -87,6 +91,7 @@
"output":{"shape":"CreateImageBuilderResult"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"InvalidAccountStatusException"},
{"shape":"ResourceAlreadyExistsException"},
{"shape":"ResourceNotAvailableException"},
{"shape":"ResourceNotFoundException"},
@ -119,6 +124,7 @@
"output":{"shape":"CreateStackResult"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"InvalidAccountStatusException"},
{"shape":"ResourceAlreadyExistsException"},
{"shape":"ConcurrentModificationException"},
{"shape":"InvalidRoleException"},
@ -348,6 +354,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"OperationNotPermittedException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidAccountStatusException"},
{"shape":"ConcurrentModificationException"}
]
},
@ -363,6 +370,7 @@
{"shape":"ResourceNotAvailableException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConcurrentModificationException"},
{"shape":"InvalidAccountStatusException"},
{"shape":"IncompatibleImageException"}
]
},
@ -403,6 +411,7 @@
"output":{"shape":"TagResourceResponse"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"InvalidAccountStatusException"},
{"shape":"ResourceNotFoundException"}
]
},
@ -443,6 +452,7 @@
"errors":[
{"shape":"ResourceInUseException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidAccountStatusException"},
{"shape":"InvalidRoleException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceNotAvailableException"},
@ -466,6 +476,7 @@
{"shape":"InvalidRoleException"},
{"shape":"InvalidParameterCombinationException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidAccountStatusException"},
{"shape":"IncompatibleImageException"}
]
}
@ -673,7 +684,8 @@
"Description":{"shape":"Description"},
"DisplayName":{"shape":"DisplayName"},
"StorageConnectors":{"shape":"StorageConnectorList"},
"RedirectURL":{"shape":"RedirectURL"}
"RedirectURL":{"shape":"RedirectURL"},
"FeedbackURL":{"shape":"FeedbackURL"}
}
},
"CreateStackResult":{
@ -922,6 +934,10 @@
"members":{
}
},
"FeedbackURL":{
"type":"string",
"max":1000
},
"Fleet":{
"type":"structure",
"required":[
@ -1135,6 +1151,13 @@
"exception":true
},
"Integer":{"type":"integer"},
"InvalidAccountStatusException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"InvalidParameterCombinationException":{
"type":"structure",
"members":{
@ -1338,6 +1361,7 @@
"CreatedTime":{"shape":"Timestamp"},
"StorageConnectors":{"shape":"StorageConnectorList"},
"RedirectURL":{"shape":"RedirectURL"},
"FeedbackURL":{"shape":"FeedbackURL"},
"StackErrors":{"shape":"StackErrors"}
}
},
@ -1345,7 +1369,9 @@
"type":"string",
"enum":[
"STORAGE_CONNECTORS",
"REDIRECT_URL"
"REDIRECT_URL",
"FEEDBACK_URL",
"THEME_NAME"
]
},
"StackAttributes":{
@ -1573,6 +1599,7 @@
"deprecated":true
},
"RedirectURL":{"shape":"RedirectURL"},
"FeedbackURL":{"shape":"FeedbackURL"},
"AttributesToDelete":{"shape":"StackAttributes"}
}
},

22
vendor/github.com/aws/aws-sdk-go/models/apis/appstream/2016-12-01/docs-2.json generated vendored
View File

@ -395,6 +395,7 @@
"refs": {
"ConcurrentModificationException$Message": null,
"IncompatibleImageException$Message": null,
"InvalidAccountStatusException$Message": null,
"InvalidParameterCombinationException$Message": null,
"InvalidRoleException$Message": null,
"LimitExceededException$Message": null,
@ -415,6 +416,14 @@
"refs": {
}
},
"FeedbackURL": {
"base": null,
"refs": {
"CreateStackRequest$FeedbackURL": "<p>The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.</p>",
"Stack$FeedbackURL": "<p>The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.</p>",
"UpdateStackRequest$FeedbackURL": "<p>The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.</p>"
}
},
"Fleet": {
"base": "<p>Contains the parameters for a fleet.</p>",
"refs": {
@ -562,6 +571,11 @@
"UpdateFleetRequest$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>"
}
},
"InvalidAccountStatusException": {
"base": "<p>The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support. </p>",
"refs": {
}
},
"InvalidParameterCombinationException": {
"base": "<p>Indicates an incorrect combination of parameters, or a missing parameter.</p>",
"refs": {
@ -662,9 +676,9 @@
"RedirectURL": {
"base": null,
"refs": {
"CreateStackRequest$RedirectURL": "<p>The URL the user is redirected to after the streaming session ends.</p>",
"Stack$RedirectURL": "<p>The URL the user is redirected to after the streaming session ends.</p>",
"UpdateStackRequest$RedirectURL": "<p>The URL the user is redirected to after the streaming session ends.</p>"
"CreateStackRequest$RedirectURL": "<p>The URL that users are redirected to after their streaming session ends.</p>",
"Stack$RedirectURL": "<p>The URL that users are redirected to after their streaming session ends.</p>",
"UpdateStackRequest$RedirectURL": "<p>The URL that users are redirected to after their streaming session ends.</p>"
}
},
"RegionName": {
@ -861,7 +875,7 @@
"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$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 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>",

45
vendor/github.com/aws/aws-sdk-go/models/apis/appsync/2017-07-25/api-2.json generated vendored
View File

@ -61,7 +61,6 @@
{"shape":"ConcurrentModificationException"},
{"shape":"UnauthorizedException"},
{"shape":"InternalFailureException"},
{"shape":"LimitExceededException"},
{"shape":"ApiLimitExceededException"}
]
},
@ -479,7 +478,8 @@
"enum":[
"API_KEY",
"AWS_IAM",
"AMAZON_COGNITO_USER_POOLS"
"AMAZON_COGNITO_USER_POOLS",
"OPENID_CONNECT"
]
},
"BadRequestException":{
@ -555,8 +555,10 @@
],
"members":{
"name":{"shape":"String"},
"logConfig":{"shape":"LogConfig"},
"authenticationType":{"shape":"AuthenticationType"},
"userPoolConfig":{"shape":"UserPoolConfig"}
"userPoolConfig":{"shape":"UserPoolConfig"},
"openIDConnectConfig":{"shape":"OpenIDConnectConfig"}
}
},
"CreateGraphqlApiResponse":{
@ -795,6 +797,14 @@
}
},
"ErrorMessage":{"type":"string"},
"FieldLogLevel":{
"type":"string",
"enum":[
"NONE",
"ERROR",
"ALL"
]
},
"GetDataSourceRequest":{
"type":"structure",
"required":[
@ -957,7 +967,9 @@
"name":{"shape":"ResourceName"},
"apiId":{"shape":"String"},
"authenticationType":{"shape":"AuthenticationType"},
"logConfig":{"shape":"LogConfig"},
"userPoolConfig":{"shape":"UserPoolConfig"},
"openIDConnectConfig":{"shape":"OpenIDConnectConfig"},
"arn":{"shape":"String"},
"uris":{"shape":"MapOfStringToString"}
}
@ -1140,6 +1152,17 @@
"nextToken":{"shape":"PaginationToken"}
}
},
"LogConfig":{
"type":"structure",
"required":[
"fieldLogLevel",
"cloudWatchLogsRoleArn"
],
"members":{
"fieldLogLevel":{"shape":"FieldLogLevel"},
"cloudWatchLogsRoleArn":{"shape":"String"}
}
},
"Long":{"type":"long"},
"MapOfStringToString":{
"type":"map",
@ -1149,7 +1172,7 @@
"MappingTemplate":{
"type":"string",
"max":65536,
"min":0
"min":1
},
"MaxResults":{
"type":"integer",
@ -1164,6 +1187,16 @@
"error":{"httpStatusCode":404},
"exception":true
},
"OpenIDConnectConfig":{
"type":"structure",
"required":["issuer"],
"members":{
"issuer":{"shape":"String"},
"clientId":{"shape":"String"},
"iatTTL":{"shape":"Long"},
"authTTL":{"shape":"Long"}
}
},
"OutputType":{
"type":"string",
"enum":[
@ -1325,8 +1358,10 @@
"locationName":"apiId"
},
"name":{"shape":"String"},
"logConfig":{"shape":"LogConfig"},
"authenticationType":{"shape":"AuthenticationType"},
"userPoolConfig":{"shape":"UserPoolConfig"}
"userPoolConfig":{"shape":"UserPoolConfig"},
"openIDConnectConfig":{"shape":"OpenIDConnectConfig"}
}
},
"UpdateGraphqlApiResponse":{

39
vendor/github.com/aws/aws-sdk-go/models/apis/appsync/2017-07-25/docs-2.json generated vendored
View File

@ -18,7 +18,7 @@
"GetResolver": "<p>Retrieves a <code>Resolver</code> object.</p>",
"GetSchemaCreationStatus": "<p>Retrieves the current status of a schema creation operation.</p>",
"GetType": "<p>Retrieves a <code>Type</code> object.</p>",
"ListApiKeys": "<p>Lists the API keys for a given API.</p>",
"ListApiKeys": "<p>Lists the API keys for a given API.</p> <note> <p>API keys are deleted automatically sometime after they expire. However, they may still be included in the response until they have actually been deleted. You can safely call <code>DeleteApiKey</code> to manually delete a key before it's automatically deleted.</p> </note>",
"ListDataSources": "<p>Lists the data sources for a given API.</p>",
"ListGraphqlApis": "<p>Lists your GraphQL APIs.</p>",
"ListResolvers": "<p>Lists the resolvers for a given API and type.</p>",
@ -32,7 +32,7 @@
},
"shapes": {
"ApiKey": {
"base": "<p>Describes an API key.</p>",
"base": "<p>Describes an API key.</p> <p>Customers invoke AWS AppSync GraphQL APIs with API keys as an identity mechanism. There are two key versions:</p> <p> <b>da1</b>: This version was introduced at launch in November 2017. These keys always expire after 7 days. Key expiration is managed by DynamoDB TTL. The keys will cease to be valid after Feb 21, 2018 and should not be used after that date.</p> <ul> <li> <p> <code>ListApiKeys</code> returns the expiration time in milliseconds.</p> </li> <li> <p> <code>CreateApiKey</code> returns the expiration time in milliseconds.</p> </li> <li> <p> <code>UpdateApiKey</code> is not available for this key version.</p> </li> <li> <p> <code>DeleteApiKey</code> deletes the item from the table.</p> </li> <li> <p>Expiration is stored in DynamoDB as milliseconds. This results in a bug where keys are not automatically deleted because DynamoDB expects the TTL to be stored in seconds. As a one-time action, we will delete these keys from the table after Feb 21, 2018.</p> </li> </ul> <p> <b>da2</b>: This version was introduced in February 2018 when AppSync added support to extend key expiration.</p> <ul> <li> <p> <code>ListApiKeys</code> returns the expiration time in seconds.</p> </li> <li> <p> <code>CreateApiKey</code> returns the expiration time in seconds and accepts a user-provided expiration time in seconds.</p> </li> <li> <p> <code>UpdateApiKey</code> returns the expiration time in seconds and accepts a user-provided expiration time in seconds. Key expiration can only be updated while the key has not expired.</p> </li> <li> <p> <code>DeleteApiKey</code> deletes the item from the table.</p> </li> <li> <p>Expiration is stored in DynamoDB as seconds.</p> </li> </ul>",
"refs": {
"ApiKeys$member": null,
"CreateApiKeyResponse$apiKey": "<p>The API key.</p>",
@ -45,7 +45,7 @@
}
},
"ApiKeyValidityOutOfBoundsException": {
"base": "<p>The API key expiration must be set to a value between 1 and 365 days.</p>",
"base": "<p>The API key expiration must be set to a value between 1 and 365 days from creation (for <code>CreateApiKey</code>) or from update (for <code>UpdateApiKey</code>).</p>",
"refs": {
}
},
@ -154,7 +154,7 @@
"base": null,
"refs": {
"CreateDataSourceRequest$type": "<p>The type of the <code>DataSource</code>.</p>",
"DataSource$type": "<p>The type of the data source.</p> <ul> <li> <p> <b>AMAZON_DYNAMODB</b>: The data source is an Amazon DynamoDB table.</p> </li> <li> <p> <b>AMAZON_ELASTICSEARCH</b>: The data source is an Amazon Elasticsearch Service domain.</p> </li> <li> <p> <b>AWS_LAMBDA</b>: The data source is an AWS Lambda function.</p> </li> <li> <p> <b>NONE</b>: There is no data source. This type is used when the required information can be computed on the fly without connecting to a back-end data source.</p> </li> </ul>",
"DataSource$type": "<p>The type of the data source.</p> <ul> <li> <p> <b>AMAZON_DYNAMODB</b>: The data source is an Amazon DynamoDB table.</p> </li> <li> <p> <b>AMAZON_ELASTICSEARCH</b>: The data source is an Amazon Elasticsearch Service domain.</p> </li> <li> <p> <b>AWS_LAMBDA</b>: The data source is an AWS Lambda function.</p> </li> <li> <p> <b>NONE</b>: There is no data source. This type is used when when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation.</p> </li> </ul>",
"UpdateDataSourceRequest$type": "<p>The new data source type.</p>"
}
},
@ -244,6 +244,12 @@
"GraphQLSchemaException$message": null
}
},
"FieldLogLevel": {
"base": null,
"refs": {
"LogConfig$fieldLogLevel": "<p>The field logging level. Values can be NONE, ERROR, ALL. </p> <ul> <li> <p> <b>NONE</b>: No field-level logs are captured.</p> </li> <li> <p> <b>ERROR</b>: Logs the following information only for the fields that are in error:</p> <ul> <li> <p>The error section in the server response.</p> </li> <li> <p>Field-level errors.</p> </li> <li> <p>The generated request/response functions that got resolved for error fields.</p> </li> </ul> </li> <li> <p> <b>ALL</b>: The following information is logged for all fields in the query:</p> <ul> <li> <p>Field-level tracing information.</p> </li> <li> <p>The generated request/response functions that got resolved for each field.</p> </li> </ul> </li> </ul>"
}
},
"GetDataSourceRequest": {
"base": null,
"refs": {
@ -392,12 +398,22 @@
"refs": {
}
},
"LogConfig": {
"base": "<p>The CloudWatch Logs configuration.</p>",
"refs": {
"CreateGraphqlApiRequest$logConfig": "<p>The Amazon CloudWatch logs configuration.</p>",
"GraphqlApi$logConfig": "<p>The Amazon CloudWatch Logs configuration.</p>",
"UpdateGraphqlApiRequest$logConfig": "<p>The Amazon CloudWatch logs configuration for the <code>GraphqlApi</code> object.</p>"
}
},
"Long": {
"base": null,
"refs": {
"ApiKey$expires": "<p>The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.</p>",
"CreateApiKeyRequest$expires": "<p>The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time.</p>",
"UpdateApiKeyRequest$expires": "<p>The time after which the API key expires. The date is represented as seconds since the epoch.</p>"
"CreateApiKeyRequest$expires": "<p>The time from creation time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time. For more information, see .</p>",
"OpenIDConnectConfig$iatTTL": "<p>The number of milliseconds a token is valid after being issued to a user.</p>",
"OpenIDConnectConfig$authTTL": "<p>The number of milliseconds a token is valid after being authenticated.</p>",
"UpdateApiKeyRequest$expires": "<p>The time from update time after which the API key expires. The date is represented as seconds since the epoch. For more information, see .</p>"
}
},
"MapOfStringToString": {
@ -432,6 +448,14 @@
"refs": {
}
},
"OpenIDConnectConfig": {
"base": "<p>Describes an Open Id Connect configuration.</p>",
"refs": {
"CreateGraphqlApiRequest$openIDConnectConfig": "<p>The Open Id Connect configuration configuration.</p>",
"GraphqlApi$openIDConnectConfig": "<p>The Open Id Connect configuration.</p>",
"UpdateGraphqlApiRequest$openIDConnectConfig": "<p>The Open Id Connect configuration configuration for the <code>GraphqlApi</code> object.</p>"
}
},
"OutputType": {
"base": null,
"refs": {
@ -560,9 +584,12 @@
"ListResolversRequest$apiId": "<p>The API ID.</p>",
"ListResolversRequest$typeName": "<p>The type name.</p>",
"ListTypesRequest$apiId": "<p>The API ID.</p>",
"LogConfig$cloudWatchLogsRoleArn": "<p>The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account. </p>",
"MapOfStringToString$key": null,
"MapOfStringToString$value": null,
"NotFoundException$message": null,
"OpenIDConnectConfig$issuer": "<p>The issuer for the open id connect configuration. The issuer returned by discovery MUST exactly match the value of iss in the ID Token.</p>",
"OpenIDConnectConfig$clientId": "<p>The client identifier of the Relying party at the OpenID Provider. This identifier is typically obtained when the Relying party is registered with the OpenID Provider. You can specify a regular expression so the AWS AppSync can validate against multiple client identifiers at a time</p>",
"Resolver$resolverArn": "<p>The resolver ARN.</p>",
"StartSchemaCreationRequest$apiId": "<p>The API ID.</p>",
"Type$description": "<p>The type description.</p>",

70
vendor/github.com/aws/aws-sdk-go/models/apis/autoscaling-plans/2018-01-06/api-2.json generated vendored
View File

@ -72,13 +72,29 @@
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
]
},
"UpdateScalingPlan":{
"name":"UpdateScalingPlan",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateScalingPlanRequest"},
"output":{"shape":"UpdateScalingPlanResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"},
{"shape":"ObjectNotFoundException"}
]
}
},
"shapes":{
"ApplicationSource":{
"type":"structure",
"members":{
"CloudFormationStackARN":{"shape":"XmlString"}
"CloudFormationStackARN":{"shape":"XmlString"},
"TagFilters":{"shape":"TagFilters"}
}
},
"ApplicationSources":{
@ -344,6 +360,7 @@
"ScalingInstructions":{"shape":"ScalingInstructions"},
"StatusCode":{"shape":"ScalingPlanStatusCode"},
"StatusMessage":{"shape":"XmlString"},
"StatusStartTime":{"shape":"TimestampType"},
"CreationTime":{"shape":"TimestampType"}
}
},
@ -351,7 +368,7 @@
"type":"string",
"max":128,
"min":1,
"pattern":"[\\p{Print}&&[^|]]+"
"pattern":"[\\p{Print}&&[^|:/]]+"
},
"ScalingPlanNames":{
"type":"list",
@ -390,7 +407,9 @@
"CreationInProgress",
"CreationFailed",
"DeletionInProgress",
"DeletionFailed"
"DeletionFailed",
"UpdateInProgress",
"UpdateFailed"
]
},
"ScalingPlanVersion":{"type":"long"},
@ -432,6 +451,21 @@
"dynamodb"
]
},
"TagFilter":{
"type":"structure",
"members":{
"Key":{"shape":"XmlStringMaxLen128"},
"Values":{"shape":"TagValues"}
}
},
"TagFilters":{
"type":"list",
"member":{"shape":"TagFilter"}
},
"TagValues":{
"type":"list",
"member":{"shape":"XmlStringMaxLen256"}
},
"TargetTrackingConfiguration":{
"type":"structure",
"required":["TargetValue"],
@ -450,6 +484,24 @@
"member":{"shape":"TargetTrackingConfiguration"}
},
"TimestampType":{"type":"timestamp"},
"UpdateScalingPlanRequest":{
"type":"structure",
"required":[
"ScalingPlanName",
"ScalingPlanVersion"
],
"members":{
"ApplicationSource":{"shape":"ApplicationSource"},
"ScalingPlanName":{"shape":"ScalingPlanName"},
"ScalingInstructions":{"shape":"ScalingInstructions"},
"ScalingPlanVersion":{"shape":"ScalingPlanVersion"}
}
},
"UpdateScalingPlanResponse":{
"type":"structure",
"members":{
}
},
"ValidationException":{
"type":"structure",
"members":{
@ -460,6 +512,18 @@
"XmlString":{
"type":"string",
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
},
"XmlStringMaxLen128":{
"type":"string",
"max":128,
"min":1,
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
},
"XmlStringMaxLen256":{
"type":"string",
"max":256,
"min":1,
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
}
}
}

64
vendor/github.com/aws/aws-sdk-go/models/apis/autoscaling-plans/2018-01-06/docs-2.json generated vendored
View File

@ -1,19 +1,21 @@
{
"version": "2.0",
"service": "<p>Use AWS Auto Scaling to quickly discover all the scalable AWS resources for your application and configure dynamic scaling for your scalable resources.</p> <p>To get started, create a scaling plan with a set of instructions used to configure dynamic scaling for the scalable resources in your application. AWS Auto Scaling creates target tracking scaling policies for the scalable resources in your scaling plan. Target tracking scaling policies adjust the capacity of your scalable resource as required to maintain resource utilization at the target value that you specified.</p>",
"service": "<fullname>AWS Auto Scaling</fullname> <p>Use AWS Auto Scaling to quickly discover all the scalable AWS resources for your application and configure dynamic scaling for your scalable resources.</p> <p>To get started, create a scaling plan with a set of instructions used to configure dynamic scaling for the scalable resources in your application. AWS Auto Scaling creates target tracking scaling policies for the scalable resources in your scaling plan. Target tracking scaling policies adjust the capacity of your scalable resource as required to maintain resource utilization at the target value that you specified.</p>",
"operations": {
"CreateScalingPlan": "<p>Creates a scaling plan.</p> <p>A scaling plan contains a set of instructions used to configure dynamic scaling for the scalable resources in your application. AWS Auto Scaling creates target tracking scaling policies based on the scaling instructions in your scaling plan.</p>",
"DeleteScalingPlan": "<p>Deletes the specified scaling plan.</p>",
"DescribeScalingPlanResources": "<p>Describes the scalable resources in the specified scaling plan.</p>",
"DescribeScalingPlans": "<p>Describes the specified scaling plans or all of your scaling plans.</p>"
"DescribeScalingPlans": "<p>Describes the specified scaling plans or all of your scaling plans.</p>",
"UpdateScalingPlan": "<p>Updates the scaling plan for the specified scaling plan.</p> <p>You cannot update a scaling plan if it is in the process of being created, updated, or deleted.</p>"
},
"shapes": {
"ApplicationSource": {
"base": "<p>Represents an application source.</p>",
"refs": {
"ApplicationSources$member": null,
"CreateScalingPlanRequest$ApplicationSource": "<p>The source for the application.</p>",
"ScalingPlan$ApplicationSource": "<p>The application source.</p>"
"CreateScalingPlanRequest$ApplicationSource": "<p>A CloudFormation stack or set of tags. You can create one scaling plan per application source.</p>",
"ScalingPlan$ApplicationSource": "<p>The application source.</p>",
"UpdateScalingPlanRequest$ApplicationSource": "<p>A CloudFormation stack or set of tags.</p>"
}
},
"ApplicationSources": {
@ -223,7 +225,7 @@
"ResourceLabel": {
"base": null,
"refs": {
"PredefinedScalingMetricSpecification$ResourceLabel": "<p>Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is <code>ALBRequestCountPerTarget</code> and there is a target group attached to the Auto Scaling group, Spot Fleet request, or ECS service.</p> <p>The format is app/&lt;load-balancer-name&gt;/&lt;load-balancer-id&gt;/targetgroup/&lt;target-group-name&gt;/&lt;target-group-id&gt;, where:</p> <ul> <li> <p>app/&lt;load-balancer-name&gt;/&lt;load-balancer-id&gt; is the final portion of the load balancer ARN</p> </li> <li> <p>targetgroup/&lt;target-group-name&gt;/&lt;target-group-id&gt; is the final portion of the target group ARN.</p> </li> </ul>"
"PredefinedScalingMetricSpecification$ResourceLabel": "<p>Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is <code>ALBRequestCountPerTarget</code> and there is a target group for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.</p> <p>The format is app/&lt;load-balancer-name&gt;/&lt;load-balancer-id&gt;/targetgroup/&lt;target-group-name&gt;/&lt;target-group-id&gt;, where:</p> <ul> <li> <p>app/&lt;load-balancer-name&gt;/&lt;load-balancer-id&gt; is the final portion of the load balancer ARN</p> </li> <li> <p>targetgroup/&lt;target-group-name&gt;/&lt;target-group-id&gt; is the final portion of the target group ARN.</p> </li> </ul>"
}
},
"ScalableDimension": {
@ -243,7 +245,8 @@
"base": null,
"refs": {
"CreateScalingPlanRequest$ScalingInstructions": "<p>The scaling instructions.</p>",
"ScalingPlan$ScalingInstructions": "<p>The scaling instructions.</p>"
"ScalingPlan$ScalingInstructions": "<p>The scaling instructions.</p>",
"UpdateScalingPlanRequest$ScalingInstructions": "<p>The scaling instructions.</p>"
}
},
"ScalingMetricType": {
@ -261,12 +264,13 @@
"ScalingPlanName": {
"base": null,
"refs": {
"CreateScalingPlanRequest$ScalingPlanName": "<p>The name of the scaling plan.</p>",
"CreateScalingPlanRequest$ScalingPlanName": "<p>The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.</p>",
"DeleteScalingPlanRequest$ScalingPlanName": "<p>The name of the scaling plan.</p>",
"DescribeScalingPlanResourcesRequest$ScalingPlanName": "<p>The name of the scaling plan.</p>",
"ScalingPlan$ScalingPlanName": "<p>The name of the scaling plan.</p>",
"ScalingPlanNames$member": null,
"ScalingPlanResource$ScalingPlanName": "<p>The name of the scaling plan.</p>"
"ScalingPlanResource$ScalingPlanName": "<p>The name of the scaling plan.</p>",
"UpdateScalingPlanRequest$ScalingPlanName": "<p>The name of the scaling plan.</p>"
}
},
"ScalingPlanNames": {
@ -301,7 +305,8 @@
"DescribeScalingPlanResourcesRequest$ScalingPlanVersion": "<p>The version of the scaling plan.</p>",
"DescribeScalingPlansRequest$ScalingPlanVersion": "<p>The version of the scaling plan. If you specify a scaling plan version, you must also specify a scaling plan name.</p>",
"ScalingPlan$ScalingPlanVersion": "<p>The version of the scaling plan.</p>",
"ScalingPlanResource$ScalingPlanVersion": "<p>The version of the scaling plan.</p>"
"ScalingPlanResource$ScalingPlanVersion": "<p>The version of the scaling plan.</p>",
"UpdateScalingPlanRequest$ScalingPlanVersion": "<p>The version number.</p>"
}
},
"ScalingPlans": {
@ -335,6 +340,24 @@
"ScalingPlanResource$ServiceNamespace": "<p>The namespace of the AWS service.</p>"
}
},
"TagFilter": {
"base": "<p>Represents a tag.</p>",
"refs": {
"TagFilters$member": null
}
},
"TagFilters": {
"base": null,
"refs": {
"ApplicationSource$TagFilters": "<p>A set of tags (up to 50).</p>"
}
},
"TagValues": {
"base": null,
"refs": {
"TagFilter$Values": "<p>The tag values (0 to 20).</p>"
}
},
"TargetTrackingConfiguration": {
"base": "<p>Represents a target tracking scaling policy.</p>",
"refs": {
@ -351,9 +374,20 @@
"TimestampType": {
"base": null,
"refs": {
"ScalingPlan$StatusStartTime": "<p>The Unix timestamp when the scaling plan entered the current status.</p>",
"ScalingPlan$CreationTime": "<p>The Unix timestamp when the scaling plan was created.</p>"
}
},
"UpdateScalingPlanRequest": {
"base": null,
"refs": {
}
},
"UpdateScalingPlanResponse": {
"base": null,
"refs": {
}
},
"ValidationException": {
"base": "<p>An exception was thrown for a validation issue. Review the parameters provided.</p>",
"refs": {
@ -366,6 +400,18 @@
"ScalingPlan$StatusMessage": "<p>A simple message about the current status of the scaling plan.</p>",
"ScalingPlanResource$ScalingStatusMessage": "<p>A simple message about the current scaling status of the resource.</p>"
}
},
"XmlStringMaxLen128": {
"base": null,
"refs": {
"TagFilter$Key": "<p>The tag key.</p>"
}
},
"XmlStringMaxLen256": {
"base": null,
"refs": {
"TagValues$member": null
}
}
}
}

19
vendor/github.com/aws/aws-sdk-go/models/apis/batch/2016-08-10/api-2.json generated vendored
View File

@ -7,6 +7,7 @@
"protocol":"rest-json",
"serviceAbbreviation":"AWS Batch",
"serviceFullName":"AWS Batch",
"serviceId":"Batch",
"signatureVersion":"v4",
"uid":"batch-2016-08-10"
},
@ -655,7 +656,8 @@
"type":{"shape":"String"},
"parameters":{"shape":"ParametersMap"},
"retryStrategy":{"shape":"RetryStrategy"},
"containerProperties":{"shape":"ContainerProperties"}
"containerProperties":{"shape":"ContainerProperties"},
"timeout":{"shape":"JobTimeout"}
}
},
"JobDefinitionList":{
@ -702,7 +704,8 @@
"jobDefinition":{"shape":"String"},
"parameters":{"shape":"ParametersMap"},
"container":{"shape":"ContainerDetail"},
"arrayProperties":{"shape":"ArrayPropertiesDetail"}
"arrayProperties":{"shape":"ArrayPropertiesDetail"},
"timeout":{"shape":"JobTimeout"}
}
},
"JobDetailList":{
@ -766,6 +769,12 @@
"type":"list",
"member":{"shape":"JobSummary"}
},
"JobTimeout":{
"type":"structure",
"members":{
"attemptDurationSeconds":{"shape":"Integer"}
}
},
"KeyValuePair":{
"type":"structure",
"members":{
@ -820,7 +829,8 @@
"type":{"shape":"JobDefinitionType"},
"parameters":{"shape":"ParametersMap"},
"containerProperties":{"shape":"ContainerProperties"},
"retryStrategy":{"shape":"RetryStrategy"}
"retryStrategy":{"shape":"RetryStrategy"},
"timeout":{"shape":"JobTimeout"}
}
},
"RegisterJobDefinitionResponse":{
@ -871,7 +881,8 @@
"jobDefinition":{"shape":"String"},
"parameters":{"shape":"ParametersMap"},
"containerOverrides":{"shape":"ContainerOverrides"},
"retryStrategy":{"shape":"RetryStrategy"}
"retryStrategy":{"shape":"RetryStrategy"},
"timeout":{"shape":"JobTimeout"}
}
},
"SubmitJobResponse":{

24
vendor/github.com/aws/aws-sdk-go/models/apis/batch/2016-08-10/docs-2.json generated vendored
View File

@ -312,7 +312,7 @@
"ContainerOverrides$vcpus": "<p>The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.</p>",
"ContainerOverrides$memory": "<p>The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.</p>",
"ContainerProperties$vcpus": "<p>The number of vCPUs reserved for the container. This parameter maps to <code>CpuShares</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.</p>",
"ContainerProperties$memory": "<p>The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to <code>Memory</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--memory</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. You must specify at least 4 MiB of memory for a job.</p>",
"ContainerProperties$memory": "<p>The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to <code>Memory</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--memory</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. You must specify at least 4 MiB of memory for a job.</p> <note> <p>If you are trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see <a href=\"http://docs.aws.amazon.com/batch/latest/userguide/memory-management.html\">Memory Management</a> in the <i>AWS Batch User Guide</i>.</p> </note>",
"ContainerSummary$exitCode": "<p>The exit code to return upon completion.</p>",
"CreateJobQueueRequest$priority": "<p>The priority of the job queue. Job queues with a higher priority (or a higher integer value for the <code>priority</code> parameter) are evaluated first when associated with same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of <code>10</code> is given scheduling preference over a job queue with a priority value of <code>1</code>.</p>",
"DescribeComputeEnvironmentsRequest$maxResults": "<p>The maximum number of cluster results returned by <code>DescribeComputeEnvironments</code> in paginated output. When this parameter is used, <code>DescribeComputeEnvironments</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeComputeEnvironments</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>DescribeComputeEnvironments</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>",
@ -320,6 +320,7 @@
"DescribeJobQueuesRequest$maxResults": "<p>The maximum number of results returned by <code>DescribeJobQueues</code> in paginated output. When this parameter is used, <code>DescribeJobQueues</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>DescribeJobQueues</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>DescribeJobQueues</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>",
"JobDefinition$revision": "<p>The revision of the job definition.</p>",
"JobQueueDetail$priority": "<p>The priority of the job queue. </p>",
"JobTimeout$attemptDurationSeconds": "<p>The time duration in seconds (measured from the job attempt's <code>startedAt</code> timestamp) after which AWS Batch terminates your jobs if they have not finished.</p>",
"ListJobsRequest$maxResults": "<p>The maximum number of results returned by <code>ListJobs</code> in paginated output. When this parameter is used, <code>ListJobs</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListJobs</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListJobs</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>",
"RegisterJobDefinitionResponse$revision": "<p>The revision of the job definition.</p>",
"RetryStrategy$attempts": "<p>The number of times to move a job to the <code>RUNNABLE</code> status. You may specify between 1 and 10 attempts. If the value of <code>attempts</code> is greater than one, the job is retried if it fails until it has moved to <code>RUNNABLE</code> that many times.</p>",
@ -417,6 +418,15 @@
"ListJobsResponse$jobSummaryList": "<p>A list of job summaries that match the request.</p>"
}
},
"JobTimeout": {
"base": "<p>An object representing a job timeout configuration.</p>",
"refs": {
"JobDefinition$timeout": "<p>The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished.</p>",
"JobDetail$timeout": "<p>The timeout configuration for the job. </p>",
"RegisterJobDefinitionRequest$timeout": "<p>The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it is not retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that is specified during a <a>SubmitJob</a> operation overrides the timeout configuration defined here. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html\">Job Timeouts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>",
"SubmitJobRequest$timeout": "<p>The timeout configuration for this <a>SubmitJob</a> operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it is not retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html\">Job Timeouts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"KeyValuePair": {
"base": "<p>A key-value pair object.</p>",
"refs": {
@ -436,11 +446,11 @@
"Long": {
"base": null,
"refs": {
"AttemptDetail$startedAt": "<p>The Unix time stamp for when the attempt was started (when the attempt transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state).</p>",
"AttemptDetail$stoppedAt": "<p>The Unix time stamp for when the attempt was stopped (when the attempt transitioned from the <code>RUNNING</code> state to a terminal state, such as <code>SUCCEEDED</code> or <code>FAILED</code>).</p>",
"JobDetail$createdAt": "<p>The Unix time stamp for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the <code>SUBMITTED</code> state (at the time <a>SubmitJob</a> was called). For array child jobs, this is when the child job was spawned by its parent and entered the <code>PENDING</code> state.</p>",
"JobDetail$startedAt": "<p>The Unix time stamp for when the job was started (when the job transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state).</p>",
"JobDetail$stoppedAt": "<p>The Unix time stamp for when the job was stopped (when the job transitioned from the <code>RUNNING</code> state to a terminal state, such as <code>SUCCEEDED</code> or <code>FAILED</code>).</p>",
"AttemptDetail$startedAt": "<p>The Unix time stamp (in seconds and milliseconds) for when the attempt was started (when the attempt transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state).</p>",
"AttemptDetail$stoppedAt": "<p>The Unix time stamp (in seconds and milliseconds) for when the attempt was stopped (when the attempt transitioned from the <code>RUNNING</code> state to a terminal state, such as <code>SUCCEEDED</code> or <code>FAILED</code>).</p>",
"JobDetail$createdAt": "<p>The Unix time stamp (in seconds and milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the <code>SUBMITTED</code> state (at the time <a>SubmitJob</a> was called). For array child jobs, this is when the child job was spawned by its parent and entered the <code>PENDING</code> state.</p>",
"JobDetail$startedAt": "<p>The Unix time stamp (in seconds and milliseconds) for when the job was started (when the job transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state).</p>",
"JobDetail$stoppedAt": "<p>The Unix time stamp (in seconds and milliseconds) for when the job was stopped (when the job transitioned from the <code>RUNNING</code> state to a terminal state, such as <code>SUCCEEDED</code> or <code>FAILED</code>).</p>",
"JobSummary$createdAt": "<p>The Unix time stamp for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the <code>SUBMITTED</code> state (at the time <a>SubmitJob</a> was called). For array child jobs, this is when the child job was spawned by its parent and entered the <code>PENDING</code> state.</p>",
"JobSummary$startedAt": "<p>The Unix time stamp for when the job was started (when the job transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state).</p>",
"JobSummary$stoppedAt": "<p>The Unix time stamp for when the job was stopped (when the job transitioned from the <code>RUNNING</code> state to a terminal state, such as <code>SUCCEEDED</code> or <code>FAILED</code>).</p>"
@ -483,7 +493,7 @@
"refs": {
"JobDefinition$retryStrategy": "<p>The retry strategy to use for failed jobs that are submitted with this job definition.</p>",
"JobDetail$retryStrategy": "<p>The retry strategy to use for this job if an attempt fails.</p>",
"RegisterJobDefinitionRequest$retryStrategy": "<p>The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that is specified during a <a>SubmitJob</a> operation overrides the retry strategy defined here.</p>",
"RegisterJobDefinitionRequest$retryStrategy": "<p>The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that is specified during a <a>SubmitJob</a> operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it is not retried. </p>",
"SubmitJobRequest$retryStrategy": "<p>The retry strategy to use for failed jobs from this <a>SubmitJob</a> operation. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.</p>"
}
},

11
vendor/github.com/aws/aws-sdk-go/models/apis/batch/2016-08-10/smoke.json generated vendored Normal file
View File

@ -0,0 +1,11 @@
{
"version": 1,
"defaultRegion": "us-west-2",
"testCases": [
{
"operationName": "DescribeComputeEnvironments",
"input": {},
"errorExpectedFromService": false
}
]
}

198
vendor/github.com/aws/aws-sdk-go/models/apis/ce/2017-10-25/api-2.json generated vendored
View File

@ -26,7 +26,8 @@
{"shape":"LimitExceededException"},
{"shape":"BillExpirationException"},
{"shape":"DataUnavailableException"},
{"shape":"InvalidNextTokenException"}
{"shape":"InvalidNextTokenException"},
{"shape":"RequestChangedException"}
]
},
"GetDimensionValues":{
@ -40,7 +41,9 @@
"errors":[
{"shape":"LimitExceededException"},
{"shape":"BillExpirationException"},
{"shape":"InvalidNextTokenException"}
{"shape":"DataUnavailableException"},
{"shape":"InvalidNextTokenException"},
{"shape":"RequestChangedException"}
]
},
"GetReservationCoverage":{
@ -57,6 +60,20 @@
{"shape":"InvalidNextTokenException"}
]
},
"GetReservationPurchaseRecommendation":{
"name":"GetReservationPurchaseRecommendation",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetReservationPurchaseRecommendationRequest"},
"output":{"shape":"GetReservationPurchaseRecommendationResponse"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"DataUnavailableException"},
{"shape":"InvalidNextTokenException"}
]
},
"GetReservationUtilization":{
"name":"GetReservationUtilization",
"http":{
@ -82,11 +99,17 @@
"errors":[
{"shape":"LimitExceededException"},
{"shape":"BillExpirationException"},
{"shape":"InvalidNextTokenException"}
{"shape":"DataUnavailableException"},
{"shape":"InvalidNextTokenException"},
{"shape":"RequestChangedException"}
]
}
},
"shapes":{
"AccountScope":{
"type":"string",
"enum":["PAYER"]
},
"AttributeType":{"type":"string"},
"AttributeValue":{"type":"string"},
"Attributes":{
@ -197,6 +220,25 @@
"type":"list",
"member":{"shape":"DimensionValuesWithAttributes"}
},
"EC2InstanceDetails":{
"type":"structure",
"members":{
"Family":{"shape":"GenericString"},
"InstanceType":{"shape":"GenericString"},
"Region":{"shape":"GenericString"},
"AvailabilityZone":{"shape":"GenericString"},
"Platform":{"shape":"GenericString"},
"Tenancy":{"shape":"GenericString"},
"CurrentGeneration":{"shape":"GenericBoolean"},
"SizeFlexEligible":{"shape":"GenericBoolean"}
}
},
"EC2Specification":{
"type":"structure",
"members":{
"OfferingClass":{"shape":"OfferingClass"}
}
},
"Entity":{"type":"string"},
"ErrorMessage":{"type":"string"},
"Estimated":{"type":"boolean"},
@ -214,6 +256,8 @@
"type":"list",
"member":{"shape":"Expression"}
},
"GenericBoolean":{"type":"boolean"},
"GenericString":{"type":"string"},
"GetCostAndUsageRequest":{
"type":"structure",
"members":{
@ -281,6 +325,29 @@
"NextPageToken":{"shape":"NextPageToken"}
}
},
"GetReservationPurchaseRecommendationRequest":{
"type":"structure",
"required":["Service"],
"members":{
"AccountId":{"shape":"GenericString"},
"Service":{"shape":"GenericString"},
"AccountScope":{"shape":"AccountScope"},
"LookbackPeriodInDays":{"shape":"LookbackPeriodInDays"},
"TermInYears":{"shape":"TermInYears"},
"PaymentOption":{"shape":"PaymentOption"},
"ServiceSpecification":{"shape":"ServiceSpecification"},
"PageSize":{"shape":"NonNegativeInteger"},
"NextPageToken":{"shape":"NextPageToken"}
}
},
"GetReservationPurchaseRecommendationResponse":{
"type":"structure",
"members":{
"Metadata":{"shape":"ReservationPurchaseRecommendationMetadata"},
"Recommendations":{"shape":"ReservationPurchaseRecommendations"},
"NextPageToken":{"shape":"NextPageToken"}
}
},
"GetReservationUtilizationRequest":{
"type":"structure",
"required":["TimePeriod"],
@ -362,6 +429,13 @@
"type":"list",
"member":{"shape":"Group"}
},
"InstanceDetails":{
"type":"structure",
"members":{
"EC2InstanceDetails":{"shape":"EC2InstanceDetails"},
"RDSInstanceDetails":{"shape":"RDSInstanceDetails"}
}
},
"InvalidNextTokenException":{
"type":"structure",
"members":{
@ -381,6 +455,14 @@
},
"exception":true
},
"LookbackPeriodInDays":{
"type":"string",
"enum":[
"SEVEN_DAYS",
"THIRTY_DAYS",
"SIXTY_DAYS"
]
},
"MetricAmount":{"type":"string"},
"MetricName":{"type":"string"},
"MetricNames":{
@ -401,9 +483,48 @@
"value":{"shape":"MetricValue"}
},
"NextPageToken":{"type":"string"},
"NonNegativeInteger":{
"type":"integer",
"min":0
},
"OfferingClass":{
"type":"string",
"enum":[
"STANDARD",
"CONVERTIBLE"
]
},
"OnDemandHours":{"type":"string"},
"PageSize":{"type":"integer"},
"PaymentOption":{
"type":"string",
"enum":[
"NO_UPFRONT",
"PARTIAL_UPFRONT",
"ALL_UPFRONT"
]
},
"PurchasedHours":{"type":"string"},
"RDSInstanceDetails":{
"type":"structure",
"members":{
"Family":{"shape":"GenericString"},
"InstanceType":{"shape":"GenericString"},
"Region":{"shape":"GenericString"},
"DatabaseEngine":{"shape":"GenericString"},
"DeploymentOption":{"shape":"GenericString"},
"LicenseModel":{"shape":"GenericString"},
"CurrentGeneration":{"shape":"GenericBoolean"},
"SizeFlexEligible":{"shape":"GenericBoolean"}
}
},
"RequestChangedException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"ReservationAggregates":{
"type":"structure",
"members":{
@ -426,6 +547,64 @@
},
"ReservationGroupKey":{"type":"string"},
"ReservationGroupValue":{"type":"string"},
"ReservationPurchaseRecommendation":{
"type":"structure",
"members":{
"AccountScope":{"shape":"AccountScope"},
"LookbackPeriodInDays":{"shape":"LookbackPeriodInDays"},
"TermInYears":{"shape":"TermInYears"},
"PaymentOption":{"shape":"PaymentOption"},
"ServiceSpecification":{"shape":"ServiceSpecification"},
"RecommendationDetails":{"shape":"ReservationPurchaseRecommendationDetails"},
"RecommendationSummary":{"shape":"ReservationPurchaseRecommendationSummary"}
}
},
"ReservationPurchaseRecommendationDetail":{
"type":"structure",
"members":{
"InstanceDetails":{"shape":"InstanceDetails"},
"RecommendedNumberOfInstancesToPurchase":{"shape":"GenericString"},
"RecommendedNormalizedUnitsToPurchase":{"shape":"GenericString"},
"MinimumNumberOfInstancesUsedPerHour":{"shape":"GenericString"},
"MinimumNormalizedUnitsUsedPerHour":{"shape":"GenericString"},
"MaximumNumberOfInstancesUsedPerHour":{"shape":"GenericString"},
"MaximumNormalizedUnitsUsedPerHour":{"shape":"GenericString"},
"AverageNumberOfInstancesUsedPerHour":{"shape":"GenericString"},
"AverageNormalizedUnitsUsedPerHour":{"shape":"GenericString"},
"AverageUtilization":{"shape":"GenericString"},
"EstimatedBreakEvenInMonths":{"shape":"GenericString"},
"CurrencyCode":{"shape":"GenericString"},
"EstimatedMonthlySavingsAmount":{"shape":"GenericString"},
"EstimatedMonthlySavingsPercentage":{"shape":"GenericString"},
"EstimatedMonthlyOnDemandCost":{"shape":"GenericString"},
"EstimatedReservationCostForLookbackPeriod":{"shape":"GenericString"},
"UpfrontCost":{"shape":"GenericString"},
"RecurringStandardMonthlyCost":{"shape":"GenericString"}
}
},
"ReservationPurchaseRecommendationDetails":{
"type":"list",
"member":{"shape":"ReservationPurchaseRecommendationDetail"}
},
"ReservationPurchaseRecommendationMetadata":{
"type":"structure",
"members":{
"RecommendationId":{"shape":"GenericString"},
"GenerationTimestamp":{"shape":"GenericString"}
}
},
"ReservationPurchaseRecommendationSummary":{
"type":"structure",
"members":{
"TotalEstimatedMonthlySavingsAmount":{"shape":"GenericString"},
"TotalEstimatedMonthlySavingsPercentage":{"shape":"GenericString"},
"CurrencyCode":{"shape":"GenericString"}
}
},
"ReservationPurchaseRecommendations":{
"type":"list",
"member":{"shape":"ReservationPurchaseRecommendation"}
},
"ReservationUtilizationGroup":{
"type":"structure",
"members":{
@ -454,6 +633,12 @@
"member":{"shape":"ResultByTime"}
},
"SearchString":{"type":"string"},
"ServiceSpecification":{
"type":"structure",
"members":{
"EC2Specification":{"shape":"EC2Specification"}
}
},
"TagKey":{"type":"string"},
"TagList":{
"type":"list",
@ -466,6 +651,13 @@
"Values":{"shape":"Values"}
}
},
"TermInYears":{
"type":"string",
"enum":[
"ONE_YEAR",
"THREE_YEARS"
]
},
"TotalActualHours":{"type":"string"},
"TotalRunningHours":{"type":"string"},
"UnusedHours":{"type":"string"},

252
vendor/github.com/aws/aws-sdk-go/models/apis/ce/2017-10-25/docs-2.json generated vendored
View File

@ -1,14 +1,22 @@
{
"version": "2.0",
"service": "<p>The Cost Explorer API allows you to programmatically query your cost and usage data. You can query for aggregated data such as total monthly costs or total daily usage. You can also query for granular data, such as the number of daily write operations for DynamoDB database tables in your production environment. </p> <p>Service Endpoint</p> <p>The Cost Explorer API provides the following endpoint:</p> <ul> <li> <p>https://ce.us-east-1.amazonaws.com</p> </li> </ul>",
"service": "<p>The Cost Explorer API allows you to programmatically query your cost and usage data. You can query for aggregated data such as total monthly costs or total daily usage. You can also query for granular data, such as the number of daily write operations for Amazon DynamoDB database tables in your production environment. </p> <p>Service Endpoint</p> <p>The Cost Explorer API provides the following endpoint:</p> <ul> <li> <p>https://ce.us-east-1.amazonaws.com</p> </li> </ul> <p>For information about costs associated with the Cost Explorer API, see <a href=\"https://aws.amazon.com/aws-cost-management/pricing/\">AWS Cost Management Pricing</a>.</p>",
"operations": {
"GetCostAndUsage": "<p>Retrieve cost and usage metrics for your account. You can specify which cost and usage-related metric, such as <code>BlendedCosts</code> or <code>UsageQuantity</code>, that you want the request to return. You can also filter and group your data by various dimensions, such as <code>SERVICE</code> or <code>AZ</code>, in a specific time range. See the <code>GetDimensionValues</code> action for a complete list of the valid dimensions. Master accounts in an organization have access to all member accounts.</p>",
"GetDimensionValues": "<p>You can use <code>GetDimensionValues</code> to retrieve all available filter values for a specific filter over a period of time. You can search the dimension values for an arbitrary string. </p>",
"GetReservationCoverage": "<p>Retrieve the reservation coverage for your account. An organization's master account has access to the associated member accounts. For any time period, you can filter data about reservation usage by the following dimensions. </p> <ul> <li> <p>AZ</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>TENANCY</p> </li> </ul> <p>To determine valid values for a dimension, use the <code>GetDimensionValues</code> operation. </p>",
"GetReservationUtilization": "<p>You can retrieve the Reservation utilization for your account. Master accounts in an organization have access to their associated member accounts. You can filter data by dimensions in a time period. You can use <code>GetDimensionValues</code> to determine the possible dimension values. Currently, you can group only by <code>SUBSCRIPTION_ID</code>. </p>",
"GetTags": "<p>You can query for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string. </p>"
"GetCostAndUsage": "<p>Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as <code>BlendedCosts</code> or <code>UsageQuantity</code>, that you want the request to return. You can also filter and group your data by various dimensions, such as <code>SERVICE</code> or <code>AZ</code>, in a specific time range. For a complete list of valid dimensions, see the <code> <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetDimensionValues.html\">GetDimensionValues</a> </code> operation. Master accounts in an organization in AWS Organizations have access to all member accounts.</p>",
"GetDimensionValues": "<p>Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string. </p>",
"GetReservationCoverage": "<p>Retrieves the reservation coverage for your account. This allows you to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation. An organization's master account can see the coverage of the associated member accounts. For any time period, you can filter data about reservation usage by the following dimensions:</p> <ul> <li> <p>AZ</p> </li> <li> <p>CACHE_ENGINE</p> </li> <li> <p>DATABASE_ENGINE</p> </li> <li> <p>DEPLOYMENT_OPTION</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>OPERATING_SYSTEM</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>SERVICE</p> </li> <li> <p>TAG</p> </li> <li> <p>TENANCY</p> </li> </ul> <p>To determine valid values for a dimension, use the <code>GetDimensionValues</code> operation. </p>",
"GetReservationPurchaseRecommendation": "<p>Gets recommendations for which reservations to purchase. These recommendations could help you reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.</p> <p>AWS generates your recommendations by identifying your On-Demand usage during a specific time period and collecting your usage into categories that are eligible for a reservation. After AWS has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of RI to purchase to maximize your estimated savings. </p> <p>For example, AWS automatically aggregates your EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region and recommends that you buy size-flexible regional reservations to apply to the c4 family usage. AWS recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible RI. AWS also shows the equal number of normalized units so that you can purchase any instance size that you want. For this example, your RI recommendation would be for <code>c4.large</code>, because that is the smallest size instance in the c4 instance family.</p>",
"GetReservationUtilization": "<p>Retrieves the reservation utilization for your account. Master accounts in an organization have access to member accounts. You can filter data by dimensions in a time period. You can use <code>GetDimensionValues</code> to determine the possible dimension values. Currently, you can group only by <code>SUBSCRIPTION_ID</code>. </p>",
"GetTags": "<p>Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string. </p>"
},
"shapes": {
"AccountScope": {
"base": null,
"refs": {
"GetReservationPurchaseRecommendationRequest$AccountScope": "<p>The account scope that you want recommendations for. The only valid value is <code>Payer</code>. This means that AWS includes the master account and any member accounts when it calculates its recommendations.</p>",
"ReservationPurchaseRecommendation$AccountScope": "<p>The account scope that AWS recommends that you purchase this instance for. For example, you can purchase this reservation for an entire organization in AWS Organizations.</p>"
}
},
"AttributeType": {
"base": null,
"refs": {
@ -37,19 +45,19 @@
"Context": {
"base": null,
"refs": {
"GetDimensionValuesRequest$Context": "<p>The context for the call to <code>GetDimensionValues</code>. This can be <code>RESERVATIONS</code> or <code>COST_AND_USAGE</code>. The default value is <code>COST_AND_USAGE</code>. If the context is set to <code>RESERVATIONS</code>, the resulting dimension values can be used in the <code>GetReservationUtilization</code> action. If the context is set to <code>COST_AND_USAGE</code>, the resulting dimension values can be used in the <code>GetCostAndUsage</code> operation.</p> <p>If you set the context to <code>CostAndUsage</code>, you can use the following dimensions for searching:</p> <ul> <li> <p>AZ - The Availability Zone. An example is us-east-1a.</p> </li> <li> <p>INSTANCE_TYPE - The type of EC2 instance. An example is m4.xlarge.</p> </li> <li> <p>LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account</p> </li> <li> <p>OPERATION - The action performed. Examples include RunInstance and CreateBucket.</p> </li> <li> <p>PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include: On Demand Instances and Standard Reserved Instances</p> </li> <li> <p>SERVICE - The AWS service such as DynamoDB.</p> </li> <li> <p>USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues action includes a unit attribute, examples of which include GB and Hrs.</p> </li> <li> <p>USAGE_TYPE_GROUP - The grouping of common usage types. An example is EC2: CloudWatch – Alarms. The response for this action includes a unit attribute.</p> </li> <li> <p>RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.</p> </li> </ul> <p>If you set the context to <code>RESERVATIONS</code>, you can use the following dimensions for searching:</p> <ul> <li> <p>AZ - The Availability Zone. An example is us-east-1a.</p> </li> <li> <p>INSTANCE_TYPE - The type of EC2 instance. An example is m4.xlarge.</p> </li> <li> <p>LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account</p> </li> <li> <p>PLATFORM - The operating system. Examples are Windows or Linux.</p> </li> <li> <p>REGION - The AWS region.</p> </li> <li> <p>SCOPE - The scope of a reserved instance (RI). Values are regional or a single availability zone.</p> </li> <li> <p>TENANCY - The tenancy of a resource. Examples are shared or dedicated.</p> </li> </ul>"
"GetDimensionValuesRequest$Context": "<p>The context for the call to <code>GetDimensionValues</code>. This can be <code>RESERVATIONS</code> or <code>COST_AND_USAGE</code>. The default value is <code>COST_AND_USAGE</code>. If the context is set to <code>RESERVATIONS</code>, the resulting dimension values can be used in the <code>GetReservationUtilization</code> operation. If the context is set to <code>COST_AND_USAGE</code> the resulting dimension values can be used in the <code>GetCostAndUsage</code> operation.</p> <p>If you set the context to <code>COST_AND_USAGE</code>, you can use the following dimensions for searching:</p> <ul> <li> <p>AZ - The Availability Zone. An example is <code>us-east-1a</code>.</p> </li> <li> <p>DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.</p> </li> <li> <p>INSTANCE_TYPE - The type of EC2 instance. An example is <code>m4.xlarge</code>.</p> </li> <li> <p>LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.</p> </li> <li> <p>LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.</p> </li> <li> <p>OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.</p> </li> <li> <p>OPERATION - The action performed. Examples include <code>RunInstance</code> and <code>CreateBucket</code>.</p> </li> <li> <p>PLATFORM - The EC2 operating system. Examples are Windows or Linux.</p> </li> <li> <p>PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.</p> </li> <li> <p>SERVICE - The AWS service such as Amazon DynamoDB.</p> </li> <li> <p>USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the <code>GetDimensionValues</code> operation includes a unit attribute. Examples include GB and Hrs.</p> </li> <li> <p>USAGE_TYPE_GROUP - The grouping of common usage types. An example is EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.</p> </li> <li> <p>RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.</p> </li> </ul> <p>If you set the context to <code>RESERVATIONS</code>, you can use the following dimensions for searching:</p> <ul> <li> <p>AZ - The Availability Zone. An example is <code>us-east-1a</code>.</p> </li> <li> <p>CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.</p> </li> <li> <p>DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are <code>SingleAZ</code> and <code>MultiAZ</code>.</p> </li> <li> <p>INSTANCE_TYPE - The type of EC2 instance. An example is <code>m4.xlarge</code>.</p> </li> <li> <p>LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.</p> </li> <li> <p>PLATFORM - The EC2 operating system. Examples are Windows or Linux.</p> </li> <li> <p>REGION - The AWS Region.</p> </li> <li> <p>SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.</p> </li> <li> <p>TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).</p> </li> <li> <p>TENANCY - The tenancy of a resource. Examples are shared or dedicated.</p> </li> </ul>"
}
},
"Coverage": {
"base": "<p>The amount of instance usage that a reservation covered.</p>",
"refs": {
"CoverageByTime$Total": "<p>The total reservation coverage, in hours.</p>",
"GetReservationCoverageResponse$Total": "<p>The total amount of instance usage covered by a reservation.</p>",
"GetReservationCoverageResponse$Total": "<p>The total amount of instance usage that is covered by a reservation.</p>",
"ReservationCoverageGroup$Coverage": "<p>How much instance usage this group of reservations covered.</p>"
}
},
"CoverageByTime": {
"base": "<p>Reservation coverage, in hours.</p>",
"base": "<p>Reservation coverage for a specified period, in hours.</p>",
"refs": {
"CoveragesByTime$member": null
}
@ -63,7 +71,7 @@
"CoverageHoursPercentage": {
"base": null,
"refs": {
"CoverageHours$CoverageHoursPercentage": "<p>The percentage of instance hours covered by a reservation.</p>"
"CoverageHours$CoverageHoursPercentage": "<p>The percentage of instance hours that are covered by a reservation.</p>"
}
},
"CoveragesByTime": {
@ -83,8 +91,8 @@
"CoverageByTime$TimePeriod": "<p>The period over which this coverage was used.</p>",
"GetCostAndUsageRequest$TimePeriod": "<p>Sets the start and end dates for retrieving AWS costs. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>.</p>",
"GetDimensionValuesRequest$TimePeriod": "<p>The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>.</p>",
"GetReservationCoverageRequest$TimePeriod": "<p>The start and end dates of the period for which you want to retrieve data about reservation coverage. You can retrieve data for a maximum of 13 months-the last 12 months and the current month. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>. </p>",
"GetReservationUtilizationRequest$TimePeriod": "<p>Sets the start and end dates for retrieving reserve instance (RI) utilization. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>. </p>",
"GetReservationCoverageRequest$TimePeriod": "<p>The start and end dates of the period for which you want to retrieve data about reservation coverage. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>. </p>",
"GetReservationUtilizationRequest$TimePeriod": "<p>Sets the start and end dates for retrieving Reserved Instance (RI) utilization. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>. </p>",
"GetTagsRequest$TimePeriod": "<p>The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>.</p>",
"ResultByTime$TimePeriod": "<p>The time period covered by a result.</p>",
"UtilizationByTime$TimePeriod": "<p>The period of time over which this utilization was used.</p>"
@ -94,7 +102,7 @@
"base": null,
"refs": {
"DimensionValues$Key": "<p>The names of the metadata types that you can use to filter and group your results. For example, <code>AZ</code> returns a list of Availability Zones.</p>",
"GetDimensionValuesRequest$Dimension": "<p>The name of the dimension. Each <code>Dimensions</code>is available for different a <code>Context</code>. For more information, see <code>Context</code>.</p>"
"GetDimensionValuesRequest$Dimension": "<p>The name of the dimension. Each <code>Dimension</code> is available for different a <code>Context</code>. For more information, see <code>Context</code>.</p>"
}
},
"DimensionValues": {
@ -112,7 +120,19 @@
"DimensionValuesWithAttributesList": {
"base": null,
"refs": {
"GetDimensionValuesResponse$DimensionValues": "<p>The filters that you used to filter your request. Some dimensions are available only for a specific context:</p> <p>If you set the context to <code>CostAndUsage</code>, you can use the following dimensions for searching:</p> <ul> <li> <p>AZ - The Availability Zone. An example is us-east-1a.</p> </li> <li> <p>INSTANCE_TYPE - The type of EC2 instance. An example is m4.xlarge.</p> </li> <li> <p>LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account</p> </li> <li> <p>OPERATION - The action performed. Examples include RunInstance and CreateBucket.</p> </li> <li> <p>PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include: On Demand Instances and Standard Reserved Instances</p> </li> <li> <p>SERVICE - The AWS service such as DynamoDB.</p> </li> <li> <p>USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues action includes a unit attribute, examples of which include GB and Hrs.</p> </li> <li> <p>USAGE_TYPE_GROUP - The grouping of common usage types. An example is EC2: CloudWatch – Alarms. The response for this action includes a unit attribute.</p> </li> <li> <p>RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.</p> </li> </ul> <p>If you set the context to <code>RESERVATIONS</code>, you can use the following dimensions for searching:</p> <ul> <li> <p>AZ - The Availability Zone. An example is us-east-1a.</p> </li> <li> <p>INSTANCE_TYPE - The type of EC2 instance. An example is m4.xlarge.</p> </li> <li> <p>LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account</p> </li> <li> <p>PLATFORM - The operating system. Examples are Windows or Linux.</p> </li> <li> <p>REGION - The AWS region.</p> </li> <li> <p>SCOPE - The scope of a reserved instance (RI). Values are regional or a single availability zone.</p> </li> <li> <p>TENANCY - The tenancy of a resource. Examples are shared or dedicated.</p> </li> </ul>"
"GetDimensionValuesResponse$DimensionValues": "<p>The filters that you used to filter your request. Some dimensions are available only for a specific context:</p> <p>If you set the context to <code>COST_AND_USAGE</code>, you can use the following dimensions for searching:</p> <ul> <li> <p>AZ - The Availability Zone. An example is <code>us-east-1a</code>.</p> </li> <li> <p>DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.</p> </li> <li> <p>INSTANCE_TYPE - The type of EC2 instance. An example is <code>m4.xlarge</code>.</p> </li> <li> <p>LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.</p> </li> <li> <p>LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.</p> </li> <li> <p>OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.</p> </li> <li> <p>OPERATION - The action performed. Examples include <code>RunInstance</code> and <code>CreateBucket</code>.</p> </li> <li> <p>PLATFORM - The EC2 operating system. Examples are Windows or Linux.</p> </li> <li> <p>PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.</p> </li> <li> <p>SERVICE - The AWS service such as Amazon DynamoDB.</p> </li> <li> <p>USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the <code>GetDimensionValues</code> operation includes a unit attribute. Examples include GB and Hrs.</p> </li> <li> <p>USAGE_TYPE_GROUP - The grouping of common usage types. An example is EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.</p> </li> <li> <p>RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.</p> </li> </ul> <p>If you set the context to <code>RESERVATIONS</code>, you can use the following dimensions for searching:</p> <ul> <li> <p>AZ - The Availability Zone. An example is <code>us-east-1a</code>.</p> </li> <li> <p>CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.</p> </li> <li> <p>DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are <code>SingleAZ</code> and <code>MultiAZ</code>.</p> </li> <li> <p>INSTANCE_TYPE - The type of EC2 instance. An example is <code>m4.xlarge</code>.</p> </li> <li> <p>LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.</p> </li> <li> <p>PLATFORM - The EC2 operating system. Examples are Windows or Linux.</p> </li> <li> <p>REGION - The AWS Region.</p> </li> <li> <p>SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.</p> </li> <li> <p>TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).</p> </li> <li> <p>TENANCY - The tenancy of a resource. Examples are shared or dedicated.</p> </li> </ul>"
}
},
"EC2InstanceDetails": {
"base": "<p>Details about the EC2 instances that AWS recommends that you purchase.</p>",
"refs": {
"InstanceDetails$EC2InstanceDetails": "<p>The EC2 instances that AWS recommends that you purchase.</p>"
}
},
"EC2Specification": {
"base": "<p>The EC2 hardware specifications that you want AWS to provide recommendations for.</p>",
"refs": {
"ServiceSpecification$EC2Specification": "<p>The EC2 hardware specifications that you want AWS to provide recommendations for.</p>"
}
},
"Entity": {
@ -127,32 +147,83 @@
"BillExpirationException$Message": null,
"DataUnavailableException$Message": null,
"InvalidNextTokenException$Message": null,
"LimitExceededException$Message": null
"LimitExceededException$Message": null,
"RequestChangedException$Message": null
}
},
"Estimated": {
"base": null,
"refs": {
"ResultByTime$Estimated": "<p>Whether or not this result is estimated.</p>"
"ResultByTime$Estimated": "<p>Whether this result is estimated.</p>"
}
},
"Expression": {
"base": "<p>Use <code>Expression</code> to filter by cost or by usage. There are two patterns: </p> <ul> <li> <p>Simple dimension values - You can set the dimension name and values for the filters that you plan to use. For example, you can filter for <code>INSTANCE_TYPE==m4.xlarge OR INSTANCE_TYPE==c4.large</code>. The <code>Expression</code> for that looks like this.</p> <p> <code>{ \"Dimensions\": { \"Key\": \"INSTANCE_TYPE\", \"Values\": [ \"m4.xlarge\", “c4.large” ] } }</code> </p> <p>The list of dimension values are OR'd together to retrieve cost or usage data. You can create <code>Expression</code> and <code>DimensionValues</code> objects using either <code>with*</code> methods or <code>set*</code> methods in multiple lines. </p> </li> <li> <p>Compound dimension values with logical operations - You can use multiple <code>Expression</code> types and the logical operators <code>AND/OR/NOT</code> to create a list of one or more <code>Expression</code> objects. This allows you to filter on more advanced options. For example, you can filter on <code>((INSTANCE_TYPE == m4.large OR INSTANCE_TYPE == m3.large) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)</code>. The <code>Expression</code> for that looks like this.</p> <p> <code>{ \"And\": [ {\"Or\": [ {\"Dimensions\": { \"Key\": \"INSTANCE_TYPE\", \"Values\": [ \"m4.x.large\", \"c4.large\" ] }}, {\"Tag\": { \"Key\": \"TagName\", \"Values\": [\"Value1\"] } } ]}, {\"Not\": {\"dimensions\": { \"Key\": \"USAGE_TYPE\", \"Values\": [\"DataTransfer\"] }}} ] } </code> </p> <note> <p>Because each <code>Expression</code> can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that will create an error.</p> </note> <p> <code> { \"And\": [ ... ], \"DimensionValues\": { \"Dimension\": \"USAGE_TYPE\", \"Values\": [ \"DataTransfer\" ] } } </code> </p> </li> </ul>",
"base": "<p>Use <code>Expression</code> to filter by cost or by usage. There are two patterns: </p> <ul> <li> <p>Simple dimension values - You can set the dimension name and values for the filters that you plan to use. For example, you can filter for <code>INSTANCE_TYPE==m4.xlarge OR INSTANCE_TYPE==c4.large</code>. The <code>Expression</code> for that looks like this:</p> <p> <code>{ \"Dimensions\": { \"Key\": \"INSTANCE_TYPE\", \"Values\": [ \"m4.xlarge\", “c4.large” ] } }</code> </p> <p>The list of dimension values are OR'd together to retrieve cost or usage data. You can create <code>Expression</code> and <code>DimensionValues</code> objects using either <code>with*</code> methods or <code>set*</code> methods in multiple lines. </p> </li> <li> <p>Compound dimension values with logical operations - You can use multiple <code>Expression</code> types and the logical operators <code>AND/OR/NOT</code> to create a list of one or more <code>Expression</code> objects. This allows you to filter on more advanced options. For example, you can filter on <code>((INSTANCE_TYPE == m4.large OR INSTANCE_TYPE == m3.large) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)</code>. The <code>Expression</code> for that looks like this:</p> <p> <code>{ \"And\": [ {\"Or\": [ {\"Dimensions\": { \"Key\": \"INSTANCE_TYPE\", \"Values\": [ \"m4.x.large\", \"c4.large\" ] }}, {\"Tag\": { \"Key\": \"TagName\", \"Values\": [\"Value1\"] } } ]}, {\"Not\": {\"dimensions\": { \"Key\": \"USAGE_TYPE\", \"Values\": [\"DataTransfer\"] }}} ] } </code> </p> <note> <p>Because each <code>Expression</code> can have only one operator, the service returns an error if more than one is specified. The following example shows an <code>Expression</code> object that creates an error.</p> </note> <p> <code> { \"And\": [ ... ], \"DimensionValues\": { \"Dimension\": \"USAGE_TYPE\", \"Values\": [ \"DataTransfer\" ] } } </code> </p> </li> </ul>",
"refs": {
"Expression$Not": "<p>Return results that don't match <code>Dimension</code>.</p>",
"Expression$Not": "<p>Return results that don't match a <code>Dimension</code> object.</p>",
"Expressions$member": null,
"GetCostAndUsageRequest$Filter": "<p>Filters AWS costs by different dimensions. For example, you can specify <code>SERVICE</code> and <code>LINKED_ACCOUNT</code> and get the costs associated with that account's usage of that service. You can nest <code>Expression</code> objects to define any combination of dimension filters. For more information, see <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a>. </p>",
"GetReservationCoverageRequest$Filter": "<p>Filters utilization data by dimensions. You can filter by the following dimensions.</p> <ul> <li> <p>AZ</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>TENANCY</p> </li> </ul> <p> <code>GetReservationCoverage</code> uses the same <code>Expression</code> object as the other operations, but only <code>AND</code> is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.</p>",
"GetReservationUtilizationRequest$Filter": "<p>Filters utilization data by using different dimensions. <code>GetReservationUtilization</code> uses the same <code>Expression</code> object as the other operations, but only <code>AND</code> is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.</p>"
"GetCostAndUsageRequest$Filter": "<p>Filters AWS costs by different dimensions. For example, you can specify <code>SERVICE</code> and <code>LINKED_ACCOUNT</code> and get the costs that are associated with that account's usage of that service. You can nest <code>Expression</code> objects to define any combination of dimension filters. For more information, see <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a>. </p>",
"GetReservationCoverageRequest$Filter": "<p>Filters utilization data by dimensions. You can filter by the following dimensions:</p> <ul> <li> <p>AZ</p> </li> <li> <p>CACHE_ENGINE</p> </li> <li> <p>DATABASE_ENGINE</p> </li> <li> <p>DEPLOYMENT_OPTION</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>OPERATING_SYSTEM</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>SERVICE</p> </li> <li> <p>TAG</p> </li> <li> <p>TENANCY</p> </li> </ul> <p> <code>GetReservationCoverage</code> uses the same <code> <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> </code> object as the other operations, but only <code>AND</code> is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.</p>",
"GetReservationUtilizationRequest$Filter": "<p>Filters utilization data by dimensions. You can filter by the following dimensions:</p> <ul> <li> <p>AZ</p> </li> <li> <p>CACHE_ENGINE</p> </li> <li> <p>DATABASE_ENGINE</p> </li> <li> <p>DEPLOYMENT_OPTION</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>OPERATING_SYSTEM</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>SERVICE</p> </li> <li> <p>SCOPE</p> </li> <li> <p>TENANCY</p> </li> </ul> <p> <code>GetReservationUtilization</code> uses the same <code> <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> </code> object as the other operations, but only <code>AND</code> is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.</p>"
}
},
"Expressions": {
"base": null,
"refs": {
"Expression$Or": "<p>Return results that match either <code>Dimension</code>.</p>",
"Expression$Or": "<p>Return results that match either <code>Dimension</code> object.</p>",
"Expression$And": "<p>Return results that match both <code>Dimension</code> objects.</p>"
}
},
"GenericBoolean": {
"base": null,
"refs": {
"EC2InstanceDetails$CurrentGeneration": "<p>Whether the recommendation is for a current generation instance. </p>",
"EC2InstanceDetails$SizeFlexEligible": "<p>Whether the recommended reservation is size flexible.</p>",
"RDSInstanceDetails$CurrentGeneration": "<p>Whether the recommendation is for a current generation instance. </p>",
"RDSInstanceDetails$SizeFlexEligible": "<p>Whether the recommended reservation is size flexible.</p>"
}
},
"GenericString": {
"base": null,
"refs": {
"EC2InstanceDetails$Family": "<p>The instance family of the recommended reservation.</p>",
"EC2InstanceDetails$InstanceType": "<p>The type of instance that AWS recommends.</p>",
"EC2InstanceDetails$Region": "<p>The AWS Region of the recommended reservation.</p>",
"EC2InstanceDetails$AvailabilityZone": "<p>The Availability Zone of the recommended reservation.</p>",
"EC2InstanceDetails$Platform": "<p>The platform of the recommended reservation. The platform is the specific combination of operating system, license model, and software on an instance.</p>",
"EC2InstanceDetails$Tenancy": "<p>Whether the recommended reservation is dedicated or shared.</p>",
"GetReservationPurchaseRecommendationRequest$AccountId": "<p>The account ID that is associated with the recommendation. </p>",
"GetReservationPurchaseRecommendationRequest$Service": "<p>The specific service that you want recommendations for.</p>",
"RDSInstanceDetails$Family": "<p>The instance family of the recommended reservation.</p>",
"RDSInstanceDetails$InstanceType": "<p>The type of instance that AWS recommends.</p>",
"RDSInstanceDetails$Region": "<p>The AWS Region of the recommended reservation.</p>",
"RDSInstanceDetails$DatabaseEngine": "<p>The database engine that the recommended reservation supports.</p>",
"RDSInstanceDetails$DeploymentOption": "<p>Whether the recommendation is for a reservation in a single availability zone or a reservation with a backup in a second availability zone.</p>",
"RDSInstanceDetails$LicenseModel": "<p>The license model that the recommended reservation supports.</p>",
"ReservationPurchaseRecommendationDetail$RecommendedNumberOfInstancesToPurchase": "<p>The number of instances that AWS recommends that you purchase.</p>",
"ReservationPurchaseRecommendationDetail$RecommendedNormalizedUnitsToPurchase": "<p>The number of normalized units that AWS recommends that you purchase.</p>",
"ReservationPurchaseRecommendationDetail$MinimumNumberOfInstancesUsedPerHour": "<p>The minimum number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.</p>",
"ReservationPurchaseRecommendationDetail$MinimumNormalizedUnitsUsedPerHour": "<p>The minimum number of hours that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.</p>",
"ReservationPurchaseRecommendationDetail$MaximumNumberOfInstancesUsedPerHour": "<p>The maximum number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.</p>",
"ReservationPurchaseRecommendationDetail$MaximumNormalizedUnitsUsedPerHour": "<p>The maximum number of normalized units that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.</p>",
"ReservationPurchaseRecommendationDetail$AverageNumberOfInstancesUsedPerHour": "<p>The average number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.</p>",
"ReservationPurchaseRecommendationDetail$AverageNormalizedUnitsUsedPerHour": "<p>The average number of normalized units that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.</p>",
"ReservationPurchaseRecommendationDetail$AverageUtilization": "<p>The average utilization of your instances. AWS uses this to calculate your recommended reservation purchases.</p>",
"ReservationPurchaseRecommendationDetail$EstimatedBreakEvenInMonths": "<p>How long AWS estimates that it takes for this instance to start saving you money, in months.</p>",
"ReservationPurchaseRecommendationDetail$CurrencyCode": "<p>The currency code that AWS used to calculate the costs for this instance.</p>",
"ReservationPurchaseRecommendationDetail$EstimatedMonthlySavingsAmount": "<p>How much AWS estimates that this specific recommendation could save you in a month.</p>",
"ReservationPurchaseRecommendationDetail$EstimatedMonthlySavingsPercentage": "<p>How much AWS estimates that this specific recommendation could save you in a month, as a percentage of your overall costs.</p>",
"ReservationPurchaseRecommendationDetail$EstimatedMonthlyOnDemandCost": "<p>How much AWS estimates that you spend on On-Demand Instances in a month.</p>",
"ReservationPurchaseRecommendationDetail$EstimatedReservationCostForLookbackPeriod": "<p>How much AWS estimates that you would have spent for all usage during the specified historical period if you had had a reservation.</p>",
"ReservationPurchaseRecommendationDetail$UpfrontCost": "<p>How much purchasing this instance costs you upfront.</p>",
"ReservationPurchaseRecommendationDetail$RecurringStandardMonthlyCost": "<p>How much purchasing this instance costs you on a monthly basis.</p>",
"ReservationPurchaseRecommendationMetadata$RecommendationId": "<p>The ID for this specific recommendation.</p>",
"ReservationPurchaseRecommendationMetadata$GenerationTimestamp": "<p>The time stamp for when AWS made this recommendation.</p>",
"ReservationPurchaseRecommendationSummary$TotalEstimatedMonthlySavingsAmount": "<p>The total amount that AWS estimates that this recommendation could save you in a month.</p>",
"ReservationPurchaseRecommendationSummary$TotalEstimatedMonthlySavingsPercentage": "<p>The total amount that AWS estimates that this recommendation could save you in a month, as a percentage of your costs.</p>",
"ReservationPurchaseRecommendationSummary$CurrencyCode": "<p>The currency code used for this recommendation.</p>"
}
},
"GetCostAndUsageRequest": {
"base": null,
"refs": {
@ -174,7 +245,7 @@
}
},
"GetReservationCoverageRequest": {
"base": "<p>You can query for how much of your instance usage was covered by a reservation.</p>",
"base": "<p>You can use the following request parameters to query for how much of your instance usage is covered by a reservation.</p>",
"refs": {
}
},
@ -183,6 +254,16 @@
"refs": {
}
},
"GetReservationPurchaseRecommendationRequest": {
"base": null,
"refs": {
}
},
"GetReservationPurchaseRecommendationResponse": {
"base": null,
"refs": {
}
},
"GetReservationUtilizationRequest": {
"base": null,
"refs": {
@ -207,8 +288,8 @@
"base": null,
"refs": {
"GetCostAndUsageRequest$Granularity": "<p>Sets the AWS cost granularity to <code>MONTHLY</code> or <code>DAILY</code>. If <code>Granularity</code> isn't set, the response object doesn't include the <code>Granularity</code>, either <code>MONTHLY</code> or <code>DAILY</code>. </p>",
"GetReservationCoverageRequest$Granularity": "<p>The granularity of the AWS cost data for the reservation. Valid values are <code>MONTHLY</code> and <code>DAILY</code>.</p> <p>If <code>GroupBy</code> is set, <code>Granularity</code> can't be set. If <code>Granularity</code> isn't set, the response object doesn't include the <code>Granularity</code>, either <code>MONTHLY</code> or <code>DAILY</code>.</p>",
"GetReservationUtilizationRequest$Granularity": "<p>If <code>GroupBy</code> is set, <code>Granularity</code> can't be set. If <code>Granularity</code> isn't set, the response object doesn't include the <code>Granularity</code>, either <code>MONTHLY</code> or <code>DAILY</code>. If both <code>GroupBy</code> and <code>Granularity</code> aren't set, <code>GetReservationUtilization</code> defaults to <code>DAILY</code>.</p>"
"GetReservationCoverageRequest$Granularity": "<p>The granularity of the AWS cost data for the reservation. Valid values are <code>MONTHLY</code> and <code>DAILY</code>.</p> <p>If <code>GroupBy</code> is set, <code>Granularity</code> can't be set. If <code>Granularity</code> isn't set, the response object doesn't include <code>Granularity</code>, either <code>MONTHLY</code> or <code>DAILY</code>.</p>",
"GetReservationUtilizationRequest$Granularity": "<p>If <code>GroupBy</code> is set, <code>Granularity</code> can't be set. If <code>Granularity</code> isn't set, the response object doesn't include <code>Granularity</code>, either <code>MONTHLY</code> or <code>DAILY</code>. If both <code>GroupBy</code> and <code>Granularity</code> aren't set, <code>GetReservationUtilization</code> defaults to <code>DAILY</code>.</p>"
}
},
"Group": {
@ -238,9 +319,9 @@
"GroupDefinitions": {
"base": null,
"refs": {
"GetCostAndUsageRequest$GroupBy": "<p>You can group AWS costs using up to two different groups, either dimensions, tag keys, or both.</p> <p>When you group by tag key, you get all tag values, including empty strings.</p> <p>Valid values are <code>AZ</code>, <code>INSTANCE_TYPE</code>, <code>LINKED_ACCOUNT</code>, <code>OPERATION</code>, <code>PLATFORM</code>, <code>PURCHASE_TYPE</code>, <code>SERVICE</code>, <code>TAGS</code>, <code>TENANCY</code>, and <code>USAGE_TYPE</code>.</p>",
"GetCostAndUsageResponse$GroupDefinitions": "<p>The groups specified by the the <code>Filter</code> or <code>GroupBy</code> parameters in the request.</p>",
"GetReservationCoverageRequest$GroupBy": "<p>You can group the data by the following attributes. </p> <ul> <li> <p>AZ</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>TENANCY</p> </li> </ul>",
"GetCostAndUsageRequest$GroupBy": "<p>You can group AWS costs using up to two different groups, either dimensions, tag keys, or both.</p> <p>When you group by tag key, you get all tag values, including empty strings.</p> <p>Valid values are <code>AZ</code>, <code>INSTANCE_TYPE</code>, <code>LEGAL_ENTITY_NAME</code>, <code>LINKED_ACCOUNT</code>, <code>OPERATION</code>, <code>PLATFORM</code>, <code>PURCHASE_TYPE</code>, <code>SERVICE</code>, <code>TAGS</code>, <code>TENANCY</code>, and <code>USAGE_TYPE</code>.</p>",
"GetCostAndUsageResponse$GroupDefinitions": "<p>The groups that are specified by the <code>Filter</code> or <code>GroupBy</code> parameters in the request.</p>",
"GetReservationCoverageRequest$GroupBy": "<p>You can group the data by the following attributes:</p> <ul> <li> <p>AZ</p> </li> <li> <p>CACHE_ENGINE</p> </li> <li> <p>DATABASE_ENGINE</p> </li> <li> <p>DEPLOYMENT_OPTION</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>OPERATING_SYSTEM</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>TAG</p> </li> <li> <p>TENANCY</p> </li> </ul>",
"GetReservationUtilizationRequest$GroupBy": "<p>Groups only by <code>SUBSCRIPTION_ID</code>. Metadata is included.</p>"
}
},
@ -250,6 +331,12 @@
"ResultByTime$Groups": "<p>The groups that are included in this time period.</p>"
}
},
"InstanceDetails": {
"base": "<p>Details about the instances that AWS recommends that you purchase.</p>",
"refs": {
"ReservationPurchaseRecommendationDetail$InstanceDetails": "<p>Details about the instances that AWS recommends that you purchase.</p>"
}
},
"InvalidNextTokenException": {
"base": "<p>The pagination token is invalid. Try again without a pagination token.</p>",
"refs": {
@ -264,7 +351,7 @@
"Keys": {
"base": null,
"refs": {
"Group$Keys": "<p>The keys included in this group.</p>"
"Group$Keys": "<p>The keys that are included in this group.</p>"
}
},
"LimitExceededException": {
@ -272,6 +359,13 @@
"refs": {
}
},
"LookbackPeriodInDays": {
"base": null,
"refs": {
"GetReservationPurchaseRecommendationRequest$LookbackPeriodInDays": "<p>The number of previous days that you want AWS to consider when it calculates your recommendations.</p>",
"ReservationPurchaseRecommendation$LookbackPeriodInDays": "<p>How many days of previous usage that AWS takes into consideration when making this recommendation.</p>"
}
},
"MetricAmount": {
"base": null,
"refs": {
@ -288,7 +382,7 @@
"MetricNames": {
"base": null,
"refs": {
"GetCostAndUsageRequest$Metrics": "<p>Which metrics are returned in the query. For more information about blended and unblended rates, see <a href=\"https://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/\">Why does the \"blended\" annotation appear on some line items in my bill?</a>. </p> <p>Valid values are <code>BlendedCost</code>, <code>UnblendedCost</code>, and <code>UsageQuantity</code>.</p> <note> <p>If you return the <code>UsageQuantity</code> metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate <code>usageQuantity</code> across all of EC2, the results aren't meaningful because EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful <code>UsageQuantity</code> metrics, filter by <code>UsageType</code> or <code>UsageTypeGroups</code>. </p> </note>"
"GetCostAndUsageRequest$Metrics": "<p>Which metrics are returned in the query. For more information about blended and unblended rates, see <a href=\"https://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/\">Why does the \"blended\" annotation appear on some line items in my bill?</a>. </p> <p>Valid values are <code>BlendedCost</code>, <code>UnblendedCost</code>, and <code>UsageQuantity</code>.</p> <note> <p>If you return the <code>UsageQuantity</code> metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate <code>usageQuantity</code> across all of EC2, the results aren't meaningful because EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful <code>UsageQuantity</code> metrics, filter by <code>UsageType</code> or <code>UsageTypeGroups</code>. </p> </note> <p> <code>Metrics</code> is required for <code>GetCostAndUsage</code> requests.</p>"
}
},
"MetricUnit": {
@ -306,7 +400,7 @@
"Metrics": {
"base": null,
"refs": {
"Group$Metrics": "<p>The metrics included in this group.</p>",
"Group$Metrics": "<p>The metrics that are included in this group.</p>",
"ResultByTime$Total": "<p>The total amount of cost or usage accrued during the time period.</p>"
}
},
@ -319,16 +413,30 @@
"GetDimensionValuesResponse$NextPageToken": "<p>The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetReservationCoverageRequest$NextPageToken": "<p>The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetReservationCoverageResponse$NextPageToken": "<p>The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetReservationPurchaseRecommendationRequest$NextPageToken": "<p>The pagination token that indicates the next set of results that you want to retrieve.</p>",
"GetReservationPurchaseRecommendationResponse$NextPageToken": "<p>The pagination token for the next set of retrievable results.</p>",
"GetReservationUtilizationRequest$NextPageToken": "<p>The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetReservationUtilizationResponse$NextPageToken": "<p>The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetTagsRequest$NextPageToken": "<p>The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetTagsResponse$NextPageToken": "<p>The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>"
}
},
"NonNegativeInteger": {
"base": null,
"refs": {
"GetReservationPurchaseRecommendationRequest$PageSize": "<p>The number of recommendations that you want returned in a single response object.</p>"
}
},
"OfferingClass": {
"base": null,
"refs": {
"EC2Specification$OfferingClass": "<p>Whether you want a recommendation for standard or convertible reservations.</p>"
}
},
"OnDemandHours": {
"base": null,
"refs": {
"CoverageHours$OnDemandHours": "<p>The number of instance running hours covered by On-Demand Instances.</p>"
"CoverageHours$OnDemandHours": "<p>The number of instance running hours that are covered by On-Demand Instances.</p>"
}
},
"PageSize": {
@ -340,10 +448,28 @@
"GetTagsResponse$TotalSize": "<p>The total number of query results.</p>"
}
},
"PaymentOption": {
"base": null,
"refs": {
"GetReservationPurchaseRecommendationRequest$PaymentOption": "<p>The reservation purchase option that you want recommendations for.</p>",
"ReservationPurchaseRecommendation$PaymentOption": "<p>The payment option for the reservation. For example, <code>AllUpfront</code> or <code>NoUpfront</code>.</p>"
}
},
"PurchasedHours": {
"base": null,
"refs": {
"ReservationAggregates$PurchasedHours": "<p>How many RI hours you purchased.</p>"
"ReservationAggregates$PurchasedHours": "<p>How many RI hours that you purchased.</p>"
}
},
"RDSInstanceDetails": {
"base": "<p>Details about the RDS instances that AWS recommends that you purchase.</p>",
"refs": {
"InstanceDetails$RDSInstanceDetails": "<p>The RDS instances that AWS recommends that you purchase.</p>"
}
},
"RequestChangedException": {
"base": "<p>Your request parameters changed between pages. Try again with the old parameters or without a pagination token.</p>",
"refs": {
}
},
"ReservationAggregates": {
@ -363,7 +489,7 @@
"ReservationCoverageGroups": {
"base": null,
"refs": {
"CoverageByTime$Groups": "<p>The group of instances that a reservation covered.</p>"
"CoverageByTime$Groups": "<p>The groups of instances that are covered by a reservation.</p>"
}
},
"ReservationGroupKey": {
@ -378,6 +504,42 @@
"ReservationUtilizationGroup$Value": "<p>The value of a specific RI attribute.</p>"
}
},
"ReservationPurchaseRecommendation": {
"base": "<p>A specific reservation that AWS recommends for purchase.</p>",
"refs": {
"ReservationPurchaseRecommendations$member": null
}
},
"ReservationPurchaseRecommendationDetail": {
"base": "<p>Details about your recommended reservation purchase.</p>",
"refs": {
"ReservationPurchaseRecommendationDetails$member": null
}
},
"ReservationPurchaseRecommendationDetails": {
"base": null,
"refs": {
"ReservationPurchaseRecommendation$RecommendationDetails": "<p>Details about the recommended purchases.</p>"
}
},
"ReservationPurchaseRecommendationMetadata": {
"base": "<p>Information about this specific recommendation, such as the time stamp for when AWS made a specific recommendation.</p>",
"refs": {
"GetReservationPurchaseRecommendationResponse$Metadata": "<p>Information about this specific recommendation call, such as the time stamp for when Cost Explorer generated this recommendation.</p>"
}
},
"ReservationPurchaseRecommendationSummary": {
"base": "<p>A summary about this recommendation, such as the currency code, the amount that AWS estimates you could save, and the total amount of reservation to purchase.</p>",
"refs": {
"ReservationPurchaseRecommendation$RecommendationSummary": "<p>A summary about the recommended purchase.</p>"
}
},
"ReservationPurchaseRecommendations": {
"base": null,
"refs": {
"GetReservationPurchaseRecommendationResponse$Recommendations": "<p>Recommendations for reservations to purchase.</p>"
}
},
"ReservationUtilizationGroup": {
"base": "<p>A group of RIs that share a set of attributes.</p>",
"refs": {
@ -393,7 +555,7 @@
"ReservedHours": {
"base": null,
"refs": {
"CoverageHours$ReservedHours": "<p>The number of instance running hours covered by reservations.</p>"
"CoverageHours$ReservedHours": "<p>The number of instance running hours that are covered by reservations.</p>"
}
},
"ResultByTime": {
@ -405,7 +567,7 @@
"ResultsByTime": {
"base": null,
"refs": {
"GetCostAndUsageResponse$ResultsByTime": "<p>The time period covered by the results in the response.</p>"
"GetCostAndUsageResponse$ResultsByTime": "<p>The time period that is covered by the results in the response.</p>"
}
},
"SearchString": {
@ -415,6 +577,13 @@
"GetTagsRequest$SearchString": "<p>The value that you want to search for.</p>"
}
},
"ServiceSpecification": {
"base": "<p>Hardware specifications for the service that you want recommendations for.</p>",
"refs": {
"GetReservationPurchaseRecommendationRequest$ServiceSpecification": "<p>The hardware specifications for the service instances that you want recommendations for, such as standard or convertible EC2 instances.</p>",
"ReservationPurchaseRecommendation$ServiceSpecification": "<p>Hardware specifications for the service that you want recommendations for.</p>"
}
},
"TagKey": {
"base": null,
"refs": {
@ -434,6 +603,13 @@
"Expression$Tags": "<p>The specific <code>Tag</code> to use for <code>Expression</code>.</p>"
}
},
"TermInYears": {
"base": null,
"refs": {
"GetReservationPurchaseRecommendationRequest$TermInYears": "<p>The reservation term that you want recommendations for.</p>",
"ReservationPurchaseRecommendation$TermInYears": "<p>The term of the reservation that you want recommendations for, in years.</p>"
}
},
"TotalActualHours": {
"base": null,
"refs": {
@ -487,8 +663,8 @@
"YearMonthDay": {
"base": null,
"refs": {
"DateInterval$Start": "<p>The beginning of the time period that you want the usage and costs for. The start date is inclusive. For example, if <code>start</code> is <code>2017-01-01</code>, then the cost and usage data is retrieved starting at <code>2017-01-01</code> up to the end date.</p>",
"DateInterval$End": "<p>The end of the time period that you want the usage and costs for. The end date is exclusive. For example, if the <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from the start date but not including <code>2017-05-01</code>.</p>"
"DateInterval$Start": "<p>The beginning of the time period that you want the usage and costs for. The start date is inclusive. For example, if <code>start</code> is <code>2017-01-01</code>, AWS retrieves cost and usage data starting at <code>2017-01-01</code> up to the end date.</p>",
"DateInterval$End": "<p>The end of the time period that you want the usage and costs for. The end date is exclusive. For example, if <code>end</code> is <code>2017-05-01</code>, AWS retrieves cost and usage data from the start date up to, but not including, <code>2017-05-01</code>.</p>"
}
}
}

97
vendor/github.com/aws/aws-sdk-go/models/apis/clouddirectory/2016-05-10/api-2.json generated vendored
View File

@ -92,7 +92,6 @@
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"InvalidArnException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotPolicyException"}
]
@ -114,6 +113,7 @@
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"InvalidAttachmentException"},
{"shape":"ResourceNotFoundException"},
{"shape":"LinkNameAlreadyInUseException"},
{"shape":"IndexedAttributeMissingException"},
@ -199,7 +199,6 @@
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryAlreadyExistsException"},
{"shape":"InvalidArnException"},
{"shape":"ResourceNotFoundException"}
]
},
@ -265,7 +264,6 @@
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"InvalidArnException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetValidationException"},
{"shape":"LinkNameAlreadyInUseException"},
@ -456,7 +454,8 @@
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"}
{"shape":"ResourceNotFoundException"},
{"shape":"NotNodeException"}
]
},
"DetachPolicy":{
@ -476,7 +475,6 @@
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"InvalidArnException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotPolicyException"}
]
@ -598,6 +596,27 @@
{"shape":"FacetNotFoundException"}
]
},
"GetObjectAttributes":{
"name":"GetObjectAttributes",
"http":{
"method":"POST",
"requestUri":"/amazonclouddirectory/2017-01-11/object/attributes/get",
"responseCode":200
},
"input":{"shape":"GetObjectAttributesRequest"},
"output":{"shape":"GetObjectAttributesResponse"},
"errors":[
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"ResourceNotFoundException"},
{"shape":"FacetValidationException"}
]
},
"GetObjectInformation":{
"name":"GetObjectInformation",
"http":{
@ -814,10 +833,12 @@
{"shape":"InternalServiceException"},
{"shape":"InvalidArnException"},
{"shape":"RetryableConflictException"},
{"shape":"FacetValidationException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotIndexException"}
]
@ -839,7 +860,6 @@
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"InvalidArnException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"},
{"shape":"FacetValidationException"}
@ -862,7 +882,6 @@
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"InvalidArnException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"},
{"shape":"NotNodeException"}
@ -906,7 +925,6 @@
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"InvalidArnException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"},
{"shape":"CannotListParentOfRootException"}
@ -972,7 +990,6 @@
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"InvalidArnException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ResourceNotFoundException"},
{"shape":"NotPolicyException"}
@ -1076,7 +1093,6 @@
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"DirectoryNotEnabledException"},
{"shape":"InvalidArnException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ResourceNotFoundException"}
]
@ -1396,6 +1412,7 @@
"AttachPolicyRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"PolicyReference",
"ObjectReference"
],
@ -1636,10 +1653,7 @@
"type":"structure",
"required":[
"SchemaFacet",
"ObjectAttributeList",
"ParentReference",
"LinkName",
"BatchReferenceName"
"ObjectAttributeList"
],
"members":{
"SchemaFacet":{"shape":"SchemaFacetList"},
@ -1688,8 +1702,7 @@
"type":"structure",
"required":[
"ParentReference",
"LinkName",
"BatchReferenceName"
"LinkName"
],
"members":{
"ParentReference":{"shape":"ObjectReference"},
@ -1731,6 +1744,25 @@
"members":{
}
},
"BatchGetObjectAttributes":{
"type":"structure",
"required":[
"ObjectReference",
"SchemaFacet",
"AttributeNames"
],
"members":{
"ObjectReference":{"shape":"ObjectReference"},
"SchemaFacet":{"shape":"SchemaFacet"},
"AttributeNames":{"shape":"AttributeNameList"}
}
},
"BatchGetObjectAttributesResponse":{
"type":"structure",
"members":{
"Attributes":{"shape":"AttributeKeyAndValueList"}
}
},
"BatchGetObjectInformation":{
"type":"structure",
"required":["ObjectReference"],
@ -1945,6 +1977,7 @@
"ListAttachedIndices":{"shape":"BatchListAttachedIndices"},
"ListObjectParentPaths":{"shape":"BatchListObjectParentPaths"},
"GetObjectInformation":{"shape":"BatchGetObjectInformation"},
"GetObjectAttributes":{"shape":"BatchGetObjectAttributes"},
"ListObjectPolicies":{"shape":"BatchListObjectPolicies"},
"ListPolicyAttachments":{"shape":"BatchListPolicyAttachments"},
"LookupPolicy":{"shape":"BatchLookupPolicy"},
@ -2000,6 +2033,7 @@
"ListObjectAttributes":{"shape":"BatchListObjectAttributesResponse"},
"ListObjectChildren":{"shape":"BatchListObjectChildrenResponse"},
"GetObjectInformation":{"shape":"BatchGetObjectInformationResponse"},
"GetObjectAttributes":{"shape":"BatchGetObjectAttributesResponse"},
"ListAttachedIndices":{"shape":"BatchListAttachedIndicesResponse"},
"ListObjectParentPaths":{"shape":"BatchListObjectParentPathsResponse"},
"ListObjectPolicies":{"shape":"BatchListObjectPoliciesResponse"},
@ -2067,6 +2101,7 @@
"AccessDeniedException",
"InvalidAttachmentException",
"NotIndexException",
"NotNodeException",
"IndexedAttributeMissingException",
"ObjectAlreadyDetachedException",
"NotPolicyException",
@ -2729,6 +2764,36 @@
"Facet":{"shape":"Facet"}
}
},
"GetObjectAttributesRequest":{
"type":"structure",
"required":[
"DirectoryArn",
"ObjectReference",
"SchemaFacet",
"AttributeNames"
],
"members":{
"DirectoryArn":{
"shape":"Arn",
"location":"header",
"locationName":"x-amz-data-partition"
},
"ObjectReference":{"shape":"ObjectReference"},
"ConsistencyLevel":{
"shape":"ConsistencyLevel",
"location":"header",
"locationName":"x-amz-consistency-level"
},
"SchemaFacet":{"shape":"SchemaFacet"},
"AttributeNames":{"shape":"AttributeNameList"}
}
},
"GetObjectAttributesResponse":{
"type":"structure",
"members":{
"Attributes":{"shape":"AttributeKeyAndValueList"}
}
},
"GetObjectInformationRequest":{
"type":"structure",
"required":[

45
vendor/github.com/aws/aws-sdk-go/models/apis/clouddirectory/2016-05-10/docs-2.json generated vendored
View File

@ -2,7 +2,7 @@
"version": "2.0",
"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>",
"AddFacetToObject": "<p>Adds a new <a>Facet</a> to an object. An object can have more than one facet applied on it.</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>",
@ -30,6 +30,7 @@
"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>",
"GetObjectAttributes": "<p>Retrieves attributes within a facet that are associated with an object.</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>",
@ -40,7 +41,7 @@
"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 and indexed values attached to the index.</p>",
"ListIndex": "<p>Lists objects attached to the specified 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>",
@ -48,7 +49,7 @@
"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>Lists schema major versions for a published schema. If <code>SchemaArn</code> is provided, lists the minor version.</p>",
"ListPublishedSchemaArns": "<p>Lists the major version families of each published schema. If a major version ARN is provided as <code>SchemaArn</code>, the minor version revisions in that family are listed instead.</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>",
@ -132,6 +133,7 @@
"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>",
"GetObjectAttributesRequest$DirectoryArn": "<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides.</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>",
@ -246,8 +248,10 @@
"AddFacetToObjectRequest$ObjectAttributeList": "<p>Attributes on the facet that you are adding to the object.</p>",
"BatchAddFacetToObject$ObjectAttributeList": "<p>The attributes to set on the object.</p>",
"BatchCreateObject$ObjectAttributeList": "<p>An attribute map, which contains an attribute ARN as the key and attribute value as the map value.</p>",
"BatchGetObjectAttributesResponse$Attributes": "<p>The attribute values that are associated with an object.</p>",
"BatchListObjectAttributesResponse$Attributes": "<p>The attributes map that is associated with the object. <code>AttributeArn</code> is the key; attribute value is the value.</p>",
"CreateObjectRequest$ObjectAttributeList": "<p>The attribute map whose attribute ARN contains the key and attribute value as the map value.</p>",
"GetObjectAttributesResponse$Attributes": "<p>The attributes that are associated with the object.</p>",
"IndexAttachment$IndexedAttributes": "<p>The indexed attribute values.</p>",
"ListObjectAttributesResponse$Attributes": "<p>Attributes map that is associated with the object. <code>AttributeArn</code> is the key, and attribute value is the value.</p>"
}
@ -288,6 +292,8 @@
"AttributeNameList": {
"base": null,
"refs": {
"BatchGetObjectAttributes$AttributeNames": "<p>List of attribute names whose values will be retrieved.</p>",
"GetObjectAttributesRequest$AttributeNames": "<p>List of attribute names whose values will be retrieved.</p>",
"GetTypedLinkFacetInformationResponse$IdentityAttributeOrder": "<p>The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
"TypedLinkFacet$IdentityAttributeOrder": "<p>The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See <a>ListOutgoingTypedLinks</a> and <a>ListIncomingTypedLinks</a> for details.</p>",
"UpdateTypedLinkFacetRequest$IdentityAttributeOrder": "<p>The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to a typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
@ -437,6 +443,18 @@
"BatchWriteOperationResponse$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>"
}
},
"BatchGetObjectAttributes": {
"base": "<p>Retrieves attributes within a facet that are associated with an object inside an <a>BatchRead</a> operation. For more information, see <a>GetObjectAttributes</a> and <a>BatchReadRequest$Operations</a>.</p>",
"refs": {
"BatchReadOperation$GetObjectAttributes": "<p>Retrieves attributes within a facet that are associated with an object.</p>"
}
},
"BatchGetObjectAttributesResponse": {
"base": "<p>Represents the output of a <a>GetObjectAttributes</a> response operation.</p>",
"refs": {
"BatchReadSuccessfulResponse$GetObjectAttributes": "<p>Retrieves attributes within a facet that are associated with an object.</p>"
}
},
"BatchGetObjectInformation": {
"base": "<p>Retrieves metadata about an object inside a <a>BatchRead</a> operation. For more information, see <a>GetObjectInformation</a> and <a>BatchReadRequest$Operations</a>.</p>",
"refs": {
@ -736,6 +754,7 @@
"base": null,
"refs": {
"BatchReadRequest$ConsistencyLevel": "<p>Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.</p>",
"GetObjectAttributesRequest$ConsistencyLevel": "<p>The consistency level at which to retrieve the attributes on an object.</p>",
"GetObjectInformationRequest$ConsistencyLevel": "<p>The consistency level at which to retrieve the object information.</p>",
"ListAttachedIndicesRequest$ConsistencyLevel": "<p>The consistency level to use for this operation.</p>",
"ListIncomingTypedLinksRequest$ConsistencyLevel": "<p>The consistency level to execute the request at.</p>",
@ -950,7 +969,7 @@
}
},
"DirectoryNotEnabledException": {
"base": "<p>An operation can only operate on a directory that is not enabled.</p>",
"base": "<p>Operations are only permitted on enabled directories.</p>",
"refs": {
}
},
@ -1023,7 +1042,7 @@
}
},
"Facet": {
"base": "<p>A structure that contains <code>Name</code>, <code>ARN</code>, <code>Attributes</code>, <a>Rule</a>s, and <code>ObjectTypes</code>.</p>",
"base": "<p>A structure that contains <code>Name</code>, <code>ARN</code>, <code>Attributes</code>, <code> <a>Rule</a>s</code>, and <code>ObjectTypes</code>. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/whatarefacets.html\">Facets</a> for more information.</p>",
"refs": {
"GetFacetResponse$Facet": "<p>The <a>Facet</a> structure that is associated with the facet.</p>"
}
@ -1144,6 +1163,16 @@
"refs": {
}
},
"GetObjectAttributesRequest": {
"base": null,
"refs": {
}
},
"GetObjectAttributesResponse": {
"base": null,
"refs": {
}
},
"GetObjectInformationRequest": {
"base": null,
"refs": {
@ -1706,6 +1735,7 @@
"BatchDetachObject$ParentReference": "<p>Parent reference from which the object with the specified link name is detached.</p>",
"BatchDetachPolicy$PolicyReference": "<p>Reference that identifies the policy object.</p>",
"BatchDetachPolicy$ObjectReference": "<p>Reference that identifies the object whose policy object will be detached.</p>",
"BatchGetObjectAttributes$ObjectReference": "<p>Reference that identifies the object whose attributes will be retrieved.</p>",
"BatchGetObjectInformation$ObjectReference": "<p>A reference to the object.</p>",
"BatchListAttachedIndices$TargetReference": "<p>A reference to the object that has indices attached.</p>",
"BatchListIncomingTypedLinks$ObjectReference": "<p>The reference that identifies the object whose attributes will be listed.</p>",
@ -1727,6 +1757,7 @@
"DetachObjectRequest$ParentReference": "<p>The parent reference from which the object with the specified link name is detached.</p>",
"DetachPolicyRequest$PolicyReference": "<p>Reference that identifies the policy object.</p>",
"DetachPolicyRequest$ObjectReference": "<p>Reference that identifies the object whose policy object will be detached.</p>",
"GetObjectAttributesRequest$ObjectReference": "<p>Reference that identifies the object whose attributes will be retrieved.</p>",
"GetObjectInformationRequest$ObjectReference": "<p>A reference to the object.</p>",
"ListAttachedIndicesRequest$TargetReference": "<p>A reference to the object that has indices attached.</p>",
"ListIncomingTypedLinksRequest$ObjectReference": "<p>Reference that identifies the object whose attributes will be listed.</p>",
@ -1916,8 +1947,10 @@
"refs": {
"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>",
"BatchGetObjectAttributes$SchemaFacet": "<p>Identifier for the facet whose attributes will be retrieved. See <a>SchemaFacet</a> for details.</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>",
"GetObjectAttributesRequest$SchemaFacet": "<p>Identifier for the facet whose attributes will be retrieved. See <a>SchemaFacet</a> for details.</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. See <a>SchemaFacet</a> for details.</p>",
"SchemaFacetList$member": null
@ -2026,7 +2059,7 @@
}
},
"TypedAttributeValueRange": {
"base": "<p>A range of attribute values.</p>",
"base": "<p>A range of attribute values. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#rangefilters\">Range Filters</a>.</p>",
"refs": {
"ObjectAttributeRange$Range": "<p>The range of attribute values being selected.</p>",
"TypedLinkAttributeRange$Range": "<p>The range of attribute values that are being selected.</p>"

8
vendor/github.com/aws/aws-sdk-go/models/apis/cloudformation/2010-05-15/api-2.json generated vendored
View File

@ -888,6 +888,7 @@
"Parameters":{"shape":"Parameters"},
"Capabilities":{"shape":"Capabilities"},
"Tags":{"shape":"Tags"},
"AdministrationRoleARN":{"shape":"RoleARN"},
"ClientRequestToken":{
"shape":"ClientRequestToken",
"idempotencyToken":true
@ -1963,9 +1964,12 @@
"TemplateBody":{"shape":"TemplateBody"},
"Parameters":{"shape":"Parameters"},
"Capabilities":{"shape":"Capabilities"},
"Tags":{"shape":"Tags"}
"Tags":{"shape":"Tags"},
"StackSetARN":{"shape":"StackSetARN"},
"AdministrationRoleARN":{"shape":"RoleARN"}
}
},
"StackSetARN":{"type":"string"},
"StackSetId":{"type":"string"},
"StackSetName":{"type":"string"},
"StackSetNameOrId":{
@ -2003,6 +2007,7 @@
"Status":{"shape":"StackSetOperationStatus"},
"OperationPreferences":{"shape":"StackSetOperationPreferences"},
"RetainStacks":{"shape":"RetainStacksNullable"},
"AdministrationRoleARN":{"shape":"RoleARN"},
"CreationTimestamp":{"shape":"Timestamp"},
"EndTimestamp":{"shape":"Timestamp"}
}
@ -2323,6 +2328,7 @@
"Capabilities":{"shape":"Capabilities"},
"Tags":{"shape":"Tags"},
"OperationPreferences":{"shape":"StackSetOperationPreferences"},
"AdministrationRoleARN":{"shape":"RoleARN"},
"OperationId":{
"shape":"ClientRequestToken",
"idempotencyToken":true

22
vendor/github.com/aws/aws-sdk-go/models/apis/cloudformation/2010-05-15/docs-2.json generated vendored
View File

@ -114,7 +114,7 @@
"Arn": {
"base": null,
"refs": {
"RollbackTrigger$Arn": "<p>The Amazon Resource Name (ARN) of the rollback trigger.</p>"
"RollbackTrigger$Arn": "<p>The Amazon Resource Name (ARN) of the rollback trigger.</p> <p>If a specified trigger is missing, the entire stack operation fails and is rolled back. </p>"
}
},
"CancelUpdateStackInput": {
@ -799,7 +799,7 @@
"MonitoringTimeInMinutes": {
"base": null,
"refs": {
"RollbackConfiguration$MonitoringTimeInMinutes": "<p>The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources. If any of the alarms goes to ALERT state during the stack operation or this monitoring period, CloudFormation rolls back the entire stack operation. Then, for update operations, if the monitoring period expires without any alarms going to ALERT state CloudFormation proceeds to dispose of old resources as usual.</p> <p>If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources for update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CancelUpdateStack.html\">CancelUpdateStack</a>, for example) as necessary.</p> <p>If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.</p>"
"RollbackConfiguration$MonitoringTimeInMinutes": "<p>The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.</p> <p>The default is 0 minutes.</p> <p>If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CancelUpdateStack.html\">CancelUpdateStack</a>, for example) as necessary.</p> <p>If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.</p>"
}
},
"NameAlreadyExistsException": {
@ -1150,13 +1150,17 @@
"ContinueUpdateRollbackInput$RoleARN": "<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to roll back the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>",
"CreateChangeSetInput$RoleARN": "<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes when executing the change set. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>",
"CreateStackInput$RoleARN": "<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>",
"CreateStackSetInput$AdministrationRoleARN": "<p>The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. </p> <p>Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html\">Define Permissions for Multiple Administrators</a> in the <i>AWS CloudFormation User Guide</i>.</p>",
"DeleteStackInput$RoleARN": "<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to delete the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>",
"Stack$RoleARN": "<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role's credentials to make calls on your behalf.</p>",
"UpdateStackInput$RoleARN": "<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to update the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>"
"StackSet$AdministrationRoleARN": "<p>The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.</p> <p>Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html\">Define Permissions for Multiple Administrators</a> in the <i>AWS CloudFormation User Guide</i>.</p>",
"StackSetOperation$AdministrationRoleARN": "<p>The Amazon Resource Number (ARN) of the IAM role used to perform this stack set operation. </p> <p>Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html\">Define Permissions for Multiple Administrators</a> in the <i>AWS CloudFormation User Guide</i>.</p>",
"UpdateStackInput$RoleARN": "<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to update the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>",
"UpdateStackSetInput$AdministrationRoleARN": "<p>The Amazon Resource Number (ARN) of the IAM role to use to update this stack set.</p> <p>Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html\">Define Permissions for Multiple Administrators</a> in the <i>AWS CloudFormation User Guide</i>.</p> <p> If you specify a customized administrator role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized administrator role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.</p>"
}
},
"RollbackConfiguration": {
"base": "<p>Structure containing the rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.</p> <p>Rollback triggers enable you to have AWS CloudFormation monitor the state of your application during stack creation and updating, and to roll back that operation if the application breaches the threshold of any of the alarms you've specified. For each rollback trigger you create, you specify the Cloudwatch alarm that CloudFormation should monitor. CloudFormation monitors the specified alarms during the stack create or update operation, and for the specified amount of time after all resources have been deployed. If any of the alarms goes to ALERT state during the stack operation or the monitoring period, CloudFormation rolls back the entire stack operation. If the monitoring period expires without any alarms going to ALERT state, CloudFormation proceeds to dispose of old resources as usual.</p> <p>By default, CloudFormation only rolls back stack operations if an alarm goes to ALERT state, not INSUFFICIENT_DATA state. To have CloudFormation roll back the stack operation if an alarm goes to INSUFFICIENT_DATA state as well, edit the CloudWatch alarm to treat missing data as <code>breaching</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html\">Configuring How CloudWatch Alarms Treats Missing Data</a>.</p> <p>AWS CloudFormation does not monitor rollback triggers when it rolls back a stack during an update operation.</p>",
"base": "<p>Structure containing the rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.</p> <p>Rollback triggers enable you to have AWS CloudFormation monitor the state of your application during stack creation and updating, and to roll back that operation if the application breaches the threshold of any of the alarms you've specified. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-rollback-triggers.html\">Monitor and Roll Back Stack Operations</a>.</p>",
"refs": {
"CreateChangeSetInput$RollbackConfiguration": "<p>The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.</p>",
"CreateStackInput$RollbackConfiguration": "<p>The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.</p>",
@ -1166,7 +1170,7 @@
}
},
"RollbackTrigger": {
"base": "<p>A rollback trigger AWS CloudFormation monitors during creation and updating of stacks. If any of the alarms you specify goes to ALERT state during the stack operation or within the specified monitoring period afterwards, CloudFormation rolls back the entire stack operation. </p>",
"base": "<p>A rollback trigger AWS CloudFormation monitors during creation and updating of stacks. If any of the alarms you specify goes to ALARM state during the stack operation or within the specified monitoring period afterwards, CloudFormation rolls back the entire stack operation. </p>",
"refs": {
"RollbackTriggers$member": null
}
@ -1174,7 +1178,7 @@
"RollbackTriggers": {
"base": null,
"refs": {
"RollbackConfiguration$RollbackTriggers": "<p>The triggers to monitor during stack creation or update actions. </p> <p>By default, AWS CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:</p> <ul> <li> <p>If you don't specify this parameter, AWS CloudFormation uses the rollback triggers previously specified for this stack, if any.</p> </li> <li> <p>If you specify any rollback triggers using this parameter, you must specify all the triggers that you want used for this stack, even triggers you've specifed before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.</p> </li> <li> <p>If you specify an empty list, AWS CloudFormation removes all currently specified triggers.</p> </li> </ul> <p>If a specified Cloudwatch alarm is missing, the entire stack operation fails and is rolled back. </p>"
"RollbackConfiguration$RollbackTriggers": "<p>The triggers to monitor during stack creation or update actions. </p> <p>By default, AWS CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:</p> <ul> <li> <p>To use the rollback triggers previously specified for this stack, if any, don't specify this parameter.</p> </li> <li> <p>To specify new or updated rollback triggers, you must specify <i>all</i> the triggers that you want used for this stack, even triggers you've specifed before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.</p> </li> <li> <p>To remove all currently specified triggers, specify an empty list for this parameter.</p> </li> </ul> <p>If a specified trigger is missing, the entire stack operation fails and is rolled back. </p>"
}
},
"Scope": {
@ -1368,6 +1372,12 @@
"DescribeStackSetOutput$StackSet": "<p>The specified stack set.</p>"
}
},
"StackSetARN": {
"base": null,
"refs": {
"StackSet$StackSetARN": "<p>The Amazon Resource Number (ARN) of the stack set.</p>"
}
},
"StackSetId": {
"base": null,
"refs": {

3940
vendor/github.com/aws/aws-sdk-go/models/apis/cloudfront/2017-10-30/api-2.json generated vendored Normal file
View File

File diff suppressed because it is too large Load Diff

2058
vendor/github.com/aws/aws-sdk-go/models/apis/cloudfront/2017-10-30/docs-2.json generated vendored Normal file
View File

File diff suppressed because it is too large Load Diff

5
vendor/github.com/aws/aws-sdk-go/models/apis/cloudfront/2017-10-30/examples-1.json generated vendored Normal file
View File

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

32
vendor/github.com/aws/aws-sdk-go/models/apis/cloudfront/2017-10-30/paginators-1.json generated vendored Normal file
View File

@ -0,0 +1,32 @@
{
"pagination": {
"ListCloudFrontOriginAccessIdentities": {
"input_token": "Marker",
"limit_key": "MaxItems",
"more_results": "CloudFrontOriginAccessIdentityList.IsTruncated",
"output_token": "CloudFrontOriginAccessIdentityList.NextMarker",
"result_key": "CloudFrontOriginAccessIdentityList.Items"
},
"ListDistributions": {
"input_token": "Marker",
"limit_key": "MaxItems",
"more_results": "DistributionList.IsTruncated",
"output_token": "DistributionList.NextMarker",
"result_key": "DistributionList.Items"
},
"ListInvalidations": {
"input_token": "Marker",
"limit_key": "MaxItems",
"more_results": "InvalidationList.IsTruncated",
"output_token": "InvalidationList.NextMarker",
"result_key": "InvalidationList.Items"
},
"ListStreamingDistributions": {
"input_token": "Marker",
"limit_key": "MaxItems",
"more_results": "StreamingDistributionList.IsTruncated",
"output_token": "StreamingDistributionList.NextMarker",
"result_key": "StreamingDistributionList.Items"
}
}
}

20
vendor/github.com/aws/aws-sdk-go/models/apis/cloudfront/2017-10-30/smoke.json generated vendored Normal file
View File

@ -0,0 +1,20 @@
{
"version": 1,
"defaultRegion": "us-east-1",
"testCases": [
{
"operationName": "ListCloudFrontOriginAccessIdentities",
"input": {
"MaxItems": "1"
},
"errorExpectedFromService": false
},
{
"operationName": "GetDistribution",
"input": {
"Id": "fake-id"
},
"errorExpectedFromService": true
}
]
}

47
vendor/github.com/aws/aws-sdk-go/models/apis/cloudfront/2017-10-30/waiters-2.json generated vendored Normal file
View File

@ -0,0 +1,47 @@
{
"version": 2,
"waiters": {
"DistributionDeployed": {
"delay": 60,
"operation": "GetDistribution",
"maxAttempts": 25,
"description": "Wait until a distribution is deployed.",
"acceptors": [
{
"expected": "Deployed",
"matcher": "path",
"state": "success",
"argument": "Distribution.Status"
}
]
},
"InvalidationCompleted": {
"delay": 20,
"operation": "GetInvalidation",
"maxAttempts": 30,
"description": "Wait until an invalidation has completed.",
"acceptors": [
{
"expected": "Completed",
"matcher": "path",
"state": "success",
"argument": "Invalidation.Status"
}
]
},
"StreamingDistributionDeployed": {
"delay": 60,
"operation": "GetStreamingDistribution",
"maxAttempts": 25,
"description": "Wait until a streaming distribution is deployed.",
"acceptors": [
{
"expected": "Deployed",
"matcher": "path",
"state": "success",
"argument": "StreamingDistribution.Status"
}
]
}
}
}

36
vendor/github.com/aws/aws-sdk-go/models/apis/codebuild/2016-10-06/api-2.json generated vendored
View File

@ -200,6 +200,20 @@
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
]
},
"UpdateWebhook":{
"name":"UpdateWebhook",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateWebhookInput"},
"output":{"shape":"UpdateWebhookOutput"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"},
{"shape":"OAuthProviderException"}
]
}
},
"shapes":{
@ -405,7 +419,8 @@
"type":"structure",
"required":["projectName"],
"members":{
"projectName":{"shape":"ProjectName"}
"projectName":{"shape":"ProjectName"},
"branchFilter":{"shape":"String"}
}
},
"CreateWebhookOutput":{
@ -889,6 +904,21 @@
"project":{"shape":"Project"}
}
},
"UpdateWebhookInput":{
"type":"structure",
"required":["projectName"],
"members":{
"projectName":{"shape":"ProjectName"},
"branchFilter":{"shape":"String"},
"rotateSecret":{"shape":"Boolean"}
}
},
"UpdateWebhookOutput":{
"type":"structure",
"members":{
"webhook":{"shape":"Webhook"}
}
},
"ValueInput":{
"type":"string",
"max":255,
@ -908,7 +938,9 @@
"members":{
"url":{"shape":"NonEmptyString"},
"payloadUrl":{"shape":"NonEmptyString"},
"secret":{"shape":"NonEmptyString"}
"secret":{"shape":"NonEmptyString"},
"branchFilter":{"shape":"String"},
"lastModifiedSecret":{"shape":"Timestamp"}
}
},
"WrapperBoolean":{"type":"boolean"},

50
vendor/github.com/aws/aws-sdk-go/models/apis/codebuild/2016-10-06/docs-2.json generated vendored
View File

@ -1,6 +1,6 @@
{
"version": "2.0",
"service": "<fullname>AWS CodeBuild</fullname> <p>AWS CodeBuild is a fully managed build service in the cloud. AWS CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. AWS CodeBuild eliminates the need to provision, manage, and scale your own build servers. It provides prepackaged build environments for the most popular programming languages and build tools, such as Apache Maven, Gradle, and more. You can also fully customize build environments in AWS CodeBuild to use your own build tools. AWS CodeBuild scales automatically to meet peak build requests, and you pay only for the build time you consume. For more information about AWS CodeBuild, see the <i>AWS CodeBuild User Guide</i>.</p> <p>AWS CodeBuild supports these operations:</p> <ul> <li> <p> <code>BatchDeleteBuilds</code>: Deletes one or more builds.</p> </li> <li> <p> <code>BatchGetProjects</code>: Gets information about one or more build projects. A <i>build project</i> defines how AWS CodeBuild will run a build. This includes information such as where to get the source code to build, the build environment to use, the build commands to run, and where to store the build output. A <i>build environment</i> represents a combination of operating system, programming language runtime, and tools that AWS CodeBuild will use to run a build. Also, you can add tags to build projects to help manage your resources and costs.</p> </li> <li> <p> <code>CreateProject</code>: Creates a build project.</p> </li> <li> <p> <code>CreateWebhook</code>: For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository.</p> </li> <li> <p> <code>DeleteProject</code>: Deletes a build project.</p> </li> <li> <p> <code>DeleteWebhook</code>: For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, stops AWS CodeBuild from automatically rebuilding the source code every time a code change is pushed to the repository.</p> </li> <li> <p> <code>ListProjects</code>: Gets a list of build project names, with each build project name representing a single build project.</p> </li> <li> <p> <code>UpdateProject</code>: Changes the settings of an existing build project.</p> </li> <li> <p> <code>BatchGetBuilds</code>: Gets information about one or more builds.</p> </li> <li> <p> <code>ListBuilds</code>: Gets a list of build IDs, with each build ID representing a single build.</p> </li> <li> <p> <code>ListBuildsForProject</code>: Gets a list of build IDs for the specified build project, with each build ID representing a single build.</p> </li> <li> <p> <code>StartBuild</code>: Starts running a build.</p> </li> <li> <p> <code>StopBuild</code>: Attempts to stop running a build.</p> </li> <li> <p> <code>ListCuratedEnvironmentImages</code>: Gets information about Docker images that are managed by AWS CodeBuild.</p> </li> </ul>",
"service": "<fullname>AWS CodeBuild</fullname> <p>AWS CodeBuild is a fully managed build service in the cloud. AWS CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. AWS CodeBuild eliminates the need to provision, manage, and scale your own build servers. It provides prepackaged build environments for the most popular programming languages and build tools, such as Apache Maven, Gradle, and more. You can also fully customize build environments in AWS CodeBuild to use your own build tools. AWS CodeBuild scales automatically to meet peak build requests, and you pay only for the build time you consume. For more information about AWS CodeBuild, see the <i>AWS CodeBuild User Guide</i>.</p> <p>AWS CodeBuild supports these operations:</p> <ul> <li> <p> <code>BatchDeleteBuilds</code>: Deletes one or more builds.</p> </li> <li> <p> <code>BatchGetProjects</code>: Gets information about one or more build projects. A <i>build project</i> defines how AWS CodeBuild will run a build. This includes information such as where to get the source code to build, the build environment to use, the build commands to run, and where to store the build output. A <i>build environment</i> represents a combination of operating system, programming language runtime, and tools that AWS CodeBuild will use to run a build. Also, you can add tags to build projects to help manage your resources and costs.</p> </li> <li> <p> <code>CreateProject</code>: Creates a build project.</p> </li> <li> <p> <code>CreateWebhook</code>: For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository.</p> </li> <li> <p> <code>UpdateWebhook</code>: Changes the settings of an existing webhook.</p> </li> <li> <p> <code>DeleteProject</code>: Deletes a build project.</p> </li> <li> <p> <code>DeleteWebhook</code>: For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, stops AWS CodeBuild from automatically rebuilding the source code every time a code change is pushed to the repository.</p> </li> <li> <p> <code>ListProjects</code>: Gets a list of build project names, with each build project name representing a single build project.</p> </li> <li> <p> <code>UpdateProject</code>: Changes the settings of an existing build project.</p> </li> <li> <p> <code>BatchGetBuilds</code>: Gets information about one or more builds.</p> </li> <li> <p> <code>ListBuilds</code>: Gets a list of build IDs, with each build ID representing a single build.</p> </li> <li> <p> <code>ListBuildsForProject</code>: Gets a list of build IDs for the specified build project, with each build ID representing a single build.</p> </li> <li> <p> <code>StartBuild</code>: Starts running a build.</p> </li> <li> <p> <code>StopBuild</code>: Attempts to stop running a build.</p> </li> <li> <p> <code>ListCuratedEnvironmentImages</code>: Gets information about Docker images that are managed by AWS CodeBuild.</p> </li> </ul>",
"operations": {
"BatchDeleteBuilds": "<p>Deletes one or more builds.</p>",
"BatchGetBuilds": "<p>Gets information about builds.</p>",
@ -16,7 +16,8 @@
"ListProjects": "<p>Gets a list of build project names, with each build project name representing a single build project.</p>",
"StartBuild": "<p>Starts running a build.</p>",
"StopBuild": "<p>Attempts to stop running a build.</p>",
"UpdateProject": "<p>Changes the settings of a build project.</p>"
"UpdateProject": "<p>Changes the settings of a build project.</p>",
"UpdateWebhook": "<p> Updates the webhook associated with an AWS CodeBuild build project. </p>"
},
"shapes": {
"AccountLimitExceededException": {
@ -76,7 +77,8 @@
"base": null,
"refs": {
"Build$buildComplete": "<p>Whether the build has finished. True if completed; otherwise, false.</p>",
"ProjectBadge$badgeEnabled": "<p>Set this to true to generate a publicly-accessible URL for your project's build badge.</p>"
"ProjectBadge$badgeEnabled": "<p>Set this to true to generate a publicly-accessible URL for your project's build badge.</p>",
"UpdateWebhookInput$rotateSecret": "<p> A boolean value that specifies whether the associated repository's secret token should be updated. </p>"
}
},
"Build": {
@ -351,15 +353,15 @@
"Build$id": "<p>The unique ID for the build.</p>",
"Build$arn": "<p>The Amazon Resource Name (ARN) of the build.</p>",
"Build$sourceVersion": "<p>Any version identifier for the version of the source code to be built.</p>",
"Build$projectName": "<p>The name of the build project.</p>",
"Build$projectName": "<p>The name of the AWS CodeBuild project.</p>",
"BuildIds$member": null,
"BuildNotDeleted$id": "<p>The ID of the build that could not be successfully deleted.</p>",
"CreateProjectInput$serviceRole": "<p>The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.</p>",
"CreateProjectInput$encryptionKey": "<p>The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.</p> <p>You can specify either the CMK's Amazon Resource Name (ARN) or, if available, the CMK's alias (using the format <code>alias/<i>alias-name</i> </code>).</p>",
"DeleteProjectInput$name": "<p>The name of the build project.</p>",
"EnvironmentVariable$name": "<p>The name or key of the environment variable.</p>",
"InvalidateProjectCacheInput$projectName": "<p>The name of the build project that the cache will be reset for.</p>",
"ListBuildsForProjectInput$projectName": "<p>The name of the build project.</p>",
"InvalidateProjectCacheInput$projectName": "<p>The name of the AWS CodeBuild build project that the cache will be reset for.</p>",
"ListBuildsForProjectInput$projectName": "<p>The name of the AWS CodeBuild project.</p>",
"ListProjectsInput$nextToken": "<p>During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a <i>next token</i>. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.</p>",
"NetworkInterface$subnetId": "<p>The ID of the subnet.</p>",
"NetworkInterface$networkInterfaceId": "<p>The ID of the network interface.</p>",
@ -368,7 +370,7 @@
"ProjectEnvironment$image": "<p>The ID of the Docker image to use for this build project.</p>",
"ProjectNames$member": null,
"SecurityGroupIds$member": null,
"StartBuildInput$projectName": "<p>The name of the build project to start running a build.</p>",
"StartBuildInput$projectName": "<p>The name of the AWS CodeBuild build project to start running a build.</p>",
"StopBuildInput$id": "<p>The ID of the build.</p>",
"Subnets$member": null,
"UpdateProjectInput$name": "<p>The name of the build project.</p> <note> <p>You cannot change a build project's name.</p> </note>",
@ -376,8 +378,8 @@
"UpdateProjectInput$encryptionKey": "<p>The replacement AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.</p> <p>You can specify either the CMK's Amazon Resource Name (ARN) or, if available, the CMK's alias (using the format <code>alias/<i>alias-name</i> </code>).</p>",
"VpcConfig$vpcId": "<p>The ID of the Amazon VPC.</p>",
"Webhook$url": "<p>The URL to the webhook.</p>",
"Webhook$payloadUrl": "<p>This is the server endpoint that will receive the webhook payload.</p>",
"Webhook$secret": "<p>Use this secret while creating a webhook in GitHub for Enterprise. The secret allows webhook requests sent by GitHub for Enterprise to be authenticated by AWS CodeBuild.</p>"
"Webhook$payloadUrl": "<p> The CodeBuild endpoint where webhook events are sent.</p>",
"Webhook$secret": "<p> The secret token of the associated repository. </p>"
}
},
"OAuthProviderException": {
@ -456,9 +458,10 @@
"base": null,
"refs": {
"CreateProjectInput$name": "<p>The name of the build project.</p>",
"CreateWebhookInput$projectName": "<p>The name of the build project.</p>",
"DeleteWebhookInput$projectName": "<p>The name of the build project.</p>",
"Project$name": "<p>The name of the build project.</p>"
"CreateWebhookInput$projectName": "<p>The name of the AWS CodeBuild project.</p>",
"DeleteWebhookInput$projectName": "<p>The name of the AWS CodeBuild project.</p>",
"Project$name": "<p>The name of the build project.</p>",
"UpdateWebhookInput$projectName": "<p>The name of the AWS CodeBuild project.</p>"
}
},
"ProjectNames": {
@ -568,6 +571,7 @@
"BuildArtifacts$sha256sum": "<p>The SHA-256 hash of the build artifact.</p> <p>You can use this hash along with a checksum tool to confirm both file integrity and authenticity.</p> <note> <p>This value is available only if the build project's <code>packaging</code> value is set to <code>ZIP</code>.</p> </note>",
"BuildArtifacts$md5sum": "<p>The MD5 hash of the build artifact.</p> <p>You can use this hash along with a checksum tool to confirm both file integrity and authenticity.</p> <note> <p>This value is available only if the build project's <code>packaging</code> value is set to <code>ZIP</code>.</p> </note>",
"BuildNotDeleted$statusCode": "<p>Additional information about the build that could not be successfully deleted.</p>",
"CreateWebhookInput$branchFilter": "<p>A regular expression used to determine which branches in a repository are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If it doesn't match, then it is not. If branchFilter is empty, then all branches are built.</p>",
"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>",
@ -593,7 +597,9 @@
"ProjectSource$buildspec": "<p>The build spec declaration to use for the builds in this build project.</p> <p>If this value is not specified, a build spec must be included along with the source code to be built.</p>",
"SourceAuth$resource": "<p>The resource value that applies to the specified authorization type.</p>",
"StartBuildInput$sourceVersion": "<p>A version of the build input to be built, for this build only. If not specified, the latest version will be used. If specified, must be one of:</p> <ul> <li> <p>For AWS CodeCommit: the commit ID to use.</p> </li> <li> <p>For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format <code>pr/pull-request-ID</code> (for example <code>pr/25</code>). If a branch name is specified, the branch's HEAD commit ID will be used. If not specified, the default branch's HEAD commit ID will be used.</p> </li> <li> <p>For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID will be used. If not specified, the default branch's HEAD commit ID will be used.</p> </li> <li> <p>For Amazon Simple Storage Service (Amazon S3): the version ID of the object representing the build input ZIP file to use.</p> </li> </ul>",
"StartBuildInput$buildspecOverride": "<p>A build spec declaration that overrides, for this build only, the latest one already defined in the build project.</p>"
"StartBuildInput$buildspecOverride": "<p>A build spec declaration that overrides, for this build only, the latest one already defined in the build project.</p>",
"UpdateWebhookInput$branchFilter": "<p>A regular expression used to determine which branches in a repository are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If it doesn't match, then it is not. If branchFilter is empty, then all branches are built.</p>",
"Webhook$branchFilter": "<p>A regular expression used to determine which branches in a repository are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If it doesn't match, then it is not. If branchFilter is empty, then all branches are built.</p>"
}
},
"Subnets": {
@ -633,7 +639,8 @@
"BuildPhase$startTime": "<p>When the build phase started, expressed in Unix time format.</p>",
"BuildPhase$endTime": "<p>When the build phase ended, expressed in Unix time format.</p>",
"Project$created": "<p>When the build project was created, expressed in Unix time format.</p>",
"Project$lastModified": "<p>When the build project's settings were last modified, expressed in Unix time format.</p>"
"Project$lastModified": "<p>When the build project's settings were last modified, expressed in Unix time format.</p>",
"Webhook$lastModifiedSecret": "<p> A timestamp indicating the last time a repository's secret token was modified. </p>"
}
},
"UpdateProjectInput": {
@ -646,6 +653,16 @@
"refs": {
}
},
"UpdateWebhookInput": {
"base": null,
"refs": {
}
},
"UpdateWebhookOutput": {
"base": null,
"refs": {
}
},
"ValueInput": {
"base": null,
"refs": {
@ -665,14 +682,15 @@
"base": "<p>Information about a webhook in GitHub that connects repository events to a build project in AWS CodeBuild.</p>",
"refs": {
"CreateWebhookOutput$webhook": "<p>Information about a webhook in GitHub that connects repository events to a build project in AWS CodeBuild.</p>",
"Project$webhook": "<p>Information about a webhook in GitHub that connects repository events to a build project in AWS CodeBuild.</p>"
"Project$webhook": "<p>Information about a webhook in GitHub that connects repository events to a build project in AWS CodeBuild.</p>",
"UpdateWebhookOutput$webhook": "<p> Information about a repository's webhook that is associated with a project in AWS CodeBuild. </p>"
}
},
"WrapperBoolean": {
"base": null,
"refs": {
"CreateProjectInput$badgeEnabled": "<p>Set this to true to generate a publicly-accessible URL for your project's build badge.</p>",
"ProjectEnvironment$privilegedMode": "<p>If set to true, enables running the Docker daemon inside a Docker container; otherwise, false or not specified (the default). This value must be set to true only if this build project will be used to build Docker images, and the specified build environment image is not one provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon will fail. Note that you must also start the Docker daemon so that your builds can interact with it as needed. One way to do this is to initialize the Docker daemon in the install phase of your build spec by running the following build commands. (Do not run the following build commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)</p> <p> <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&amp; - timeout -t 15 sh -c \"until docker info; do echo .; sleep 1; done\"</code> </p>",
"ProjectEnvironment$privilegedMode": "<p>Enables running the Docker daemon inside a Docker container. Set to true only if the build project is be used to build Docker images, and the specified build environment image is not provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon will fail. Note that you must also start the Docker daemon so that builds can interact with it. One way to do this is to initialize the Docker daemon during the install phase of your build spec by running the following build commands. (Do not run the following build commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)</p> <p> <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&amp; - timeout -t 15 sh -c \"until docker info; do echo .; sleep 1; done\"</code> </p>",
"ProjectSource$insecureSsl": "<p>Enable this flag to ignore SSL warnings while connecting to the project source code.</p>",
"UpdateProjectInput$badgeEnabled": "<p>Set this to true to generate a publicly-accessible URL for your project's build badge.</p>"
}

9
vendor/github.com/aws/aws-sdk-go/models/apis/codedeploy/2014-10-06/api-2.json generated vendored
View File

@ -187,7 +187,8 @@
{"shape":"InvalidAutoScalingGroupException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidUpdateOutdatedInstancesOnlyValueException"},
{"shape":"InvalidIgnoreApplicationStopFailuresValueException"}
{"shape":"InvalidIgnoreApplicationStopFailuresValueException"},
{"shape":"InvalidGitHubAccountTokenException"}
]
},
"CreateDeploymentConfig":{
@ -1881,6 +1882,12 @@
},
"exception":true
},
"InvalidGitHubAccountTokenException":{
"type":"structure",
"members":{
},
"exception":true
},
"InvalidGitHubAccountTokenNameException":{
"type":"structure",
"members":{

7
vendor/github.com/aws/aws-sdk-go/models/apis/codedeploy/2014-10-06/docs-2.json generated vendored
View File

@ -622,7 +622,7 @@
"DeploymentReadyAction": {
"base": null,
"refs": {
"DeploymentReadyOption$actionOnTimeout": "<p>Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.</p> <ul> <li> <p>CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.</p> </li> <li> <p>STOP_DEPLOYMENT: Do not register new instances with load balancer unless traffic is rerouted manually. If traffic is not rerouted manually before the end of the specified wait period, the deployment status is changed to Stopped.</p> </li> </ul>"
"DeploymentReadyOption$actionOnTimeout": "<p>Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.</p> <ul> <li> <p>CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.</p> </li> <li> <p>STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using <a>ContinueDeployment</a>. If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped.</p> </li> </ul>"
}
},
"DeploymentReadyOption": {
@ -1180,6 +1180,11 @@
"refs": {
}
},
"InvalidGitHubAccountTokenException": {
"base": "<p>The GitHub token is not valid.</p>",
"refs": {
}
},
"InvalidGitHubAccountTokenNameException": {
"base": "<p>The format of the specified GitHub account connection name is invalid.</p>",
"refs": {

18
vendor/github.com/aws/aws-sdk-go/models/apis/codedeploy/2014-10-06/smoke.json generated vendored Normal file
View File

@ -0,0 +1,18 @@
{
"version": 1,
"defaultRegion": "us-west-2",
"testCases": [
{
"operationName": "ListApplications",
"input": {},
"errorExpectedFromService": false
},
{
"operationName": "GetDeployment",
"input": {
"deploymentId": "d-USUAELQEX"
},
"errorExpectedFromService": true
}
]
}

291
vendor/github.com/aws/aws-sdk-go/models/apis/codepipeline/2015-07-09/api-2.json generated vendored
View File

@ -94,6 +94,31 @@
{"shape":"ValidationException"}
]
},
"DeleteWebhook":{
"name":"DeleteWebhook",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteWebhookInput"},
"output":{"shape":"DeleteWebhookOutput"},
"errors":[
{"shape":"ValidationException"}
]
},
"DeregisterWebhookWithThirdParty":{
"name":"DeregisterWebhookWithThirdParty",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeregisterWebhookWithThirdPartyInput"},
"output":{"shape":"DeregisterWebhookWithThirdPartyOutput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"WebhookNotFoundException"}
]
},
"DisableStageTransition":{
"name":"DisableStageTransition",
"http":{
@ -225,6 +250,20 @@
"input":{"shape":"ListPipelinesInput"},
"output":{"shape":"ListPipelinesOutput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"InvalidNextTokenException"}
]
},
"ListWebhooks":{
"name":"ListWebhooks",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListWebhooksInput"},
"output":{"shape":"ListWebhooksOutput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"InvalidNextTokenException"}
]
},
@ -340,6 +379,35 @@
{"shape":"InvalidClientTokenException"}
]
},
"PutWebhook":{
"name":"PutWebhook",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutWebhookInput"},
"output":{"shape":"PutWebhookOutput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidWebhookFilterPatternException"},
{"shape":"InvalidWebhookAuthenticationParametersException"},
{"shape":"PipelineNotFoundException"}
]
},
"RegisterWebhookWithThirdParty":{
"name":"RegisterWebhookWithThirdParty",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RegisterWebhookWithThirdPartyInput"},
"output":{"shape":"RegisterWebhookWithThirdPartyOutput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"WebhookNotFoundException"}
]
},
"RetryStageExecution":{
"name":"RetryStageExecution",
"http":{
@ -804,7 +872,11 @@
"min":1
},
"Code":{"type":"string"},
"ContinuationToken":{"type":"string"},
"ContinuationToken":{
"type":"string",
"max":2048,
"min":1
},
"CreateCustomActionTypeInput":{
"type":"structure",
"required":[
@ -877,9 +949,32 @@
"name":{"shape":"PipelineName"}
}
},
"DeleteWebhookInput":{
"type":"structure",
"required":["name"],
"members":{
"name":{"shape":"WebhookName"}
}
},
"DeleteWebhookOutput":{
"type":"structure",
"members":{
}
},
"DeregisterWebhookWithThirdPartyInput":{
"type":"structure",
"members":{
"webhookName":{"shape":"WebhookName"}
}
},
"DeregisterWebhookWithThirdPartyOutput":{
"type":"structure",
"members":{
}
},
"Description":{
"type":"string",
"max":2048,
"max":160,
"min":1
},
"DisableStageTransitionInput":{
@ -957,7 +1052,11 @@
"max":1500,
"min":1
},
"ExecutionSummary":{"type":"string"},
"ExecutionSummary":{
"type":"string",
"max":2048,
"min":1
},
"FailureDetails":{
"type":"structure",
"required":[
@ -1131,6 +1230,18 @@
},
"exception":true
},
"InvalidWebhookAuthenticationParametersException":{
"type":"structure",
"members":{
},
"exception":true
},
"InvalidWebhookFilterPatternException":{
"type":"structure",
"members":{
},
"exception":true
},
"Job":{
"type":"structure",
"members":{
@ -1187,6 +1298,11 @@
"Failed"
]
},
"JsonPath":{
"type":"string",
"max":150,
"min":1
},
"LastChangedAt":{"type":"timestamp"},
"LastChangedBy":{"type":"string"},
"LastUpdatedBy":{"type":"string"},
@ -1240,6 +1356,40 @@
"nextToken":{"shape":"NextToken"}
}
},
"ListWebhookItem":{
"type":"structure",
"required":[
"definition",
"url"
],
"members":{
"definition":{"shape":"WebhookDefinition"},
"url":{"shape":"WebhookUrl"},
"errorMessage":{"shape":"WebhookErrorMessage"},
"errorCode":{"shape":"WebhookErrorCode"},
"lastTriggered":{"shape":"WebhookLastTriggered"},
"arn":{"shape":"WebhookArn"}
}
},
"ListWebhooksInput":{
"type":"structure",
"members":{
"NextToken":{"shape":"NextToken"},
"MaxResults":{"shape":"MaxResults"}
}
},
"ListWebhooksOutput":{
"type":"structure",
"members":{
"webhooks":{"shape":"WebhookList"},
"NextToken":{"shape":"NextToken"}
}
},
"MatchEquals":{
"type":"string",
"max":150,
"min":1
},
"MaxBatchSize":{
"type":"integer",
"min":1
@ -1254,7 +1404,11 @@
"max":5,
"min":0
},
"Message":{"type":"string"},
"Message":{
"type":"string",
"max":5000,
"min":1
},
"MinimumArtifactCount":{
"type":"integer",
"max":5,
@ -1265,7 +1419,11 @@
"max":2048,
"min":1
},
"Nonce":{"type":"string"},
"Nonce":{
"type":"string",
"max":50,
"min":1
},
"NotLatestPipelineExecutionException":{
"type":"structure",
"members":{
@ -1351,7 +1509,8 @@
"pipelineExecutionId":{"shape":"PipelineExecutionId"},
"status":{"shape":"PipelineExecutionStatus"},
"startTime":{"shape":"Timestamp"},
"lastUpdateTime":{"shape":"Timestamp"}
"lastUpdateTime":{"shape":"Timestamp"},
"sourceRevisions":{"shape":"SourceRevisionList"}
}
},
"PipelineExecutionSummaryList":{
@ -1533,6 +1692,19 @@
"executionDetails":{"shape":"ExecutionDetails"}
}
},
"PutWebhookInput":{
"type":"structure",
"required":["webhook"],
"members":{
"webhook":{"shape":"WebhookDefinition"}
}
},
"PutWebhookOutput":{
"type":"structure",
"members":{
"webhook":{"shape":"ListWebhookItem"}
}
},
"QueryParamMap":{
"type":"map",
"key":{"shape":"ActionConfigurationKey"},
@ -1540,6 +1712,17 @@
"max":1,
"min":0
},
"RegisterWebhookWithThirdPartyInput":{
"type":"structure",
"members":{
"webhookName":{"shape":"WebhookName"}
}
},
"RegisterWebhookWithThirdPartyOutput":{
"type":"structure",
"members":{
}
},
"RetryStageExecutionInput":{
"type":"structure",
"required":[
@ -1596,6 +1779,20 @@
"S3ObjectKey":{"type":"string"},
"SecretAccessKey":{"type":"string"},
"SessionToken":{"type":"string"},
"SourceRevision":{
"type":"structure",
"required":["actionName"],
"members":{
"actionName":{"shape":"ActionName"},
"revisionId":{"shape":"Revision"},
"revisionSummary":{"shape":"RevisionSummary"},
"revisionUrl":{"shape":"Url"}
}
},
"SourceRevisionList":{
"type":"list",
"member":{"shape":"SourceRevision"}
},
"StageActionDeclarationList":{
"type":"list",
"member":{"shape":"ActionDeclaration"}
@ -1778,6 +1975,88 @@
"max":9,
"min":1,
"pattern":"[0-9A-Za-z_-]+"
},
"WebhookArn":{"type":"string"},
"WebhookAuthConfiguration":{
"type":"structure",
"members":{
"AllowedIPRange":{"shape":"WebhookAuthConfigurationAllowedIPRange"},
"SecretToken":{"shape":"WebhookAuthConfigurationSecretToken"}
}
},
"WebhookAuthConfigurationAllowedIPRange":{
"type":"string",
"max":100,
"min":1
},
"WebhookAuthConfigurationSecretToken":{
"type":"string",
"max":100,
"min":1
},
"WebhookAuthenticationType":{
"type":"string",
"enum":[
"GITHUB_HMAC",
"IP",
"UNAUTHENTICATED"
]
},
"WebhookDefinition":{
"type":"structure",
"required":[
"name",
"targetPipeline",
"targetAction",
"filters",
"authentication",
"authenticationConfiguration"
],
"members":{
"name":{"shape":"WebhookName"},
"targetPipeline":{"shape":"PipelineName"},
"targetAction":{"shape":"ActionName"},
"filters":{"shape":"WebhookFilters"},
"authentication":{"shape":"WebhookAuthenticationType"},
"authenticationConfiguration":{"shape":"WebhookAuthConfiguration"}
}
},
"WebhookErrorCode":{"type":"string"},
"WebhookErrorMessage":{"type":"string"},
"WebhookFilterRule":{
"type":"structure",
"required":["jsonPath"],
"members":{
"jsonPath":{"shape":"JsonPath"},
"matchEquals":{"shape":"MatchEquals"}
}
},
"WebhookFilters":{
"type":"list",
"member":{"shape":"WebhookFilterRule"},
"max":5
},
"WebhookLastTriggered":{"type":"timestamp"},
"WebhookList":{
"type":"list",
"member":{"shape":"ListWebhookItem"}
},
"WebhookName":{
"type":"string",
"max":100,
"min":1,
"pattern":"[A-Za-z0-9.@\\-_]+"
},
"WebhookNotFoundException":{
"type":"structure",
"members":{
},
"exception":true
},
"WebhookUrl":{
"type":"string",
"max":1000,
"min":1
}
}
}

220
vendor/github.com/aws/aws-sdk-go/models/apis/codepipeline/2015-07-09/docs-2.json generated vendored
View File

File diff suppressed because one or more lines are too long

662
vendor/github.com/aws/aws-sdk-go/models/apis/config/2014-11-12/api-2.json generated vendored
View File

@ -7,11 +7,36 @@
"protocol":"json",
"serviceAbbreviation":"Config Service",
"serviceFullName":"AWS Config",
"serviceId":"Config Service",
"signatureVersion":"v4",
"targetPrefix":"StarlingDoveService",
"uid":"config-2014-11-12"
},
"operations":{
"BatchGetResourceConfig":{
"name":"BatchGetResourceConfig",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"BatchGetResourceConfigRequest"},
"output":{"shape":"BatchGetResourceConfigResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"NoAvailableConfigurationRecorderException"}
]
},
"DeleteAggregationAuthorization":{
"name":"DeleteAggregationAuthorization",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteAggregationAuthorizationRequest"},
"errors":[
{"shape":"InvalidParameterValueException"}
]
},
"DeleteConfigRule":{
"name":"DeleteConfigRule",
"http":{
@ -24,6 +49,17 @@
{"shape":"ResourceInUseException"}
]
},
"DeleteConfigurationAggregator":{
"name":"DeleteConfigurationAggregator",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteConfigurationAggregatorRequest"},
"errors":[
{"shape":"NoSuchConfigurationAggregatorException"}
]
},
"DeleteConfigurationRecorder":{
"name":"DeleteConfigurationRecorder",
"http":{
@ -60,6 +96,17 @@
{"shape":"ResourceInUseException"}
]
},
"DeletePendingAggregationRequest":{
"name":"DeletePendingAggregationRequest",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeletePendingAggregationRequestRequest"},
"errors":[
{"shape":"InvalidParameterValueException"}
]
},
"DeliverConfigSnapshot":{
"name":"DeliverConfigSnapshot",
"http":{
@ -74,6 +121,35 @@
{"shape":"NoRunningConfigurationRecorderException"}
]
},
"DescribeAggregateComplianceByConfigRules":{
"name":"DescribeAggregateComplianceByConfigRules",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeAggregateComplianceByConfigRulesRequest"},
"output":{"shape":"DescribeAggregateComplianceByConfigRulesResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"InvalidLimitException"},
{"shape":"InvalidNextTokenException"},
{"shape":"NoSuchConfigurationAggregatorException"}
]
},
"DescribeAggregationAuthorizations":{
"name":"DescribeAggregationAuthorizations",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeAggregationAuthorizationsRequest"},
"output":{"shape":"DescribeAggregationAuthorizationsResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidNextTokenException"},
{"shape":"InvalidLimitException"}
]
},
"DescribeComplianceByConfigRule":{
"name":"DescribeComplianceByConfigRule",
"http":{
@ -128,6 +204,36 @@
{"shape":"InvalidNextTokenException"}
]
},
"DescribeConfigurationAggregatorSourcesStatus":{
"name":"DescribeConfigurationAggregatorSourcesStatus",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeConfigurationAggregatorSourcesStatusRequest"},
"output":{"shape":"DescribeConfigurationAggregatorSourcesStatusResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"NoSuchConfigurationAggregatorException"},
{"shape":"InvalidNextTokenException"},
{"shape":"InvalidLimitException"}
]
},
"DescribeConfigurationAggregators":{
"name":"DescribeConfigurationAggregators",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeConfigurationAggregatorsRequest"},
"output":{"shape":"DescribeConfigurationAggregatorsResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"NoSuchConfigurationAggregatorException"},
{"shape":"InvalidNextTokenException"},
{"shape":"InvalidLimitException"}
]
},
"DescribeConfigurationRecorderStatus":{
"name":"DescribeConfigurationRecorderStatus",
"http":{
@ -176,6 +282,50 @@
{"shape":"NoSuchDeliveryChannelException"}
]
},
"DescribePendingAggregationRequests":{
"name":"DescribePendingAggregationRequests",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribePendingAggregationRequestsRequest"},
"output":{"shape":"DescribePendingAggregationRequestsResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidNextTokenException"},
{"shape":"InvalidLimitException"}
]
},
"GetAggregateComplianceDetailsByConfigRule":{
"name":"GetAggregateComplianceDetailsByConfigRule",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetAggregateComplianceDetailsByConfigRuleRequest"},
"output":{"shape":"GetAggregateComplianceDetailsByConfigRuleResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"InvalidLimitException"},
{"shape":"InvalidNextTokenException"},
{"shape":"NoSuchConfigurationAggregatorException"}
]
},
"GetAggregateConfigRuleComplianceSummary":{
"name":"GetAggregateConfigRuleComplianceSummary",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetAggregateConfigRuleComplianceSummaryRequest"},
"output":{"shape":"GetAggregateConfigRuleComplianceSummaryResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"InvalidLimitException"},
{"shape":"InvalidNextTokenException"},
{"shape":"NoSuchConfigurationAggregatorException"}
]
},
"GetComplianceDetailsByConfigRule":{
"name":"GetComplianceDetailsByConfigRule",
"http":{
@ -268,6 +418,18 @@
{"shape":"NoAvailableConfigurationRecorderException"}
]
},
"PutAggregationAuthorization":{
"name":"PutAggregationAuthorization",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutAggregationAuthorizationRequest"},
"output":{"shape":"PutAggregationAuthorizationResponse"},
"errors":[
{"shape":"InvalidParameterValueException"}
]
},
"PutConfigRule":{
"name":"PutConfigRule",
"http":{
@ -283,6 +445,23 @@
{"shape":"NoAvailableConfigurationRecorderException"}
]
},
"PutConfigurationAggregator":{
"name":"PutConfigurationAggregator",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutConfigurationAggregatorRequest"},
"output":{"shape":"PutConfigurationAggregatorResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidRoleException"},
{"shape":"OrganizationAccessDeniedException"},
{"shape":"NoAvailableOrganizationException"},
{"shape":"OrganizationAllFeaturesNotEnabledException"}
]
},
"PutConfigurationRecorder":{
"name":"PutConfigurationRecorder",
"http":{
@ -369,15 +548,173 @@
},
"shapes":{
"ARN":{"type":"string"},
"AccountId":{"type":"string"},
"AccountAggregationSource":{
"type":"structure",
"required":["AccountIds"],
"members":{
"AccountIds":{"shape":"AccountAggregationSourceAccountList"},
"AllAwsRegions":{"shape":"Boolean"},
"AwsRegions":{"shape":"AggregatorRegionList"}
}
},
"AccountAggregationSourceAccountList":{
"type":"list",
"member":{"shape":"AccountId"},
"min":1
},
"AccountAggregationSourceList":{
"type":"list",
"member":{"shape":"AccountAggregationSource"},
"max":1,
"min":0
},
"AccountId":{
"type":"string",
"pattern":"\\d{12}"
},
"AggregateComplianceByConfigRule":{
"type":"structure",
"members":{
"ConfigRuleName":{"shape":"ConfigRuleName"},
"Compliance":{"shape":"Compliance"},
"AccountId":{"shape":"AccountId"},
"AwsRegion":{"shape":"AwsRegion"}
}
},
"AggregateComplianceByConfigRuleList":{
"type":"list",
"member":{"shape":"AggregateComplianceByConfigRule"}
},
"AggregateComplianceCount":{
"type":"structure",
"members":{
"GroupName":{"shape":"StringWithCharLimit256"},
"ComplianceSummary":{"shape":"ComplianceSummary"}
}
},
"AggregateComplianceCountList":{
"type":"list",
"member":{"shape":"AggregateComplianceCount"}
},
"AggregateEvaluationResult":{
"type":"structure",
"members":{
"EvaluationResultIdentifier":{"shape":"EvaluationResultIdentifier"},
"ComplianceType":{"shape":"ComplianceType"},
"ResultRecordedTime":{"shape":"Date"},
"ConfigRuleInvokedTime":{"shape":"Date"},
"Annotation":{"shape":"StringWithCharLimit256"},
"AccountId":{"shape":"AccountId"},
"AwsRegion":{"shape":"AwsRegion"}
}
},
"AggregateEvaluationResultList":{
"type":"list",
"member":{"shape":"AggregateEvaluationResult"}
},
"AggregatedSourceStatus":{
"type":"structure",
"members":{
"SourceId":{"shape":"String"},
"SourceType":{"shape":"AggregatedSourceType"},
"AwsRegion":{"shape":"AwsRegion"},
"LastUpdateStatus":{"shape":"AggregatedSourceStatusType"},
"LastUpdateTime":{"shape":"Date"},
"LastErrorCode":{"shape":"String"},
"LastErrorMessage":{"shape":"String"}
}
},
"AggregatedSourceStatusList":{
"type":"list",
"member":{"shape":"AggregatedSourceStatus"}
},
"AggregatedSourceStatusType":{
"type":"string",
"enum":[
"FAILED",
"SUCCEEDED",
"OUTDATED"
]
},
"AggregatedSourceStatusTypeList":{
"type":"list",
"member":{"shape":"AggregatedSourceStatusType"},
"min":1
},
"AggregatedSourceType":{
"type":"string",
"enum":[
"ACCOUNT",
"ORGANIZATION"
]
},
"AggregationAuthorization":{
"type":"structure",
"members":{
"AggregationAuthorizationArn":{"shape":"String"},
"AuthorizedAccountId":{"shape":"AccountId"},
"AuthorizedAwsRegion":{"shape":"AwsRegion"},
"CreationTime":{"shape":"Date"}
}
},
"AggregationAuthorizationList":{
"type":"list",
"member":{"shape":"AggregationAuthorization"}
},
"AggregatorRegionList":{
"type":"list",
"member":{"shape":"String"},
"min":1
},
"AllSupported":{"type":"boolean"},
"AvailabilityZone":{"type":"string"},
"AwsRegion":{"type":"string"},
"AwsRegion":{
"type":"string",
"max":64,
"min":1
},
"BaseConfigurationItem":{
"type":"structure",
"members":{
"version":{"shape":"Version"},
"accountId":{"shape":"AccountId"},
"configurationItemCaptureTime":{"shape":"ConfigurationItemCaptureTime"},
"configurationItemStatus":{"shape":"ConfigurationItemStatus"},
"configurationStateId":{"shape":"ConfigurationStateId"},
"arn":{"shape":"ARN"},
"resourceType":{"shape":"ResourceType"},
"resourceId":{"shape":"ResourceId"},
"resourceName":{"shape":"ResourceName"},
"awsRegion":{"shape":"AwsRegion"},
"availabilityZone":{"shape":"AvailabilityZone"},
"resourceCreationTime":{"shape":"ResourceCreationTime"},
"configuration":{"shape":"Configuration"},
"supplementaryConfiguration":{"shape":"SupplementaryConfiguration"}
}
},
"BaseConfigurationItems":{
"type":"list",
"member":{"shape":"BaseConfigurationItem"}
},
"BaseResourceId":{
"type":"string",
"max":768,
"min":1
},
"BatchGetResourceConfigRequest":{
"type":"structure",
"required":["resourceKeys"],
"members":{
"resourceKeys":{"shape":"ResourceKeys"}
}
},
"BatchGetResourceConfigResponse":{
"type":"structure",
"members":{
"baseConfigurationItems":{"shape":"BaseConfigurationItems"},
"unprocessedResourceKeys":{"shape":"ResourceKeys"}
}
},
"Boolean":{"type":"boolean"},
"ChannelName":{
"type":"string",
@ -494,6 +831,29 @@
"ConfigRuleState":{"shape":"ConfigRuleState"}
}
},
"ConfigRuleComplianceFilters":{
"type":"structure",
"members":{
"ConfigRuleName":{"shape":"ConfigRuleName"},
"ComplianceType":{"shape":"ComplianceType"},
"AccountId":{"shape":"AccountId"},
"AwsRegion":{"shape":"AwsRegion"}
}
},
"ConfigRuleComplianceSummaryFilters":{
"type":"structure",
"members":{
"AccountId":{"shape":"AccountId"},
"AwsRegion":{"shape":"AwsRegion"}
}
},
"ConfigRuleComplianceSummaryGroupKey":{
"type":"string",
"enum":[
"ACCOUNT_ID",
"AWS_REGION"
]
},
"ConfigRuleEvaluationStatus":{
"type":"structure",
"members":{
@ -514,6 +874,11 @@
"type":"list",
"member":{"shape":"ConfigRuleEvaluationStatus"}
},
"ConfigRuleName":{
"type":"string",
"max":64,
"min":1
},
"ConfigRuleNames":{
"type":"list",
"member":{"shape":"StringWithCharLimit64"},
@ -549,6 +914,37 @@
}
},
"Configuration":{"type":"string"},
"ConfigurationAggregator":{
"type":"structure",
"members":{
"ConfigurationAggregatorName":{"shape":"ConfigurationAggregatorName"},
"ConfigurationAggregatorArn":{"shape":"ConfigurationAggregatorArn"},
"AccountAggregationSources":{"shape":"AccountAggregationSourceList"},
"OrganizationAggregationSource":{"shape":"OrganizationAggregationSource"},
"CreationTime":{"shape":"Date"},
"LastUpdatedTime":{"shape":"Date"}
}
},
"ConfigurationAggregatorArn":{
"type":"string",
"pattern":"arn:aws[a-z\\-]*:config:[a-z\\-\\d]+:\\d+:config-aggregator/config-aggregator-[a-z\\d]+"
},
"ConfigurationAggregatorList":{
"type":"list",
"member":{"shape":"ConfigurationAggregator"}
},
"ConfigurationAggregatorName":{
"type":"string",
"max":256,
"min":1,
"pattern":"[\\w\\-]+"
},
"ConfigurationAggregatorNameList":{
"type":"list",
"member":{"shape":"ConfigurationAggregatorName"},
"max":10,
"min":0
},
"ConfigurationItem":{
"type":"structure",
"members":{
@ -623,6 +1019,17 @@
},
"ConfigurationStateId":{"type":"string"},
"Date":{"type":"timestamp"},
"DeleteAggregationAuthorizationRequest":{
"type":"structure",
"required":[
"AuthorizedAccountId",
"AuthorizedAwsRegion"
],
"members":{
"AuthorizedAccountId":{"shape":"AccountId"},
"AuthorizedAwsRegion":{"shape":"AwsRegion"}
}
},
"DeleteConfigRuleRequest":{
"type":"structure",
"required":["ConfigRuleName"],
@ -630,6 +1037,13 @@
"ConfigRuleName":{"shape":"StringWithCharLimit64"}
}
},
"DeleteConfigurationAggregatorRequest":{
"type":"structure",
"required":["ConfigurationAggregatorName"],
"members":{
"ConfigurationAggregatorName":{"shape":"ConfigurationAggregatorName"}
}
},
"DeleteConfigurationRecorderRequest":{
"type":"structure",
"required":["ConfigurationRecorderName"],
@ -656,6 +1070,17 @@
"members":{
}
},
"DeletePendingAggregationRequestRequest":{
"type":"structure",
"required":[
"RequesterAccountId",
"RequesterAwsRegion"
],
"members":{
"RequesterAccountId":{"shape":"AccountId"},
"RequesterAwsRegion":{"shape":"AwsRegion"}
}
},
"DeliverConfigSnapshotRequest":{
"type":"structure",
"required":["deliveryChannelName"],
@ -708,6 +1133,37 @@
"Not_Applicable"
]
},
"DescribeAggregateComplianceByConfigRulesRequest":{
"type":"structure",
"required":["ConfigurationAggregatorName"],
"members":{
"ConfigurationAggregatorName":{"shape":"ConfigurationAggregatorName"},
"Filters":{"shape":"ConfigRuleComplianceFilters"},
"Limit":{"shape":"GroupByAPILimit"},
"NextToken":{"shape":"NextToken"}
}
},
"DescribeAggregateComplianceByConfigRulesResponse":{
"type":"structure",
"members":{
"AggregateComplianceByConfigRules":{"shape":"AggregateComplianceByConfigRuleList"},
"NextToken":{"shape":"NextToken"}
}
},
"DescribeAggregationAuthorizationsRequest":{
"type":"structure",
"members":{
"Limit":{"shape":"Limit"},
"NextToken":{"shape":"String"}
}
},
"DescribeAggregationAuthorizationsResponse":{
"type":"structure",
"members":{
"AggregationAuthorizations":{"shape":"AggregationAuthorizationList"},
"NextToken":{"shape":"String"}
}
},
"DescribeComplianceByConfigRuleRequest":{
"type":"structure",
"members":{
@ -769,6 +1225,38 @@
"NextToken":{"shape":"String"}
}
},
"DescribeConfigurationAggregatorSourcesStatusRequest":{
"type":"structure",
"required":["ConfigurationAggregatorName"],
"members":{
"ConfigurationAggregatorName":{"shape":"ConfigurationAggregatorName"},
"UpdateStatus":{"shape":"AggregatedSourceStatusTypeList"},
"NextToken":{"shape":"String"},
"Limit":{"shape":"Limit"}
}
},
"DescribeConfigurationAggregatorSourcesStatusResponse":{
"type":"structure",
"members":{
"AggregatedSourceStatusList":{"shape":"AggregatedSourceStatusList"},
"NextToken":{"shape":"String"}
}
},
"DescribeConfigurationAggregatorsRequest":{
"type":"structure",
"members":{
"ConfigurationAggregatorNames":{"shape":"ConfigurationAggregatorNameList"},
"NextToken":{"shape":"String"},
"Limit":{"shape":"Limit"}
}
},
"DescribeConfigurationAggregatorsResponse":{
"type":"structure",
"members":{
"ConfigurationAggregators":{"shape":"ConfigurationAggregatorList"},
"NextToken":{"shape":"String"}
}
},
"DescribeConfigurationRecorderStatusRequest":{
"type":"structure",
"members":{
@ -817,6 +1305,25 @@
"DeliveryChannels":{"shape":"DeliveryChannelList"}
}
},
"DescribePendingAggregationRequestsLimit":{
"type":"integer",
"max":20,
"min":0
},
"DescribePendingAggregationRequestsRequest":{
"type":"structure",
"members":{
"Limit":{"shape":"DescribePendingAggregationRequestsLimit"},
"NextToken":{"shape":"String"}
}
},
"DescribePendingAggregationRequestsResponse":{
"type":"structure",
"members":{
"PendingAggregationRequests":{"shape":"PendingAggregationRequestList"},
"NextToken":{"shape":"String"}
}
},
"EarlierTime":{"type":"timestamp"},
"EmptiableStringWithCharLimit256":{
"type":"string",
@ -879,6 +1386,50 @@
"type":"string",
"enum":["aws.config"]
},
"GetAggregateComplianceDetailsByConfigRuleRequest":{
"type":"structure",
"required":[
"ConfigurationAggregatorName",
"ConfigRuleName",
"AccountId",
"AwsRegion"
],
"members":{
"ConfigurationAggregatorName":{"shape":"ConfigurationAggregatorName"},
"ConfigRuleName":{"shape":"ConfigRuleName"},
"AccountId":{"shape":"AccountId"},
"AwsRegion":{"shape":"AwsRegion"},
"ComplianceType":{"shape":"ComplianceType"},
"Limit":{"shape":"Limit"},
"NextToken":{"shape":"NextToken"}
}
},
"GetAggregateComplianceDetailsByConfigRuleResponse":{
"type":"structure",
"members":{
"AggregateEvaluationResults":{"shape":"AggregateEvaluationResultList"},
"NextToken":{"shape":"NextToken"}
}
},
"GetAggregateConfigRuleComplianceSummaryRequest":{
"type":"structure",
"required":["ConfigurationAggregatorName"],
"members":{
"ConfigurationAggregatorName":{"shape":"ConfigurationAggregatorName"},
"Filters":{"shape":"ConfigRuleComplianceSummaryFilters"},
"GroupByKey":{"shape":"ConfigRuleComplianceSummaryGroupKey"},
"Limit":{"shape":"GroupByAPILimit"},
"NextToken":{"shape":"NextToken"}
}
},
"GetAggregateConfigRuleComplianceSummaryResponse":{
"type":"structure",
"members":{
"GroupByKey":{"shape":"StringWithCharLimit256"},
"AggregateComplianceCounts":{"shape":"AggregateComplianceCountList"},
"NextToken":{"shape":"NextToken"}
}
},
"GetComplianceDetailsByConfigRuleRequest":{
"type":"structure",
"required":["ConfigRuleName"],
@ -973,6 +1524,11 @@
"nextToken":{"shape":"NextToken"}
}
},
"GroupByAPILimit":{
"type":"integer",
"max":1000,
"min":0
},
"IncludeGlobalResourceTypes":{"type":"boolean"},
"InsufficientDeliveryPolicyException":{
"type":"structure",
@ -1142,6 +1698,12 @@
},
"exception":true
},
"NoAvailableOrganizationException":{
"type":"structure",
"members":{
},
"exception":true
},
"NoRunningConfigurationRecorderException":{
"type":"structure",
"members":{
@ -1160,6 +1722,12 @@
},
"exception":true
},
"NoSuchConfigurationAggregatorException":{
"type":"structure",
"members":{
},
"exception":true
},
"NoSuchConfigurationRecorderException":{
"type":"structure",
"members":{
@ -1173,6 +1741,27 @@
"exception":true
},
"OrderingTimestamp":{"type":"timestamp"},
"OrganizationAccessDeniedException":{
"type":"structure",
"members":{
},
"exception":true
},
"OrganizationAggregationSource":{
"type":"structure",
"required":["RoleArn"],
"members":{
"RoleArn":{"shape":"String"},
"AwsRegions":{"shape":"AggregatorRegionList"},
"AllAwsRegions":{"shape":"Boolean"}
}
},
"OrganizationAllFeaturesNotEnabledException":{
"type":"structure",
"members":{
},
"exception":true
},
"Owner":{
"type":"string",
"enum":[
@ -1180,6 +1769,34 @@
"AWS"
]
},
"PendingAggregationRequest":{
"type":"structure",
"members":{
"RequesterAccountId":{"shape":"AccountId"},
"RequesterAwsRegion":{"shape":"AwsRegion"}
}
},
"PendingAggregationRequestList":{
"type":"list",
"member":{"shape":"PendingAggregationRequest"}
},
"PutAggregationAuthorizationRequest":{
"type":"structure",
"required":[
"AuthorizedAccountId",
"AuthorizedAwsRegion"
],
"members":{
"AuthorizedAccountId":{"shape":"AccountId"},
"AuthorizedAwsRegion":{"shape":"AwsRegion"}
}
},
"PutAggregationAuthorizationResponse":{
"type":"structure",
"members":{
"AggregationAuthorization":{"shape":"AggregationAuthorization"}
}
},
"PutConfigRuleRequest":{
"type":"structure",
"required":["ConfigRule"],
@ -1187,6 +1804,21 @@
"ConfigRule":{"shape":"ConfigRule"}
}
},
"PutConfigurationAggregatorRequest":{
"type":"structure",
"required":["ConfigurationAggregatorName"],
"members":{
"ConfigurationAggregatorName":{"shape":"ConfigurationAggregatorName"},
"AccountAggregationSources":{"shape":"AccountAggregationSourceList"},
"OrganizationAggregationSource":{"shape":"OrganizationAggregationSource"}
}
},
"PutConfigurationAggregatorResponse":{
"type":"structure",
"members":{
"ConfigurationAggregator":{"shape":"ConfigurationAggregator"}
}
},
"PutConfigurationRecorderRequest":{
"type":"structure",
"required":["ConfigurationRecorder"],
@ -1299,6 +1931,23 @@
},
"exception":true
},
"ResourceKey":{
"type":"structure",
"required":[
"resourceType",
"resourceId"
],
"members":{
"resourceType":{"shape":"ResourceType"},
"resourceId":{"shape":"ResourceId"}
}
},
"ResourceKeys":{
"type":"list",
"member":{"shape":"ResourceKey"},
"max":100,
"min":1
},
"ResourceName":{"type":"string"},
"ResourceNotDiscoveredException":{
"type":"structure",
@ -1358,7 +2007,14 @@
"AWS::WAFRegional::Rule",
"AWS::WAFRegional::WebACL",
"AWS::CloudFront::Distribution",
"AWS::CloudFront::StreamingDistribution"
"AWS::CloudFront::StreamingDistribution",
"AWS::WAF::RuleGroup",
"AWS::WAFRegional::RuleGroup",
"AWS::Lambda::Function",
"AWS::ElasticBeanstalk::Application",
"AWS::ElasticBeanstalk::ApplicationVersion",
"AWS::ElasticBeanstalk::Environment",
"AWS::ElasticLoadBalancing::LoadBalancer"
]
},
"ResourceTypeList":{

592
vendor/github.com/aws/aws-sdk-go/models/apis/config/2014-11-12/docs-2.json generated vendored
View File

File diff suppressed because it is too large Load Diff

19
vendor/github.com/aws/aws-sdk-go/models/apis/config/2014-11-12/smoke.json generated vendored Normal file
View File

@ -0,0 +1,19 @@
{
"version": 1,
"defaultRegion": "us-west-2",
"testCases": [
{
"operationName": "DescribeConfigurationRecorders",
"input": {},
"errorExpectedFromService": false
},
{
"operationName": "GetResourceConfigHistory",
"input": {
"resourceType": "fake-type",
"resourceId": "fake-id"
},
"errorExpectedFromService": true
}
]
}

191
vendor/github.com/aws/aws-sdk-go/models/apis/connect/2017-08-08/api-2.json generated vendored Normal file
View File

@ -0,0 +1,191 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2017-08-08",
"endpointPrefix":"connect",
"jsonVersion":"1.1",
"protocol":"rest-json",
"serviceAbbreviation":"Amazon Connect",
"serviceFullName":"Amazon Connect Service",
"serviceId":"Connect",
"signatureVersion":"v4",
"signingName":"connect",
"uid":"connect-2017-08-08"
},
"operations":{
"StartOutboundVoiceContact":{
"name":"StartOutboundVoiceContact",
"http":{
"method":"PUT",
"requestUri":"/contact/outbound-voice"
},
"input":{"shape":"StartOutboundVoiceContactRequest"},
"output":{"shape":"StartOutboundVoiceContactResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServiceException"},
{"shape":"LimitExceededException"},
{"shape":"DestinationNotAllowedException"},
{"shape":"OutboundContactNotPermittedException"}
]
},
"StopContact":{
"name":"StopContact",
"http":{
"method":"POST",
"requestUri":"/contact/stop"
},
"input":{"shape":"StopContactRequest"},
"output":{"shape":"StopContactResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ContactNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServiceException"}
]
}
},
"shapes":{
"AttributeName":{
"type":"string",
"max":32767,
"min":1
},
"AttributeValue":{
"type":"string",
"max":32767,
"min":0
},
"Attributes":{
"type":"map",
"key":{"shape":"AttributeName"},
"value":{"shape":"AttributeValue"}
},
"ClientToken":{
"type":"string",
"max":500
},
"ContactFlowId":{
"type":"string",
"max":500
},
"ContactId":{
"type":"string",
"max":256,
"min":1
},
"ContactNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"Message"}
},
"error":{"httpStatusCode":410},
"exception":true
},
"DestinationNotAllowedException":{
"type":"structure",
"members":{
"Message":{"shape":"Message"}
},
"error":{"httpStatusCode":403},
"exception":true
},
"InstanceId":{"type":"string"},
"InternalServiceException":{
"type":"structure",
"members":{
"Message":{"shape":"Message"}
},
"error":{"httpStatusCode":500},
"exception":true
},
"InvalidParameterException":{
"type":"structure",
"members":{
"Message":{"shape":"Message"}
},
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidRequestException":{
"type":"structure",
"members":{
"Message":{"shape":"Message"}
},
"error":{"httpStatusCode":400},
"exception":true
},
"LimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"Message"}
},
"error":{"httpStatusCode":429},
"exception":true
},
"Message":{"type":"string"},
"OutboundContactNotPermittedException":{
"type":"structure",
"members":{
"Message":{"shape":"Message"}
},
"error":{"httpStatusCode":403},
"exception":true
},
"PhoneNumber":{"type":"string"},
"QueueId":{"type":"string"},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"Message"}
},
"error":{"httpStatusCode":404},
"exception":true
},
"StartOutboundVoiceContactRequest":{
"type":"structure",
"required":[
"DestinationPhoneNumber",
"ContactFlowId",
"InstanceId"
],
"members":{
"DestinationPhoneNumber":{"shape":"PhoneNumber"},
"ContactFlowId":{"shape":"ContactFlowId"},
"InstanceId":{"shape":"InstanceId"},
"ClientToken":{
"shape":"ClientToken",
"idempotencyToken":true
},
"SourcePhoneNumber":{"shape":"PhoneNumber"},
"QueueId":{"shape":"QueueId"},
"Attributes":{"shape":"Attributes"}
}
},
"StartOutboundVoiceContactResponse":{
"type":"structure",
"members":{
"ContactId":{"shape":"ContactId"}
}
},
"StopContactRequest":{
"type":"structure",
"required":[
"ContactId",
"InstanceId"
],
"members":{
"ContactId":{"shape":"ContactId"},
"InstanceId":{"shape":"InstanceId"}
}
},
"StopContactResponse":{
"type":"structure",
"members":{
}
}
}
}

140
vendor/github.com/aws/aws-sdk-go/models/apis/connect/2017-08-08/docs-2.json generated vendored Normal file
View File

@ -0,0 +1,140 @@
{
"version": "2.0",
"service": "<p>The Amazon Connect API Reference provides descriptions, syntax, and usage examples for each of the Amazon Connect actions, data types, parameters, and errors. Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.</p>",
"operations": {
"StartOutboundVoiceContact": "<p>The <code>StartOutboundVoiceContact</code> operation initiates a contact flow to place an outbound call to a customer.</p> <p>There is a throttling limit placed on usage of the API that includes a <code>RateLimit</code> of 2 per second, and a <code>BurstLimit</code> of 5 per second.</p> <p>If you are using an IAM account, it must have permissions to the <code>connect:StartOutboundVoiceContact</code> action.</p>",
"StopContact": "<p>Ends the contact initiated by the <code>StartOutboundVoiceContact</code> operation.</p> <p>If you are using an IAM account, it must have permissions to the <code>connect:StopContact</code> operation.</p>"
},
"shapes": {
"AttributeName": {
"base": "Key for the key value pair to be used for additional attributes.",
"refs": {
"Attributes$key": null
}
},
"AttributeValue": {
"base": "Value for the key value pair to be used for additional attributes.",
"refs": {
"Attributes$value": null
}
},
"Attributes": {
"base": "Additional attributes can be provided in the request using this field. This will be passed to the contact flow execution. Client can make use of this additional info in their contact flow.",
"refs": {
"StartOutboundVoiceContactRequest$Attributes": "<p>Specify a custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.</p> <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs. Attribute keys can include only alphanumeric, dash, and underscore characters.</p> <p>For example, to play a greeting when the customer answers the call, you can pass the customer name in attributes similar to the following:</p>"
}
},
"ClientToken": {
"base": "Dedupe token to be provided by the client. This token is used to avoid duplicate calls to the customer.",
"refs": {
"StartOutboundVoiceContactRequest$ClientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned. If the contact is disconnected, a new contact is started.</p>"
}
},
"ContactFlowId": {
"base": "Amazon resource name for the contact flow to be executed to handle the current call.",
"refs": {
"StartOutboundVoiceContactRequest$ContactFlowId": "<p>The identifier for the contact flow to execute for the outbound call. This is a GUID value only. Amazon Resource Name (ARN) values are not supported.</p> <p>To find the <code>ContactFlowId</code>, open the contact flow to use in the Amazon Connect contact flow designer. The ID for the contact flow is displayed in the address bar as part of the URL. For example, an address displayed when you open a contact flow is similar to the following: <code>https://myconnectinstance.awsapps.com/connect/contact-flows/edit?id=arn:aws:connect:us-east-1:361814831152:instance/2fb42df9-78a2-4b99-b484-f5cf80dc300c/contact-flow/<i>b0b8f2dd-ed1b-4c44-af36-ce189a178181</i> </code>. At the end of the URL, you see <code>contact-flow/b0b8f2dd-ed1b-4c44-af36-ce189a178181</code>. The <code>ContactFlowID</code> for this contact flow is <code> <i>b0b8f2dd-ed1b-4c44-af36-ce189a178181</i> </code>. Make sure to include only the GUID after the \"contact-flow/\" in your requests.</p>"
}
},
"ContactId": {
"base": "Amazon Connect contact identifier. An unique ContactId will be generated for each contact request.",
"refs": {
"StartOutboundVoiceContactResponse$ContactId": "<p>The unique identifier of this contact within your Amazon Connect instance.</p>",
"StopContactRequest$ContactId": "<p>The unique identifier of the contact to end. This is the <code>ContactId</code> value returned from the <code>StartOutboundVoiceContact</code> operation.</p>"
}
},
"ContactNotFoundException": {
"base": "<p>The contact with the specified ID is not active or does not exist.</p>",
"refs": {
}
},
"DestinationNotAllowedException": {
"base": "<p>Outbound calls to the destination number are not allowed for your instance. You can request that the country be included in the allowed countries for your instance by submitting a <a href=\"https://console.aws.amazon.com/support/v1#/case/create?issueType=service-limit-increase\">Service Limit Increase</a>.</p>",
"refs": {
}
},
"InstanceId": {
"base": "Amazon Connect Organization ARN. A client must provide its organization ARN in order to place a call. This defines the call from organization.",
"refs": {
"StartOutboundVoiceContactRequest$InstanceId": "<p>The identifier for your Amazon Connect instance. To find the <code>InstanceId</code> value for your Amazon Connect instance, open the <a href=\"https://console.aws.amazon.com/connect/\">Amazon Connect console</a>. Select the instance alias of the instance and view the instance ID in the <b>Overview</b> section. For example, the instance ID is the set of characters at the end of the instance ARN, after \"instance/\", such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</p>",
"StopContactRequest$InstanceId": "<p>The identifier of the Amazon Connect instance in which the contact is active.</p>"
}
},
"InternalServiceException": {
"base": "<p>Request processing failed due to an error or failure with the service.</p>",
"refs": {
}
},
"InvalidParameterException": {
"base": "<p>One or more of the parameters provided to the operation are not valid.</p>",
"refs": {
}
},
"InvalidRequestException": {
"base": "<p>The request is not valid.</p>",
"refs": {
}
},
"LimitExceededException": {
"base": "<p>The limit exceeded the maximum allowed active calls in a queue.</p>",
"refs": {
}
},
"Message": {
"base": null,
"refs": {
"ContactNotFoundException$Message": "<p>The message.</p>",
"DestinationNotAllowedException$Message": "<p>The message.</p>",
"InternalServiceException$Message": "<p>The message.</p>",
"InvalidParameterException$Message": "<p>The message.</p>",
"InvalidRequestException$Message": "<p>The message.</p>",
"LimitExceededException$Message": "<p>The message.</p>",
"OutboundContactNotPermittedException$Message": "<p>The message.</p>",
"ResourceNotFoundException$Message": "<p>The message.</p>"
}
},
"OutboundContactNotPermittedException": {
"base": "<p>The contact is not permitted because outbound calling is not enabled for the instance.</p>",
"refs": {
}
},
"PhoneNumber": {
"base": "End customer's phone number to call.",
"refs": {
"StartOutboundVoiceContactRequest$DestinationPhoneNumber": "<p>The phone number, in E.164 format, of the customer to call with the outbound contact.</p>",
"StartOutboundVoiceContactRequest$SourcePhoneNumber": "<p>The phone number, in E.164 format, associated with your Amazon Connect instance to use to place the outbound call.</p>"
}
},
"QueueId": {
"base": "Identifier of the queue to be used for the contact routing.",
"refs": {
"StartOutboundVoiceContactRequest$QueueId": "<p>The queue to which to add the call. If you specify a queue, the phone displayed for caller ID is the phone number defined for the queue. If you do not specify a queue, the queue used is the queue defined in the contact flow specified by <code>ContactFlowId</code>.</p> <p>To find the <code>QueueId</code>, open the queue to use in the Amazon Connect queue editor. The ID for the queue is displayed in the address bar as part of the URL. For example, the <code>QueueId</code> value is the set of characters at the end of the URL, after \"queue/\", such as <code>aeg40574-2d01-51c3-73d6-bf8624d2168c</code>.</p>"
}
},
"ResourceNotFoundException": {
"base": "<p>The specified resource was not found.</p>",
"refs": {
}
},
"StartOutboundVoiceContactRequest": {
"base": null,
"refs": {
}
},
"StartOutboundVoiceContactResponse": {
"base": null,
"refs": {
}
},
"StopContactRequest": {
"base": null,
"refs": {
}
},
"StopContactResponse": {
"base": null,
"refs": {
}
}
}
}

5
vendor/github.com/aws/aws-sdk-go/models/apis/connect/2017-08-08/examples-1.json generated vendored Normal file
View File

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

4
vendor/github.com/aws/aws-sdk-go/models/apis/connect/2017-08-08/paginators-1.json generated vendored Normal file
View File

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

508
vendor/github.com/aws/aws-sdk-go/models/apis/devicefarm/2015-06-23/api-2.json generated vendored
View File

@ -6,6 +6,7 @@
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"AWS Device Farm",
"serviceId":"Device Farm",
"signatureVersion":"v4",
"targetPrefix":"DeviceFarm_20150623",
"uid":"devicefarm-2015-06-23"
@ -26,6 +27,21 @@
{"shape":"ServiceAccountException"}
]
},
"CreateInstanceProfile":{
"name":"CreateInstanceProfile",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateInstanceProfileRequest"},
"output":{"shape":"CreateInstanceProfileResult"},
"errors":[
{"shape":"ArgumentException"},
{"shape":"NotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
]
},
"CreateNetworkProfile":{
"name":"CreateNetworkProfile",
"http":{
@ -86,6 +102,20 @@
{"shape":"ServiceAccountException"}
]
},
"CreateVPCEConfiguration":{
"name":"CreateVPCEConfiguration",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateVPCEConfigurationRequest"},
"output":{"shape":"CreateVPCEConfigurationResult"},
"errors":[
{"shape":"ArgumentException"},
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
]
},
"DeleteDevicePool":{
"name":"DeleteDevicePool",
"http":{
@ -101,6 +131,21 @@
{"shape":"ServiceAccountException"}
]
},
"DeleteInstanceProfile":{
"name":"DeleteInstanceProfile",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteInstanceProfileRequest"},
"output":{"shape":"DeleteInstanceProfileResult"},
"errors":[
{"shape":"ArgumentException"},
{"shape":"NotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
]
},
"DeleteNetworkProfile":{
"name":"DeleteNetworkProfile",
"http":{
@ -176,6 +221,21 @@
{"shape":"ServiceAccountException"}
]
},
"DeleteVPCEConfiguration":{
"name":"DeleteVPCEConfiguration",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteVPCEConfigurationRequest"},
"output":{"shape":"DeleteVPCEConfigurationResult"},
"errors":[
{"shape":"ArgumentException"},
{"shape":"NotFoundException"},
{"shape":"ServiceAccountException"},
{"shape":"InvalidOperationException"}
]
},
"GetAccountSettings":{
"name":"GetAccountSettings",
"http":{
@ -206,6 +266,21 @@
{"shape":"ServiceAccountException"}
]
},
"GetDeviceInstance":{
"name":"GetDeviceInstance",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetDeviceInstanceRequest"},
"output":{"shape":"GetDeviceInstanceResult"},
"errors":[
{"shape":"ArgumentException"},
{"shape":"NotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
]
},
"GetDevicePool":{
"name":"GetDevicePool",
"http":{
@ -236,6 +311,21 @@
{"shape":"ServiceAccountException"}
]
},
"GetInstanceProfile":{
"name":"GetInstanceProfile",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetInstanceProfileRequest"},
"output":{"shape":"GetInstanceProfileResult"},
"errors":[
{"shape":"ArgumentException"},
{"shape":"NotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
]
},
"GetJob":{
"name":"GetJob",
"http":{
@ -372,6 +462,20 @@
{"shape":"ServiceAccountException"}
]
},
"GetVPCEConfiguration":{
"name":"GetVPCEConfiguration",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetVPCEConfigurationRequest"},
"output":{"shape":"GetVPCEConfigurationResult"},
"errors":[
{"shape":"ArgumentException"},
{"shape":"NotFoundException"},
{"shape":"ServiceAccountException"}
]
},
"InstallToRemoteAccessSession":{
"name":"InstallToRemoteAccessSession",
"http":{
@ -402,6 +506,21 @@
{"shape":"ServiceAccountException"}
]
},
"ListDeviceInstances":{
"name":"ListDeviceInstances",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListDeviceInstancesRequest"},
"output":{"shape":"ListDeviceInstancesResult"},
"errors":[
{"shape":"ArgumentException"},
{"shape":"NotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
]
},
"ListDevicePools":{
"name":"ListDevicePools",
"http":{
@ -432,6 +551,21 @@
{"shape":"ServiceAccountException"}
]
},
"ListInstanceProfiles":{
"name":"ListInstanceProfiles",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListInstanceProfilesRequest"},
"output":{"shape":"ListInstanceProfilesResult"},
"errors":[
{"shape":"ArgumentException"},
{"shape":"NotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
]
},
"ListJobs":{
"name":"ListJobs",
"http":{
@ -630,6 +764,19 @@
{"shape":"ServiceAccountException"}
]
},
"ListVPCEConfigurations":{
"name":"ListVPCEConfigurations",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListVPCEConfigurationsRequest"},
"output":{"shape":"ListVPCEConfigurationsResult"},
"errors":[
{"shape":"ArgumentException"},
{"shape":"ServiceAccountException"}
]
},
"PurchaseOffering":{
"name":"PurchaseOffering",
"http":{
@ -708,6 +855,21 @@
{"shape":"ServiceAccountException"}
]
},
"UpdateDeviceInstance":{
"name":"UpdateDeviceInstance",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateDeviceInstanceRequest"},
"output":{"shape":"UpdateDeviceInstanceResult"},
"errors":[
{"shape":"ArgumentException"},
{"shape":"NotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
]
},
"UpdateDevicePool":{
"name":"UpdateDevicePool",
"http":{
@ -723,6 +885,21 @@
{"shape":"ServiceAccountException"}
]
},
"UpdateInstanceProfile":{
"name":"UpdateInstanceProfile",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateInstanceProfileRequest"},
"output":{"shape":"UpdateInstanceProfileResult"},
"errors":[
{"shape":"ArgumentException"},
{"shape":"NotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
]
},
"UpdateNetworkProfile":{
"name":"UpdateNetworkProfile",
"http":{
@ -752,6 +929,21 @@
{"shape":"LimitExceededException"},
{"shape":"ServiceAccountException"}
]
},
"UpdateVPCEConfiguration":{
"name":"UpdateVPCEConfiguration",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateVPCEConfigurationRequest"},
"output":{"shape":"UpdateVPCEConfigurationResult"},
"errors":[
{"shape":"ArgumentException"},
{"shape":"NotFoundException"},
{"shape":"ServiceAccountException"},
{"shape":"InvalidOperationException"}
]
}
},
"shapes":{
@ -769,7 +961,8 @@
"maxJobTimeoutMinutes":{"shape":"JobTimeoutMinutes"},
"trialMinutes":{"shape":"TrialMinutes"},
"maxSlots":{"shape":"MaxSlotMap"},
"defaultJobTimeoutMinutes":{"shape":"JobTimeoutMinutes"}
"defaultJobTimeoutMinutes":{"shape":"JobTimeoutMinutes"},
"skipAppResign":{"shape":"SkipAppResign"}
}
},
"AccountsCleanup":{"type":"boolean"},
@ -905,6 +1098,23 @@
"devicePool":{"shape":"DevicePool"}
}
},
"CreateInstanceProfileRequest":{
"type":"structure",
"required":["name"],
"members":{
"name":{"shape":"Name"},
"description":{"shape":"Message"},
"packageCleanup":{"shape":"Boolean"},
"excludeAppPackagesFromCleanup":{"shape":"PackageIds"},
"rebootAfterUse":{"shape":"Boolean"}
}
},
"CreateInstanceProfileResult":{
"type":"structure",
"members":{
"instanceProfile":{"shape":"InstanceProfile"}
}
},
"CreateNetworkProfileRequest":{
"type":"structure",
"required":[
@ -961,6 +1171,7 @@
"members":{
"projectArn":{"shape":"AmazonResourceName"},
"deviceArn":{"shape":"AmazonResourceName"},
"instanceArn":{"shape":"AmazonResourceName"},
"sshPublicKey":{"shape":"SshPublicKey"},
"remoteDebugEnabled":{"shape":"Boolean"},
"remoteRecordEnabled":{"shape":"Boolean"},
@ -968,7 +1179,8 @@
"name":{"shape":"Name"},
"clientId":{"shape":"ClientId"},
"configuration":{"shape":"CreateRemoteAccessSessionConfiguration"},
"interactionMode":{"shape":"InteractionMode"}
"interactionMode":{"shape":"InteractionMode"},
"skipAppResign":{"shape":"Boolean"}
}
},
"CreateRemoteAccessSessionResult":{
@ -997,6 +1209,26 @@
"upload":{"shape":"Upload"}
}
},
"CreateVPCEConfigurationRequest":{
"type":"structure",
"required":[
"vpceConfigurationName",
"vpceServiceName",
"serviceDnsName"
],
"members":{
"vpceConfigurationName":{"shape":"VPCEConfigurationName"},
"vpceServiceName":{"shape":"VPCEServiceName"},
"serviceDnsName":{"shape":"ServiceDnsName"},
"vpceConfigurationDescription":{"shape":"VPCEConfigurationDescription"}
}
},
"CreateVPCEConfigurationResult":{
"type":"structure",
"members":{
"vpceConfiguration":{"shape":"VPCEConfiguration"}
}
},
"CurrencyCode":{
"type":"string",
"enum":["USD"]
@ -1022,6 +1254,18 @@
"members":{
}
},
"DeleteInstanceProfileRequest":{
"type":"structure",
"required":["arn"],
"members":{
"arn":{"shape":"AmazonResourceName"}
}
},
"DeleteInstanceProfileResult":{
"type":"structure",
"members":{
}
},
"DeleteNetworkProfileRequest":{
"type":"structure",
"required":["arn"],
@ -1082,6 +1326,18 @@
"members":{
}
},
"DeleteVPCEConfigurationRequest":{
"type":"structure",
"required":["arn"],
"members":{
"arn":{"shape":"AmazonResourceName"}
}
},
"DeleteVPCEConfigurationResult":{
"type":"structure",
"members":{
}
},
"Device":{
"type":"structure",
"members":{
@ -1103,7 +1359,8 @@
"remoteAccessEnabled":{"shape":"Boolean"},
"remoteDebugEnabled":{"shape":"Boolean"},
"fleetType":{"shape":"String"},
"fleetName":{"shape":"String"}
"fleetName":{"shape":"String"},
"instances":{"shape":"DeviceInstances"}
}
},
"DeviceAttribute":{
@ -1115,7 +1372,10 @@
"MANUFACTURER",
"REMOTE_ACCESS_ENABLED",
"REMOTE_DEBUG_ENABLED",
"APPIUM_VERSION"
"APPIUM_VERSION",
"INSTANCE_ARN",
"INSTANCE_LABELS",
"FLEET_TYPE"
]
},
"DeviceFormFactor":{
@ -1129,6 +1389,21 @@
"type":"list",
"member":{"shape":"String"}
},
"DeviceInstance":{
"type":"structure",
"members":{
"arn":{"shape":"AmazonResourceName"},
"deviceArn":{"shape":"AmazonResourceName"},
"labels":{"shape":"InstanceLabels"},
"status":{"shape":"InstanceStatus"},
"udid":{"shape":"String"},
"instanceProfile":{"shape":"InstanceProfile"}
}
},
"DeviceInstances":{
"type":"list",
"member":{"shape":"DeviceInstance"}
},
"DeviceMinutes":{
"type":"structure",
"members":{
@ -1187,7 +1462,8 @@
"members":{
"jobTimeoutMinutes":{"shape":"JobTimeoutMinutes"},
"accountsCleanup":{"shape":"AccountsCleanup"},
"appPackagesCleanup":{"shape":"AppPackagesCleanup"}
"appPackagesCleanup":{"shape":"AppPackagesCleanup"},
"skipAppResign":{"shape":"SkipAppResign"}
}
},
"ExecutionResult":{
@ -1204,7 +1480,10 @@
},
"ExecutionResultCode":{
"type":"string",
"enum":["PARSING_FAILED"]
"enum":[
"PARSING_FAILED",
"VPC_ENDPOINT_SETUP_FAILED"
]
},
"ExecutionStatus":{
"type":"string",
@ -1236,6 +1515,19 @@
"accountSettings":{"shape":"AccountSettings"}
}
},
"GetDeviceInstanceRequest":{
"type":"structure",
"required":["arn"],
"members":{
"arn":{"shape":"AmazonResourceName"}
}
},
"GetDeviceInstanceResult":{
"type":"structure",
"members":{
"deviceInstance":{"shape":"DeviceInstance"}
}
},
"GetDevicePoolCompatibilityRequest":{
"type":"structure",
"required":["devicePoolArn"],
@ -1243,7 +1535,8 @@
"devicePoolArn":{"shape":"AmazonResourceName"},
"appArn":{"shape":"AmazonResourceName"},
"testType":{"shape":"TestType"},
"test":{"shape":"ScheduleRunTest"}
"test":{"shape":"ScheduleRunTest"},
"configuration":{"shape":"ScheduleRunConfiguration"}
}
},
"GetDevicePoolCompatibilityResult":{
@ -1279,6 +1572,19 @@
"device":{"shape":"Device"}
}
},
"GetInstanceProfileRequest":{
"type":"structure",
"required":["arn"],
"members":{
"arn":{"shape":"AmazonResourceName"}
}
},
"GetInstanceProfileResult":{
"type":"structure",
"members":{
"instanceProfile":{"shape":"InstanceProfile"}
}
},
"GetJobRequest":{
"type":"structure",
"required":["arn"],
@ -1397,6 +1703,19 @@
"upload":{"shape":"Upload"}
}
},
"GetVPCEConfigurationRequest":{
"type":"structure",
"required":["arn"],
"members":{
"arn":{"shape":"AmazonResourceName"}
}
},
"GetVPCEConfigurationResult":{
"type":"structure",
"members":{
"vpceConfiguration":{"shape":"VPCEConfiguration"}
}
},
"HostAddress":{
"type":"string",
"max":1024
@ -1436,6 +1755,34 @@
"appUpload":{"shape":"Upload"}
}
},
"InstanceLabels":{
"type":"list",
"member":{"shape":"String"}
},
"InstanceProfile":{
"type":"structure",
"members":{
"arn":{"shape":"AmazonResourceName"},
"packageCleanup":{"shape":"Boolean"},
"excludeAppPackagesFromCleanup":{"shape":"PackageIds"},
"rebootAfterUse":{"shape":"Boolean"},
"name":{"shape":"Name"},
"description":{"shape":"Message"}
}
},
"InstanceProfiles":{
"type":"list",
"member":{"shape":"InstanceProfile"}
},
"InstanceStatus":{
"type":"string",
"enum":[
"IN_USE",
"PREPARING",
"AVAILABLE",
"NOT_AVAILABLE"
]
},
"Integer":{"type":"integer"},
"InteractionMode":{
"type":"string",
@ -1447,6 +1794,13 @@
"max":64,
"min":0
},
"InvalidOperationException":{
"type":"structure",
"members":{
"message":{"shape":"Message"}
},
"exception":true
},
"IosPaths":{
"type":"list",
"member":{"shape":"String"}
@ -1465,6 +1819,7 @@
"counters":{"shape":"Counters"},
"message":{"shape":"Message"},
"device":{"shape":"Device"},
"instanceArn":{"shape":"AmazonResourceName"},
"deviceMinutes":{"shape":"DeviceMinutes"}
}
},
@ -1499,6 +1854,20 @@
"nextToken":{"shape":"PaginationToken"}
}
},
"ListDeviceInstancesRequest":{
"type":"structure",
"members":{
"maxResults":{"shape":"Integer"},
"nextToken":{"shape":"PaginationToken"}
}
},
"ListDeviceInstancesResult":{
"type":"structure",
"members":{
"deviceInstances":{"shape":"DeviceInstances"},
"nextToken":{"shape":"PaginationToken"}
}
},
"ListDevicePoolsRequest":{
"type":"structure",
"required":["arn"],
@ -1529,6 +1898,20 @@
"nextToken":{"shape":"PaginationToken"}
}
},
"ListInstanceProfilesRequest":{
"type":"structure",
"members":{
"maxResults":{"shape":"Integer"},
"nextToken":{"shape":"PaginationToken"}
}
},
"ListInstanceProfilesResult":{
"type":"structure",
"members":{
"instanceProfiles":{"shape":"InstanceProfiles"},
"nextToken":{"shape":"PaginationToken"}
}
},
"ListJobsRequest":{
"type":"structure",
"required":["arn"],
@ -1718,6 +2101,20 @@
"nextToken":{"shape":"PaginationToken"}
}
},
"ListVPCEConfigurationsRequest":{
"type":"structure",
"members":{
"maxResults":{"shape":"Integer"},
"nextToken":{"shape":"PaginationToken"}
}
},
"ListVPCEConfigurationsResult":{
"type":"structure",
"members":{
"vpceConfigurations":{"shape":"VPCEConfigurations"},
"nextToken":{"shape":"PaginationToken"}
}
},
"Location":{
"type":"structure",
"required":[
@ -1872,6 +2269,10 @@
"type":"list",
"member":{"shape":"Offering"}
},
"PackageIds":{
"type":"list",
"member":{"shape":"String"}
},
"PaginationToken":{
"type":"string",
"max":1024,
@ -1973,6 +2374,7 @@
"started":{"shape":"DateTime"},
"stopped":{"shape":"DateTime"},
"device":{"shape":"Device"},
"instanceArn":{"shape":"AmazonResourceName"},
"remoteDebugEnabled":{"shape":"Boolean"},
"remoteRecordEnabled":{"shape":"Boolean"},
"remoteRecordAppArn":{"shape":"AmazonResourceName"},
@ -1982,7 +2384,8 @@
"deviceMinutes":{"shape":"DeviceMinutes"},
"endpoint":{"shape":"String"},
"deviceUdid":{"shape":"String"},
"interactionMode":{"shape":"InteractionMode"}
"interactionMode":{"shape":"InteractionMode"},
"skipAppResign":{"shape":"SkipAppResign"}
}
},
"RemoteAccessSessions":{
@ -2062,7 +2465,8 @@
"radios":{"shape":"Radios"},
"location":{"shape":"Location"},
"customerArtifactPaths":{"shape":"CustomerArtifactPaths"},
"webUrl":{"shape":"String"}
"webUrl":{"shape":"String"},
"skipAppResign":{"shape":"SkipAppResign"}
}
},
"Runs":{
@ -2110,6 +2514,7 @@
"networkProfileArn":{"shape":"AmazonResourceName"},
"locale":{"shape":"String"},
"location":{"shape":"Location"},
"vpceConfigurationArns":{"shape":"AmazonResourceNames"},
"customerArtifactPaths":{"shape":"CustomerArtifactPaths"},
"radios":{"shape":"Radios"},
"auxiliaryApps":{"shape":"AmazonResourceNames"},
@ -2156,6 +2561,12 @@
},
"exception":true
},
"ServiceDnsName":{
"type":"string",
"max":2048,
"min":0
},
"SkipAppResign":{"type":"boolean"},
"SshPublicKey":{
"type":"string",
"max":8192,
@ -2287,6 +2698,21 @@
"key":{"shape":"ExecutionResult"},
"value":{"shape":"UniqueProblems"}
},
"UpdateDeviceInstanceRequest":{
"type":"structure",
"required":["arn"],
"members":{
"arn":{"shape":"AmazonResourceName"},
"profileArn":{"shape":"AmazonResourceName"},
"labels":{"shape":"InstanceLabels"}
}
},
"UpdateDeviceInstanceResult":{
"type":"structure",
"members":{
"deviceInstance":{"shape":"DeviceInstance"}
}
},
"UpdateDevicePoolRequest":{
"type":"structure",
"required":["arn"],
@ -2303,6 +2729,24 @@
"devicePool":{"shape":"DevicePool"}
}
},
"UpdateInstanceProfileRequest":{
"type":"structure",
"required":["arn"],
"members":{
"arn":{"shape":"AmazonResourceName"},
"name":{"shape":"Name"},
"description":{"shape":"Message"},
"packageCleanup":{"shape":"Boolean"},
"excludeAppPackagesFromCleanup":{"shape":"PackageIds"},
"rebootAfterUse":{"shape":"Boolean"}
}
},
"UpdateInstanceProfileResult":{
"type":"structure",
"members":{
"instanceProfile":{"shape":"InstanceProfile"}
}
},
"UpdateNetworkProfileRequest":{
"type":"structure",
"required":["arn"],
@ -2342,6 +2786,23 @@
"project":{"shape":"Project"}
}
},
"UpdateVPCEConfigurationRequest":{
"type":"structure",
"required":["arn"],
"members":{
"arn":{"shape":"AmazonResourceName"},
"vpceConfigurationName":{"shape":"VPCEConfigurationName"},
"vpceServiceName":{"shape":"VPCEServiceName"},
"serviceDnsName":{"shape":"ServiceDnsName"},
"vpceConfigurationDescription":{"shape":"VPCEConfigurationDescription"}
}
},
"UpdateVPCEConfigurationResult":{
"type":"structure",
"members":{
"vpceConfiguration":{"shape":"VPCEConfiguration"}
}
},
"Upload":{
"type":"structure",
"members":{
@ -2389,6 +2850,35 @@
"Uploads":{
"type":"list",
"member":{"shape":"Upload"}
},
"VPCEConfiguration":{
"type":"structure",
"members":{
"arn":{"shape":"AmazonResourceName"},
"vpceConfigurationName":{"shape":"VPCEConfigurationName"},
"vpceServiceName":{"shape":"VPCEServiceName"},
"serviceDnsName":{"shape":"ServiceDnsName"},
"vpceConfigurationDescription":{"shape":"VPCEConfigurationDescription"}
}
},
"VPCEConfigurationDescription":{
"type":"string",
"max":2048,
"min":0
},
"VPCEConfigurationName":{
"type":"string",
"max":1024,
"min":0
},
"VPCEConfigurations":{
"type":"list",
"member":{"shape":"VPCEConfiguration"}
},
"VPCEServiceName":{
"type":"string",
"max":2048,
"min":0
}
}
}

316
vendor/github.com/aws/aws-sdk-go/models/apis/devicefarm/2015-06-23/docs-2.json generated vendored
View File

@ -3,20 +3,26 @@
"service": "<p>AWS Device Farm is a service that enables mobile app developers to test Android, iOS, and Fire OS apps on physical phones, tablets, and other devices in the cloud.</p>",
"operations": {
"CreateDevicePool": "<p>Creates a device pool.</p>",
"CreateInstanceProfile": "<p>Creates a profile that can be applied to one or more private fleet device instances.</p>",
"CreateNetworkProfile": "<p>Creates a network profile.</p>",
"CreateProject": "<p>Creates a new project.</p>",
"CreateRemoteAccessSession": "<p>Specifies and starts a remote access session.</p>",
"CreateUpload": "<p>Uploads an app or test scripts.</p>",
"CreateVPCEConfiguration": "<p>Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.</p>",
"DeleteDevicePool": "<p>Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.</p>",
"DeleteInstanceProfile": "<p>Deletes a profile that can be applied to one or more private device instances.</p>",
"DeleteNetworkProfile": "<p>Deletes a network profile.</p>",
"DeleteProject": "<p>Deletes an AWS Device Farm project, given the project ARN.</p> <p> <b>Note</b> Deleting this resource does not stop an in-progress run.</p>",
"DeleteRemoteAccessSession": "<p>Deletes a completed remote access session and its results.</p>",
"DeleteRun": "<p>Deletes the run, given the run ARN.</p> <p> <b>Note</b> Deleting this resource does not stop an in-progress run.</p>",
"DeleteUpload": "<p>Deletes an upload given the upload ARN.</p>",
"DeleteVPCEConfiguration": "<p>Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.</p>",
"GetAccountSettings": "<p>Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account.</p>",
"GetDevice": "<p>Gets information about a unique device type.</p>",
"GetDeviceInstance": "<p>Returns information about a device instance belonging to a private device fleet.</p>",
"GetDevicePool": "<p>Gets information about a device pool.</p>",
"GetDevicePoolCompatibility": "<p>Gets information about compatibility with a device pool.</p>",
"GetInstanceProfile": "<p>Returns information about the specified instance profile.</p>",
"GetJob": "<p>Gets information about a job.</p>",
"GetNetworkProfile": "<p>Returns information about a network profile.</p>",
"GetOfferingStatus": "<p>Gets the current status and future status of all offerings purchased by an AWS account. The response indicates how many offerings are currently available and the offerings that will be available in the next period. The API returns a <code>NotEligible</code> error if the user is not permitted to invoke the operation. Please contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a> if you believe that you should be able to invoke this operation.</p>",
@ -26,10 +32,13 @@
"GetSuite": "<p>Gets information about a suite.</p>",
"GetTest": "<p>Gets information about a test.</p>",
"GetUpload": "<p>Gets information about an upload.</p>",
"GetVPCEConfiguration": "<p>Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.</p>",
"InstallToRemoteAccessSession": "<p>Installs an application to the device in a remote access session. For Android applications, the file must be in .apk format. For iOS applications, the file must be in .ipa format.</p>",
"ListArtifacts": "<p>Gets information about artifacts.</p>",
"ListDeviceInstances": "<p>Returns information about the private device instances associated with one or more AWS accounts.</p>",
"ListDevicePools": "<p>Gets information about device pools.</p>",
"ListDevices": "<p>Gets information about unique device types.</p>",
"ListInstanceProfiles": "<p>Returns information about all the instance profiles in an AWS account.</p>",
"ListJobs": "<p>Gets information about jobs for a given test run.</p>",
"ListNetworkProfiles": "<p>Returns the list of available network profiles.</p>",
"ListOfferingPromotions": "<p>Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a <code>NotEligible</code> error if the caller is not permitted to invoke the operation. Contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a> if you believe that you should be able to invoke this operation.</p>",
@ -43,14 +52,18 @@
"ListTests": "<p>Gets information about tests in a given test suite.</p>",
"ListUniqueProblems": "<p>Gets information about unique problems.</p>",
"ListUploads": "<p>Gets information about uploads, given an AWS Device Farm project ARN.</p>",
"ListVPCEConfigurations": "<p>Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.</p>",
"PurchaseOffering": "<p>Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was overridden. The API returns a <code>NotEligible</code> error if the user is not permitted to invoke the operation. Please contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a> if you believe that you should be able to invoke this operation.</p>",
"RenewOffering": "<p>Explicitly sets the quantity of devices to renew for an offering, starting from the <code>effectiveDate</code> of the next period. The API returns a <code>NotEligible</code> error if the user is not permitted to invoke the operation. Please contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a> if you believe that you should be able to invoke this operation.</p>",
"ScheduleRun": "<p>Schedules a run.</p>",
"StopRemoteAccessSession": "<p>Ends a specified remote access session.</p>",
"StopRun": "<p>Initiates a stop request for the current test run. AWS Device Farm will immediately stop the run on devices where tests have not started executing, and you will not be billed for these devices. On devices where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on those devices. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.</p>",
"UpdateDeviceInstance": "<p>Updates information about an existing private device instance.</p>",
"UpdateDevicePool": "<p>Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all).</p>",
"UpdateInstanceProfile": "<p>Updates information about an existing private device instance profile.</p>",
"UpdateNetworkProfile": "<p>Updates the network profile with specific settings.</p>",
"UpdateProject": "<p>Modifies the specified project name, given the project ARN and a new name.</p>"
"UpdateProject": "<p>Modifies the specified project name, given the project ARN and a new name.</p>",
"UpdateVPCEConfiguration": "<p>Updates information about an existing Amazon Virtual Private Cloud (VPC) endpoint configuration.</p>"
},
"shapes": {
"AWSAccountNumber": {
@ -80,20 +93,27 @@
"CreateNetworkProfileRequest$projectArn": "<p>The Amazon Resource Name (ARN) of the project for which you want to create a network profile.</p>",
"CreateRemoteAccessSessionRequest$projectArn": "<p>The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.</p>",
"CreateRemoteAccessSessionRequest$deviceArn": "<p>The Amazon Resource Name (ARN) of the device for which you want to create a remote access session.</p>",
"CreateRemoteAccessSessionRequest$instanceArn": "<p>The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.</p>",
"CreateRemoteAccessSessionRequest$remoteRecordAppArn": "<p>The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.</p>",
"CreateUploadRequest$projectArn": "<p>The ARN of the project for the upload.</p>",
"DeleteDevicePoolRequest$arn": "<p>Represents the Amazon Resource Name (ARN) of the Device Farm device pool you wish to delete.</p>",
"DeleteInstanceProfileRequest$arn": "<p>The Amazon Resource Name (ARN) of the instance profile you are requesting to delete.</p>",
"DeleteNetworkProfileRequest$arn": "<p>The Amazon Resource Name (ARN) of the network profile you want to delete.</p>",
"DeleteProjectRequest$arn": "<p>Represents the Amazon Resource Name (ARN) of the Device Farm project you wish to delete.</p>",
"DeleteRemoteAccessSessionRequest$arn": "<p>The Amazon Resource Name (ARN) of the sesssion for which you want to delete remote access.</p>",
"DeleteRunRequest$arn": "<p>The Amazon Resource Name (ARN) for the run you wish to delete.</p>",
"DeleteUploadRequest$arn": "<p>Represents the Amazon Resource Name (ARN) of the Device Farm upload you wish to delete.</p>",
"DeleteVPCEConfigurationRequest$arn": "<p>The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to delete.</p>",
"Device$arn": "<p>The device's ARN.</p>",
"DeviceInstance$arn": "<p>The Amazon Resource Name (ARN) of the device instance.</p>",
"DeviceInstance$deviceArn": "<p>The Amazon Resource Name (ARN) of the device.</p>",
"DevicePool$arn": "<p>The device pool's ARN.</p>",
"GetDeviceInstanceRequest$arn": "<p>The Amazon Resource Name (ARN) of the instance you're requesting information about.</p>",
"GetDevicePoolCompatibilityRequest$devicePoolArn": "<p>The device pool's ARN.</p>",
"GetDevicePoolCompatibilityRequest$appArn": "<p>The ARN of the app that is associated with the specified device pool.</p>",
"GetDevicePoolRequest$arn": "<p>The device pool's ARN.</p>",
"GetDeviceRequest$arn": "<p>The device type's ARN.</p>",
"GetInstanceProfileRequest$arn": "<p>The Amazon Resource Name (ARN) of your instance profile.</p>",
"GetJobRequest$arn": "<p>The job's ARN.</p>",
"GetNetworkProfileRequest$arn": "<p>The Amazon Resource Name (ARN) of the network profile you want to return information about.</p>",
"GetProjectRequest$arn": "<p>The project's ARN.</p>",
@ -102,9 +122,12 @@
"GetSuiteRequest$arn": "<p>The suite's ARN.</p>",
"GetTestRequest$arn": "<p>The test's ARN.</p>",
"GetUploadRequest$arn": "<p>The upload's ARN.</p>",
"GetVPCEConfigurationRequest$arn": "<p>The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to describe.</p>",
"InstallToRemoteAccessSessionRequest$remoteAccessSessionArn": "<p>The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.</p>",
"InstallToRemoteAccessSessionRequest$appArn": "<p>The Amazon Resource Name (ARN) of the app about which you are requesting information.</p>",
"InstanceProfile$arn": "<p>The Amazon Resource Name (ARN) of the instance profile.</p>",
"Job$arn": "<p>The job's ARN.</p>",
"Job$instanceArn": "<p>The Amazon Resource Name (ARN) of the instance.</p>",
"ListArtifactsRequest$arn": "<p>The Run, Job, Suite, or Test ARN.</p>",
"ListDevicePoolsRequest$arn": "<p>The project ARN.</p>",
"ListDevicesRequest$arn": "<p>The Amazon Resource Name (ARN) of the project.</p>",
@ -122,6 +145,7 @@
"ProblemDetail$arn": "<p>The problem detail's ARN.</p>",
"Project$arn": "<p>The project's ARN.</p>",
"RemoteAccessSession$arn": "<p>The Amazon Resource Name (ARN) of the remote access session.</p>",
"RemoteAccessSession$instanceArn": "<p>The Amazon Resource Name (ARN) of the instance.</p>",
"RemoteAccessSession$remoteRecordAppArn": "<p>The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.</p>",
"Run$arn": "<p>The run's ARN.</p>",
"Run$appUpload": "<p>An app to upload or that has been uploaded.</p>",
@ -137,15 +161,21 @@
"StopRunRequest$arn": "<p>Represents the Amazon Resource Name (ARN) of the Device Farm run you wish to stop.</p>",
"Suite$arn": "<p>The suite's ARN.</p>",
"Test$arn": "<p>The test's ARN.</p>",
"UpdateDeviceInstanceRequest$arn": "<p>The Amazon Resource Name (ARN) of the device instance.</p>",
"UpdateDeviceInstanceRequest$profileArn": "<p>The Amazon Resource Name (ARN) of the profile that you want to associate with the device instance.</p>",
"UpdateDevicePoolRequest$arn": "<p>The Amazon Resourc Name (ARN) of the Device Farm device pool you wish to update.</p>",
"UpdateInstanceProfileRequest$arn": "<p>The Amazon Resource Name (ARN) of the instance profile.</p>",
"UpdateNetworkProfileRequest$arn": "<p>The Amazon Resource Name (ARN) of the project for which you want to update network profile settings.</p>",
"UpdateProjectRequest$arn": "<p>The Amazon Resource Name (ARN) of the project whose name you wish to update.</p>",
"Upload$arn": "<p>The upload's ARN.</p>"
"UpdateVPCEConfigurationRequest$arn": "<p>The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to update.</p>",
"Upload$arn": "<p>The upload's ARN.</p>",
"VPCEConfiguration$arn": "<p>The Amazon Resource Name (ARN) of the VPC endpoint configuration.</p>"
}
},
"AmazonResourceNames": {
"base": null,
"refs": {
"ScheduleRunConfiguration$vpceConfigurationArns": "<p>An array of Amazon Resource Names (ARNs) for your VPC endpoint configurations.</p>",
"ScheduleRunConfiguration$auxiliaryApps": "<p>A list of auxiliary apps for the run.</p>"
}
},
@ -193,7 +223,7 @@
"BillingMethod": {
"base": null,
"refs": {
"CreateRemoteAccessSessionConfiguration$billingMethod": "<p>Returns the billing method for purposes of configuring a remote access session.</p>",
"CreateRemoteAccessSessionConfiguration$billingMethod": "<p>The billing method for the remote access session.</p>",
"RemoteAccessSession$billingMethod": "<p>The billing method of the remote access session. Possible values include <code>METERED</code> or <code>UNMETERED</code>. For more information about metered devices, see <a href=\"http://docs.aws.amazon.com/devicefarm/latest/developerguide/welcome.html#welcome-terminology\">AWS Device Farm terminology</a>.\"</p>",
"Run$billingMethod": "<p>Specifies the billing method for a test run: <code>metered</code> or <code>unmetered</code>. If the parameter is not specified, the default value is <code>metered</code>.</p>",
"ScheduleRunConfiguration$billingMethod": "<p>Specifies the billing method for a test run: <code>metered</code> or <code>unmetered</code>. If the parameter is not specified, the default value is <code>metered</code>.</p>"
@ -202,17 +232,24 @@
"Boolean": {
"base": null,
"refs": {
"CreateInstanceProfileRequest$packageCleanup": "<p>When set to <code>true</code>, Device Farm will remove app packages after a test run. The default value is <code>false</code> for private devices.</p>",
"CreateInstanceProfileRequest$rebootAfterUse": "<p>When set to <code>true</code>, Device Farm will reboot the instance after a test run. The default value is <code>true</code>.</p>",
"CreateRemoteAccessSessionRequest$remoteDebugEnabled": "<p>Set to <code>true</code> if you want to access devices remotely for debugging in your remote access session.</p>",
"CreateRemoteAccessSessionRequest$remoteRecordEnabled": "<p>Set to <code>true</code> to enable remote recording for the remote access session.</p>",
"CreateRemoteAccessSessionRequest$skipAppResign": "<p>When set to <code>true</code>, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.</p> <p>For more information about how Device Farm re-signs your app(s), see <a href=\"https://aws.amazon.com/device-farm/faq/\">Do you modify my app?</a> in the <i>AWS Device Farm FAQs</i>.</p>",
"Device$remoteAccessEnabled": "<p>Specifies whether remote access has been enabled for the specified device.</p>",
"Device$remoteDebugEnabled": "<p>This flag is set to <code>true</code> if remote debugging is enabled for the device.</p>",
"DevicePoolCompatibilityResult$compatible": "<p>Whether the result was compatible with the device pool.</p>",
"InstanceProfile$packageCleanup": "<p>When set to <code>true</code>, Device Farm will remove app packages after a test run. The default value is <code>false</code> for private devices.</p>",
"InstanceProfile$rebootAfterUse": "<p>When set to <code>true</code>, Device Farm will reboot the instance after a test run. The default value is <code>true</code>.</p>",
"Radios$wifi": "<p>True if Wi-Fi is enabled at the beginning of the test; otherwise, false.</p>",
"Radios$bluetooth": "<p>True if Bluetooth is enabled at the beginning of the test; otherwise, false.</p>",
"Radios$nfc": "<p>True if NFC is enabled at the beginning of the test; otherwise, false.</p>",
"Radios$gps": "<p>True if GPS is enabled at the beginning of the test; otherwise, false.</p>",
"RemoteAccessSession$remoteDebugEnabled": "<p>This flag is set to <code>true</code> if remote debugging is enabled for the remote access session.</p>",
"RemoteAccessSession$remoteRecordEnabled": "<p>This flag is set to <code>true</code> if remote recording is enabled for the remote access session.</p>"
"RemoteAccessSession$remoteRecordEnabled": "<p>This flag is set to <code>true</code> if remote recording is enabled for the remote access session.</p>",
"UpdateInstanceProfileRequest$packageCleanup": "<p>The updated choice for whether you want to specify package cleanup. The default value is <code>false</code> for private devices.</p>",
"UpdateInstanceProfileRequest$rebootAfterUse": "<p>The updated choice for whether you want to reboot the device after use. The default value is <code>true</code>.</p>"
}
},
"CPU": {
@ -254,6 +291,16 @@
"refs": {
}
},
"CreateInstanceProfileRequest": {
"base": null,
"refs": {
}
},
"CreateInstanceProfileResult": {
"base": null,
"refs": {
}
},
"CreateNetworkProfileRequest": {
"base": null,
"refs": {
@ -275,7 +322,7 @@
}
},
"CreateRemoteAccessSessionConfiguration": {
"base": "<p>Creates the configuration settings for a remote access session, including the device model and type.</p>",
"base": "<p>Configuration settings for a remote access session, including billing method.</p>",
"refs": {
"CreateRemoteAccessSessionRequest$configuration": "<p>The configuration information for the remote access session request.</p>"
}
@ -300,6 +347,16 @@
"refs": {
}
},
"CreateVPCEConfigurationRequest": {
"base": null,
"refs": {
}
},
"CreateVPCEConfigurationResult": {
"base": null,
"refs": {
}
},
"CurrencyCode": {
"base": null,
"refs": {
@ -347,6 +404,16 @@
"refs": {
}
},
"DeleteInstanceProfileRequest": {
"base": null,
"refs": {
}
},
"DeleteInstanceProfileResult": {
"base": null,
"refs": {
}
},
"DeleteNetworkProfileRequest": {
"base": null,
"refs": {
@ -397,6 +464,16 @@
"refs": {
}
},
"DeleteVPCEConfigurationRequest": {
"base": null,
"refs": {
}
},
"DeleteVPCEConfigurationResult": {
"base": null,
"refs": {
}
},
"Device": {
"base": "<p>Represents a device type that an app is tested against.</p>",
"refs": {
@ -412,7 +489,7 @@
"base": null,
"refs": {
"IncompatibilityMessage$type": "<p>The type of incompatibility.</p> <p>Allowed values include:</p> <ul> <li> <p>ARN: The ARN.</p> </li> <li> <p>FORM_FACTOR: The form factor (for example, phone or tablet).</p> </li> <li> <p>MANUFACTURER: The manufacturer.</p> </li> <li> <p>PLATFORM: The platform (for example, Android or iOS).</p> </li> <li> <p>REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.</p> </li> <li> <p>APPIUM_VERSION: The Appium version for the test.</p> </li> </ul>",
"Rule$attribute": "<p>The rule's stringified attribute. For example, specify the value as <code>\"\\\"abc\\\"\"</code>.</p> <p>Allowed values include:</p> <ul> <li> <p>ARN: The ARN.</p> </li> <li> <p>FORM_FACTOR: The form factor (for example, phone or tablet).</p> </li> <li> <p>MANUFACTURER: The manufacturer.</p> </li> <li> <p>PLATFORM: The platform (for example, Android or iOS).</p> </li> <li> <p>REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.</p> </li> <li> <p>APPIUM_VERSION: The Appium version for the test.</p> </li> </ul>"
"Rule$attribute": "<p>The rule's stringified attribute. For example, specify the value as <code>\"\\\"abc\\\"\"</code>.</p> <p>Allowed values include:</p> <ul> <li> <p>ARN: The ARN.</p> </li> <li> <p>FORM_FACTOR: The form factor (for example, phone or tablet).</p> </li> <li> <p>MANUFACTURER: The manufacturer.</p> </li> <li> <p>PLATFORM: The platform (for example, Android or iOS).</p> </li> <li> <p>REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.</p> </li> <li> <p>APPIUM_VERSION: The Appium version for the test.</p> </li> <li> <p>INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.</p> </li> <li> <p>INSTANCE_LABELS: The label of the device instance.</p> </li> </ul>"
}
},
"DeviceFormFactor": {
@ -427,6 +504,21 @@
"CustomerArtifactPaths$deviceHostPaths": "<p>Comma-separated list of paths in the test execution environment where the artifacts generated by the customer's tests will be pulled from.</p>"
}
},
"DeviceInstance": {
"base": "<p>Represents the device instance.</p>",
"refs": {
"DeviceInstances$member": null,
"GetDeviceInstanceResult$deviceInstance": "<p>An object containing information about your device instance.</p>",
"UpdateDeviceInstanceResult$deviceInstance": "<p>An object containing information about your device instance.</p>"
}
},
"DeviceInstances": {
"base": null,
"refs": {
"Device$instances": "<p>The instances belonging to this device.</p>",
"ListDeviceInstancesResult$deviceInstances": "<p>An object containing information about your device instances.</p>"
}
},
"DeviceMinutes": {
"base": "<p>Represents the total (metered or unmetered) minutes used by the resource to run tests. Contains the sum of minutes consumed by all children.</p>",
"refs": {
@ -551,6 +643,16 @@
"refs": {
}
},
"GetDeviceInstanceRequest": {
"base": null,
"refs": {
}
},
"GetDeviceInstanceResult": {
"base": null,
"refs": {
}
},
"GetDevicePoolCompatibilityRequest": {
"base": "<p>Represents a request to the get device pool compatibility operation.</p>",
"refs": {
@ -581,6 +683,16 @@
"refs": {
}
},
"GetInstanceProfileRequest": {
"base": null,
"refs": {
}
},
"GetInstanceProfileResult": {
"base": null,
"refs": {
}
},
"GetJobRequest": {
"base": "<p>Represents a request to the get job operation.</p>",
"refs": {
@ -671,6 +783,16 @@
"refs": {
}
},
"GetVPCEConfigurationRequest": {
"base": null,
"refs": {
}
},
"GetVPCEConfigurationResult": {
"base": null,
"refs": {
}
},
"HostAddress": {
"base": null,
"refs": {
@ -704,6 +826,35 @@
"refs": {
}
},
"InstanceLabels": {
"base": null,
"refs": {
"DeviceInstance$labels": "<p>An array of strings describing the device instance.</p>",
"UpdateDeviceInstanceRequest$labels": "<p>An array of strings that you want to associate with the device instance.</p>"
}
},
"InstanceProfile": {
"base": "<p>Represents the instance profile.</p>",
"refs": {
"CreateInstanceProfileResult$instanceProfile": "<p>An object containing information about your instance profile.</p>",
"DeviceInstance$instanceProfile": "<p>A object containing information about the instance profile.</p>",
"GetInstanceProfileResult$instanceProfile": "<p>An object containing information about your instance profile.</p>",
"InstanceProfiles$member": null,
"UpdateInstanceProfileResult$instanceProfile": "<p>An object containing information about your instance profile.</p>"
}
},
"InstanceProfiles": {
"base": null,
"refs": {
"ListInstanceProfilesResult$instanceProfiles": "<p>An object containing information about your instance profiles.</p>"
}
},
"InstanceStatus": {
"base": null,
"refs": {
"DeviceInstance$status": "<p>The status of the device instance. Valid values are listed below.</p>"
}
},
"Integer": {
"base": null,
"refs": {
@ -714,6 +865,9 @@
"Counters$errored": "<p>The number of errored entities.</p>",
"Counters$stopped": "<p>The number of stopped entities.</p>",
"Counters$skipped": "<p>The number of skipped entities.</p>",
"ListDeviceInstancesRequest$maxResults": "<p>An integer specifying the maximum number of items you want to return in the API response.</p>",
"ListInstanceProfilesRequest$maxResults": "<p>An integer specifying the maximum number of items you want to return in the API response.</p>",
"ListVPCEConfigurationsRequest$maxResults": "<p>An integer specifying the maximum number of items you want to return in the API response.</p>",
"MaxSlotMap$value": null,
"OfferingStatus$quantity": "<p>The number of available devices in the offering.</p>",
"PurchaseOfferingRequest$quantity": "<p>The number of device slots you wish to purchase in an offering request.</p>",
@ -734,6 +888,11 @@
"RemoteAccessSession$interactionMode": "<p>The interaction mode of the remote access session. Valid values are:</p> <ul> <li> <p>INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You <b>cannot</b> run XCUITest framework-based tests in this mode.</p> </li> <li> <p>NO_VIDEO: You are connected to the device but cannot interact with it or view the screen. This mode has the fastest test execution speed. You <b>can</b> run XCUITest framework-based tests in this mode.</p> </li> <li> <p>VIDEO_ONLY: You can view the screen but cannot touch or rotate it. You <b>can</b> run XCUITest framework-based tests and watch the screen in this mode.</p> </li> </ul>"
}
},
"InvalidOperationException": {
"base": "<p>There was an error with the update request, or you do not have sufficient permissions to update this VPC endpoint configuration.</p>",
"refs": {
}
},
"IosPaths": {
"base": null,
"refs": {
@ -780,6 +939,16 @@
"refs": {
}
},
"ListDeviceInstancesRequest": {
"base": null,
"refs": {
}
},
"ListDeviceInstancesResult": {
"base": null,
"refs": {
}
},
"ListDevicePoolsRequest": {
"base": "<p>Represents the result of a list device pools request.</p>",
"refs": {
@ -800,6 +969,16 @@
"refs": {
}
},
"ListInstanceProfilesRequest": {
"base": null,
"refs": {
}
},
"ListInstanceProfilesResult": {
"base": null,
"refs": {
}
},
"ListJobsRequest": {
"base": "<p>Represents a request to the list jobs operation.</p>",
"refs": {
@ -930,6 +1109,16 @@
"refs": {
}
},
"ListVPCEConfigurationsRequest": {
"base": null,
"refs": {
}
},
"ListVPCEConfigurationsResult": {
"base": null,
"refs": {
}
},
"Location": {
"base": "<p>Represents a latitude and longitude pair, expressed in geographic coordinate system degrees (for example 47.6204, -122.3491).</p> <p>Elevation is currently not supported.</p>",
"refs": {
@ -973,10 +1162,13 @@
"refs": {
"ArgumentException$message": "<p>Any additional information about the exception.</p>",
"CreateDevicePoolRequest$description": "<p>The device pool's description.</p>",
"CreateInstanceProfileRequest$description": "<p>The description of your instance profile.</p>",
"CreateNetworkProfileRequest$description": "<p>The description of the network profile.</p>",
"DevicePool$description": "<p>The device pool's description.</p>",
"IdempotencyException$message": "<p>Any additional information about the exception.</p>",
"IncompatibilityMessage$message": "<p>A message about the incompatibility.</p>",
"InstanceProfile$description": "<p>The description of the instance profile.</p>",
"InvalidOperationException$message": null,
"Job$message": "<p>A message about the job's result.</p>",
"LimitExceededException$message": "<p>Any additional information about the exception.</p>",
"NetworkProfile$description": "<p>The description of the network profile.</p>",
@ -992,6 +1184,7 @@
"Test$message": "<p>A message about the test's result.</p>",
"UniqueProblem$message": "<p>A message about the unique problems' result.</p>",
"UpdateDevicePoolRequest$description": "<p>A description of the device pool you wish to update.</p>",
"UpdateInstanceProfileRequest$description": "<p>The updated description for your instance profile.</p>",
"UpdateNetworkProfileRequest$description": "<p>The descriptoin of the network profile about which you are returning information.</p>",
"Upload$message": "<p>A message about the upload's result.</p>"
}
@ -1014,12 +1207,14 @@
"refs": {
"Artifact$name": "<p>The artifact's name.</p>",
"CreateDevicePoolRequest$name": "<p>The device pool's name.</p>",
"CreateInstanceProfileRequest$name": "<p>The name of your instance profile.</p>",
"CreateNetworkProfileRequest$name": "<p>The name you wish to specify for the new network profile.</p>",
"CreateProjectRequest$name": "<p>The project's name.</p>",
"CreateRemoteAccessSessionRequest$name": "<p>The name of the remote access session that you wish to create.</p>",
"CreateUploadRequest$name": "<p>The upload's file name. The name should not contain the '/' character. If uploading an iOS app, the file name needs to end with the <code>.ipa</code> extension. If uploading an Android app, the file name needs to end with the <code>.apk</code> extension. For all others, the file name must end with the <code>.zip</code> file extension.</p>",
"Device$name": "<p>The device's display name.</p>",
"DevicePool$name": "<p>The device pool's name.</p>",
"InstanceProfile$name": "<p>The name of the instance profile.</p>",
"Job$name": "<p>The job's name.</p>",
"NetworkProfile$name": "<p>The name of the network profile.</p>",
"ProblemDetail$name": "<p>The problem detail's name.</p>",
@ -1030,6 +1225,7 @@
"Suite$name": "<p>The suite's name.</p>",
"Test$name": "<p>The test's name.</p>",
"UpdateDevicePoolRequest$name": "<p>A string representing the name of the device pool you wish to update.</p>",
"UpdateInstanceProfileRequest$name": "<p>The updated name for your instance profile.</p>",
"UpdateNetworkProfileRequest$name": "<p>The name of the network profile about which you are returning information.</p>",
"UpdateProjectRequest$name": "<p>A string representing the new name of the project that you are updating.</p>",
"Upload$name": "<p>The upload's file name.</p>"
@ -1152,6 +1348,14 @@
"ListOfferingsResult$offerings": "<p>A value representing the list offering results.</p>"
}
},
"PackageIds": {
"base": null,
"refs": {
"CreateInstanceProfileRequest$excludeAppPackagesFromCleanup": "<p>An array of strings specifying the list of app packages that should not be cleaned up from the device after a test run is over.</p> <p>The list of packages is only considered if you set <code>packageCleanup</code> to <code>true</code>.</p>",
"InstanceProfile$excludeAppPackagesFromCleanup": "<p>An array of strings specifying the list of app packages that should not be cleaned up from the device after a test run is over.</p> <p>The list of packages is only considered if you set <code>packageCleanup</code> to <code>true</code>.</p>",
"UpdateInstanceProfileRequest$excludeAppPackagesFromCleanup": "<p>An array of strings specifying the list of app packages that should not be cleaned up from the device after a test run is over.</p> <p>The list of packages is only considered if you set <code>packageCleanup</code> to <code>true</code>.</p>"
}
},
"PaginationToken": {
"base": null,
"refs": {
@ -1159,10 +1363,14 @@
"GetOfferingStatusResult$nextToken": "<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>",
"ListArtifactsRequest$nextToken": "<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>",
"ListArtifactsResult$nextToken": "<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>",
"ListDeviceInstancesRequest$nextToken": "<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>",
"ListDeviceInstancesResult$nextToken": "<p>An identifier that can be used in the next call to this operation to return the next set of items in the list.</p>",
"ListDevicePoolsRequest$nextToken": "<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>",
"ListDevicePoolsResult$nextToken": "<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>",
"ListDevicesRequest$nextToken": "<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>",
"ListDevicesResult$nextToken": "<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>",
"ListInstanceProfilesRequest$nextToken": "<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>",
"ListInstanceProfilesResult$nextToken": "<p>An identifier that can be used in the next call to this operation to return the next set of items in the list.</p>",
"ListJobsRequest$nextToken": "<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>",
"ListJobsResult$nextToken": "<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>",
"ListNetworkProfilesRequest$nextToken": "<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>",
@ -1188,7 +1396,9 @@
"ListUniqueProblemsRequest$nextToken": "<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>",
"ListUniqueProblemsResult$nextToken": "<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>",
"ListUploadsRequest$nextToken": "<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>",
"ListUploadsResult$nextToken": "<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>"
"ListUploadsResult$nextToken": "<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>",
"ListVPCEConfigurationsRequest$nextToken": "<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>",
"ListVPCEConfigurationsResult$nextToken": "<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>"
}
},
"PercentInteger": {
@ -1367,6 +1577,7 @@
"ScheduleRunConfiguration": {
"base": "<p>Represents the settings for a run. Includes things like location, radio states, auxiliary apps, and network profiles.</p>",
"refs": {
"GetDevicePoolCompatibilityRequest$configuration": "<p>An object containing information about the settings for a run.</p>",
"ScheduleRunRequest$configuration": "<p>Information about the settings for the run to be scheduled.</p>"
}
},
@ -1392,6 +1603,23 @@
"refs": {
}
},
"ServiceDnsName": {
"base": null,
"refs": {
"CreateVPCEConfigurationRequest$serviceDnsName": "<p>The DNS name of the service running in your VPC that you want Device Farm to test.</p>",
"UpdateVPCEConfigurationRequest$serviceDnsName": "<p>The DNS (domain) name used to connect to your private service in your Amazon VPC. The DNS name must not already be in use on the Internet.</p>",
"VPCEConfiguration$serviceDnsName": "<p>The DNS name that maps to the private IP address of the service you want to access.</p>"
}
},
"SkipAppResign": {
"base": null,
"refs": {
"AccountSettings$skipAppResign": "<p>When set to <code>true</code>, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.</p> <p>For more information about how Device Farm re-signs your app(s), see <a href=\"https://aws.amazon.com/device-farm/faq/\">Do you modify my app?</a> in the <i>AWS Device Farm FAQs</i>.</p>",
"ExecutionConfiguration$skipAppResign": "<p>When set to <code>true</code>, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.</p> <p>For more information about how Device Farm re-signs your app(s), see <a href=\"https://aws.amazon.com/device-farm/faq/\">Do you modify my app?</a> in the <i>AWS Device Farm FAQs</i>.</p>",
"RemoteAccessSession$skipAppResign": "<p>When set to <code>true</code>, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.</p> <p>For more information about how Device Farm re-signs your app(s), see <a href=\"https://aws.amazon.com/device-farm/faq/\">Do you modify my app?</a> in the <i>AWS Device Farm FAQs</i>.</p>",
"Run$skipAppResign": "<p>When set to <code>true</code>, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.</p> <p>For more information about how Device Farm re-signs your app(s), see <a href=\"https://aws.amazon.com/device-farm/faq/\">Do you modify my app?</a> in the <i>AWS Device Farm FAQs</i>.</p>"
}
},
"SshPublicKey": {
"base": null,
"refs": {
@ -1435,14 +1663,17 @@
"Device$fleetType": "<p>The type of fleet to which this device belongs. Possible values for fleet type are PRIVATE and PUBLIC.</p>",
"Device$fleetName": "<p>The name of the fleet to which this device belongs.</p>",
"DeviceHostPaths$member": null,
"DeviceInstance$udid": "<p>Unique device identifier for the device instance.</p>",
"InstanceLabels$member": null,
"IosPaths$member": null,
"MaxSlotMap$key": null,
"PackageIds$member": null,
"RemoteAccessSession$endpoint": "<p>The endpoint for the remote access sesssion.</p>",
"RemoteAccessSession$deviceUdid": "<p>Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote access session.</p>",
"Rule$value": "<p>The rule's value.</p>",
"Run$parsingResultUrl": "<p>Read-only URL for an object in S3 bucket where you can get the parsing results of the test package. If the test package doesn't parse, the reason why it doesn't parse appears in the file that this URL points to.</p>",
"Run$locale": "<p>Information about the locale that is used for the run.</p>",
"Run$webUrl": "<p>A pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the symbol file for the run.</p>",
"Run$webUrl": "<p>The Device Farm console URL for the recording of the run.</p>",
"ScheduleRunConfiguration$locale": "<p>Information about the locale that is used for the run.</p>",
"TestParameters$key": null,
"TestParameters$value": null
@ -1529,6 +1760,16 @@
"ListUniqueProblemsResult$uniqueProblems": "<p>Information about the unique problems.</p> <p>Allowed values include:</p> <ul> <li> <p>PENDING: A pending condition.</p> </li> <li> <p>PASSED: A passing condition.</p> </li> <li> <p>WARNED: A warning condition.</p> </li> <li> <p>FAILED: A failed condition.</p> </li> <li> <p>SKIPPED: A skipped condition.</p> </li> <li> <p>ERRORED: An error condition.</p> </li> <li> <p>STOPPED: A stopped condition.</p> </li> </ul>"
}
},
"UpdateDeviceInstanceRequest": {
"base": null,
"refs": {
}
},
"UpdateDeviceInstanceResult": {
"base": null,
"refs": {
}
},
"UpdateDevicePoolRequest": {
"base": "<p>Represents a request to the update device pool operation.</p>",
"refs": {
@ -1539,6 +1780,16 @@
"refs": {
}
},
"UpdateInstanceProfileRequest": {
"base": null,
"refs": {
}
},
"UpdateInstanceProfileResult": {
"base": null,
"refs": {
}
},
"UpdateNetworkProfileRequest": {
"base": null,
"refs": {
@ -1559,6 +1810,16 @@
"refs": {
}
},
"UpdateVPCEConfigurationRequest": {
"base": null,
"refs": {
}
},
"UpdateVPCEConfigurationResult": {
"base": null,
"refs": {
}
},
"Upload": {
"base": "<p>An app or a set of one or more tests to upload or that have been uploaded.</p>",
"refs": {
@ -1586,6 +1847,45 @@
"refs": {
"ListUploadsResult$uploads": "<p>Information about the uploads.</p>"
}
},
"VPCEConfiguration": {
"base": "<p>Represents an Amazon Virtual Private Cloud (VPC) endpoint configuration.</p>",
"refs": {
"CreateVPCEConfigurationResult$vpceConfiguration": "<p>An object containing information about your VPC endpoint configuration.</p>",
"GetVPCEConfigurationResult$vpceConfiguration": "<p>An object containing information about your VPC endpoint configuration.</p>",
"UpdateVPCEConfigurationResult$vpceConfiguration": "<p>An object containing information about your VPC endpoint configuration.</p>",
"VPCEConfigurations$member": null
}
},
"VPCEConfigurationDescription": {
"base": null,
"refs": {
"CreateVPCEConfigurationRequest$vpceConfigurationDescription": "<p>An optional description, providing more details about your VPC endpoint configuration.</p>",
"UpdateVPCEConfigurationRequest$vpceConfigurationDescription": "<p>An optional description, providing more details about your VPC endpoint configuration.</p>",
"VPCEConfiguration$vpceConfigurationDescription": "<p>An optional description, providing more details about your VPC endpoint configuration.</p>"
}
},
"VPCEConfigurationName": {
"base": null,
"refs": {
"CreateVPCEConfigurationRequest$vpceConfigurationName": "<p>The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily.</p>",
"UpdateVPCEConfigurationRequest$vpceConfigurationName": "<p>The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily.</p>",
"VPCEConfiguration$vpceConfigurationName": "<p>The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily.</p>"
}
},
"VPCEConfigurations": {
"base": null,
"refs": {
"ListVPCEConfigurationsResult$vpceConfigurations": "<p>An array of <code>VPCEConfiguration</code> objects containing information about your VPC endpoint configuration.</p>"
}
},
"VPCEServiceName": {
"base": null,
"refs": {
"CreateVPCEConfigurationRequest$vpceServiceName": "<p>The name of the VPC endpoint service running inside your AWS account that you want Device Farm to test.</p>",
"UpdateVPCEConfigurationRequest$vpceServiceName": "<p>The name of the VPC endpoint service running inside your AWS account that you want Device Farm to test.</p>",
"VPCEConfiguration$vpceServiceName": "<p>The name of the VPC endpoint service running inside your AWS account that you want Device Farm to test.</p>"
}
}
}
}

18
vendor/github.com/aws/aws-sdk-go/models/apis/devicefarm/2015-06-23/smoke.json generated vendored Normal file
View File

@ -0,0 +1,18 @@
{
"version": 1,
"defaultRegion": "us-west-2",
"testCases": [
{
"operationName": "ListDevices",
"input": {},
"errorExpectedFromService": false
},
{
"operationName": "GetDevice",
"input": {
"arn": "arn:aws:devicefarm:us-west-2::device:000000000000000000000000fake-arn"
},
"errorExpectedFromService": true
}
]
}

32
vendor/github.com/aws/aws-sdk-go/models/apis/dms/2016-01-01/api-2.json generated vendored
View File

@ -552,7 +552,8 @@
"output":{"shape":"StartReplicationTaskResponse"},
"errors":[
{"shape":"ResourceNotFoundFault"},
{"shape":"InvalidResourceStateFault"}
{"shape":"InvalidResourceStateFault"},
{"shape":"AccessDeniedFault"}
]
},
"StartReplicationTaskAssessment":{
@ -719,6 +720,8 @@
"Tags":{"shape":"TagList"},
"CertificateArn":{"shape":"String"},
"SslMode":{"shape":"DmsSslModeValue"},
"ServiceAccessRoleArn":{"shape":"String"},
"ExternalTableDefinition":{"shape":"String"},
"DynamoDbSettings":{"shape":"DynamoDbSettings"},
"S3Settings":{"shape":"S3Settings"},
"MongoDbSettings":{"shape":"MongoDbSettings"}
@ -819,6 +822,8 @@
"TableMappings":{"shape":"String"},
"ReplicationTaskSettings":{"shape":"String"},
"CdcStartTime":{"shape":"TStamp"},
"CdcStartPosition":{"shape":"String"},
"CdcStopPosition":{"shape":"String"},
"Tags":{"shape":"TagList"}
}
},
@ -1187,6 +1192,7 @@
"EndpointIdentifier":{"shape":"String"},
"EndpointType":{"shape":"ReplicationEndpointTypeValue"},
"EngineName":{"shape":"String"},
"EngineDisplayName":{"shape":"String"},
"Username":{"shape":"String"},
"ServerName":{"shape":"String"},
"Port":{"shape":"IntegerOptional"},
@ -1197,6 +1203,8 @@
"EndpointArn":{"shape":"String"},
"CertificateArn":{"shape":"String"},
"SslMode":{"shape":"DmsSslModeValue"},
"ServiceAccessRoleArn":{"shape":"String"},
"ExternalTableDefinition":{"shape":"String"},
"ExternalId":{"shape":"String"},
"DynamoDbSettings":{"shape":"DynamoDbSettings"},
"S3Settings":{"shape":"S3Settings"},
@ -1369,6 +1377,8 @@
"ExtraConnectionAttributes":{"shape":"String"},
"CertificateArn":{"shape":"String"},
"SslMode":{"shape":"DmsSslModeValue"},
"ServiceAccessRoleArn":{"shape":"String"},
"ExternalTableDefinition":{"shape":"String"},
"DynamoDbSettings":{"shape":"DynamoDbSettings"},
"S3Settings":{"shape":"S3Settings"},
"MongoDbSettings":{"shape":"MongoDbSettings"}
@ -1447,7 +1457,9 @@
"MigrationType":{"shape":"MigrationTypeValue"},
"TableMappings":{"shape":"String"},
"ReplicationTaskSettings":{"shape":"String"},
"CdcStartTime":{"shape":"TStamp"}
"CdcStartTime":{"shape":"TStamp"},
"CdcStartPosition":{"shape":"String"},
"CdcStopPosition":{"shape":"String"}
}
},
"ModifyReplicationTaskResponse":{
@ -1469,7 +1481,8 @@
"NestingLevel":{"shape":"NestingLevelValue"},
"ExtractDocId":{"shape":"String"},
"DocsToInvestigate":{"shape":"String"},
"AuthSource":{"shape":"String"}
"AuthSource":{"shape":"String"},
"KmsKeyId":{"shape":"String"}
}
},
"NestingLevelValue":{
@ -1613,7 +1626,8 @@
"ReplicationInstancePublicIpAddresses":{"shape":"ReplicationInstancePublicIpAddressList"},
"ReplicationInstancePrivateIpAddresses":{"shape":"ReplicationInstancePrivateIpAddressList"},
"PubliclyAccessible":{"shape":"Boolean"},
"SecondaryAvailabilityZone":{"shape":"String"}
"SecondaryAvailabilityZone":{"shape":"String"},
"FreeUntil":{"shape":"TStamp"}
}
},
"ReplicationInstanceList":{
@ -1685,6 +1699,9 @@
"StopReason":{"shape":"String"},
"ReplicationTaskCreationDate":{"shape":"TStamp"},
"ReplicationTaskStartDate":{"shape":"TStamp"},
"CdcStartPosition":{"shape":"String"},
"CdcStopPosition":{"shape":"String"},
"RecoveryCheckpoint":{"shape":"String"},
"ReplicationTaskArn":{"shape":"String"},
"ReplicationTaskStats":{"shape":"ReplicationTaskStats"}
}
@ -1805,7 +1822,9 @@
"members":{
"ReplicationTaskArn":{"shape":"String"},
"StartReplicationTaskType":{"shape":"StartReplicationTaskTypeValue"},
"CdcStartTime":{"shape":"TStamp"}
"CdcStartTime":{"shape":"TStamp"},
"CdcStartPosition":{"shape":"String"},
"CdcStopPosition":{"shape":"String"}
}
},
"StartReplicationTaskResponse":{
@ -1871,7 +1890,8 @@
"members":{
"EngineName":{"shape":"String"},
"SupportsCDC":{"shape":"Boolean"},
"EndpointType":{"shape":"ReplicationEndpointTypeValue"}
"EndpointType":{"shape":"ReplicationEndpointTypeValue"},
"EngineDisplayName":{"shape":"String"}
}
},
"SupportedEndpointTypeList":{

43
vendor/github.com/aws/aws-sdk-go/models/apis/dms/2016-01-01/docs-2.json generated vendored
View File

@ -2,7 +2,7 @@
"version": "2.0",
"service": "<fullname>AWS Database Migration Service</fullname> <p>AWS Database Migration Service (AWS DMS) can migrate your data to and from the most widely used commercial and open-source databases such as Oracle, PostgreSQL, Microsoft SQL Server, Amazon Redshift, MariaDB, Amazon Aurora, MySQL, and SAP Adaptive Server Enterprise (ASE). The service supports homogeneous migrations such as Oracle to Oracle, as well as heterogeneous migrations between different database platforms, such as Oracle to MySQL or SQL Server to PostgreSQL.</p> <p>For more information about AWS DMS, see the AWS DMS user guide at <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/Welcome.html\"> What Is AWS Database Migration Service? </a> </p>",
"operations": {
"AddTagsToResource": "<p>Adds metadata tags to a DMS resource, including replication instance, endpoint, security group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with DMS resources, or used in a Condition statement in an IAM policy for DMS.</p>",
"AddTagsToResource": "<p>Adds metadata tags to an AWS DMS resource, including replication instance, endpoint, security group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with DMS resources, or used in a Condition statement in an IAM policy for DMS.</p>",
"CreateEndpoint": "<p>Creates an endpoint using the provided settings.</p>",
"CreateEventSubscription": "<p> Creates an AWS DMS event notification subscription. </p> <p>You can specify the type of source (<code>SourceType</code>) you want to be notified of, provide a list of AWS DMS source IDs (<code>SourceIds</code>) that triggers the events, and provide a list of event categories (<code>EventCategories</code>) for events you want to be notified of. If you specify both the <code>SourceType</code> and <code>SourceIds</code>, such as <code>SourceType = replication-instance</code> and <code>SourceIdentifier = my-replinstance</code>, you will be notified of all the replication instance events for the specified source. If you specify a <code>SourceType</code> but don't specify a <code>SourceIdentifier</code>, you receive notice of the events for that source type for all your AWS DMS sources. If you don't specify either <code>SourceType</code> nor <code>SourceIdentifier</code>, you will be notified of events generated from all AWS DMS sources belonging to your customer account.</p> <p>For more information about AWS DMS events, see <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html\"> Working with Events and Notifications </a> in the AWS Database MIgration Service User Guide.</p>",
"CreateReplicationInstance": "<p>Creates the replication instance using the specified parameters.</p>",
@ -864,7 +864,7 @@
"ReplicationInstanceTaskLogsList": {
"base": null,
"refs": {
"DescribeReplicationInstanceTaskLogsResponse$ReplicationInstanceTaskLogs": "<p>An array of replication task log metadata. Each member of the array contains the replication task name, ARN, and task log size (in bytes).</p>"
"DescribeReplicationInstanceTaskLogsResponse$ReplicationInstanceTaskLogs": "<p>An array of replication task log metadata. Each member of the array contains the replication task name, ARN, and task log size (in bytes). </p>"
}
},
"ReplicationPendingModifiedValues": {
@ -947,7 +947,7 @@
"S3Settings": {
"base": "<p/>",
"refs": {
"CreateEndpointMessage$S3Settings": "<p>Settings in JSON format for the target S3 endpoint. For more information about the available settings, see the <b>Extra Connection Attributes</b> section at <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html\"> Using Amazon S3 as a Target for AWS Database Migration Service</a>. </p>",
"CreateEndpointMessage$S3Settings": "<p>Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see the <b>Extra Connection Attributes</b> section at <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html\"> Using Amazon S3 as a Target for AWS Database Migration Service</a>. </p>",
"Endpoint$S3Settings": "<p>The settings for the S3 target endpoint. For more information, see the <code>S3Settings</code> structure.</p>",
"ModifyEndpointMessage$S3Settings": "<p>Settings in JSON format for the target S3 endpoint. For more information about the available settings, see the <b>Extra Connection Attributes</b> section at <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html\"> Using Amazon S3 as a Target for AWS Database Migration Service</a>. </p>"
}
@ -1049,14 +1049,16 @@
"Connection$EndpointIdentifier": "<p>The identifier of the endpoint. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.</p>",
"Connection$ReplicationInstanceIdentifier": "<p>The replication instance identifier. This parameter is stored as a lowercase string.</p>",
"CreateEndpointMessage$EndpointIdentifier": "<p>The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.</p>",
"CreateEndpointMessage$EngineName": "<p>The type of engine for the endpoint. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, redshift, S3, sybase, dynamodb, mongodb, and sqlserver.</p>",
"CreateEndpointMessage$EngineName": "<p>The type of engine for the endpoint. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, dynamodb, mongodb, and sqlserver.</p>",
"CreateEndpointMessage$Username": "<p>The user name to be used to login to the endpoint database.</p>",
"CreateEndpointMessage$ServerName": "<p>The name of the server where the endpoint database resides.</p>",
"CreateEndpointMessage$DatabaseName": "<p>The name of the endpoint database.</p>",
"CreateEndpointMessage$ExtraConnectionAttributes": "<p>Additional attributes associated with the connection.</p>",
"CreateEndpointMessage$KmsKeyId": "<p>The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.</p>",
"CreateEndpointMessage$CertificateArn": "<p>The Amazon Resource Name (ARN) for the certificate.</p>",
"CreateEventSubscriptionMessage$SubscriptionName": "<p>The name of the DMS event notification subscription. </p> <p>Constraints: The name must be less than 255 characters. </p>",
"CreateEndpointMessage$ServiceAccessRoleArn": "<p> The Amazon Resource Name (ARN) for the service access role you want to use to create the endpoint. </p>",
"CreateEndpointMessage$ExternalTableDefinition": "<p>The external table definition. </p>",
"CreateEventSubscriptionMessage$SubscriptionName": "<p>The name of the AWS DMS event notification subscription. </p> <p>Constraints: The name must be less than 255 characters. </p>",
"CreateEventSubscriptionMessage$SnsTopicArn": "<p> The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it. </p>",
"CreateEventSubscriptionMessage$SourceType": "<p> The type of AWS DMS resource that generates the events. For example, if you want to be notified of events generated by a replication instance, you set this parameter to <code>replication-instance</code>. If this value is not specified, all events are returned. </p> <p>Valid values: replication-instance | migration-task</p>",
"CreateReplicationInstanceMessage$ReplicationInstanceIdentifier": "<p>The replication instance identifier. This parameter is stored as a lowercase string.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul> <p>Example: <code>myrepinstance</code> </p>",
@ -1074,6 +1076,8 @@
"CreateReplicationTaskMessage$ReplicationInstanceArn": "<p>The Amazon Resource Name (ARN) of the replication instance.</p>",
"CreateReplicationTaskMessage$TableMappings": "<p>When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with \"file://\". When working with the DMS API, provide the JSON as the parameter value.</p> <p>For example, --table-mappings file://mappingfile.json</p>",
"CreateReplicationTaskMessage$ReplicationTaskSettings": "<p>Settings for the task, such as target metadata settings. For a complete list of task settings, see <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.html\">Task Settings for AWS Database Migration Service Tasks</a>.</p>",
"CreateReplicationTaskMessage$CdcStartPosition": "<p>Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.</p> <p> The value can be in date, checkpoint, or LSN/SCN format.</p> <p>Date Example: --cdc-start-position “2018-03-08T12:12:12”</p> <p>Checkpoint Example: --cdc-start-position \"checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93\"</p> <p>LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”</p>",
"CreateReplicationTaskMessage$CdcStopPosition": "<p>Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.</p> <p>Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”</p> <p>Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “</p>",
"DeleteCertificateMessage$CertificateArn": "<p>The Amazon Resource Name (ARN) of the deleted certificate.</p>",
"DeleteEndpointMessage$EndpointArn": "<p>The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.</p>",
"DeleteEventSubscriptionMessage$SubscriptionName": "<p>The name of the DMS event notification subscription to be deleted.</p>",
@ -1121,7 +1125,8 @@
"DescribeTableStatisticsResponse$Marker": "<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>",
"DynamoDbSettings$ServiceAccessRoleArn": "<p> The Amazon Resource Name (ARN) used by the service access IAM role. </p>",
"Endpoint$EndpointIdentifier": "<p>The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.</p>",
"Endpoint$EngineName": "<p>The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, redshift, S3, sybase, dynamodb, mongodb, and sqlserver.</p>",
"Endpoint$EngineName": "<p>The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.</p>",
"Endpoint$EngineDisplayName": "<p>The expanded name for the engine name. For example, if the <code>EngineName</code> parameter is \"aurora,\" this value would be \"Amazon Aurora MySQL.\"</p>",
"Endpoint$Username": "<p>The user name used to connect to the endpoint.</p>",
"Endpoint$ServerName": "<p>The name of the server at the endpoint.</p>",
"Endpoint$DatabaseName": "<p>The name of the database at the endpoint.</p>",
@ -1130,6 +1135,8 @@
"Endpoint$KmsKeyId": "<p>The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.</p>",
"Endpoint$EndpointArn": "<p>The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.</p>",
"Endpoint$CertificateArn": "<p>The Amazon Resource Name (ARN) used for SSL connection to the endpoint.</p>",
"Endpoint$ServiceAccessRoleArn": "<p>The Amazon Resource Name (ARN) used by the service access IAM role.</p>",
"Endpoint$ExternalTableDefinition": "<p>The external table definition.</p>",
"Endpoint$ExternalId": "<p> Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account. </p>",
"Event$SourceIdentifier": "<p> The identifier of the event source. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens. </p> <p>Constraints:replication instance, endpoint, migration task</p>",
"Event$Message": "<p>The event message.</p>",
@ -1149,12 +1156,14 @@
"ListTagsForResourceMessage$ResourceArn": "<p>The Amazon Resource Name (ARN) string that uniquely identifies the AWS DMS resource.</p>",
"ModifyEndpointMessage$EndpointArn": "<p>The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.</p>",
"ModifyEndpointMessage$EndpointIdentifier": "<p>The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.</p>",
"ModifyEndpointMessage$EngineName": "<p>The type of engine for the endpoint. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, redshift, S3, sybase, dynamodb, mongodb, and sqlserver.</p>",
"ModifyEndpointMessage$EngineName": "<p>The type of engine for the endpoint. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.</p>",
"ModifyEndpointMessage$Username": "<p>The user name to be used to login to the endpoint database.</p>",
"ModifyEndpointMessage$ServerName": "<p>The name of the server where the endpoint database resides.</p>",
"ModifyEndpointMessage$DatabaseName": "<p>The name of the endpoint database.</p>",
"ModifyEndpointMessage$ExtraConnectionAttributes": "<p>Additional attributes associated with the connection. To reset this parameter, pass the empty string (\"\") as an argument.</p>",
"ModifyEndpointMessage$CertificateArn": "<p>The Amazon Resource Name (ARN) of the certificate used for SSL connection.</p>",
"ModifyEndpointMessage$ServiceAccessRoleArn": "<p> The Amazon Resource Name (ARN) for the service access role you want to use to modify the endpoint. </p>",
"ModifyEndpointMessage$ExternalTableDefinition": "<p>The external table definition.</p>",
"ModifyEventSubscriptionMessage$SubscriptionName": "<p>The name of the AWS DMS event notification subscription to be modified.</p>",
"ModifyEventSubscriptionMessage$SnsTopicArn": "<p> The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.</p>",
"ModifyEventSubscriptionMessage$SourceType": "<p> The type of AWS DMS resource that generates the events you want to subscribe to. </p> <p>Valid values: replication-instance | migration-task</p>",
@ -1169,12 +1178,15 @@
"ModifyReplicationTaskMessage$ReplicationTaskIdentifier": "<p>The replication task identifier.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 255 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>",
"ModifyReplicationTaskMessage$TableMappings": "<p>When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with \"file://\". When working with the DMS API, provide the JSON as the parameter value.</p> <p>For example, --table-mappings file://mappingfile.json</p>",
"ModifyReplicationTaskMessage$ReplicationTaskSettings": "<p>JSON file that contains settings for the task, such as target metadata settings.</p>",
"ModifyReplicationTaskMessage$CdcStartPosition": "<p>Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.</p> <p> The value can be in date, checkpoint, or LSN/SCN format.</p> <p>Date Example: --cdc-start-position “2018-03-08T12:12:12”</p> <p>Checkpoint Example: --cdc-start-position \"checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93\"</p> <p>LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”</p>",
"ModifyReplicationTaskMessage$CdcStopPosition": "<p>Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.</p> <p>Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”</p> <p>Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “</p>",
"MongoDbSettings$Username": "<p>The user name you use to access the MongoDB source endpoint. </p>",
"MongoDbSettings$ServerName": "<p> The name of the server on the MongoDB source endpoint. </p>",
"MongoDbSettings$DatabaseName": "<p> The database name on the MongoDB source endpoint. </p>",
"MongoDbSettings$ExtractDocId": "<p> Specifies the document ID. Use this attribute when <code>NestingLevel</code> is set to NONE. </p> <p>Default value is false. </p>",
"MongoDbSettings$DocsToInvestigate": "<p> Indicates the number of documents to preview to determine the document organization. Use this attribute when <code>NestingLevel</code> is set to ONE. </p> <p>Must be a positive value greater than 0. Default value is 1000.</p>",
"MongoDbSettings$AuthSource": "<p> The MongoDB database name. This attribute is not used when <code>authType=NO</code>. </p> <p>The default is admin.</p>",
"MongoDbSettings$KmsKeyId": "<p> The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region. </p>",
"OrderableReplicationInstance$EngineVersion": "<p>The version of the replication engine.</p>",
"OrderableReplicationInstance$ReplicationInstanceClass": "<p>The compute and memory capacity of the replication instance.</p> <p> Valid Values: <code>dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge </code> </p>",
"OrderableReplicationInstance$StorageType": "<p>The type of storage used by the replication instance.</p>",
@ -1217,6 +1229,9 @@
"ReplicationTask$Status": "<p>The status of the replication task.</p>",
"ReplicationTask$LastFailureMessage": "<p>The last error (failure) message generated for the replication instance.</p>",
"ReplicationTask$StopReason": "<p>The reason the replication task was stopped.</p>",
"ReplicationTask$CdcStartPosition": "<p>Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.</p> <p> The value can be in date, checkpoint, or LSN/SCN format.</p> <p>Date Example: --cdc-start-position “2018-03-08T12:12:12”</p> <p>Checkpoint Example: --cdc-start-position \"checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93\"</p> <p>LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”</p>",
"ReplicationTask$CdcStopPosition": "<p>Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.</p> <p>Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”</p> <p>Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “</p>",
"ReplicationTask$RecoveryCheckpoint": "<p>Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the <code>CdcStartPosition</code> parameter to start a CDC operation that begins at that checkpoint.</p>",
"ReplicationTask$ReplicationTaskArn": "<p>The Amazon Resource Name (ARN) of the replication task.</p>",
"ReplicationTaskAssessmentResult$ReplicationTaskIdentifier": "<p> The replication task identifier of the task on which the task assessment was run. </p>",
"ReplicationTaskAssessmentResult$ReplicationTaskArn": "<p>The Amazon Resource Name (ARN) of the replication task. </p>",
@ -1225,7 +1240,7 @@
"ReplicationTaskAssessmentResult$AssessmentResults": "<p> The task assessment results in JSON format. </p>",
"ReplicationTaskAssessmentResult$S3ObjectUrl": "<p> The URL of the S3 object containing the task assessment results. </p>",
"S3Settings$ServiceAccessRoleArn": "<p> The Amazon Resource Name (ARN) used by the service access IAM role. </p>",
"S3Settings$ExternalTableDefinition": "<p> </p>",
"S3Settings$ExternalTableDefinition": "<p> The external table definition. </p>",
"S3Settings$CsvRowDelimiter": "<p> The delimiter used to separate rows in the source files. The default is a carriage return (\\n). </p>",
"S3Settings$CsvDelimiter": "<p> The delimiter used to separate columns in the source files. The default is a comma. </p>",
"S3Settings$BucketFolder": "<p> An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path &lt;bucketFolder&gt;/&lt;schema_name&gt;/&lt;table_name&gt;/. If this parameter is not specified, then the path used is &lt;schema_name&gt;/&lt;table_name&gt;/. </p>",
@ -1234,11 +1249,14 @@
"SourceIdsList$member": null,
"StartReplicationTaskAssessmentMessage$ReplicationTaskArn": "<p> The Amazon Resource Name (ARN) of the replication task. </p>",
"StartReplicationTaskMessage$ReplicationTaskArn": "<p>The Amazon Resource Name (ARN) of the replication task to be started.</p>",
"StartReplicationTaskMessage$CdcStartPosition": "<p>Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.</p> <p> The value can be in date, checkpoint, or LSN/SCN format.</p> <p>Date Example: --cdc-start-position “2018-03-08T12:12:12”</p> <p>Checkpoint Example: --cdc-start-position \"checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93\"</p> <p>LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”</p>",
"StartReplicationTaskMessage$CdcStopPosition": "<p>Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.</p> <p>Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”</p> <p>Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “</p>",
"StopReplicationTaskMessage$ReplicationTaskArn": "<p>The Amazon Resource Name(ARN) of the replication task to be stopped.</p>",
"Subnet$SubnetIdentifier": "<p>The subnet identifier.</p>",
"Subnet$SubnetStatus": "<p>The status of the subnet.</p>",
"SubnetIdentifierList$member": null,
"SupportedEndpointType$EngineName": "<p>The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, redshift, S3, sybase, dynamodb, mongodb, and sqlserver.</p>",
"SupportedEndpointType$EngineName": "<p>The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, sybase, dynamodb, mongodb, and sqlserver.</p>",
"SupportedEndpointType$EngineDisplayName": "<p>The expanded name for the engine name. For example, if the <code>EngineName</code> parameter is \"aurora,\" this value would be \"Amazon Aurora MySQL.\"</p>",
"TableStatistics$SchemaName": "<p>The schema name.</p>",
"TableStatistics$TableName": "<p>The name of the table.</p>",
"TableStatistics$TableState": "<p>The state of the tables described.</p> <p>Valid states: Table does not exist | Before load | Full load | Table completed | Table cancelled | Table error | Table all | Table updates | Table is being reloaded</p>",
@ -1296,17 +1314,18 @@
"Certificate$CertificateCreationDate": "<p>The date that the certificate was created.</p>",
"Certificate$ValidFromDate": "<p>The beginning date that the certificate is valid.</p>",
"Certificate$ValidToDate": "<p>The final date that the certificate is valid.</p>",
"CreateReplicationTaskMessage$CdcStartTime": "<p>The start time for the Change Data Capture (CDC) operation.</p>",
"CreateReplicationTaskMessage$CdcStartTime": "<p>Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.</p>",
"DescribeEventsMessage$StartTime": "<p>The start time for the events to be listed.</p>",
"DescribeEventsMessage$EndTime": "<p>The end time for the events to be listed.</p>",
"Event$Date": "<p>The date of the event.</p>",
"ModifyReplicationTaskMessage$CdcStartTime": "<p>The start time for the Change Data Capture (CDC) operation.</p>",
"ModifyReplicationTaskMessage$CdcStartTime": "<p>Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.</p>",
"RefreshSchemasStatus$LastRefreshDate": "<p>The date the schema was last refreshed.</p>",
"ReplicationInstance$InstanceCreateTime": "<p>The time the replication instance was created.</p>",
"ReplicationInstance$FreeUntil": "<p> The expiration date of the free replication instance that is part of the Free DMS program. </p>",
"ReplicationTask$ReplicationTaskCreationDate": "<p>The date the replication task was created.</p>",
"ReplicationTask$ReplicationTaskStartDate": "<p>The date the replication task is scheduled to start.</p>",
"ReplicationTaskAssessmentResult$ReplicationTaskLastAssessmentDate": "<p>The date the task assessment was completed. </p>",
"StartReplicationTaskMessage$CdcStartTime": "<p>The start time for the Change Data Capture (CDC) operation.</p>",
"StartReplicationTaskMessage$CdcStartTime": "<p>Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.</p>",
"TableStatistics$LastUpdateTime": "<p>The last time the table was updated.</p>"
}
},

259
vendor/github.com/aws/aws-sdk-go/models/apis/dynamodb/2012-08-10/api-2.json generated vendored
View File

@ -173,6 +173,19 @@
{"shape":"GlobalTableNotFoundException"}
]
},
"DescribeGlobalTableSettings":{
"name":"DescribeGlobalTableSettings",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeGlobalTableSettingsInput"},
"output":{"shape":"DescribeGlobalTableSettingsOutput"},
"errors":[
{"shape":"GlobalTableNotFoundException"},
{"shape":"InternalServerError"}
]
},
"DescribeLimits":{
"name":"DescribeLimits",
"http":{
@ -321,6 +334,24 @@
{"shape":"InternalServerError"}
]
},
"RestoreTableToPointInTime":{
"name":"RestoreTableToPointInTime",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RestoreTableToPointInTimeInput"},
"output":{"shape":"RestoreTableToPointInTimeOutput"},
"errors":[
{"shape":"TableAlreadyExistsException"},
{"shape":"TableNotFoundException"},
{"shape":"TableInUseException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidRestoreTimeException"},
{"shape":"PointInTimeRecoveryUnavailableException"},
{"shape":"InternalServerError"}
]
},
"Scan":{
"name":"Scan",
"http":{
@ -363,6 +394,20 @@
{"shape":"ResourceInUseException"}
]
},
"UpdateContinuousBackups":{
"name":"UpdateContinuousBackups",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateContinuousBackupsInput"},
"output":{"shape":"UpdateContinuousBackupsOutput"},
"errors":[
{"shape":"TableNotFoundException"},
{"shape":"ContinuousBackupsUnavailableException"},
{"shape":"InternalServerError"}
]
},
"UpdateGlobalTable":{
"name":"UpdateGlobalTable",
"http":{
@ -379,6 +424,23 @@
{"shape":"TableNotFoundException"}
]
},
"UpdateGlobalTableSettings":{
"name":"UpdateGlobalTableSettings",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateGlobalTableSettingsInput"},
"output":{"shape":"UpdateGlobalTableSettingsOutput"},
"errors":[
{"shape":"GlobalTableNotFoundException"},
{"shape":"ReplicaNotFoundException"},
{"shape":"IndexNotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceInUseException"},
{"shape":"InternalServerError"}
]
},
"UpdateItem":{
"name":"UpdateItem",
"http":{
@ -706,7 +768,8 @@
"type":"structure",
"required":["ContinuousBackupsStatus"],
"members":{
"ContinuousBackupsStatus":{"shape":"ContinuousBackupsStatus"}
"ContinuousBackupsStatus":{"shape":"ContinuousBackupsStatus"},
"PointInTimeRecoveryDescription":{"shape":"PointInTimeRecoveryDescription"}
}
},
"ContinuousBackupsStatus":{
@ -918,6 +981,20 @@
"GlobalTableDescription":{"shape":"GlobalTableDescription"}
}
},
"DescribeGlobalTableSettingsInput":{
"type":"structure",
"required":["GlobalTableName"],
"members":{
"GlobalTableName":{"shape":"TableName"}
}
},
"DescribeGlobalTableSettingsOutput":{
"type":"structure",
"members":{
"GlobalTableName":{"shape":"TableName"},
"ReplicaSettings":{"shape":"ReplicaSettingsDescriptionList"}
}
},
"DescribeLimitsInput":{
"type":"structure",
"members":{
@ -1100,6 +1177,20 @@
"GlobalTableName":{"shape":"TableName"}
}
},
"GlobalTableGlobalSecondaryIndexSettingsUpdate":{
"type":"structure",
"required":["IndexName"],
"members":{
"IndexName":{"shape":"IndexName"},
"ProvisionedWriteCapacityUnits":{"shape":"PositiveLongObject"}
}
},
"GlobalTableGlobalSecondaryIndexSettingsUpdateList":{
"type":"list",
"member":{"shape":"GlobalTableGlobalSecondaryIndexSettingsUpdate"},
"max":20,
"min":1
},
"GlobalTableList":{
"type":"list",
"member":{"shape":"GlobalTable"}
@ -1126,6 +1217,13 @@
"min":3,
"pattern":"[a-zA-Z0-9_.-]+"
},
"IndexNotFoundException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"exception":true
},
"IndexStatus":{
"type":"string",
"enum":[
@ -1144,6 +1242,13 @@
"exception":true,
"fault":true
},
"InvalidRestoreTimeException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"exception":true
},
"ItemCollectionKeyAttributeMap":{
"type":"map",
"key":{"shape":"AttributeName"},
@ -1387,6 +1492,35 @@
"type":"list",
"member":{"shape":"NumberAttributeValue"}
},
"PointInTimeRecoveryDescription":{
"type":"structure",
"members":{
"PointInTimeRecoveryStatus":{"shape":"PointInTimeRecoveryStatus"},
"EarliestRestorableDateTime":{"shape":"Date"},
"LatestRestorableDateTime":{"shape":"Date"}
}
},
"PointInTimeRecoverySpecification":{
"type":"structure",
"required":["PointInTimeRecoveryEnabled"],
"members":{
"PointInTimeRecoveryEnabled":{"shape":"BooleanObject"}
}
},
"PointInTimeRecoveryStatus":{
"type":"string",
"enum":[
"ENABLED",
"DISABLED"
]
},
"PointInTimeRecoveryUnavailableException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"exception":true
},
"PositiveIntegerObject":{
"type":"integer",
"min":1
@ -1535,6 +1669,34 @@
"type":"list",
"member":{"shape":"ReplicaDescription"}
},
"ReplicaGlobalSecondaryIndexSettingsDescription":{
"type":"structure",
"required":["IndexName"],
"members":{
"IndexName":{"shape":"IndexName"},
"IndexStatus":{"shape":"IndexStatus"},
"ProvisionedReadCapacityUnits":{"shape":"PositiveLongObject"},
"ProvisionedWriteCapacityUnits":{"shape":"PositiveLongObject"}
}
},
"ReplicaGlobalSecondaryIndexSettingsDescriptionList":{
"type":"list",
"member":{"shape":"ReplicaGlobalSecondaryIndexSettingsDescription"}
},
"ReplicaGlobalSecondaryIndexSettingsUpdate":{
"type":"structure",
"required":["IndexName"],
"members":{
"IndexName":{"shape":"IndexName"},
"ProvisionedReadCapacityUnits":{"shape":"PositiveLongObject"}
}
},
"ReplicaGlobalSecondaryIndexSettingsUpdateList":{
"type":"list",
"member":{"shape":"ReplicaGlobalSecondaryIndexSettingsUpdate"},
"max":20,
"min":1
},
"ReplicaList":{
"type":"list",
"member":{"shape":"Replica"}
@ -1546,6 +1708,45 @@
},
"exception":true
},
"ReplicaSettingsDescription":{
"type":"structure",
"required":["RegionName"],
"members":{
"RegionName":{"shape":"RegionName"},
"ReplicaStatus":{"shape":"ReplicaStatus"},
"ReplicaProvisionedReadCapacityUnits":{"shape":"PositiveLongObject"},
"ReplicaProvisionedWriteCapacityUnits":{"shape":"PositiveLongObject"},
"ReplicaGlobalSecondaryIndexSettings":{"shape":"ReplicaGlobalSecondaryIndexSettingsDescriptionList"}
}
},
"ReplicaSettingsDescriptionList":{
"type":"list",
"member":{"shape":"ReplicaSettingsDescription"}
},
"ReplicaSettingsUpdate":{
"type":"structure",
"required":["RegionName"],
"members":{
"RegionName":{"shape":"RegionName"},
"ReplicaProvisionedReadCapacityUnits":{"shape":"PositiveLongObject"},
"ReplicaGlobalSecondaryIndexSettingsUpdate":{"shape":"ReplicaGlobalSecondaryIndexSettingsUpdateList"}
}
},
"ReplicaSettingsUpdateList":{
"type":"list",
"member":{"shape":"ReplicaSettingsUpdate"},
"max":50,
"min":1
},
"ReplicaStatus":{
"type":"string",
"enum":[
"CREATING",
"UPDATING",
"DELETING",
"ACTIVE"
]
},
"ReplicaUpdate":{
"type":"structure",
"members":{
@ -1576,7 +1777,6 @@
},
"exception":true
},
"RestoreDateTime":{"type":"timestamp"},
"RestoreInProgress":{"type":"boolean"},
"RestoreSummary":{
"type":"structure",
@ -1587,7 +1787,7 @@
"members":{
"SourceBackupArn":{"shape":"BackupArn"},
"SourceTableArn":{"shape":"TableArn"},
"RestoreDateTime":{"shape":"RestoreDateTime"},
"RestoreDateTime":{"shape":"Date"},
"RestoreInProgress":{"shape":"RestoreInProgress"}
}
},
@ -1608,6 +1808,25 @@
"TableDescription":{"shape":"TableDescription"}
}
},
"RestoreTableToPointInTimeInput":{
"type":"structure",
"required":[
"SourceTableName",
"TargetTableName"
],
"members":{
"SourceTableName":{"shape":"TableName"},
"TargetTableName":{"shape":"TableName"},
"UseLatestRestorableTime":{"shape":"BooleanObject"},
"RestoreDateTime":{"shape":"Date"}
}
},
"RestoreTableToPointInTimeOutput":{
"type":"structure",
"members":{
"TableDescription":{"shape":"TableDescription"}
}
},
"ReturnConsumedCapacity":{
"type":"string",
"enum":[
@ -1932,6 +2151,23 @@
"TagKeys":{"shape":"TagKeyList"}
}
},
"UpdateContinuousBackupsInput":{
"type":"structure",
"required":[
"TableName",
"PointInTimeRecoverySpecification"
],
"members":{
"TableName":{"shape":"TableName"},
"PointInTimeRecoverySpecification":{"shape":"PointInTimeRecoverySpecification"}
}
},
"UpdateContinuousBackupsOutput":{
"type":"structure",
"members":{
"ContinuousBackupsDescription":{"shape":"ContinuousBackupsDescription"}
}
},
"UpdateExpression":{"type":"string"},
"UpdateGlobalSecondaryIndexAction":{
"type":"structure",
@ -1961,6 +2197,23 @@
"GlobalTableDescription":{"shape":"GlobalTableDescription"}
}
},
"UpdateGlobalTableSettingsInput":{
"type":"structure",
"required":["GlobalTableName"],
"members":{
"GlobalTableName":{"shape":"TableName"},
"GlobalTableProvisionedWriteCapacityUnits":{"shape":"PositiveLongObject"},
"GlobalTableGlobalSecondaryIndexSettingsUpdate":{"shape":"GlobalTableGlobalSecondaryIndexSettingsUpdateList"},
"ReplicaSettingsUpdate":{"shape":"ReplicaSettingsUpdateList"}
}
},
"UpdateGlobalTableSettingsOutput":{
"type":"structure",
"members":{
"GlobalTableName":{"shape":"TableName"},
"ReplicaSettings":{"shape":"ReplicaSettingsDescriptionList"}
}
},
"UpdateItemInput":{
"type":"structure",
"required":[

216
vendor/github.com/aws/aws-sdk-go/models/apis/dynamodb/2012-08-10/docs-2.json generated vendored
View File

@ -3,16 +3,17 @@
"service": "<fullname>Amazon DynamoDB</fullname> <p>Amazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. DynamoDB lets you offload the administrative burdens of operating and scaling a distributed database, so that you don't have to worry about hardware provisioning, setup and configuration, replication, software patching, or cluster scaling.</p> <p>With DynamoDB, you can create database tables that can store and retrieve any amount of data, and serve any level of request traffic. You can scale up or scale down your tables' throughput capacity without downtime or performance degradation, and use the AWS Management Console to monitor resource utilization and performance metrics.</p> <p>DynamoDB automatically spreads the data and traffic for your tables over a sufficient number of servers to handle your throughput and storage requirements, while maintaining consistent and fast performance. All of your data is stored on solid state disks (SSDs) and automatically replicated across multiple Availability Zones in an AWS region, providing built-in high availability and data durability. </p>",
"operations": {
"BatchGetItem": "<p>The <code>BatchGetItem</code> operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key.</p> <p>A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. <code>BatchGetItem</code> will return a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for <code>UnprocessedKeys</code>. You can use this value to retry the operation starting with the next item to get.</p> <important> <p>If you request more than 100 items <code>BatchGetItem</code> will return a <code>ValidationException</code> with the message \"Too many items requested for the BatchGetItem call\".</p> </important> <p>For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate <code>UnprocessedKeys</code> value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one data set.</p> <p>If <i>none</i> of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then <code>BatchGetItem</code> will return a <code>ProvisionedThroughputExceededException</code>. If <i>at least one</i> of the items is successfully processed, then <code>BatchGetItem</code> completes successfully, while returning the keys of the unread items in <code>UnprocessedKeys</code>.</p> <important> <p>If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, <i>we strongly recommend that you use an exponential backoff algorithm</i>. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations\">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> </important> <p>By default, <code>BatchGetItem</code> performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set <code>ConsistentRead</code> to <code>true</code> for any or all tables.</p> <p>In order to minimize response latency, <code>BatchGetItem</code> retrieves items in parallel.</p> <p>When designing your application, keep in mind that DynamoDB does not return items in any particular order. To help parse the response by item, include the primary key values for the items in your request in the <code>ProjectionExpression</code> parameter.</p> <p>If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations\">Capacity Units Calculations</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>",
"BatchWriteItem": "<p>The <code>BatchWriteItem</code> operation puts or deletes multiple items in one or more tables. A single call to <code>BatchWriteItem</code> can write up to 16 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 400 KB.</p> <note> <p> <code>BatchWriteItem</code> cannot update items. To update items, use the <code>UpdateItem</code> action.</p> </note> <p>The individual <code>PutItem</code> and <code>DeleteItem</code> operations specified in <code>BatchWriteItem</code> are atomic; however <code>BatchWriteItem</code> as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the <code>UnprocessedItems</code> response parameter. You can investigate and optionally resend the requests. Typically, you would call <code>BatchWriteItem</code> in a loop. Each iteration would check for unprocessed items and submit a new <code>BatchWriteItem</code> request with those unprocessed items until all items have been processed.</p> <p>Note that if <i>none</i> of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then <code>BatchWriteItem</code> will return a <code>ProvisionedThroughputExceededException</code>.</p> <important> <p>If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, <i>we strongly recommend that you use an exponential backoff algorithm</i>. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations\">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> </important> <p>With <code>BatchWriteItem</code>, you can efficiently write or delete large amounts of data, such as from Amazon Elastic MapReduce (EMR), or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, <code>BatchWriteItem</code> does not behave in the same way as individual <code>PutItem</code> and <code>DeleteItem</code> calls would. For example, you cannot specify conditions on individual put and delete requests, and <code>BatchWriteItem</code> does not return deleted items in the response.</p> <p>If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, <code>BatchWriteItem</code> performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.</p> <p>Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.</p> <p>If one or more of the following is true, DynamoDB rejects the entire batch write operation:</p> <ul> <li> <p>One or more tables specified in the <code>BatchWriteItem</code> request does not exist.</p> </li> <li> <p>Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema.</p> </li> <li> <p>You try to perform multiple operations on the same item in the same <code>BatchWriteItem</code> request. For example, you cannot put and delete the same item in the same <code>BatchWriteItem</code> request. </p> </li> <li> <p>There are more than 25 requests in the batch.</p> </li> <li> <p>Any individual item in a batch exceeds 400 KB.</p> </li> <li> <p>The total request size exceeds 16 MB.</p> </li> </ul>",
"BatchWriteItem": "<p>The <code>BatchWriteItem</code> operation puts or deletes multiple items in one or more tables. A single call to <code>BatchWriteItem</code> can write up to 16 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 400 KB.</p> <note> <p> <code>BatchWriteItem</code> cannot update items. To update items, use the <code>UpdateItem</code> action.</p> </note> <p>The individual <code>PutItem</code> and <code>DeleteItem</code> operations specified in <code>BatchWriteItem</code> are atomic; however <code>BatchWriteItem</code> as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the <code>UnprocessedItems</code> response parameter. You can investigate and optionally resend the requests. Typically, you would call <code>BatchWriteItem</code> in a loop. Each iteration would check for unprocessed items and submit a new <code>BatchWriteItem</code> request with those unprocessed items until all items have been processed.</p> <p>Note that if <i>none</i> of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then <code>BatchWriteItem</code> will return a <code>ProvisionedThroughputExceededException</code>.</p> <important> <p>If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, <i>we strongly recommend that you use an exponential backoff algorithm</i>. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations\">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> </important> <p>With <code>BatchWriteItem</code>, you can efficiently write or delete large amounts of data, such as from Amazon Elastic MapReduce (EMR), or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, <code>BatchWriteItem</code> does not behave in the same way as individual <code>PutItem</code> and <code>DeleteItem</code> calls would. For example, you cannot specify conditions on individual put and delete requests, and <code>BatchWriteItem</code> does not return deleted items in the response.</p> <p>If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, <code>BatchWriteItem</code> performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.</p> <p>Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.</p> <p>If one or more of the following is true, DynamoDB rejects the entire batch write operation:</p> <ul> <li> <p>One or more tables specified in the <code>BatchWriteItem</code> request does not exist.</p> </li> <li> <p>Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema.</p> </li> <li> <p>You try to perform multiple operations on the same item in the same <code>BatchWriteItem</code> request. For example, you cannot put and delete the same item in the same <code>BatchWriteItem</code> request. </p> </li> <li> <p> Your request contains at least two items with identical hash and range keys (which essentially is two put operations). </p> </li> <li> <p>There are more than 25 requests in the batch.</p> </li> <li> <p>Any individual item in a batch exceeds 400 KB.</p> </li> <li> <p>The total request size exceeds 16 MB.</p> </li> </ul>",
"CreateBackup": "<p>Creates a backup for an existing table.</p> <p> Each time you create an On-Demand Backup, the entire table data is backed up. There is no limit to the number of on-demand backups that can be taken. </p> <p> When you create an On-Demand Backup, a time marker of the request is cataloged, and the backup is created asynchronously, by applying all changes until the time of the request to the last full table snapshot. Backup requests are processed instantaneously and become available for restore within minutes. </p> <p>You can call <code>CreateBackup</code> at a maximum rate of 50 times per second.</p> <p>All backups in DynamoDB work without consuming any provisioned throughput on the table.</p> <p> If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to contain all data committed to the table up to 14:24:00, and data committed after 14:26:00 will not be. The backup may or may not contain data modifications made between 14:24:00 and 14:26:00. On-Demand Backup does not support causal consistency. </p> <p> Along with data, the following are also included on the backups: </p> <ul> <li> <p>Global secondary indexes (GSIs)</p> </li> <li> <p>Local secondary indexes (LSIs)</p> </li> <li> <p>Streams</p> </li> <li> <p>Provisioned read and write capacity</p> </li> </ul>",
"CreateGlobalTable": "<p>Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided regions. </p> <p> Tables can only be added as the replicas of a global table group under the following conditions: </p> <ul> <li> <p> The tables must have the same name. </p> </li> <li> <p> The tables must contain no items. </p> </li> <li> <p> The tables must have the same hash key and sort key (if present). </p> </li> <li> <p> The tables must have DynamoDB Streams enabled (NEW_AND_OLD_IMAGES). </p> </li> </ul>",
"CreateGlobalTable": "<p>Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided regions. </p> <p> Tables can only be added as the replicas of a global table group under the following conditions: </p> <ul> <li> <p> The tables must have the same name. </p> </li> <li> <p> The tables must contain no items. </p> </li> <li> <p> The tables must have the same hash key and sort key (if present). </p> </li> <li> <p> The tables must have DynamoDB Streams enabled (NEW_AND_OLD_IMAGES). </p> </li> <li> <p> The tables must have same provisioned and maximum write capacity units. </p> </li> </ul> <p> If global secondary indexes are specified, then the following conditions must also be met: </p> <ul> <li> <p> The global secondary indexes must have the same name. </p> </li> <li> <p> The global secondary indexes must have the same hash key and sort key (if present). </p> </li> <li> <p> The global secondary indexes must have the same provisioned and maximum write capacity units. </p> </li> </ul>",
"CreateTable": "<p>The <code>CreateTable</code> operation adds a new table to your account. In an AWS account, table names must be unique within each region. That is, you can have two tables with same name if you create the tables in different regions.</p> <p> <code>CreateTable</code> is an asynchronous operation. Upon receiving a <code>CreateTable</code> request, DynamoDB immediately returns a response with a <code>TableStatus</code> of <code>CREATING</code>. After the table is created, DynamoDB sets the <code>TableStatus</code> to <code>ACTIVE</code>. You can perform read and write operations only on an <code>ACTIVE</code> table. </p> <p>You can optionally define secondary indexes on the new table, as part of the <code>CreateTable</code> operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the <code>CREATING</code> state at any given time.</p> <p>You can use the <code>DescribeTable</code> action to check the table status.</p>",
"DeleteBackup": "<p>Deletes an existing backup of a table.</p> <p>You can call <code>DeleteBackup</code> at a maximum rate of 10 times per second.</p>",
"DeleteItem": "<p>Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.</p> <p>In addition to deleting an item, you can also return the item's attribute values in the same operation, using the <code>ReturnValues</code> parameter.</p> <p>Unless you specify conditions, the <code>DeleteItem</code> is an idempotent operation; running it multiple times on the same item or attribute does <i>not</i> result in an error response.</p> <p>Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.</p>",
"DeleteTable": "<p>The <code>DeleteTable</code> operation deletes a table and all of its items. After a <code>DeleteTable</code> request, the specified table is in the <code>DELETING</code> state until DynamoDB completes the deletion. If the table is in the <code>ACTIVE</code> state, you can delete it. If a table is in <code>CREATING</code> or <code>UPDATING</code> states, then DynamoDB returns a <code>ResourceInUseException</code>. If the specified table does not exist, DynamoDB returns a <code>ResourceNotFoundException</code>. If table is already in the <code>DELETING</code> state, no error is returned. </p> <note> <p>DynamoDB might continue to accept data read and write operations, such as <code>GetItem</code> and <code>PutItem</code>, on a table in the <code>DELETING</code> state until the table deletion is complete.</p> </note> <p>When you delete a table, any indexes on that table are also deleted.</p> <p>If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the <code>DISABLED</code> state, and the stream is automatically deleted after 24 hours.</p> <p>Use the <code>DescribeTable</code> action to check the status of the table. </p>",
"DescribeBackup": "<p>Describes an existing backup of a table.</p> <p>You can call <code>DescribeBackup</code> at a maximum rate of 10 times per second.</p>",
"DescribeContinuousBackups": "<p>Checks the status of the backup restore settings on the specified table. If backups are enabled, <code>ContinuousBackupsStatus</code> will bet set to ENABLED.</p> <p>You can call <code>DescribeContinuousBackups</code> at a maximum rate of 10 times per second.</p>",
"DescribeContinuousBackups": "<p>Checks the status of continuous backups and point in time recovery on the specified table. Continuous backups are <code>ENABLED</code> on all tables at table creation. If point in time recovery is enabled, <code>PointInTimeRecoveryStatus</code> will be set to ENABLED.</p> <p> Once continuous backups and point in time recovery are enabled, you can restore to any point in time within <code>EarliestRestorableDateTime</code> and <code>LatestRestorableDateTime</code>. </p> <p> <code>LatestRestorableDateTime</code> is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days. </p> <p>You can call <code>DescribeContinuousBackups</code> at a maximum rate of 10 times per second.</p>",
"DescribeGlobalTable": "<p>Returns information about the specified global table.</p>",
"DescribeGlobalTableSettings": "<p>Describes region specific settings for a global table.</p>",
"DescribeLimits": "<p>Returns the current provisioned-capacity limits for your AWS account in a region, both for the region as a whole and for any one DynamoDB table that you create there.</p> <p>When you establish an AWS account, the account has initial limits on the maximum read capacity units and write capacity units that you can provision across all of your DynamoDB tables in a given region. Also, there are per-table limits that apply when you create a table there. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html\">Limits</a> page in the <i>Amazon DynamoDB Developer Guide</i>.</p> <p>Although you can increase these limits by filing a case at <a href=\"https://console.aws.amazon.com/support/home#/\">AWS Support Center</a>, obtaining the increase is not instantaneous. The <code>DescribeLimits</code> action lets you write code to compare the capacity you are currently using to those limits imposed by your account so that you have enough time to apply for an increase before you hit a limit.</p> <p>For example, you could use one of the AWS SDKs to do the following:</p> <ol> <li> <p>Call <code>DescribeLimits</code> for a particular region to obtain your current account limits on provisioned capacity there.</p> </li> <li> <p>Create a variable to hold the aggregate read capacity units provisioned for all your tables in that region, and one to hold the aggregate write capacity units. Zero them both.</p> </li> <li> <p>Call <code>ListTables</code> to obtain a list of all your DynamoDB tables.</p> </li> <li> <p>For each table name listed by <code>ListTables</code>, do the following:</p> <ul> <li> <p>Call <code>DescribeTable</code> with the table name.</p> </li> <li> <p>Use the data returned by <code>DescribeTable</code> to add the read capacity units and write capacity units provisioned for the table itself to your variables.</p> </li> <li> <p>If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well.</p> </li> </ul> </li> <li> <p>Report the account limits for that region returned by <code>DescribeLimits</code>, along with the total current provisioned capacity levels you have calculated.</p> </li> </ol> <p>This will let you see whether you are getting close to your account-level limits.</p> <p>The per-table limits apply only when you are creating a new table. They restrict the sum of the provisioned capacity of the new table itself and all its global secondary indexes.</p> <p>For existing tables and their GSIs, DynamoDB will not let you increase provisioned capacity extremely rapidly, but the only upper limit that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account limits.</p> <note> <p> <code>DescribeLimits</code> should only be called periodically. You can expect throttling errors if you call it more than once in a minute.</p> </note> <p>The <code>DescribeLimits</code> Request element has no content.</p>",
"DescribeTable": "<p>Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.</p> <note> <p>If you issue a <code>DescribeTable</code> request immediately after a <code>CreateTable</code> request, DynamoDB might return a <code>ResourceNotFoundException</code>. This is because <code>DescribeTable</code> uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the <code>DescribeTable</code> request again.</p> </note>",
"DescribeTimeToLive": "<p>Gives a description of the Time to Live (TTL) status on the specified table. </p>",
@ -23,11 +24,14 @@
"ListTagsOfResource": "<p>List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 times per second, per account.</p> <p>For an overview on tagging DynamoDB resources, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html\">Tagging for DynamoDB</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>",
"PutItem": "<p>Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. You can return the item's attribute values in the same operation, using the <code>ReturnValues</code> parameter.</p> <important> <p>This topic provides general information about the <code>PutItem</code> API.</p> <p>For information on how to call the <code>PutItem</code> API using the AWS SDK in specific languages, see the following:</p> <ul> <li> <p> <a href=\"http://docs.aws.amazon.com/goto/aws-cli/dynamodb-2012-08-10/PutItem\"> PutItem in the AWS Command Line Interface </a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/goto/DotNetSDKV3/dynamodb-2012-08-10/PutItem\"> PutItem in the AWS SDK for .NET </a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/goto/SdkForCpp/dynamodb-2012-08-10/PutItem\"> PutItem in the AWS SDK for C++ </a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/goto/SdkForGoV1/dynamodb-2012-08-10/PutItem\"> PutItem in the AWS SDK for Go </a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/goto/SdkForJava/dynamodb-2012-08-10/PutItem\"> PutItem in the AWS SDK for Java </a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/goto/AWSJavaScriptSDK/dynamodb-2012-08-10/PutItem\"> PutItem in the AWS SDK for JavaScript </a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/goto/SdkForPHPV3/dynamodb-2012-08-10/PutItem\"> PutItem in the AWS SDK for PHP V3 </a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/goto/boto3/dynamodb-2012-08-10/PutItem\"> PutItem in the AWS SDK for Python </a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/goto/SdkForRubyV2/dynamodb-2012-08-10/PutItem\"> PutItem in the AWS SDK for Ruby V2 </a> </p> </li> </ul> </important> <p>When you add an item, the primary key attribute(s) are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a <code>ValidationException</code> exception.</p> <note> <p>To prevent a new item from replacing an existing item, use a conditional expression that contains the <code>attribute_not_exists</code> function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the <code>attribute_not_exists</code> function will only succeed if no matching item exists.</p> </note> <p>For more information about <code>PutItem</code>, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithItems.html\">Working with Items</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>",
"Query": "<p>The <code>Query</code> operation finds items based on primary key values. You can query any table or secondary index that has a composite primary key (a partition key and a sort key). </p> <p>Use the <code>KeyConditionExpression</code> parameter to provide a specific value for the partition key. The <code>Query</code> operation will return all of the items from the table or index with that partition key value. You can optionally narrow the scope of the <code>Query</code> operation by specifying a sort key value and a comparison operator in <code>KeyConditionExpression</code>. To further refine the <code>Query</code> results, you can optionally provide a <code>FilterExpression</code>. A <code>FilterExpression</code> determines which items within the results should be returned to you. All of the other results are discarded. </p> <p> A <code>Query</code> operation always returns a result set. If no matching items are found, the result set will be empty. Queries that do not return results consume the minimum number of read capacity units for that type of read operation. </p> <note> <p> DynamoDB calculates the number of read capacity units consumed based on item size, not on the amount of data that is returned to an application. The number of capacity units consumed will be the same whether you request all of the attributes (the default behavior) or just some of them (using a projection expression). The number will also be the same whether or not you use a <code>FilterExpression</code>. </p> </note> <p> <code>Query</code> results are always sorted by the sort key value. If the data type of the sort key is Number, the results are returned in numeric order; otherwise, the results are returned in order of UTF-8 bytes. By default, the sort order is ascending. To reverse the order, set the <code>ScanIndexForward</code> parameter to false. </p> <p> A single <code>Query</code> operation will read up to the maximum number of items set (if using the <code>Limit</code> parameter) or a maximum of 1 MB of data and then apply any filtering to the results using <code>FilterExpression</code>. If <code>LastEvaluatedKey</code> is present in the response, you will need to paginate the result set. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Query.html#Query.Pagination\">Paginating the Results</a> in the <i>Amazon DynamoDB Developer Guide</i>. </p> <p> <code>FilterExpression</code> is applied after a <code>Query</code> finishes, but before the results are returned. A <code>FilterExpression</code> cannot contain partition key or sort key attributes. You need to specify those attributes in the <code>KeyConditionExpression</code>. </p> <note> <p> A <code>Query</code> operation can return an empty result set and a <code>LastEvaluatedKey</code> if all the items read for the page of results are filtered out. </p> </note> <p>You can query a table, a local secondary index, or a global secondary index. For a query on a table or on a local secondary index, you can set the <code>ConsistentRead</code> parameter to <code>true</code> and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify <code>ConsistentRead</code> when querying a global secondary index.</p>",
"RestoreTableFromBackup": "<p>Creates a new table from an existing backup. Any number of users can execute up to 10 concurrent restores in a given account. </p> <p>You can call <code>RestoreTableFromBackup</code> at a maximum rate of 10 times per second.</p> <p>You must manually set up the following on the restored table:</p> <ul> <li> <p>Auto scaling policies</p> </li> <li> <p>IAM policies</p> </li> <li> <p>Cloudwatch metrics and alarms</p> </li> <li> <p>Tags</p> </li> <li> <p>Stream settings</p> </li> <li> <p>Time to Live (TTL) settings</p> </li> </ul>",
"RestoreTableFromBackup": "<p>Creates a new table from an existing backup. Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account. </p> <p>You can call <code>RestoreTableFromBackup</code> at a maximum rate of 10 times per second.</p> <p>You must manually set up the following on the restored table:</p> <ul> <li> <p>Auto scaling policies</p> </li> <li> <p>IAM policies</p> </li> <li> <p>Cloudwatch metrics and alarms</p> </li> <li> <p>Tags</p> </li> <li> <p>Stream settings</p> </li> <li> <p>Time to Live (TTL) settings</p> </li> </ul>",
"RestoreTableToPointInTime": "<p>Restores the specified table to the specified point in time within <code>EarliestRestorableDateTime</code> and <code>LatestRestorableDateTime</code>. You can restore your table to any point in time during the last 35 days. Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account. </p> <p> When you restore using point in time recovery, DynamoDB restores your table data to the state based on the selected date and time (day:hour:minute:second) to a new table. </p> <p> Along with data, the following are also included on the new restored table using point in time recovery: </p> <ul> <li> <p>Global secondary indexes (GSIs)</p> </li> <li> <p>Local secondary indexes (LSIs)</p> </li> <li> <p>Provisioned read and write capacity</p> </li> <li> <p>Encryption settings</p> <important> <p> All these settings come from the current settings of the source table at the time of restore. </p> </important> </li> </ul> <p>You must manually set up the following on the restored table:</p> <ul> <li> <p>Auto scaling policies</p> </li> <li> <p>IAM policies</p> </li> <li> <p>Cloudwatch metrics and alarms</p> </li> <li> <p>Tags</p> </li> <li> <p>Stream settings</p> </li> <li> <p>Time to Live (TTL) settings</p> </li> <li> <p>Point in time recovery settings</p> </li> </ul>",
"Scan": "<p>The <code>Scan</code> operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a <code>FilterExpression</code> operation.</p> <p>If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user as a <code>LastEvaluatedKey</code> value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria. </p> <p>A single <code>Scan</code> operation will read up to the maximum number of items set (if using the <code>Limit</code> parameter) or a maximum of 1 MB of data and then apply any filtering to the results using <code>FilterExpression</code>. If <code>LastEvaluatedKey</code> is present in the response, you will need to paginate the result set. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.Pagination\">Paginating the Results</a> in the <i>Amazon DynamoDB Developer Guide</i>. </p> <p> <code>Scan</code> operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel <code>Scan</code> operation by providing the <code>Segment</code> and <code>TotalSegments</code> parameters. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Scan.html#Scan.ParallelScan\">Parallel Scan</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> <p> <code>Scan</code> uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the <code>Scan</code> begins, you can set the <code>ConsistentRead</code> parameter to <code>true</code>.</p>",
"TagResource": "<p>Associate a set of tags with an Amazon DynamoDB resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. You can call TagResource up to 5 times per second, per account. </p> <p>For an overview on tagging DynamoDB resources, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html\">Tagging for DynamoDB</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>",
"UntagResource": "<p>Removes the association of tags from an Amazon DynamoDB resource. You can call UntagResource up to 5 times per second, per account. </p> <p>For an overview on tagging DynamoDB resources, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html\">Tagging for DynamoDB</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>",
"UpdateGlobalTable": "<p>Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, must have the same name as the global table, must have the same key schema, must have DynamoDB Streams enabled, and cannot have any local secondary indexes (LSIs).</p> <note> <p>Although you can use <code>UpdateGlobalTable</code> to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas.</p> </note>",
"UpdateContinuousBackups": "<p> <code>UpdateContinuousBackups</code> enables or disables point in time recovery for the specified table. A successful <code>UpdateContinuousBackups</code> call returns the current <code>ContinuousBackupsDescription</code>. Continuous backups are <code>ENABLED</code> on all tables at table creation. If point in time recovery is enabled, <code>PointInTimeRecoveryStatus</code> will be set to ENABLED.</p> <p> Once continuous backups and point in time recovery are enabled, you can restore to any point in time within <code>EarliestRestorableDateTime</code> and <code>LatestRestorableDateTime</code>. </p> <p> <code>LatestRestorableDateTime</code> is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days.. </p>",
"UpdateGlobalTable": "<p>Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, must have the same name as the global table, must have the same key schema, and must have DynamoDB Streams enabled and must have same provisioned and maximum write capacity units.</p> <note> <p>Although you can use <code>UpdateGlobalTable</code> to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas.</p> </note> <p> If global secondary indexes are specified, then the following conditions must also be met: </p> <ul> <li> <p> The global secondary indexes must have the same name. </p> </li> <li> <p> The global secondary indexes must have the same hash key and sort key (if present). </p> </li> <li> <p> The global secondary indexes must have the same provisioned and maximum write capacity units. </p> </li> </ul>",
"UpdateGlobalTableSettings": "<p>Updates settings for a global table.</p>",
"UpdateItem": "<p>Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values).</p> <p>You can also return the item's attribute values in the same <code>UpdateItem</code> operation using the <code>ReturnValues</code> parameter.</p>",
"UpdateTable": "<p>Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.</p> <p>You can only perform one of the following operations at once:</p> <ul> <li> <p>Modify the provisioned throughput settings of the table.</p> </li> <li> <p>Enable or disable Streams on the table.</p> </li> <li> <p>Remove a global secondary index from the table.</p> </li> <li> <p>Create a new global secondary index on the table. Once the index begins backfilling, you can use <code>UpdateTable</code> to perform other operations.</p> </li> </ul> <p> <code>UpdateTable</code> is an asynchronous operation; while it is executing, the table status changes from <code>ACTIVE</code> to <code>UPDATING</code>. While it is <code>UPDATING</code>, you cannot issue another <code>UpdateTable</code> request. When the table returns to the <code>ACTIVE</code> state, the <code>UpdateTable</code> operation is complete.</p>",
"UpdateTimeToLive": "<p>The UpdateTimeToLive method will enable or disable TTL for the specified table. A successful <code>UpdateTimeToLive</code> call returns the current <code>TimeToLiveSpecification</code>; it may take up to one hour for the change to fully process. Any additional <code>UpdateTimeToLive</code> calls for the same table during this one hour duration result in a <code>ValidationException</code>. </p> <p>TTL compares the current time in epoch time format to the time stored in the TTL attribute of an item. If the epoch time value stored in the attribute is less than the current time, the item is marked as expired and subsequently deleted.</p> <note> <p> The epoch time format is the number of seconds elapsed since 12:00:00 AM January 1st, 1970 UTC. </p> </note> <p>DynamoDB deletes expired items on a best-effort basis to ensure availability of throughput for other data operations. </p> <important> <p>DynamoDB typically deletes expired items within two days of expiration. The exact duration within which an item gets deleted after expiration is specific to the nature of the workload. Items that have expired and not been deleted will still show up in reads, queries, and scans.</p> </important> <p>As items are deleted, they are removed from any Local Secondary Index and Global Secondary Index immediately in the same eventually consistent way as a standard delete operation.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html\">Time To Live</a> in the Amazon DynamoDB Developer Guide. </p>"
@ -275,7 +279,9 @@
"base": null,
"refs": {
"ExpectedAttributeValue$Exists": "<p>Causes DynamoDB to evaluate the value before attempting a conditional operation:</p> <ul> <li> <p>If <code>Exists</code> is <code>true</code>, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a <code>ConditionalCheckFailedException</code>.</p> </li> <li> <p>If <code>Exists</code> is <code>false</code>, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a <code>ConditionalCheckFailedException</code>.</p> </li> </ul> <p>The default setting for <code>Exists</code> is <code>true</code>. If you supply a <code>Value</code> all by itself, DynamoDB assumes the attribute exists: You don't have to set <code>Exists</code> to <code>true</code>, because it is implied.</p> <p>DynamoDB returns a <code>ValidationException</code> if:</p> <ul> <li> <p> <code>Exists</code> is <code>true</code> but there is no <code>Value</code> to check. (You expect a value to exist, but don't specify what that value is.)</p> </li> <li> <p> <code>Exists</code> is <code>false</code> but you also provide a <code>Value</code>. (You cannot expect an attribute to have a value, while also expecting it not to exist.)</p> </li> </ul>",
"QueryInput$ScanIndexForward": "<p>Specifies the order for index traversal: If <code>true</code> (default), the traversal is performed in ascending order; if <code>false</code>, the traversal is performed in descending order. </p> <p>Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored in order of ASCII character code values. For type Binary, DynamoDB treats each byte of the binary data as unsigned.</p> <p>If <code>ScanIndexForward</code> is <code>true</code>, DynamoDB returns the results in the order in which they are stored (by sort key value). This is the default behavior. If <code>ScanIndexForward</code> is <code>false</code>, DynamoDB reads the results in reverse order by sort key value, and then returns the results to the client.</p>"
"PointInTimeRecoverySpecification$PointInTimeRecoveryEnabled": "<p>Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.</p>",
"QueryInput$ScanIndexForward": "<p>Specifies the order for index traversal: If <code>true</code> (default), the traversal is performed in ascending order; if <code>false</code>, the traversal is performed in descending order. </p> <p>Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored in order of UTF-8 bytes. For type Binary, DynamoDB treats each byte of the binary data as unsigned.</p> <p>If <code>ScanIndexForward</code> is <code>true</code>, DynamoDB returns the results in the order in which they are stored (by sort key value). This is the default behavior. If <code>ScanIndexForward</code> is <code>false</code>, DynamoDB reads the results in reverse order by sort key value, and then returns the results to the client.</p>",
"RestoreTableToPointInTimeInput$UseLatestRestorableTime": "<p>Restore the table to the latest possible time. <code>LatestRestorableDateTime</code> is typically 5 minutes before the current time. </p>"
}
},
"Capacity": {
@ -360,15 +366,16 @@
}
},
"ContinuousBackupsDescription": {
"base": "<p>Represents the backup and restore settings on the table when the backup was created.</p>",
"base": "<p>Represents the continuous backups and point in time recovery settings on the table.</p>",
"refs": {
"DescribeContinuousBackupsOutput$ContinuousBackupsDescription": "<p> <code>ContinuousBackupsDescription</code> can be one of the following : ENABLED, DISABLED. </p>"
"DescribeContinuousBackupsOutput$ContinuousBackupsDescription": "<p> <code>ContinuousBackupsDescription</code> can be one of the following : ENABLED, DISABLED. </p>",
"UpdateContinuousBackupsOutput$ContinuousBackupsDescription": "<p>Represents the continuous backups and point in time recovery settings on the table.</p>"
}
},
"ContinuousBackupsStatus": {
"base": null,
"refs": {
"ContinuousBackupsDescription$ContinuousBackupsStatus": "<p>ContinuousBackupsStatus can be one of the following states : ENABLED, DISABLED</p>"
"ContinuousBackupsDescription$ContinuousBackupsStatus": "<p> <code>ContinuousBackupsStatus</code> can be one of the following states : ENABLED, DISABLED</p>"
}
},
"ContinuousBackupsUnavailableException": {
@ -422,8 +429,12 @@
"base": null,
"refs": {
"GlobalTableDescription$CreationDateTime": "<p>The creation time of the global table.</p>",
"PointInTimeRecoveryDescription$EarliestRestorableDateTime": "<p>Specifies the earliest point in time you can restore your table to. It You can restore your table to any point in time during the last 35 days. </p>",
"PointInTimeRecoveryDescription$LatestRestorableDateTime": "<p> <code>LatestRestorableDateTime</code> is typically 5 minutes before the current time. </p>",
"ProvisionedThroughputDescription$LastIncreaseDateTime": "<p>The date and time of the last provisioned throughput increase for this table.</p>",
"ProvisionedThroughputDescription$LastDecreaseDateTime": "<p>The date and time of the last provisioned throughput decrease for this table.</p>",
"RestoreSummary$RestoreDateTime": "<p>Point in time or source backup time.</p>",
"RestoreTableToPointInTimeInput$RestoreDateTime": "<p>Time in the past to restore the table to.</p>",
"TableDescription$CreationDateTime": "<p>The date and time when the table was created, in <a href=\"http://www.epochconverter.com/\">UNIX epoch time</a> format.</p>"
}
},
@ -505,6 +516,16 @@
"refs": {
}
},
"DescribeGlobalTableSettingsInput": {
"base": null,
"refs": {
}
},
"DescribeGlobalTableSettingsOutput": {
"base": null,
"refs": {
}
},
"DescribeLimitsInput": {
"base": "<p>Represents the input of a <code>DescribeLimits</code> operation. Has no content.</p>",
"refs": {
@ -544,9 +565,12 @@
"ContinuousBackupsUnavailableException$message": null,
"GlobalTableAlreadyExistsException$message": null,
"GlobalTableNotFoundException$message": null,
"IndexNotFoundException$message": null,
"InternalServerError$message": "<p>The server encountered an internal error trying to fulfill the request.</p>",
"InvalidRestoreTimeException$message": null,
"ItemCollectionSizeLimitExceededException$message": "<p>The total size of an item collection has exceeded the maximum limit of 10 gigabytes.</p>",
"LimitExceededException$message": "<p>Too many operations for a given subscriber.</p>",
"PointInTimeRecoveryUnavailableException$message": null,
"ProvisionedThroughputExceededException$message": "<p>You exceeded your maximum allowed provisioned throughput.</p>",
"ReplicaAlreadyExistsException$message": null,
"ReplicaNotFoundException$message": null,
@ -695,6 +719,18 @@
"UpdateGlobalTableOutput$GlobalTableDescription": "<p>Contains the details of the global table.</p>"
}
},
"GlobalTableGlobalSecondaryIndexSettingsUpdate": {
"base": "<p>Represents the settings of a global secondary index for a global table that will be modified.</p>",
"refs": {
"GlobalTableGlobalSecondaryIndexSettingsUpdateList$member": null
}
},
"GlobalTableGlobalSecondaryIndexSettingsUpdateList": {
"base": null,
"refs": {
"UpdateGlobalTableSettingsInput$GlobalTableGlobalSecondaryIndexSettingsUpdate": "<p>Represents the settings of a global secondary index for a global table that will be modified.</p>"
}
},
"GlobalTableList": {
"base": null,
"refs": {
@ -720,19 +756,28 @@
"GlobalSecondaryIndex$IndexName": "<p>The name of the global secondary index. The name must be unique among all other indexes on this table.</p>",
"GlobalSecondaryIndexDescription$IndexName": "<p>The name of the global secondary index.</p>",
"GlobalSecondaryIndexInfo$IndexName": "<p>The name of the global secondary index.</p>",
"GlobalTableGlobalSecondaryIndexSettingsUpdate$IndexName": "<p>The name of the global secondary index. The name must be unique among all other indexes on this table.</p>",
"LocalSecondaryIndex$IndexName": "<p>The name of the local secondary index. The name must be unique among all other indexes on this table.</p>",
"LocalSecondaryIndexDescription$IndexName": "<p>Represents the name of the local secondary index.</p>",
"LocalSecondaryIndexInfo$IndexName": "<p>Represents the name of the local secondary index.</p>",
"QueryInput$IndexName": "<p>The name of an index to query. This index can be any local secondary index or global secondary index on the table. Note that if you use the <code>IndexName</code> parameter, you must also provide <code>TableName.</code> </p>",
"ReplicaGlobalSecondaryIndexSettingsDescription$IndexName": "<p>The name of the global secondary index. The name must be unique among all other indexes on this table.</p>",
"ReplicaGlobalSecondaryIndexSettingsUpdate$IndexName": "<p>The name of the global secondary index. The name must be unique among all other indexes on this table.</p>",
"ScanInput$IndexName": "<p>The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the <code>IndexName</code> parameter, you must also provide <code>TableName</code>.</p>",
"SecondaryIndexesCapacityMap$key": null,
"UpdateGlobalSecondaryIndexAction$IndexName": "<p>The name of the global secondary index to be updated.</p>"
}
},
"IndexNotFoundException": {
"base": "<p>The operation tried to access a nonexistent index.</p>",
"refs": {
}
},
"IndexStatus": {
"base": null,
"refs": {
"GlobalSecondaryIndexDescription$IndexStatus": "<p>The current state of the global secondary index:</p> <ul> <li> <p> <code>CREATING</code> - The index is being created.</p> </li> <li> <p> <code>UPDATING</code> - The index is being updated.</p> </li> <li> <p> <code>DELETING</code> - The index is being deleted.</p> </li> <li> <p> <code>ACTIVE</code> - The index is ready for use.</p> </li> </ul>"
"GlobalSecondaryIndexDescription$IndexStatus": "<p>The current state of the global secondary index:</p> <ul> <li> <p> <code>CREATING</code> - The index is being created.</p> </li> <li> <p> <code>UPDATING</code> - The index is being updated.</p> </li> <li> <p> <code>DELETING</code> - The index is being deleted.</p> </li> <li> <p> <code>ACTIVE</code> - The index is ready for use.</p> </li> </ul>",
"ReplicaGlobalSecondaryIndexSettingsDescription$IndexStatus": "<p> The current status of the global secondary index:</p> <ul> <li> <p> <code>CREATING</code> - The global secondary index is being created.</p> </li> <li> <p> <code>UPDATING</code> - The global secondary index is being updated.</p> </li> <li> <p> <code>DELETING</code> - The global secondary index is being deleted.</p> </li> <li> <p> <code>ACTIVE</code> - The global secondary index is ready for use.</p> </li> </ul>"
}
},
"Integer": {
@ -749,6 +794,11 @@
"refs": {
}
},
"InvalidRestoreTimeException": {
"base": "<p>An invalid restore time was specified. RestoreDateTime must be between EarliestRestorableDateTime and LatestRestorableDateTime.</p>",
"refs": {
}
},
"ItemCollectionKeyAttributeMap": {
"base": null,
"refs": {
@ -880,7 +930,7 @@
}
},
"LimitExceededException": {
"base": "<p>Up to 50 <code>CreateBackup</code> operations are allowed per second, per account. There is no limit to the number of daily on-demand backups that can be taken. </p> <p>Up to 10 simultaneous table operations are allowed per account. These operations include <code>CreateTable</code>, <code>UpdateTable</code>, <code>DeleteTable</code>,<code>UpdateTimeToLive</code>, and <code>RestoreTableFromBackup</code>. </p> <p>For tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously.</p> <p>The total limit of tables in the <code>ACTIVE</code> state is 250.</p> <p>For tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously.</p> <p>The total limit of tables in the <code>ACTIVE</code> state is 250.</p>",
"base": "<p>Up to 50 <code>CreateBackup</code> operations are allowed per second, per account. There is no limit to the number of daily on-demand backups that can be taken. </p> <p>Up to 10 simultaneous table operations are allowed per account. These operations include <code>CreateTable</code>, <code>UpdateTable</code>, <code>DeleteTable</code>,<code>UpdateTimeToLive</code>, <code>RestoreTableFromBackup</code>, and <code>RestoreTableToPointInTime</code>. </p> <p>For tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously.</p> <p>The total limit of tables in the <code>ACTIVE</code> state is 250.</p>",
"refs": {
}
},
@ -1028,6 +1078,29 @@
"AttributeValue$NS": "<p>An attribute of type Number Set. For example:</p> <p> <code>\"NS\": [\"42.2\", \"-19\", \"7.5\", \"3.14\"]</code> </p> <p>Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.</p>"
}
},
"PointInTimeRecoveryDescription": {
"base": "<p>The description of the point in time settings applied to the table.</p>",
"refs": {
"ContinuousBackupsDescription$PointInTimeRecoveryDescription": "<p>The description of the point in time recovery settings applied to the table.</p>"
}
},
"PointInTimeRecoverySpecification": {
"base": "<p>Represents the settings used to enable point in time recovery.</p>",
"refs": {
"UpdateContinuousBackupsInput$PointInTimeRecoverySpecification": "<p>Represents the settings used to enable point in time recovery.</p>"
}
},
"PointInTimeRecoveryStatus": {
"base": null,
"refs": {
"PointInTimeRecoveryDescription$PointInTimeRecoveryStatus": "<p>The current state of point in time recovery:</p> <ul> <li> <p> <code>ENABLING</code> - Point in time recovery is being enabled.</p> </li> <li> <p> <code>ENABLED</code> - Point in time recovery is enabled.</p> </li> <li> <p> <code>DISABLED</code> - Point in time recovery is disabled.</p> </li> </ul>"
}
},
"PointInTimeRecoveryUnavailableException": {
"base": "<p>Point in time recovery has not yet been enabled for this source table.</p>",
"refs": {
}
},
"PositiveIntegerObject": {
"base": null,
"refs": {
@ -1043,11 +1116,19 @@
"DescribeLimitsOutput$AccountMaxWriteCapacityUnits": "<p>The maximum total write capacity units that your account allows you to provision across all of your tables in this region.</p>",
"DescribeLimitsOutput$TableMaxReadCapacityUnits": "<p>The maximum read capacity units that your account allows you to provision for a new table that you are creating in this region, including the read capacity units provisioned for its global secondary indexes (GSIs).</p>",
"DescribeLimitsOutput$TableMaxWriteCapacityUnits": "<p>The maximum write capacity units that your account allows you to provision for a new table that you are creating in this region, including the write capacity units provisioned for its global secondary indexes (GSIs).</p>",
"GlobalTableGlobalSecondaryIndexSettingsUpdate$ProvisionedWriteCapacityUnits": "<p>The maximum number of writes consumed per second before DynamoDB returns a <code>ThrottlingException.</code> </p>",
"ProvisionedThroughput$ReadCapacityUnits": "<p>The maximum number of strongly consistent reads consumed per second before DynamoDB returns a <code>ThrottlingException</code>. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput\">Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>",
"ProvisionedThroughput$WriteCapacityUnits": "<p>The maximum number of writes consumed per second before DynamoDB returns a <code>ThrottlingException</code>. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput\">Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>",
"ProvisionedThroughputDescription$NumberOfDecreasesToday": "<p>The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html\">Limits</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>",
"ProvisionedThroughputDescription$ReadCapacityUnits": "<p>The maximum number of strongly consistent reads consumed per second before DynamoDB returns a <code>ThrottlingException</code>. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 <code>ReadCapacityUnits</code> per second provides 100 eventually consistent <code>ReadCapacityUnits</code> per second.</p>",
"ProvisionedThroughputDescription$WriteCapacityUnits": "<p>The maximum number of writes consumed per second before DynamoDB returns a <code>ThrottlingException</code>.</p>"
"ProvisionedThroughputDescription$WriteCapacityUnits": "<p>The maximum number of writes consumed per second before DynamoDB returns a <code>ThrottlingException</code>.</p>",
"ReplicaGlobalSecondaryIndexSettingsDescription$ProvisionedReadCapacityUnits": "<p>The maximum number of strongly consistent reads consumed per second before DynamoDB returns a <code>ThrottlingException</code>.</p>",
"ReplicaGlobalSecondaryIndexSettingsDescription$ProvisionedWriteCapacityUnits": "<p>The maximum number of writes consumed per second before DynamoDB returns a <code>ThrottlingException</code>.</p>",
"ReplicaGlobalSecondaryIndexSettingsUpdate$ProvisionedReadCapacityUnits": "<p>The maximum number of strongly consistent reads consumed per second before DynamoDB returns a <code>ThrottlingException</code>.</p>",
"ReplicaSettingsDescription$ReplicaProvisionedReadCapacityUnits": "<p>The maximum number of strongly consistent reads consumed per second before DynamoDB returns a <code>ThrottlingException</code>. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput\">Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>. </p>",
"ReplicaSettingsDescription$ReplicaProvisionedWriteCapacityUnits": "<p>The maximum number of writes consumed per second before DynamoDB returns a <code>ThrottlingException</code>. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput\">Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>",
"ReplicaSettingsUpdate$ReplicaProvisionedReadCapacityUnits": "<p>The maximum number of strongly consistent reads consumed per second before DynamoDB returns a <code>ThrottlingException</code>. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput\">Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB Developer Guide</i>. </p>",
"UpdateGlobalTableSettingsInput$GlobalTableProvisionedWriteCapacityUnits": "<p>The maximum number of writes consumed per second before DynamoDB returns a <code>ThrottlingException.</code> </p>"
}
},
"Projection": {
@ -1141,7 +1222,9 @@
"DeleteReplicaAction$RegionName": "<p>The region of the replica to be removed.</p>",
"ListGlobalTablesInput$RegionName": "<p>Lists the global tables in a specific region.</p>",
"Replica$RegionName": "<p>The region where the replica needs to be created.</p>",
"ReplicaDescription$RegionName": "<p>The name of the region.</p>"
"ReplicaDescription$RegionName": "<p>The name of the region.</p>",
"ReplicaSettingsDescription$RegionName": "<p>The region name of the replica.</p>",
"ReplicaSettingsUpdate$RegionName": "<p>The region of the replica to be added.</p>"
}
},
"Replica": {
@ -1167,6 +1250,30 @@
"GlobalTableDescription$ReplicationGroup": "<p>The regions where the global table has replicas.</p>"
}
},
"ReplicaGlobalSecondaryIndexSettingsDescription": {
"base": "<p>Represents the properties of a global secondary index.</p>",
"refs": {
"ReplicaGlobalSecondaryIndexSettingsDescriptionList$member": null
}
},
"ReplicaGlobalSecondaryIndexSettingsDescriptionList": {
"base": null,
"refs": {
"ReplicaSettingsDescription$ReplicaGlobalSecondaryIndexSettings": "<p>Replica global secondary index settings for the global table.</p>"
}
},
"ReplicaGlobalSecondaryIndexSettingsUpdate": {
"base": "<p>Represents the settings of a global secondary index for a global table that will be modified.</p>",
"refs": {
"ReplicaGlobalSecondaryIndexSettingsUpdateList$member": null
}
},
"ReplicaGlobalSecondaryIndexSettingsUpdateList": {
"base": null,
"refs": {
"ReplicaSettingsUpdate$ReplicaGlobalSecondaryIndexSettingsUpdate": "<p>Represents the settings of a global secondary index for a global table that will be modified.</p>"
}
},
"ReplicaList": {
"base": null,
"refs": {
@ -1179,6 +1286,37 @@
"refs": {
}
},
"ReplicaSettingsDescription": {
"base": "<p>Represents the properties of a replica.</p>",
"refs": {
"ReplicaSettingsDescriptionList$member": null
}
},
"ReplicaSettingsDescriptionList": {
"base": null,
"refs": {
"DescribeGlobalTableSettingsOutput$ReplicaSettings": "<p>The region specific settings for the global table.</p>",
"UpdateGlobalTableSettingsOutput$ReplicaSettings": "<p>The region specific settings for the global table.</p>"
}
},
"ReplicaSettingsUpdate": {
"base": "<p>Represents the settings for a global table in a region that will be modified.</p>",
"refs": {
"ReplicaSettingsUpdateList$member": null
}
},
"ReplicaSettingsUpdateList": {
"base": null,
"refs": {
"UpdateGlobalTableSettingsInput$ReplicaSettingsUpdate": "<p>Represents the settings for a global table in a region that will be modified.</p>"
}
},
"ReplicaStatus": {
"base": null,
"refs": {
"ReplicaSettingsDescription$ReplicaStatus": "<p>The current state of the region:</p> <ul> <li> <p> <code>CREATING</code> - The region is being created.</p> </li> <li> <p> <code>UPDATING</code> - The region is being updated.</p> </li> <li> <p> <code>DELETING</code> - The region is being deleted.</p> </li> <li> <p> <code>ACTIVE</code> - The region is ready for use.</p> </li> </ul>"
}
},
"ReplicaUpdate": {
"base": "<p>Represents one of the following:</p> <ul> <li> <p>A new replica to be added to an existing global table.</p> </li> <li> <p>New parameters for an existing replica.</p> </li> <li> <p>An existing replica to be removed from an existing global table.</p> </li> </ul>",
"refs": {
@ -1209,12 +1347,6 @@
"refs": {
}
},
"RestoreDateTime": {
"base": null,
"refs": {
"RestoreSummary$RestoreDateTime": "<p>Point in time or source backup time.</p>"
}
},
"RestoreInProgress": {
"base": null,
"refs": {
@ -1237,6 +1369,16 @@
"refs": {
}
},
"RestoreTableToPointInTimeInput": {
"base": null,
"refs": {
}
},
"RestoreTableToPointInTimeOutput": {
"base": null,
"refs": {
}
},
"ReturnConsumedCapacity": {
"base": "<p>Determines the level of detail about provisioned throughput consumption that is returned in the response:</p> <ul> <li> <p> <code>INDEXES</code> - The response includes the aggregate <code>ConsumedCapacity</code> for the operation, together with <code>ConsumedCapacity</code> for each table and secondary index that was accessed.</p> <p>Note that some operations, such as <code>GetItem</code> and <code>BatchGetItem</code>, do not access any indexes at all. In these cases, specifying <code>INDEXES</code> will only return <code>ConsumedCapacity</code> information for table(s).</p> </li> <li> <p> <code>TOTAL</code> - The response includes only the aggregate <code>ConsumedCapacity</code> for the operation.</p> </li> <li> <p> <code>NONE</code> - No <code>ConsumedCapacity</code> details are included in the response.</p> </li> </ul>",
"refs": {
@ -1396,7 +1538,7 @@
}
},
"TableAlreadyExistsException": {
"base": "<p>A table with the name already exists. </p>",
"base": "<p>A target table with the specified name already exists. </p>",
"refs": {
}
},
@ -1421,6 +1563,7 @@
"DeleteTableOutput$TableDescription": "<p>Represents the properties of a table.</p>",
"DescribeTableOutput$Table": "<p>The properties of the table.</p>",
"RestoreTableFromBackupOutput$TableDescription": "<p>The description of the table created from an existing backup.</p>",
"RestoreTableToPointInTimeOutput$TableDescription": "<p>Represents the properties of a table.</p>",
"UpdateTableOutput$TableDescription": "<p>Represents the properties of the table.</p>"
}
},
@ -1433,7 +1576,7 @@
}
},
"TableInUseException": {
"base": "<p>A table by that name is either being created or deleted. </p>",
"base": "<p>A target table with the specified name is either being created or deleted. </p>",
"refs": {
}
},
@ -1450,8 +1593,10 @@
"CreateTableInput$TableName": "<p>The name of the table to create.</p>",
"DeleteItemInput$TableName": "<p>The name of the table from which to delete the item.</p>",
"DeleteTableInput$TableName": "<p>The name of the table to delete.</p>",
"DescribeContinuousBackupsInput$TableName": "<p>Name of the table for which the customer wants to check the backup and restore settings.</p>",
"DescribeContinuousBackupsInput$TableName": "<p>Name of the table for which the customer wants to check the continuous backups and point in time recovery settings.</p>",
"DescribeGlobalTableInput$GlobalTableName": "<p>The name of the global table.</p>",
"DescribeGlobalTableSettingsInput$GlobalTableName": "<p>The name of the global table to describe.</p>",
"DescribeGlobalTableSettingsOutput$GlobalTableName": "<p>The name of the global table.</p>",
"DescribeTableInput$TableName": "<p>The name of the table to describe.</p>",
"DescribeTimeToLiveInput$TableName": "<p>The name of the table to be described.</p>",
"GetItemInput$TableName": "<p>The name of the table containing the requested item.</p>",
@ -1466,11 +1611,16 @@
"PutItemInput$TableName": "<p>The name of the table to contain the item.</p>",
"QueryInput$TableName": "<p>The name of the table containing the requested items.</p>",
"RestoreTableFromBackupInput$TargetTableName": "<p>The name of the new table to which the backup must be restored.</p>",
"RestoreTableToPointInTimeInput$SourceTableName": "<p>Name of the source table that is being restored.</p>",
"RestoreTableToPointInTimeInput$TargetTableName": "<p>The name of the new table to which it must be restored to.</p>",
"ScanInput$TableName": "<p>The name of the table containing the requested items; or, if you provide <code>IndexName</code>, the name of the table to which that index belongs.</p>",
"SourceTableDetails$TableName": "<p>The name of the table for which the backup was created. </p>",
"TableDescription$TableName": "<p>The name of the table.</p>",
"TableNameList$member": null,
"UpdateContinuousBackupsInput$TableName": "<p>The name of the table.</p>",
"UpdateGlobalTableInput$GlobalTableName": "<p>The global table name.</p>",
"UpdateGlobalTableSettingsInput$GlobalTableName": "<p>The name of the global table</p>",
"UpdateGlobalTableSettingsOutput$GlobalTableName": "<p>The name of the global table.</p>",
"UpdateItemInput$TableName": "<p>The name of the table containing the item to update.</p>",
"UpdateTableInput$TableName": "<p>The name of the table to be updated.</p>",
"UpdateTimeToLiveInput$TableName": "<p>The name of the table to be configured.</p>"
@ -1483,7 +1633,7 @@
}
},
"TableNotFoundException": {
"base": "<p>A table with the name <code>TableName</code> does not currently exist within the subscriber's account.</p>",
"base": "<p>A source table with the name <code>TableName</code> does not currently exist within the subscriber's account.</p>",
"refs": {
}
},
@ -1580,6 +1730,16 @@
"refs": {
}
},
"UpdateContinuousBackupsInput": {
"base": null,
"refs": {
}
},
"UpdateContinuousBackupsOutput": {
"base": null,
"refs": {
}
},
"UpdateExpression": {
"base": null,
"refs": {
@ -1602,6 +1762,16 @@
"refs": {
}
},
"UpdateGlobalTableSettingsInput": {
"base": null,
"refs": {
}
},
"UpdateGlobalTableSettingsOutput": {
"base": null,
"refs": {
}
},
"UpdateItemInput": {
"base": "<p>Represents the input of an <code>UpdateItem</code> operation.</p>",
"refs": {

630
vendor/github.com/aws/aws-sdk-go/models/apis/ec2/2016-11-15/api-2.json generated vendored
View File

@ -338,6 +338,15 @@
"input":{"shape":"CreateEgressOnlyInternetGatewayRequest"},
"output":{"shape":"CreateEgressOnlyInternetGatewayResult"}
},
"CreateFleet":{
"name":"CreateFleet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateFleetRequest"},
"output":{"shape":"CreateFleetResult"}
},
"CreateFlowLogs":{
"name":"CreateFlowLogs",
"http":{
@ -638,6 +647,15 @@
"input":{"shape":"DeleteEgressOnlyInternetGatewayRequest"},
"output":{"shape":"DeleteEgressOnlyInternetGatewayResult"}
},
"DeleteFleets":{
"name":"DeleteFleets",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteFleetsRequest"},
"output":{"shape":"DeleteFleetsResult"}
},
"DeleteFlowLogs":{
"name":"DeleteFlowLogs",
"http":{
@ -988,6 +1006,33 @@
"input":{"shape":"DescribeExportTasksRequest"},
"output":{"shape":"DescribeExportTasksResult"}
},
"DescribeFleetHistory":{
"name":"DescribeFleetHistory",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeFleetHistoryRequest"},
"output":{"shape":"DescribeFleetHistoryResult"}
},
"DescribeFleetInstances":{
"name":"DescribeFleetInstances",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeFleetInstancesRequest"},
"output":{"shape":"DescribeFleetInstancesResult"}
},
"DescribeFleets":{
"name":"DescribeFleets",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeFleetsRequest"},
"output":{"shape":"DescribeFleetsResult"}
},
"DescribeFlowLogs":{
"name":"DescribeFlowLogs",
"http":{
@ -1844,6 +1889,15 @@
"input":{"shape":"ImportVolumeRequest"},
"output":{"shape":"ImportVolumeResult"}
},
"ModifyFleet":{
"name":"ModifyFleet",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyFleetRequest"},
"output":{"shape":"ModifyFleetResult"}
},
"ModifyFpgaImageAttribute":{
"name":"ModifyFpgaImageAttribute",
"http":{
@ -4082,6 +4136,39 @@
}
}
},
"CreateFleetRequest":{
"type":"structure",
"required":[
"LaunchTemplateConfigs",
"TargetCapacitySpecification"
],
"members":{
"DryRun":{"shape":"Boolean"},
"ClientToken":{"shape":"String"},
"SpotOptions":{"shape":"SpotOptionsRequest"},
"ExcessCapacityTerminationPolicy":{"shape":"FleetExcessCapacityTerminationPolicy"},
"LaunchTemplateConfigs":{"shape":"FleetLaunchTemplateConfigListRequest"},
"TargetCapacitySpecification":{"shape":"TargetCapacitySpecificationRequest"},
"TerminateInstancesWithExpiration":{"shape":"Boolean"},
"Type":{"shape":"FleetType"},
"ValidFrom":{"shape":"DateTime"},
"ValidUntil":{"shape":"DateTime"},
"ReplaceUnhealthyInstances":{"shape":"Boolean"},
"TagSpecifications":{
"shape":"TagSpecificationList",
"locationName":"TagSpecification"
}
}
},
"CreateFleetResult":{
"type":"structure",
"members":{
"FleetId":{
"shape":"FleetIdentifier",
"locationName":"fleetId"
}
}
},
"CreateFlowLogsRequest":{
"type":"structure",
"required":[
@ -5058,6 +5145,13 @@
]
},
"DateTime":{"type":"timestamp"},
"DefaultTargetCapacityType":{
"type":"string",
"enum":[
"spot",
"on-demand"
]
},
"DeleteCustomerGatewayRequest":{
"type":"structure",
"required":["CustomerGatewayId"],
@ -5097,6 +5191,100 @@
}
}
},
"DeleteFleetError":{
"type":"structure",
"members":{
"Code":{
"shape":"DeleteFleetErrorCode",
"locationName":"code"
},
"Message":{
"shape":"String",
"locationName":"message"
}
}
},
"DeleteFleetErrorCode":{
"type":"string",
"enum":[
"fleetIdDoesNotExist",
"fleetIdMalformed",
"fleetNotInDeletableState",
"unexpectedError"
]
},
"DeleteFleetErrorItem":{
"type":"structure",
"members":{
"Error":{
"shape":"DeleteFleetError",
"locationName":"error"
},
"FleetId":{
"shape":"FleetIdentifier",
"locationName":"fleetId"
}
}
},
"DeleteFleetErrorSet":{
"type":"list",
"member":{
"shape":"DeleteFleetErrorItem",
"locationName":"item"
}
},
"DeleteFleetSuccessItem":{
"type":"structure",
"members":{
"CurrentFleetState":{
"shape":"FleetStateCode",
"locationName":"currentFleetState"
},
"PreviousFleetState":{
"shape":"FleetStateCode",
"locationName":"previousFleetState"
},
"FleetId":{
"shape":"FleetIdentifier",
"locationName":"fleetId"
}
}
},
"DeleteFleetSuccessSet":{
"type":"list",
"member":{
"shape":"DeleteFleetSuccessItem",
"locationName":"item"
}
},
"DeleteFleetsRequest":{
"type":"structure",
"required":[
"FleetIds",
"TerminateInstances"
],
"members":{
"DryRun":{"shape":"Boolean"},
"FleetIds":{
"shape":"FleetIdSet",
"locationName":"FleetId"
},
"TerminateInstances":{"shape":"Boolean"}
}
},
"DeleteFleetsResult":{
"type":"structure",
"members":{
"SuccessfulFleetDeletions":{
"shape":"DeleteFleetSuccessSet",
"locationName":"successfulFleetDeletionSet"
},
"UnsuccessfulFleetDeletions":{
"shape":"DeleteFleetErrorSet",
"locationName":"unsuccessfulFleetDeletionSet"
}
}
},
"DeleteFlowLogsRequest":{
"type":"structure",
"required":["FlowLogIds"],
@ -5918,6 +6106,106 @@
}
}
},
"DescribeFleetHistoryRequest":{
"type":"structure",
"required":[
"FleetId",
"StartTime"
],
"members":{
"DryRun":{"shape":"Boolean"},
"EventType":{"shape":"FleetEventType"},
"MaxResults":{"shape":"Integer"},
"NextToken":{"shape":"String"},
"FleetId":{"shape":"FleetIdentifier"},
"StartTime":{"shape":"DateTime"}
}
},
"DescribeFleetHistoryResult":{
"type":"structure",
"members":{
"HistoryRecords":{
"shape":"HistoryRecordSet",
"locationName":"historyRecordSet"
},
"LastEvaluatedTime":{
"shape":"DateTime",
"locationName":"lastEvaluatedTime"
},
"NextToken":{
"shape":"String",
"locationName":"nextToken"
},
"FleetId":{
"shape":"FleetIdentifier",
"locationName":"fleetId"
},
"StartTime":{
"shape":"DateTime",
"locationName":"startTime"
}
}
},
"DescribeFleetInstancesRequest":{
"type":"structure",
"required":["FleetId"],
"members":{
"DryRun":{"shape":"Boolean"},
"MaxResults":{"shape":"Integer"},
"NextToken":{"shape":"String"},
"FleetId":{"shape":"FleetIdentifier"},
"Filters":{
"shape":"FilterList",
"locationName":"Filter"
}
}
},
"DescribeFleetInstancesResult":{
"type":"structure",
"members":{
"ActiveInstances":{
"shape":"ActiveInstanceSet",
"locationName":"activeInstanceSet"
},
"NextToken":{
"shape":"String",
"locationName":"nextToken"
},
"FleetId":{
"shape":"FleetIdentifier",
"locationName":"fleetId"
}
}
},
"DescribeFleetsRequest":{
"type":"structure",
"members":{
"DryRun":{"shape":"Boolean"},
"MaxResults":{"shape":"Integer"},
"NextToken":{"shape":"String"},
"FleetIds":{
"shape":"FleetIdSet",
"locationName":"FleetId"
},
"Filters":{
"shape":"FilterList",
"locationName":"Filter"
}
}
},
"DescribeFleetsResult":{
"type":"structure",
"members":{
"NextToken":{
"shape":"String",
"locationName":"nextToken"
},
"Fleets":{
"shape":"FleetSet",
"locationName":"fleetSet"
}
}
},
"DescribeFlowLogsRequest":{
"type":"structure",
"members":{
@ -8806,6 +9094,193 @@
"locationName":"Filter"
}
},
"FleetActivityStatus":{
"type":"string",
"enum":[
"error",
"pending-fulfillment",
"pending-termination",
"fulfilled"
]
},
"FleetData":{
"type":"structure",
"members":{
"ActivityStatus":{
"shape":"FleetActivityStatus",
"locationName":"activityStatus"
},
"CreateTime":{
"shape":"DateTime",
"locationName":"createTime"
},
"FleetId":{
"shape":"FleetIdentifier",
"locationName":"fleetId"
},
"FleetState":{
"shape":"FleetStateCode",
"locationName":"fleetState"
},
"ClientToken":{
"shape":"String",
"locationName":"clientToken"
},
"ExcessCapacityTerminationPolicy":{
"shape":"FleetExcessCapacityTerminationPolicy",
"locationName":"excessCapacityTerminationPolicy"
},
"FulfilledCapacity":{
"shape":"Double",
"locationName":"fulfilledCapacity"
},
"FulfilledOnDemandCapacity":{
"shape":"Double",
"locationName":"fulfilledOnDemandCapacity"
},
"LaunchTemplateConfigs":{
"shape":"FleetLaunchTemplateConfigList",
"locationName":"launchTemplateConfigs"
},
"TargetCapacitySpecification":{
"shape":"TargetCapacitySpecification",
"locationName":"targetCapacitySpecification"
},
"TerminateInstancesWithExpiration":{
"shape":"Boolean",
"locationName":"terminateInstancesWithExpiration"
},
"Type":{
"shape":"FleetType",
"locationName":"type"
},
"ValidFrom":{
"shape":"DateTime",
"locationName":"validFrom"
},
"ValidUntil":{
"shape":"DateTime",
"locationName":"validUntil"
},
"ReplaceUnhealthyInstances":{
"shape":"Boolean",
"locationName":"replaceUnhealthyInstances"
},
"SpotOptions":{
"shape":"SpotOptions",
"locationName":"spotOptions"
},
"Tags":{
"shape":"TagList",
"locationName":"tagSet"
}
}
},
"FleetEventType":{
"type":"string",
"enum":[
"instance-change",
"fleet-change",
"service-error"
]
},
"FleetExcessCapacityTerminationPolicy":{
"type":"string",
"enum":[
"no-termination",
"termination"
]
},
"FleetIdSet":{
"type":"list",
"member":{"shape":"FleetIdentifier"}
},
"FleetIdentifier":{"type":"string"},
"FleetLaunchTemplateConfig":{
"type":"structure",
"members":{
"LaunchTemplateSpecification":{
"shape":"FleetLaunchTemplateSpecification",
"locationName":"launchTemplateSpecification"
},
"Overrides":{
"shape":"FleetLaunchTemplateOverridesList",
"locationName":"overrides"
}
}
},
"FleetLaunchTemplateConfigList":{
"type":"list",
"member":{
"shape":"FleetLaunchTemplateConfig",
"locationName":"item"
}
},
"FleetLaunchTemplateConfigListRequest":{
"type":"list",
"member":{
"shape":"FleetLaunchTemplateConfigRequest",
"locationName":"item"
},
"max":50
},
"FleetLaunchTemplateConfigRequest":{
"type":"structure",
"members":{
"LaunchTemplateSpecification":{"shape":"FleetLaunchTemplateSpecificationRequest"},
"Overrides":{"shape":"FleetLaunchTemplateOverridesListRequest"}
}
},
"FleetLaunchTemplateOverrides":{
"type":"structure",
"members":{
"InstanceType":{
"shape":"InstanceType",
"locationName":"instanceType"
},
"MaxPrice":{
"shape":"String",
"locationName":"maxPrice"
},
"SubnetId":{
"shape":"String",
"locationName":"subnetId"
},
"AvailabilityZone":{
"shape":"String",
"locationName":"availabilityZone"
},
"WeightedCapacity":{
"shape":"Double",
"locationName":"weightedCapacity"
}
}
},
"FleetLaunchTemplateOverridesList":{
"type":"list",
"member":{
"shape":"FleetLaunchTemplateOverrides",
"locationName":"item"
}
},
"FleetLaunchTemplateOverridesListRequest":{
"type":"list",
"member":{
"shape":"FleetLaunchTemplateOverridesRequest",
"locationName":"item"
},
"max":50
},
"FleetLaunchTemplateOverridesRequest":{
"type":"structure",
"members":{
"InstanceType":{"shape":"InstanceType"},
"MaxPrice":{"shape":"String"},
"SubnetId":{"shape":"String"},
"AvailabilityZone":{"shape":"String"},
"WeightedCapacity":{"shape":"Double"}
}
},
"FleetLaunchTemplateSpecification":{
"type":"structure",
"members":{
@ -8823,6 +9298,33 @@
}
}
},
"FleetLaunchTemplateSpecificationRequest":{
"type":"structure",
"members":{
"LaunchTemplateId":{"shape":"String"},
"LaunchTemplateName":{"shape":"LaunchTemplateName"},
"Version":{"shape":"String"}
}
},
"FleetSet":{
"type":"list",
"member":{
"shape":"FleetData",
"locationName":"item"
}
},
"FleetStateCode":{
"type":"string",
"enum":[
"submitted",
"active",
"deleted",
"failed",
"deleted-running",
"deleted-terminating",
"modifying"
]
},
"FleetType":{
"type":"string",
"enum":[
@ -9275,6 +9777,30 @@
}
}
},
"HistoryRecordEntry":{
"type":"structure",
"members":{
"EventInformation":{
"shape":"EventInformation",
"locationName":"eventInformation"
},
"EventType":{
"shape":"FleetEventType",
"locationName":"eventType"
},
"Timestamp":{
"shape":"DateTime",
"locationName":"timestamp"
}
}
},
"HistoryRecordSet":{
"type":"list",
"member":{
"shape":"HistoryRecordEntry",
"locationName":"item"
}
},
"HistoryRecords":{
"type":"list",
"member":{
@ -9320,6 +9846,14 @@
"State":{
"shape":"AllocationState",
"locationName":"state"
},
"AllocationTime":{
"shape":"DateTime",
"locationName":"allocationTime"
},
"ReleaseTime":{
"shape":"DateTime",
"locationName":"releaseTime"
}
}
},
@ -12083,6 +12617,28 @@
"max":255,
"min":5
},
"ModifyFleetRequest":{
"type":"structure",
"required":[
"FleetId",
"TargetCapacitySpecification"
],
"members":{
"DryRun":{"shape":"Boolean"},
"ExcessCapacityTerminationPolicy":{"shape":"FleetExcessCapacityTerminationPolicy"},
"FleetId":{"shape":"FleetIdentifier"},
"TargetCapacitySpecification":{"shape":"TargetCapacitySpecificationRequest"}
}
},
"ModifyFleetResult":{
"type":"structure",
"members":{
"Return":{
"shape":"Boolean",
"locationName":"return"
}
}
},
"ModifyFpgaImageAttributeRequest":{
"type":"structure",
"required":["FpgaImageId"],
@ -16401,6 +16957,13 @@
}
}
},
"SpotAllocationStrategy":{
"type":"string",
"enum":[
"lowest-price",
"diversified"
]
},
"SpotDatafeedSubscription":{
"type":"structure",
"members":{
@ -16566,6 +17129,10 @@
"shape":"Double",
"locationName":"fulfilledCapacity"
},
"OnDemandFulfilledCapacity":{
"shape":"Double",
"locationName":"onDemandFulfilledCapacity"
},
"IamFleetRole":{
"shape":"String",
"locationName":"iamFleetRole"
@ -16586,6 +17153,10 @@
"shape":"Integer",
"locationName":"targetCapacity"
},
"OnDemandTargetCapacity":{
"shape":"Integer",
"locationName":"onDemandTargetCapacity"
},
"TerminateInstancesWithExpiration":{
"shape":"Boolean",
"locationName":"terminateInstancesWithExpiration"
@ -16643,6 +17214,14 @@
"locationName":"item"
}
},
"SpotInstanceInterruptionBehavior":{
"type":"string",
"enum":[
"hibernate",
"stop",
"terminate"
]
},
"SpotInstanceRequest":{
"type":"structure",
"members":{
@ -16795,6 +17374,26 @@
"InstanceInterruptionBehavior":{"shape":"InstanceInterruptionBehavior"}
}
},
"SpotOptions":{
"type":"structure",
"members":{
"AllocationStrategy":{
"shape":"SpotAllocationStrategy",
"locationName":"allocationStrategy"
},
"InstanceInterruptionBehavior":{
"shape":"SpotInstanceInterruptionBehavior",
"locationName":"instanceInterruptionBehavior"
}
}
},
"SpotOptionsRequest":{
"type":"structure",
"members":{
"AllocationStrategy":{"shape":"SpotAllocationStrategy"},
"InstanceInterruptionBehavior":{"shape":"SpotInstanceInterruptionBehavior"}
}
},
"SpotPlacement":{
"type":"structure",
"members":{
@ -17244,6 +17843,37 @@
"locationName":"item"
}
},
"TargetCapacitySpecification":{
"type":"structure",
"members":{
"TotalTargetCapacity":{
"shape":"Integer",
"locationName":"totalTargetCapacity"
},
"OnDemandTargetCapacity":{
"shape":"Integer",
"locationName":"onDemandTargetCapacity"
},
"SpotTargetCapacity":{
"shape":"Integer",
"locationName":"spotTargetCapacity"
},
"DefaultTargetCapacityType":{
"shape":"DefaultTargetCapacityType",
"locationName":"defaultTargetCapacityType"
}
}
},
"TargetCapacitySpecificationRequest":{
"type":"structure",
"required":["TotalTargetCapacity"],
"members":{
"TotalTargetCapacity":{"shape":"Integer"},
"OnDemandTargetCapacity":{"shape":"Integer"},
"SpotTargetCapacity":{"shape":"Integer"},
"DefaultTargetCapacityType":{"shape":"DefaultTargetCapacityType"}
}
},
"TargetConfiguration":{
"type":"structure",
"members":{

402
vendor/github.com/aws/aws-sdk-go/models/apis/ec2/2016-11-15/docs-2.json generated vendored
View File

File diff suppressed because one or more lines are too long

33
vendor/github.com/aws/aws-sdk-go/models/apis/ecs/2014-11-13/api-2.json generated vendored
View File

@ -798,6 +798,7 @@
"serviceName":{"shape":"String"},
"taskDefinition":{"shape":"String"},
"loadBalancers":{"shape":"LoadBalancers"},
"serviceRegistries":{"shape":"ServiceRegistries"},
"desiredCount":{"shape":"BoxedInteger"},
"clientToken":{"shape":"String"},
"launchType":{"shape":"LaunchType"},
@ -1125,7 +1126,9 @@
"members":{
"capabilities":{"shape":"KernelCapabilities"},
"devices":{"shape":"DevicesList"},
"initProcessEnabled":{"shape":"BoxedBoolean"}
"initProcessEnabled":{"shape":"BoxedBoolean"},
"sharedMemorySize":{"shape":"BoxedInteger"},
"tmpfs":{"shape":"TmpfsList"}
}
},
"ListAttributesRequest":{
@ -1527,6 +1530,7 @@
"serviceName":{"shape":"String"},
"clusterArn":{"shape":"String"},
"loadBalancers":{"shape":"LoadBalancers"},
"serviceRegistries":{"shape":"ServiceRegistries"},
"status":{"shape":"String"},
"desiredCount":{"shape":"Integer"},
"runningCount":{"shape":"Integer"},
@ -1569,6 +1573,17 @@
},
"exception":true
},
"ServiceRegistries":{
"type":"list",
"member":{"shape":"ServiceRegistry"}
},
"ServiceRegistry":{
"type":"structure",
"members":{
"registryArn":{"shape":"String"},
"port":{"shape":"BoxedInteger"}
}
},
"Services":{
"type":"list",
"member":{"shape":"Service"}
@ -1770,6 +1785,22 @@
"member":{"shape":"Task"}
},
"Timestamp":{"type":"timestamp"},
"Tmpfs":{
"type":"structure",
"required":[
"containerPath",
"size"
],
"members":{
"containerPath":{"shape":"String"},
"size":{"shape":"Integer"},
"mountOptions":{"shape":"StringList"}
}
},
"TmpfsList":{
"type":"list",
"member":{"shape":"Tmpfs"}
},
"TransportProtocol":{
"type":"string",
"enum":[

43
vendor/github.com/aws/aws-sdk-go/models/apis/ecs/2014-11-13/docs-2.json generated vendored
View File

@ -32,7 +32,7 @@
"SubmitTaskStateChange": "<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 task changed states.</p>",
"UpdateContainerAgent": "<p>Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.</p> <p> <code>UpdateContainerAgent</code> requires the Amazon ECS-optimized AMI or Amazon Linux with the <code>ecs-init</code> service installed and running. For help updating the Amazon ECS container agent on other operating systems, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent\">Manually Updating the Amazon ECS Container Agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>",
"UpdateContainerInstancesState": "<p>Modifies the status of an Amazon ECS container instance.</p> <p>You can change the status of a container instance to <code>DRAINING</code> to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size. </p> <p>When you set a container instance to <code>DRAINING</code>, Amazon ECS prevents new tasks from being scheduled for placement on the container instance and replacement service tasks are started on other container instances in the cluster if the resources are available. Service tasks on the container instance that are in the <code>PENDING</code> state are stopped immediately.</p> <p>Service tasks on the container instance that are in the <code>RUNNING</code> state are stopped and replaced according to the service's deployment configuration parameters, <code>minimumHealthyPercent</code> and <code>maximumPercent</code>. You can change the deployment configuration of your service using <a>UpdateService</a>.</p> <ul> <li> <p>If <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore <code>desiredCount</code> temporarily during task replacement. For example, <code>desiredCount</code> is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler can't remove existing tasks until the replacement tasks are considered healthy. Tasks for services that do not use a load balancer are considered healthy if they are in the <code>RUNNING</code> state. Tasks for services that 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.</p> </li> <li> <p>The <code>maximumPercent</code> parameter represents an upper limit on the number of running tasks during task replacement, which enables you to define the replacement batch size. For example, if <code>desiredCount</code> of four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained (provided that the cluster resources required to do this are available). If the maximum is 100%, then replacement tasks can't start until the draining tasks have stopped.</p> </li> </ul> <p>Any <code>PENDING</code> or <code>RUNNING</code> tasks that do not belong to a service are not affected; you must wait for them to finish or stop them manually.</p> <p>A container instance has completed draining when it has no more <code>RUNNING</code> tasks. You can verify this using <a>ListTasks</a>.</p> <p>When you set a container instance to <code>ACTIVE</code>, the Amazon ECS scheduler can begin scheduling tasks on the instance again.</p>",
"UpdateService": "<p>Modifies the desired count, deployment configuration, network configuration, or task definition used in a service.</p> <p>You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new <code>desiredCount</code> parameter.</p> <p>You can use <a>UpdateService</a> to modify your task definition and deploy a new version of your service.</p> <p>You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, <code>minimumHealthyPercent</code> and <code>maximumPercent</code>, to determine the deployment strategy.</p> <ul> <li> <p>If <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore <code>desiredCount</code> temporarily during a deployment. For example, if <code>desiredCount</code> is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the <code>RUNNING</code> state. Tasks for services that 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.</p> </li> <li> <p>The <code>maximumPercent</code> parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if <code>desiredCount</code> is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).</p> </li> </ul> <p>When <a>UpdateService</a> stops a task during a deployment, 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 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> <p>When the service scheduler launches new tasks, it determines task placement in your cluster with 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):</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> <p>When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic: </p> <ul> <li> <p>Sort the container instances by the largest 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 two, container instances in either zone B or C are considered optimal for termination.</p> </li> <li> <p>Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service.</p> </li> </ul>"
"UpdateService": "<p>Modifies the desired count, deployment configuration, network configuration, or task definition used in a service.</p> <p>You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new <code>desiredCount</code> parameter.</p> <p>If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy.</p> <note> <p>If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, <code>my_image:latest</code>), you do not need to create a new revision of your task definition. You can update the service using the <code>forceNewDeployment</code> option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.</p> </note> <p>You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, <code>minimumHealthyPercent</code> and <code>maximumPercent</code>, to determine the deployment strategy.</p> <ul> <li> <p>If <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore <code>desiredCount</code> temporarily during a deployment. For example, if <code>desiredCount</code> is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the <code>RUNNING</code> state. Tasks for services that 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.</p> </li> <li> <p>The <code>maximumPercent</code> parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if <code>desiredCount</code> is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).</p> </li> </ul> <p>When <a>UpdateService</a> stops a task during a deployment, 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 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> <p>When the service scheduler launches new tasks, it determines task placement in your cluster with 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):</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> <p>When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic: </p> <ul> <li> <p>Sort the container instances by the largest 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 two, container instances in either zone B or C are considered optimal for termination.</p> </li> <li> <p>Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service.</p> </li> </ul>"
},
"shapes": {
"AccessDeniedException": {
@ -122,7 +122,7 @@
"base": null,
"refs": {
"ContainerInstance$agentConnected": "<p>This parameter returns <code>true</code> if the agent is connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return <code>false</code>. Instances without a connected agent can't accept placement requests.</p>",
"UpdateServiceRequest$forceNewDeployment": "<p>Whether to force a new deployment of the service. By default, <code>--no-force-new-deployment</code> is assumed unless otherwise specified.</p>"
"UpdateServiceRequest$forceNewDeployment": "<p>Whether to force a new deployment of the service. Deployments are not forced by default. You can use this option to trigger a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (<code>my_image:latest</code>) or to roll Fargate tasks onto a newer platform version.</p>"
}
},
"BoxedBoolean": {
@ -156,6 +156,7 @@
"HealthCheck$timeout": "<p>The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5 seconds.</p>",
"HealthCheck$retries": "<p>The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3 retries.</p>",
"HealthCheck$startPeriod": "<p>The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You may specify between 0 and 300 seconds. The <code>startPeriod</code> is disabled by default.</p> <note> <p>If a health check succeeds within the <code>startPeriod</code>, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.</p> </note>",
"LinuxParameters$sharedMemorySize": "<p>The value for the size of the <code>/dev/shm</code> volume. This parameter maps to the <code>--shm-size</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</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>",
"ListClustersRequest$maxResults": "<p>The maximum number of cluster results returned by <code>ListClusters</code> in paginated output. When this parameter is used, <code>ListClusters</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>ListClusters</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>ListClusters</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>",
"ListContainerInstancesRequest$maxResults": "<p>The maximum number of container instance results returned by <code>ListContainerInstances</code> in paginated output. When this parameter is used, <code>ListContainerInstances</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>ListContainerInstances</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>ListContainerInstances</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>",
@ -170,6 +171,7 @@
"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 set to 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>",
"ServiceRegistry$port": "<p>The port value used if your Service Discovery service specified an SRV record.</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$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 Elastic Load Balancing health checks, you can specify a health check grace period of up to 1,800 seconds during which the ECS service scheduler ignores the Elastic Load Balancing 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>"
@ -584,6 +586,7 @@
"Service$runningCount": "<p>The number of tasks in the cluster that are in the <code>RUNNING</code> state.</p>",
"Service$pendingCount": "<p>The number of tasks in the cluster that are in the <code>PENDING</code> state.</p>",
"TaskDefinition$revision": "<p>The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is <code>1</code>; each time you register a new revision of a task definition in the same family, the revision value always increases by one (even if you have deregistered previous revisions in this family).</p>",
"Tmpfs$size": "<p>The size of the tmpfs volume.</p>",
"Ulimit$softLimit": "<p>The soft limit for the ulimit type.</p>",
"Ulimit$hardLimit": "<p>The hard limit for the ulimit type.</p>"
}
@ -907,8 +910,8 @@
"Resources": {
"base": null,
"refs": {
"ContainerInstance$remainingResources": "<p>For most resource types, this parameter describes the remaining resources of the container instance that are available for new tasks. For port resource types, this parameter describes the ports that are reserved by the Amazon ECS container agent and any containers that have reserved port mappings; any port that is not specified here is available for new tasks.</p>",
"ContainerInstance$registeredResources": "<p>For most resource types, this parameter describes the registered resources on the container instance that are in use by current tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.</p>",
"ContainerInstance$remainingResources": "<p>For CPU and memory resource types, this parameter describes the remaining CPU and memory on the that has not already been allocated to tasks (and is therefore available for new tasks). For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the <code>host</code> or <code>bridge</code> network mode). Any port that is not specified here is available for new tasks.</p>",
"ContainerInstance$registeredResources": "<p>For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS; this value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.</p>",
"RegisterContainerInstanceRequest$totalResources": "<p>The resources available on the instance.</p>"
}
},
@ -958,6 +961,19 @@
"refs": {
}
},
"ServiceRegistries": {
"base": null,
"refs": {
"CreateServiceRequest$serviceRegistries": "<p>The details of the service discovery registries you want to assign to this service. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguideservice-discovery.html\">Service Discovery</a>.</p>",
"Service$serviceRegistries": "<p/>"
}
},
"ServiceRegistry": {
"base": "<p>Details of the service registry.</p>",
"refs": {
"ServiceRegistries$member": null
}
},
"Services": {
"base": null,
"refs": {
@ -1132,6 +1148,7 @@
"Service$roleArn": "<p>The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.</p>",
"ServiceEvent$id": "<p>The ID string of the event.</p>",
"ServiceEvent$message": "<p>The event message.</p>",
"ServiceRegistry$registryArn": "<p>The Amazon Resource Name (ARN) of the Service Registry. The currently supported service registry is Amazon Route 53 Auto Naming Service. For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_autonaming_Service.html\">Service</a>.</p>",
"StartTaskRequest$cluster": "<p>The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed.</p>",
"StartTaskRequest$taskDefinition": "<p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or full ARN of the task definition to start. If a <code>revision</code> is not specified, the latest <code>ACTIVE</code> revision is used.</p>",
"StartTaskRequest$startedBy": "<p>An optional tag specified when a task is started. For example if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the <code>startedBy</code> parameter. You can then identify which tasks belong to that job by filtering the results of a <a>ListTasks</a> call with the <code>startedBy</code> value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.</p> <p>If a 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>",
@ -1172,6 +1189,7 @@
"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>",
"Tmpfs$containerPath": "<p>The absolute file path where the tmpfs volume will be mounted.</p>",
"UpdateContainerAgentRequest$cluster": "<p>The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on. If you do not specify a cluster, the default cluster is assumed.</p>",
"UpdateContainerAgentRequest$containerInstance": "<p>The container instance ID or full ARN entries for the container instance on which you would like to update the Amazon ECS container agent.</p>",
"UpdateContainerInstancesStateRequest$cluster": "<p>The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to update. If you do not specify a cluster, the default cluster is assumed.</p>",
@ -1189,8 +1207,8 @@
"StringList": {
"base": null,
"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>",
"AwsVpcConfiguration$subnets": "<p>The subnets associated with the task or service. There is a limit of 10 subnets able to be specified per AwsVpcConfiguration.</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. There is a limit of 5 security groups able to be specified per AwsVpcConfiguration.</p>",
"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>",
@ -1213,6 +1231,7 @@
"ListTasksResponse$taskArns": "<p>The list of task ARN entries for the <code>ListTasks</code> request.</p>",
"Resource$stringSetValue": "<p>When the <code>stringSetValue</code> type is set, the value of the resource must be a string type.</p>",
"StartTaskRequest$containerInstances": "<p>The container instance IDs or full ARN entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.</p>",
"Tmpfs$mountOptions": "<p>The list of tmpfs volume mount options.</p> <p>Valid values: <code>\"defaults\" | \"ro\" | \"rw\" | \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" | \"exec\" | \"noexec\" | \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" | \"atime\" | \"noatime\" | \"diratime\" | \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" | \"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" | \"relatime\" | \"norelatime\" | \"strictatime\" | \"nostrictatime\"</code> </p>",
"UpdateContainerInstancesStateRequest$containerInstances": "<p>A list of container instance IDs or full ARN entries.</p>"
}
},
@ -1332,6 +1351,18 @@
"Task$stoppedAt": "<p>The Unix time stamp for when the task was stopped (the task transitioned from the <code>RUNNING</code> state to the <code>STOPPED</code> state).</p>"
}
},
"Tmpfs": {
"base": "<p>The container path, mount options, and size of the tmpfs mount.</p>",
"refs": {
"TmpfsList$member": null
}
},
"TmpfsList": {
"base": null,
"refs": {
"LinuxParameters$tmpfs": "<p>The container path, mount options, and size of the tmpfs mount. This parameter maps to the <code>--tmpfs</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
}
},
"TransportProtocol": {
"base": null,
"refs": {

4
vendor/github.com/aws/aws-sdk-go/models/apis/elasticbeanstalk/2010-12-01/api-2.json generated vendored
View File

@ -658,9 +658,11 @@
"Unknown"
]
},
"ApplicationArn":{"type":"string"},
"ApplicationDescription":{
"type":"structure",
"members":{
"ApplicationArn":{"shape":"ApplicationArn"},
"ApplicationName":{"shape":"ApplicationName"},
"Description":{"shape":"Description"},
"DateCreated":{"shape":"CreationDate"},
@ -718,9 +720,11 @@
"ResourceLifecycleConfig":{"shape":"ApplicationResourceLifecycleConfig"}
}
},
"ApplicationVersionArn":{"type":"string"},
"ApplicationVersionDescription":{
"type":"structure",
"members":{
"ApplicationVersionArn":{"shape":"ApplicationVersionArn"},
"ApplicationName":{"shape":"ApplicationName"},
"Description":{"shape":"Description"},
"VersionLabel":{"shape":"VersionLabel"},

36
vendor/github.com/aws/aws-sdk-go/models/apis/elasticbeanstalk/2010-12-01/docs-2.json generated vendored
View File

@ -17,7 +17,7 @@
"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>",
"DeleteEnvironmentConfiguration": "<p>Deletes the draft configuration associated with the running environment.</p> <p>Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using <a>DescribeConfigurationSettings</a> while the update is in progress or if the update fails. The <code>DeploymentStatus</code> for the draft configuration indicates whether the deployment is in process or has failed. The draft configuration remains in existence until it is deleted with this action.</p>",
"DeletePlatformVersion": "<p>Deletes the specified version of a custom platform.</p>",
"DescribeAccountAttributes": null,
"DescribeAccountAttributes": "<p>Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account.</p> <p>The result currently has one set of attributes—resource quotas.</p>",
"DescribeApplicationVersions": "<p>Retrieve a list of application versions.</p>",
"DescribeApplications": "<p>Returns the descriptions of existing applications.</p>",
"DescribeConfigurationOptions": "<p>Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.</p>",
@ -86,6 +86,12 @@
"ManagedActionHistoryItem$ActionType": "<p>The type of the managed action.</p>"
}
},
"ApplicationArn": {
"base": null,
"refs": {
"ApplicationDescription$ApplicationArn": "<p>The Amazon Resource Name (ARN) of the application.</p>"
}
},
"ApplicationDescription": {
"base": "<p>Describes the properties of an application.</p>",
"refs": {
@ -169,6 +175,12 @@
"refs": {
}
},
"ApplicationVersionArn": {
"base": null,
"refs": {
"ApplicationVersionDescription$ApplicationVersionArn": "<p>The Amazon Resource Name (ARN) of the application version.</p>"
}
},
"ApplicationVersionDescription": {
"base": "<p>Describes the properties of an application version.</p>",
"refs": {
@ -265,7 +277,7 @@
"BuildConfiguration$TimeoutInMinutes": "<p>How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed. The default is 60 minutes.</p>",
"MaxAgeRule$MaxAgeInDays": "<p>Specify the number of days to retain an application versions.</p>",
"MaxCountRule$MaxCount": "<p>Specify the maximum number of application versions to retain.</p>",
"ResourceQuota$Maximum": null
"ResourceQuota$Maximum": "<p>The maximum number of instances of this Elastic Beanstalk resource type that an AWS account can use.</p>"
}
},
"BuildConfiguration": {
@ -711,7 +723,7 @@
"EnvironmentArn": {
"base": null,
"refs": {
"EnvironmentDescription$EnvironmentArn": "<p>The environment's Amazon Resource Name (ARN), which can be used in other API reuqests that require an ARN.</p>"
"EnvironmentDescription$EnvironmentArn": "<p>The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.</p>"
}
},
"EnvironmentDescription": {
@ -1013,7 +1025,7 @@
}
},
"InsufficientPrivilegesException": {
"base": "<p>The specified account does not have sufficient privileges for one of more AWS services.</p>",
"base": "<p>The specified account does not have sufficient privileges for one or more AWS services.</p>",
"refs": {
}
},
@ -1530,19 +1542,19 @@
}
},
"ResourceQuota": {
"base": null,
"base": "<p>The AWS Elastic Beanstalk quota information for a single resource type in an AWS account. It reflects the resource's limits for this account.</p>",
"refs": {
"ResourceQuotas$ApplicationQuota": null,
"ResourceQuotas$ApplicationVersionQuota": null,
"ResourceQuotas$EnvironmentQuota": null,
"ResourceQuotas$ConfigurationTemplateQuota": null,
"ResourceQuotas$CustomPlatformQuota": null
"ResourceQuotas$ApplicationQuota": "<p>The quota for applications in the AWS account.</p>",
"ResourceQuotas$ApplicationVersionQuota": "<p>The quota for application versions in the AWS account.</p>",
"ResourceQuotas$EnvironmentQuota": "<p>The quota for environments in the AWS account.</p>",
"ResourceQuotas$ConfigurationTemplateQuota": "<p>The quota for configuration templates in the AWS account.</p>",
"ResourceQuotas$CustomPlatformQuota": "<p>The quota for custom platforms in the AWS account.</p>"
}
},
"ResourceQuotas": {
"base": null,
"base": "<p>A set of per-resource AWS Elastic Beanstalk quotas associated with an AWS account. They reflect Elastic Beanstalk resource limits for this account.</p>",
"refs": {
"DescribeAccountAttributesResult$ResourceQuotas": null
"DescribeAccountAttributesResult$ResourceQuotas": "<p>The Elastic Beanstalk resource quotas associated with the calling AWS account.</p>"
}
},
"ResourceTagsDescriptionMessage": {

42
vendor/github.com/aws/aws-sdk-go/models/apis/es/2015-01-01/api-2.json generated vendored
View File

@ -5,6 +5,7 @@
"endpointPrefix":"es",
"protocol":"rest-json",
"serviceFullName":"Amazon Elasticsearch Service",
"serviceId":"Elasticsearch Service",
"signatureVersion":"v4",
"uid":"es-2015-01-01"
},
@ -277,6 +278,26 @@
},
"Boolean":{"type":"boolean"},
"CloudWatchLogsLogGroupArn":{"type":"string"},
"CognitoOptions":{
"type":"structure",
"members":{
"Enabled":{"shape":"Boolean"},
"UserPoolId":{"shape":"UserPoolId"},
"IdentityPoolId":{"shape":"IdentityPoolId"},
"RoleArn":{"shape":"RoleArn"}
}
},
"CognitoOptionsStatus":{
"type":"structure",
"required":[
"Options",
"Status"
],
"members":{
"Options":{"shape":"CognitoOptions"},
"Status":{"shape":"OptionStatus"}
}
},
"CreateElasticsearchDomainRequest":{
"type":"structure",
"required":["DomainName"],
@ -288,6 +309,7 @@
"AccessPolicies":{"shape":"PolicyDocument"},
"SnapshotOptions":{"shape":"SnapshotOptions"},
"VPCOptions":{"shape":"VPCOptions"},
"CognitoOptions":{"shape":"CognitoOptions"},
"EncryptionAtRestOptions":{"shape":"EncryptionAtRestOptions"},
"AdvancedOptions":{"shape":"AdvancedOptions"},
"LogPublishingOptions":{"shape":"LogPublishingOptions"}
@ -524,6 +546,7 @@
"AccessPolicies":{"shape":"AccessPoliciesStatus"},
"SnapshotOptions":{"shape":"SnapshotOptionsStatus"},
"VPCOptions":{"shape":"VPCDerivedInfoStatus"},
"CognitoOptions":{"shape":"CognitoOptionsStatus"},
"EncryptionAtRestOptions":{"shape":"EncryptionAtRestOptionsStatus"},
"AdvancedOptions":{"shape":"AdvancedOptionsStatus"},
"LogPublishingOptions":{"shape":"LogPublishingOptionsStatus"}
@ -552,6 +575,7 @@
"AccessPolicies":{"shape":"PolicyDocument"},
"SnapshotOptions":{"shape":"SnapshotOptions"},
"VPCOptions":{"shape":"VPCDerivedInfo"},
"CognitoOptions":{"shape":"CognitoOptions"},
"EncryptionAtRestOptions":{"shape":"EncryptionAtRestOptions"},
"AdvancedOptions":{"shape":"AdvancedOptions"},
"LogPublishingOptions":{"shape":"LogPublishingOptions"}
@ -605,6 +629,12 @@
"value":{"shape":"ServiceUrl"}
},
"ErrorMessage":{"type":"string"},
"IdentityPoolId":{
"type":"string",
"max":55,
"min":1,
"pattern":"[\\w-]+:[0-9a-f-]+"
},
"InstanceCountLimits":{
"type":"structure",
"members":{
@ -825,6 +855,11 @@
"error":{"httpStatusCode":409},
"exception":true
},
"RoleArn":{
"type":"string",
"max":2048,
"min":20
},
"ServiceUrl":{"type":"string"},
"SnapshotOptions":{
"type":"structure",
@ -915,6 +950,7 @@
"EBSOptions":{"shape":"EBSOptions"},
"SnapshotOptions":{"shape":"SnapshotOptions"},
"VPCOptions":{"shape":"VPCOptions"},
"CognitoOptions":{"shape":"CognitoOptions"},
"AdvancedOptions":{"shape":"AdvancedOptions"},
"AccessPolicies":{"shape":"PolicyDocument"},
"LogPublishingOptions":{"shape":"LogPublishingOptions"}
@ -928,6 +964,12 @@
}
},
"UpdateTimestamp":{"type":"timestamp"},
"UserPoolId":{
"type":"string",
"max":55,
"min":1,
"pattern":"[\\w-]+_[0-9a-zA-Z]+"
},
"VPCDerivedInfo":{
"type":"structure",
"members":{

35
vendor/github.com/aws/aws-sdk-go/models/apis/es/2015-01-01/docs-2.json generated vendored
View File

@ -73,6 +73,7 @@
"Boolean": {
"base": null,
"refs": {
"CognitoOptions$Enabled": "<p>Specifies the option to enable Cognito for Kibana authentication.</p>",
"EBSOptions$EBSEnabled": "<p>Specifies whether EBS-based storage is enabled.</p>",
"ElasticsearchClusterConfig$DedicatedMasterEnabled": "<p>A boolean value to indicate whether a dedicated master node is enabled. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-dedicatedmasternodes\" target=\"_blank\">About Dedicated Master Nodes</a> for more information.</p>",
"ElasticsearchClusterConfig$ZoneAwarenessEnabled": "<p>A boolean value to indicate whether zone awareness is enabled. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-zoneawareness\" target=\"_blank\">About Zone Awareness</a> for more information.</p>",
@ -90,6 +91,21 @@
"LogPublishingOption$CloudWatchLogsLogGroupArn": null
}
},
"CognitoOptions": {
"base": "<p>Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html\" target=\"_blank\">Amazon Cognito Authentication for Kibana</a>.</p>",
"refs": {
"CognitoOptionsStatus$Options": "<p>Specifies the Cognito options for the specified Elasticsearch domain.</p>",
"CreateElasticsearchDomainRequest$CognitoOptions": "<p>Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html\" target=\"_blank\">Amazon Cognito Authentication for Kibana</a>.</p>",
"ElasticsearchDomainStatus$CognitoOptions": "<p>The <code>CognitoOptions</code> for the specified domain. For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html\" target=\"_blank\">Amazon Cognito Authentication for Kibana</a>.</p>",
"UpdateElasticsearchDomainConfigRequest$CognitoOptions": "<p>Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html\" target=\"_blank\">Amazon Cognito Authentication for Kibana</a>.</p>"
}
},
"CognitoOptionsStatus": {
"base": "<p>Status of the Cognito options for the specified Elasticsearch domain.</p>",
"refs": {
"ElasticsearchDomainConfig$CognitoOptions": "<p>The <code>CognitoOptions</code> for the specified domain. For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-cognito-auth.html\" target=\"_blank\">Amazon Cognito Authentication for Kibana</a>.</p>"
}
},
"CreateElasticsearchDomainRequest": {
"base": null,
"refs": {
@ -310,6 +326,12 @@
"BaseException$message": "<p>A description of the error.</p>"
}
},
"IdentityPoolId": {
"base": null,
"refs": {
"CognitoOptions$IdentityPoolId": "<p>Specifies the Cognito identity pool ID for Kibana authentication.</p>"
}
},
"InstanceCountLimits": {
"base": "<p> InstanceCountLimits represents the limits on number of instances that be created in Amazon Elasticsearch for given InstanceType. </p>",
"refs": {
@ -492,6 +514,7 @@
"refs": {
"AccessPoliciesStatus$Status": "<p>The status of the access policy for the Elasticsearch domain. See <code>OptionStatus</code> for the status information that's included. </p>",
"AdvancedOptionsStatus$Status": "<p> Specifies the status of <code>OptionStatus</code> for advanced options for the specified Elasticsearch domain.</p>",
"CognitoOptionsStatus$Status": "<p>Specifies the status of the Cognito options for the specified Elasticsearch domain.</p>",
"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>",
@ -525,6 +548,12 @@
"refs": {
}
},
"RoleArn": {
"base": null,
"refs": {
"CognitoOptions$RoleArn": "<p>Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.</p>"
}
},
"ServiceUrl": {
"base": "<p>The endpoint to which service requests are submitted. For example, <code>search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com</code> or <code>doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com</code>.</p>",
"refs": {
@ -652,6 +681,12 @@
"OptionStatus$UpdateDate": "<p>Timestamp which tells the last updated time for the entity.</p>"
}
},
"UserPoolId": {
"base": null,
"refs": {
"CognitoOptions$UserPoolId": "<p>Specifies the Cognito user pool ID for Kibana authentication.</p>"
}
},
"VPCDerivedInfo": {
"base": "<p>Options to specify the subnets and security groups for VPC endpoint. For more information, see <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-vpc.html\" target=\"_blank\"> VPC Endpoints for Amazon Elasticsearch Service Domains</a>.</p>",
"refs": {

18
vendor/github.com/aws/aws-sdk-go/models/apis/es/2015-01-01/smoke.json generated vendored Normal file
View File

@ -0,0 +1,18 @@
{
"version": 1,
"defaultRegion": "us-west-2",
"testCases": [
{
"operationName": "ListDomainNames",
"input": {},
"errorExpectedFromService": false
},
{
"operationName": "DescribeElasticsearchDomain",
"input": {
"DomainName": "not-a-domain"
},
"errorExpectedFromService": true
}
]
}

10
vendor/github.com/aws/aws-sdk-go/models/apis/events/2015-10-07/api-2.json generated vendored
View File

@ -422,6 +422,7 @@
"NextToken":{"shape":"NextToken"}
}
},
"MessageGroupId":{"type":"string"},
"NextToken":{
"type":"string",
"max":2048,
@ -677,6 +678,12 @@
"type":"string",
"max":256
},
"SqsParameters":{
"type":"structure",
"members":{
"MessageGroupId":{"shape":"MessageGroupId"}
}
},
"StatementId":{
"type":"string",
"max":64,
@ -700,7 +707,8 @@
"KinesisParameters":{"shape":"KinesisParameters"},
"RunCommandParameters":{"shape":"RunCommandParameters"},
"EcsParameters":{"shape":"EcsParameters"},
"BatchParameters":{"shape":"BatchParameters"}
"BatchParameters":{"shape":"BatchParameters"},
"SqsParameters":{"shape":"SqsParameters"}
}
},
"TargetArn":{

14
vendor/github.com/aws/aws-sdk-go/models/apis/events/2015-10-07/docs-2.json generated vendored
View File

@ -13,7 +13,7 @@
"PutEvents": "<p>Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.</p>",
"PutPermission": "<p>Running <code>PutPermission</code> permits the specified AWS account to put events to your account's default <i>event bus</i>. CloudWatch Events rules in your account are triggered by these events arriving to your default event bus. </p> <p>For another account to send events to your account, that external account must have a CloudWatch Events rule with your account's default event bus as a target.</p> <p>To enable multiple AWS accounts to put events to your default event bus, run <code>PutPermission</code> once for each of these accounts.</p> <p>The permission policy on the default event bus cannot exceed 10KB in size.</p>",
"PutRule": "<p>Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using <a>DisableRule</a>.</p> <p>If you are updating an existing rule, the rule is completely replaced with what you specify in this <code>PutRule</code> command. If you omit arguments in <code>PutRule</code>, the old values for those arguments are not kept. Instead, they are replaced with null values.</p> <p>When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Please allow a short period of time for changes to take effect.</p> <p>A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule.</p> <p>Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, CloudWatch Events uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.</p>",
"PutTargets": "<p>Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.</p> <p>Targets are the resources that are invoked when a rule is triggered.</p> <p>You can configure the following as targets for CloudWatch Events:</p> <ul> <li> <p>EC2 instances</p> </li> <li> <p>AWS Lambda functions</p> </li> <li> <p>Streams in Amazon Kinesis Streams</p> </li> <li> <p>Delivery streams in Amazon Kinesis Firehose</p> </li> <li> <p>Amazon ECS tasks</p> </li> <li> <p>AWS Step Functions state machines</p> </li> <li> <p>AWS Batch jobs</p> </li> <li> <p>Pipelines in Amazon Code Pipeline</p> </li> <li> <p>Amazon Inspector assessment templates</p> </li> <li> <p>Amazon SNS topics</p> </li> <li> <p>Amazon SQS queues</p> </li> <li> <p>The default event bus of another AWS account</p> </li> </ul> <p>Note that creating rules with built-in targets is supported only in the AWS Management Console.</p> <p>For some target types, <code>PutTargets</code> provides target-specific parameters. If the target is an Amazon Kinesis stream, you can optionally specify which shard the event goes to by using the <code>KinesisParameters</code> argument. To invoke a command on multiple EC2 instances with one rule, you can use the <code>RunCommandParameters</code> field.</p> <p>To be able to make API calls against the resources that you own, Amazon CloudWatch Events needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, CloudWatch Events relies on resource-based policies. For EC2 instances, Amazon Kinesis streams, and AWS Step Functions state machines, CloudWatch Events relies on IAM roles that you specify in the <code>RoleARN</code> argument in <code>PutTargets</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/events/auth-and-access-control-cwe.html\">Authentication and Access Control</a> in the <i>Amazon CloudWatch Events User Guide</i>.</p> <p>If another AWS account is in the same region and has granted you permission (using <code>PutPermission</code>), you can send events to that account by setting that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the <code>Arn</code> when you run <code>PutTargets</code>. If your account sends events to another account, your account is charged for each sent event. Each event sent to antoher account is charged as a custom event. The account receiving the event is not charged. For more information on pricing, see <a href=\"https://aws.amazon.com/cloudwatch/pricing/\">Amazon CloudWatch Pricing</a>.</p> <p>For more information about enabling cross-account events, see <a>PutPermission</a>.</p> <p> <b>Input</b>, <b>InputPath</b> and <b>InputTransformer</b> are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:</p> <ul> <li> <p>If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON form (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).</p> </li> <li> <p>If <b>Input</b> is specified in the form of valid JSON, then the matched event is overridden with this constant.</p> </li> <li> <p>If <b>InputPath</b> is specified in the form of JSONPath (for example, <code>$.detail</code>), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).</p> </li> <li> <p>If <b>InputTransformer</b> is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.</p> </li> </ul> <p>When you specify <code>InputPath</code> or <code>InputTransformer</code>, you must use JSON dot notation, not bracket notation.</p> <p>When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Please allow a short period of time for changes to take effect.</p> <p>This action can partially fail if too many requests are made at the same time. If that happens, <code>FailedEntryCount</code> is non-zero in the response and each entry in <code>FailedEntries</code> provides the ID of the failed target and the error code.</p>",
"PutTargets": "<p>Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.</p> <p>Targets are the resources that are invoked when a rule is triggered.</p> <p>You can configure the following as targets for CloudWatch Events:</p> <ul> <li> <p>EC2 instances</p> </li> <li> <p>AWS Lambda functions</p> </li> <li> <p>Streams in Amazon Kinesis Streams</p> </li> <li> <p>Delivery streams in Amazon Kinesis Firehose</p> </li> <li> <p>Amazon ECS tasks</p> </li> <li> <p>AWS Step Functions state machines</p> </li> <li> <p>AWS Batch jobs</p> </li> <li> <p>Pipelines in Amazon Code Pipeline</p> </li> <li> <p>Amazon Inspector assessment templates</p> </li> <li> <p>Amazon SNS topics</p> </li> <li> <p>Amazon SQS queues, including FIFO queues</p> </li> <li> <p>The default event bus of another AWS account</p> </li> </ul> <p>Note that creating rules with built-in targets is supported only in the AWS Management Console.</p> <p>For some target types, <code>PutTargets</code> provides target-specific parameters. If the target is an Amazon Kinesis stream, you can optionally specify which shard the event goes to by using the <code>KinesisParameters</code> argument. To invoke a command on multiple EC2 instances with one rule, you can use the <code>RunCommandParameters</code> field.</p> <p>To be able to make API calls against the resources that you own, Amazon CloudWatch Events needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, CloudWatch Events relies on resource-based policies. For EC2 instances, Amazon Kinesis streams, and AWS Step Functions state machines, CloudWatch Events relies on IAM roles that you specify in the <code>RoleARN</code> argument in <code>PutTargets</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/events/auth-and-access-control-cwe.html\">Authentication and Access Control</a> in the <i>Amazon CloudWatch Events User Guide</i>.</p> <p>If another AWS account is in the same region and has granted you permission (using <code>PutPermission</code>), you can send events to that account by setting that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the <code>Arn</code> when you run <code>PutTargets</code>. If your account sends events to another account, your account is charged for each sent event. Each event sent to antoher account is charged as a custom event. The account receiving the event is not charged. For more information on pricing, see <a href=\"https://aws.amazon.com/cloudwatch/pricing/\">Amazon CloudWatch Pricing</a>.</p> <p>For more information about enabling cross-account events, see <a>PutPermission</a>.</p> <p> <b>Input</b>, <b>InputPath</b> and <b>InputTransformer</b> are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:</p> <ul> <li> <p>If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON form (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).</p> </li> <li> <p>If <b>Input</b> is specified in the form of valid JSON, then the matched event is overridden with this constant.</p> </li> <li> <p>If <b>InputPath</b> is specified in the form of JSONPath (for example, <code>$.detail</code>), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).</p> </li> <li> <p>If <b>InputTransformer</b> is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.</p> </li> </ul> <p>When you specify <code>InputPath</code> or <code>InputTransformer</code>, you must use JSON dot notation, not bracket notation.</p> <p>When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Please allow a short period of time for changes to take effect.</p> <p>This action can partially fail if too many requests are made at the same time. If that happens, <code>FailedEntryCount</code> is non-zero in the response and each entry in <code>FailedEntries</code> provides the ID of the failed target and the error code.</p>",
"RemovePermission": "<p>Revokes the permission of another AWS account to be able to put events to your default event bus. Specify the account to revoke by the <code>StatementId</code> value that you associated with the account when you granted it permission with <code>PutPermission</code>. You can find the <code>StatementId</code> by using <a>DescribeEventBus</a>.</p>",
"RemoveTargets": "<p>Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked.</p> <p>When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. Please allow a short period of time for changes to take effect.</p> <p>This action can partially fail if too many requests are made at the same time. If that happens, <code>FailedEntryCount</code> is non-zero in the response and each entry in <code>FailedEntries</code> provides the ID of the failed target and the error code.</p>",
"TestEventPattern": "<p>Tests whether the specified event pattern matches the provided event.</p> <p>Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, CloudWatch Events uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.</p>"
@ -237,6 +237,12 @@
"refs": {
}
},
"MessageGroupId": {
"base": null,
"refs": {
"SqsParameters$MessageGroupId": "<p>The FIFO message group ID to use as the target.</p>"
}
},
"NextToken": {
"base": null,
"refs": {
@ -474,6 +480,12 @@
"Rule$ScheduleExpression": "<p>The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5 minutes)\".</p>"
}
},
"SqsParameters": {
"base": "<p>This structure includes the custom parameter to be used when the target is an SQS FIFO queue.</p>",
"refs": {
"Target$SqsParameters": "<p>Contains the message group ID to use when the target is a FIFO queue.</p>"
}
},
"StatementId": {
"base": null,
"refs": {

137
vendor/github.com/aws/aws-sdk-go/models/apis/firehose/2015-08-04/api-2.json generated vendored
View File

@ -61,6 +61,20 @@
"input":{"shape":"ListDeliveryStreamsInput"},
"output":{"shape":"ListDeliveryStreamsOutput"}
},
"ListTagsForDeliveryStream":{
"name":"ListTagsForDeliveryStream",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTagsForDeliveryStreamInput"},
"output":{"shape":"ListTagsForDeliveryStreamOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArgumentException"},
{"shape":"LimitExceededException"}
]
},
"PutRecord":{
"name":"PutRecord",
"http":{
@ -89,6 +103,36 @@
{"shape":"ServiceUnavailableException"}
]
},
"TagDeliveryStream":{
"name":"TagDeliveryStream",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"TagDeliveryStreamInput"},
"output":{"shape":"TagDeliveryStreamOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"},
{"shape":"InvalidArgumentException"},
{"shape":"LimitExceededException"}
]
},
"UntagDeliveryStream":{
"name":"UntagDeliveryStream",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UntagDeliveryStreamInput"},
"output":{"shape":"UntagDeliveryStreamOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"},
{"shape":"InvalidArgumentException"},
{"shape":"LimitExceededException"}
]
},
"UpdateDestination":{
"name":"UpdateDestination",
"http":{
@ -583,6 +627,37 @@
"HasMoreDeliveryStreams":{"shape":"BooleanObject"}
}
},
"ListTagsForDeliveryStreamInput":{
"type":"structure",
"required":["DeliveryStreamName"],
"members":{
"DeliveryStreamName":{"shape":"DeliveryStreamName"},
"ExclusiveStartTagKey":{"shape":"TagKey"},
"Limit":{"shape":"ListTagsForDeliveryStreamInputLimit"}
}
},
"ListTagsForDeliveryStreamInputLimit":{
"type":"integer",
"max":50,
"min":1
},
"ListTagsForDeliveryStreamOutput":{
"type":"structure",
"required":[
"Tags",
"HasMoreTags"
],
"members":{
"Tags":{"shape":"ListTagsForDeliveryStreamOutputTagList"},
"HasMoreTags":{"shape":"BooleanObject"}
}
},
"ListTagsForDeliveryStreamOutputTagList":{
"type":"list",
"member":{"shape":"Tag"},
"max":50,
"min":0
},
"LogGroupName":{"type":"string"},
"LogStreamName":{"type":"string"},
"NoEncryptionConfig":{
@ -962,7 +1037,69 @@
"AllEvents"
]
},
"Tag":{
"type":"structure",
"required":["Key"],
"members":{
"Key":{"shape":"TagKey"},
"Value":{"shape":"TagValue"}
}
},
"TagDeliveryStreamInput":{
"type":"structure",
"required":[
"DeliveryStreamName",
"Tags"
],
"members":{
"DeliveryStreamName":{"shape":"DeliveryStreamName"},
"Tags":{"shape":"TagDeliveryStreamInputTagList"}
}
},
"TagDeliveryStreamInputTagList":{
"type":"list",
"member":{"shape":"Tag"},
"max":50,
"min":1
},
"TagDeliveryStreamOutput":{
"type":"structure",
"members":{
}
},
"TagKey":{
"type":"string",
"max":128,
"min":1
},
"TagKeyList":{
"type":"list",
"member":{"shape":"TagKey"},
"max":50,
"min":1
},
"TagValue":{
"type":"string",
"max":256,
"min":0
},
"Timestamp":{"type":"timestamp"},
"UntagDeliveryStreamInput":{
"type":"structure",
"required":[
"DeliveryStreamName",
"TagKeys"
],
"members":{
"DeliveryStreamName":{"shape":"DeliveryStreamName"},
"TagKeys":{"shape":"TagKeyList"}
}
},
"UntagDeliveryStreamOutput":{
"type":"structure",
"members":{
}
},
"UpdateDestinationInput":{
"type":"structure",
"required":[

254
vendor/github.com/aws/aws-sdk-go/models/apis/firehose/2015-08-04/docs-2.json generated vendored
View File

@ -1,20 +1,23 @@
{
"version": "2.0",
"service": "<fullname>Amazon Kinesis Firehose API Reference</fullname> <p>Amazon Kinesis Firehose is a fully managed service that delivers real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon Elasticsearch Service (Amazon ES), and Amazon Redshift.</p>",
"service": "<fullname>Amazon Kinesis Data Firehose API Reference</fullname> <p>Amazon Kinesis Data Firehose is a fully managed service that delivers real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon Elasticsearch Service (Amazon ES), Amazon Redshift, and Splunk.</p>",
"operations": {
"CreateDeliveryStream": "<p>Creates a delivery stream.</p> <p>By default, you can create up to 20 delivery streams per region.</p> <p>This is an asynchronous operation that immediately returns. The initial status of the delivery stream is <code>CREATING</code>. After the delivery stream is created, its status is <code>ACTIVE</code> and it now accepts data. Attempts to send data to a delivery stream that is not in the <code>ACTIVE</code> state cause an exception. To check the state of a delivery stream, use <a>DescribeDeliveryStream</a>.</p> <p>A Kinesis Firehose delivery stream can be configured to receive records directly from providers using <a>PutRecord</a> or <a>PutRecordBatch</a>, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis stream as input, set the <code>DeliveryStreamType</code> parameter to <code>KinesisStreamAsSource</code>, and provide the Kinesis stream ARN and role ARN in the <code>KinesisStreamSourceConfiguration</code> parameter.</p> <p>A delivery stream is configured with a single destination: Amazon S3, Amazon ES, or Amazon Redshift. You must specify only one of the following destination configuration parameters: <b>ExtendedS3DestinationConfiguration</b>, <b>S3DestinationConfiguration</b>, <b>ElasticsearchDestinationConfiguration</b>, or <b>RedshiftDestinationConfiguration</b>.</p> <p>When you specify <b>S3DestinationConfiguration</b>, you can also provide the following optional values: <b>BufferingHints</b>, <b>EncryptionConfiguration</b>, and <b>CompressionFormat</b>. By default, if no <b>BufferingHints</b> value is provided, Kinesis Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. Note that <b>BufferingHints</b> is a hint, so there are some cases where the service cannot adhere to these conditions strictly; for example, record boundaries are such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3.</p> <p>A few notes about Amazon Redshift as a destination:</p> <ul> <li> <p>An Amazon Redshift destination requires an S3 bucket as intermediate location, as Kinesis Firehose first delivers data to S3 and then uses <code>COPY</code> syntax to load data into an Amazon Redshift table. This is specified in the <b>RedshiftDestinationConfiguration.S3Configuration</b> parameter.</p> </li> <li> <p>The compression formats <code>SNAPPY</code> or <code>ZIP</code> cannot be specified in <b>RedshiftDestinationConfiguration.S3Configuration</b> because the Amazon Redshift <code>COPY</code> operation that reads from the S3 bucket doesn't support these compression formats.</p> </li> <li> <p>We strongly recommend that you use the user name and password you provide exclusively with Kinesis Firehose, and that the permissions for the account are restricted for Amazon Redshift <code>INSERT</code> permissions.</p> </li> </ul> <p>Kinesis Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Kinesis Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3\">Amazon S3 Bucket Access</a> in the <i>Amazon Kinesis Firehose Developer Guide</i>.</p>",
"CreateDeliveryStream": "<p>Creates a delivery stream.</p> <p>By default, you can create up to 50 delivery streams per AWS Region.</p> <p>This is an asynchronous operation that immediately returns. The initial status of the delivery stream is <code>CREATING</code>. After the delivery stream is created, its status is <code>ACTIVE</code> and it now accepts data. Attempts to send data to a delivery stream that is not in the <code>ACTIVE</code> state cause an exception. To check the state of a delivery stream, use <a>DescribeDeliveryStream</a>.</p> <p>A Kinesis Data Firehose delivery stream can be configured to receive records directly from providers using <a>PutRecord</a> or <a>PutRecordBatch</a>, or it can be configured to use an existing Kinesis data stream as its source. To specify a Kinesis data stream as input, set the <code>DeliveryStreamType</code> parameter to <code>KinesisStreamAsSource</code>, and provide the Kinesis data stream Amazon Resource Name (ARN) and role ARN in the <code>KinesisStreamSourceConfiguration</code> parameter.</p> <p>A delivery stream is configured with a single destination: Amazon S3, Amazon ES, Amazon Redshift, or Splunk. Specify only one of the following destination configuration parameters: <code>ExtendedS3DestinationConfiguration</code>, <code>S3DestinationConfiguration</code>, <code>ElasticsearchDestinationConfiguration</code>, <code>RedshiftDestinationConfiguration</code>, or <code>SplunkDestinationConfiguration</code>.</p> <p>When you specify <code>S3DestinationConfiguration</code>, you can also provide the following optional values: <code>BufferingHints</code>, <code>EncryptionConfiguration</code>, and <code>CompressionFormat</code>. By default, if no <code>BufferingHints</code> value is provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. <code>BufferingHints</code> is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries are such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3.</p> <p>A few notes about Amazon Redshift as a destination:</p> <ul> <li> <p>An Amazon Redshift destination requires an S3 bucket as intermediate location. This is because Kinesis Data Firehose first delivers data to Amazon S3 and then uses <code>COPY</code> syntax to load data into an Amazon Redshift table. This is specified in the <code>RedshiftDestinationConfiguration.S3Configuration</code> parameter.</p> </li> <li> <p>The compression formats <code>SNAPPY</code> or <code>ZIP</code> cannot be specified in <code>RedshiftDestinationConfiguration.S3Configuration</code> because the Amazon Redshift <code>COPY</code> operation that reads from the S3 bucket doesn't support these compression formats.</p> </li> <li> <p>We strongly recommend that you use the user name and password that you provide exclusively with Kinesis Data Firehose. In addition, the permissions for the account should be restricted for Amazon Redshift <code>INSERT</code> permissions.</p> </li> </ul> <p>Kinesis Data Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Kinesis Data Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3\">Grant Kinesis Firehose Access to an Amazon S3 Destination</a> in the <i>Amazon Kinesis Data Firehose Developer Guide</i>.</p>",
"DeleteDeliveryStream": "<p>Deletes a delivery stream and its data.</p> <p>You can delete a delivery stream only if it is in <code>ACTIVE</code> or <code>DELETING</code> state, and not in the <code>CREATING</code> state. While the deletion request is in process, the delivery stream is in the <code>DELETING</code> state.</p> <p>To check the state of a delivery stream, use <a>DescribeDeliveryStream</a>.</p> <p>While the delivery stream is <code>DELETING</code> state, the service may continue to accept the records, but the service doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, you should first stop any applications that are sending records before deleting a delivery stream.</p>",
"DescribeDeliveryStream": "<p>Describes the specified delivery stream and gets the status. For example, after your delivery stream is created, call <a>DescribeDeliveryStream</a> to see if the delivery stream is <code>ACTIVE</code> and therefore ready for data to be sent to it.</p>",
"ListDeliveryStreams": "<p>Lists your delivery streams.</p> <p>The number of delivery streams might be too large to return using a single call to <a>ListDeliveryStreams</a>. You can limit the number of delivery streams returned, using the <b>Limit</b> parameter. To determine whether there are more delivery streams to list, check the value of <b>HasMoreDeliveryStreams</b> in the output. If there are more delivery streams to list, you can request them by specifying the name of the last delivery stream returned in the call in the <b>ExclusiveStartDeliveryStreamName</b> parameter of a subsequent call.</p>",
"PutRecord": "<p>Writes a single data record into an Amazon Kinesis Firehose delivery stream. To write multiple data records into a delivery stream, use <a>PutRecordBatch</a>. Applications using these operations are referred to as producers.</p> <p>By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. Note that if you use <a>PutRecord</a> and <a>PutRecordBatch</a>, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/limits.html\">Amazon Kinesis Firehose Limits</a>. </p> <p>You must specify the name of the delivery stream and the data record when using <a>PutRecord</a>. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data, for example, a segment from a log file, geographic location data, website clickstream data, and so on.</p> <p>Kinesis Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (<code>\\n</code>) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination.</p> <p>The <a>PutRecord</a> operation returns a <b>RecordId</b>, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation.</p> <p>If the <a>PutRecord</a> operation throws a <b>ServiceUnavailableException</b>, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. </p> <p>Data records sent to Kinesis Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.</p>",
"PutRecordBatch": "<p>Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a delivery stream, use <a>PutRecord</a>. Applications using these operations are referred to as producers.</p> <p>By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. If you use <a>PutRecord</a> and <a>PutRecordBatch</a>, the limits are an aggregate across these two operations for each delivery stream. For more information about limits, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/limits.html\">Amazon Kinesis Firehose Limits</a>.</p> <p>Each <a>PutRecordBatch</a> request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before 64-bit encoding), up to a limit of 4 MB for the entire request. These limits cannot be changed.</p> <p>You must specify the name of the delivery stream and the data record when using <a>PutRecord</a>. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data. For example, it could be a segment from a log file, geographic location data, web site clickstream data, and so on.</p> <p>Kinesis Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (<code>\\n</code>) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination.</p> <p>The <a>PutRecordBatch</a> response includes a count of failed records, <b>FailedPutCount</b>, and an array of responses, <b>RequestResponses</b>. Each entry in the <b>RequestResponses</b> array provides additional information about the processed record. It directly correlates with a record in the request array using the same ordering, from the top to the bottom. The response array always includes the same number of records as the request array. <b>RequestResponses</b> includes both successfully and unsuccessfully processed records. Kinesis Firehose attempts to process all records in each <a>PutRecordBatch</a> request. A single record failure does not stop the processing of subsequent records.</p> <p>A successfully processed record includes a <b>RecordId</b> value, which is unique for the record. An unsuccessfully processed record includes <b>ErrorCode</b> and <b>ErrorMessage</b> values. <b>ErrorCode</b> reflects the type of error, and is one of the following values: <code>ServiceUnavailable</code> or <code>InternalFailure</code>. <b>ErrorMessage</b> provides more detailed information about the error.</p> <p>If there is an internal server error or a timeout, the write might have completed or it might have failed. If <b>FailedPutCount</b> is greater than 0, retry the request, resending only those records that might have failed processing. This minimizes the possible duplicate records and also reduces the total bytes sent (and corresponding charges). We recommend that you handle any duplicates at the destination.</p> <p>If <a>PutRecordBatch</a> throws <b>ServiceUnavailableException</b>, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.</p> <p>Data records sent to Kinesis Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.</p>",
"UpdateDestination": "<p>Updates the specified destination of the specified delivery stream.</p> <p>You can use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are usually effective within a few minutes.</p> <p>Note that switching between Amazon ES and other services is not supported. For an Amazon ES destination, you can only update to another Amazon ES destination.</p> <p>If the destination type is the same, Kinesis Firehose merges the configuration parameters specified with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the call, the existing values are retained. For example, in the Amazon S3 destination, if <a>EncryptionConfiguration</a> is not specified, then the existing <a>EncryptionConfiguration</a> is maintained on the destination.</p> <p>If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Kinesis Firehose does not merge any parameters. In this case, all parameters must be specified.</p> <p>Kinesis Firehose uses <b>CurrentDeliveryStreamVersionId</b> to avoid race conditions and conflicting merges. This is a required field, and the service updates the configuration only if the existing configuration has a version ID that matches. After the update is applied successfully, the version ID is updated, and can be retrieved using <a>DescribeDeliveryStream</a>. Use the new version ID to set <b>CurrentDeliveryStreamVersionId</b> in the next call.</p>"
"DescribeDeliveryStream": "<p>Describes the specified delivery stream and gets the status. For example, after your delivery stream is created, call <code>DescribeDeliveryStream</code> to see whether the delivery stream is <code>ACTIVE</code> and therefore ready for data to be sent to it.</p>",
"ListDeliveryStreams": "<p>Lists your delivery streams.</p> <p>The number of delivery streams might be too large to return using a single call to <code>ListDeliveryStreams</code>. You can limit the number of delivery streams returned, using the <b>Limit</b> parameter. To determine whether there are more delivery streams to list, check the value of <code>HasMoreDeliveryStreams</code> in the output. If there are more delivery streams to list, you can request them by specifying the name of the last delivery stream returned in the call in the <code>ExclusiveStartDeliveryStreamName</code> parameter of a subsequent call.</p>",
"ListTagsForDeliveryStream": "<p>Lists the tags for the specified delivery stream. This operation has a limit of five transactions per second per account. </p>",
"PutRecord": "<p>Writes a single data record into an Amazon Kinesis Data Firehose delivery stream. To write multiple data records into a delivery stream, use <a>PutRecordBatch</a>. Applications using these operations are referred to as producers.</p> <p>By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. Note that if you use <code>PutRecord</code> and <a>PutRecordBatch</a>, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/limits.html\">Amazon Kinesis Data Firehose Limits</a>. </p> <p>You must specify the name of the delivery stream and the data record when using <code>PutRecord</code>. The data record consists of a data blob that can be up to 1,000 KB in size and any kind of data. For example, it can be a segment from a log file, geographic location data, website clickstream data, and so on.</p> <p>Kinesis Data Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (<code>\\n</code>) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination.</p> <p>The <code>PutRecord</code> operation returns a <code>RecordId</code>, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation.</p> <p>If the <code>PutRecord</code> operation throws a <code>ServiceUnavailableException</code>, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream. </p> <p>Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.</p>",
"PutRecordBatch": "<p>Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a delivery stream, use <a>PutRecord</a>. Applications using these operations are referred to as producers.</p> <p>By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. If you use <a>PutRecord</a> and <code>PutRecordBatch</code>, the limits are an aggregate across these two operations for each delivery stream. For more information about limits, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/limits.html\">Amazon Kinesis Data Firehose Limits</a>.</p> <p>Each <code>PutRecordBatch</code> request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before 64-bit encoding), up to a limit of 4 MB for the entire request. These limits cannot be changed.</p> <p>You must specify the name of the delivery stream and the data record when using <a>PutRecord</a>. The data record consists of a data blob that can be up to 1,000 KB in size and any kind of data. For example, it could be a segment from a log file, geographic location data, website clickstream data, and so on.</p> <p>Kinesis Data Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (<code>\\n</code>) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination.</p> <p>The <code>PutRecordBatch</code> response includes a count of failed records, <code>FailedPutCount</code>, and an array of responses, <code>RequestResponses</code>. Each entry in the <code>RequestResponses</code> array provides additional information about the processed record. It directly correlates with a record in the request array using the same ordering, from the top to the bottom. The response array always includes the same number of records as the request array. <code>RequestResponses</code> includes both successfully and unsuccessfully processed records. Kinesis Data Firehose attempts to process all records in each <code>PutRecordBatch</code> request. A single record failure does not stop the processing of subsequent records.</p> <p>A successfully processed record includes a <code>RecordId</code> value, which is unique for the record. An unsuccessfully processed record includes <code>ErrorCode</code> and <code>ErrorMessage</code> values. <code>ErrorCode</code> reflects the type of error, and is one of the following values: <code>ServiceUnavailable</code> or <code>InternalFailure</code>. <code>ErrorMessage</code> provides more detailed information about the error.</p> <p>If there is an internal server error or a timeout, the write might have completed or it might have failed. If <code>FailedPutCount</code> is greater than 0, retry the request, resending only those records that might have failed processing. This minimizes the possible duplicate records and also reduces the total bytes sent (and corresponding charges). We recommend that you handle any duplicates at the destination.</p> <p>If <code>PutRecordBatch</code> throws <code>ServiceUnavailableException</code>, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.</p> <p>Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.</p>",
"TagDeliveryStream": "<p>Adds or updates tags for the specified delivery stream. A tag is a key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the delivery stream. For more information about tags, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html\">Using Cost Allocation Tags</a> in the <i>AWS Billing and Cost Management User Guide</i>. </p> <p> Each delivery stream can have up to 50 tags. </p> <p> This operation has a limit of five transactions per second per account. </p>",
"UntagDeliveryStream": "<p>Removes tags from the specified delivery stream. Removed tags are deleted, and you can't recover them after this operation successfully completes.</p> <p>If you specify a tag that doesn't exist, the operation ignores it.</p> <p>This operation has a limit of five transactions per second per account. </p>",
"UpdateDestination": "<p>Updates the specified destination of the specified delivery stream.</p> <p>Use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are usually effective within a few minutes.</p> <p>Switching between Amazon ES and other services is not supported. For an Amazon ES destination, you can only update to another Amazon ES destination.</p> <p>If the destination type is the same, Kinesis Data Firehose merges the configuration parameters specified with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the call, the existing values are retained. For example, in the Amazon S3 destination, if <a>EncryptionConfiguration</a> is not specified, then the existing <code>EncryptionConfiguration</code> is maintained on the destination.</p> <p>If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Kinesis Data Firehose does not merge any parameters. In this case, all parameters must be specified.</p> <p>Kinesis Data Firehose uses <code>CurrentDeliveryStreamVersionId</code> to avoid race conditions and conflicting merges. This is a required field, and the service updates the configuration only if the existing configuration has a version ID that matches. After the update is applied successfully, the version ID is updated, and you can retrieve it using <a>DescribeDeliveryStream</a>. Use the new version ID to set <code>CurrentDeliveryStreamVersionId</code> in the next call.</p>"
},
"shapes": {
"AWSKMSKeyARN": {
"base": null,
"refs": {
"KMSEncryptionConfig$AWSKMSKeyARN": "<p>The ARN of the encryption key. Must belong to the same region as the destination Amazon S3 bucket.</p>"
"KMSEncryptionConfig$AWSKMSKeyARN": "<p>The Amazon Resource Name (ARN) of the encryption key. Must belong to the same AWS Region as the destination Amazon S3 bucket.</p>"
}
},
"BooleanObject": {
@ -23,6 +26,7 @@
"CloudWatchLoggingOptions$Enabled": "<p>Enables or disables CloudWatch logging.</p>",
"DeliveryStreamDescription$HasMoreDestinations": "<p>Indicates whether there are more destinations available to list.</p>",
"ListDeliveryStreamsOutput$HasMoreDeliveryStreams": "<p>Indicates whether there are more delivery streams available to list.</p>",
"ListTagsForDeliveryStreamOutput$HasMoreTags": "<p>If this is <code>true</code> in the response, more tags are available. To list the remaining tags, set <code>ExclusiveStartTagKey</code> to the key of the last tag returned and call <code>ListTagsForDeliveryStream</code> again.</p>",
"ProcessingConfiguration$Enabled": "<p>Enables or disables data processing.</p>"
}
},
@ -38,14 +42,14 @@
}
},
"BufferingHints": {
"base": "<p>Describes hints for the buffering to perform before delivering data to the destination. Please note that these options are treated as hints, and therefore Kinesis Firehose may choose to use different values when it is optimal.</p>",
"base": "<p>Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Kinesis Data Firehose might choose to use different values whenever it is optimal.</p>",
"refs": {
"ExtendedS3DestinationConfiguration$BufferingHints": "<p>The buffering option.</p>",
"ExtendedS3DestinationDescription$BufferingHints": "<p>The buffering option.</p>",
"ExtendedS3DestinationUpdate$BufferingHints": "<p>The buffering option.</p>",
"S3DestinationConfiguration$BufferingHints": "<p>The buffering option. If no value is specified, <b>BufferingHints</b> object default values are used.</p>",
"S3DestinationDescription$BufferingHints": "<p>The buffering option. If no value is specified, <b>BufferingHints</b> object default values are used.</p>",
"S3DestinationUpdate$BufferingHints": "<p>The buffering option. If no value is specified, <b>BufferingHints</b> object default values are used.</p>"
"S3DestinationConfiguration$BufferingHints": "<p>The buffering option. If no value is specified, <code>BufferingHints</code> object default values are used.</p>",
"S3DestinationDescription$BufferingHints": "<p>The buffering option. If no value is specified, <code>BufferingHints</code> object default values are used.</p>",
"S3DestinationUpdate$BufferingHints": "<p>The buffering option. If no value is specified, <code>BufferingHints</code> object default values are used.</p>"
}
},
"CloudWatchLoggingOptions": {
@ -103,7 +107,7 @@
"CopyOptions": {
"base": null,
"refs": {
"CopyCommand$CopyOptions": "<p>Optional parameters to use with the Amazon Redshift <code>COPY</code> command. For more information, see the \"Optional Parameters\" section of <a href=\"http://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html\">Amazon Redshift COPY command</a>. Some possible examples that would apply to Kinesis Firehose are as follows:</p> <p> <code>delimiter '\\t' lzop;</code> - fields are delimited with \"\\t\" (TAB character) and compressed using lzop.</p> <p> <code>delimiter '|'</code> - fields are delimited with \"|\" (this is the default delimiter).</p> <p> <code>delimiter '|' escape</code> - the delimiter should be escaped.</p> <p> <code>fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6'</code> - fields are fixed width in the source, with each width specified after every column in the table.</p> <p> <code>JSON 's3://mybucket/jsonpaths.txt'</code> - data is in JSON format, and the path specified is the format of the data.</p> <p>For more examples, see <a href=\"http://docs.aws.amazon.com/redshift/latest/dg/r_COPY_command_examples.html\">Amazon Redshift COPY command examples</a>.</p>"
"CopyCommand$CopyOptions": "<p>Optional parameters to use with the Amazon Redshift <code>COPY</code> command. For more information, see the \"Optional Parameters\" section of <a href=\"http://docs.aws.amazon.com/redshift/latest/dg/r_COPY.html\">Amazon Redshift COPY command</a>. Some possible examples that would apply to Kinesis Data Firehose are as follows:</p> <p> <code>delimiter '\\t' lzop;</code> - fields are delimited with \"\\t\" (TAB character) and compressed using lzop.</p> <p> <code>delimiter '|'</code> - fields are delimited with \"|\" (this is the default delimiter).</p> <p> <code>delimiter '|' escape</code> - the delimiter should be escaped.</p> <p> <code>fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6'</code> - fields are fixed width in the source, with each width specified after every column in the table.</p> <p> <code>JSON 's3://mybucket/jsonpaths.txt'</code> - data is in JSON format, and the path specified is the format of the data.</p> <p>For more examples, see <a href=\"http://docs.aws.amazon.com/redshift/latest/dg/r_COPY_command_examples.html\">Amazon Redshift COPY command examples</a>.</p>"
}
},
"CreateDeliveryStreamInput": {
@ -147,7 +151,7 @@
"DeliveryStartTimestamp": {
"base": null,
"refs": {
"KinesisStreamSourceDescription$DeliveryStartTimestamp": "<p>Kinesis Firehose starts retrieving records from the Kinesis stream starting with this time stamp.</p>"
"KinesisStreamSourceDescription$DeliveryStartTimestamp": "<p>Kinesis Data Firehose starts retrieving records from the Kinesis data stream starting with this time stamp.</p>"
}
},
"DeliveryStreamARN": {
@ -166,14 +170,17 @@
"DeliveryStreamName": {
"base": null,
"refs": {
"CreateDeliveryStreamInput$DeliveryStreamName": "<p>The name of the delivery stream. This name must be unique per AWS account in the same region. If the delivery streams are in different accounts or different regions, you can have multiple delivery streams with the same name.</p>",
"CreateDeliveryStreamInput$DeliveryStreamName": "<p>The name of the delivery stream. This name must be unique per AWS account in the same Region. If the delivery streams are in different accounts or different Regions, you can have multiple delivery streams with the same name.</p>",
"DeleteDeliveryStreamInput$DeliveryStreamName": "<p>The name of the delivery stream.</p>",
"DeliveryStreamDescription$DeliveryStreamName": "<p>The name of the delivery stream.</p>",
"DeliveryStreamNameList$member": null,
"DescribeDeliveryStreamInput$DeliveryStreamName": "<p>The name of the delivery stream.</p>",
"ListDeliveryStreamsInput$ExclusiveStartDeliveryStreamName": "<p>The name of the delivery stream to start the list with.</p>",
"ListTagsForDeliveryStreamInput$DeliveryStreamName": "<p>The name of the delivery stream whose tags you want to list.</p>",
"PutRecordBatchInput$DeliveryStreamName": "<p>The name of the delivery stream.</p>",
"PutRecordInput$DeliveryStreamName": "<p>The name of the delivery stream.</p>",
"TagDeliveryStreamInput$DeliveryStreamName": "<p>The name of the delivery stream to which you want to add the tags.</p>",
"UntagDeliveryStreamInput$DeliveryStreamName": "<p>The name of the delivery stream.</p>",
"UpdateDestinationInput$DeliveryStreamName": "<p>The name of the delivery stream.</p>"
}
},
@ -192,16 +199,16 @@
"DeliveryStreamType": {
"base": null,
"refs": {
"CreateDeliveryStreamInput$DeliveryStreamType": "<p>The delivery stream type. This parameter can be one of the following values:</p> <ul> <li> <p> <code>DirectPut</code>: Provider applications access the delivery stream directly.</p> </li> <li> <p> <code>KinesisStreamAsSource</code>: The delivery stream uses a Kinesis stream as a source.</p> </li> </ul>",
"DeliveryStreamDescription$DeliveryStreamType": "<p>The delivery stream type. This can be one of the following values:</p> <ul> <li> <p> <code>DirectPut</code>: Provider applications access the delivery stream directly.</p> </li> <li> <p> <code>KinesisStreamAsSource</code>: The delivery stream uses a Kinesis stream as a source.</p> </li> </ul>",
"ListDeliveryStreamsInput$DeliveryStreamType": "<p>The delivery stream type. This can be one of the following values:</p> <ul> <li> <p> <code>DirectPut</code>: Provider applications access the delivery stream directly.</p> </li> <li> <p> <code>KinesisStreamAsSource</code>: The delivery stream uses a Kinesis stream as a source.</p> </li> </ul> <p>This parameter is optional. If this parameter is omitted, delivery streams of all types are returned.</p>"
"CreateDeliveryStreamInput$DeliveryStreamType": "<p>The delivery stream type. This parameter can be one of the following values:</p> <ul> <li> <p> <code>DirectPut</code>: Provider applications access the delivery stream directly.</p> </li> <li> <p> <code>KinesisStreamAsSource</code>: The delivery stream uses a Kinesis data stream as a source.</p> </li> </ul>",
"DeliveryStreamDescription$DeliveryStreamType": "<p>The delivery stream type. This can be one of the following values:</p> <ul> <li> <p> <code>DirectPut</code>: Provider applications access the delivery stream directly.</p> </li> <li> <p> <code>KinesisStreamAsSource</code>: The delivery stream uses a Kinesis data stream as a source.</p> </li> </ul>",
"ListDeliveryStreamsInput$DeliveryStreamType": "<p>The delivery stream type. This can be one of the following values:</p> <ul> <li> <p> <code>DirectPut</code>: Provider applications access the delivery stream directly.</p> </li> <li> <p> <code>KinesisStreamAsSource</code>: The delivery stream uses a Kinesis data stream as a source.</p> </li> </ul> <p>This parameter is optional. If this parameter is omitted, delivery streams of all types are returned.</p>"
}
},
"DeliveryStreamVersionId": {
"base": null,
"refs": {
"DeliveryStreamDescription$VersionId": "<p>Each time the destination is updated for a delivery stream, the version ID is changed, and the current version ID is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream.</p>",
"UpdateDestinationInput$CurrentDeliveryStreamVersionId": "<p>Obtain this value from the <b>VersionId</b> result of <a>DeliveryStreamDescription</a>. This value is required, and helps the service to perform conditional operations. For example, if there is an interleaving update and this value is null, then the update destination fails. After the update is successful, the <b>VersionId</b> value is updated. The service then performs a merge of the old configuration with the new configuration.</p>"
"UpdateDestinationInput$CurrentDeliveryStreamVersionId": "<p>Obtain this value from the <code>VersionId</code> result of <a>DeliveryStreamDescription</a>. This value is required, and it helps the service perform conditional operations. For example, if there is an interleaving update and this value is null, then the update destination fails. After the update is successful, the <code>VersionId</code> value is updated. The service then performs a merge of the old configuration with the new configuration.</p>"
}
},
"DescribeDeliveryStreamInput": {
@ -235,7 +242,7 @@
"DestinationId": {
"base": null,
"refs": {
"DescribeDeliveryStreamInput$ExclusiveStartDestinationId": "<p>The ID of the destination to start returning the destination information. Currently, Kinesis Firehose supports one destination per delivery stream.</p>",
"DescribeDeliveryStreamInput$ExclusiveStartDestinationId": "<p>The ID of the destination to start returning the destination information. Currently, Kinesis Data Firehose supports one destination per delivery stream.</p>",
"DestinationDescription$DestinationId": "<p>The ID of the destination.</p>",
"UpdateDestinationInput$DestinationId": "<p>The ID of the destination.</p>"
}
@ -243,9 +250,9 @@
"ElasticsearchBufferingHints": {
"base": "<p>Describes the buffering to perform before delivering data to the Amazon ES destination.</p>",
"refs": {
"ElasticsearchDestinationConfiguration$BufferingHints": "<p>The buffering options. If no value is specified, the default values for <b>ElasticsearchBufferingHints</b> are used.</p>",
"ElasticsearchDestinationConfiguration$BufferingHints": "<p>The buffering options. If no value is specified, the default values for <code>ElasticsearchBufferingHints</code> are used.</p>",
"ElasticsearchDestinationDescription$BufferingHints": "<p>The buffering options.</p>",
"ElasticsearchDestinationUpdate$BufferingHints": "<p>The buffering options. If no value is specified, <b>ElasticsearchBufferingHints</b> object default values are used. </p>"
"ElasticsearchDestinationUpdate$BufferingHints": "<p>The buffering options. If no value is specified, <code>ElasticsearchBufferingHints</code> object default values are used. </p>"
}
},
"ElasticsearchBufferingIntervalInSeconds": {
@ -281,9 +288,9 @@
"ElasticsearchDomainARN": {
"base": null,
"refs": {
"ElasticsearchDestinationConfiguration$DomainARN": "<p>The ARN of the Amazon ES domain. The IAM role must have permissions for <code>DescribeElasticsearchDomain</code>, <code>DescribeElasticsearchDomains</code>, and <code>DescribeElasticsearchDomainConfig</code> after assuming the role specified in <b>RoleARN</b>.</p>",
"ElasticsearchDestinationConfiguration$DomainARN": "<p>The ARN of the Amazon ES domain. The IAM role must have permissions for <code>DescribeElasticsearchDomain</code>, <code>DescribeElasticsearchDomains</code>, and <code>DescribeElasticsearchDomainConfig</code> after assuming the role specified in <code>RoleARN</code>.</p>",
"ElasticsearchDestinationDescription$DomainARN": "<p>The ARN of the Amazon ES domain.</p>",
"ElasticsearchDestinationUpdate$DomainARN": "<p>The ARN of the Amazon ES domain. The IAM role must have permissions for <code>DescribeElasticsearchDomain</code>, <code>DescribeElasticsearchDomains</code>, and <code>DescribeElasticsearchDomainConfig</code> after assuming the IAM role specified in <b>RoleARN</b>.</p>"
"ElasticsearchDestinationUpdate$DomainARN": "<p>The ARN of the Amazon ES domain. The IAM role must have permissions for <code>DescribeElasticsearchDomain</code>, <code>DescribeElasticsearchDomains</code>, and <code>DescribeElasticsearchDomainConfig</code> after assuming the IAM role specified in <code>RoleARN</code>.</p>"
}
},
"ElasticsearchIndexName": {
@ -297,29 +304,29 @@
"ElasticsearchIndexRotationPeriod": {
"base": null,
"refs": {
"ElasticsearchDestinationConfiguration$IndexRotationPeriod": "<p>The Elasticsearch index rotation period. Index rotation appends a time stamp to the IndexName to facilitate the expiration of old data. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation\">Index Rotation for Amazon Elasticsearch Service Destination</a>. The default value is <code>OneDay</code>.</p>",
"ElasticsearchDestinationConfiguration$IndexRotationPeriod": "<p>The Elasticsearch index rotation period. Index rotation appends a time stamp to the IndexName to facilitate the expiration of old data. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation\">Index Rotation for the Amazon ES Destination</a>. The default value is <code>OneDay</code>.</p>",
"ElasticsearchDestinationDescription$IndexRotationPeriod": "<p>The Elasticsearch index rotation period</p>",
"ElasticsearchDestinationUpdate$IndexRotationPeriod": "<p>The Elasticsearch index rotation period. Index rotation appends a time stamp to IndexName to facilitate the expiration of old data. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation\">Index Rotation for Amazon Elasticsearch Service Destination</a>. Default value is <code>OneDay</code>.</p>"
"ElasticsearchDestinationUpdate$IndexRotationPeriod": "<p>The Elasticsearch index rotation period. Index rotation appends a time stamp to IndexName to facilitate the expiration of old data. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation\">Index Rotation for the Amazon ES Destination</a>. Default value is <code>OneDay</code>.</p>"
}
},
"ElasticsearchRetryDurationInSeconds": {
"base": null,
"refs": {
"ElasticsearchRetryOptions$DurationInSeconds": "<p>After an initial failure to deliver to Amazon ES, the total amount of time during which Kinesis Firehose re-attempts delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.</p>"
"ElasticsearchRetryOptions$DurationInSeconds": "<p>After an initial failure to deliver to Amazon ES, the total amount of time during which Kinesis Data Firehose re-attempts delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.</p>"
}
},
"ElasticsearchRetryOptions": {
"base": "<p>Configures retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon ES.</p>",
"base": "<p>Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES.</p>",
"refs": {
"ElasticsearchDestinationConfiguration$RetryOptions": "<p>The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).</p>",
"ElasticsearchDestinationConfiguration$RetryOptions": "<p>The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).</p>",
"ElasticsearchDestinationDescription$RetryOptions": "<p>The Amazon ES retry options.</p>",
"ElasticsearchDestinationUpdate$RetryOptions": "<p>The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).</p>"
"ElasticsearchDestinationUpdate$RetryOptions": "<p>The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).</p>"
}
},
"ElasticsearchS3BackupMode": {
"base": null,
"refs": {
"ElasticsearchDestinationConfiguration$S3BackupMode": "<p>Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-s3-backup\">Amazon S3 Backup for Amazon Elasticsearch Service Destination</a>. Default value is FailedDocumentsOnly.</p>",
"ElasticsearchDestinationConfiguration$S3BackupMode": "<p>Defines how documents should be delivered to Amazon S3. When set to <code>FailedDocumentsOnly</code>, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with <code>elasticsearch-failed/</code> appended to the key prefix. When set to <code>AllDocuments</code>, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with <code>elasticsearch-failed/</code> appended to the prefix. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#retry\">Data Delivery Failure Handling</a>. Default value is <code>FailedDocumentsOnly</code>.</p>",
"ElasticsearchDestinationDescription$S3BackupMode": "<p>The Amazon S3 backup mode.</p>"
}
},
@ -381,33 +388,33 @@
"HECAcknowledgmentTimeoutInSeconds": {
"base": null,
"refs": {
"SplunkDestinationConfiguration$HECAcknowledgmentTimeoutInSeconds": "<p>The amount of time that Kinesis Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period Kinesis Firehose either tries to send the data again or considers it an error, based on your retry settings.</p>",
"SplunkDestinationDescription$HECAcknowledgmentTimeoutInSeconds": "<p>The amount of time that Kinesis Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period Kinesis Firehose either tries to send the data again or considers it an error, based on your retry settings.</p>",
"SplunkDestinationUpdate$HECAcknowledgmentTimeoutInSeconds": "<p>The amount of time that Kinesis Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period Kinesis Firehose either tries to send the data again or considers it an error, based on your retry settings.</p>"
"SplunkDestinationConfiguration$HECAcknowledgmentTimeoutInSeconds": "<p>The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.</p>",
"SplunkDestinationDescription$HECAcknowledgmentTimeoutInSeconds": "<p>The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.</p>",
"SplunkDestinationUpdate$HECAcknowledgmentTimeoutInSeconds": "<p>The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.</p>"
}
},
"HECEndpoint": {
"base": null,
"refs": {
"SplunkDestinationConfiguration$HECEndpoint": "<p>The HTTP Event Collector (HEC) endpoint to which Kinesis Firehose sends your data.</p>",
"SplunkDestinationDescription$HECEndpoint": "<p>The HTTP Event Collector (HEC) endpoint to which Kinesis Firehose sends your data.</p>",
"SplunkDestinationUpdate$HECEndpoint": "<p>The HTTP Event Collector (HEC) endpoint to which Kinesis Firehose sends your data.</p>"
"SplunkDestinationConfiguration$HECEndpoint": "<p>The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.</p>",
"SplunkDestinationDescription$HECEndpoint": "<p>The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.</p>",
"SplunkDestinationUpdate$HECEndpoint": "<p>The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.</p>"
}
},
"HECEndpointType": {
"base": null,
"refs": {
"SplunkDestinationConfiguration$HECEndpointType": "<p>This type can be either \"Raw\" or \"Event\".</p>",
"SplunkDestinationDescription$HECEndpointType": "<p>This type can be either \"Raw\" or \"Event\".</p>",
"SplunkDestinationUpdate$HECEndpointType": "<p>This type can be either \"Raw\" or \"Event\".</p>"
"SplunkDestinationConfiguration$HECEndpointType": "<p>This type can be either \"Raw\" or \"Event.\"</p>",
"SplunkDestinationDescription$HECEndpointType": "<p>This type can be either \"Raw\" or \"Event.\"</p>",
"SplunkDestinationUpdate$HECEndpointType": "<p>This type can be either \"Raw\" or \"Event.\"</p>"
}
},
"HECToken": {
"base": null,
"refs": {
"SplunkDestinationConfiguration$HECToken": "<p>This is a GUID you obtain from your Splunk cluster when you create a new HEC endpoint.</p>",
"SplunkDestinationConfiguration$HECToken": "<p>This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.</p>",
"SplunkDestinationDescription$HECToken": "<p>This is a GUID you obtain from your Splunk cluster when you create a new HEC endpoint.</p>",
"SplunkDestinationUpdate$HECToken": "<p>This is a GUID you obtain from your Splunk cluster when you create a new HEC endpoint.</p>"
"SplunkDestinationUpdate$HECToken": "<p>A GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.</p>"
}
},
"IntervalInSeconds": {
@ -430,20 +437,20 @@
"KinesisStreamARN": {
"base": null,
"refs": {
"KinesisStreamSourceConfiguration$KinesisStreamARN": "<p>The ARN of the source Kinesis stream.</p>",
"KinesisStreamSourceDescription$KinesisStreamARN": "<p>The ARN of the source Kinesis stream.</p>"
"KinesisStreamSourceConfiguration$KinesisStreamARN": "<p>The ARN of the source Kinesis data stream.</p>",
"KinesisStreamSourceDescription$KinesisStreamARN": "<p>The Amazon Resource Name (ARN) of the source Kinesis data stream.</p>"
}
},
"KinesisStreamSourceConfiguration": {
"base": "<p>The stream and role ARNs for a Kinesis stream used as the source for a delivery stream.</p>",
"base": "<p>The stream and role Amazon Resource Names (ARNs) for a Kinesis data stream used as the source for a delivery stream.</p>",
"refs": {
"CreateDeliveryStreamInput$KinesisStreamSourceConfiguration": "<p>When a Kinesis stream is used as the source for the delivery stream, a <a>KinesisStreamSourceConfiguration</a> containing the Kinesis stream ARN and the role ARN for the source stream.</p>"
"CreateDeliveryStreamInput$KinesisStreamSourceConfiguration": "<p>When a Kinesis data stream is used as the source for the delivery stream, a <a>KinesisStreamSourceConfiguration</a> containing the Kinesis data stream Amazon Resource Name (ARN) and the role ARN for the source stream.</p>"
}
},
"KinesisStreamSourceDescription": {
"base": "<p>Details about a Kinesis stream used as the source for a Kinesis Firehose delivery stream.</p>",
"base": "<p>Details about a Kinesis data stream used as the source for a Kinesis Data Firehose delivery stream.</p>",
"refs": {
"SourceDescription$KinesisStreamSourceDescription": "<p>The <a>KinesisStreamSourceDescription</a> value for the source Kinesis stream.</p>"
"SourceDescription$KinesisStreamSourceDescription": "<p>The <a>KinesisStreamSourceDescription</a> value for the source Kinesis data stream.</p>"
}
},
"LimitExceededException": {
@ -467,6 +474,28 @@
"refs": {
}
},
"ListTagsForDeliveryStreamInput": {
"base": null,
"refs": {
}
},
"ListTagsForDeliveryStreamInputLimit": {
"base": null,
"refs": {
"ListTagsForDeliveryStreamInput$Limit": "<p>The number of tags to return. If this number is less than the total number of tags associated with the delivery stream, <code>HasMoreTags</code> is set to <code>true</code> in the response. To list additional tags, set <code>ExclusiveStartTagKey</code> to the last key in the response. </p>"
}
},
"ListTagsForDeliveryStreamOutput": {
"base": null,
"refs": {
}
},
"ListTagsForDeliveryStreamOutputTagList": {
"base": null,
"refs": {
"ListTagsForDeliveryStreamOutput$Tags": "<p>A list of tags associated with <code>DeliveryStreamName</code>, starting with the first tag after <code>ExclusiveStartTagKey</code> and up to the specified <code>Limit</code>.</p>"
}
},
"LogGroupName": {
"base": null,
"refs": {
@ -501,12 +530,12 @@
"Prefix": {
"base": null,
"refs": {
"ExtendedS3DestinationConfiguration$Prefix": "<p>The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html\">Amazon S3 Object Name Format</a> in the <i>Amazon Kinesis Firehose Developer Guide</i>.</p>",
"ExtendedS3DestinationDescription$Prefix": "<p>The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html\">Amazon S3 Object Name Format</a> in the <i>Amazon Kinesis Firehose Developer Guide</i>.</p>",
"ExtendedS3DestinationUpdate$Prefix": "<p>The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html\">Amazon S3 Object Name Format</a> in the <i>Amazon Kinesis Firehose Developer Guide</i>.</p>",
"S3DestinationConfiguration$Prefix": "<p>The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html\">Amazon S3 Object Name Format</a> in the <i>Amazon Kinesis Firehose Developer Guide</i>.</p>",
"S3DestinationDescription$Prefix": "<p>The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html\">Amazon S3 Object Name Format</a> in the <i>Amazon Kinesis Firehose Developer Guide</i>.</p>",
"S3DestinationUpdate$Prefix": "<p>The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html\">Amazon S3 Object Name Format</a> in the <i>Amazon Kinesis Firehose Developer Guide</i>.</p>"
"ExtendedS3DestinationConfiguration$Prefix": "<p>The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#s3-object-name\">Amazon S3 Object Name Format</a> in the <i>Amazon Kinesis Data Firehose Developer Guide</i>.</p>",
"ExtendedS3DestinationDescription$Prefix": "<p>The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#s3-object-name\">Amazon S3 Object Name Format</a> in the <i>Amazon Kinesis Data Firehose Developer Guide</i>.</p>",
"ExtendedS3DestinationUpdate$Prefix": "<p>The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#s3-object-name\">Amazon S3 Object Name Format</a> in the <i>Amazon Kinesis Data Firehose Developer Guide</i>.</p>",
"S3DestinationConfiguration$Prefix": "<p>The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#s3-object-name\">Amazon S3 Object Name Format</a> in the <i>Amazon Kinesis Data Firehose Developer Guide</i>.</p>",
"S3DestinationDescription$Prefix": "<p>The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#s3-object-name\">Amazon S3 Object Name Format</a> in the <i>Amazon Kinesis Data Firehose Developer Guide</i>.</p>",
"S3DestinationUpdate$Prefix": "<p>The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3 files. You can specify an extra prefix to be added in front of the time format prefix. If the prefix ends with a slash, it appears as a folder in the S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#s3-object-name\">Amazon S3 Object Name Format</a> in the <i>Amazon Kinesis Data Firehose Developer Guide</i>.</p>"
}
},
"ProcessingConfiguration": {
@ -641,15 +670,15 @@
"RedshiftRetryDurationInSeconds": {
"base": null,
"refs": {
"RedshiftRetryOptions$DurationInSeconds": "<p>The length of time during which Kinesis Firehose retries delivery after a failure, starting from the initial request and including the first attempt. The default value is 3600 seconds (60 minutes). Kinesis Firehose does not retry if the value of <code>DurationInSeconds</code> is 0 (zero) or if the first delivery attempt takes longer than the current value.</p>"
"RedshiftRetryOptions$DurationInSeconds": "<p>The length of time during which Kinesis Data Firehose retries delivery after a failure, starting from the initial request and including the first attempt. The default value is 3600 seconds (60 minutes). Kinesis Data Firehose does not retry if the value of <code>DurationInSeconds</code> is 0 (zero) or if the first delivery attempt takes longer than the current value.</p>"
}
},
"RedshiftRetryOptions": {
"base": "<p>Configures retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon Redshift.</p>",
"base": "<p>Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift.</p>",
"refs": {
"RedshiftDestinationConfiguration$RetryOptions": "<p>The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).</p>",
"RedshiftDestinationDescription$RetryOptions": "<p>The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).</p>",
"RedshiftDestinationUpdate$RetryOptions": "<p>The retry behavior in case Kinesis Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).</p>"
"RedshiftDestinationConfiguration$RetryOptions": "<p>The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).</p>",
"RedshiftDestinationDescription$RetryOptions": "<p>The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).</p>",
"RedshiftDestinationUpdate$RetryOptions": "<p>The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).</p>"
}
},
"RedshiftS3BackupMode": {
@ -673,20 +702,20 @@
"RoleARN": {
"base": null,
"refs": {
"ElasticsearchDestinationConfiguration$RoleARN": "<p>The ARN of the IAM role to be assumed by Kinesis Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3\">Amazon S3 Bucket Access</a>.</p>",
"ElasticsearchDestinationDescription$RoleARN": "<p>The ARN of the AWS credentials.</p>",
"ElasticsearchDestinationUpdate$RoleARN": "<p>The ARN of the IAM role to be assumed by Kinesis Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3\">Amazon S3 Bucket Access</a>.</p>",
"ExtendedS3DestinationConfiguration$RoleARN": "<p>The ARN of the AWS credentials.</p>",
"ExtendedS3DestinationDescription$RoleARN": "<p>The ARN of the AWS credentials.</p>",
"ExtendedS3DestinationUpdate$RoleARN": "<p>The ARN of the AWS credentials.</p>",
"KinesisStreamSourceConfiguration$RoleARN": "<p>The ARN of the role that provides access to the source Kinesis stream.</p>",
"KinesisStreamSourceDescription$RoleARN": "<p>The ARN of the role used by the source Kinesis stream.</p>",
"RedshiftDestinationConfiguration$RoleARN": "<p>The ARN of the AWS credentials.</p>",
"RedshiftDestinationDescription$RoleARN": "<p>The ARN of the AWS credentials.</p>",
"RedshiftDestinationUpdate$RoleARN": "<p>The ARN of the AWS credentials.</p>",
"S3DestinationConfiguration$RoleARN": "<p>The ARN of the AWS credentials.</p>",
"S3DestinationDescription$RoleARN": "<p>The ARN of the AWS credentials.</p>",
"S3DestinationUpdate$RoleARN": "<p>The ARN of the AWS credentials.</p>"
"ElasticsearchDestinationConfiguration$RoleARN": "<p>The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3\">Grant Kinesis Data Firehose Access to an Amazon Destination</a>.</p>",
"ElasticsearchDestinationDescription$RoleARN": "<p>The Amazon Resource Name (ARN) of the AWS credentials.</p>",
"ElasticsearchDestinationUpdate$RoleARN": "<p>The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3\">Grant Kinesis Data Firehose Access to an Amazon S3 Destination</a>.</p>",
"ExtendedS3DestinationConfiguration$RoleARN": "<p>The Amazon Resource Name (ARN) of the AWS credentials.</p>",
"ExtendedS3DestinationDescription$RoleARN": "<p>The Amazon Resource Name (ARN) of the AWS credentials.</p>",
"ExtendedS3DestinationUpdate$RoleARN": "<p>The Amazon Resource Name (ARN) of the AWS credentials.</p>",
"KinesisStreamSourceConfiguration$RoleARN": "<p>The ARN of the role that provides access to the source Kinesis data stream.</p>",
"KinesisStreamSourceDescription$RoleARN": "<p>The ARN of the role used by the source Kinesis data stream.</p>",
"RedshiftDestinationConfiguration$RoleARN": "<p>The Amazon Resource Name (ARN) of the AWS credentials.</p>",
"RedshiftDestinationDescription$RoleARN": "<p>The Amazon Resource Name (ARN) of the AWS credentials.</p>",
"RedshiftDestinationUpdate$RoleARN": "<p>The Amazon Resource Name (ARN) of the AWS credentials.</p>",
"S3DestinationConfiguration$RoleARN": "<p>The Amazon Resource Name (ARN) of the AWS credentials.</p>",
"S3DestinationDescription$RoleARN": "<p>The Amazon Resource Name (ARN) of the AWS credentials.</p>",
"S3DestinationUpdate$RoleARN": "<p>The Amazon Resource Name (ARN) of the AWS credentials.</p>"
}
},
"S3BackupMode": {
@ -703,7 +732,7 @@
"CreateDeliveryStreamInput$S3DestinationConfiguration": "<p>[Deprecated] The destination in Amazon S3. You can specify only one destination.</p>",
"ElasticsearchDestinationConfiguration$S3Configuration": "<p>The configuration for the backup Amazon S3 location.</p>",
"ExtendedS3DestinationConfiguration$S3BackupConfiguration": "<p>The configuration for backup in Amazon S3.</p>",
"RedshiftDestinationConfiguration$S3Configuration": "<p>The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions are described in the topic for <a>CreateDeliveryStream</a>.</p> <p>The compression formats <code>SNAPPY</code> or <code>ZIP</code> cannot be specified in <b>RedshiftDestinationConfiguration.S3Configuration</b> because the Amazon Redshift <code>COPY</code> operation that reads from the S3 bucket doesn't support these compression formats.</p>",
"RedshiftDestinationConfiguration$S3Configuration": "<p>The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions are described in the topic for <a>CreateDeliveryStream</a>.</p> <p>The compression formats <code>SNAPPY</code> or <code>ZIP</code> cannot be specified in <code>RedshiftDestinationConfiguration.S3Configuration</code> because the Amazon Redshift <code>COPY</code> operation that reads from the S3 bucket doesn't support these compression formats.</p>",
"RedshiftDestinationConfiguration$S3BackupConfiguration": "<p>The configuration for backup in Amazon S3.</p>",
"SplunkDestinationConfiguration$S3Configuration": "<p>The configuration for the backup Amazon S3 location.</p>"
}
@ -724,14 +753,14 @@
"refs": {
"ElasticsearchDestinationUpdate$S3Update": "<p>The Amazon S3 destination.</p>",
"ExtendedS3DestinationUpdate$S3BackupUpdate": "<p>The Amazon S3 destination for backup.</p>",
"RedshiftDestinationUpdate$S3Update": "<p>The Amazon S3 destination.</p> <p>The compression formats <code>SNAPPY</code> or <code>ZIP</code> cannot be specified in <b>RedshiftDestinationUpdate.S3Update</b> because the Amazon Redshift <code>COPY</code> operation that reads from the S3 bucket doesn't support these compression formats.</p>",
"RedshiftDestinationUpdate$S3Update": "<p>The Amazon S3 destination.</p> <p>The compression formats <code>SNAPPY</code> or <code>ZIP</code> cannot be specified in <code>RedshiftDestinationUpdate.S3Update</code> because the Amazon Redshift <code>COPY</code> operation that reads from the S3 bucket doesn't support these compression formats.</p>",
"RedshiftDestinationUpdate$S3BackupUpdate": "<p>The Amazon S3 destination for backup.</p>",
"SplunkDestinationUpdate$S3Update": "<p>Your update to the configuration of the backup Amazon S3 location.</p>",
"UpdateDestinationInput$S3DestinationUpdate": "<p>[Deprecated] Describes an update for a destination in Amazon S3.</p>"
}
},
"ServiceUnavailableException": {
"base": "<p>The service is unavailable, back off and retry the operation. If you continue to see the exception, throughput limits for the delivery stream may have been exceeded. For more information about limits and how to request an increase, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/limits.html\">Amazon Kinesis Firehose Limits</a>.</p>",
"base": "<p>The service is unavailable. Back off and retry the operation. If you continue to see the exception, throughput limits for the delivery stream may have been exceeded. For more information about limits and how to request an increase, see <a href=\"http://docs.aws.amazon.com/firehose/latest/dev/limits.html\">Amazon Kinesis Data Firehose Limits</a>.</p>",
"refs": {
}
},
@ -742,9 +771,9 @@
}
},
"SourceDescription": {
"base": "<p>Details about a Kinesis stream used as the source for a Kinesis Firehose delivery stream.</p>",
"base": "<p>Details about a Kinesis data stream used as the source for a Kinesis Data Firehose delivery stream.</p>",
"refs": {
"DeliveryStreamDescription$Source": "<p>If the <code>DeliveryStreamType</code> parameter is <code>KinesisStreamAsSource</code>, a <a>SourceDescription</a> object describing the source Kinesis stream.</p>"
"DeliveryStreamDescription$Source": "<p>If the <code>DeliveryStreamType</code> parameter is <code>KinesisStreamAsSource</code>, a <a>SourceDescription</a> object describing the source Kinesis data stream.</p>"
}
},
"SplunkDestinationConfiguration": {
@ -768,23 +797,66 @@
"SplunkRetryDurationInSeconds": {
"base": null,
"refs": {
"SplunkRetryOptions$DurationInSeconds": "<p>The total amount of time that Kinesis Firehose spends on retries. This duration starts after the initial attempt to send data to Splunk fails and doesn't include the periods during which Kinesis Firehose waits for acknowledgment from Splunk after each attempt.</p>"
"SplunkRetryOptions$DurationInSeconds": "<p>The total amount of time that Kinesis Data Firehose spends on retries. This duration starts after the initial attempt to send data to Splunk fails. It doesn't include the periods during which Kinesis Data Firehose waits for acknowledgment from Splunk after each attempt.</p>"
}
},
"SplunkRetryOptions": {
"base": "<p>Configures retry behavior in case Kinesis Firehose is unable to deliver documents to Splunk or if it doesn't receive an acknowledgment from Splunk.</p>",
"base": "<p>Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Splunk, or if it doesn't receive an acknowledgment from Splunk.</p>",
"refs": {
"SplunkDestinationConfiguration$RetryOptions": "<p>The retry behavior in case Kinesis Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.</p>",
"SplunkDestinationDescription$RetryOptions": "<p>The retry behavior in case Kinesis Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.</p>",
"SplunkDestinationUpdate$RetryOptions": "<p>The retry behavior in case Kinesis Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.</p>"
"SplunkDestinationConfiguration$RetryOptions": "<p>The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk.</p>",
"SplunkDestinationDescription$RetryOptions": "<p>The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.</p>",
"SplunkDestinationUpdate$RetryOptions": "<p>The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.</p>"
}
},
"SplunkS3BackupMode": {
"base": null,
"refs": {
"SplunkDestinationConfiguration$S3BackupMode": "<p>Defines how documents should be delivered to Amazon S3. When set to <code>FailedDocumentsOnly</code>, Kinesis Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to <code>AllDocuments</code>, Kinesis Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is <code>FailedDocumentsOnly</code>. </p>",
"SplunkDestinationDescription$S3BackupMode": "<p>Defines how documents should be delivered to Amazon S3. When set to <code>FailedDocumentsOnly</code>, Kinesis Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to <code>AllDocuments</code>, Kinesis Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is <code>FailedDocumentsOnly</code>. </p>",
"SplunkDestinationUpdate$S3BackupMode": "<p>Defines how documents should be delivered to Amazon S3. When set to <code>FailedDocumentsOnly</code>, Kinesis Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to <code>AllDocuments</code>, Kinesis Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is <code>FailedDocumentsOnly</code>. </p>"
"SplunkDestinationConfiguration$S3BackupMode": "<p>Defines how documents should be delivered to Amazon S3. When set to <code>FailedDocumentsOnly</code>, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to <code>AllDocuments</code>, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is <code>FailedDocumentsOnly</code>. </p>",
"SplunkDestinationDescription$S3BackupMode": "<p>Defines how documents should be delivered to Amazon S3. When set to <code>FailedDocumentsOnly</code>, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to <code>AllDocuments</code>, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is <code>FailedDocumentsOnly</code>. </p>",
"SplunkDestinationUpdate$S3BackupMode": "<p>Defines how documents should be delivered to Amazon S3. When set to <code>FailedDocumentsOnly</code>, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to <code>AllDocuments</code>, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is <code>FailedDocumentsOnly</code>. </p>"
}
},
"Tag": {
"base": "<p>Metadata that you can assign to a delivery stream, consisting of a key-value pair.</p>",
"refs": {
"ListTagsForDeliveryStreamOutputTagList$member": null,
"TagDeliveryStreamInputTagList$member": null
}
},
"TagDeliveryStreamInput": {
"base": null,
"refs": {
}
},
"TagDeliveryStreamInputTagList": {
"base": null,
"refs": {
"TagDeliveryStreamInput$Tags": "<p>A set of key-value pairs to use to create the tags.</p>"
}
},
"TagDeliveryStreamOutput": {
"base": null,
"refs": {
}
},
"TagKey": {
"base": null,
"refs": {
"ListTagsForDeliveryStreamInput$ExclusiveStartTagKey": "<p>The key to use as the starting point for the list of tags. If you set this parameter, <code>ListTagsForDeliveryStream</code> gets all tags that occur after <code>ExclusiveStartTagKey</code>.</p>",
"Tag$Key": "<p>A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @</p>",
"TagKeyList$member": null
}
},
"TagKeyList": {
"base": null,
"refs": {
"UntagDeliveryStreamInput$TagKeys": "<p>A list of tag keys. Each corresponding tag is removed from the delivery stream.</p>"
}
},
"TagValue": {
"base": null,
"refs": {
"Tag$Value": "<p>An optional string, which you can use to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @</p>"
}
},
"Timestamp": {
@ -794,6 +866,16 @@
"DeliveryStreamDescription$LastUpdateTimestamp": "<p>The date and time that the delivery stream was last updated.</p>"
}
},
"UntagDeliveryStreamInput": {
"base": null,
"refs": {
}
},
"UntagDeliveryStreamOutput": {
"base": null,
"refs": {
}
},
"UpdateDestinationInput": {
"base": null,
"refs": {

18
vendor/github.com/aws/aws-sdk-go/models/apis/firehose/2015-08-04/smoke.json generated vendored Normal file
View File

@ -0,0 +1,18 @@
{
"version": 1,
"defaultRegion": "us-west-2",
"testCases": [
{
"operationName": "ListDeliveryStreams",
"input": {},
"errorExpectedFromService": false
},
{
"operationName": "DescribeDeliveryStream",
"input": {
"DeliveryStreamName": "bogus-stream-name"
},
"errorExpectedFromService": true
}
]
}

544
vendor/github.com/aws/aws-sdk-go/models/apis/fms/2018-01-01/api-2.json generated vendored Normal file
View File

@ -0,0 +1,544 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2018-01-01",
"endpointPrefix":"fms",
"jsonVersion":"1.1",
"protocol":"json",
"serviceAbbreviation":"FMS",
"serviceFullName":"Firewall Management Service",
"serviceId":"FMS",
"signatureVersion":"v4",
"targetPrefix":"AWSFMS_20180101",
"uid":"fms-2018-01-01"
},
"operations":{
"AssociateAdminAccount":{
"name":"AssociateAdminAccount",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AssociateAdminAccountRequest"},
"errors":[
{"shape":"InvalidOperationException"},
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalErrorException"}
]
},
"DeleteNotificationChannel":{
"name":"DeleteNotificationChannel",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteNotificationChannelRequest"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidOperationException"},
{"shape":"InternalErrorException"}
]
},
"DeletePolicy":{
"name":"DeletePolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeletePolicyRequest"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidOperationException"},
{"shape":"InternalErrorException"}
]
},
"DisassociateAdminAccount":{
"name":"DisassociateAdminAccount",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisassociateAdminAccountRequest"},
"errors":[
{"shape":"InvalidOperationException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalErrorException"}
]
},
"GetAdminAccount":{
"name":"GetAdminAccount",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetAdminAccountRequest"},
"output":{"shape":"GetAdminAccountResponse"},
"errors":[
{"shape":"InvalidOperationException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalErrorException"}
]
},
"GetComplianceDetail":{
"name":"GetComplianceDetail",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetComplianceDetailRequest"},
"output":{"shape":"GetComplianceDetailResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalErrorException"}
]
},
"GetNotificationChannel":{
"name":"GetNotificationChannel",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetNotificationChannelRequest"},
"output":{"shape":"GetNotificationChannelResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidOperationException"},
{"shape":"InternalErrorException"}
]
},
"GetPolicy":{
"name":"GetPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetPolicyRequest"},
"output":{"shape":"GetPolicyResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidOperationException"},
{"shape":"InternalErrorException"}
]
},
"ListComplianceStatus":{
"name":"ListComplianceStatus",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListComplianceStatusRequest"},
"output":{"shape":"ListComplianceStatusResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalErrorException"}
]
},
"ListPolicies":{
"name":"ListPolicies",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListPoliciesRequest"},
"output":{"shape":"ListPoliciesResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidOperationException"},
{"shape":"LimitExceededException"},
{"shape":"InternalErrorException"}
]
},
"PutNotificationChannel":{
"name":"PutNotificationChannel",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutNotificationChannelRequest"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidOperationException"},
{"shape":"InternalErrorException"}
]
},
"PutPolicy":{
"name":"PutPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutPolicyRequest"},
"output":{"shape":"PutPolicyResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidOperationException"},
{"shape":"InvalidInputException"},
{"shape":"InternalErrorException"}
]
}
},
"shapes":{
"AWSAccountId":{
"type":"string",
"max":1024,
"min":1
},
"AssociateAdminAccountRequest":{
"type":"structure",
"required":["AdminAccount"],
"members":{
"AdminAccount":{"shape":"AWSAccountId"}
}
},
"Boolean":{"type":"boolean"},
"ComplianceViolator":{
"type":"structure",
"members":{
"ResourceId":{"shape":"ResourceId"},
"ViolationReason":{"shape":"ViolationReason"},
"ResourceType":{"shape":"ResourceType"}
}
},
"ComplianceViolators":{
"type":"list",
"member":{"shape":"ComplianceViolator"}
},
"DeleteNotificationChannelRequest":{
"type":"structure",
"members":{
}
},
"DeletePolicyRequest":{
"type":"structure",
"required":["PolicyId"],
"members":{
"PolicyId":{"shape":"PolicyId"}
}
},
"DisassociateAdminAccountRequest":{
"type":"structure",
"members":{
}
},
"ErrorMessage":{"type":"string"},
"EvaluationResult":{
"type":"structure",
"members":{
"ComplianceStatus":{"shape":"PolicyComplianceStatusType"},
"ViolatorCount":{"shape":"ResourceCount"},
"EvaluationLimitExceeded":{"shape":"Boolean"}
}
},
"EvaluationResults":{
"type":"list",
"member":{"shape":"EvaluationResult"}
},
"GetAdminAccountRequest":{
"type":"structure",
"members":{
}
},
"GetAdminAccountResponse":{
"type":"structure",
"members":{
"AdminAccount":{"shape":"AWSAccountId"}
}
},
"GetComplianceDetailRequest":{
"type":"structure",
"required":[
"PolicyId",
"MemberAccount"
],
"members":{
"PolicyId":{"shape":"PolicyId"},
"MemberAccount":{"shape":"AWSAccountId"}
}
},
"GetComplianceDetailResponse":{
"type":"structure",
"members":{
"PolicyComplianceDetail":{"shape":"PolicyComplianceDetail"}
}
},
"GetNotificationChannelRequest":{
"type":"structure",
"members":{
}
},
"GetNotificationChannelResponse":{
"type":"structure",
"members":{
"SnsTopicArn":{"shape":"ResourceArn"},
"SnsRoleName":{"shape":"ResourceArn"}
}
},
"GetPolicyRequest":{
"type":"structure",
"required":["PolicyId"],
"members":{
"PolicyId":{"shape":"PolicyId"}
}
},
"GetPolicyResponse":{
"type":"structure",
"members":{
"Policy":{"shape":"Policy"},
"PolicyArn":{"shape":"ResourceArn"}
}
},
"InternalErrorException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"InvalidInputException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"InvalidOperationException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"LimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"ListComplianceStatusRequest":{
"type":"structure",
"required":["PolicyId"],
"members":{
"PolicyId":{"shape":"PolicyId"},
"NextToken":{"shape":"PaginationToken"},
"MaxResults":{"shape":"PaginationMaxResults"}
}
},
"ListComplianceStatusResponse":{
"type":"structure",
"members":{
"PolicyComplianceStatusList":{"shape":"PolicyComplianceStatusList"},
"NextToken":{"shape":"PaginationToken"}
}
},
"ListPoliciesRequest":{
"type":"structure",
"members":{
"NextToken":{"shape":"PaginationToken"},
"MaxResults":{"shape":"PaginationMaxResults"}
}
},
"ListPoliciesResponse":{
"type":"structure",
"members":{
"PolicyList":{"shape":"PolicySummaryList"},
"NextToken":{"shape":"PaginationToken"}
}
},
"ManagedServiceData":{
"type":"string",
"max":1024,
"min":1
},
"PaginationMaxResults":{
"type":"integer",
"max":100,
"min":1
},
"PaginationToken":{
"type":"string",
"min":1
},
"Policy":{
"type":"structure",
"required":[
"PolicyName",
"SecurityServicePolicyData",
"ResourceType",
"ExcludeResourceTags",
"RemediationEnabled"
],
"members":{
"PolicyId":{"shape":"PolicyId"},
"PolicyName":{"shape":"ResourceName"},
"PolicyUpdateToken":{"shape":"PolicyUpdateToken"},
"SecurityServicePolicyData":{"shape":"SecurityServicePolicyData"},
"ResourceType":{"shape":"ResourceType"},
"ResourceTags":{"shape":"ResourceTags"},
"ExcludeResourceTags":{"shape":"Boolean"},
"RemediationEnabled":{"shape":"Boolean"}
}
},
"PolicyComplianceDetail":{
"type":"structure",
"members":{
"PolicyOwner":{"shape":"AWSAccountId"},
"PolicyId":{"shape":"PolicyId"},
"MemberAccount":{"shape":"AWSAccountId"},
"Violators":{"shape":"ComplianceViolators"},
"EvaluationLimitExceeded":{"shape":"Boolean"},
"ExpiredAt":{"shape":"TimeStamp"}
}
},
"PolicyComplianceStatus":{
"type":"structure",
"members":{
"PolicyOwner":{"shape":"AWSAccountId"},
"PolicyId":{"shape":"PolicyId"},
"PolicyName":{"shape":"ResourceName"},
"MemberAccount":{"shape":"AWSAccountId"},
"EvaluationResults":{"shape":"EvaluationResults"},
"LastUpdated":{"shape":"TimeStamp"}
}
},
"PolicyComplianceStatusList":{
"type":"list",
"member":{"shape":"PolicyComplianceStatus"}
},
"PolicyComplianceStatusType":{
"type":"string",
"enum":[
"COMPLIANT",
"NON_COMPLIANT"
]
},
"PolicyId":{
"type":"string",
"max":36,
"min":36
},
"PolicySummary":{
"type":"structure",
"members":{
"PolicyArn":{"shape":"ResourceArn"},
"PolicyId":{"shape":"PolicyId"},
"PolicyName":{"shape":"ResourceName"},
"ResourceType":{"shape":"ResourceType"},
"SecurityServiceType":{"shape":"SecurityServiceType"},
"RemediationEnabled":{"shape":"Boolean"}
}
},
"PolicySummaryList":{
"type":"list",
"member":{"shape":"PolicySummary"}
},
"PolicyUpdateToken":{
"type":"string",
"max":1024,
"min":1
},
"PutNotificationChannelRequest":{
"type":"structure",
"required":[
"SnsTopicArn",
"SnsRoleName"
],
"members":{
"SnsTopicArn":{"shape":"ResourceArn"},
"SnsRoleName":{"shape":"ResourceArn"}
}
},
"PutPolicyRequest":{
"type":"structure",
"required":["Policy"],
"members":{
"Policy":{"shape":"Policy"}
}
},
"PutPolicyResponse":{
"type":"structure",
"members":{
"Policy":{"shape":"Policy"},
"PolicyArn":{"shape":"ResourceArn"}
}
},
"ResourceArn":{
"type":"string",
"max":1024,
"min":1
},
"ResourceCount":{
"type":"long",
"min":0
},
"ResourceId":{
"type":"string",
"max":1024,
"min":1
},
"ResourceName":{
"type":"string",
"max":128,
"min":1
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"ResourceTag":{
"type":"structure",
"required":["Key"],
"members":{
"Key":{"shape":"TagKey"},
"Value":{"shape":"TagValue"}
}
},
"ResourceTags":{
"type":"list",
"member":{"shape":"ResourceTag"},
"max":8,
"min":0
},
"ResourceType":{
"type":"string",
"max":128,
"min":1
},
"SecurityServicePolicyData":{
"type":"structure",
"required":["Type"],
"members":{
"Type":{"shape":"SecurityServiceType"},
"ManagedServiceData":{"shape":"ManagedServiceData"}
}
},
"SecurityServiceType":{
"type":"string",
"enum":["WAF"]
},
"TagKey":{
"type":"string",
"max":128,
"min":1,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
},
"TagValue":{
"type":"string",
"max":256,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
},
"TimeStamp":{"type":"timestamp"},
"ViolationReason":{
"type":"string",
"enum":[
"WEB_ACL_MISSING_RULE_GROUP",
"RESOURCE_MISSING_WEB_ACL",
"RESOURCE_INCORRECT_WEB_ACL"
]
}
}
}

371
vendor/github.com/aws/aws-sdk-go/models/apis/fms/2018-01-01/docs-2.json generated vendored Normal file
View File

@ -0,0 +1,371 @@
{
"version": "2.0",
"service": "<fullname>AWS Firewall Manager</fullname> <p>This is the <i>AWS Firewall Manager API Reference</i>. This guide is for developers who need detailed information about the AWS Firewall Manager API actions, data types, and errors. For detailed information about AWS Firewall Manager features, see the <a href=\"http://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html\">AWS Firewall Manager Developer Guide</a>.</p>",
"operations": {
"AssociateAdminAccount": "<p>Sets the AWS Firewall Manager administrator account. AWS Firewall Manager must be associated with a master account in AWS Organizations or associated with a member account that has the appropriate permissions. If the account ID that you submit is not an AWS Organizations master account, AWS Firewall Manager will set the appropriate permissions for the given member account.</p> <p>The account that you associate with AWS Firewall Manager is called the AWS Firewall manager administrator account. </p>",
"DeleteNotificationChannel": "<p>Deletes an AWS Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs.</p>",
"DeletePolicy": "<p>Permanently deletes an AWS Firewall Manager policy. </p>",
"DisassociateAdminAccount": "<p>Disassociates the account that has been set as the AWS Firewall Manager administrator account. You will need to submit an <code>AssociateAdminAccount</code> request to set a new account as the AWS Firewall administrator.</p>",
"GetAdminAccount": "<p>Returns the AWS Organizations master account that is associated with AWS Firewall Manager as the AWS Firewall Manager administrator.</p>",
"GetComplianceDetail": "<p>Returns detailed compliance information about the specified member account. Details include resources that are in and out of compliance with the specified policy. Resources are considered non-compliant if the specified policy has not been applied to them.</p>",
"GetNotificationChannel": "<p>Returns information about the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs.</p>",
"GetPolicy": "<p>Returns information about the specified AWS Firewall Manager policy.</p>",
"ListComplianceStatus": "<p>Returns an array of <code>PolicyComplianceStatus</code> objects in the response. Use <code>PolicyComplianceStatus</code> to get a summary of which member accounts are protected by the specified policy. </p>",
"ListPolicies": "<p>Returns an array of <code>PolicySummary</code> objects in the response.</p>",
"PutNotificationChannel": "<p>Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs.</p>",
"PutPolicy": "<p>Creates an AWS Firewall Manager policy.</p>"
},
"shapes": {
"AWSAccountId": {
"base": null,
"refs": {
"AssociateAdminAccountRequest$AdminAccount": "<p>The AWS account ID to associate with AWS Firewall Manager as the AWS Firewall Manager administrator account. This can be an AWS Organizations master account or a member account. For more information about AWS Organizations and master accounts, see <a href=\"https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts.html\">Managing the AWS Accounts in Your Organization</a>.</p>",
"GetAdminAccountResponse$AdminAccount": "<p>The AWS account that is set as the AWS Firewall Manager administrator.</p>",
"GetComplianceDetailRequest$MemberAccount": "<p>The AWS account that owns the resources that you want to get the details for.</p>",
"PolicyComplianceDetail$PolicyOwner": "<p>The AWS account that created the AWS Firewall Manager policy.</p>",
"PolicyComplianceDetail$MemberAccount": "<p>The AWS account ID.</p>",
"PolicyComplianceStatus$PolicyOwner": "<p>The AWS account that created the AWS Firewall Manager policy.</p>",
"PolicyComplianceStatus$MemberAccount": "<p>The member account ID.</p>"
}
},
"AssociateAdminAccountRequest": {
"base": null,
"refs": {
}
},
"Boolean": {
"base": null,
"refs": {
"EvaluationResult$EvaluationLimitExceeded": "<p>Indicates that over 100 resources are non-compliant with the AWS Firewall Manager policy.</p>",
"Policy$ExcludeResourceTags": "<p>If set to <code>True</code>, resources with the tags that are specified in the <code>ResourceTag</code> array are not protected by the policy. If set to <code>False</code>, and the <code>ResourceTag</code> array is not null, only resources with the specified tags are associated with the policy.</p>",
"Policy$RemediationEnabled": "<p>Indicates if the policy should be automatically applied to new resources.</p>",
"PolicyComplianceDetail$EvaluationLimitExceeded": "<p>Indicates if over 100 resources are non-compliant with the AWS Firewall Manager policy.</p>",
"PolicySummary$RemediationEnabled": "<p>Indicates if the policy should be automatically applied to new resources.</p>"
}
},
"ComplianceViolator": {
"base": "<p>Details of the resource that is not protected by the policy.</p>",
"refs": {
"ComplianceViolators$member": null
}
},
"ComplianceViolators": {
"base": null,
"refs": {
"PolicyComplianceDetail$Violators": "<p>An array of resources that are not protected by the policy.</p>"
}
},
"DeleteNotificationChannelRequest": {
"base": null,
"refs": {
}
},
"DeletePolicyRequest": {
"base": null,
"refs": {
}
},
"DisassociateAdminAccountRequest": {
"base": null,
"refs": {
}
},
"ErrorMessage": {
"base": null,
"refs": {
"InternalErrorException$Message": null,
"InvalidInputException$Message": null,
"InvalidOperationException$Message": null,
"LimitExceededException$Message": null,
"ResourceNotFoundException$Message": null
}
},
"EvaluationResult": {
"base": "<p>Describes the compliance status for the account. An account is considered non-compliant if it includes resources that are not protected by the specified policy.</p>",
"refs": {
"EvaluationResults$member": null
}
},
"EvaluationResults": {
"base": null,
"refs": {
"PolicyComplianceStatus$EvaluationResults": "<p>An array of <code>EvaluationResult</code> objects.</p>"
}
},
"GetAdminAccountRequest": {
"base": null,
"refs": {
}
},
"GetAdminAccountResponse": {
"base": null,
"refs": {
}
},
"GetComplianceDetailRequest": {
"base": null,
"refs": {
}
},
"GetComplianceDetailResponse": {
"base": null,
"refs": {
}
},
"GetNotificationChannelRequest": {
"base": null,
"refs": {
}
},
"GetNotificationChannelResponse": {
"base": null,
"refs": {
}
},
"GetPolicyRequest": {
"base": null,
"refs": {
}
},
"GetPolicyResponse": {
"base": null,
"refs": {
}
},
"InternalErrorException": {
"base": "<p>The operation failed because of a system problem, even though the request was valid. Retry your request.</p>",
"refs": {
}
},
"InvalidInputException": {
"base": "<p>The parameters of the request were invalid.</p>",
"refs": {
}
},
"InvalidOperationException": {
"base": "<p>The operation failed because there was nothing to do. For example, you might have submitted an <code>AssociateAdminAccount</code> request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.</p>",
"refs": {
}
},
"LimitExceededException": {
"base": "<p>The operation exceeds a resource limit, for example, the maximum number of <code>policy</code> objects that you can create for an AWS account. For more information, see <a href=\"http://docs.aws.amazon.com/waf/latest/developerguide/fms-limits.html\">Firewall Manager Limits</a> in the <i>AWS WAF Developer Guide</i>.</p>",
"refs": {
}
},
"ListComplianceStatusRequest": {
"base": null,
"refs": {
}
},
"ListComplianceStatusResponse": {
"base": null,
"refs": {
}
},
"ListPoliciesRequest": {
"base": null,
"refs": {
}
},
"ListPoliciesResponse": {
"base": null,
"refs": {
}
},
"ManagedServiceData": {
"base": null,
"refs": {
"SecurityServicePolicyData$ManagedServiceData": "<p>Details about the service. This contains <code>WAF</code> data in JSON format, as shown in the following example:</p> <p> <code>ManagedServiceData\": \"{\\\"type\\\": \\\"WAF\\\", \\\"ruleGroups\\\": [{\\\"id\\\": \\\"12345678-1bcd-9012-efga-0987654321ab\\\", \\\"overrideAction\\\" : {\\\"type\\\": \\\"COUNT\\\"}}], \\\"defaultAction\\\": {\\\"type\\\": \\\"BLOCK\\\"}}</code> </p>"
}
},
"PaginationMaxResults": {
"base": null,
"refs": {
"ListComplianceStatusRequest$MaxResults": "<p>Specifies the number of <code>PolicyComplianceStatus</code> objects that you want AWS Firewall Manager to return for this request. If you have more <code>PolicyComplianceStatus</code> objects than the number that you specify for <code>MaxResults</code>, the response includes a <code>NextToken</code> value that you can use to get another batch of <code>PolicyComplianceStatus</code> objects.</p>",
"ListPoliciesRequest$MaxResults": "<p>Specifies the number of <code>PolicySummary</code> objects that you want AWS Firewall Manager to return for this request. If you have more <code>PolicySummary</code> objects than the number that you specify for <code>MaxResults</code>, the response includes a <code>NextToken</code> value that you can use to get another batch of <code>PolicySummary</code> objects.</p>"
}
},
"PaginationToken": {
"base": null,
"refs": {
"ListComplianceStatusRequest$NextToken": "<p>If you specify a value for <code>MaxResults</code> and you have more <code>PolicyComplianceStatus</code> objects than the number that you specify for <code>MaxResults</code>, AWS Firewall Manager returns a <code>NextToken</code> value in the response that allows you to list another group of <code>PolicyComplianceStatus</code> objects. For the second and subsequent <code>ListComplianceStatus</code> requests, specify the value of <code>NextToken</code> from the previous response to get information about another batch of <code>PolicyComplianceStatus</code> objects.</p>",
"ListComplianceStatusResponse$NextToken": "<p>If you have more <code>PolicyComplianceStatus</code> objects than the number that you specified for <code>MaxResults</code> in the request, the response includes a <code>NextToken</code> value. To list more <code>PolicyComplianceStatus</code> objects, submit another <code>ListComplianceStatus</code> request, and specify the <code>NextToken</code> value from the response in the <code>NextToken</code> value in the next request.</p>",
"ListPoliciesRequest$NextToken": "<p>If you specify a value for <code>MaxResults</code> and you have more <code>PolicySummary</code> objects than the number that you specify for <code>MaxResults</code>, AWS Firewall Manager returns a <code>NextToken</code> value in the response that allows you to list another group of <code>PolicySummary</code> objects. For the second and subsequent <code>ListPolicies</code> requests, specify the value of <code>NextToken</code> from the previous response to get information about another batch of <code>PolicySummary</code> objects.</p>",
"ListPoliciesResponse$NextToken": "<p>If you have more <code>PolicySummary</code> objects than the number that you specified for <code>MaxResults</code> in the request, the response includes a <code>NextToken</code> value. To list more <code>PolicySummary</code> objects, submit another <code>ListPolicies</code> request, and specify the <code>NextToken</code> value from the response in the <code>NextToken</code> value in the next request.</p>"
}
},
"Policy": {
"base": "<p>An AWS Firewall Manager policy.</p>",
"refs": {
"GetPolicyResponse$Policy": "<p>Information about the specified AWS Firewall Manager policy.</p>",
"PutPolicyRequest$Policy": "<p>The details of the AWS Firewall Manager policy to be created.</p>",
"PutPolicyResponse$Policy": "<p>The details of the AWS Firewall Manager policy that was created.</p>"
}
},
"PolicyComplianceDetail": {
"base": "<p>Describes the non-compliant resources in a member account for a specific AWS Firewall Manager policy. A maximum of 100 entries are displayed. If more than 100 resources are non-compliant, <code>EvaluationLimitExceeded</code> is set to <code>True</code>.</p>",
"refs": {
"GetComplianceDetailResponse$PolicyComplianceDetail": "<p>Information about the resources and the policy that you specified in the <code>GetComplianceDetail</code> request.</p>"
}
},
"PolicyComplianceStatus": {
"base": "<p>Indicates whether the account is compliant with the specified policy. An account is considered non-compliant if it includes resources that are not protected by the policy.</p>",
"refs": {
"PolicyComplianceStatusList$member": null
}
},
"PolicyComplianceStatusList": {
"base": null,
"refs": {
"ListComplianceStatusResponse$PolicyComplianceStatusList": "<p>An array of <code>PolicyComplianceStatus</code> objects.</p>"
}
},
"PolicyComplianceStatusType": {
"base": null,
"refs": {
"EvaluationResult$ComplianceStatus": "<p>Describes an AWS account's compliance with the AWS Firewall Manager policy.</p>"
}
},
"PolicyId": {
"base": null,
"refs": {
"DeletePolicyRequest$PolicyId": "<p>The ID of the policy that you want to delete. <code>PolicyId</code> is returned by <code>PutPolicy</code> and by <code>ListPolicies</code>.</p>",
"GetComplianceDetailRequest$PolicyId": "<p>The ID of the policy that you want to get the details for. <code>PolicyId</code> is returned by <code>PutPolicy</code> and by <code>ListPolicies</code>.</p>",
"GetPolicyRequest$PolicyId": "<p>The ID of the AWS Firewall Manager policy that you want the details for.</p>",
"ListComplianceStatusRequest$PolicyId": "<p>The ID of the AWS Firewall Manager policy that you want the details for.</p>",
"Policy$PolicyId": "<p>The ID of the AWS Firewall Manager policy.</p>",
"PolicyComplianceDetail$PolicyId": "<p>The ID of the AWS Firewall Manager policy.</p>",
"PolicyComplianceStatus$PolicyId": "<p>The ID of the AWS Firewall Manager policy.</p>",
"PolicySummary$PolicyId": "<p>The ID of the specified policy.</p>"
}
},
"PolicySummary": {
"base": "<p>Details of the AWS Firewall Manager policy. </p>",
"refs": {
"PolicySummaryList$member": null
}
},
"PolicySummaryList": {
"base": null,
"refs": {
"ListPoliciesResponse$PolicyList": "<p>An array of <code>PolicySummary</code> objects.</p>"
}
},
"PolicyUpdateToken": {
"base": null,
"refs": {
"Policy$PolicyUpdateToken": "<p>A unique identifier for each update to the policy. When issuing a <code>PutPolicy</code> request, the <code>PolicyUpdateToken</code> in the request must match the <code>PolicyUpdateToken</code> of the current policy version. To get the <code>PolicyUpdateToken</code> of the current policy version, use a <code>GetPolicy</code> request.</p>"
}
},
"PutNotificationChannelRequest": {
"base": null,
"refs": {
}
},
"PutPolicyRequest": {
"base": null,
"refs": {
}
},
"PutPolicyResponse": {
"base": null,
"refs": {
}
},
"ResourceArn": {
"base": null,
"refs": {
"GetNotificationChannelResponse$SnsTopicArn": "<p>The SNS topic that records AWS Firewall Manager activity. </p>",
"GetNotificationChannelResponse$SnsRoleName": "<p>The IAM role that is used by AWS Firewall Manager to record activity to SNS.</p>",
"GetPolicyResponse$PolicyArn": "<p>The Amazon Resource Name (ARN) of the specified policy.</p>",
"PolicySummary$PolicyArn": "<p>The Amazon Resource Name (ARN) of the specified policy.</p>",
"PutNotificationChannelRequest$SnsTopicArn": "<p>The Amazon Resource Name (ARN) of the SNS topic that collects notifications from AWS Firewall Manager.</p>",
"PutNotificationChannelRequest$SnsRoleName": "<p>The Amazon Resource Name (ARN) of the IAM role that allows Amazon SNS to record AWS Firewall Manager activity. </p>",
"PutPolicyResponse$PolicyArn": "<p>The Amazon Resource Name (ARN) of the policy that was created.</p>"
}
},
"ResourceCount": {
"base": null,
"refs": {
"EvaluationResult$ViolatorCount": "<p>Number of resources that are non-compliant with the specified policy. A resource is considered non-compliant if it is not associated with the specified policy.</p>"
}
},
"ResourceId": {
"base": null,
"refs": {
"ComplianceViolator$ResourceId": "<p>The resource ID.</p>"
}
},
"ResourceName": {
"base": null,
"refs": {
"Policy$PolicyName": "<p>The friendly name of the AWS Firewall Manager policy.</p>",
"PolicyComplianceStatus$PolicyName": "<p>The friendly name of the AWS Firewall Manager policy.</p>",
"PolicySummary$PolicyName": "<p>The friendly name of the specified policy.</p>"
}
},
"ResourceNotFoundException": {
"base": "<p>The specified resource was not found.</p>",
"refs": {
}
},
"ResourceTag": {
"base": "<p>The resource tags that AWS Firewall Manager uses to determine if a particular resource should be included or excluded from protection by the AWS Firewall Manager policy. Tags enable you to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. Tags are combined with an \"OR.\" That is, if you add more than one tag, if any of the tags matches, the resource is considered a match for the include or exclude. <a href=\"https://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/tag-editor.html\">Working with Tag Editor</a>.</p>",
"refs": {
"ResourceTags$member": null
}
},
"ResourceTags": {
"base": null,
"refs": {
"Policy$ResourceTags": "<p>An array of <code>ResourceTag</code> objects.</p>"
}
},
"ResourceType": {
"base": null,
"refs": {
"ComplianceViolator$ResourceType": "<p>The resource type. This is in the format shown in <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html\">AWS Resource Types Reference</a>. Valid values are <code>AWS::ElasticLoadBalancingV2::LoadBalancer</code> or <code>AWS::CloudFront::Distribution</code>.</p>",
"Policy$ResourceType": "<p>The type of resource to protect with the policy, either an Application Load Balancer or a CloudFront distribution. This is in the format shown in <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html\">AWS Resource Types Reference</a>. Valid values are <code>AWS::ElasticLoadBalancingV2::LoadBalancer</code> or <code>AWS::CloudFront::Distribution</code>.</p>",
"PolicySummary$ResourceType": "<p>The type of resource to protect with the policy, either an Application Load Balancer or a CloudFront distribution. This is in the format shown in <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html\">AWS Resource Types Reference</a>. Valid values are <code>AWS::ElasticLoadBalancingV2::LoadBalancer</code> or <code>AWS::CloudFront::Distribution</code>.</p>"
}
},
"SecurityServicePolicyData": {
"base": "<p>Details about the security service that is being used to protect the resources.</p>",
"refs": {
"Policy$SecurityServicePolicyData": "<p>Details about the security service that is being used to protect the resources.</p>"
}
},
"SecurityServiceType": {
"base": null,
"refs": {
"PolicySummary$SecurityServiceType": "<p>The service that the policy is using to protect the resources. This value is <code>WAF</code>.</p>",
"SecurityServicePolicyData$Type": "<p>The service that the policy is using to protect the resources. This value is <code>WAF</code>.</p>"
}
},
"TagKey": {
"base": null,
"refs": {
"ResourceTag$Key": "<p>The resource tag key.</p>"
}
},
"TagValue": {
"base": null,
"refs": {
"ResourceTag$Value": "<p>The resource tag value.</p>"
}
},
"TimeStamp": {
"base": null,
"refs": {
"PolicyComplianceDetail$ExpiredAt": "<p>A time stamp that indicates when the returned information should be considered out-of-date.</p>",
"PolicyComplianceStatus$LastUpdated": "<p>Time stamp of the last update to the <code>EvaluationResult</code> objects.</p>"
}
},
"ViolationReason": {
"base": null,
"refs": {
"ComplianceViolator$ViolationReason": "<p>The reason that the resource is not protected by the policy.</p>"
}
}
}
}

5
vendor/github.com/aws/aws-sdk-go/models/apis/fms/2018-01-01/examples-1.json generated vendored Normal file
View File

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

4
vendor/github.com/aws/aws-sdk-go/models/apis/fms/2018-01-01/paginators-1.json generated vendored Normal file
View File

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

2
vendor/github.com/aws/aws-sdk-go/models/apis/glacier/2012-06-01/docs-2.json generated vendored
View File

@ -11,7 +11,7 @@
"DeleteArchive": "<p>This operation deletes an archive from a vault. Subsequent requests to initiate a retrieval of this archive will fail. Archive retrievals that are in progress for this archive ID may or may not succeed according to the following scenarios:</p> <ul> <li> <p>If the archive retrieval job is actively preparing the data for download when Amazon Glacier receives the delete archive request, the archival retrieval operation might fail.</p> </li> <li> <p>If the archive retrieval job has successfully prepared the archive for download when Amazon Glacier receives the delete archive request, you will be able to download the output.</p> </li> </ul> <p>This operation is idempotent. Attempting to delete an already-deleted archive does not result in an error.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p> For conceptual information and underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/deleting-an-archive.html\">Deleting an Archive in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-delete.html\">Delete Archive</a> in the <i>Amazon Glacier Developer Guide</i>. </p>",
"DeleteVault": "<p>This operation deletes a vault. Amazon Glacier will delete a vault only if there are no archives in the vault as of the last inventory and there have been no writes to the vault since the last inventory. If either of these conditions is not satisfied, the vault deletion fails (that is, the vault is not removed) and Amazon Glacier returns an error. You can use <a>DescribeVault</a> to return the number of archives in a vault, and you can use <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html\">Initiate a Job (POST jobs)</a> to initiate a new inventory retrieval for a vault. The inventory contains the archive IDs you use to delete archives using <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-archive-delete.html\">Delete Archive (DELETE archive)</a>.</p> <p>This operation is idempotent.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p> For conceptual information and underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/deleting-vaults.html\">Deleting a Vault in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-delete.html\">Delete Vault </a> in the <i>Amazon Glacier Developer Guide</i>. </p>",
"DeleteVaultAccessPolicy": "<p>This operation deletes the access policy associated with the specified vault. The operation is eventually consistent; that is, it might take some time for Amazon Glacier to completely remove the access policy, and you might still see the effect of the policy for a short time after you send the delete request.</p> <p>This operation is idempotent. You can invoke delete multiple times, even if there is no policy associated with the vault. For more information about vault access policies, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html\">Amazon Glacier Access Control with Vault Access Policies</a>. </p>",
"DeleteVaultNotifications": "<p>This operation deletes the notification configuration set for a vault. The operation is eventually consistent; that is, it might take some time for Amazon Glacier to completely disable the notifications and you might still receive some notifications for a short time after you send the delete request.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p> For conceptual information and underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html\">Configuring Vault Notifications in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-delete.html\">Delete Vault Notification Configuration </a> in the Amazon Glacier Developer Guide. </p>",
"DeleteVaultNotifications": "<p>This operation deletes the notification configuration set for a vault. The operation is eventually consistent; that is, it might take some time for Amazon Glacier to completely disable the notifications and you might still receive some notifications for a short time after you send the delete request.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p> For conceptual information and underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/configuring-notifications.html\">Configuring Vault Notifications in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-notifications-delete.html\">Delete Vault Notification Configuration </a> in the Amazon Glacier Developer Guide. </p>",
"DescribeJob": "<p>This operation returns information about a job you previously initiated, including the job initiation date, the user who initiated the job, the job status code/message and the Amazon SNS topic to notify after Amazon Glacier completes the job. For more information about initiating a job, see <a>InitiateJob</a>. </p> <note> <p>This operation enables you to check the status of your job. However, it is strongly recommended that you set up an Amazon SNS topic and specify it in your initiate job request so that Amazon Glacier can notify the topic after it completes the job.</p> </note> <p>A job ID will not expire for at least 24 hours after Amazon Glacier completes the job.</p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p> For more information about using this operation, see the documentation for the underlying REST API <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-describe-job-get.html\">Describe Job</a> in the <i>Amazon Glacier Developer Guide</i>. </p>",
"DescribeVault": "<p>This operation returns information about a vault, including the vault's Amazon Resource Name (ARN), the date the vault was created, the number of archives it contains, and the total size of all the archives in the vault. The number of archives and their total size are as of the last inventory generation. This means that if you add or remove an archive from a vault, and then immediately use Describe Vault, the change in contents will not be immediately reflected. If you want to retrieve the latest inventory of the vault, use <a>InitiateJob</a>. Amazon Glacier generates vault inventories approximately daily. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/vault-inventory.html\">Downloading a Vault Inventory in Amazon Glacier</a>. </p> <p>An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/using-iam-with-amazon-glacier.html\">Access Control Using AWS Identity and Access Management (IAM)</a>.</p> <p>For conceptual information and underlying REST API, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/retrieving-vault-info.html\">Retrieving Vault Metadata in Amazon Glacier</a> and <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/api-vault-get.html\">Describe Vault </a> in the <i>Amazon Glacier Developer Guide</i>. </p>",
"GetDataRetrievalPolicy": "<p>This operation returns the current data retrieval policy for the account and region specified in the GET request. For more information about data retrieval policies, see <a href=\"http://docs.aws.amazon.com/amazonglacier/latest/dev/data-retrieval-policy.html\">Amazon Glacier Data Retrieval Policies</a>.</p>",

34
vendor/github.com/aws/aws-sdk-go/models/apis/glue/2017-03-31/api-2.json generated vendored
View File

@ -1190,7 +1190,8 @@
"type":"structure",
"members":{
"JobName":{"shape":"NameString"},
"Arguments":{"shape":"GenericMap"}
"Arguments":{"shape":"GenericMap"},
"Timeout":{"shape":"Timeout"}
}
},
"ActionList":{
@ -1779,8 +1780,7 @@
"type":"structure",
"required":[
"EndpointName",
"RoleArn",
"PublicKey"
"RoleArn"
],
"members":{
"EndpointName":{"shape":"GenericString"},
@ -1843,7 +1843,8 @@
"DefaultArguments":{"shape":"GenericMap"},
"Connections":{"shape":"ConnectionsList"},
"MaxRetries":{"shape":"MaxRetries"},
"AllocatedCapacity":{"shape":"IntegerValue"}
"AllocatedCapacity":{"shape":"IntegerValue"},
"Timeout":{"shape":"Timeout"}
}
},
"CreateJobResponse":{
@ -1927,7 +1928,8 @@
"Schedule":{"shape":"GenericString"},
"Predicate":{"shape":"Predicate"},
"Actions":{"shape":"ActionList"},
"Description":{"shape":"DescriptionString"}
"Description":{"shape":"DescriptionString"},
"StartOnCreation":{"shape":"BooleanValue"}
}
},
"CreateTriggerResponse":{
@ -2200,6 +2202,7 @@
"SecurityGroupIds":{"shape":"StringList"},
"SubnetId":{"shape":"GenericString"},
"YarnEndpointAddress":{"shape":"GenericString"},
"PrivateAddress":{"shape":"GenericString"},
"ZeppelinRemoteSparkInterpreterPort":{"shape":"IntegerValue"},
"PublicAddress":{"shape":"GenericString"},
"Status":{"shape":"GenericString"},
@ -2841,7 +2844,8 @@
"DefaultArguments":{"shape":"GenericMap"},
"Connections":{"shape":"ConnectionsList"},
"MaxRetries":{"shape":"MaxRetries"},
"AllocatedCapacity":{"shape":"IntegerValue"}
"AllocatedCapacity":{"shape":"IntegerValue"},
"Timeout":{"shape":"Timeout"}
}
},
"JobBookmarkEntry":{
@ -2881,7 +2885,9 @@
"Arguments":{"shape":"GenericMap"},
"ErrorMessage":{"shape":"ErrorString"},
"PredecessorRuns":{"shape":"PredecessorList"},
"AllocatedCapacity":{"shape":"IntegerValue"}
"AllocatedCapacity":{"shape":"IntegerValue"},
"ExecutionTime":{"shape":"IntegerValue"},
"Timeout":{"shape":"Timeout"}
}
},
"JobRunList":{
@ -2896,7 +2902,8 @@
"STOPPING",
"STOPPED",
"SUCCEEDED",
"FAILED"
"FAILED",
"TIMEOUT"
]
},
"JobUpdate":{
@ -2910,7 +2917,8 @@
"DefaultArguments":{"shape":"GenericMap"},
"Connections":{"shape":"ConnectionsList"},
"MaxRetries":{"shape":"MaxRetries"},
"AllocatedCapacity":{"shape":"IntegerValue"}
"AllocatedCapacity":{"shape":"IntegerValue"},
"Timeout":{"shape":"Timeout"}
}
},
"JsonClassifier":{
@ -3360,7 +3368,8 @@
"JobName":{"shape":"NameString"},
"JobRunId":{"shape":"IdString"},
"Arguments":{"shape":"GenericMap"},
"AllocatedCapacity":{"shape":"IntegerValue"}
"AllocatedCapacity":{"shape":"IntegerValue"},
"Timeout":{"shape":"Timeout"}
}
},
"StartJobRunResponse":{
@ -3524,6 +3533,11 @@
"type":"list",
"member":{"shape":"TableVersionError"}
},
"Timeout":{
"type":"integer",
"box":true,
"min":1
},
"Timestamp":{"type":"timestamp"},
"TimestampValue":{"type":"timestamp"},
"Token":{"type":"string"},

116
vendor/github.com/aws/aws-sdk-go/models/apis/glue/2017-03-31/docs-2.json generated vendored
View File

@ -8,13 +8,13 @@
"BatchDeleteTable": "<p>Deletes multiple tables at once.</p>",
"BatchDeleteTableVersion": "<p>Deletes a specified batch of versions of a table.</p>",
"BatchGetPartition": "<p>Retrieves partitions in a batch request.</p>",
"BatchStopJobRun": "<p>Stops one or more job runs for a specified Job.</p>",
"BatchStopJobRun": "<p>Stops one or more job runs for a specified job definition.</p>",
"CreateClassifier": "<p>Creates a classifier in the user's account. This may be a <code>GrokClassifier</code>, an <code>XMLClassifier</code>, or abbrev <code>JsonClassifier</code>, depending on which field of the request is present.</p>",
"CreateConnection": "<p>Creates a connection definition in the Data Catalog.</p>",
"CreateCrawler": "<p>Creates a new crawler with specified targets, role, configuration, and optional schedule. At least one crawl target must be specified, in either the <i>s3Targets</i> or the <i>jdbcTargets</i> field.</p>",
"CreateDatabase": "<p>Creates a new database in a Data Catalog.</p>",
"CreateDevEndpoint": "<p>Creates a new DevEndpoint.</p>",
"CreateJob": "<p>Creates a new job.</p>",
"CreateJob": "<p>Creates a new job definition.</p>",
"CreatePartition": "<p>Creates a new partition.</p>",
"CreateScript": "<p>Transforms a directed acyclic graph (DAG) into code.</p>",
"CreateTable": "<p>Creates a new table definition in the Data Catalog.</p>",
@ -25,7 +25,7 @@
"DeleteCrawler": "<p>Removes a specified crawler from the Data Catalog, unless the crawler state is <code>RUNNING</code>.</p>",
"DeleteDatabase": "<p>Removes a specified Database from a Data Catalog.</p>",
"DeleteDevEndpoint": "<p>Deletes a specified DevEndpoint.</p>",
"DeleteJob": "<p>Deletes a specified job. If the job is not found, no exception is thrown.</p>",
"DeleteJob": "<p>Deletes a specified job definition. If the job definition is not found, no exception is thrown.</p>",
"DeletePartition": "<p>Deletes a specified partition.</p>",
"DeleteTable": "<p>Removes a table definition from the Data Catalog.</p>",
"DeleteTableVersion": "<p>Deletes a specified version of a table.</p>",
@ -46,8 +46,8 @@
"GetDevEndpoints": "<p>Retrieves all the DevEndpoints in this AWS account.</p>",
"GetJob": "<p>Retrieves an existing job definition.</p>",
"GetJobRun": "<p>Retrieves the metadata for a given job run.</p>",
"GetJobRuns": "<p>Retrieves metadata for all runs of a given job.</p>",
"GetJobs": "<p>Retrieves all current jobs.</p>",
"GetJobRuns": "<p>Retrieves metadata for all runs of a given job definition.</p>",
"GetJobs": "<p>Retrieves all current job definitions.</p>",
"GetMapping": "<p>Creates mappings.</p>",
"GetPartition": "<p>Retrieves information about a specified partition.</p>",
"GetPartitions": "<p>Retrieves information about the partitions in a table.</p>",
@ -64,7 +64,7 @@
"ResetJobBookmark": "<p>Resets a bookmark entry.</p>",
"StartCrawler": "<p>Starts a crawl using the specified crawler, regardless of what is scheduled. If the crawler is already running, does nothing.</p>",
"StartCrawlerSchedule": "<p>Changes the schedule state of the specified crawler to <code>SCHEDULED</code>, unless the crawler is already running or the schedule state is already <code>SCHEDULED</code>.</p>",
"StartJobRun": "<p>Runs a job.</p>",
"StartJobRun": "<p>Starts a job run using a job definition.</p>",
"StartTrigger": "<p>Starts an existing trigger. See <a href=\"http://docs.aws.amazon.com/glue/latest/dg/trigger-job.html\">Triggering Jobs</a> for information about how different types of trigger are started.</p>",
"StopCrawler": "<p>If the specified crawler is running, stops the crawl.</p>",
"StopCrawlerSchedule": "<p>Sets the schedule state of the specified crawler to <code>NOT_SCHEDULED</code>, but does not stop the crawler if it is already running.</p>",
@ -198,7 +198,7 @@
}
},
"BatchStopJobRunError": {
"base": "<p>Records an error that occurred when attempting to stop a specified JobRun.</p>",
"base": "<p>Records an error that occurred when attempting to stop a specified job run.</p>",
"refs": {
"BatchStopJobRunErrorList$member": null
}
@ -212,7 +212,7 @@
"BatchStopJobRunJobRunIdList": {
"base": null,
"refs": {
"BatchStopJobRunRequest$JobRunIds": "<p>A list of the JobRunIds that should be stopped for that Job.</p>"
"BatchStopJobRunRequest$JobRunIds": "<p>A list of the JobRunIds that should be stopped for that job definition.</p>"
}
},
"BatchStopJobRunRequest": {
@ -256,6 +256,7 @@
"BooleanValue": {
"base": null,
"refs": {
"CreateTriggerRequest$StartOnCreation": "<p>Set to true to start SCHEDULED and CONDITIONAL triggers when created. True not supported for ON_DEMAND triggers.</p>",
"GetJobRunRequest$PredecessorsIncluded": "<p>True if a list of predecessor runs should be returned.</p>",
"UpdateDevEndpointRequest$UpdateEtlLibraries": "<p>True if the list of custom libraries to be loaded in the development endpoint needs to be updated, or False otherwise.</p>"
}
@ -914,13 +915,13 @@
"ConnectionInput$Description": "<p>Description of the connection.</p>",
"Crawler$Description": "<p>A description of the crawler.</p>",
"CreateCrawlerRequest$Description": "<p>A description of the new crawler.</p>",
"CreateJobRequest$Description": "<p>Description of the job.</p>",
"CreateJobRequest$Description": "<p>Description of the job being defined.</p>",
"CreateTriggerRequest$Description": "<p>A description of the new trigger.</p>",
"Database$Description": "<p>Description of the database.</p>",
"DatabaseInput$Description": "<p>Description of the database</p>",
"ErrorDetail$ErrorMessage": "<p>A message describing the error.</p>",
"Job$Description": "<p>Description of this job.</p>",
"JobUpdate$Description": "<p>Description of the job.</p>",
"Job$Description": "<p>Description of the job being defined.</p>",
"JobUpdate$Description": "<p>Description of the job being defined.</p>",
"LastCrawlInfo$ErrorMessage": "<p>If an error occurred, the error information about the last crawl.</p>",
"Table$Description": "<p>Description of the table.</p>",
"TableInput$Description": "<p>Description of the table.</p>",
@ -1011,12 +1012,12 @@
"GenericMap": {
"base": null,
"refs": {
"Action$Arguments": "<p>Arguments to be passed to the job.</p> <p>You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.</p> <p>For information about how to specify and consume your own Job arguments, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html\">Calling AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information about the key-value pairs that AWS Glue consumes to set up your job, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-glue-arguments.html\">Special Parameters Used by AWS Glue</a> topic in the developer guide.</p>",
"CreateJobRequest$DefaultArguments": "<p>The default arguments for this job.</p> <p>You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.</p> <p>For information about how to specify and consume your own Job arguments, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html\">Calling AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information about the key-value pairs that AWS Glue consumes to set up your job, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-glue-arguments.html\">Special Parameters Used by AWS Glue</a> topic in the developer guide.</p>",
"Job$DefaultArguments": "<p>The default arguments for this job, specified as name-value pairs.</p> <p>You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.</p> <p>For information about how to specify and consume your own Job arguments, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html\">Calling AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information about the key-value pairs that AWS Glue consumes to set up your job, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-glue-arguments.html\">Special Parameters Used by AWS Glue</a> topic in the developer guide.</p>",
"JobRun$Arguments": "<p>The job arguments associated with this run. These override equivalent default arguments set for the job.</p> <p>You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.</p> <p>For information about how to specify and consume your own job arguments, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html\">Calling AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information about the key-value pairs that AWS Glue consumes to set up your job, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-glue-arguments.html\">Special Parameters Used by AWS Glue</a> topic in the developer guide.</p>",
"JobUpdate$DefaultArguments": "<p>The default arguments for this job.</p> <p>You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.</p> <p>For information about how to specify and consume your own Job arguments, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html\">Calling AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information about the key-value pairs that AWS Glue consumes to set up your job, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-glue-arguments.html\">Special Parameters Used by AWS Glue</a> topic in the developer guide.</p>",
"StartJobRunRequest$Arguments": "<p>The job arguments specifically for this run. They override the equivalent default arguments set for the job itself.</p> <p>You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.</p> <p>For information about how to specify and consume your own Job arguments, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html\">Calling AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information about the key-value pairs that AWS Glue consumes to set up your job, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-glue-arguments.html\">Special Parameters Used by AWS Glue</a> topic in the developer guide.</p>"
"Action$Arguments": "<p>Arguments to be passed to the job.</p> <p>You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.</p> <p>For information about how to specify and consume your own Job arguments, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html\">Calling AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information about the key-value pairs that AWS Glue consumes to set up your job, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html\">Special Parameters Used by AWS Glue</a> topic in the developer guide.</p>",
"CreateJobRequest$DefaultArguments": "<p>The default arguments for this job.</p> <p>You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.</p> <p>For information about how to specify and consume your own Job arguments, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html\">Calling AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information about the key-value pairs that AWS Glue consumes to set up your job, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html\">Special Parameters Used by AWS Glue</a> topic in the developer guide.</p>",
"Job$DefaultArguments": "<p>The default arguments for this job, specified as name-value pairs.</p> <p>You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.</p> <p>For information about how to specify and consume your own Job arguments, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html\">Calling AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information about the key-value pairs that AWS Glue consumes to set up your job, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html\">Special Parameters Used by AWS Glue</a> topic in the developer guide.</p>",
"JobRun$Arguments": "<p>The job arguments associated with this run. These override equivalent default arguments set for the job.</p> <p>You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.</p> <p>For information about how to specify and consume your own job arguments, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html\">Calling AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information about the key-value pairs that AWS Glue consumes to set up your job, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html\">Special Parameters Used by AWS Glue</a> topic in the developer guide.</p>",
"JobUpdate$DefaultArguments": "<p>The default arguments for this job.</p> <p>You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.</p> <p>For information about how to specify and consume your own Job arguments, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html\">Calling AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information about the key-value pairs that AWS Glue consumes to set up your job, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html\">Special Parameters Used by AWS Glue</a> topic in the developer guide.</p>",
"StartJobRunRequest$Arguments": "<p>The job arguments specifically for this run. They override the equivalent default arguments set for in the job definition itself.</p> <p>You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.</p> <p>For information about how to specify and consume your own Job arguments, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html\">Calling AWS Glue APIs in Python</a> topic in the developer guide.</p> <p>For information about the key-value pairs that AWS Glue consumes to set up your job, see the <a href=\"http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html\">Special Parameters Used by AWS Glue</a> topic in the developer guide.</p>"
}
},
"GenericString": {
@ -1041,7 +1042,8 @@
"DevEndpoint$EndpointName": "<p>The name of the DevEndpoint.</p>",
"DevEndpoint$SubnetId": "<p>The subnet ID for this DevEndpoint.</p>",
"DevEndpoint$YarnEndpointAddress": "<p>The YARN endpoint address used by this DevEndpoint.</p>",
"DevEndpoint$PublicAddress": "<p>The public address used by this DevEndpoint.</p>",
"DevEndpoint$PrivateAddress": "<p>The private address used by this DevEndpoint.</p>",
"DevEndpoint$PublicAddress": "<p>The public VPC address used by this DevEndpoint.</p>",
"DevEndpoint$Status": "<p>The current status of this DevEndpoint.</p>",
"DevEndpoint$AvailabilityZone": "<p>The AWS availability zone where this DevEndpoint is located.</p>",
"DevEndpoint$VpcId": "<p>The ID of the virtual private cloud (VPC) used by this DevEndpoint.</p>",
@ -1060,7 +1062,7 @@
"GetJobRunsRequest$NextToken": "<p>A continuation token, if this is a continuation call.</p>",
"GetJobRunsResponse$NextToken": "<p>A continuation token, if not all reequested job runs have been returned.</p>",
"GetJobsRequest$NextToken": "<p>A continuation token, if this is a continuation call.</p>",
"GetJobsResponse$NextToken": "<p>A continuation token, if not all jobs have yet been returned.</p>",
"GetJobsResponse$NextToken": "<p>A continuation token, if not all job definitions have yet been returned.</p>",
"GetTriggersRequest$NextToken": "<p>A continuation token, if this is a continuation call.</p>",
"GetTriggersResponse$NextToken": "<p>A continuation token, if not all the requested triggers have yet been returned.</p>",
"JobCommand$Name": "<p>The name of the job command: this must be <code>glueetl</code>.</p>",
@ -1390,9 +1392,9 @@
"IdString": {
"base": null,
"refs": {
"BatchStopJobRunError$JobRunId": "<p>The JobRunId of the JobRun in question.</p>",
"BatchStopJobRunError$JobRunId": "<p>The JobRunId of the job run in question.</p>",
"BatchStopJobRunJobRunIdList$member": null,
"BatchStopJobRunSuccessfulSubmission$JobRunId": "<p>The JobRunId of the JobRun in question.</p>",
"BatchStopJobRunSuccessfulSubmission$JobRunId": "<p>The JobRunId of the job run that was stopped.</p>",
"GetJobRunRequest$RunId": "<p>The ID of the job run.</p>",
"JobRun$Id": "<p>The ID of this job run.</p>",
"JobRun$PreviousRunId": "<p>The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.</p>",
@ -1439,11 +1441,12 @@
"CreateJobRequest$AllocatedCapacity": "<p>The number of AWS Glue data processing units (DPUs) to allocate to this Job. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the <a href=\"https://aws.amazon.com/glue/pricing/\">AWS Glue pricing page</a>.</p>",
"DevEndpoint$ZeppelinRemoteSparkInterpreterPort": "<p>The Apache Zeppelin port for the remote Apache Spark interpreter.</p>",
"DevEndpoint$NumberOfNodes": "<p>The number of AWS Glue Data Processing Units (DPUs) allocated to this DevEndpoint.</p>",
"Job$AllocatedCapacity": "<p>The number of AWS Glue data processing units (DPUs) allocated to this Job. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the <a href=\"https://aws.amazon.com/glue/pricing/\">AWS Glue pricing page</a>.</p>",
"Job$AllocatedCapacity": "<p>The number of AWS Glue data processing units (DPUs) allocated to runs of this job. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the <a href=\"https://aws.amazon.com/glue/pricing/\">AWS Glue pricing page</a>.</p>",
"JobBookmarkEntry$Version": "<p>Version of the job.</p>",
"JobBookmarkEntry$Run": "<p>The run ID number.</p>",
"JobBookmarkEntry$Attempt": "<p>The attempt ID number.</p>",
"JobRun$AllocatedCapacity": "<p>The number of AWS Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the <a href=\"https://aws.amazon.com/glue/pricing/\">AWS Glue pricing page</a>.</p>",
"JobRun$ExecutionTime": "<p>The amount of time (in seconds) that the job run consumed resources.</p>",
"JobUpdate$AllocatedCapacity": "<p>The number of AWS Glue data processing units (DPUs) to allocate to this Job. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the <a href=\"https://aws.amazon.com/glue/pricing/\">AWS Glue pricing page</a>.</p>",
"StartJobRunRequest$AllocatedCapacity": "<p>The number of AWS Glue data processing units (DPUs) to allocate to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the <a href=\"https://aws.amazon.com/glue/pricing/\">AWS Glue pricing page</a>.</p>"
}
@ -1471,7 +1474,7 @@
}
},
"Job": {
"base": "<p>Specifies a job.</p>",
"base": "<p>Specifies a job definition.</p>",
"refs": {
"GetJobResponse$Job": "<p>The requested job definition.</p>",
"JobList$member": null
@ -1484,7 +1487,7 @@
}
},
"JobCommand": {
"base": "<p>Specifies code that executes a job.</p>",
"base": "<p>Specifies code executed when a job is run.</p>",
"refs": {
"CreateJobRequest$Command": "<p>The JobCommand that executes this job.</p>",
"Job$Command": "<p>The JobCommand that executes this job.</p>",
@ -1494,7 +1497,7 @@
"JobList": {
"base": null,
"refs": {
"GetJobsResponse$Jobs": "<p>A list of jobs.</p>"
"GetJobsResponse$Jobs": "<p>A list of job definitions.</p>"
}
},
"JobName": {
@ -1520,14 +1523,14 @@
"JobRunState": {
"base": null,
"refs": {
"Condition$State": "<p>The condition state. Currently, the values supported are SUCCEEDED, STOPPED and FAILED.</p>",
"Condition$State": "<p>The condition state. Currently, the values supported are SUCCEEDED, STOPPED, TIMEOUT and FAILED.</p>",
"JobRun$JobRunState": "<p>The current state of the job run.</p>"
}
},
"JobUpdate": {
"base": "<p>Specifies information used to update an existing job. Note that the previous job definition will be completely overwritten by this information.</p>",
"base": "<p>Specifies information used to update an existing job definition. Note that the previous job definition will be completely overwritten by this information.</p>",
"refs": {
"UpdateJobRequest$JobUpdate": "<p>Specifies the values with which to update the job.</p>"
"UpdateJobRequest$JobUpdate": "<p>Specifies the values with which to update the job definition.</p>"
}
},
"JsonClassifier": {
@ -1609,7 +1612,7 @@
"Logical": {
"base": null,
"refs": {
"Predicate$Logical": "<p>Currently \"OR\" is not supported.</p>"
"Predicate$Logical": "<p>Optional field if only one condition is listed. If multiple conditions are listed, then this field is required.</p>"
}
},
"LogicalOperator": {
@ -1642,14 +1645,14 @@
"MaxConcurrentRuns": {
"base": null,
"refs": {
"ExecutionProperty$MaxConcurrentRuns": "<p>The maximum number of concurrent runs allowed for a job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.</p>"
"ExecutionProperty$MaxConcurrentRuns": "<p>The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.</p>"
}
},
"MaxRetries": {
"base": null,
"refs": {
"CreateJobRequest$MaxRetries": "<p>The maximum number of times to retry this job if it fails.</p>",
"Job$MaxRetries": "<p>The maximum number of times to retry this job if it fails.</p>",
"Job$MaxRetries": "<p>The maximum number of times to retry this job after a JobRun fails.</p>",
"JobUpdate$MaxRetries": "<p>The maximum number of times to retry this job if it fails.</p>"
}
},
@ -1703,9 +1706,9 @@
"BatchDeleteTableVersionRequest$TableName": "<p>The name of the table. For Hive compatibility, this name is entirely lowercase.</p>",
"BatchGetPartitionRequest$DatabaseName": "<p>The name of the catalog database where the partitions reside.</p>",
"BatchGetPartitionRequest$TableName": "<p>The name of the partitions' table.</p>",
"BatchStopJobRunError$JobName": "<p>The name of the Job in question.</p>",
"BatchStopJobRunRequest$JobName": "<p>The name of the Job in question.</p>",
"BatchStopJobRunSuccessfulSubmission$JobName": "<p>The Name of the Job in question.</p>",
"BatchStopJobRunError$JobName": "<p>The name of the job definition used in the job run in question.</p>",
"BatchStopJobRunRequest$JobName": "<p>The name of the job definition for which to stop job runs.</p>",
"BatchStopJobRunSuccessfulSubmission$JobName": "<p>The name of the job definition used in the job run that was stopped.</p>",
"CatalogEntry$DatabaseName": "<p>The database in which the table metadata resides.</p>",
"CatalogEntry$TableName": "<p>The name of the table in question.</p>",
"CatalogImportStatus$ImportedBy": "<p>The name of the person who initiated the migration.</p>",
@ -1720,8 +1723,8 @@
"CrawlerNameList$member": null,
"CreateCrawlerRequest$Name": "<p>Name of the new crawler.</p>",
"CreateGrokClassifierRequest$Name": "<p>The name of the new classifier.</p>",
"CreateJobRequest$Name": "<p>The name you assign to this job. It must be unique in your account.</p>",
"CreateJobResponse$Name": "<p>The unique name that was provided.</p>",
"CreateJobRequest$Name": "<p>The name you assign to this job definition. It must be unique in your account.</p>",
"CreateJobResponse$Name": "<p>The unique name that was provided for this job definition.</p>",
"CreateJsonClassifierRequest$Name": "<p>The name of the classifier.</p>",
"CreatePartitionRequest$DatabaseName": "<p>The name of the metadata database in which the partition is to be created.</p>",
"CreatePartitionRequest$TableName": "<p>The name of the metadata table in which the partition is to be created.</p>",
@ -1737,8 +1740,8 @@
"DeleteConnectionRequest$ConnectionName": "<p>The name of the connection to delete.</p>",
"DeleteCrawlerRequest$Name": "<p>Name of the crawler to remove.</p>",
"DeleteDatabaseRequest$Name": "<p>The name of the Database to delete. For Hive compatibility, this must be all lowercase.</p>",
"DeleteJobRequest$JobName": "<p>The name of the job to delete.</p>",
"DeleteJobResponse$JobName": "<p>The name of the job that was deleted.</p>",
"DeleteJobRequest$JobName": "<p>The name of the job definition to delete.</p>",
"DeleteJobResponse$JobName": "<p>The name of the job definition that was deleted.</p>",
"DeletePartitionRequest$DatabaseName": "<p>The name of the catalog database in which the table in question resides.</p>",
"DeletePartitionRequest$TableName": "<p>The name of the table where the partition to be deleted is located.</p>",
"DeleteTableRequest$DatabaseName": "<p>The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase.</p>",
@ -1755,9 +1758,9 @@
"GetConnectionRequest$Name": "<p>The name of the connection definition to retrieve.</p>",
"GetCrawlerRequest$Name": "<p>Name of the crawler to retrieve metadata for.</p>",
"GetDatabaseRequest$Name": "<p>The name of the database to retrieve. For Hive compatibility, this should be all lowercase.</p>",
"GetJobRequest$JobName": "<p>The name of the job to retrieve.</p>",
"GetJobRunRequest$JobName": "<p>Name of the job being run.</p>",
"GetJobRunsRequest$JobName": "<p>The name of the job for which to retrieve all job runs.</p>",
"GetJobRequest$JobName": "<p>The name of the job definition to retrieve.</p>",
"GetJobRunRequest$JobName": "<p>Name of the job definition being run.</p>",
"GetJobRunsRequest$JobName": "<p>The name of the job definition for which to retrieve all job runs.</p>",
"GetPartitionRequest$DatabaseName": "<p>The name of the catalog database where the partition resides.</p>",
"GetPartitionRequest$TableName": "<p>The name of the partition's table.</p>",
"GetPartitionsRequest$DatabaseName": "<p>The name of the catalog database where the partitions reside.</p>",
@ -1776,9 +1779,9 @@
"GetUserDefinedFunctionsRequest$DatabaseName": "<p>The name of the catalog database where the functions are located.</p>",
"GetUserDefinedFunctionsRequest$Pattern": "<p>An optional function-name pattern string that filters the function definitions returned.</p>",
"GrokClassifier$Name": "<p>The name of the classifier.</p>",
"Job$Name": "<p>The name you assign to this job.</p>",
"Job$Name": "<p>The name you assign to this job definition.</p>",
"JobRun$TriggerName": "<p>The name of the trigger that started this job run.</p>",
"JobRun$JobName": "<p>The name of the job being run.</p>",
"JobRun$JobName": "<p>The name of the job definition being used in this run.</p>",
"JsonClassifier$Name": "<p>The name of the classifier.</p>",
"MatchCriteria$member": null,
"NameStringList$member": null,
@ -1787,13 +1790,13 @@
"Partition$TableName": "<p>The name of the table in question.</p>",
"PhysicalConnectionRequirements$SubnetId": "<p>The subnet ID used by the connection.</p>",
"PhysicalConnectionRequirements$AvailabilityZone": "<p>The connection's availability zone. This field is deprecated and has no effect.</p>",
"Predecessor$JobName": "<p>The name of the predecessor job.</p>",
"Predecessor$JobName": "<p>The name of the job definition used by the predecessor job run.</p>",
"SecurityGroupIdList$member": null,
"SerDeInfo$Name": "<p>Name of the SerDe.</p>",
"SerDeInfo$SerializationLibrary": "<p>Usually the class that implements the SerDe. An example is: <code>org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe</code>.</p>",
"StartCrawlerRequest$Name": "<p>Name of the crawler to start.</p>",
"StartCrawlerScheduleRequest$CrawlerName": "<p>Name of the crawler to schedule.</p>",
"StartJobRunRequest$JobName": "<p>The name of the job to start.</p>",
"StartJobRunRequest$JobName": "<p>The name of the job definition to use.</p>",
"StartTriggerRequest$Name": "<p>The name of the trigger to start.</p>",
"StartTriggerResponse$Name": "<p>The name of the trigger that was started.</p>",
"StopCrawlerRequest$Name": "<p>Name of the crawler to stop.</p>",
@ -1816,7 +1819,7 @@
"UpdateDatabaseRequest$Name": "<p>The name of the database to update in the catalog. For Hive compatibility, this is folded to lowercase.</p>",
"UpdateGrokClassifierRequest$Name": "<p>The name of the <code>GrokClassifier</code>.</p>",
"UpdateJobRequest$JobName": "<p>Name of the job definition to update.</p>",
"UpdateJobResponse$JobName": "<p>Returns the name of the updated job.</p>",
"UpdateJobResponse$JobName": "<p>Returns the name of the updated job definition.</p>",
"UpdateJsonClassifierRequest$Name": "<p>The name of the classifier.</p>",
"UpdatePartitionRequest$DatabaseName": "<p>The name of the catalog database in which the table in question resides.</p>",
"UpdatePartitionRequest$TableName": "<p>The name of the table where the partition to be updated is located.</p>",
@ -2084,9 +2087,9 @@
"RoleString": {
"base": null,
"refs": {
"CreateJobRequest$Role": "<p>The name of the IAM role associated with this job.</p>",
"Job$Role": "<p>The name of the IAM role associated with this job.</p>",
"JobUpdate$Role": "<p>The name of the IAM role associated with this job (required).</p>"
"CreateJobRequest$Role": "<p>The name or ARN of the IAM role associated with this job.</p>",
"Job$Role": "<p>The name or ARN of the IAM role associated with this job.</p>",
"JobUpdate$Role": "<p>The name or ARN of the IAM role associated with this job (required).</p>"
}
},
"RowTag": {
@ -2350,6 +2353,17 @@
"BatchDeleteTableVersionResponse$Errors": "<p>A list of errors encountered while trying to delete the specified table versions.</p>"
}
},
"Timeout": {
"base": null,
"refs": {
"Action$Timeout": "<p>The job run timeout in minutes. It overrides the timeout value of the job.</p>",
"CreateJobRequest$Timeout": "<p>The job timeout in minutes. The default is 2880 minutes (48 hours).</p>",
"Job$Timeout": "<p>The job timeout in minutes.</p>",
"JobRun$Timeout": "<p>The job run timeout in minutes.</p>",
"JobUpdate$Timeout": "<p>The job timeout in minutes. The default is 2880 minutes (48 hours).</p>",
"StartJobRunRequest$Timeout": "<p>The job run timeout in minutes. It overrides the timeout value of the job.</p>"
}
},
"Timestamp": {
"base": null,
"refs": {
@ -2386,8 +2400,8 @@
"CreateDevEndpointResponse$CreatedTimestamp": "<p>The point in time at which this DevEndpoint was created.</p>",
"DevEndpoint$CreatedTimestamp": "<p>The point in time at which this DevEndpoint was created.</p>",
"DevEndpoint$LastModifiedTimestamp": "<p>The point in time at which this DevEndpoint was last modified.</p>",
"Job$CreatedOn": "<p>The time and date that this job specification was created.</p>",
"Job$LastModifiedOn": "<p>The last point in time when this job specification was modified.</p>",
"Job$CreatedOn": "<p>The time and date that this job definition was created.</p>",
"Job$LastModifiedOn": "<p>The last point in time when this job definition was modified.</p>",
"JobRun$StartedOn": "<p>The date and time at which this job run was started.</p>",
"JobRun$LastModifiedOn": "<p>The last time this job run was modified.</p>",
"JobRun$CompletedOn": "<p>The date and time this job run completed.</p>"

295
vendor/github.com/aws/aws-sdk-go/models/apis/greengrass/2017-06-07/api-2.json generated vendored
View File

@ -1365,13 +1365,14 @@
"ThingArn" : {
"shape" : "__string"
}
}
},
"required" : [ ]
},
"CoreDefinitionVersion" : {
"type" : "structure",
"members" : {
"Cores" : {
"shape" : "ListOfCore"
"shape" : "__listOfCore"
}
}
},
@ -1431,7 +1432,7 @@
"locationName" : "CoreDefinitionId"
},
"Cores" : {
"shape" : "ListOfCore"
"shape" : "__listOfCore"
}
},
"required" : [ "CoreDefinitionId" ]
@ -1545,7 +1546,7 @@
"locationName" : "DeviceDefinitionId"
},
"Devices" : {
"shape" : "ListOfDevice"
"shape" : "__listOfDevice"
}
},
"required" : [ "DeviceDefinitionId" ]
@ -1623,7 +1624,7 @@
"locationName" : "FunctionDefinitionId"
},
"Functions" : {
"shape" : "ListOfFunction"
"shape" : "__listOfFunction"
}
},
"required" : [ "FunctionDefinitionId" ]
@ -1818,7 +1819,7 @@
"locationName" : "LoggerDefinitionId"
},
"Loggers" : {
"shape" : "ListOfLogger"
"shape" : "__listOfLogger"
}
},
"required" : [ "LoggerDefinitionId" ]
@ -1896,7 +1897,7 @@
"locationName" : "ResourceDefinitionId"
},
"Resources" : {
"shape" : "ListOfResource"
"shape" : "__listOfResource"
}
},
"required" : [ "ResourceDefinitionId" ]
@ -1914,7 +1915,7 @@
"shape" : "__string"
},
"Version" : {
"shape" : "__string"
"shape" : "__string"
}
}
},
@ -1922,9 +1923,9 @@
"type" : "structure",
"members" : {
"AmznClientToken" : {
"shape" : "__string",
"location" : "header",
"locationName" : "X-Amzn-Client-Token"
"shape" : "__string",
"location" : "header",
"locationName" : "X-Amzn-Client-Token"
},
"S3UrlSignerRole" : {
"shape" : "S3UrlSignerRole"
@ -2013,7 +2014,7 @@
"locationName" : "SubscriptionDefinitionId"
},
"Subscriptions" : {
"shape" : "ListOfSubscription"
"shape" : "__listOfSubscription"
}
},
"required" : [ "SubscriptionDefinitionId" ]
@ -2211,13 +2212,14 @@
"ThingArn" : {
"shape" : "__string"
}
}
},
"required" : [ ]
},
"DeviceDefinitionVersion" : {
"type" : "structure",
"members" : {
"Devices" : {
"shape" : "ListOfDevice"
"shape" : "__listOfDevice"
}
}
},
@ -2256,6 +2258,10 @@
"type" : "structure",
"members" : { }
},
"EncodingType" : {
"type" : "string",
"enum" : [ "binary", "json" ]
},
"ErrorDetail" : {
"type" : "structure",
"members" : {
@ -2285,11 +2291,15 @@
"Id" : {
"shape" : "__string"
}
}
},
"required" : [ ]
},
"FunctionConfiguration" : {
"type" : "structure",
"members" : {
"EncodingType" : {
"shape" : "EncodingType"
},
"Environment" : {
"shape" : "FunctionConfigurationEnvironment"
},
@ -2317,10 +2327,10 @@
"shape" : "__boolean"
},
"ResourceAccessPolicies" : {
"shape" : "ListOfResourceAccessPolicy"
"shape" : "__listOfResourceAccessPolicy"
},
"Variables" : {
"shape" : "MapOf__string"
"shape" : "__mapOf__string"
}
}
},
@ -2328,7 +2338,7 @@
"type" : "structure",
"members" : {
"Functions" : {
"shape" : "ListOfFunction"
"shape" : "__listOfFunction"
}
}
},
@ -2380,7 +2390,7 @@
"type" : "structure",
"members" : {
"ConnectivityInfo" : {
"shape" : "ListOfConnectivityInfo"
"shape" : "__listOfConnectivityInfo"
},
"Message" : {
"shape" : "__string",
@ -3133,7 +3143,7 @@
"shape" : "__string"
},
"Versions" : {
"shape" : "ListOfVersionInformation"
"shape" : "__listOfVersionInformation"
}
}
},
@ -3156,7 +3166,7 @@
"type" : "structure",
"members" : {
"Definitions" : {
"shape" : "ListOfDefinitionInformation"
"shape" : "__listOfDefinitionInformation"
},
"NextToken" : {
"shape" : "__string"
@ -3167,7 +3177,7 @@
"type" : "structure",
"members" : {
"Definitions" : {
"shape" : "ListOfDefinitionInformation"
"shape" : "__listOfDefinitionInformation"
},
"NextToken" : {
"shape" : "__string"
@ -3234,7 +3244,7 @@
"shape" : "__string"
},
"Versions" : {
"shape" : "ListOfVersionInformation"
"shape" : "__listOfVersionInformation"
}
}
},
@ -3257,7 +3267,7 @@
"type" : "structure",
"members" : {
"Definitions" : {
"shape" : "ListOfDefinitionInformation"
"shape" : "__listOfDefinitionInformation"
},
"NextToken" : {
"shape" : "__string"
@ -3292,7 +3302,7 @@
"shape" : "__string"
},
"Versions" : {
"shape" : "ListOfVersionInformation"
"shape" : "__listOfVersionInformation"
}
}
},
@ -3315,7 +3325,7 @@
"type" : "structure",
"members" : {
"Definitions" : {
"shape" : "ListOfDefinitionInformation"
"shape" : "__listOfDefinitionInformation"
},
"NextToken" : {
"shape" : "__string"
@ -3337,7 +3347,7 @@
"type" : "structure",
"members" : {
"GroupCertificateAuthorities" : {
"shape" : "ListOfGroupCertificateAuthorityProperties"
"shape" : "__listOfGroupCertificateAuthorityProperties"
}
}
},
@ -3369,7 +3379,7 @@
"shape" : "__string"
},
"Versions" : {
"shape" : "ListOfVersionInformation"
"shape" : "__listOfVersionInformation"
}
}
},
@ -3392,7 +3402,7 @@
"type" : "structure",
"members" : {
"Groups" : {
"shape" : "ListOfGroupInformation"
"shape" : "__listOfGroupInformation"
},
"NextToken" : {
"shape" : "__string"
@ -3427,7 +3437,7 @@
"shape" : "__string"
},
"Versions" : {
"shape" : "ListOfVersionInformation"
"shape" : "__listOfVersionInformation"
}
}
},
@ -3450,85 +3460,13 @@
"type" : "structure",
"members" : {
"Definitions" : {
"shape" : "ListOfDefinitionInformation"
"shape" : "__listOfDefinitionInformation"
},
"NextToken" : {
"shape" : "__string"
}
}
},
"ListOfConnectivityInfo" : {
"type" : "list",
"member" : {
"shape" : "ConnectivityInfo"
}
},
"ListOfCore" : {
"type" : "list",
"member" : {
"shape" : "Core"
}
},
"ListOfDefinitionInformation" : {
"type" : "list",
"member" : {
"shape" : "DefinitionInformation"
}
},
"ListOfDevice" : {
"type" : "list",
"member" : {
"shape" : "Device"
}
},
"ListOfFunction" : {
"type" : "list",
"member" : {
"shape" : "Function"
}
},
"ListOfGroupCertificateAuthorityProperties" : {
"type" : "list",
"member" : {
"shape" : "GroupCertificateAuthorityProperties"
}
},
"ListOfGroupInformation" : {
"type" : "list",
"member" : {
"shape" : "GroupInformation"
}
},
"ListOfLogger" : {
"type" : "list",
"member" : {
"shape" : "Logger"
}
},
"ListOfResource" : {
"type" : "list",
"member" : {
"shape" : "Resource"
}
},
"ListOfResourceAccessPolicy" : {
"type" : "list",
"member" : {
"shape" : "ResourceAccessPolicy"
}
},
"ListOfSubscription" : {
"type" : "list",
"member" : {
"shape" : "Subscription"
}
},
"ListOfVersionInformation" : {
"type" : "list",
"member" : {
"shape" : "VersionInformation"
}
},
"ListResourceDefinitionVersionsRequest" : {
"type" : "structure",
"members" : {
@ -3557,7 +3495,7 @@
"shape" : "__string"
},
"Versions" : {
"shape" : "ListOfVersionInformation"
"shape" : "__listOfVersionInformation"
}
}
},
@ -3580,7 +3518,7 @@
"type" : "structure",
"members" : {
"Definitions" : {
"shape" : "ListOfDefinitionInformation"
"shape" : "__listOfDefinitionInformation"
},
"NextToken" : {
"shape" : "__string"
@ -3615,7 +3553,7 @@
"shape" : "__string"
},
"Versions" : {
"shape" : "ListOfVersionInformation"
"shape" : "__listOfVersionInformation"
}
}
},
@ -3638,7 +3576,7 @@
"type" : "structure",
"members" : {
"Definitions" : {
"shape" : "ListOfDefinitionInformation"
"shape" : "__listOfDefinitionInformation"
},
"NextToken" : {
"shape" : "__string"
@ -3652,7 +3590,7 @@
"shape" : "__string"
},
"Versions" : {
"shape" : "ListOfVersionInformation"
"shape" : "__listOfVersionInformation"
}
}
},
@ -3699,7 +3637,8 @@
"Type" : {
"shape" : "LoggerType"
}
}
},
"required" : [ ]
},
"LoggerComponent" : {
"type" : "string",
@ -3709,7 +3648,7 @@
"type" : "structure",
"members" : {
"Loggers" : {
"shape" : "ListOfLogger"
"shape" : "__listOfLogger"
}
}
},
@ -3721,15 +3660,6 @@
"type" : "string",
"enum" : [ "FileSystem", "AWSCloudWatch" ]
},
"MapOf__string" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "__string"
}
},
"Permission" : {
"type" : "string",
"enum" : [ "ro", "rw" ]
@ -3776,7 +3706,8 @@
"ResourceDataContainer" : {
"shape" : "ResourceDataContainer"
}
}
},
"required" : [ ]
},
"ResourceAccessPolicy" : {
"type" : "structure",
@ -3787,7 +3718,8 @@
"ResourceId" : {
"shape" : "__string"
}
}
},
"required" : [ ]
},
"ResourceDataContainer" : {
"type" : "structure",
@ -3797,6 +3729,12 @@
},
"LocalVolumeResourceData" : {
"shape" : "LocalVolumeResourceData"
},
"S3MachineLearningModelResourceData" : {
"shape" : "S3MachineLearningModelResourceData"
},
"SageMakerMachineLearningModelResourceData" : {
"shape" : "SageMakerMachineLearningModelResourceData"
}
}
},
@ -3804,13 +3742,35 @@
"type" : "structure",
"members" : {
"Resources" : {
"shape" : "ListOfResource"
"shape" : "__listOfResource"
}
}
},
"S3MachineLearningModelResourceData" : {
"type" : "structure",
"members" : {
"DestinationPath" : {
"shape" : "__string"
},
"S3Uri" : {
"shape" : "__string"
}
}
},
"S3UrlSignerRole" : {
"type" : "string"
},
"SageMakerMachineLearningModelResourceData" : {
"type" : "structure",
"members" : {
"DestinationPath" : {
"shape" : "__string"
},
"SageMakerJobArn" : {
"shape" : "__string"
}
}
},
"SoftwareToUpdate" : {
"type" : "string",
"enum" : [ "core", "ota_agent" ]
@ -3830,13 +3790,14 @@
"Target" : {
"shape" : "__string"
}
}
},
"required" : [ ]
},
"SubscriptionDefinitionVersion" : {
"type" : "structure",
"members" : {
"Subscriptions" : {
"shape" : "ListOfSubscription"
"shape" : "__listOfSubscription"
}
}
},
@ -3848,7 +3809,7 @@
"type" : "structure",
"members" : {
"ConnectivityInfo" : {
"shape" : "ListOfConnectivityInfo"
"shape" : "__listOfConnectivityInfo"
},
"ThingName" : {
"shape" : "__string",
@ -4064,6 +4025,90 @@
"__integer" : {
"type" : "integer"
},
"__listOfConnectivityInfo" : {
"type" : "list",
"member" : {
"shape" : "ConnectivityInfo"
}
},
"__listOfCore" : {
"type" : "list",
"member" : {
"shape" : "Core"
}
},
"__listOfDefinitionInformation" : {
"type" : "list",
"member" : {
"shape" : "DefinitionInformation"
}
},
"__listOfDevice" : {
"type" : "list",
"member" : {
"shape" : "Device"
}
},
"__listOfFunction" : {
"type" : "list",
"member" : {
"shape" : "Function"
}
},
"__listOfGroupCertificateAuthorityProperties" : {
"type" : "list",
"member" : {
"shape" : "GroupCertificateAuthorityProperties"
}
},
"__listOfGroupInformation" : {
"type" : "list",
"member" : {
"shape" : "GroupInformation"
}
},
"__listOfLogger" : {
"type" : "list",
"member" : {
"shape" : "Logger"
}
},
"__listOfResource" : {
"type" : "list",
"member" : {
"shape" : "Resource"
}
},
"__listOfResourceAccessPolicy" : {
"type" : "list",
"member" : {
"shape" : "ResourceAccessPolicy"
}
},
"__listOfSubscription" : {
"type" : "list",
"member" : {
"shape" : "Subscription"
}
},
"__listOfVersionInformation" : {
"type" : "list",
"member" : {
"shape" : "VersionInformation"
}
},
"__long" : {
"type" : "long"
},
"__mapOf__string" : {
"type" : "map",
"key" : {
"shape" : "__string"
},
"value" : {
"shape" : "__string"
}
},
"__string" : {
"type" : "string"
},

636
vendor/github.com/aws/aws-sdk-go/models/apis/greengrass/2017-06-07/docs-2.json generated vendored
View File

@ -2,34 +2,34 @@
"version" : "2.0",
"service" : "AWS Greengrass seamlessly extends AWS onto physical devices so they can act locally on the data they generate, while still using the cloud for management, analytics, and durable storage. AWS Greengrass ensures your devices can respond quickly to local events and operate with intermittent connectivity. AWS Greengrass minimizes the cost of transmitting data to the cloud by allowing you to author AWS Lambda functions that execute locally.",
"operations" : {
"AssociateRoleToGroup" : "Associates a role with a group. The role will be used by the AWS Greengrass core in order to access AWS cloud services. The role's permissions will allow Greengrass core Lambda functions to perform actions against the cloud.",
"AssociateServiceRoleToAccount" : "Associates a role which is used by AWS Greengrass. AWS Greengrass uses the role to access your Lambda functions and AWS IoT resources. This is necessary for deployments to succeed. It needs to have minimum permissions in policy ``AWSGreengrassResourceAccessRolePolicy``",
"CreateCoreDefinition" : "Creates a core definition. You may optionally provide the initial version of the core definition or use ''CreateCoreDefinitionVersion'' at a later time. AWS Greengrass Groups must each contain exactly 1 AWS Greengrass Core.",
"CreateCoreDefinitionVersion" : "Creates a version of a core definition that has already been defined. AWS Greengrass Groups must each contain exactly 1 AWS Greengrass Core.",
"AssociateRoleToGroup" : "Associates a role with a group. Your AWS Greengrass core will use the role to access AWS cloud services. The role's permissions should allow Greengrass core Lambda functions to perform actions against the cloud.",
"AssociateServiceRoleToAccount" : "Associates a role with your account. AWS Greengrass will use the role to access your Lambda functions and AWS IoT resources. This is necessary for deployments to succeed. The role must have at least minimum permissions in the policy ''AWSGreengrassResourceAccessRolePolicy''.",
"CreateCoreDefinition" : "Creates a core definition. You may provide the initial version of the core definition now or use ''CreateCoreDefinitionVersion'' at a later time. AWS Greengrass groups must each contain exactly one AWS Greengrass core.",
"CreateCoreDefinitionVersion" : "Creates a version of a core definition that has already been defined. AWS Greengrass groups must each contain exactly one AWS Greengrass core.",
"CreateDeployment" : "Creates a deployment.",
"CreateDeviceDefinition" : "Creates a device definition. You may optinally provide the initial version of the device definition or use ``CreateDeviceDefinitionVersion`` at a later time.",
"CreateDeviceDefinition" : "Creates a device definition. You may provide the initial version of the device definition now or use ''CreateDeviceDefinitionVersion'' at a later time.",
"CreateDeviceDefinitionVersion" : "Creates a version of a device definition that has already been defined.",
"CreateFunctionDefinition" : "Creates a Lambda function definition which contains a list of Lambda functions and their configurations to be used in a group. You can create an initial version of the definition by providing a list of Lambda functions and their configurations now, or use ``CreateFunctionDefinitionVersion`` later.",
"CreateFunctionDefinitionVersion" : "Create a version of a Lambda function definition that has already been defined.",
"CreateGroup" : "Creates a group. You may optionally provide the initial version of the group or use ''CreateGroupVersion'' at a later time.",
"CreateFunctionDefinition" : "Creates a Lambda function definition which contains a list of Lambda functions and their configurations to be used in a group. You can create an initial version of the definition by providing a list of Lambda functions and their configurations now, or use ''CreateFunctionDefinitionVersion'' later.",
"CreateFunctionDefinitionVersion" : "Creates a version of a Lambda function definition that has already been defined.",
"CreateGroup" : "Creates a group. You may provide the initial version of the group or use ''CreateGroupVersion'' at a later time.",
"CreateGroupCertificateAuthority" : "Creates a CA for the group. If a CA already exists, it will rotate the existing CA.",
"CreateGroupVersion" : "Creates a version of a group which has already been defined.",
"CreateLoggerDefinition" : "Creates a logger definition. You may optionally provide the initial version of the logger definition or use ``CreateLoggerDefinitionVersion`` at a later time.",
"CreateLoggerDefinition" : "Creates a logger definition. You may provide the initial version of the logger definition now or use ''CreateLoggerDefinitionVersion'' at a later time.",
"CreateLoggerDefinitionVersion" : "Creates a version of a logger definition that has already been defined.",
"CreateResourceDefinition" : "Creates a resource definition which contains a list of resources to be used in a group. You can create an initial version of the definition by providing a list of resources now, or use ``CreateResourceDefinitionVersion`` later.",
"CreateResourceDefinitionVersion" : "Create a version of a resource definition that has already been defined.",
"CreateSoftwareUpdateJob" : "Creates an Iot Job that will trigger your Greengrass Cores to update the software they are running.",
"CreateSubscriptionDefinition" : "Creates a subscription definition. You may optionally provide the initial version of the subscription definition or use ``CreateSubscriptionDefinitionVersion`` at a later time.",
"CreateResourceDefinition" : "Creates a resource definition which contains a list of resources to be used in a group. You can create an initial version of the definition by providing a list of resources now, or use ''CreateResourceDefinitionVersion'' later.",
"CreateResourceDefinitionVersion" : "Creates a version of a resource definition that has already been defined.",
"CreateSoftwareUpdateJob" : "Creates a software update for a core or group of cores (specified as an IoT thing group.) Use this to update the OTA Agent as well as the Greengrass core software. It makes use of the IoT Jobs feature which provides additional commands to manage a Greengrass core software update job.",
"CreateSubscriptionDefinition" : "Creates a subscription definition. You may provide the initial version of the subscription definition now or use ''CreateSubscriptionDefinitionVersion'' at a later time.",
"CreateSubscriptionDefinitionVersion" : "Creates a version of a subscription definition which has already been defined.",
"DeleteCoreDefinition" : "Deletes a core definition. The core definition must not have been used in a deployment.",
"DeleteDeviceDefinition" : "Deletes a device definition. The device definition must not have been used in a deployment.",
"DeleteFunctionDefinition" : "Deletes a Lambda function definition. The Lambda function definition must not have been used in a deployment.",
"DeleteGroup" : "Deletes a group. The group must not have been used in deployment.",
"DeleteLoggerDefinition" : "Deletes a logger definition. The logger definition must not have been used in a deployment.",
"DeleteCoreDefinition" : "Deletes a core definition.",
"DeleteDeviceDefinition" : "Deletes a device definition.",
"DeleteFunctionDefinition" : "Deletes a Lambda function definition.",
"DeleteGroup" : "Deletes a group.",
"DeleteLoggerDefinition" : "Deletes a logger definition.",
"DeleteResourceDefinition" : "Deletes a resource definition.",
"DeleteSubscriptionDefinition" : "Deletes a subscription definition. The subscription definition must not have been used in a deployment.",
"DeleteSubscriptionDefinition" : "Deletes a subscription definition.",
"DisassociateRoleFromGroup" : "Disassociates the role from a group.",
"DisassociateServiceRoleFromAccount" : "Disassociates the service role from the account. Without a service role, deployments will not work.",
"DisassociateServiceRoleFromAccount" : "Disassociates the service role from your account. Without a service role, deployments will not work.",
"GetAssociatedRole" : "Retrieves the role associated with a particular group.",
"GetConnectivityInfo" : "Retrieves the connectivity information for a core.",
"GetCoreDefinition" : "Retrieves information about a core definition version.",
@ -37,20 +37,20 @@
"GetDeploymentStatus" : "Returns the status of a deployment.",
"GetDeviceDefinition" : "Retrieves information about a device definition.",
"GetDeviceDefinitionVersion" : "Retrieves information about a device definition version.",
"GetFunctionDefinition" : "Retrieves information about a Lambda function definition, such as its creation time and latest version.",
"GetFunctionDefinitionVersion" : "Retrieves information about a Lambda function definition version, such as which Lambda functions are included in the version and their configurations.",
"GetFunctionDefinition" : "Retrieves information about a Lambda function definition, including its creation time and latest version.",
"GetFunctionDefinitionVersion" : "Retrieves information about a Lambda function definition version, including which Lambda functions are included in the version and their configurations.",
"GetGroup" : "Retrieves information about a group.",
"GetGroupCertificateAuthority" : "Retreives the CA associated with a group. Returns the public key of the CA.",
"GetGroupCertificateConfiguration" : "Retrieves the current configuration for the CA used by the group.",
"GetGroupVersion" : "Retrieves information about a group version.",
"GetLoggerDefinition" : "Retrieves information about a logger definition.",
"GetLoggerDefinitionVersion" : "Retrieves information about a logger definition version.",
"GetResourceDefinition" : "Retrieves information about a resource definition, such as its creation time and latest version.",
"GetResourceDefinitionVersion" : "Retrieves information about a resource definition version, such as which resources are included in the version.",
"GetServiceRoleForAccount" : "Retrieves the service role that is attached to the account.",
"GetResourceDefinition" : "Retrieves information about a resource definition, including its creation time and latest version.",
"GetResourceDefinitionVersion" : "Retrieves information about a resource definition version, including which resources are included in the version.",
"GetServiceRoleForAccount" : "Retrieves the service role that is attached to your account.",
"GetSubscriptionDefinition" : "Retrieves information about a subscription definition.",
"GetSubscriptionDefinitionVersion" : "Retrieves information about a subscription definition version.",
"ListCoreDefinitionVersions" : "Lists versions of a core definition.",
"ListCoreDefinitionVersions" : "Lists the versions of a core definition.",
"ListCoreDefinitions" : "Retrieves a list of core definitions.",
"ListDeployments" : "Returns a history of deployments for the group.",
"ListDeviceDefinitionVersions" : "Lists the versions of a device definition.",
@ -58,7 +58,7 @@
"ListFunctionDefinitionVersions" : "Lists the versions of a Lambda function definition.",
"ListFunctionDefinitions" : "Retrieves a list of Lambda function definitions.",
"ListGroupCertificateAuthorities" : "Retrieves the current CAs for a group.",
"ListGroupVersions" : "List the versions of a group.",
"ListGroupVersions" : "Lists the versions of a group.",
"ListGroups" : "Retrieves a list of groups.",
"ListLoggerDefinitionVersions" : "Lists the versions of a logger definition.",
"ListLoggerDefinitions" : "Retrieves a list of logger definitions.",
@ -72,7 +72,7 @@
"UpdateDeviceDefinition" : "Updates a device definition.",
"UpdateFunctionDefinition" : "Updates a Lambda function definition.",
"UpdateGroup" : "Updates a group.",
"UpdateGroupCertificateConfiguration" : "Updates the Cert expiry time for a group.",
"UpdateGroupCertificateConfiguration" : "Updates the Certificate expiry time for a group.",
"UpdateLoggerDefinition" : "Updates a logger definition.",
"UpdateResourceDefinition" : "Updates a resource definition.",
"UpdateSubscriptionDefinition" : "Updates a subscription definition."
@ -95,30 +95,29 @@
"refs" : { }
},
"BadRequestException" : {
"base" : "user error",
"base" : "General error information.",
"refs" : { }
},
"ConnectivityInfo" : {
"base" : "Connectivity Info",
"base" : "Information about a Greengrass core's connectivity.",
"refs" : {
"GetConnectivityInfoResponse$ConnectivityInfo" : "Connectivity info list",
"UpdateConnectivityInfoRequest$ConnectivityInfo" : "Connectivity info list"
"__listOfConnectivityInfo$member" : null
}
},
"Core" : {
"base" : "Information on the core",
"base" : "Information about a core.",
"refs" : {
"CoreDefinitionVersion$Cores" : "Cores in the definition version."
"__listOfCore$member" : null
}
},
"CoreDefinitionVersion" : {
"base" : "Information on core definition version",
"base" : "Information about a core definition version.",
"refs" : {
"GetCoreDefinitionVersionResponse$Definition" : "Information on definition"
"GetCoreDefinitionVersionResponse$Definition" : "Information about the core definition version."
}
},
"CreateDeploymentRequest" : {
"base" : "Information on Deployment",
"base" : "Information about a deployment.",
"refs" : { }
},
"CreateDeploymentResponse" : {
@ -130,7 +129,7 @@
"refs" : { }
},
"CreateSoftwareUpdateJobRequest" : {
"base" : "Request for the CreateSoftwareUpdateJob API",
"base" : "Request for the CreateSoftwareUpdateJob API.",
"refs" : { }
},
"CreateSoftwareUpdateJobResponse" : {
@ -138,41 +137,41 @@
"refs" : { }
},
"DefinitionInformation" : {
"base" : "Information on the Definition",
"base" : "Information about a definition.",
"refs" : {
"ListDefinitionsResponse$Definitions" : "Definitions"
"__listOfDefinitionInformation$member" : null
}
},
"Deployment" : {
"base" : "Information on the deployment",
"base" : "Information about a deployment.",
"refs" : {
"Deployments" : null
"Deployments$member" : null
}
},
"DeploymentType" : {
"base" : null,
"refs" : {
"CreateDeploymentRequest$DeploymentType" : "Type of deployment. When used in CreateDeployment, only NewDeployment and Redeployment are valid. ",
"Deployment$DeploymentType" : "The type of deployment.",
"CreateDeploymentRequest$DeploymentType" : "The type of deployment. When used in ''CreateDeployment'', only ''NewDeployment'' and ''Redeployment'' are valid.",
"Deployment$DeploymentType" : "The type of the deployment.",
"GetDeploymentStatusResponse$DeploymentType" : "The type of the deployment."
}
},
"Deployments" : {
"base" : null,
"refs" : {
"ListDeploymentsResponse$Deployments" : "List of deployments for the requested groups"
"ListDeploymentsResponse$Deployments" : "A list of deployments for the requested groups."
}
},
"Device" : {
"base" : "Information on a Device",
"base" : "Information about a device.",
"refs" : {
"DeviceDefinitionVersion$Devices" : "Devices in the definition version."
"__listOfDevice$member" : null
}
},
"DeviceDefinitionVersion" : {
"base" : "Information on device definition version",
"base" : "Information about a device definition version.",
"refs" : {
"GetDeviceDefinitionVersionResponse$Definition" : "Device definition version"
"GetDeviceDefinitionVersionResponse$Definition" : "Information about the device definition version."
}
},
"DisassociateRoleFromGroupResponse" : {
@ -187,45 +186,51 @@
"base" : "Empty",
"refs" : { }
},
"ErrorDetail" : {
"base" : "ErrorDetail",
"EncodingType" : {
"base" : null,
"refs" : {
"ErrorDetails" : "Error Details"
"FunctionConfiguration$EncodingType" : "The expected encoding type of the input payload for the function. The default is ''json''."
}
},
"ErrorDetail" : {
"base" : "Details about the error.",
"refs" : {
"ErrorDetails$member" : null
}
},
"ErrorDetails" : {
"base" : "Error Details",
"base" : "A list of error details.",
"refs" : {
"GeneralError$ErrorDetails" : "Error Details",
"GetDeploymentStatusResponse$ErrorDetails" : "The error Details"
"GeneralError$ErrorDetails" : "Details about the error.",
"GetDeploymentStatusResponse$ErrorDetails" : "Error details"
}
},
"Function" : {
"base" : "Information on function",
"base" : "Information about a Lambda function.",
"refs" : {
"FunctionDefinitionVersion$Functions" : "Lambda functions in this function definition version."
"__listOfFunction$member" : null
}
},
"FunctionConfiguration" : {
"base" : "Configuration of the function",
"base" : "The configuration of the Lambda function.",
"refs" : {
"Function$FunctionConfiguration" : "Configuration of the function"
"Function$FunctionConfiguration" : "The configuration of the Lambda function."
}
},
"FunctionConfigurationEnvironment" : {
"base" : "Environment of the function configuration",
"base" : "The environment configuration of the function.",
"refs" : {
"FunctionConfiguration$Environment" : "Environment of the function configuration"
"FunctionConfiguration$Environment" : "The environment configuration of the function."
}
},
"FunctionDefinitionVersion" : {
"base" : "Information on the function definition version",
"base" : "Information about a function definition version.",
"refs" : {
"GetFunctionDefinitionVersionResponse$Definition" : "Information on the definition."
}
},
"GeneralError" : {
"base" : "General Error",
"base" : "General error information.",
"refs" : { }
},
"GetAssociatedRoleResponse" : {
@ -233,7 +238,7 @@
"refs" : { }
},
"GetConnectivityInfoResponse" : {
"base" : "connectivity info response",
"base" : "Information about a Greengrass core's connectivity.",
"refs" : { }
},
"GetCoreDefinitionVersionResponse" : {
@ -241,7 +246,7 @@
"refs" : { }
},
"GetDeploymentStatusResponse" : {
"base" : "The response body contains the status of a deployment for a group.",
"base" : "Information about the status of a deployment for a group.",
"refs" : { }
},
"GetDeviceDefinitionVersionResponse" : {
@ -249,23 +254,23 @@
"refs" : { }
},
"GetFunctionDefinitionVersionResponse" : {
"base" : "Function definition version",
"base" : "Information about a function definition version.",
"refs" : { }
},
"GetGroupCertificateAuthorityResponse" : {
"base" : "Certificate authority for the group.",
"base" : "Information about a certificate authority for a group.",
"refs" : { }
},
"GetGroupVersionResponse" : {
"base" : "Information on the group version",
"base" : "Information about a group version.",
"refs" : { }
},
"GetLoggerDefinitionVersionResponse" : {
"base" : "Information on logger definition version response",
"base" : "Information about a logger definition version.",
"refs" : { }
},
"GetResourceDefinitionVersionResponse" : {
"base" : "Information on resource definition version response",
"base" : "Information about a resource definition version.",
"refs" : { }
},
"GetServiceRoleForAccountResponse" : {
@ -273,44 +278,44 @@
"refs" : { }
},
"GetSubscriptionDefinitionVersionResponse" : {
"base" : "Information on the Subscription Definition Version",
"base" : "Information about a subscription definition version.",
"refs" : { }
},
"GroupCertificateAuthorityProperties" : {
"base" : "Information on group certificate authority properties",
"base" : "Information about a certificate authority for a group.",
"refs" : {
"ListGroupCertificateAuthoritiesResponse$GroupCertificateAuthorities" : "List of certificate authorities associated with the group."
"__listOfGroupCertificateAuthorityProperties$member" : null
}
},
"GroupCertificateConfiguration" : {
"base" : "Information on the group certificate configuration",
"base" : "Information about a group certificate configuration.",
"refs" : { }
},
"GroupInformation" : {
"base" : "Information on the group",
"base" : "Information about a group.",
"refs" : {
"ListGroupsResponse$Groups" : "Groups"
"__listOfGroupInformation$member" : null
}
},
"GroupOwnerSetting" : {
"base" : "Group owner related settings for local resources.",
"refs" : {
"LocalDeviceResourceData$GroupOwnerSetting" : "Group owner related settings for local resources.",
"LocalVolumeResourceData$GroupOwnerSetting" : "Group owner related settings for local resources."
"LocalDeviceResourceData$GroupOwnerSetting" : "Group/owner related settings for local resources.",
"LocalVolumeResourceData$GroupOwnerSetting" : "Allows you to configure additional group privileges for the Lambda process. This field is optional."
}
},
"GroupVersion" : {
"base" : "Information on group version",
"base" : "Information about a group version.",
"refs" : {
"GetGroupVersionResponse$Definition" : "Information on the definition"
"GetGroupVersionResponse$Definition" : "Information about the group version definition."
}
},
"InternalServerErrorException" : {
"base" : "The server encountered an unexpected error.",
"base" : "General error information.",
"refs" : { }
},
"ListDefinitionsResponse" : {
"base" : "List of definition responses",
"base" : "A list of definitions.",
"refs" : { }
},
"ListDeploymentsResponse" : {
@ -325,112 +330,60 @@
"base" : null,
"refs" : { }
},
"ListOfConnectivityInfo" : {
"base" : null,
"refs" : { }
},
"ListOfCore" : {
"base" : null,
"refs" : { }
},
"ListOfDefinitionInformation" : {
"base" : null,
"refs" : { }
},
"ListOfDevice" : {
"base" : null,
"refs" : { }
},
"ListOfFunction" : {
"base" : null,
"refs" : { }
},
"ListOfGroupCertificateAuthorityProperties" : {
"base" : null,
"refs" : { }
},
"ListOfGroupInformation" : {
"base" : null,
"refs" : { }
},
"ListOfLogger" : {
"base" : null,
"refs" : { }
},
"ListOfResource" : {
"base" : null,
"refs" : { }
},
"ListOfResourceAccessPolicy" : {
"base" : null,
"refs" : { }
},
"ListOfSubscription" : {
"base" : null,
"refs" : { }
},
"ListOfVersionInformation" : {
"base" : null,
"refs" : { }
},
"ListVersionsResponse" : {
"base" : "List of versions response",
"base" : "A list of versions.",
"refs" : { }
},
"LocalDeviceResourceData" : {
"base" : "Attributes that define the Local Device Resource.",
"base" : "Attributes that define a local device resource.",
"refs" : {
"ResourceDataContainer$LocalDeviceResourceData" : "Attributes that define the Local Device Resource."
"ResourceDataContainer$LocalDeviceResourceData" : "Attributes that define the local device resource."
}
},
"LocalVolumeResourceData" : {
"base" : "Attributes that define the Local Volume Resource.",
"base" : "Attributes that define a local volume resource.",
"refs" : {
"ResourceDataContainer$LocalVolumeResourceData" : "Attributes that define the Local Volume Resource."
"ResourceDataContainer$LocalVolumeResourceData" : "Attributes that define the local volume resource."
}
},
"Logger" : {
"base" : "Information on the Logger",
"base" : "Information about a logger",
"refs" : {
"LoggerDefinitionVersion$Loggers" : "List of loggers."
"__listOfLogger$member" : null
}
},
"LoggerComponent" : {
"base" : null,
"refs" : {
"Logger$Component" : "The component that will be subject to logs"
"Logger$Component" : "The component that will be subject to logging."
}
},
"LoggerDefinitionVersion" : {
"base" : "Information on logger definition version",
"base" : "Information about a logger definition version.",
"refs" : {
"GetLoggerDefinitionVersionResponse$Definition" : "Information on definition"
"GetLoggerDefinitionVersionResponse$Definition" : "Information about the logger definition version."
}
},
"LoggerLevel" : {
"base" : null,
"refs" : {
"Logger$Level" : "The level of the logs"
"Logger$Level" : "The level of the logs."
}
},
"LoggerType" : {
"base" : null,
"refs" : {
"Logger$Type" : "The type which will be use for log output"
"Logger$Type" : "The type of log output which will be used."
}
},
"MapOf__string" : {
"base" : null,
"refs" : { }
},
"Permission" : {
"base" : "Type of permissions a function could have to access a resource.",
"base" : "The type of permission a function has to access a resource.",
"refs" : {
"ResourceAccessPolicy$Permission" : "The function's access permission to the resource."
"ResourceAccessPolicy$Permission" : "The permissions that the Lambda function has to the resource. Can be one of ''rw'' (read/write) or ''ro'' (read-only)."
}
},
"ResetDeploymentsRequest" : {
"base" : "Information needed to perform a reset of a group's deployments.",
"base" : "Information about a group reset request.",
"refs" : { }
},
"ResetDeploymentsResponse" : {
@ -438,27 +391,33 @@
"refs" : { }
},
"Resource" : {
"base" : "Information on the resource.",
"base" : "Information about a resource.",
"refs" : {
"ResourceDefinitionVersion$Resources" : "List of resources."
"__listOfResource$member" : null
}
},
"ResourceAccessPolicy" : {
"base" : "Policy for the function to access a resource.",
"base" : "A policy used by the function to access a resource.",
"refs" : {
"FunctionConfigurationEnvironment$ResourceAccessPolicies" : "Policies for the function to access resources."
"__listOfResourceAccessPolicy$member" : null
}
},
"ResourceDataContainer" : {
"base" : "A container of data for all resource types.",
"base" : "A container for resource data. The container takes only one of the following supported resource data types: ''LocalDeviceResourceData'', ''LocalVolumeResourceData'', ''SageMakerMachineLearningModelResourceData'', ''S3MachineLearningModelResourceData''.",
"refs" : {
"Resource$ResourceDataContainer" : "A container of data for all resource types."
}
},
"ResourceDefinitionVersion" : {
"base" : "Information on resource definition version",
"base" : "Information about a resource definition version.",
"refs" : {
"GetResourceDefinitionVersionResponse$Definition" : "Information on definition."
"GetResourceDefinitionVersionResponse$Definition" : "Information about the definition."
}
},
"S3MachineLearningModelResourceData" : {
"base" : "Attributes that define an S3 machine learning resource.",
"refs" : {
"ResourceDataContainer$S3MachineLearningModelResourceData" : "Attributes that define an S3 machine learning resource."
}
},
"S3UrlSignerRole" : {
@ -467,22 +426,28 @@
"CreateSoftwareUpdateJobRequest$S3UrlSignerRole" : null
}
},
"SageMakerMachineLearningModelResourceData" : {
"base" : "Attributes that define an SageMaker machine learning resource.",
"refs" : {
"ResourceDataContainer$SageMakerMachineLearningModelResourceData" : "Attributes that define an SageMaker machine learning resource."
}
},
"SoftwareToUpdate" : {
"base" : "The piece of software on the Greengrass Core that will be updated.",
"base" : "The piece of software on the Greengrass core that will be updated.",
"refs" : {
"CreateSoftwareUpdateJobRequest$SoftwareToUpdate" : null
}
},
"Subscription" : {
"base" : "Information on subscription",
"base" : "Information about a subscription.",
"refs" : {
"SubscriptionDefinitionVersion$Subscriptions" : "Subscriptions in the version."
"__listOfSubscription$member" : null
}
},
"SubscriptionDefinitionVersion" : {
"base" : "Information on subscription definition version",
"base" : "Information about a subscription definition version.",
"refs" : {
"GetSubscriptionDefinitionVersionResponse$Definition" : "Information on the definition"
"GetSubscriptionDefinitionVersionResponse$Definition" : "Information about the subscription definition version."
}
},
"UpdateAgentLogLevel" : {
@ -492,7 +457,7 @@
}
},
"UpdateConnectivityInfoRequest" : {
"base" : "Information on connectivity info",
"base" : "Information required to update a Greengrass core's connectivity.",
"refs" : { }
},
"UpdateConnectivityInfoResponse" : {
@ -504,174 +469,259 @@
"refs" : { }
},
"UpdateTargets" : {
"base" : "The target arns that this update will be applied to.",
"base" : "The ARNs of the targets (IoT things or IoT thing groups) that this update will be applied to.",
"refs" : {
"CreateSoftwareUpdateJobRequest$UpdateTargets" : null
}
},
"UpdateTargetsArchitecture" : {
"base" : "The architecture of the Cores in the targets of an update",
"base" : "The architecture of the cores which are the targets of an update.",
"refs" : {
"CreateSoftwareUpdateJobRequest$UpdateTargetsArchitecture" : null
}
},
"UpdateTargetsOperatingSystem" : {
"base" : "The operating system of the Cores in the targets of an update",
"base" : "The operating system of the cores which are the targets of an update.",
"refs" : {
"CreateSoftwareUpdateJobRequest$UpdateTargetsOperatingSystem" : null
}
},
"VersionInformation" : {
"base" : "Information on the version",
"base" : "Information about a version.",
"refs" : {
"ListVersionsResponse$Versions" : "Versions"
"__listOfVersionInformation$member" : null
}
},
"__boolean" : {
"base" : null,
"refs" : {
"Core$SyncShadow" : "If true, the local shadow value automatically syncs with the cloud's shadow state.",
"Device$SyncShadow" : "If true, the local shadow value automatically syncs with the cloud's shadow state.",
"FunctionConfiguration$Pinned" : "Whether the function is pinned or not. Pinned means the function is long-lived and starts when the core starts.",
"FunctionConfigurationEnvironment$AccessSysfs" : "Flag to allow lambda access sys filesystem.",
"GroupOwnerSetting$AutoAddGroupOwner" : "Eanble the auto added group owner.",
"ResetDeploymentsRequest$Force" : "When set to true, perform a best-effort only core reset."
"Core$SyncShadow" : "If true, the core's local shadow is automatically synced with the cloud.",
"Device$SyncShadow" : "If true, the device's local shadow will be automatically synced with the cloud.",
"FunctionConfiguration$Pinned" : "True if the function is pinned. Pinned means the function is long-lived and starts when the core starts.",
"FunctionConfigurationEnvironment$AccessSysfs" : "If true, the Lambda function is allowed to access the host's /sys folder. Use this when the Lambda function needs to read device information from /sys.",
"GroupOwnerSetting$AutoAddGroupOwner" : "If true, GreenGrass automatically adds the specified Linux OS group owner of the resource to the Lambda process privileges. Thus the Lambda process will have the file access permissions of the added Linux group.",
"ResetDeploymentsRequest$Force" : "If true, performs a best-effort only core reset."
}
},
"__integer" : {
"base" : null,
"refs" : {
"ConnectivityInfo$PortNumber" : "Port of the GGC. Usually 8883.",
"FunctionConfiguration$MemorySize" : "The memory size, in KB, you configured for the function.",
"FunctionConfiguration$Timeout" : "The function execution time at which Lambda should terminate the function. This timeout still applies to pinned lambdas for each request.",
"Logger$Space" : "Amount of hardware space, in KB, to use if file system is used for logging purposes."
"ConnectivityInfo$PortNumber" : "The port of the Greengrass core. Usually 8883.",
"FunctionConfiguration$MemorySize" : "The memory size, in KB, which the function requires.",
"FunctionConfiguration$Timeout" : "The allowed function execution time, after which Lambda should terminate the function. This timeout still applies to pinned lambdas for each request.",
"Logger$Space" : "The amount of file space, in KB, to use if the local file system is used for logging purposes."
}
},
"__listOfConnectivityInfo" : {
"base" : null,
"refs" : {
"GetConnectivityInfoResponse$ConnectivityInfo" : "Connectivity info list.",
"UpdateConnectivityInfoRequest$ConnectivityInfo" : "A list of connectivity info."
}
},
"__listOfCore" : {
"base" : null,
"refs" : {
"CoreDefinitionVersion$Cores" : "A list of cores in the core definition version."
}
},
"__listOfDefinitionInformation" : {
"base" : null,
"refs" : {
"ListDefinitionsResponse$Definitions" : "Information about a definition."
}
},
"__listOfDevice" : {
"base" : null,
"refs" : {
"DeviceDefinitionVersion$Devices" : "A list of devices in the definition version."
}
},
"__listOfFunction" : {
"base" : null,
"refs" : {
"FunctionDefinitionVersion$Functions" : "A list of Lambda functions in this function definition version."
}
},
"__listOfGroupCertificateAuthorityProperties" : {
"base" : null,
"refs" : {
"ListGroupCertificateAuthoritiesResponse$GroupCertificateAuthorities" : "A list of certificate authorities associated with the group."
}
},
"__listOfGroupInformation" : {
"base" : null,
"refs" : {
"ListGroupsResponse$Groups" : "Information about a group."
}
},
"__listOfLogger" : {
"base" : null,
"refs" : {
"LoggerDefinitionVersion$Loggers" : "A list of loggers."
}
},
"__listOfResource" : {
"base" : null,
"refs" : {
"ResourceDefinitionVersion$Resources" : "A list of resources."
}
},
"__listOfResourceAccessPolicy" : {
"base" : null,
"refs" : {
"FunctionConfigurationEnvironment$ResourceAccessPolicies" : "A list of the resources, with their permissions, to which the Lambda function will be granted access. A Lambda function can have at most 10 resources."
}
},
"__listOfSubscription" : {
"base" : null,
"refs" : {
"SubscriptionDefinitionVersion$Subscriptions" : "A list of subscriptions."
}
},
"__listOfVersionInformation" : {
"base" : null,
"refs" : {
"ListVersionsResponse$Versions" : "Information about a version."
}
},
"__mapOf__string" : {
"base" : null,
"refs" : {
"FunctionConfigurationEnvironment$Variables" : "Environment variables for the Lambda function's configuration."
}
},
"__string" : {
"base" : null,
"refs" : {
"AssociateRoleToGroupRequest$RoleArn" : "Role arn you wish to associate with this group.",
"AssociateRoleToGroupResponse$AssociatedAt" : "Time the role arn was associated to your group.",
"AssociateServiceRoleToAccountRequest$RoleArn" : "Role arn you wish to associate with this account.",
"AssociateServiceRoleToAccountResponse$AssociatedAt" : "Time when the service role was associated to the account.",
"ConnectivityInfo$HostAddress" : "Endpoint for the GGC. Can be an IP address or DNS.",
"ConnectivityInfo$Id" : "Element Id for this entry in the list.",
"AssociateRoleToGroupRequest$RoleArn" : "The ARN of the role you wish to associate with this group.",
"AssociateRoleToGroupResponse$AssociatedAt" : "The time, in milliseconds since the epoch, when the role ARN was associated with the group.",
"AssociateServiceRoleToAccountRequest$RoleArn" : "The ARN of the service role you wish to associate with your account.",
"AssociateServiceRoleToAccountResponse$AssociatedAt" : "The time when the service role was associated with the account.",
"ConnectivityInfo$HostAddress" : "The endpoint for the Greengrass core. Can be an IP address or DNS.",
"ConnectivityInfo$Id" : "The ID of the connectivity information.",
"ConnectivityInfo$Metadata" : "Metadata for this endpoint.",
"Core$CertificateArn" : "Certificate arn of the core.",
"Core$Id" : "Element Id for this entry in the list.",
"Core$ThingArn" : "Thing arn of the core.",
"CreateDeploymentRequest$DeploymentId" : "Id of the deployment if you wish to redeploy a previous deployment.",
"CreateDeploymentRequest$GroupVersionId" : "Group Version you wish to deploy.",
"CreateDeploymentResponse$DeploymentArn" : "The arn of the deployment.",
"CreateDeploymentResponse$DeploymentId" : "The id of the deployment.",
"CreateGroupCertificateAuthorityResponse$GroupCertificateAuthorityArn" : "Arn of the group certificate authority.",
"CreateSoftwareUpdateJobResponse$IotJobArn" : "The Iot Job Arn corresponding to this update.",
"CreateSoftwareUpdateJobResponse$IotJobId" : "The Iot Job Id corresponding to this update.",
"DefinitionInformation$Arn" : "Arn of the definition.",
"DefinitionInformation$CreationTimestamp" : "Timestamp of when the definition was created.",
"DefinitionInformation$Id" : "Id of the definition.",
"DefinitionInformation$LastUpdatedTimestamp" : "Last updated timestamp of the definition.",
"DefinitionInformation$LatestVersion" : "Last version of the definition.",
"DefinitionInformation$LatestVersionArn" : "Latest version arn of the definition.",
"DefinitionInformation$Name" : "Name of the definition.",
"Deployment$CreatedAt" : "Timestamp when the deployment was created.",
"Deployment$DeploymentArn" : "Arn of the deployment.",
"Deployment$DeploymentId" : "Id of the deployment.",
"Deployment$GroupArn" : "Arn of the group for this deployment.",
"Device$CertificateArn" : "Certificate arn of the device.",
"Device$Id" : "Element Id for this entry in the list.",
"Device$ThingArn" : "Thing arn of the device.",
"DisassociateRoleFromGroupResponse$DisassociatedAt" : "Time when the role was disassociated from the group.",
"DisassociateServiceRoleFromAccountResponse$DisassociatedAt" : "Time when the service role was disassociated from the account.",
"ErrorDetail$DetailedErrorCode" : "Detailed Error Code",
"ErrorDetail$DetailedErrorMessage" : "Detailed Error Message",
"Function$FunctionArn" : "Arn of the Lambda function.",
"Function$Id" : "Id of the function in this version.",
"FunctionConfiguration$ExecArgs" : "Execution Arguments",
"FunctionConfiguration$Executable" : "Executable",
"GeneralError$Message" : "Message containing information about the error",
"GetAssociatedRoleResponse$AssociatedAt" : "Time when the role was associated for the group.",
"GetAssociatedRoleResponse$RoleArn" : "Arn of the role that is associated with the group.",
"GetConnectivityInfoResponse$Message" : "Response Text",
"GetCoreDefinitionVersionResponse$Arn" : "Arn of the core definition version.",
"GetCoreDefinitionVersionResponse$CreationTimestamp" : "Timestamp of when the core definition version was created.",
"GetCoreDefinitionVersionResponse$Id" : "Id of the core definition the version belongs to.",
"GetCoreDefinitionVersionResponse$Version" : "Version of the core definition version.",
"GetDeploymentStatusResponse$DeploymentStatus" : "Status of the deployment.",
"GetDeploymentStatusResponse$ErrorMessage" : "Error Message",
"GetDeploymentStatusResponse$UpdatedAt" : "Last time the deployment status was updated.",
"GetDeviceDefinitionVersionResponse$Arn" : "Arn of the device definition version.",
"GetDeviceDefinitionVersionResponse$CreationTimestamp" : "Timestamp of when the device definition version was created.",
"GetDeviceDefinitionVersionResponse$Id" : "Id of the device definition the version belongs to.",
"GetDeviceDefinitionVersionResponse$Version" : "Version of the device definition version.",
"GetFunctionDefinitionVersionResponse$Arn" : "Arn of the function definition version.",
"GetFunctionDefinitionVersionResponse$CreationTimestamp" : "Timestamp when the funtion definition version was created.",
"GetFunctionDefinitionVersionResponse$Id" : "Id of the function definition the version belongs to.",
"GetFunctionDefinitionVersionResponse$Version" : "Version of the function definition version.",
"GetGroupCertificateAuthorityResponse$GroupCertificateAuthorityArn" : "Arn of the certificate authority for the group.",
"GetGroupCertificateAuthorityResponse$GroupCertificateAuthorityId" : "Id of the certificate authority for the group.",
"GetGroupCertificateAuthorityResponse$PemEncodedCertificate" : "PEM encoded certificate for the group.",
"GetGroupVersionResponse$Arn" : "Arn of the group version.",
"GetGroupVersionResponse$CreationTimestamp" : "Timestamp when the group version was created.",
"GetGroupVersionResponse$Id" : "Id of the group version.",
"GetGroupVersionResponse$Version" : "Unique Id for a version of the Group.",
"GetLoggerDefinitionVersionResponse$Arn" : "Arn of the logger definition version.",
"GetLoggerDefinitionVersionResponse$CreationTimestamp" : "Timestamp of when the logger definition version was created.",
"GetLoggerDefinitionVersionResponse$Id" : "Id of the logger definition the version belongs to.",
"GetLoggerDefinitionVersionResponse$Version" : "Version of the logger definition version.",
"Core$CertificateArn" : "The ARN of the certificate associated with the core.",
"Core$Id" : "The ID of the core.",
"Core$ThingArn" : "The ARN of the thing which is the core.",
"CreateDeploymentRequest$DeploymentId" : "The ID of the deployment if you wish to redeploy a previous deployment.",
"CreateDeploymentRequest$GroupVersionId" : "The ID of the group version to be deployed.",
"CreateDeploymentResponse$DeploymentArn" : "The ARN of the deployment.",
"CreateDeploymentResponse$DeploymentId" : "The ID of the deployment.",
"CreateGroupCertificateAuthorityResponse$GroupCertificateAuthorityArn" : "The ARN of the group certificate authority.",
"CreateSoftwareUpdateJobResponse$IotJobArn" : "The IoT Job ARN corresponding to this update.",
"CreateSoftwareUpdateJobResponse$IotJobId" : "The IoT Job Id corresponding to this update.",
"DefinitionInformation$Arn" : "The ARN of the definition.",
"DefinitionInformation$CreationTimestamp" : "The time, in milliseconds since the epoch, when the definition was created.",
"DefinitionInformation$Id" : "The ID of the definition.",
"DefinitionInformation$LastUpdatedTimestamp" : "The time, in milliseconds since the epoch, when the definition was last updated.",
"DefinitionInformation$LatestVersion" : "The latest version of the definition.",
"DefinitionInformation$LatestVersionArn" : "The ARN of the latest version of the definition.",
"DefinitionInformation$Name" : "The name of the definition.",
"Deployment$CreatedAt" : "The time, in milliseconds since the epoch, when the deployment was created.",
"Deployment$DeploymentArn" : "The ARN of the deployment.",
"Deployment$DeploymentId" : "The ID of the deployment.",
"Deployment$GroupArn" : "The ARN of the group for this deployment.",
"Device$CertificateArn" : "The ARN of the certificate associated with the device.",
"Device$Id" : "The ID of the device.",
"Device$ThingArn" : "The thing ARN of the device.",
"DisassociateRoleFromGroupResponse$DisassociatedAt" : "The time, in milliseconds since the epoch, when the role was disassociated from the group.",
"DisassociateServiceRoleFromAccountResponse$DisassociatedAt" : "The time when the service role was disassociated from the account.",
"ErrorDetail$DetailedErrorCode" : "A detailed error code.",
"ErrorDetail$DetailedErrorMessage" : "A detailed error message.",
"Function$FunctionArn" : "The ARN of the Lambda function.",
"Function$Id" : "The ID of the Lambda function.",
"FunctionConfiguration$ExecArgs" : "The execution arguments.",
"FunctionConfiguration$Executable" : "The name of the function executable.",
"GeneralError$Message" : "A message containing information about the error.",
"GetAssociatedRoleResponse$AssociatedAt" : "The time when the role was associated with the group.",
"GetAssociatedRoleResponse$RoleArn" : "The ARN of the role that is associated with the group.",
"GetConnectivityInfoResponse$Message" : "A message about the connectivity info request.",
"GetCoreDefinitionVersionResponse$Arn" : "The ARN of the core definition version.",
"GetCoreDefinitionVersionResponse$CreationTimestamp" : "The time, in milliseconds since the epoch, when the core definition version was created.",
"GetCoreDefinitionVersionResponse$Id" : "The ID of the core definition version.",
"GetCoreDefinitionVersionResponse$Version" : "The version of the core definition version.",
"GetDeploymentStatusResponse$DeploymentStatus" : "The status of the deployment.",
"GetDeploymentStatusResponse$ErrorMessage" : "Error message",
"GetDeploymentStatusResponse$UpdatedAt" : "The time, in milliseconds since the epoch, when the deployment status was updated.",
"GetDeviceDefinitionVersionResponse$Arn" : "The ARN of the device definition version.",
"GetDeviceDefinitionVersionResponse$CreationTimestamp" : "The time, in milliseconds since the epoch, when the device definition version was created.",
"GetDeviceDefinitionVersionResponse$Id" : "The ID of the device definition version.",
"GetDeviceDefinitionVersionResponse$Version" : "The version of the device definition version.",
"GetFunctionDefinitionVersionResponse$Arn" : "The ARN of the function definition version.",
"GetFunctionDefinitionVersionResponse$CreationTimestamp" : "The time, in milliseconds since the epoch, when the function definition version was created.",
"GetFunctionDefinitionVersionResponse$Id" : "The ID of the function definition version.",
"GetFunctionDefinitionVersionResponse$Version" : "The version of the function definition version.",
"GetGroupCertificateAuthorityResponse$GroupCertificateAuthorityArn" : "The ARN of the certificate authority for the group.",
"GetGroupCertificateAuthorityResponse$GroupCertificateAuthorityId" : "The ID of the certificate authority for the group.",
"GetGroupCertificateAuthorityResponse$PemEncodedCertificate" : "The PEM encoded certificate for the group.",
"GetGroupVersionResponse$Arn" : "The ARN of the group version.",
"GetGroupVersionResponse$CreationTimestamp" : "The time, in milliseconds since the epoch, when the group version was created.",
"GetGroupVersionResponse$Id" : "The ID of the group version.",
"GetGroupVersionResponse$Version" : "The unique ID for the version of the group.",
"GetLoggerDefinitionVersionResponse$Arn" : "The ARN of the logger definition version.",
"GetLoggerDefinitionVersionResponse$CreationTimestamp" : "The time, in milliseconds since the epoch, when the logger definition version was created.",
"GetLoggerDefinitionVersionResponse$Id" : "The ID of the logger definition version.",
"GetLoggerDefinitionVersionResponse$Version" : "The version of the logger definition version.",
"GetResourceDefinitionVersionResponse$Arn" : "Arn of the resource definition version.",
"GetResourceDefinitionVersionResponse$CreationTimestamp" : "Timestamp of when the resource definition version was created.",
"GetResourceDefinitionVersionResponse$Id" : "Id of the resource definition the version belongs to.",
"GetResourceDefinitionVersionResponse$Version" : "Version of the resource definition version.",
"GetServiceRoleForAccountResponse$AssociatedAt" : "Time when the service role was associated to the account.",
"GetServiceRoleForAccountResponse$RoleArn" : "Role arn which is associated to the account.",
"GetSubscriptionDefinitionVersionResponse$Arn" : "Arn of the subscription definition version.",
"GetSubscriptionDefinitionVersionResponse$CreationTimestamp" : "Timestamp of when the subscription definition version was created.",
"GetSubscriptionDefinitionVersionResponse$Id" : "Id of the subscription definition the version belongs to.",
"GetSubscriptionDefinitionVersionResponse$Version" : "Version of the subscription definition version.",
"GroupCertificateAuthorityProperties$GroupCertificateAuthorityArn" : "Arn of the certificate authority for the group.",
"GroupCertificateAuthorityProperties$GroupCertificateAuthorityId" : "Id of the certificate authority for the group.",
"GroupCertificateConfiguration$CertificateAuthorityExpiryInMilliseconds" : "Amount of time when the certificate authority expires in milliseconds.",
"GroupCertificateConfiguration$CertificateExpiryInMilliseconds" : "Amount of time when the certificate expires in milliseconds.",
"GroupCertificateConfiguration$GroupId" : "Id of the group the certificate configuration belongs to.",
"GroupInformation$Arn" : "Arn of a group.",
"GroupInformation$CreationTimestamp" : "Timestamp of when the group was created.",
"GroupInformation$Id" : "Id of a group.",
"GroupInformation$LastUpdatedTimestamp" : "Last updated timestamp of the group.",
"GroupInformation$LatestVersion" : "Last version of the group.",
"GroupInformation$LatestVersionArn" : "Latest version arn of the group.",
"GroupInformation$Name" : "Name of a group.",
"GroupOwnerSetting$GroupOwner" : "Name of the group owner.",
"GroupVersion$CoreDefinitionVersionArn" : "Core definition version arn for this group.",
"GroupVersion$DeviceDefinitionVersionArn" : "Device definition version arn for this group.",
"GroupVersion$FunctionDefinitionVersionArn" : "Function definition version arn for this group.",
"GroupVersion$LoggerDefinitionVersionArn" : "Logger definition version arn for this group.",
"GroupVersion$ResourceDefinitionVersionArn" : "Resource definition version arn for this group.",
"GroupVersion$SubscriptionDefinitionVersionArn" : "Subscription definition version arn for this group.",
"GetResourceDefinitionVersionResponse$CreationTimestamp" : "The time, in milliseconds since the epoch, when the resource definition version was created.",
"GetResourceDefinitionVersionResponse$Id" : "The ID of the resource definition version.",
"GetResourceDefinitionVersionResponse$Version" : "The version of the resource definition version.",
"GetServiceRoleForAccountResponse$AssociatedAt" : "The time when the service role was associated with the account.",
"GetServiceRoleForAccountResponse$RoleArn" : "The ARN of the role which is associated with the account.",
"GetSubscriptionDefinitionVersionResponse$Arn" : "The ARN of the subscription definition version.",
"GetSubscriptionDefinitionVersionResponse$CreationTimestamp" : "The time, in milliseconds since the epoch, when the subscription definition version was created.",
"GetSubscriptionDefinitionVersionResponse$Id" : "The ID of the subscription definition version.",
"GetSubscriptionDefinitionVersionResponse$Version" : "The version of the subscription definition version.",
"GroupCertificateAuthorityProperties$GroupCertificateAuthorityArn" : "The ARN of the certificate authority for the group.",
"GroupCertificateAuthorityProperties$GroupCertificateAuthorityId" : "The ID of the certificate authority for the group.",
"GroupCertificateConfiguration$CertificateAuthorityExpiryInMilliseconds" : "The amount of time remaining before the certificate authority expires, in milliseconds.",
"GroupCertificateConfiguration$CertificateExpiryInMilliseconds" : "The amount of time remaining before the certificate expires, in milliseconds.",
"GroupCertificateConfiguration$GroupId" : "The ID of the group certificate configuration.",
"GroupInformation$Arn" : "The ARN of the group.",
"GroupInformation$CreationTimestamp" : "The time, in milliseconds since the epoch, when the group was created.",
"GroupInformation$Id" : "The ID of the group.",
"GroupInformation$LastUpdatedTimestamp" : "The time, in milliseconds since the epoch, when the group was last updated.",
"GroupInformation$LatestVersion" : "The latest version of the group.",
"GroupInformation$LatestVersionArn" : "The ARN of the latest version of the group.",
"GroupInformation$Name" : "The name of the group.",
"GroupOwnerSetting$GroupOwner" : "The name of the Linux OS group whose privileges will be added to the Lambda process. This field is optional.",
"GroupVersion$CoreDefinitionVersionArn" : "The ARN of the core definition version for this group.",
"GroupVersion$DeviceDefinitionVersionArn" : "The ARN of the device definition version for this group.",
"GroupVersion$FunctionDefinitionVersionArn" : "The ARN of the function definition version for this group.",
"GroupVersion$LoggerDefinitionVersionArn" : "The ARN of the logger definition version for this group.",
"GroupVersion$ResourceDefinitionVersionArn" : "The resource definition version ARN for this group.",
"GroupVersion$SubscriptionDefinitionVersionArn" : "The ARN of the subscription definition version for this group.",
"ListDefinitionsResponse$NextToken" : "The token for the next set of results, or ''null'' if there are no additional results.",
"ListDeploymentsResponse$NextToken" : "The token for the next set of results, or ''null'' if there are no additional results.",
"ListGroupsResponse$NextToken" : "The token for the next set of results, or ''null'' if there are no additional results.",
"ListVersionsResponse$NextToken" : "The token for the next set of results, or ''null'' if there are no additional results.",
"LocalDeviceResourceData$SourcePath" : "Local source path of the resource.",
"LocalVolumeResourceData$DestinationPath" : "Local destination path of the resource.",
"LocalVolumeResourceData$SourcePath" : "Local source path of the resource.",
"Logger$Id" : "Element Id for this entry in the list.",
"ResetDeploymentsResponse$DeploymentArn" : "The arn of the reset deployment.",
"ResetDeploymentsResponse$DeploymentId" : "The id of the reset deployment.",
"Resource$Id" : "Resource Id.",
"Resource$Name" : "A descriptive resource name.",
"ResourceAccessPolicy$ResourceId" : "Id of the resource. A reference to the resource definiton.",
"Subscription$Id" : "Element Id for this entry in the list.",
"Subscription$Source" : "Source of the subscription. Can be a thing arn, lambda arn or word 'cloud'",
"Subscription$Subject" : "Subject of the message.",
"Subscription$Target" : "Where the message is sent to. Can be a thing arn, lambda arn or word 'cloud'.",
"UpdateConnectivityInfoResponse$Message" : "Response Text",
"UpdateConnectivityInfoResponse$Version" : "New Version",
"UpdateGroupCertificateConfigurationRequest$CertificateExpiryInMilliseconds" : "Amount of time when the certificate expires in milliseconds.",
"VersionInformation$Arn" : "Arn of the version.",
"VersionInformation$CreationTimestamp" : "Timestamp of when the version was created.",
"VersionInformation$Id" : "Id of the resource container.",
"VersionInformation$Version" : "Unique Id of a version."
"LocalDeviceResourceData$SourcePath" : "The local absolute path of the device resource. The source path for a device resource can refer only to a character device or block device under ''/dev''.",
"LocalVolumeResourceData$DestinationPath" : "The absolute local path of the resource inside the lambda environment.",
"LocalVolumeResourceData$SourcePath" : "The local absolute path of the volume resource on the host. The source path for a volume resource type cannot start with ''/proc'' or ''/sys''.",
"Logger$Id" : "The id of the logger.",
"ResetDeploymentsResponse$DeploymentArn" : "The ARN of the deployment.",
"ResetDeploymentsResponse$DeploymentId" : "The ID of the deployment.",
"Resource$Id" : "The resource ID, used to refer to a resource in the Lambda function configuration. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''. This must be unique within a Greengrass group.",
"Resource$Name" : "The descriptive resource name, which is displayed on the Greengrass console. Max length 128 characters with pattern ''[a-zA-Z0-9:_-]+''. This must be unique within a Greengrass group.",
"ResourceAccessPolicy$ResourceId" : "The ID of the resource. (This ID is assigned to the resource when you create the resource definiton.)",
"S3MachineLearningModelResourceData$DestinationPath" : "The absolute local path of the resource inside the Lambda environment.",
"S3MachineLearningModelResourceData$S3Uri" : "The URI of the source model in an S3 bucket. The model package must be in tar.gz or .zip format.",
"SageMakerMachineLearningModelResourceData$DestinationPath" : "The absolute local path of the resource inside the Lambda environment.",
"SageMakerMachineLearningModelResourceData$SageMakerJobArn" : "The ARN of the SageMaker training job that represents the source model.",
"Subscription$Id" : "The id of the subscription.",
"Subscription$Source" : "The source of the subscription. Can be a thing ARN, a Lambda function ARN, 'cloud' (which represents the IoT cloud), or 'GGShadowService'.",
"Subscription$Subject" : "The subject of the message.",
"Subscription$Target" : "Where the message is sent to. Can be a thing ARN, a Lambda function ARN, 'cloud' (which represents the IoT cloud), or 'GGShadowService'.",
"UpdateConnectivityInfoResponse$Message" : "A message about the connectivity info update request.",
"UpdateConnectivityInfoResponse$Version" : "The new version of the connectivity info.",
"UpdateGroupCertificateConfigurationRequest$CertificateExpiryInMilliseconds" : "The amount of time remaining before the certificate expires, in milliseconds.",
"UpdateTargets$member" : null,
"VersionInformation$Arn" : "The ARN of the version.",
"VersionInformation$CreationTimestamp" : "The time, in milliseconds since the epoch, when the version was created.",
"VersionInformation$Id" : "The ID of the version.",
"VersionInformation$Version" : "The unique ID of the version.",
"__mapOf__string$member" : null
}
}
}

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